Test Your Integration in an ExhibitDay Workspace
Try a complete Task and attachment workflow in a test Event, confirm a stale update is refused, and choose whether to clean up.
Example use case
You are about to turn on an integration and want to check how it creates, updates and verifies records first.
What you'll end up with
One checked Task and attachment, a downloaded copy, and an explicit choice about removing the test records.
Before you start
Have a workspace API key, an Event reserved for testing, and a small file you can leave unchanged while the test runs.
Good to know
Use a dedicated test Event in a workspace you control. This example sends real requests to the API.
At a glance
Time to try
About 15 minutes
Effect on your data
Creates records
Endpoints
9
The program creates and renames one test Task, adds one file, and saves a verified local download and private journal. It removes only those two records if you explicitly choose cleanup.
How it works
- Confirm the workspace and create one Task in the test Event. Save its ID and current revision.
- Rename the Task and check that an update using the old revision gets HTTP 409.
- Attach, find and download one file. Keep the records by default, or explicitly remove the file and Task created by this run.
Run the Task and attachment checks
Use your test Event ID to create the Task. For the later requests, substitute the Task and attachment IDs from your own responses. Remove records only if you choose cleanup and created them during this test.
Replace the example IDs and values with your own. Use the complete program below to save progress and check each result.
Step 1: Check the workspace
Verify where the test will create data.
curl -X GET "https://api.exhibitday.com/v1/references/workspace_info" -H "Authorization: Bearer YOUR_API_KEY"
Example response (shortened)
{
"id": 98765
}
Check: Confirm the returned id matches the workspace you set aside for the test.
Step 2: Create the test Task
Send your test Event ID and a unique name, using one idempotency key for this create.
curl -X POST "https://api.exhibitday.com/v1/tasks" -H "Authorization: Bearer YOUR_API_KEY" -H "Idempotency-Key: YOUR_CREATE_KEY" -H "Content-Type: application/json" --data-binary "{\"event_id\":12345,\"name\":\"API integration check\"}"
Example response (shortened)
{
"id": 34567,
"name": "API integration check"
}
Check: Save the returned Task ID. The complete program derives its test name from your job ID.
Step 3: Read the Task and its revision
Read that exact Task before updating it.
curl -X GET "https://api.exhibitday.com/v1/tasks/info?id=34567&%24include_record_revision=true" -H "Authorization: Bearer YOUR_API_KEY"
Example response (shortened)
{
"id": 34567,
"record_revision": "COPY_TASK_REVISION_FROM_YOUR_READ"
}
Check: Keep the full revision from your own read.
Step 4: Rename the Task
Use the revision to rename only the Task created in this test.
curl -X PATCH "https://api.exhibitday.com/v1/tasks" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" --data-binary "{\"id\":34567,\"name\":\"API integration check updated\",\"expected_revision\":\"COPY_TASK_REVISION_FROM_YOUR_READ\"}"
Example response (shortened)
{
"record_revision": "NEW_TASK_REVISION"
}
Check: Save the new revision and keep the original for the next check.
Step 5: Try the old revision once
Send a different name with the old revision to check that a stale update is refused.
curl -X PATCH "https://api.exhibitday.com/v1/tasks" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" --data-binary "{\"id\":34567,\"name\":\"API integration check refused\",\"expected_revision\":\"COPY_TASK_REVISION_FROM_YOUR_READ\"}"
Check: Expect record_changed (HTTP 409). The Task keeps the name from Step 4.
Step 6: Confirm the Task kept its new name
Read it again after the conflict.
curl -X GET "https://api.exhibitday.com/v1/tasks/info?id=34567&%24include_record_revision=true" -H "Authorization: Bearer YOUR_API_KEY"
Example response (shortened)
{
"id": 34567,
"name": "API integration check updated",
"record_revision": "NEW_TASK_REVISION"
}
Check: Compare the saved name and revision against the successful update.
Step 7: Attach a test file
Send one file to the Task you just created.
curl -X POST "https://api.exhibitday.com/v1/tasks/attachments" -H "Authorization: Bearer YOUR_API_KEY" -H "Idempotency-Key: YOUR_UPLOAD_KEY" -F "task_id=34567" -F "file=@integration-check.txt"
Example response (shortened)
{
"list_data": [
{
"id": 45678,
"filename": "integration-check.txt"
}
]
}
Check: Keep the returned attachment ID.
Step 8: Find the file on that Task
Read the attachment list for the Task and look for the ID returned by the upload.
curl -X GET "https://api.exhibitday.com/v1/tasks/attachments?task_id=34567&%24limit=25&%24offset=0" -H "Authorization: Bearer YOUR_API_KEY"
Example response (shortened)
{
"list_data": [
{
"id": 45678,
"filename": "integration-check.txt"
}
]
}
Check: Confirm both the ID and filename.
Step 9: Download and compare the file
Use the saved attachment ID to fetch the bytes.
curl -X GET "https://api.exhibitday.com/v1/tasks/attachments/download?id=45678" -H "Authorization: Bearer YOUR_API_KEY" --fail --output "downloaded-copy.txt"
The response contains the file bytes.
Check: The program compares length and SHA-256 with the original and saves only a matching file.
Step 10: Remove the test file, if you chose cleanup
Delete only the attachment ID the program saved from Step 7.
curl -X DELETE "https://api.exhibitday.com/v1/tasks/attachments?id=45678" -H "Authorization: Bearer YOUR_API_KEY"
Check: The program skips this step unless you set EXHIBITDAY_TEST_CLEANUP=delete.
Step 11: Remove the test Task, if you chose cleanup
Delete the Task this run created after its file is removed.
curl -X DELETE "https://api.exhibitday.com/v1/tasks?id=34567" -H "Authorization: Bearer YOUR_API_KEY"
Check: The program deletes only the Task it created in this run.
Step 12: Confirm the test Task is gone
Read the same Task after cleanup.
curl -X GET "https://api.exhibitday.com/v1/tasks/info?id=34567" -H "Authorization: Bearer YOUR_API_KEY"
Expected status: HTTP 404.
Check: The program expects HTTP 404 after the Task is deleted.
Try it
Before running the example
| Variable | What to put in it | Required? |
|---|---|---|
EXHIBITDAY_API_KEY | Your workspace API key. | Yes |
EXHIBITDAY_EVENT_ID | The ID of an Event reserved for testing. | Yes |
EXHIBITDAY_FILE | Path to a small local file for the test. | Yes |
EXHIBITDAY_DOWNLOAD_PATH | A new path for the downloaded copy. | Yes |
EXHIBITDAY_JOB_ID | A unique ID for this run. Use the same ID to continue it. | Yes |
EXHIBITDAY_TEST_STATE | A private local path for the journal (the run state). | Yes |
EXHIBITDAY_TEST_CLEANUP | Use keep to leave the records for review, or delete to remove them after the checks. Defaults to keep. | No |
EXHIBITDAY_JOB_MODE | Use new to start a run, or resume to continue an existing one. Defaults to resume. | No |
Bash
export EXHIBITDAY_API_KEY='YOUR_API_KEY'
export EXHIBITDAY_EVENT_ID='12345'
export EXHIBITDAY_FILE='integration-check.txt'
export EXHIBITDAY_DOWNLOAD_PATH='verified-integration-check.txt'
export EXHIBITDAY_JOB_ID='integration-testing-01'
export EXHIBITDAY_TEST_STATE='integration-testing-01.json'
export EXHIBITDAY_JOB_MODE='new'
PowerShell
$env:EXHIBITDAY_API_KEY = 'YOUR_API_KEY'
$env:EXHIBITDAY_EVENT_ID = '12345'
$env:EXHIBITDAY_FILE = 'integration-check.txt'
$env:EXHIBITDAY_DOWNLOAD_PATH = 'verified-integration-check.txt'
$env:EXHIBITDAY_JOB_ID = 'integration-testing-01'
$env:EXHIBITDAY_TEST_STATE = 'integration-testing-01.json'
$env:EXHIBITDAY_JOB_MODE = 'new'
Use your own IDs, file paths and values. Then copy and run the complete program in your language.
Complete example program
#!/usr/bin/env bash
# Requires Bash, curl and Python3. No API key is written into the program.
python3 - <<'EXHIBITDAY_PY'
# Python 3; standard library only. Set EXHIBITDAY_API_KEY before running.
import http.client
import json
import os
import re
import time
import urllib.error
import urllib.parse
import urllib.request
BASE = "https://api.exhibitday.com/v1"
SPEC = json.loads("{\"preserveNumbers\":true,\"requests\":{\"workspace_binding\":{\"method\":\"GET\",\"path\":\"/references/workspace_info\"},\"create\":{\"method\":\"POST\",\"path\":\"/tasks\"},\"read\":{\"method\":\"GET\",\"path\":\"/tasks/info\"},\"edit\":{\"method\":\"PATCH\",\"path\":\"/tasks\"},\"stale\":{\"method\":\"PATCH\",\"path\":\"/tasks\"},\"after_edit\":{\"method\":\"GET\",\"path\":\"/tasks/info\"},\"upload\":{\"method\":\"POST\",\"path\":\"/tasks/attachments\",\"file\":{\"name\":\"file\",\"maximum_bytes\":\"26214400\",\"extensions\":[\"png\",\"jpg\",\"jpeg\",\"bmp\",\"gif\",\"pdf\",\"msg\",\"eml\",\"doc\",\"docx\",\"ppt\",\"pptx\",\"xls\",\"xlsx\",\"csv\",\"rtf\",\"odp\",\"odt\",\"ods\",\"txt\",\"wks\",\"zip\"],\"content_types\":[]}},\"verify_file\":{\"method\":\"GET\",\"path\":\"/tasks/attachments\"},\"download\":{\"method\":\"GET\",\"path\":\"/tasks/attachments/download\",\"binary\":true},\"remove_file\":{\"method\":\"DELETE\",\"path\":\"/tasks/attachments\"},\"remove_task\":{\"method\":\"DELETE\",\"path\":\"/tasks\"},\"verify_removed\":{\"method\":\"GET\",\"path\":\"/tasks/info\"}}}")
API_KEY = os.environ["EXHIBITDAY_API_KEY"]
if any(ord(char) < 32 or ord(char) > 126 for char in API_KEY):
raise RuntimeError("Use the API key as one ASCII header value without control characters")
if not API_KEY.strip():
raise RuntimeError("Set EXHIBITDAY_API_KEY")
def decode_json(text):
if SPEC["preserveNumbers"]:
# Quote JSON NUMBER tokens, never text inside a JSON string, to keep CSV decimals exact.
text = re.sub(r'"(?:\\.|[^"\\])*"|-?\d+(?:\.\d+)?(?:[eE][+-]?\d+)?',
lambda m: m[0] if m[0].startswith('"') else json.dumps(m[0]), text)
return json.loads(text)
from pathlib import Path
# This terminal version uses curl for HTTP and Python's standard library for JSON/CSV.
import subprocess
import tempfile
def transport(method, url, headers, data):
with tempfile.TemporaryDirectory(prefix="exhibitday-guide-") as directory:
folder = Path(directory)
# curl may leave no output file for a valid bodyless304 response.
(folder / "body").write_bytes(b"")
command = ["curl", "--disable", "--silent", "--show-error", "--request", method, "--url", url,
"--max-time", "30", "--dump-header", str(folder / "headers"),
"--output", str(folder / "body"), "--write-out", "%{http_code}"]
for name, value in headers.items():
command += ["--header", name + ": " + value]
if data is not None:
(folder / "request").write_bytes(data)
command += ["--data-binary", "@" + str(folder / "request")]
result = subprocess.run(command, capture_output=True, text=True)
if result.returncode:
raise urllib.error.URLError(result.stderr.strip())
response_headers = {}
blocks = (folder / "headers").read_text(encoding="iso-8859-1").replace("\r\n", "\n").strip().split("\n\n")
for line in blocks[-1].splitlines()[1:]:
name, separator, value = line.partition(":")
if separator:
response_headers[name] = value.strip()
return int(result.stdout), (folder / "body").read_bytes(), response_headers
class ApiError(RuntimeError):
"""An API error response. Branch on error_code (and status), never on the message text.
uncertain is True when a PATCH or DELETE got no response or a server error: it may or may not have been applied."""
def __init__(self, status, body, uncertain=False):
self.status = status
self.uncertain = uncertain
self.error_code = body.get("error_code") if isinstance(body, dict) else None
super().__init__(f"{body.get('error_code')} {body.get('error_params')}: {body.get('errors')} (request {body.get('request_id')})"
if isinstance(body, dict) else "HTTP " + str(status) if status else "No response")
def call(name, params=None, body=None, key=None):
route = SPEC["requests"][name]
headers = {"Authorization": "Bearer " + API_KEY, "Accept": "application/json"}
if route["method"] == "POST":
if not key: raise RuntimeError("Save a create key before sending POST")
headers["Idempotency-Key"] = key
data = None if body is None else json.dumps(body).encode("utf-8")
if data is not None:
headers["Content-Type"] = "application/json"
query = urllib.parse.urlencode(params or {})
url = BASE + route["path"] + ("?" + query if query else "")
# Only GET has automatic retries in this workflow. A PATCH or DELETE that got no response or a
# server error is never resent blindly: it may already have been applied, so the caller reads the record first.
resend = route["method"] == "GET"
for attempt in range(5):
try:
status, raw, response_headers = transport(route["method"], url, headers, data)
except (urllib.error.URLError, TimeoutError, ConnectionError, http.client.HTTPException):
if not resend:
raise ApiError(0, None, uncertain=True)
if attempt == 4:
raise
time.sleep(2 ** attempt)
continue
response_headers = {k.lower(): v for k, v in response_headers.items()}
result = None
if status != 304 and raw:
try:
result = decode_json(raw.decode("utf-8"))
except (ValueError, UnicodeError):
if status < 400:
raise RuntimeError("Expected a JSON success response")
if status >= 500 and not resend:
raise ApiError(status, result, uncertain=True)
retry = resend and (status == 429 or status >= 500)
if retry:
if attempt == 4:
raise RuntimeError("Retry limit reached; check the request outcome before starting a new create")
delay = response_headers.get("retry-after", str(2 ** attempt))
time.sleep(max(0, float(delay)))
continue
if status >= 400:
raise ApiError(status, result)
return {"status": status, "body": result, "headers": response_headers, "raw": raw}
raise RuntimeError("Retry limit reached")
def add_offset(offset, received):
result = int(offset) + received
if received <= 0 or result > 2147483647: raise RuntimeError("Cannot advance this int32 offset; reconcile the query")
return str(result)
def both(left,right):
return left and right
def concat(left, right):
return left + right
def items(value):
if not isinstance(value, list): raise RuntimeError("Expected a JSON array")
return value
def count(value):
return len(items(value))
def deep_equal(left,right):
if type(left) is not type(right): return False
if isinstance(left,dict): return left.keys()==right.keys() and all(deep_equal(left[k],right[k]) for k in left)
if isinstance(left,list): return len(left)==len(right) and all(deep_equal(a,b) for a,b in zip(left,right))
return left==right
def either(left, right):
if not isinstance(left, bool) or not isinstance(right, bool): raise RuntimeError("Expected Boolean criteria")
return left or right
def equal(left, right):
return type(left) is type(right) and left == right
def field(value, name):
if not isinstance(value, dict) or name not in value: raise RuntimeError("Missing response field: " + name)
return value[name]
import hashlib
import secrets
from pathlib import Path
class FileSnapshot:
def __init__(self, name, data):
self.name, self.data = name, bytes(data)
self.sha256 = hashlib.sha256(self.data).hexdigest()
def file_length(value): return str(len(value.data))
def file_name(value): return value.name
def file_sha256(value): return value.sha256
def is_empty(value):
return count(value) == 0
def is_present(value):
return value is not None and value != ""
"""Strict private client journal reference; no transport or application dependency."""
from pathlib import Path
import hashlib
import os
import re
import secrets
from urllib.parse import urlsplit
PREAMBLE=b'EXHIBITDAY-GUIDE-JOURNAL 1\n'
class JournalRefusal(RuntimeError):
pass
def utf8(value):
if not isinstance(value,str):raise JournalRefusal('Journal fields are exact strings')
return value.encode('utf-8',errors='strict')
def strings(values):
raw=bytearray()
for value in values:
item=utf8(value);raw.extend(str(len(item)).encode('ascii'));raw.extend(b':');raw.extend(item)
return bytes(raw)
def read_strings(raw):
values=[];offset=0
while offset<len(raw):
end=raw.find(b':',offset)
if end<0:raise JournalRefusal('Incomplete journal string length')
length=raw[offset:end]
if not re.fullmatch(b'0|[1-9][0-9]*',length):raise JournalRefusal('Noncanonical journal string length')
size=int(length);offset=end+1
if size>len(raw)-offset:raise JournalRefusal('Incomplete journal string')
values.append(raw[offset:offset+size].decode('utf-8',errors='strict'));offset+=size
return values
def digest(raw):return hashlib.sha256(raw).hexdigest().upper()
def fingerprint(pairs):
values=[]
for name,value in sorted(pairs.items()):
if not re.fullmatch('[A-Za-z0-9_.-]+',name):raise JournalRefusal('Fingerprint field names must be explicit ASCII identifiers')
if name.lower() in ('api_key','exhibitday_api_key'):raise JournalRefusal('Never fingerprint the API key')
values.extend((name,value))
return digest(strings(values))
def frame(values):
raw=strings(values)
return str(len(raw)).encode('ascii')+b' '+digest(raw).encode('ascii')+b'\n'+raw+b'\n'
def decode(raw):
if not raw.startswith(PREAMBLE):raise JournalRefusal('Unknown or incomplete journal version')
offset=len(PREAMBLE);records=[]
while offset<len(raw):
end=raw.find(b'\n',offset)
if end<0:raise JournalRefusal('Incomplete journal frame header; reconcile before retry')
match=re.fullmatch(b'(0|[1-9][0-9]*) ([0-9A-F]{64})',raw[offset:end])
if match is None:raise JournalRefusal('Invalid journal frame header')
size=int(match[1]);offset=end+1
if size>=len(raw)-offset:raise JournalRefusal('Incomplete journal frame; reconcile before retry')
payload=raw[offset:offset+size];offset+=size
if raw[offset:offset+1]!=b'\n' or digest(payload).encode('ascii')!=match[2]:raise JournalRefusal('Journal integrity check failed; reconcile before retry')
records.append(read_strings(payload));offset+=1
return records
class Journal:
def __init__(self,path,base,workspace,slug,job,input_fingerprint,writes,mode="resume"):
self.path=Path(path);self.lock=Path(str(self.path)+'.lock');self.fd=None;self.owned=False;self.identity=None;self.tainted=False;self.intents={};self.saved_values={}
address=urlsplit(base)
if address.scheme not in ('https','http')or not address.netloc or address.username is not None or address.query or address.fragment or not re.fullmatch('[a-z][a-z0-9-]*',slug):raise JournalRefusal('Use the actual API base and closed guide slug')
if not job.strip() or not re.fullmatch('[1-9][0-9]*',workspace) or not re.fullmatch('[0-9A-F]{64}',input_fingerprint):raise JournalRefusal('Use an actual workspace, explicit stable job ID and exact input fingerprint')
if mode not in ("new","resume"):raise JournalRefusal("Choose new or resume for this local job")
self.allowed={};manifest=[]
for step,method,route in writes:
if not re.fullmatch('[a-z][a-z0-9_-]*',step)or step in self.allowed or method not in ('POST','PATCH','DELETE')or not re.fullmatch('/v1/[A-Za-z0-9_/-]+',route)or'//'in route:raise JournalRefusal('Use a closed unique write manifest')
self.allowed[step]=(method,route);manifest.extend((step,method,route))
if not self.allowed:raise JournalRefusal('Only write workflows need a restart journal')
self.header=['H','1',base,workspace,slug,job,input_fingerprint,digest(strings(manifest))]
strings(self.header)
try:
self.fd=os.open(self.lock,os.O_WRONLY|os.O_CREAT|os.O_EXCL,0o600);self.owned=True
except FileExistsError:raise JournalRefusal('This journal is locked; do not run overlapping jobs or steal a stale lock')
try:
self.owner=secrets.token_hex(16);self.identity=os.fstat(self.fd)
if os.write(self.fd,self.owner.encode('ascii'))!=len(self.owner):raise OSError('Incomplete lock identity write')
os.fsync(self.fd)
if self.path.is_symlink():raise JournalRefusal('Choose a private regular journal file')
if mode=="resume" and not self.path.exists():raise JournalRefusal("Journal missing: stop and reconcile lost state before starting a new job")
if mode=="new" and self.path.exists():raise JournalRefusal("A journal already exists; use resume for the same job")
if mode=="new":
with open(self.path,'xb',buffering=0)as target:
target.write(PREAMBLE+frame(self.header));os.fsync(target.fileno())
records=decode(self.path.read_bytes())
if not records or records[0]!=self.header:raise JournalRefusal('Journal workspace/base/guide/job/input binding differs')
for record in records[1:]:self.apply(record)
if any(step not in self.saved_values for step in self.intents):raise JournalRefusal('A saved before-send intent lacks an ACK; stop and reconcile its outcome before retry')
except BaseException:
self.close();raise
def apply(self,record):
if not record:raise JournalRefusal('Empty journal record')
if record[0]=='I':
if len(record)!=6:raise JournalRefusal('Invalid intent shape')
_,step,method,path,request_fingerprint,key=record
if not re.fullmatch('[a-z][a-z0-9_-]*',step)or step in self.intents or self.allowed.get(step)!=(method,path)or not re.fullmatch('[0-9A-F]{64}',request_fingerprint)or any(name not in self.saved_values for name in self.intents):raise JournalRefusal('Invalid, future or repeated journal intent')
if method=='POST'and not re.fullmatch('[0-9a-f]{32}',key)or method!='POST'and key!='':raise JournalRefusal('Invalid persisted action key')
self.intents[step]={'method':method,'path':path,'request_fingerprint':request_fingerprint,'idempotency_key':key}
elif record[0]=='A':
if len(record)<3:raise JournalRefusal('Invalid ACK shape')
_,step,count,*pairs=record
if not re.fullmatch('0|[1-9][0-9]*',count)or len(pairs)!=2*int(count)or step not in self.intents or step in self.saved_values:raise JournalRefusal('ACK without exactly one prior intent')
names=pairs[::2]
if names!=sorted(set(names))or any(not re.fullmatch('[a-z][a-z0-9_]*',name)or name in ('api_key','exhibitday_api_key')for name in names):raise JournalRefusal('ACK saved fields must be unique sorted secret-free identifiers')
self.saved_values[step]=dict(zip(names,pairs[1::2]))
else:raise JournalRefusal('Unknown journal transition')
def append(self,record):
# The reader commits state only after complete length/digest recognition.
# A torn append is retained and refused, never silently truncated.
self.require_active();raw=frame(record)
try:
with open(self.path,'ab',buffering=0)as target:
view=memoryview(raw)
while view:
written=target.write(view)
if not written:raise OSError('Journal write did not advance')
view=view[written:]
os.fsync(target.fileno())
except BaseException:
self.tainted=True;raise
def require_active(self):
if not self.owned or self.fd is None or self.identity is None or self.tainted:raise JournalRefusal('The journal scope is closed or its IO outcome needs reconciliation')
current=self.lock.stat(follow_symlinks=False)
if current.st_dev!=self.identity.st_dev or current.st_ino!=self.identity.st_ino or self.lock.read_text(encoding='ascii')!=self.owner:raise JournalRefusal('The journal lock was replaced; stop without deleting it')
def acknowledged(self,step):
self.require_active();return step in self.saved_values
def saved(self,step):
self.require_active()
if step not in self.saved_values:raise JournalRefusal('No confirmed state exists for this step')
return dict(self.saved_values[step])
def begin(self,step,method,path,request_fingerprint):
self.require_active()
if step in self.intents:raise JournalRefusal('Never blindly repeat an existing action intent')
key=secrets.token_hex(16)if method=='POST'else''
record=['I',step,method,path,request_fingerprint,key]
# Validate on an isolated state before touching the file.
old=dict(self.intents)
try:self.apply(record)
finally:self.intents=old
self.append(record);self.apply(record)
return dict(self.intents[step])
def acknowledge(self,step,saved):
self.require_active()
record=['A',step,str(len(saved))]
for name,value in sorted(saved.items()):record.extend((name,value))
old={name:dict(value)for name,value in self.saved_values.items()}
try:self.apply(record);strings(record)
finally:self.saved_values=old
self.append(record);self.apply(record)
def close(self):
if self.owned:
if self.tainted:
os.close(self.fd);self.fd=None;self.owned=False
return # Retain this lock after failed journal IO; manual reconciliation is required.
try:self.require_active()
except BaseException:
os.close(self.fd);self.fd=None;self.owned=False;raise
os.close(self.fd);self.fd=None;self.owned=False
self.lock.unlink()
def __enter__(self):return self
def __exit__(self,*args):self.close()
def journal_values(value):
if not isinstance(value, dict) or any(not isinstance(k, str) or not isinstance(v, str) for k,v in value.items()):
raise JournalRefusal('Saved/fingerprint values must be exact string fields')
return dict(value)
def journal_acknowledge(job, step, saved):
job.acknowledge(step,journal_values(saved))
def journal_acknowledged(job, step):
return job.acknowledged(step)
def journal_begin(job, step, method, path, request_fingerprint):
return job.begin(step,method,path,request_fingerprint)
def journal_fingerprint(value):
return fingerprint(journal_values(value))
def journal_saved(job, step):
return job.saved(step)
def json_string(value):
return json.dumps(value,ensure_ascii=False,allow_nan=False,separators=(",",":"))
def new_id_set():
return set()
def not_value(value):
if not isinstance(value, bool): raise RuntimeError("Expected a Boolean")
return not value
def open_journal(path, base, workspace, slug, job, input_fingerprint, writes, mode):
return Journal(path,base,workspace,slug,job,input_fingerprint,writes,mode)
def optional(name, fallback):
value = os.environ.get(name)
return fallback if value is None or value == "" else value
def parse_json(value):
return json.loads(value)
def positive_id(value):
if not re.fullmatch(r"[1-9][0-9]*", value) or int(value) > 9223372036854775807: raise RuntimeError("Use a positive record ID")
return value
def print_value(value):
print(value if isinstance(value, str) else json.dumps(value, ensure_ascii=False))
def read_file_snapshot(path, action):
rule = SPEC['requests'][action].get('file')
if not rule or rule['name'] != 'file': raise RuntimeError('Use the current declared file input')
data = Path(path).read_bytes()
if not data or len(data) > int(rule['maximum_bytes']): raise RuntimeError('The selected file is empty or exceeds this endpoint file limit')
name = Path(path).name
if not name or any(c in name for c in '\r\n\0'): raise RuntimeError('Use a filename without header control characters')
return FileSnapshot(name, data)
def remember_id(seen, value):
if value in seen: return False
seen.add(value)
return True
def request_download(name, params):
route = SPEC['requests'][name]
if route['method'] != 'GET' or route.get('binary') is not True: raise RuntimeError('Bind the declared binary GET')
query = urllib.parse.urlencode(params or {})
status, raw, headers = transport('GET', BASE + route['path'] + ('?' + query if query else ''), {'Authorization': 'Bearer ' + API_KEY, 'Accept': 'application/octet-stream'}, None)
if status != 200:
parsed = None
try: parsed = decode_json(raw.decode('utf-8'))
except (ValueError, UnicodeError): pass
raise ApiError(status, parsed)
return bytes(raw)
def request_expect(name,query,body,key,expected):
try:
call(name,query,body,key)
except ApiError as observed:
if observed.uncertain or str(observed.status)!=expected:
raise
return str(observed.status)
raise RuntimeError("Expected HTTP "+expected+" refusal; request unexpectedly succeeded")
def request_upload(name, params, file, key):
route = SPEC['requests'][name]
if route['method'] != 'POST' or not route.get('file') or not key: raise RuntimeError('Bind one declared upload and its persisted create key')
boundary = 'ExhibitDayGuide' + secrets.token_hex(24)
while boundary.encode('ascii') in file.data: boundary = 'ExhibitDayGuide' + secrets.token_hex(24)
quoted = file.name.replace('\\', '\\\\').replace('"', '\\"')
data = ('--' + boundary + '\r\nContent-Disposition: form-data; name="file"; filename="' + quoted + '"\r\nContent-Type: application/octet-stream\r\n\r\n').encode('utf-8') + file.data + ('\r\n--' + boundary + '--\r\n').encode('ascii')
headers = {'Authorization': 'Bearer ' + API_KEY, 'Accept': 'application/json', 'Idempotency-Key': key, 'Content-Type': 'multipart/form-data; boundary=' + boundary}
query = urllib.parse.urlencode(params or {})
url = BASE + route['path'] + ('?' + query if query else '')
try: status, raw, response_headers = transport('POST', url, headers, data)
except (urllib.error.URLError, TimeoutError, ConnectionError, http.client.HTTPException): raise ApiError(0, None, uncertain=True)
parsed = None
try: parsed = decode_json(raw.decode('utf-8'))
except (ValueError, UnicodeError): pass
if status != 200: raise ApiError(status, parsed, uncertain=status >= 500)
if not isinstance(parsed, dict): raise RuntimeError('Upload returned no usable JSON receipt; reconcile before retrying')
return {'status': status, 'body': parsed, 'headers': {k.lower(): v for k,v in response_headers.items()}, 'raw': raw}
def require_condition(value, message):
if value is not True: raise RuntimeError(message)
def required(name):
value = os.environ.get(name)
if value is None or not value.strip(): raise RuntimeError("Set " + name)
return value
def response_status(value):
return str(value["status"])
def save_checked_download(data, file, path):
if len(data) != len(file.data) or hashlib.sha256(data).hexdigest() != file.sha256: raise RuntimeError('Downloaded bytes differ; no output was created')
descriptor = os.open(path, os.O_CREAT | os.O_EXCL | os.O_WRONLY | getattr(os, 'O_BINARY', 0), 0o600)
with os.fdopen(descriptor, 'wb') as output:
output.write(data); output.flush(); os.fsync(output.fileno())
def single(value):
rows=items(value)
if len(rows)!=1: raise RuntimeError('Expected exactly one selected record')
return rows[0]
def text(value):
if value is None: return ""
if isinstance(value, str): return value
if isinstance(value, bool): return "true" if value else "false"
if isinstance(value, int): return str(value)
raise RuntimeError("Expected a scalar response value")
def main():
integration_event_id = positive_id(required("EXHIBITDAY_EVENT_ID"))
integration_job_id = required("EXHIBITDAY_JOB_ID")
integration_job_hash = journal_fingerprint({"job_id": integration_job_id})
integration_initial_name = concat("API integration check ", integration_job_hash)
integration_updated_name = concat(integration_initial_name, " updated")
integration_file = read_file_snapshot(required("EXHIBITDAY_FILE"), "upload")
integration_output_path = required("EXHIBITDAY_DOWNLOAD_PATH")
integration_cleanup = optional("EXHIBITDAY_TEST_CLEANUP", "keep")
require_condition(either(equal(integration_cleanup, "keep"), equal(integration_cleanup, "delete")), "Use keep or delete for EXHIBITDAY_TEST_CLEANUP.")
integration_workspace_response = call("workspace_binding", {}, None, None)
require_condition(equal(response_status(integration_workspace_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_workspace = integration_workspace_response["body"]
integration_workspace_id = positive_id(text(field(integration_workspace, "id")))
integration_state_path = required("EXHIBITDAY_TEST_STATE")
integration_job_mode = optional("EXHIBITDAY_JOB_MODE", "resume")
integration_job = open_journal(integration_state_path, "https://api.exhibitday.com/v1", integration_workspace_id, "integration-testing", integration_job_id, journal_fingerprint({"workflow_contract_sha256": "3808BE3DE866226BE6AAA4C445EBC19FC7903FD96FC8DC2F223F6D6451BA6267", "event_id": integration_event_id, "initial_name": integration_initial_name, "updated_name": integration_updated_name, "filename": file_name(integration_file), "file_length": file_length(integration_file), "file_sha256": file_sha256(integration_file)}), [["create", "POST", "/v1/tasks"], ["edit", "PATCH", "/v1/tasks"], ["stale", "PATCH", "/v1/tasks"], ["upload", "POST", "/v1/tasks/attachments"], ["remove_file", "DELETE", "/v1/tasks/attachments"], ["remove_task", "DELETE", "/v1/tasks"]], integration_job_mode)
try:
integration_task_id = ""
integration_attachment_id = ""
if not_value(journal_acknowledged(integration_job, "remove_task")):
if not_value(journal_acknowledged(integration_job, "create")):
integration_create_intent = journal_begin(integration_job, "create", "POST", "/v1/tasks", journal_fingerprint({"event_id": integration_event_id, "name": integration_initial_name}))
integration_created_response = call("create", {}, {"event_id": integration_event_id, "name": integration_initial_name}, text(field(integration_create_intent, "idempotency_key")))
require_condition(equal(response_status(integration_created_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_created = integration_created_response["body"]
integration_task_id = positive_id(text(field(integration_created, "id")))
require_condition(both(equal(text(field(integration_created, "id")), integration_task_id), both(equal(text(field(field(integration_created, "event"), "id")), integration_event_id), equal(text(field(integration_created, "name")), integration_initial_name))), "The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.")
journal_acknowledge(integration_job, "create", {"task_id": integration_task_id, "event_id": integration_event_id, "name": integration_initial_name, "create_key": text(field(integration_create_intent, "idempotency_key"))})
integration_saved_create = journal_saved(integration_job, "create")
integration_task_id = positive_id(text(field(integration_saved_create, "task_id")))
require_condition(both(equal(text(field(integration_saved_create, "event_id")), integration_event_id), equal(text(field(integration_saved_create, "name")), integration_initial_name)), "Saved create state differs from this Event/job.")
require_condition(either(not_value(journal_acknowledged(integration_job, "remove_file")), equal(integration_cleanup, "delete")), "Cleanup already removed the test file. Continue with EXHIBITDAY_TEST_CLEANUP=delete to finish this Task cleanup.")
integration_before_response = call("read", {"id": integration_task_id, "$include_record_revision": "true"}, None, None)
require_condition(equal(response_status(integration_before_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_before = integration_before_response["body"]
if not_value(journal_acknowledged(integration_job, "edit")):
require_condition(both(equal(text(field(integration_before, "id")), integration_task_id), both(equal(text(field(field(integration_before, "event"), "id")), integration_event_id), equal(text(field(integration_before, "name")), integration_initial_name))), "The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.")
integration_original_revision = text(field(integration_before, "record_revision"))
require_condition(is_present(integration_original_revision), "Read the actual created Task revision before editing.")
journal_begin(integration_job, "edit", "PATCH", "/v1/tasks", journal_fingerprint({"id": integration_task_id, "name": integration_updated_name, "expected_revision": integration_original_revision}))
integration_edit_response = call("edit", {}, {"id": integration_task_id, "name": integration_updated_name, "expected_revision": integration_original_revision}, None)
require_condition(equal(response_status(integration_edit_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_edit_receipt = integration_edit_response["body"]
integration_saved_revision = text(field(integration_edit_receipt, "record_revision"))
require_condition(both(is_present(integration_saved_revision), not_value(equal(integration_original_revision, integration_saved_revision))), "The distinct test name must produce a checked new revision before the stale test.")
journal_acknowledge(integration_job, "edit", {"task_id": integration_task_id, "name": integration_updated_name, "original_revision": integration_original_revision, "record_revision": integration_saved_revision})
integration_saved_edit = journal_saved(integration_job, "edit")
require_condition(both(equal(text(field(integration_saved_edit, "task_id")), integration_task_id), equal(text(field(integration_saved_edit, "name")), integration_updated_name)), "Saved edit state differs from this Task/name.")
if not_value(journal_acknowledged(integration_job, "stale")):
journal_begin(integration_job, "stale", "PATCH", "/v1/tasks", journal_fingerprint({"id": integration_task_id, "name": "Refused stale test", "expected_revision": text(field(integration_saved_edit, "original_revision"))}))
integration_stale_status = request_expect("stale", {}, {"id": integration_task_id, "name": "Refused stale test", "expected_revision": text(field(integration_saved_edit, "original_revision"))}, None, "409")
journal_acknowledge(integration_job, "stale", {"task_id": integration_task_id, "observed_status": integration_stale_status})
integration_saved_stale = journal_saved(integration_job, "stale")
require_condition(both(equal(text(field(integration_saved_stale, "task_id")), integration_task_id), equal(text(field(integration_saved_stale, "observed_status")), "409")), "The saved conflict assertion differs from this Task/status.")
integration_after_edit_response = call("after_edit", {"id": integration_task_id, "$include_record_revision": "true"}, None, None)
require_condition(equal(response_status(integration_after_edit_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_after_edit = integration_after_edit_response["body"]
require_condition(both(equal(text(field(integration_after_edit, "id")), integration_task_id), both(equal(text(field(field(integration_after_edit, "event"), "id")), integration_event_id), equal(text(field(integration_after_edit, "name")), integration_updated_name))), "The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.")
require_condition(equal(text(field(integration_after_edit, "record_revision")), text(field(integration_saved_edit, "record_revision"))), "The test Task's revision changed; stop before file work or cleanup.")
require_condition(either(not_value(equal(integration_cleanup, "delete")), deep_equal(field(integration_after_edit, "comments"), [])), "The test Task has comments; stop before cleanup.")
if not_value(journal_acknowledged(integration_job, "upload")):
require_condition(equal(text(field(integration_after_edit, "record_revision")), text(field(integration_saved_edit, "record_revision"))), "The Task changed after the conditional edit. Review it before uploading.")
integration_upload_intent = journal_begin(integration_job, "upload", "POST", "/v1/tasks/attachments", journal_fingerprint({"task_id": integration_task_id, "filename": file_name(integration_file), "file_length": file_length(integration_file), "file_sha256": file_sha256(integration_file)}))
integration_upload_response = request_upload("upload", {"task_id": integration_task_id}, integration_file, text(field(integration_upload_intent, "idempotency_key")))
require_condition(equal(response_status(integration_upload_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_upload = integration_upload_response["body"]
require_condition(both(equal(text(field(integration_upload, "records_found")), "1"), both(equal(text(field(integration_upload, "total_records")), "1"), equal(field(integration_upload, "has_more"), False))), "Require exactly one complete uploaded-file receipt.")
integration_uploaded_file = single(field(integration_upload, "list_data"))
integration_attachment_id = positive_id(text(field(integration_uploaded_file, "id")))
require_condition(is_present(text(field(integration_uploaded_file, "filename"))), "The upload receipt needs its actual stored filename.")
journal_acknowledge(integration_job, "upload", {"task_id": integration_task_id, "attachment_id": integration_attachment_id, "filename": text(field(integration_uploaded_file, "filename")), "attachment_json": json_string(integration_uploaded_file), "file_length": file_length(integration_file), "file_sha256": file_sha256(integration_file)})
integration_saved_upload = journal_saved(integration_job, "upload")
integration_attachment_id = positive_id(text(field(integration_saved_upload, "attachment_id")))
require_condition(both(equal(text(field(integration_saved_upload, "task_id")), integration_task_id), both(equal(text(field(integration_saved_upload, "file_length")), file_length(integration_file)), equal(text(field(integration_saved_upload, "file_sha256")), file_sha256(integration_file)))), "The confirmed file differs from the saved test Task or file details.")
if not_value(journal_acknowledged(integration_job, "remove_file")):
integration_list_offset = "0"
integration_file_count = "0"
integration_file_found = False
integration_file_seen = new_id_set()
integration_list_query = {"task_id": integration_task_id, "$limit": "25", "$offset": "0"}
while True:
integration_list_query["$offset"] = integration_list_offset
integration_list_response = call("verify_file", integration_list_query, None, None)
require_condition(equal(response_status(integration_list_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_list = integration_list_response["body"]
integration_list_rows = items(field(integration_list, "list_data"))
require_condition(equal(text(field(integration_list, "records_found")), text(count(integration_list_rows))), "The Task file page count differs from its rows.")
require_condition(is_present(text(field(integration_list, "total_records"))), "The Task file page needs total_records.")
require_condition(either(equal(field(integration_list, "has_more"), True), equal(field(integration_list, "has_more"), False)), "The Task file page needs Boolean has_more.")
for integration_list_row in items(integration_list_rows):
integration_list_id = positive_id(text(field(integration_list_row, "id")))
require_condition(remember_id(integration_file_seen, integration_list_id), "A Task file ID repeated while paging.")
if equal(integration_list_id, integration_attachment_id):
require_condition(deep_equal(integration_list_row, parse_json(text(field(integration_saved_upload, "attachment_json")))), "The saved Task file details changed.")
integration_file_found = True
integration_file_count = add_offset(integration_file_count, count(integration_list_rows))
if equal(field(integration_list, "has_more"), False):
break
require_condition(not_value(is_empty(integration_list_rows)), "An empty Task file page says has_more=true.")
integration_list_offset = add_offset(integration_list_offset, count(integration_list_rows))
require_condition(integration_file_found, "The saved file is not on this Task; stop before downloading by id or cleaning up.")
require_condition(either(not_value(equal(integration_cleanup, "delete")), equal(integration_file_count, "1")), "Another Task file exists; stop before deleting the test Task.")
integration_download_response = request_download("download", {"id": integration_attachment_id})
save_checked_download(integration_download_response, integration_file, integration_output_path)
if equal(integration_cleanup, "delete"):
if not_value(journal_acknowledged(integration_job, "remove_file")):
journal_begin(integration_job, "remove_file", "DELETE", "/v1/tasks/attachments", journal_fingerprint({"id": integration_attachment_id}))
integration_file_remove_response = call("remove_file", {"id": integration_attachment_id}, None, None)
require_condition(equal(response_status(integration_file_remove_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
journal_acknowledge(integration_job, "remove_file", {"task_id": integration_task_id, "attachment_id": integration_attachment_id})
if not_value(journal_acknowledged(integration_job, "remove_task")):
journal_begin(integration_job, "remove_task", "DELETE", "/v1/tasks", journal_fingerprint({"id": integration_task_id}))
integration_task_remove_response = call("remove_task", {"id": integration_task_id}, None, None)
require_condition(equal(response_status(integration_task_remove_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
journal_acknowledge(integration_job, "remove_task", {"task_id": integration_task_id})
else:
print_value({"task_id": integration_task_id, "attachment_id": integration_attachment_id, "cleanup": "kept"})
if journal_acknowledged(integration_job, "remove_task"):
integration_removed = journal_saved(integration_job, "remove_task")
integration_task_id = positive_id(text(field(integration_removed, "task_id")))
integration_missing_status = request_expect("verify_removed", {"id": integration_task_id}, None, None, "404")
print_value({"task_id": integration_task_id, "cleanup": "removed", "observed_missing_status": integration_missing_status})
finally:
integration_job.close()
if __name__ == "__main__":
main()
EXHIBITDAY_PY
// Server-side Node.js with fetch; built-in modules only. Set EXHIBITDAY_API_KEY.
const BASE = "https://api.exhibitday.com/v1";
const SPEC = JSON.parse("{\"preserveNumbers\":true,\"requests\":{\"workspace_binding\":{\"method\":\"GET\",\"path\":\"/references/workspace_info\"},\"create\":{\"method\":\"POST\",\"path\":\"/tasks\"},\"read\":{\"method\":\"GET\",\"path\":\"/tasks/info\"},\"edit\":{\"method\":\"PATCH\",\"path\":\"/tasks\"},\"stale\":{\"method\":\"PATCH\",\"path\":\"/tasks\"},\"after_edit\":{\"method\":\"GET\",\"path\":\"/tasks/info\"},\"upload\":{\"method\":\"POST\",\"path\":\"/tasks/attachments\",\"file\":{\"name\":\"file\",\"maximum_bytes\":\"26214400\",\"extensions\":[\"png\",\"jpg\",\"jpeg\",\"bmp\",\"gif\",\"pdf\",\"msg\",\"eml\",\"doc\",\"docx\",\"ppt\",\"pptx\",\"xls\",\"xlsx\",\"csv\",\"rtf\",\"odp\",\"odt\",\"ods\",\"txt\",\"wks\",\"zip\"],\"content_types\":[]}},\"verify_file\":{\"method\":\"GET\",\"path\":\"/tasks/attachments\"},\"download\":{\"method\":\"GET\",\"path\":\"/tasks/attachments/download\",\"binary\":true},\"remove_file\":{\"method\":\"DELETE\",\"path\":\"/tasks/attachments\"},\"remove_task\":{\"method\":\"DELETE\",\"path\":\"/tasks\"},\"verify_removed\":{\"method\":\"GET\",\"path\":\"/tasks/info\"}}}");
const API_KEY = process.env.EXHIBITDAY_API_KEY;
if (!API_KEY || !API_KEY.trim()) throw new Error("Set EXHIBITDAY_API_KEY");
if (/[^\x20-\x7e]/.test(API_KEY)) throw new Error("Use the API key as one ASCII header value without control characters");
const sleep = milliseconds => new Promise(resolve => setTimeout(resolve, milliseconds));
function decodeJson(text) {
if (SPEC.preserveNumbers) {
// Keep raw JSON number tokens exact for CSV; quoted JSON strings remain unchanged.
text = text.replace(/"(?:\\.|[^"\\])*"|-?\d+(?:\.\d+)?(?:[eE][+-]?\d+)?/g,
token => token.startsWith('"') ? token : JSON.stringify(token));
}
return JSON.parse(text);
}
// An API error response. Branch on errorCode (and status), never on the message text.
// uncertain is true when a PATCH or DELETE got no response or a server error: it may or may not have been applied.
class ApiError extends Error {
constructor(status, result, uncertain = false) {
super(result ? JSON.stringify({ error_code: result.error_code, errors: result.errors,
error_params: result.error_params, request_id: result.request_id }) : status ? "HTTP " + status : "No response");
this.status = status;
this.errorCode = result ? result.error_code : undefined;
this.uncertain = uncertain;
}
}
async function call(name, params = {}, body = null, key = null) {
const route = SPEC.requests[name];
const headers = { Authorization: "Bearer " + API_KEY, Accept: "application/json" };
if (route.method === "POST") {
if (!key) throw new Error("Save a create key before sending POST");
headers["Idempotency-Key"] = key;
}
const data = body === null ? undefined : JSON.stringify(body);
if (data !== undefined) headers["Content-Type"] = "application/json";
const query = new URLSearchParams(params).toString();
const url = BASE + route.path + (query ? "?" + query : "");
// Only GET has automatic retries in this workflow. A PATCH or DELETE that got no response or a
// server error is never resent blindly: it may already have been applied, so the caller reads the record first.
const resend = route.method === "GET";
for (let attempt = 0; attempt < 5; attempt++) {
const controller = new AbortController();
const timer = setTimeout(() => controller.abort(), 30000);
let response, raw;
try {
response = await fetch(url, { method: route.method, headers, body: data, signal: controller.signal, redirect: "error" });
raw = await response.text();
} catch (error) {
if (!resend) throw new ApiError(0, null, true);
if (attempt === 4) throw error;
await sleep(1000 * 2 ** attempt);
continue;
} finally { clearTimeout(timer); }
const resultHeaders = {};
response.headers.forEach((value, name) => { resultHeaders[name.toLowerCase()] = value; });
let result = null;
if (response.status !== 304 && raw) {
try { result = decodeJson(raw); }
catch (error) { if (response.status < 400) throw new Error("Expected a JSON success response"); }
}
if (response.status >= 500 && !resend) throw new ApiError(response.status, result, true);
const retry = resend && (response.status === 429 || response.status >= 500);
if (retry) {
if (attempt === 4) throw new Error("Retry limit reached; check the outcome before starting a new create");
const requested = Number(resultHeaders["retry-after"]);
await sleep(1000 * (Number.isFinite(requested) && requested >= 0 ? requested : 2 ** attempt));
continue;
}
if (response.status >= 400) throw new ApiError(response.status, result);
return { status: response.status, body: result, headers: resultHeaders, raw };
}
throw new Error("Retry limit reached");
}
function add_offset(offset, received) { const result = BigInt(offset) + received; if (received <= 0n || result > 2147483647n) throw new Error("Cannot advance this int32 offset; reconcile the query"); return result.toString(); }
function both(left,right) { return left && right; }
function concat(left, right) { return left + right; }
function items(value) { if (!Array.isArray(value)) throw new Error("Expected a JSON array"); return value; }
function count(value) { return BigInt(items(value).length); }
function deep_equal(left,right) {
if(left===null||right===null)return left===right;
if(typeof left!==typeof right||Array.isArray(left)!==Array.isArray(right))return false;
if(typeof left!=='object')return left===right;
const a=Object.keys(left).sort(),b=Object.keys(right).sort();return a.length===b.length&&a.every((k,i)=>k===b[i]&&deep_equal(left[k],right[k]));
}
function either(left, right) { if (typeof left !== "boolean" || typeof right !== "boolean") throw new Error("Expected Boolean criteria"); return left || right; }
function equal(left, right) { return typeof left === typeof right && left === right; }
function field(value, name) { if (!value || Array.isArray(value) || typeof value !== "object" || !Object.hasOwn(value, name)) throw new Error("Missing response field: " + name); return value[name]; }
const fileFs = require('node:fs');
const filePath = require('node:path');
const fileCrypto = require('node:crypto');
function file_length(value) { return String(value.data.length); }
function file_name(value) { return value.name; }
function file_sha256(value) { return value.sha256; }
function is_empty(value) { return count(value) === 0n; }
function is_present(value) { return value !== null && value !== undefined && value !== ""; }
'use strict';
// Private client restart state. No HTTP or application dependency.
const fs = require('node:fs');
const crypto = require('node:crypto');
const PREAMBLE = Buffer.from('EXHIBITDAY-GUIDE-JOURNAL 1\n', 'ascii');
class JournalRefusal extends Error {}
function ascii(raw) {
if (raw.some(value => value > 127)) throw new JournalRefusal('Journal framing must be canonical ASCII');
return raw.toString('ascii');
}
function utf8(value) {
if (typeof value !== 'string') throw new JournalRefusal('Journal fields are exact strings');
for (const unit of value) if (unit.length === 1 && unit.charCodeAt(0) >= 0xd800 && unit.charCodeAt(0) <= 0xdfff)
throw new JournalRefusal('Invalid Unicode journal field');
return Buffer.from(value, 'utf8');
}
function strings(values) {
const parts = [];
for (const value of values) { const raw = utf8(value); parts.push(Buffer.from(String(raw.length) + ':', 'ascii'), raw); }
return Buffer.concat(parts);
}
function readStrings(raw) {
const values = []; let offset = 0;
while (offset < raw.length) {
const end = raw.indexOf(58, offset);
if (end < 0) throw new JournalRefusal('Incomplete journal string length');
const length = ascii(raw.subarray(offset, end));
if (!/^(0|[1-9][0-9]*)$/.test(length)) throw new JournalRefusal('Noncanonical journal string length');
const size = BigInt(length); offset = end + 1;
if (size > BigInt(raw.length - offset)) throw new JournalRefusal('Incomplete journal string');
const count = Number(size);
values.push(new TextDecoder('utf-8', { fatal: true, ignoreBOM: true }).decode(raw.subarray(offset, offset + count))); offset += count;
}
return values;
}
function digest(raw) { return crypto.createHash('sha256').update(raw).digest('hex').toUpperCase(); }
function fingerprint(pairs) {
const values = [];
for (const name of Object.keys(pairs).sort()) {
if (!/^[A-Za-z0-9_.-]+$/.test(name) || ['api_key', 'exhibitday_api_key'].includes(name.toLowerCase()))
throw new JournalRefusal('Use explicit secret-free fingerprint field names');
values.push(name, pairs[name]);
}
return digest(strings(values));
}
function frame(values) {
const raw = strings(values);
return Buffer.concat([Buffer.from(String(raw.length) + ' ' + digest(raw) + '\n', 'ascii'), raw, Buffer.from('\n')]);
}
function decode(raw) {
if (!raw.subarray(0, PREAMBLE.length).equals(PREAMBLE)) throw new JournalRefusal('Unknown or incomplete journal version');
let offset = PREAMBLE.length; const records = [];
while (offset < raw.length) {
const end = raw.indexOf(10, offset);
if (end < 0) throw new JournalRefusal('Incomplete journal frame header; reconcile before retry');
const match = /^(0|[1-9][0-9]*) ([0-9A-F]{64})$/.exec(ascii(raw.subarray(offset, end)));
if (!match) throw new JournalRefusal('Invalid journal frame header');
const size = BigInt(match[1]); offset = end + 1;
if (size >= BigInt(raw.length - offset)) throw new JournalRefusal('Incomplete journal frame; reconcile before retry');
const count = Number(size), payload = raw.subarray(offset, offset + count); offset += count;
if (raw[offset] !== 10 || digest(payload) !== match[2]) throw new JournalRefusal('Journal integrity check failed; reconcile before retry');
records.push(readStrings(payload)); offset++;
}
return records;
}
function writeAll(fd, raw) {
let offset = 0;
while (offset < raw.length) { const count = fs.writeSync(fd, raw, offset, raw.length - offset); if (!count) throw new Error('Journal write did not advance'); offset += count; }
}
function same(left, right) { return left.length === right.length && left.every((value, index) => value === right[index]); }
class Journal {
constructor(path, base, workspace, slug, job, inputFingerprint, writes, mode = 'resume') {
this.path = path; this.lock = path + '.lock'; this.fd = null; this.owned = false; this.identity = null; this.tainted = false;
this.intents = new Map(); this.savedValues = new Map(); this.allowed = new Map();
if (!['new', 'resume'].includes(mode)) throw new JournalRefusal('Choose new or resume for this local job');
const address = new URL(base);
if (!['https:', 'http:'].includes(address.protocol) || !address.hostname || address.username || address.password || address.search || address.hash || !/^[a-z][a-z0-9-]*$/.test(slug))
throw new JournalRefusal('Use the actual API base and closed guide slug');
if (!job.trim() || !/^[1-9][0-9]*$/.test(workspace) || !/^[0-9A-F]{64}$/.test(inputFingerprint))
throw new JournalRefusal('Use an actual workspace, stable explicit job ID and exact input fingerprint');
const manifest = [];
for (const [step, method, route] of writes) {
if (!/^[a-z][a-z0-9_-]*$/.test(step) || this.allowed.has(step) || !['POST', 'PATCH', 'DELETE'].includes(method) || !/^\/v1\/[A-Za-z0-9_/-]+$/.test(route) || route.includes('//'))
throw new JournalRefusal('Use a closed unique write manifest');
this.allowed.set(step, [method, route]); manifest.push(step, method, route);
}
if (!this.allowed.size) throw new JournalRefusal('Only write workflows need a restart journal');
this.header = ['H', '1', base, workspace, slug, job, inputFingerprint, digest(strings(manifest))]; strings(this.header);
try { this.fd = fs.openSync(this.lock, 'wx', 0o600); this.owned = true; }
catch (error) { if (error.code === 'EEXIST') throw new JournalRefusal('This journal is locked; do not overlap jobs or steal a stale lock'); throw error; }
try {
this.owner = crypto.randomBytes(16).toString('hex'); this.identity = fs.fstatSync(this.fd, { bigint: true });
writeAll(this.fd, Buffer.from(this.owner, 'ascii')); fs.fsyncSync(this.fd);
let exists = true;
try { if (fs.lstatSync(path).isSymbolicLink()) throw new JournalRefusal('Choose a private regular journal file'); }
catch (error) { if (error.code === 'ENOENT') exists = false; else throw error; }
if (mode === 'resume' && !exists) throw new JournalRefusal('Journal missing: stop and reconcile lost state before starting a new job');
if (mode === 'new' && exists) throw new JournalRefusal('Journal already exists; use resume for the same job');
if (mode === 'new') {
const target = fs.openSync(path, 'wx', 0o600);
try { writeAll(target, Buffer.concat([PREAMBLE, frame(this.header)])); fs.fsyncSync(target); } finally { fs.closeSync(target); }
}
const records = decode(fs.readFileSync(path));
if (!records.length || !same(records[0], this.header)) throw new JournalRefusal('Journal workspace/base/guide/job/input binding differs');
for (const record of records.slice(1)) this.apply(record);
if ([...this.intents.keys()].some(step => !this.savedValues.has(step))) throw new JournalRefusal('Saved before-send intent lacks ACK; stop and reconcile before retry');
} catch (error) { this.close(); throw error; }
}
apply(record) {
if (record[0] === 'I') {
if (record.length !== 6) throw new JournalRefusal('Invalid intent shape');
const [, step, method, path, requestFingerprint, key] = record;
if (!/^[a-z][a-z0-9_-]*$/.test(step) || this.intents.has(step) || !this.allowed.has(step) || !same(this.allowed.get(step), [method, path]) || !/^[0-9A-F]{64}$/.test(requestFingerprint) || [...this.intents.keys()].some(name => !this.savedValues.has(name)))
throw new JournalRefusal('Invalid, future or repeated intent');
if ((method === 'POST' && !/^[0-9a-f]{32}$/.test(key)) || (method !== 'POST' && key !== '')) throw new JournalRefusal('Invalid persisted action key');
this.intents.set(step, { method, path, request_fingerprint: requestFingerprint, idempotency_key: key });
} else if (record[0] === 'A') {
const [, step, count, ...pairs] = record;
if (record.length < 3 || !/^(0|[1-9][0-9]*)$/.test(count) || BigInt(pairs.length) !== 2n * BigInt(count) || !this.intents.has(step) || this.savedValues.has(step))
throw new JournalRefusal('ACK without exactly one prior intent');
const names = pairs.filter((_, index) => index % 2 === 0);
if (!same(names, [...new Set(names)].sort()) || names.some(name => !/^[a-z][a-z0-9_]*$/.test(name) || ['api_key', 'exhibitday_api_key'].includes(name)))
throw new JournalRefusal('ACK fields must be unique sorted secret-free identifiers');
this.savedValues.set(step, Object.fromEntries(names.map((name, index) => [name, pairs[index * 2 + 1]])));
} else throw new JournalRefusal('Unknown journal transition');
}
requireActive() {
if (!this.owned || this.fd === null || this.identity === null || this.tainted) throw new JournalRefusal('Journal is closed or its IO outcome needs reconciliation');
const current = fs.lstatSync(this.lock, { bigint: true });
if (current.dev !== this.identity.dev || current.ino !== this.identity.ino || ascii(fs.readFileSync(this.lock)) !== this.owner)
throw new JournalRefusal('Journal lock was replaced; stop without deleting it');
}
append(record) {
this.requireActive(); const raw = frame(record); let target;
try { target = fs.openSync(this.path, 'a'); writeAll(target, raw); fs.fsyncSync(target); }
catch (error) { this.tainted = true; throw error; }
finally { if (target !== undefined) fs.closeSync(target); }
}
acknowledged(step) { this.requireActive(); return this.savedValues.has(step); }
saved(step) { this.requireActive(); if (!this.savedValues.has(step)) throw new JournalRefusal('No confirmed state exists'); return { ...this.savedValues.get(step) }; }
begin(step, method, path, requestFingerprint) {
this.requireActive(); if (this.intents.has(step)) throw new JournalRefusal('Never blindly repeat an existing action');
const key = method === 'POST' ? crypto.randomBytes(16).toString('hex') : '', record = ['I', step, method, path, requestFingerprint, key];
const old = new Map(this.intents); try { this.apply(record); } finally { this.intents = old; }
this.append(record); this.apply(record); return { ...this.intents.get(step) };
}
acknowledge(step, saved) {
this.requireActive(); const names = Object.keys(saved).sort(), record = ['A', step, String(names.length)];
for (const name of names) record.push(name, saved[name]);
const old = new Map(this.savedValues); try { this.apply(record); strings(record); } finally { this.savedValues = old; }
this.append(record); this.apply(record);
}
close() {
if (!this.owned) return;
if (this.tainted) { fs.closeSync(this.fd); this.fd = null; this.owned = false; return; }
try { this.requireActive(); }
catch (error) { fs.closeSync(this.fd); this.fd = null; this.owned = false; throw error; }
fs.closeSync(this.fd); this.fd = null; this.owned = false; fs.unlinkSync(this.lock);
}
}
function journal_values(value) {
if (!value || typeof value !== 'object' || Array.isArray(value) || Object.values(value).some(item=>typeof item!=='string')) throw new JournalRefusal('Saved/fingerprint values must be exact strings');
return {...value};
}
function journal_acknowledge(job,step,saved) { job.acknowledge(step,journal_values(saved)); }
function journal_acknowledged(job,step) { return job.acknowledged(step); }
function journal_begin(job,step,method,path,requestFingerprint) { return job.begin(step,method,path,requestFingerprint); }
function journal_fingerprint(value) { return fingerprint(journal_values(value)); }
function journal_saved(job,step) { return job.saved(step); }
function json_string(value) { return JSON.stringify(value); }
function new_id_set() { return new Set(); }
function not_value(value) { if (typeof value !== "boolean") throw new Error("Expected a Boolean"); return !value; }
function open_journal(path,base,workspace,slug,job,inputFingerprint,writes,mode) { return new Journal(path,base,workspace,slug,job,inputFingerprint,writes,mode); }
function optional(name, fallback) { const value = process.env[name]; return value === undefined || value === "" ? fallback : value; }
function parse_json(value) { return JSON.parse(value); }
function positive_id(value) { if (!/^[1-9][0-9]*$/.test(value) || BigInt(value) > 9223372036854775807n) throw new Error("Use a positive record ID"); return value; }
function print_value(value) { console.log(typeof value === "string" ? value : JSON.stringify(value)); }
function read_file_snapshot(path, action) {
const rule = SPEC.requests[action].file;
if (!rule || rule.name !== 'file') throw new Error('Use the current declared file input');
const data = Buffer.from(fileFs.readFileSync(path));
if (!data.length || data.length > Number(rule.maximum_bytes)) throw new Error('The selected file is empty or exceeds this endpoint file limit');
const name = filePath.basename(path);
if (!name || /[\r\n\0]/.test(name)) throw new Error('Use a filename without header control characters');
return { name, data, sha256: fileCrypto.createHash('sha256').update(data).digest('hex') };
}
function remember_id(seen, value) { if (seen.has(value)) return false; seen.add(value); return true; }
async function request_download(name, params) {
const route = SPEC.requests[name];
if (route.method !== 'GET' || route.binary !== true) throw new Error('Bind the declared binary GET');
const query = new URLSearchParams(params).toString();
const controller = new AbortController(); const timer = setTimeout(() => controller.abort(), 30000);
let response, data;
try { response = await fetch(BASE + route.path + (query ? '?' + query : ''), {method:'GET', headers:{Authorization:'Bearer ' + API_KEY, Accept:'application/octet-stream'}, signal:controller.signal, redirect:'error'}); data = Buffer.from(await response.arrayBuffer()); }
finally { clearTimeout(timer); }
if (response.status !== 200) { let body=null; try { body=decodeJson(data.toString('utf8')); } catch(error){} throw new ApiError(response.status, body); }
return data;
}
async function request_expect(name,query,body,key,expected) {
try { await call(name,query,body,key); }
catch(observed) {
if(!(observed instanceof ApiError)||observed.uncertain||String(observed.status)!==expected)throw observed;
return String(observed.status);
}
throw new Error("Expected HTTP "+expected+" refusal; request unexpectedly succeeded");
}
async function request_upload(name, params, file, key) {
const route = SPEC.requests[name];
if (route.method !== 'POST' || !route.file || !key) throw new Error('Bind one declared upload and its persisted create key');
let boundary; do { boundary = 'ExhibitDayGuide' + fileCrypto.randomBytes(24).toString('hex'); } while (file.data.includes(Buffer.from(boundary)));
const quoted = file.name.replace(/\\/g, '\\\\').replace(/"/g, '\\"');
const data = Buffer.concat([Buffer.from('--' + boundary + '\r\nContent-Disposition: form-data; name="file"; filename="' + quoted + '"\r\nContent-Type: application/octet-stream\r\n\r\n', 'utf8'), file.data, Buffer.from('\r\n--' + boundary + '--\r\n')]);
const headers = { Authorization: 'Bearer ' + API_KEY, Accept: 'application/json', 'Idempotency-Key': key, 'Content-Type': 'multipart/form-data; boundary=' + boundary };
const query = new URLSearchParams(params).toString();
const controller = new AbortController(); const timer = setTimeout(() => controller.abort(), 30000);
let response, raw;
try { response = await fetch(BASE + route.path + (query ? '?' + query : ''), {method:'POST', headers, body:data, signal:controller.signal, redirect:'error'}); raw = await response.text(); }
catch (error) { throw new ApiError(0, null, true); } finally { clearTimeout(timer); }
let body = null; try { body = decodeJson(raw); } catch (error) { }
if (response.status !== 200) throw new ApiError(response.status, body, response.status >= 500);
if (!body || Array.isArray(body) || typeof body !== 'object') throw new Error('Upload returned no usable JSON receipt; reconcile before retrying');
const resultHeaders = {}; response.headers.forEach((value, key) => { resultHeaders[key.toLowerCase()] = value; });
return {status:response.status, body, headers:resultHeaders, raw};
}
function require_condition(value, message) { if (value !== true) throw new Error(message); }
function required(name) { const value = process.env[name]; if (value === undefined || !value.trim()) throw new Error("Set " + name); return value; }
function response_status(value) { return String(value.status); }
function save_checked_download(data, file, path) {
if (data.length !== file.data.length || fileCrypto.createHash('sha256').update(data).digest('hex') !== file.sha256) throw new Error('Downloaded bytes differ; no output was created');
const output = fileFs.openSync(path, 'wx', 0o600);
try { let offset=0; while(offset<data.length) { const count=fileFs.writeSync(output,data,offset,data.length-offset); if(!count)throw new Error('Output write stopped'); offset+=count; } fileFs.fsyncSync(output); } finally { fileFs.closeSync(output); }
}
function single(value){const rows=items(value);if(rows.length!==1)throw new Error('Expected exactly one selected record');return rows[0];}
function text(value) { if (value === null || value === undefined) return ""; if (["string", "boolean", "bigint"].includes(typeof value)) return String(value); throw new Error("Expected a scalar response value"); }
async function main() {
let integration_event_id = positive_id(required("EXHIBITDAY_EVENT_ID"));
let integration_job_id = required("EXHIBITDAY_JOB_ID");
let integration_job_hash = journal_fingerprint({"job_id": integration_job_id});
let integration_initial_name = concat("API integration check ", integration_job_hash);
let integration_updated_name = concat(integration_initial_name, " updated");
let integration_file = read_file_snapshot(required("EXHIBITDAY_FILE"), "upload");
let integration_output_path = required("EXHIBITDAY_DOWNLOAD_PATH");
let integration_cleanup = optional("EXHIBITDAY_TEST_CLEANUP", "keep");
require_condition(either(equal(integration_cleanup, "keep"), equal(integration_cleanup, "delete")), "Use keep or delete for EXHIBITDAY_TEST_CLEANUP.");
let integration_workspace_response = await call("workspace_binding", {}, null, null);
require_condition(equal(response_status(integration_workspace_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
let integration_workspace = integration_workspace_response.body;
let integration_workspace_id = positive_id(text(field(integration_workspace, "id")));
let integration_state_path = required("EXHIBITDAY_TEST_STATE");
let integration_job_mode = optional("EXHIBITDAY_JOB_MODE", "resume");
let integration_job = open_journal(integration_state_path, "https://api.exhibitday.com/v1", integration_workspace_id, "integration-testing", integration_job_id, journal_fingerprint({"workflow_contract_sha256": "3808BE3DE866226BE6AAA4C445EBC19FC7903FD96FC8DC2F223F6D6451BA6267", "event_id": integration_event_id, "initial_name": integration_initial_name, "updated_name": integration_updated_name, "filename": file_name(integration_file), "file_length": file_length(integration_file), "file_sha256": file_sha256(integration_file)}), [["create", "POST", "/v1/tasks"], ["edit", "PATCH", "/v1/tasks"], ["stale", "PATCH", "/v1/tasks"], ["upload", "POST", "/v1/tasks/attachments"], ["remove_file", "DELETE", "/v1/tasks/attachments"], ["remove_task", "DELETE", "/v1/tasks"]], integration_job_mode);
try {
let integration_task_id = "";
let integration_attachment_id = "";
if (not_value(journal_acknowledged(integration_job, "remove_task"))) {
if (not_value(journal_acknowledged(integration_job, "create"))) {
let integration_create_intent = journal_begin(integration_job, "create", "POST", "/v1/tasks", journal_fingerprint({"event_id": integration_event_id, "name": integration_initial_name}));
let integration_created_response = await call("create", {}, {"event_id": integration_event_id, "name": integration_initial_name}, text(field(integration_create_intent, "idempotency_key")));
require_condition(equal(response_status(integration_created_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
let integration_created = integration_created_response.body;
integration_task_id = positive_id(text(field(integration_created, "id")));
require_condition(both(equal(text(field(integration_created, "id")), integration_task_id), both(equal(text(field(field(integration_created, "event"), "id")), integration_event_id), equal(text(field(integration_created, "name")), integration_initial_name))), "The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.");
journal_acknowledge(integration_job, "create", {"task_id": integration_task_id, "event_id": integration_event_id, "name": integration_initial_name, "create_key": text(field(integration_create_intent, "idempotency_key"))});
}
let integration_saved_create = journal_saved(integration_job, "create");
integration_task_id = positive_id(text(field(integration_saved_create, "task_id")));
require_condition(both(equal(text(field(integration_saved_create, "event_id")), integration_event_id), equal(text(field(integration_saved_create, "name")), integration_initial_name)), "Saved create state differs from this Event/job.");
require_condition(either(not_value(journal_acknowledged(integration_job, "remove_file")), equal(integration_cleanup, "delete")), "Cleanup already removed the test file. Continue with EXHIBITDAY_TEST_CLEANUP=delete to finish this Task cleanup.");
let integration_before_response = await call("read", {"id": integration_task_id, "$include_record_revision": "true"}, null, null);
require_condition(equal(response_status(integration_before_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
let integration_before = integration_before_response.body;
if (not_value(journal_acknowledged(integration_job, "edit"))) {
require_condition(both(equal(text(field(integration_before, "id")), integration_task_id), both(equal(text(field(field(integration_before, "event"), "id")), integration_event_id), equal(text(field(integration_before, "name")), integration_initial_name))), "The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.");
let integration_original_revision = text(field(integration_before, "record_revision"));
require_condition(is_present(integration_original_revision), "Read the actual created Task revision before editing.");
journal_begin(integration_job, "edit", "PATCH", "/v1/tasks", journal_fingerprint({"id": integration_task_id, "name": integration_updated_name, "expected_revision": integration_original_revision}));
let integration_edit_response = await call("edit", {}, {"id": integration_task_id, "name": integration_updated_name, "expected_revision": integration_original_revision}, null);
require_condition(equal(response_status(integration_edit_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
let integration_edit_receipt = integration_edit_response.body;
let integration_saved_revision = text(field(integration_edit_receipt, "record_revision"));
require_condition(both(is_present(integration_saved_revision), not_value(equal(integration_original_revision, integration_saved_revision))), "The distinct test name must produce a checked new revision before the stale test.");
journal_acknowledge(integration_job, "edit", {"task_id": integration_task_id, "name": integration_updated_name, "original_revision": integration_original_revision, "record_revision": integration_saved_revision});
}
let integration_saved_edit = journal_saved(integration_job, "edit");
require_condition(both(equal(text(field(integration_saved_edit, "task_id")), integration_task_id), equal(text(field(integration_saved_edit, "name")), integration_updated_name)), "Saved edit state differs from this Task/name.");
if (not_value(journal_acknowledged(integration_job, "stale"))) {
journal_begin(integration_job, "stale", "PATCH", "/v1/tasks", journal_fingerprint({"id": integration_task_id, "name": "Refused stale test", "expected_revision": text(field(integration_saved_edit, "original_revision"))}));
let integration_stale_status = await request_expect("stale", {}, {"id": integration_task_id, "name": "Refused stale test", "expected_revision": text(field(integration_saved_edit, "original_revision"))}, null, "409");
journal_acknowledge(integration_job, "stale", {"task_id": integration_task_id, "observed_status": integration_stale_status});
}
let integration_saved_stale = journal_saved(integration_job, "stale");
require_condition(both(equal(text(field(integration_saved_stale, "task_id")), integration_task_id), equal(text(field(integration_saved_stale, "observed_status")), "409")), "The saved conflict assertion differs from this Task/status.");
let integration_after_edit_response = await call("after_edit", {"id": integration_task_id, "$include_record_revision": "true"}, null, null);
require_condition(equal(response_status(integration_after_edit_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
let integration_after_edit = integration_after_edit_response.body;
require_condition(both(equal(text(field(integration_after_edit, "id")), integration_task_id), both(equal(text(field(field(integration_after_edit, "event"), "id")), integration_event_id), equal(text(field(integration_after_edit, "name")), integration_updated_name))), "The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.");
require_condition(equal(text(field(integration_after_edit, "record_revision")), text(field(integration_saved_edit, "record_revision"))), "The test Task's revision changed; stop before file work or cleanup.");
require_condition(either(not_value(equal(integration_cleanup, "delete")), deep_equal(field(integration_after_edit, "comments"), [])), "The test Task has comments; stop before cleanup.");
if (not_value(journal_acknowledged(integration_job, "upload"))) {
require_condition(equal(text(field(integration_after_edit, "record_revision")), text(field(integration_saved_edit, "record_revision"))), "The Task changed after the conditional edit. Review it before uploading.");
let integration_upload_intent = journal_begin(integration_job, "upload", "POST", "/v1/tasks/attachments", journal_fingerprint({"task_id": integration_task_id, "filename": file_name(integration_file), "file_length": file_length(integration_file), "file_sha256": file_sha256(integration_file)}));
let integration_upload_response = await request_upload("upload", {"task_id": integration_task_id}, integration_file, text(field(integration_upload_intent, "idempotency_key")));
require_condition(equal(response_status(integration_upload_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
let integration_upload = integration_upload_response.body;
require_condition(both(equal(text(field(integration_upload, "records_found")), "1"), both(equal(text(field(integration_upload, "total_records")), "1"), equal(field(integration_upload, "has_more"), false))), "Require exactly one complete uploaded-file receipt.");
let integration_uploaded_file = single(field(integration_upload, "list_data"));
integration_attachment_id = positive_id(text(field(integration_uploaded_file, "id")));
require_condition(is_present(text(field(integration_uploaded_file, "filename"))), "The upload receipt needs its actual stored filename.");
journal_acknowledge(integration_job, "upload", {"task_id": integration_task_id, "attachment_id": integration_attachment_id, "filename": text(field(integration_uploaded_file, "filename")), "attachment_json": json_string(integration_uploaded_file), "file_length": file_length(integration_file), "file_sha256": file_sha256(integration_file)});
}
let integration_saved_upload = journal_saved(integration_job, "upload");
integration_attachment_id = positive_id(text(field(integration_saved_upload, "attachment_id")));
require_condition(both(equal(text(field(integration_saved_upload, "task_id")), integration_task_id), both(equal(text(field(integration_saved_upload, "file_length")), file_length(integration_file)), equal(text(field(integration_saved_upload, "file_sha256")), file_sha256(integration_file)))), "The confirmed file differs from the saved test Task or file details.");
if (not_value(journal_acknowledged(integration_job, "remove_file"))) {
let integration_list_offset = "0";
let integration_file_count = "0";
let integration_file_found = false;
let integration_file_seen = new_id_set();
let integration_list_query = {"task_id": integration_task_id, "$limit": "25", "$offset": "0"};
while (true) {
integration_list_query["$offset"] = integration_list_offset;
let integration_list_response = await call("verify_file", integration_list_query, null, null);
require_condition(equal(response_status(integration_list_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
let integration_list = integration_list_response.body;
let integration_list_rows = items(field(integration_list, "list_data"));
require_condition(equal(text(field(integration_list, "records_found")), text(count(integration_list_rows))), "The Task file page count differs from its rows.");
require_condition(is_present(text(field(integration_list, "total_records"))), "The Task file page needs total_records.");
require_condition(either(equal(field(integration_list, "has_more"), true), equal(field(integration_list, "has_more"), false)), "The Task file page needs Boolean has_more.");
for (const integration_list_row of items(integration_list_rows)) {
let integration_list_id = positive_id(text(field(integration_list_row, "id")));
require_condition(remember_id(integration_file_seen, integration_list_id), "A Task file ID repeated while paging.");
if (equal(integration_list_id, integration_attachment_id)) {
require_condition(deep_equal(integration_list_row, parse_json(text(field(integration_saved_upload, "attachment_json")))), "The saved Task file details changed.");
integration_file_found = true;
}
}
integration_file_count = add_offset(integration_file_count, count(integration_list_rows));
if (equal(field(integration_list, "has_more"), false)) {
break;
}
require_condition(not_value(is_empty(integration_list_rows)), "An empty Task file page says has_more=true.");
integration_list_offset = add_offset(integration_list_offset, count(integration_list_rows));
}
require_condition(integration_file_found, "The saved file is not on this Task; stop before downloading by id or cleaning up.");
require_condition(either(not_value(equal(integration_cleanup, "delete")), equal(integration_file_count, "1")), "Another Task file exists; stop before deleting the test Task.");
let integration_download_response = await request_download("download", {"id": integration_attachment_id});
save_checked_download(integration_download_response, integration_file, integration_output_path);
}
if (equal(integration_cleanup, "delete")) {
if (not_value(journal_acknowledged(integration_job, "remove_file"))) {
journal_begin(integration_job, "remove_file", "DELETE", "/v1/tasks/attachments", journal_fingerprint({"id": integration_attachment_id}));
let integration_file_remove_response = await call("remove_file", {"id": integration_attachment_id}, null, null);
require_condition(equal(response_status(integration_file_remove_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
journal_acknowledge(integration_job, "remove_file", {"task_id": integration_task_id, "attachment_id": integration_attachment_id});
}
if (not_value(journal_acknowledged(integration_job, "remove_task"))) {
journal_begin(integration_job, "remove_task", "DELETE", "/v1/tasks", journal_fingerprint({"id": integration_task_id}));
let integration_task_remove_response = await call("remove_task", {"id": integration_task_id}, null, null);
require_condition(equal(response_status(integration_task_remove_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
journal_acknowledge(integration_job, "remove_task", {"task_id": integration_task_id});
}
} else {
print_value({"task_id": integration_task_id, "attachment_id": integration_attachment_id, "cleanup": "kept"});
}
}
if (journal_acknowledged(integration_job, "remove_task")) {
let integration_removed = journal_saved(integration_job, "remove_task");
integration_task_id = positive_id(text(field(integration_removed, "task_id")));
let integration_missing_status = await request_expect("verify_removed", {"id": integration_task_id}, null, null, "404");
print_value({"task_id": integration_task_id, "cleanup": "removed", "observed_missing_status": integration_missing_status});
}
} finally {
integration_job.close();
}
}
if (require.main === module) main().catch(error => { console.error(error.message); process.exitCode = 1; });
module.exports = { main };
# Python 3; standard library only. Set EXHIBITDAY_API_KEY before running.
import http.client
import json
import os
import re
import time
import urllib.error
import urllib.parse
import urllib.request
BASE = "https://api.exhibitday.com/v1"
SPEC = json.loads("{\"preserveNumbers\":true,\"requests\":{\"workspace_binding\":{\"method\":\"GET\",\"path\":\"/references/workspace_info\"},\"create\":{\"method\":\"POST\",\"path\":\"/tasks\"},\"read\":{\"method\":\"GET\",\"path\":\"/tasks/info\"},\"edit\":{\"method\":\"PATCH\",\"path\":\"/tasks\"},\"stale\":{\"method\":\"PATCH\",\"path\":\"/tasks\"},\"after_edit\":{\"method\":\"GET\",\"path\":\"/tasks/info\"},\"upload\":{\"method\":\"POST\",\"path\":\"/tasks/attachments\",\"file\":{\"name\":\"file\",\"maximum_bytes\":\"26214400\",\"extensions\":[\"png\",\"jpg\",\"jpeg\",\"bmp\",\"gif\",\"pdf\",\"msg\",\"eml\",\"doc\",\"docx\",\"ppt\",\"pptx\",\"xls\",\"xlsx\",\"csv\",\"rtf\",\"odp\",\"odt\",\"ods\",\"txt\",\"wks\",\"zip\"],\"content_types\":[]}},\"verify_file\":{\"method\":\"GET\",\"path\":\"/tasks/attachments\"},\"download\":{\"method\":\"GET\",\"path\":\"/tasks/attachments/download\",\"binary\":true},\"remove_file\":{\"method\":\"DELETE\",\"path\":\"/tasks/attachments\"},\"remove_task\":{\"method\":\"DELETE\",\"path\":\"/tasks\"},\"verify_removed\":{\"method\":\"GET\",\"path\":\"/tasks/info\"}}}")
API_KEY = os.environ["EXHIBITDAY_API_KEY"]
if any(ord(char) < 32 or ord(char) > 126 for char in API_KEY):
raise RuntimeError("Use the API key as one ASCII header value without control characters")
if not API_KEY.strip():
raise RuntimeError("Set EXHIBITDAY_API_KEY")
def decode_json(text):
if SPEC["preserveNumbers"]:
# Quote JSON NUMBER tokens, never text inside a JSON string, to keep CSV decimals exact.
text = re.sub(r'"(?:\\.|[^"\\])*"|-?\d+(?:\.\d+)?(?:[eE][+-]?\d+)?',
lambda m: m[0] if m[0].startswith('"') else json.dumps(m[0]), text)
return json.loads(text)
class NoRedirect(urllib.request.HTTPRedirectHandler):
def redirect_request(self, request, file, code, message, headers, new_url):
return None
OPENER = urllib.request.build_opener(NoRedirect())
def transport(method, url, headers, data):
request = urllib.request.Request(url, data=data, headers=headers, method=method)
try:
with OPENER.open(request, timeout=30) as response:
return response.status, response.read(), dict(response.headers)
except urllib.error.HTTPError as response:
try:
return response.code, response.read(), dict(response.headers)
finally:
response.close()
class ApiError(RuntimeError):
"""An API error response. Branch on error_code (and status), never on the message text.
uncertain is True when a PATCH or DELETE got no response or a server error: it may or may not have been applied."""
def __init__(self, status, body, uncertain=False):
self.status = status
self.uncertain = uncertain
self.error_code = body.get("error_code") if isinstance(body, dict) else None
super().__init__(f"{body.get('error_code')} {body.get('error_params')}: {body.get('errors')} (request {body.get('request_id')})"
if isinstance(body, dict) else "HTTP " + str(status) if status else "No response")
def call(name, params=None, body=None, key=None):
route = SPEC["requests"][name]
headers = {"Authorization": "Bearer " + API_KEY, "Accept": "application/json"}
if route["method"] == "POST":
if not key: raise RuntimeError("Save a create key before sending POST")
headers["Idempotency-Key"] = key
data = None if body is None else json.dumps(body).encode("utf-8")
if data is not None:
headers["Content-Type"] = "application/json"
query = urllib.parse.urlencode(params or {})
url = BASE + route["path"] + ("?" + query if query else "")
# Only GET has automatic retries in this workflow. A PATCH or DELETE that got no response or a
# server error is never resent blindly: it may already have been applied, so the caller reads the record first.
resend = route["method"] == "GET"
for attempt in range(5):
try:
status, raw, response_headers = transport(route["method"], url, headers, data)
except (urllib.error.URLError, TimeoutError, ConnectionError, http.client.HTTPException):
if not resend:
raise ApiError(0, None, uncertain=True)
if attempt == 4:
raise
time.sleep(2 ** attempt)
continue
response_headers = {k.lower(): v for k, v in response_headers.items()}
result = None
if status != 304 and raw:
try:
result = decode_json(raw.decode("utf-8"))
except (ValueError, UnicodeError):
if status < 400:
raise RuntimeError("Expected a JSON success response")
if status >= 500 and not resend:
raise ApiError(status, result, uncertain=True)
retry = resend and (status == 429 or status >= 500)
if retry:
if attempt == 4:
raise RuntimeError("Retry limit reached; check the request outcome before starting a new create")
delay = response_headers.get("retry-after", str(2 ** attempt))
time.sleep(max(0, float(delay)))
continue
if status >= 400:
raise ApiError(status, result)
return {"status": status, "body": result, "headers": response_headers, "raw": raw}
raise RuntimeError("Retry limit reached")
def add_offset(offset, received):
result = int(offset) + received
if received <= 0 or result > 2147483647: raise RuntimeError("Cannot advance this int32 offset; reconcile the query")
return str(result)
def both(left,right):
return left and right
def concat(left, right):
return left + right
def items(value):
if not isinstance(value, list): raise RuntimeError("Expected a JSON array")
return value
def count(value):
return len(items(value))
def deep_equal(left,right):
if type(left) is not type(right): return False
if isinstance(left,dict): return left.keys()==right.keys() and all(deep_equal(left[k],right[k]) for k in left)
if isinstance(left,list): return len(left)==len(right) and all(deep_equal(a,b) for a,b in zip(left,right))
return left==right
def either(left, right):
if not isinstance(left, bool) or not isinstance(right, bool): raise RuntimeError("Expected Boolean criteria")
return left or right
def equal(left, right):
return type(left) is type(right) and left == right
def field(value, name):
if not isinstance(value, dict) or name not in value: raise RuntimeError("Missing response field: " + name)
return value[name]
import hashlib
import secrets
from pathlib import Path
class FileSnapshot:
def __init__(self, name, data):
self.name, self.data = name, bytes(data)
self.sha256 = hashlib.sha256(self.data).hexdigest()
def file_length(value): return str(len(value.data))
def file_name(value): return value.name
def file_sha256(value): return value.sha256
def is_empty(value):
return count(value) == 0
def is_present(value):
return value is not None and value != ""
"""Strict private client journal reference; no transport or application dependency."""
from pathlib import Path
import hashlib
import os
import re
import secrets
from urllib.parse import urlsplit
PREAMBLE=b'EXHIBITDAY-GUIDE-JOURNAL 1\n'
class JournalRefusal(RuntimeError):
pass
def utf8(value):
if not isinstance(value,str):raise JournalRefusal('Journal fields are exact strings')
return value.encode('utf-8',errors='strict')
def strings(values):
raw=bytearray()
for value in values:
item=utf8(value);raw.extend(str(len(item)).encode('ascii'));raw.extend(b':');raw.extend(item)
return bytes(raw)
def read_strings(raw):
values=[];offset=0
while offset<len(raw):
end=raw.find(b':',offset)
if end<0:raise JournalRefusal('Incomplete journal string length')
length=raw[offset:end]
if not re.fullmatch(b'0|[1-9][0-9]*',length):raise JournalRefusal('Noncanonical journal string length')
size=int(length);offset=end+1
if size>len(raw)-offset:raise JournalRefusal('Incomplete journal string')
values.append(raw[offset:offset+size].decode('utf-8',errors='strict'));offset+=size
return values
def digest(raw):return hashlib.sha256(raw).hexdigest().upper()
def fingerprint(pairs):
values=[]
for name,value in sorted(pairs.items()):
if not re.fullmatch('[A-Za-z0-9_.-]+',name):raise JournalRefusal('Fingerprint field names must be explicit ASCII identifiers')
if name.lower() in ('api_key','exhibitday_api_key'):raise JournalRefusal('Never fingerprint the API key')
values.extend((name,value))
return digest(strings(values))
def frame(values):
raw=strings(values)
return str(len(raw)).encode('ascii')+b' '+digest(raw).encode('ascii')+b'\n'+raw+b'\n'
def decode(raw):
if not raw.startswith(PREAMBLE):raise JournalRefusal('Unknown or incomplete journal version')
offset=len(PREAMBLE);records=[]
while offset<len(raw):
end=raw.find(b'\n',offset)
if end<0:raise JournalRefusal('Incomplete journal frame header; reconcile before retry')
match=re.fullmatch(b'(0|[1-9][0-9]*) ([0-9A-F]{64})',raw[offset:end])
if match is None:raise JournalRefusal('Invalid journal frame header')
size=int(match[1]);offset=end+1
if size>=len(raw)-offset:raise JournalRefusal('Incomplete journal frame; reconcile before retry')
payload=raw[offset:offset+size];offset+=size
if raw[offset:offset+1]!=b'\n' or digest(payload).encode('ascii')!=match[2]:raise JournalRefusal('Journal integrity check failed; reconcile before retry')
records.append(read_strings(payload));offset+=1
return records
class Journal:
def __init__(self,path,base,workspace,slug,job,input_fingerprint,writes,mode="resume"):
self.path=Path(path);self.lock=Path(str(self.path)+'.lock');self.fd=None;self.owned=False;self.identity=None;self.tainted=False;self.intents={};self.saved_values={}
address=urlsplit(base)
if address.scheme not in ('https','http')or not address.netloc or address.username is not None or address.query or address.fragment or not re.fullmatch('[a-z][a-z0-9-]*',slug):raise JournalRefusal('Use the actual API base and closed guide slug')
if not job.strip() or not re.fullmatch('[1-9][0-9]*',workspace) or not re.fullmatch('[0-9A-F]{64}',input_fingerprint):raise JournalRefusal('Use an actual workspace, explicit stable job ID and exact input fingerprint')
if mode not in ("new","resume"):raise JournalRefusal("Choose new or resume for this local job")
self.allowed={};manifest=[]
for step,method,route in writes:
if not re.fullmatch('[a-z][a-z0-9_-]*',step)or step in self.allowed or method not in ('POST','PATCH','DELETE')or not re.fullmatch('/v1/[A-Za-z0-9_/-]+',route)or'//'in route:raise JournalRefusal('Use a closed unique write manifest')
self.allowed[step]=(method,route);manifest.extend((step,method,route))
if not self.allowed:raise JournalRefusal('Only write workflows need a restart journal')
self.header=['H','1',base,workspace,slug,job,input_fingerprint,digest(strings(manifest))]
strings(self.header)
try:
self.fd=os.open(self.lock,os.O_WRONLY|os.O_CREAT|os.O_EXCL,0o600);self.owned=True
except FileExistsError:raise JournalRefusal('This journal is locked; do not run overlapping jobs or steal a stale lock')
try:
self.owner=secrets.token_hex(16);self.identity=os.fstat(self.fd)
if os.write(self.fd,self.owner.encode('ascii'))!=len(self.owner):raise OSError('Incomplete lock identity write')
os.fsync(self.fd)
if self.path.is_symlink():raise JournalRefusal('Choose a private regular journal file')
if mode=="resume" and not self.path.exists():raise JournalRefusal("Journal missing: stop and reconcile lost state before starting a new job")
if mode=="new" and self.path.exists():raise JournalRefusal("A journal already exists; use resume for the same job")
if mode=="new":
with open(self.path,'xb',buffering=0)as target:
target.write(PREAMBLE+frame(self.header));os.fsync(target.fileno())
records=decode(self.path.read_bytes())
if not records or records[0]!=self.header:raise JournalRefusal('Journal workspace/base/guide/job/input binding differs')
for record in records[1:]:self.apply(record)
if any(step not in self.saved_values for step in self.intents):raise JournalRefusal('A saved before-send intent lacks an ACK; stop and reconcile its outcome before retry')
except BaseException:
self.close();raise
def apply(self,record):
if not record:raise JournalRefusal('Empty journal record')
if record[0]=='I':
if len(record)!=6:raise JournalRefusal('Invalid intent shape')
_,step,method,path,request_fingerprint,key=record
if not re.fullmatch('[a-z][a-z0-9_-]*',step)or step in self.intents or self.allowed.get(step)!=(method,path)or not re.fullmatch('[0-9A-F]{64}',request_fingerprint)or any(name not in self.saved_values for name in self.intents):raise JournalRefusal('Invalid, future or repeated journal intent')
if method=='POST'and not re.fullmatch('[0-9a-f]{32}',key)or method!='POST'and key!='':raise JournalRefusal('Invalid persisted action key')
self.intents[step]={'method':method,'path':path,'request_fingerprint':request_fingerprint,'idempotency_key':key}
elif record[0]=='A':
if len(record)<3:raise JournalRefusal('Invalid ACK shape')
_,step,count,*pairs=record
if not re.fullmatch('0|[1-9][0-9]*',count)or len(pairs)!=2*int(count)or step not in self.intents or step in self.saved_values:raise JournalRefusal('ACK without exactly one prior intent')
names=pairs[::2]
if names!=sorted(set(names))or any(not re.fullmatch('[a-z][a-z0-9_]*',name)or name in ('api_key','exhibitday_api_key')for name in names):raise JournalRefusal('ACK saved fields must be unique sorted secret-free identifiers')
self.saved_values[step]=dict(zip(names,pairs[1::2]))
else:raise JournalRefusal('Unknown journal transition')
def append(self,record):
# The reader commits state only after complete length/digest recognition.
# A torn append is retained and refused, never silently truncated.
self.require_active();raw=frame(record)
try:
with open(self.path,'ab',buffering=0)as target:
view=memoryview(raw)
while view:
written=target.write(view)
if not written:raise OSError('Journal write did not advance')
view=view[written:]
os.fsync(target.fileno())
except BaseException:
self.tainted=True;raise
def require_active(self):
if not self.owned or self.fd is None or self.identity is None or self.tainted:raise JournalRefusal('The journal scope is closed or its IO outcome needs reconciliation')
current=self.lock.stat(follow_symlinks=False)
if current.st_dev!=self.identity.st_dev or current.st_ino!=self.identity.st_ino or self.lock.read_text(encoding='ascii')!=self.owner:raise JournalRefusal('The journal lock was replaced; stop without deleting it')
def acknowledged(self,step):
self.require_active();return step in self.saved_values
def saved(self,step):
self.require_active()
if step not in self.saved_values:raise JournalRefusal('No confirmed state exists for this step')
return dict(self.saved_values[step])
def begin(self,step,method,path,request_fingerprint):
self.require_active()
if step in self.intents:raise JournalRefusal('Never blindly repeat an existing action intent')
key=secrets.token_hex(16)if method=='POST'else''
record=['I',step,method,path,request_fingerprint,key]
# Validate on an isolated state before touching the file.
old=dict(self.intents)
try:self.apply(record)
finally:self.intents=old
self.append(record);self.apply(record)
return dict(self.intents[step])
def acknowledge(self,step,saved):
self.require_active()
record=['A',step,str(len(saved))]
for name,value in sorted(saved.items()):record.extend((name,value))
old={name:dict(value)for name,value in self.saved_values.items()}
try:self.apply(record);strings(record)
finally:self.saved_values=old
self.append(record);self.apply(record)
def close(self):
if self.owned:
if self.tainted:
os.close(self.fd);self.fd=None;self.owned=False
return # Retain this lock after failed journal IO; manual reconciliation is required.
try:self.require_active()
except BaseException:
os.close(self.fd);self.fd=None;self.owned=False;raise
os.close(self.fd);self.fd=None;self.owned=False
self.lock.unlink()
def __enter__(self):return self
def __exit__(self,*args):self.close()
def journal_values(value):
if not isinstance(value, dict) or any(not isinstance(k, str) or not isinstance(v, str) for k,v in value.items()):
raise JournalRefusal('Saved/fingerprint values must be exact string fields')
return dict(value)
def journal_acknowledge(job, step, saved):
job.acknowledge(step,journal_values(saved))
def journal_acknowledged(job, step):
return job.acknowledged(step)
def journal_begin(job, step, method, path, request_fingerprint):
return job.begin(step,method,path,request_fingerprint)
def journal_fingerprint(value):
return fingerprint(journal_values(value))
def journal_saved(job, step):
return job.saved(step)
def json_string(value):
return json.dumps(value,ensure_ascii=False,allow_nan=False,separators=(",",":"))
def new_id_set():
return set()
def not_value(value):
if not isinstance(value, bool): raise RuntimeError("Expected a Boolean")
return not value
def open_journal(path, base, workspace, slug, job, input_fingerprint, writes, mode):
return Journal(path,base,workspace,slug,job,input_fingerprint,writes,mode)
def optional(name, fallback):
value = os.environ.get(name)
return fallback if value is None or value == "" else value
def parse_json(value):
return json.loads(value)
def positive_id(value):
if not re.fullmatch(r"[1-9][0-9]*", value) or int(value) > 9223372036854775807: raise RuntimeError("Use a positive record ID")
return value
def print_value(value):
print(value if isinstance(value, str) else json.dumps(value, ensure_ascii=False))
def read_file_snapshot(path, action):
rule = SPEC['requests'][action].get('file')
if not rule or rule['name'] != 'file': raise RuntimeError('Use the current declared file input')
data = Path(path).read_bytes()
if not data or len(data) > int(rule['maximum_bytes']): raise RuntimeError('The selected file is empty or exceeds this endpoint file limit')
name = Path(path).name
if not name or any(c in name for c in '\r\n\0'): raise RuntimeError('Use a filename without header control characters')
return FileSnapshot(name, data)
def remember_id(seen, value):
if value in seen: return False
seen.add(value)
return True
def request_download(name, params):
route = SPEC['requests'][name]
if route['method'] != 'GET' or route.get('binary') is not True: raise RuntimeError('Bind the declared binary GET')
query = urllib.parse.urlencode(params or {})
status, raw, headers = transport('GET', BASE + route['path'] + ('?' + query if query else ''), {'Authorization': 'Bearer ' + API_KEY, 'Accept': 'application/octet-stream'}, None)
if status != 200:
parsed = None
try: parsed = decode_json(raw.decode('utf-8'))
except (ValueError, UnicodeError): pass
raise ApiError(status, parsed)
return bytes(raw)
def request_expect(name,query,body,key,expected):
try:
call(name,query,body,key)
except ApiError as observed:
if observed.uncertain or str(observed.status)!=expected:
raise
return str(observed.status)
raise RuntimeError("Expected HTTP "+expected+" refusal; request unexpectedly succeeded")
def request_upload(name, params, file, key):
route = SPEC['requests'][name]
if route['method'] != 'POST' or not route.get('file') or not key: raise RuntimeError('Bind one declared upload and its persisted create key')
boundary = 'ExhibitDayGuide' + secrets.token_hex(24)
while boundary.encode('ascii') in file.data: boundary = 'ExhibitDayGuide' + secrets.token_hex(24)
quoted = file.name.replace('\\', '\\\\').replace('"', '\\"')
data = ('--' + boundary + '\r\nContent-Disposition: form-data; name="file"; filename="' + quoted + '"\r\nContent-Type: application/octet-stream\r\n\r\n').encode('utf-8') + file.data + ('\r\n--' + boundary + '--\r\n').encode('ascii')
headers = {'Authorization': 'Bearer ' + API_KEY, 'Accept': 'application/json', 'Idempotency-Key': key, 'Content-Type': 'multipart/form-data; boundary=' + boundary}
query = urllib.parse.urlencode(params or {})
url = BASE + route['path'] + ('?' + query if query else '')
try: status, raw, response_headers = transport('POST', url, headers, data)
except (urllib.error.URLError, TimeoutError, ConnectionError, http.client.HTTPException): raise ApiError(0, None, uncertain=True)
parsed = None
try: parsed = decode_json(raw.decode('utf-8'))
except (ValueError, UnicodeError): pass
if status != 200: raise ApiError(status, parsed, uncertain=status >= 500)
if not isinstance(parsed, dict): raise RuntimeError('Upload returned no usable JSON receipt; reconcile before retrying')
return {'status': status, 'body': parsed, 'headers': {k.lower(): v for k,v in response_headers.items()}, 'raw': raw}
def require_condition(value, message):
if value is not True: raise RuntimeError(message)
def required(name):
value = os.environ.get(name)
if value is None or not value.strip(): raise RuntimeError("Set " + name)
return value
def response_status(value):
return str(value["status"])
def save_checked_download(data, file, path):
if len(data) != len(file.data) or hashlib.sha256(data).hexdigest() != file.sha256: raise RuntimeError('Downloaded bytes differ; no output was created')
descriptor = os.open(path, os.O_CREAT | os.O_EXCL | os.O_WRONLY | getattr(os, 'O_BINARY', 0), 0o600)
with os.fdopen(descriptor, 'wb') as output:
output.write(data); output.flush(); os.fsync(output.fileno())
def single(value):
rows=items(value)
if len(rows)!=1: raise RuntimeError('Expected exactly one selected record')
return rows[0]
def text(value):
if value is None: return ""
if isinstance(value, str): return value
if isinstance(value, bool): return "true" if value else "false"
if isinstance(value, int): return str(value)
raise RuntimeError("Expected a scalar response value")
def main():
integration_event_id = positive_id(required("EXHIBITDAY_EVENT_ID"))
integration_job_id = required("EXHIBITDAY_JOB_ID")
integration_job_hash = journal_fingerprint({"job_id": integration_job_id})
integration_initial_name = concat("API integration check ", integration_job_hash)
integration_updated_name = concat(integration_initial_name, " updated")
integration_file = read_file_snapshot(required("EXHIBITDAY_FILE"), "upload")
integration_output_path = required("EXHIBITDAY_DOWNLOAD_PATH")
integration_cleanup = optional("EXHIBITDAY_TEST_CLEANUP", "keep")
require_condition(either(equal(integration_cleanup, "keep"), equal(integration_cleanup, "delete")), "Use keep or delete for EXHIBITDAY_TEST_CLEANUP.")
integration_workspace_response = call("workspace_binding", {}, None, None)
require_condition(equal(response_status(integration_workspace_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_workspace = integration_workspace_response["body"]
integration_workspace_id = positive_id(text(field(integration_workspace, "id")))
integration_state_path = required("EXHIBITDAY_TEST_STATE")
integration_job_mode = optional("EXHIBITDAY_JOB_MODE", "resume")
integration_job = open_journal(integration_state_path, "https://api.exhibitday.com/v1", integration_workspace_id, "integration-testing", integration_job_id, journal_fingerprint({"workflow_contract_sha256": "3808BE3DE866226BE6AAA4C445EBC19FC7903FD96FC8DC2F223F6D6451BA6267", "event_id": integration_event_id, "initial_name": integration_initial_name, "updated_name": integration_updated_name, "filename": file_name(integration_file), "file_length": file_length(integration_file), "file_sha256": file_sha256(integration_file)}), [["create", "POST", "/v1/tasks"], ["edit", "PATCH", "/v1/tasks"], ["stale", "PATCH", "/v1/tasks"], ["upload", "POST", "/v1/tasks/attachments"], ["remove_file", "DELETE", "/v1/tasks/attachments"], ["remove_task", "DELETE", "/v1/tasks"]], integration_job_mode)
try:
integration_task_id = ""
integration_attachment_id = ""
if not_value(journal_acknowledged(integration_job, "remove_task")):
if not_value(journal_acknowledged(integration_job, "create")):
integration_create_intent = journal_begin(integration_job, "create", "POST", "/v1/tasks", journal_fingerprint({"event_id": integration_event_id, "name": integration_initial_name}))
integration_created_response = call("create", {}, {"event_id": integration_event_id, "name": integration_initial_name}, text(field(integration_create_intent, "idempotency_key")))
require_condition(equal(response_status(integration_created_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_created = integration_created_response["body"]
integration_task_id = positive_id(text(field(integration_created, "id")))
require_condition(both(equal(text(field(integration_created, "id")), integration_task_id), both(equal(text(field(field(integration_created, "event"), "id")), integration_event_id), equal(text(field(integration_created, "name")), integration_initial_name))), "The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.")
journal_acknowledge(integration_job, "create", {"task_id": integration_task_id, "event_id": integration_event_id, "name": integration_initial_name, "create_key": text(field(integration_create_intent, "idempotency_key"))})
integration_saved_create = journal_saved(integration_job, "create")
integration_task_id = positive_id(text(field(integration_saved_create, "task_id")))
require_condition(both(equal(text(field(integration_saved_create, "event_id")), integration_event_id), equal(text(field(integration_saved_create, "name")), integration_initial_name)), "Saved create state differs from this Event/job.")
require_condition(either(not_value(journal_acknowledged(integration_job, "remove_file")), equal(integration_cleanup, "delete")), "Cleanup already removed the test file. Continue with EXHIBITDAY_TEST_CLEANUP=delete to finish this Task cleanup.")
integration_before_response = call("read", {"id": integration_task_id, "$include_record_revision": "true"}, None, None)
require_condition(equal(response_status(integration_before_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_before = integration_before_response["body"]
if not_value(journal_acknowledged(integration_job, "edit")):
require_condition(both(equal(text(field(integration_before, "id")), integration_task_id), both(equal(text(field(field(integration_before, "event"), "id")), integration_event_id), equal(text(field(integration_before, "name")), integration_initial_name))), "The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.")
integration_original_revision = text(field(integration_before, "record_revision"))
require_condition(is_present(integration_original_revision), "Read the actual created Task revision before editing.")
journal_begin(integration_job, "edit", "PATCH", "/v1/tasks", journal_fingerprint({"id": integration_task_id, "name": integration_updated_name, "expected_revision": integration_original_revision}))
integration_edit_response = call("edit", {}, {"id": integration_task_id, "name": integration_updated_name, "expected_revision": integration_original_revision}, None)
require_condition(equal(response_status(integration_edit_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_edit_receipt = integration_edit_response["body"]
integration_saved_revision = text(field(integration_edit_receipt, "record_revision"))
require_condition(both(is_present(integration_saved_revision), not_value(equal(integration_original_revision, integration_saved_revision))), "The distinct test name must produce a checked new revision before the stale test.")
journal_acknowledge(integration_job, "edit", {"task_id": integration_task_id, "name": integration_updated_name, "original_revision": integration_original_revision, "record_revision": integration_saved_revision})
integration_saved_edit = journal_saved(integration_job, "edit")
require_condition(both(equal(text(field(integration_saved_edit, "task_id")), integration_task_id), equal(text(field(integration_saved_edit, "name")), integration_updated_name)), "Saved edit state differs from this Task/name.")
if not_value(journal_acknowledged(integration_job, "stale")):
journal_begin(integration_job, "stale", "PATCH", "/v1/tasks", journal_fingerprint({"id": integration_task_id, "name": "Refused stale test", "expected_revision": text(field(integration_saved_edit, "original_revision"))}))
integration_stale_status = request_expect("stale", {}, {"id": integration_task_id, "name": "Refused stale test", "expected_revision": text(field(integration_saved_edit, "original_revision"))}, None, "409")
journal_acknowledge(integration_job, "stale", {"task_id": integration_task_id, "observed_status": integration_stale_status})
integration_saved_stale = journal_saved(integration_job, "stale")
require_condition(both(equal(text(field(integration_saved_stale, "task_id")), integration_task_id), equal(text(field(integration_saved_stale, "observed_status")), "409")), "The saved conflict assertion differs from this Task/status.")
integration_after_edit_response = call("after_edit", {"id": integration_task_id, "$include_record_revision": "true"}, None, None)
require_condition(equal(response_status(integration_after_edit_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_after_edit = integration_after_edit_response["body"]
require_condition(both(equal(text(field(integration_after_edit, "id")), integration_task_id), both(equal(text(field(field(integration_after_edit, "event"), "id")), integration_event_id), equal(text(field(integration_after_edit, "name")), integration_updated_name))), "The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.")
require_condition(equal(text(field(integration_after_edit, "record_revision")), text(field(integration_saved_edit, "record_revision"))), "The test Task's revision changed; stop before file work or cleanup.")
require_condition(either(not_value(equal(integration_cleanup, "delete")), deep_equal(field(integration_after_edit, "comments"), [])), "The test Task has comments; stop before cleanup.")
if not_value(journal_acknowledged(integration_job, "upload")):
require_condition(equal(text(field(integration_after_edit, "record_revision")), text(field(integration_saved_edit, "record_revision"))), "The Task changed after the conditional edit. Review it before uploading.")
integration_upload_intent = journal_begin(integration_job, "upload", "POST", "/v1/tasks/attachments", journal_fingerprint({"task_id": integration_task_id, "filename": file_name(integration_file), "file_length": file_length(integration_file), "file_sha256": file_sha256(integration_file)}))
integration_upload_response = request_upload("upload", {"task_id": integration_task_id}, integration_file, text(field(integration_upload_intent, "idempotency_key")))
require_condition(equal(response_status(integration_upload_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_upload = integration_upload_response["body"]
require_condition(both(equal(text(field(integration_upload, "records_found")), "1"), both(equal(text(field(integration_upload, "total_records")), "1"), equal(field(integration_upload, "has_more"), False))), "Require exactly one complete uploaded-file receipt.")
integration_uploaded_file = single(field(integration_upload, "list_data"))
integration_attachment_id = positive_id(text(field(integration_uploaded_file, "id")))
require_condition(is_present(text(field(integration_uploaded_file, "filename"))), "The upload receipt needs its actual stored filename.")
journal_acknowledge(integration_job, "upload", {"task_id": integration_task_id, "attachment_id": integration_attachment_id, "filename": text(field(integration_uploaded_file, "filename")), "attachment_json": json_string(integration_uploaded_file), "file_length": file_length(integration_file), "file_sha256": file_sha256(integration_file)})
integration_saved_upload = journal_saved(integration_job, "upload")
integration_attachment_id = positive_id(text(field(integration_saved_upload, "attachment_id")))
require_condition(both(equal(text(field(integration_saved_upload, "task_id")), integration_task_id), both(equal(text(field(integration_saved_upload, "file_length")), file_length(integration_file)), equal(text(field(integration_saved_upload, "file_sha256")), file_sha256(integration_file)))), "The confirmed file differs from the saved test Task or file details.")
if not_value(journal_acknowledged(integration_job, "remove_file")):
integration_list_offset = "0"
integration_file_count = "0"
integration_file_found = False
integration_file_seen = new_id_set()
integration_list_query = {"task_id": integration_task_id, "$limit": "25", "$offset": "0"}
while True:
integration_list_query["$offset"] = integration_list_offset
integration_list_response = call("verify_file", integration_list_query, None, None)
require_condition(equal(response_status(integration_list_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_list = integration_list_response["body"]
integration_list_rows = items(field(integration_list, "list_data"))
require_condition(equal(text(field(integration_list, "records_found")), text(count(integration_list_rows))), "The Task file page count differs from its rows.")
require_condition(is_present(text(field(integration_list, "total_records"))), "The Task file page needs total_records.")
require_condition(either(equal(field(integration_list, "has_more"), True), equal(field(integration_list, "has_more"), False)), "The Task file page needs Boolean has_more.")
for integration_list_row in items(integration_list_rows):
integration_list_id = positive_id(text(field(integration_list_row, "id")))
require_condition(remember_id(integration_file_seen, integration_list_id), "A Task file ID repeated while paging.")
if equal(integration_list_id, integration_attachment_id):
require_condition(deep_equal(integration_list_row, parse_json(text(field(integration_saved_upload, "attachment_json")))), "The saved Task file details changed.")
integration_file_found = True
integration_file_count = add_offset(integration_file_count, count(integration_list_rows))
if equal(field(integration_list, "has_more"), False):
break
require_condition(not_value(is_empty(integration_list_rows)), "An empty Task file page says has_more=true.")
integration_list_offset = add_offset(integration_list_offset, count(integration_list_rows))
require_condition(integration_file_found, "The saved file is not on this Task; stop before downloading by id or cleaning up.")
require_condition(either(not_value(equal(integration_cleanup, "delete")), equal(integration_file_count, "1")), "Another Task file exists; stop before deleting the test Task.")
integration_download_response = request_download("download", {"id": integration_attachment_id})
save_checked_download(integration_download_response, integration_file, integration_output_path)
if equal(integration_cleanup, "delete"):
if not_value(journal_acknowledged(integration_job, "remove_file")):
journal_begin(integration_job, "remove_file", "DELETE", "/v1/tasks/attachments", journal_fingerprint({"id": integration_attachment_id}))
integration_file_remove_response = call("remove_file", {"id": integration_attachment_id}, None, None)
require_condition(equal(response_status(integration_file_remove_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
journal_acknowledge(integration_job, "remove_file", {"task_id": integration_task_id, "attachment_id": integration_attachment_id})
if not_value(journal_acknowledged(integration_job, "remove_task")):
journal_begin(integration_job, "remove_task", "DELETE", "/v1/tasks", journal_fingerprint({"id": integration_task_id}))
integration_task_remove_response = call("remove_task", {"id": integration_task_id}, None, None)
require_condition(equal(response_status(integration_task_remove_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
journal_acknowledge(integration_job, "remove_task", {"task_id": integration_task_id})
else:
print_value({"task_id": integration_task_id, "attachment_id": integration_attachment_id, "cleanup": "kept"})
if journal_acknowledged(integration_job, "remove_task"):
integration_removed = journal_saved(integration_job, "remove_task")
integration_task_id = positive_id(text(field(integration_removed, "task_id")))
integration_missing_status = request_expect("verify_removed", {"id": integration_task_id}, None, None, "404")
print_value({"task_id": integration_task_id, "cleanup": "removed", "observed_missing_status": integration_missing_status})
finally:
integration_job.close()
if __name__ == "__main__":
main()
// .NET 8 console program; standard library only. Set EXHIBITDAY_API_KEY.
#nullable disable
using System;
using System.Collections.Generic;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Net.Http;
using System.Text;
using System.Text.Json;
using System.Text.Json.Nodes;
using System.Threading.Tasks;
class Program
{
static readonly string BaseUrl = "https://api.exhibitday.com/v1";
static readonly JsonNode Spec = JsonNode.Parse("{\"preserveNumbers\":true,\"requests\":{\"workspace_binding\":{\"method\":\"GET\",\"path\":\"/references/workspace_info\"},\"create\":{\"method\":\"POST\",\"path\":\"/tasks\"},\"read\":{\"method\":\"GET\",\"path\":\"/tasks/info\"},\"edit\":{\"method\":\"PATCH\",\"path\":\"/tasks\"},\"stale\":{\"method\":\"PATCH\",\"path\":\"/tasks\"},\"after_edit\":{\"method\":\"GET\",\"path\":\"/tasks/info\"},\"upload\":{\"method\":\"POST\",\"path\":\"/tasks/attachments\",\"file\":{\"name\":\"file\",\"maximum_bytes\":\"26214400\",\"extensions\":[\"png\",\"jpg\",\"jpeg\",\"bmp\",\"gif\",\"pdf\",\"msg\",\"eml\",\"doc\",\"docx\",\"ppt\",\"pptx\",\"xls\",\"xlsx\",\"csv\",\"rtf\",\"odp\",\"odt\",\"ods\",\"txt\",\"wks\",\"zip\"],\"content_types\":[]}},\"verify_file\":{\"method\":\"GET\",\"path\":\"/tasks/attachments\"},\"download\":{\"method\":\"GET\",\"path\":\"/tasks/attachments/download\",\"binary\":true},\"remove_file\":{\"method\":\"DELETE\",\"path\":\"/tasks/attachments\"},\"remove_task\":{\"method\":\"DELETE\",\"path\":\"/tasks\"},\"verify_removed\":{\"method\":\"GET\",\"path\":\"/tasks/info\"}}}");
static readonly string ApiKey = HeaderKey(Required("EXHIBITDAY_API_KEY"));
static string HeaderKey(string value) { if(value.Any(c=>c<32||c>126))throw new Exception("Use the API key as one ASCII header value without control characters");return value; }
static readonly HttpClient Client = new HttpClient(new HttpClientHandler { AllowAutoRedirect = false }) { Timeout = TimeSpan.FromSeconds(30) };
internal static Func<HttpRequestMessage, Task<HttpResponseMessage>> Send = request => Client.SendAsync(request);
sealed class Result { public int Status; public JsonNode Body; public Dictionary<string, string> Headers; public string Raw; }
// An API error response. Branch on ErrorCode (and Status), never on the message text.
// Uncertain is true when a PATCH or DELETE got no response or a server error: it may or may not have been applied.
sealed class ApiException : Exception
{
public int Status { get; }
public string ErrorCode { get; }
public bool Uncertain { get; }
public ApiException(int status, string errorCode, string message, bool uncertain = false) : base(message) { Status = status; ErrorCode = errorCode; Uncertain = uncertain; }
}
static string Required(string name)
{ var value = Environment.GetEnvironmentVariable(name); return string.IsNullOrWhiteSpace(value) ? throw new Exception("Set " + name) : value; }
static string Text(JsonNode value) => value == null ? "" :
value is JsonValue scalar && scalar.TryGetValue<string>(out var text) ? text : value.ToJsonString();
static JsonObject Query(params (string Key, string Value)[] values)
{ var result = new JsonObject(); foreach (var value in values) result[value.Key] = value.Value; return result; }
static async Task<Result> Call(string name, JsonObject query = null, JsonNode body = null,
string key = null)
{
var route = Spec["requests"][name];
var method = Text(route["method"]);
var headers = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase)
{ ["Authorization"] = "Bearer " + ApiKey, ["Accept"] = "application/json" };
if (method == "POST") { if (string.IsNullOrEmpty(key)) throw new Exception("Save a create key before sending POST"); headers["Idempotency-Key"] = key; }
var data = body?.ToJsonString();
var suffix = query == null ? "" : string.Join("&", query.Select(p => Uri.EscapeDataString(p.Key) + "=" + Uri.EscapeDataString(Text(p.Value))));
var url = BaseUrl + Text(route["path"]) + (suffix.Length == 0 ? "" : "?" + suffix);
// Only GET has automatic retries in this workflow. A PATCH or DELETE that got no response or a
// server error is never resent blindly: it may already have been applied, so the caller reads the record first.
var resend = method == "GET";
for (var attempt = 0; attempt < 5; attempt++)
{
using var request = new HttpRequestMessage(new HttpMethod(method), url);
foreach (var header in headers) request.Headers.TryAddWithoutValidation(header.Key, header.Value);
if (data != null) request.Content = new StringContent(data, Encoding.UTF8, "application/json");
HttpResponseMessage response;
string raw;
try { response = await Send(request); }
catch (Exception error) when (error is HttpRequestException || error is TaskCanceledException)
{ if (!resend) throw new ApiException(0, null, "No response", true); if (attempt == 4) throw; await Task.Delay(TimeSpan.FromSeconds(Math.Pow(2, attempt))); continue; }
using (response)
{
try { raw = await response.Content.ReadAsStringAsync(); }
catch (Exception error) when (error is HttpRequestException || error is TaskCanceledException)
{ if (!resend) throw new ApiException(0, null, "No response", true); if (attempt == 4) throw; await Task.Delay(TimeSpan.FromSeconds(Math.Pow(2, attempt))); continue; }
var status = (int)response.StatusCode;
var resultHeaders = response.Headers.Concat(response.Content.Headers)
.ToDictionary(h => h.Key.ToLowerInvariant(), h => string.Join(", ", h.Value));
JsonNode result = null;
if (status != 304 && raw.Length > 0)
{
try { result = JsonNode.Parse(raw); }
catch (JsonException) { if (status < 400) throw new Exception("Expected a JSON success response"); }
}
var errorBody = result as JsonObject;
if (status >= 500 && !resend) throw new ApiException(status, errorBody == null ? null : Text(errorBody["error_code"]), "HTTP " + status, true);
var retry = resend && (status == 429 || status >= 500);
if (retry)
{
if (attempt == 4) throw new Exception("Retry limit reached; check the outcome before starting a new create");
var seconds = Math.Pow(2, attempt);
if (resultHeaders.TryGetValue("retry-after", out var requested) &&
double.TryParse(requested, NumberStyles.Float, CultureInfo.InvariantCulture, out var delay) &&
double.IsFinite(delay) && delay >= 0) seconds = delay;
await Task.Delay(TimeSpan.FromSeconds(seconds)); continue;
}
if (status >= 400) throw new ApiException(status, errorBody == null ? null : Text(errorBody["error_code"]), errorBody == null ? "HTTP " + status :
$"{Text(errorBody["error_code"])} {errorBody["error_params"]}: {errorBody["errors"]} (request {Text(errorBody["request_id"])})");
return new Result { Status = status, Body = result, Headers = resultHeaders, Raw = raw };
}
}
throw new Exception("Retry limit reached");
}
static string AddOffset(string offset,long received) { var result=checked(long.Parse(offset,CultureInfo.InvariantCulture)+received);if(received<=0||result>int.MaxValue)throw new Exception("Cannot advance this int32 offset; reconcile the query");return result.ToString(CultureInfo.InvariantCulture); }
static bool Both(bool left,bool right)=>left&&right;
static string Concat(string left,string right) => left+right;
static JsonArray Items(JsonNode value) => value as JsonArray ?? throw new Exception("Expected a JSON array");
static long Count(JsonNode value) => Items(value).Count;
static bool DeepEqual(JsonNode left,JsonNode right)=>JsonNode.DeepEquals(left,right);
static bool Either(bool left,bool right) => left || right;
static object Scalar(object value) { if(value is JsonValue json){if(json.TryGetValue<bool>(out var boolean))return boolean;if(json.TryGetValue<string>(out var text))return text;return json.ToJsonString();}return value; }
static bool Equal(object left,object right) => object.Equals(Scalar(left),Scalar(right));
static JsonNode Field(JsonNode value,string name) { if(value is not JsonObject obj || !obj.TryGetPropertyValue(name,out var item))throw new Exception("Missing response field: "+name);return item; }
sealed class FileSnapshot { internal string Name; internal byte[] Data; internal string Sha256; }
static string FileLength(FileSnapshot value) => value.Data.LongLength.ToString(CultureInfo.InvariantCulture);
static string FileName(FileSnapshot value) => value.Name;
static string FileSha256(FileSnapshot value) => value.Sha256;
static bool IsEmpty(JsonNode value) => Count(value)==0;
static bool IsPresent(string value) => value!=null && value!="";
public sealed class JournalRefusal : Exception { public JournalRefusal(string message) : base(message) {} }
public static class JournalProtocol
{
public static readonly byte[] Preamble = Encoding.ASCII.GetBytes("EXHIBITDAY-GUIDE-JOURNAL 1\n");
static readonly UTF8Encoding Utf8 = new UTF8Encoding(false, true);
static bool Match(string value,string pattern) => value != null && System.Text.RegularExpressions.Regex.IsMatch(value,"\\A(?:"+pattern+")\\z",System.Text.RegularExpressions.RegexOptions.CultureInvariant);
public static bool Valid(string value,string pattern) => Match(value,pattern);
static string Ascii(byte[] raw,int start,int count)
{ for(var i=start;i<start+count;i++)if(raw[i]>127)throw new JournalRefusal("Journal framing must be canonical ASCII");return Encoding.ASCII.GetString(raw,start,count); }
public static byte[] Strings(IEnumerable<string> values)
{
using var data=new MemoryStream();
foreach(var value in values){if(value==null)throw new JournalRefusal("Journal fields are exact strings");var item=Utf8.GetBytes(value);var prefix=Encoding.ASCII.GetBytes(item.Length.ToString(CultureInfo.InvariantCulture)+":");data.Write(prefix);data.Write(item);}
return data.ToArray();
}
public static List<string> ReadStrings(byte[] raw)
{
var values=new List<string>();var offset=0;
while(offset<raw.Length){var end=Array.IndexOf(raw,(byte)58,offset);if(end<0)throw new JournalRefusal("Incomplete journal string length");var text=Ascii(raw,offset,end-offset);
if(!Match(text,"0|[1-9][0-9]*")||!long.TryParse(text,NumberStyles.None,CultureInfo.InvariantCulture,out var size))throw new JournalRefusal("Noncanonical journal string length");offset=end+1;
if(size>raw.Length-offset)throw new JournalRefusal("Incomplete journal string");values.Add(Utf8.GetString(raw,offset,(int)size));offset+=(int)size;}
return values;
}
public static string Digest(byte[] raw)=>Convert.ToHexString(System.Security.Cryptography.SHA256.HashData(raw));
public static string Fingerprint(IReadOnlyDictionary<string,string> pairs)
{
var values=new List<string>();foreach(var name in pairs.Keys.OrderBy(n=>n,StringComparer.Ordinal)){
if(!Match(name,"[A-Za-z0-9_.-]+")||new[]{"api_key","exhibitday_api_key"}.Contains(name.ToLowerInvariant()))throw new JournalRefusal("Use explicit secret-free fingerprint names");values.Add(name);values.Add(pairs[name]);}
return Digest(Strings(values));
}
public static byte[] Frame(IEnumerable<string> values)
{
var payload=Strings(values);var header=Encoding.ASCII.GetBytes(payload.Length.ToString(CultureInfo.InvariantCulture)+" "+Digest(payload)+"\n");
using var data=new MemoryStream();data.Write(header);data.Write(payload);data.WriteByte(10);return data.ToArray();
}
public static List<List<string>> Decode(byte[] raw)
{
if(raw.Length<Preamble.Length||!raw.Take(Preamble.Length).SequenceEqual(Preamble))throw new JournalRefusal("Unknown or incomplete journal version");
var offset=Preamble.Length;var records=new List<List<string>>();
while(offset<raw.Length){var end=Array.IndexOf(raw,(byte)10,offset);if(end<0)throw new JournalRefusal("Incomplete frame header; reconcile before retry");var header=Ascii(raw,offset,end-offset);
if(!Match(header,"(0|[1-9][0-9]*) [0-9A-F]{64}"))throw new JournalRefusal("Invalid frame header");var split=header.Split(' ');
if(!long.TryParse(split[0],NumberStyles.None,CultureInfo.InvariantCulture,out var size))throw new JournalRefusal("Invalid frame length");offset=end+1;
if(size>=raw.Length-offset)throw new JournalRefusal("Incomplete frame; reconcile before retry");var payload=raw.AsSpan(offset,(int)size).ToArray();offset+=(int)size;
if(raw[offset]!=10||Digest(payload)!=split[1])throw new JournalRefusal("Journal integrity failed; reconcile before retry");records.Add(ReadStrings(payload));offset++;}
return records;
}
}
public sealed class Journal : IDisposable
{
readonly string path,lockPath,owner;readonly List<string> header;
readonly Dictionary<string,(string Method,string Path)> allowed=new Dictionary<string,(string,string)>(StringComparer.Ordinal);
Dictionary<string,Dictionary<string,string>> intents=new Dictionary<string,Dictionary<string,string>>(StringComparer.Ordinal),savedValues=new Dictionary<string,Dictionary<string,string>>(StringComparer.Ordinal);
FileStream lockStream;bool owned,tainted;DateTime creation;
static FileStream CreatePrivate(string target,FileAccess access,FileShare share)
{
var options=new FileStreamOptions{Mode=FileMode.CreateNew,Access=access,Share=share};
if(!OperatingSystem.IsWindows())options.UnixCreateMode=UnixFileMode.UserRead|UnixFileMode.UserWrite;
return new FileStream(target,options);
}
public Journal(string path,string apiBase,string workspace,string slug,string job,string inputFingerprint,IEnumerable<(string Step,string Method,string Path)> writes,string mode="resume")
{
this.path=path;lockPath=path+".lock";owner=Convert.ToHexString(System.Security.Cryptography.RandomNumberGenerator.GetBytes(16)).ToLowerInvariant();
if(!Uri.TryCreate(apiBase,UriKind.Absolute,out var address)||address.Scheme!="https"&&address.Scheme!="http"||address.UserInfo.Length!=0||address.Query.Length!=0||address.Fragment.Length!=0||!JournalProtocol.Valid(slug,"[a-z][a-z0-9-]*"))throw new JournalRefusal("Use the actual API base and closed guide slug");
if(string.IsNullOrWhiteSpace(job)||!JournalProtocol.Valid(workspace,"[1-9][0-9]*")||!JournalProtocol.Valid(inputFingerprint,"[0-9A-F]{64}"))throw new JournalRefusal("Use actual workspace, stable explicit job ID and exact fingerprint");
if(mode!="new"&&mode!="resume")throw new JournalRefusal("Choose new or resume for this local job");
var manifest=new List<string>();foreach(var write in writes){
if(!JournalProtocol.Valid(write.Step,"[a-z][a-z0-9_-]*")||allowed.ContainsKey(write.Step)||!new[]{"POST","PATCH","DELETE"}.Contains(write.Method)||!JournalProtocol.Valid(write.Path,"/v1/[A-Za-z0-9_/-]+")||write.Path.Contains("//"))throw new JournalRefusal("Use a closed unique write manifest");
allowed.Add(write.Step,(write.Method,write.Path));manifest.AddRange(new[]{write.Step,write.Method,write.Path});}
if(allowed.Count==0)throw new JournalRefusal("Only write workflows need a restart journal");
header=new List<string>{"H","1",apiBase,workspace,slug,job,inputFingerprint,JournalProtocol.Digest(JournalProtocol.Strings(manifest))};JournalProtocol.Strings(header);
try{lockStream=CreatePrivate(lockPath,FileAccess.ReadWrite,FileShare.Read);owned=true;}
catch(IOException)when(File.Exists(lockPath)){throw new JournalRefusal("This journal is locked; do not overlap jobs or steal a stale lock");}
try{
var token=Encoding.ASCII.GetBytes(owner);lockStream.Write(token);lockStream.Flush(true);creation=File.GetCreationTimeUtc(lockPath);
if(File.Exists(path)&&(File.GetAttributes(path)&FileAttributes.ReparsePoint)!=0)throw new JournalRefusal("Choose a private regular journal file");
if(mode=="resume"&&!File.Exists(path))throw new JournalRefusal("Journal missing: stop and reconcile lost state before starting a new job");
if(mode=="new"&&File.Exists(path))throw new JournalRefusal("Journal exists; use resume for the same job");
if(mode=="new"){using var output=CreatePrivate(path,FileAccess.Write,FileShare.None);output.Write(JournalProtocol.Preamble);output.Write(JournalProtocol.Frame(header));output.Flush(true);}
var records=JournalProtocol.Decode(File.ReadAllBytes(path));if(records.Count==0||!records[0].SequenceEqual(header))throw new JournalRefusal("Journal workspace/base/guide/job/input binding differs");
foreach(var record in records.Skip(1))Apply(record);if(intents.Keys.Any(step=>!savedValues.ContainsKey(step)))throw new JournalRefusal("Saved intent lacks ACK; stop and reconcile before retry");
}catch{Dispose();throw;}
}
void Apply(IReadOnlyList<string> record)
{
if(record.Count==0)throw new JournalRefusal("Empty journal record");
if(record[0]=="I"){
if(record.Count!=6)throw new JournalRefusal("Invalid intent shape");var step=record[1];var method=record[2];var route=record[3];var fingerprint=record[4];var key=record[5];
if(!JournalProtocol.Valid(step,"[a-z][a-z0-9_-]*")||intents.ContainsKey(step)||!allowed.TryGetValue(step,out var expected)||expected!=(method,route)||!JournalProtocol.Valid(fingerprint,"[0-9A-F]{64}")||intents.Keys.Any(name=>!savedValues.ContainsKey(name)))throw new JournalRefusal("Invalid, future or repeated intent");
if(method=="POST"&&!JournalProtocol.Valid(key,"[0-9a-f]{32}")||method!="POST"&&key!="")throw new JournalRefusal("Invalid persisted action key");
intents.Add(step,new Dictionary<string,string>{{"method",method},{"path",route},{"request_fingerprint",fingerprint},{"idempotency_key",key}});
}else if(record[0]=="A"){
if(record.Count<3||!JournalProtocol.Valid(record[2],"0|[1-9][0-9]*")||!long.TryParse(record[2],NumberStyles.None,CultureInfo.InvariantCulture,out var count)||count!=(record.Count-3L)/2||record.Count%2!=1||!intents.ContainsKey(record[1])||savedValues.ContainsKey(record[1]))throw new JournalRefusal("ACK without exactly one prior intent");
var names=record.Skip(3).Where((_,index)=>index%2==0).ToArray();
if(!names.SequenceEqual(names.Distinct(StringComparer.Ordinal).OrderBy(name=>name,StringComparer.Ordinal))||names.Any(name=>!JournalProtocol.Valid(name,"[a-z][a-z0-9_]*")||name=="api_key"||name=="exhibitday_api_key"))throw new JournalRefusal("ACK fields must be unique sorted secret-free identifiers");
var saved=new Dictionary<string,string>(StringComparer.Ordinal);for(var i=0;i<names.Length;i++)saved.Add(names[i],record[4+2*i]);savedValues.Add(record[1],saved);
}else throw new JournalRefusal("Unknown journal transition");
}
void RequireActive()
{
if(!owned||lockStream==null||tainted)throw new JournalRefusal("Journal is closed or IO outcome needs reconciliation");
// FileShare.Read denies write/delete sharing on Windows while this handle
// is held. Token + creation witness guards cooperative ownership. Manual
// replacement during a run is outside the portable compare/unlink claim.
var position=lockStream.Position;lockStream.Position=0;var token=new byte[owner.Length];var count=lockStream.Read(token);lockStream.Position=position;
if(!File.Exists(lockPath)||File.GetCreationTimeUtc(lockPath)!=creation||lockStream.Length!=owner.Length||count!=owner.Length||!token.SequenceEqual(Encoding.ASCII.GetBytes(owner)))throw new JournalRefusal("Journal lock was replaced; stop without deleting it");
}
void Append(IReadOnlyList<string> record)
{
RequireActive();var raw=JournalProtocol.Frame(record);
try{using var output=new FileStream(path,FileMode.Append,FileAccess.Write,FileShare.None);output.Write(raw);output.Flush(true);}
catch{tainted=true;throw;}
}
public bool Acknowledged(string step){RequireActive();return savedValues.ContainsKey(step);}
public Dictionary<string,string> Saved(string step){RequireActive();if(!savedValues.ContainsKey(step))throw new JournalRefusal("No confirmed state exists");return new Dictionary<string,string>(savedValues[step],StringComparer.Ordinal);}
public Dictionary<string,string> Begin(string step,string method,string route,string requestFingerprint)
{
RequireActive();if(intents.ContainsKey(step))throw new JournalRefusal("Never blindly repeat an existing action");
var key=method=="POST"?Convert.ToHexString(System.Security.Cryptography.RandomNumberGenerator.GetBytes(16)).ToLowerInvariant():"";
var record=new[]{"I",step,method,route,requestFingerprint,key};var previous=new Dictionary<string,Dictionary<string,string>>(intents,StringComparer.Ordinal);try{Apply(record);}finally{intents=previous;}
Append(record);Apply(record);return new Dictionary<string,string>(intents[step],StringComparer.Ordinal);
}
public void Acknowledge(string step,IReadOnlyDictionary<string,string> saved)
{
RequireActive();var record=new List<string>{"A",step,saved.Count.ToString(CultureInfo.InvariantCulture)};foreach(var name in saved.Keys.OrderBy(name=>name,StringComparer.Ordinal))record.AddRange(new[]{name,saved[name]});
var previous=new Dictionary<string,Dictionary<string,string>>(savedValues,StringComparer.Ordinal);try{Apply(record);JournalProtocol.Strings(record);}finally{savedValues=previous;}
Append(record);Apply(record);
}
public void Dispose()
{
if(!owned)return;if(tainted){lockStream.Dispose();lockStream=null;owned=false;return;}
try{RequireActive();}catch{lockStream.Dispose();lockStream=null;owned=false;throw;}
lockStream.Dispose();lockStream=null;owned=false;File.Delete(lockPath);
}
}
static Dictionary<string,string> JournalValues(JsonNode value)
{
if(value is not JsonObject fields)throw new JournalRefusal("Saved/fingerprint values need an explicit object");
var result=new Dictionary<string,string>(StringComparer.Ordinal);
foreach(var field in fields){if(field.Value is not JsonValue item || !item.TryGetValue<string>(out var text) || text==null)throw new JournalRefusal("Saved/fingerprint values must be exact strings");result.Add(field.Key,text);}return result;
}
static JsonObject JournalObject(IReadOnlyDictionary<string,string> fields){var result=new JsonObject();foreach(var field in fields)result.Add(field.Key,JsonValue.Create(field.Value));return result;}
static void JournalAcknowledge(Journal job,string step,JsonNode saved)=>job.Acknowledge(step,JournalValues(saved));
static bool JournalAcknowledged(Journal job,string step)=>job.Acknowledged(step);
static JsonNode JournalBegin(Journal job,string step,string method,string path,string requestFingerprint)=>JournalObject(job.Begin(step,method,path,requestFingerprint));
static string JournalFingerprint(JsonNode value)=>JournalProtocol.Fingerprint(JournalValues(value));
static JsonNode JournalSaved(Journal job,string step)=>JournalObject(job.Saved(step));
static string JsonString(JsonNode value)=>value?.ToJsonString()??"null";
static HashSet<string> NewIdSet() => new HashSet<string>(StringComparer.Ordinal);
static bool NotValue(bool value) => !value;
static Journal OpenJournal(string path,string apiBase,string workspace,string slug,string job,string inputFingerprint,JsonNode manifest,string mode)
{
if(manifest is not JsonArray rows)throw new JournalRefusal("A closed write manifest is required");var writes=new List<(string,string,string)>();
foreach(var row in rows){if(row is not JsonArray fields || fields.Count!=3)throw new JournalRefusal("Each write must bind its step/method/path");var values=fields.Select(value=>value is JsonValue item&&item.TryGetValue<string>(out var text)&&text!=null?text:throw new JournalRefusal("Manifest values are exact strings")).ToArray();writes.Add((values[0],values[1],values[2]));}
return new Journal(path,apiBase,workspace,slug,job,inputFingerprint,writes,mode);
}
static string Optional(string name,string fallback) { var value=Environment.GetEnvironmentVariable(name);return value==null||value==""?fallback:value; }
static JsonNode ParseJson(string value)=>JsonNode.Parse(value);
static string PositiveId(string value) { if(string.IsNullOrEmpty(value)||value[0]=='0'||!value.All(c=>c>='0'&&c<='9')||!long.TryParse(value,NumberStyles.None,CultureInfo.InvariantCulture,out var id)||id<=0)throw new Exception("Use a positive record ID");return value; }
static void PrintValue(object value) => Console.WriteLine(value is string text ? text : JsonSerializer.Serialize(value));
static FileSnapshot ReadFileSnapshot(string path, string action) {
var rule = Spec["requests"][action]["file"];
if (rule == null || Text(rule["name"]) != "file") throw new Exception("Use the current declared file input");
var data = File.ReadAllBytes(path);
if (data.Length == 0 || data.LongLength > long.Parse(Text(rule["maximum_bytes"]), CultureInfo.InvariantCulture)) throw new Exception("The selected file is empty or exceeds this endpoint file limit");
var name = Path.GetFileName(path);
if (name.Length == 0 || name.IndexOfAny(new[]{'\r','\n','\0'}) >= 0) throw new Exception("Use a filename without header control characters");
return new FileSnapshot { Name=name, Data=data, Sha256=Convert.ToHexString(System.Security.Cryptography.SHA256.HashData(data)).ToLowerInvariant() };
}
static bool RememberId(HashSet<string> seen,string value) => seen.Add(value);
static async Task<byte[]> RequestDownload(string name, JsonObject query) {
var route=Spec["requests"][name];
if(Text(route["method"])!="GET" || Text(route["binary"])!="true")throw new Exception("Bind the declared binary GET");
var suffix=query==null?"":string.Join("&",query.Select(p=>Uri.EscapeDataString(p.Key)+"="+Uri.EscapeDataString(Text(p.Value))));
using var request=new HttpRequestMessage(HttpMethod.Get,BaseUrl+Text(route["path"])+(suffix.Length==0?"":"?"+suffix));
request.Headers.Add("Authorization","Bearer "+ApiKey);request.Headers.Add("Accept","application/octet-stream");
using var response=await Send(request);var data=await response.Content.ReadAsByteArrayAsync();var status=(int)response.StatusCode;
if(status!=200){JsonNode parsed=null;try{parsed=JsonNode.Parse(data);}catch(JsonException){}throw new ApiException(status,parsed is JsonObject?Text(parsed["error_code"]):null,"HTTP "+status);}
return data;
}
static async Task<string> RequestExpect(string name,JsonObject query,JsonNode body,string key,string expected) {
try { await Call(name,query,body,key); }
catch(ApiException observed) { if(observed.Uncertain||observed.Status.ToString(System.Globalization.CultureInfo.InvariantCulture)!=expected)throw;return observed.Status.ToString(System.Globalization.CultureInfo.InvariantCulture); }
throw new Exception("Expected HTTP "+expected+" refusal; request unexpectedly succeeded");
}
static async Task<Result> RequestUpload(string name, JsonObject query, FileSnapshot file, string key) {
var route = Spec["requests"][name];
if (Text(route["method"]) != "POST" || route["file"] == null || string.IsNullOrEmpty(key)) throw new Exception("Bind one declared upload and its persisted create key");
var suffix = query == null ? "" : string.Join("&", query.Select(p=>Uri.EscapeDataString(p.Key)+"="+Uri.EscapeDataString(Text(p.Value))));
using var request = new HttpRequestMessage(HttpMethod.Post, BaseUrl+Text(route["path"])+(suffix.Length==0?"":"?"+suffix));
request.Headers.Add("Authorization","Bearer "+ApiKey); request.Headers.Add("Accept","application/json"); request.Headers.Add("Idempotency-Key",key);
using var multipart = new MultipartFormDataContent(); using var content = new ByteArrayContent(file.Data);
content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("application/octet-stream"); multipart.Add(content,"file",file.Name); request.Content=multipart;
HttpResponseMessage response; string raw;
try { response=await Send(request); }
catch(Exception error) when(error is HttpRequestException || error is TaskCanceledException) { throw new ApiException(0,null,"No response",true); }
using(response) {
try { raw=await response.Content.ReadAsStringAsync(); } catch(Exception error) when(error is HttpRequestException || error is TaskCanceledException) { throw new ApiException(0,null,"No response",true); }
JsonNode parsed=null; try { parsed=JsonNode.Parse(raw); } catch(JsonException) { }
var status=(int)response.StatusCode;
if(status!=200)throw new ApiException(status,parsed is JsonObject?Text(parsed["error_code"]):null,"HTTP "+status,status>=500);
if(!(parsed is JsonObject))throw new Exception("Upload returned no usable JSON receipt; reconcile before retrying");
return new Result { Status=status, Body=parsed, Raw=raw, Headers=response.Headers.Concat(response.Content.Headers).ToDictionary(h=>h.Key.ToLowerInvariant(),h=>string.Join(", ",h.Value)) };
}
}
static void RequireCondition(bool value,string message) { if(!value)throw new Exception(message); }
static string ResponseStatus(Result value)=>value.Status.ToString(CultureInfo.InvariantCulture);
static void SaveCheckedDownload(byte[] data, FileSnapshot file, string path) {
if(data.LongLength!=file.Data.LongLength || Convert.ToHexString(System.Security.Cryptography.SHA256.HashData(data)).ToLowerInvariant()!=file.Sha256)throw new Exception("Downloaded bytes differ; no output was created");
var options=new FileStreamOptions { Mode=FileMode.CreateNew, Access=FileAccess.Write, Share=FileShare.None };
if(!OperatingSystem.IsWindows())options.UnixCreateMode=UnixFileMode.UserRead|UnixFileMode.UserWrite;
using var output=new FileStream(path,options);output.Write(data);output.Flush(true);
}
static JsonNode Single(JsonNode value){var rows=Items(value);if(rows.Count!=1)throw new Exception("Expected exactly one selected record");return rows[0];}
static string Text(object value) => value==null?"":value is JsonNode node?Text(node):Convert.ToString(value,CultureInfo.InvariantCulture);
internal static async Task Run()
{
var integration_event_id = PositiveId(Required("EXHIBITDAY_EVENT_ID"));
var integration_job_id = Required("EXHIBITDAY_JOB_ID");
var integration_job_hash = JournalFingerprint(new JsonObject { ["job_id"] = integration_job_id });
var integration_initial_name = Concat("API integration check ", integration_job_hash);
var integration_updated_name = Concat(integration_initial_name, " updated");
var integration_file = ReadFileSnapshot(Required("EXHIBITDAY_FILE"), "upload");
var integration_output_path = Required("EXHIBITDAY_DOWNLOAD_PATH");
var integration_cleanup = Optional("EXHIBITDAY_TEST_CLEANUP", "keep");
RequireCondition(Either(Equal(integration_cleanup, "keep"), Equal(integration_cleanup, "delete")), "Use keep or delete for EXHIBITDAY_TEST_CLEANUP.");
var integration_workspace_response = await Call("workspace_binding", new JsonObject { }, null, null);
RequireCondition(Equal(ResponseStatus(integration_workspace_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
var integration_workspace = integration_workspace_response.Body;
var integration_workspace_id = PositiveId(Text(Field(integration_workspace, "id")));
var integration_state_path = Required("EXHIBITDAY_TEST_STATE");
var integration_job_mode = Optional("EXHIBITDAY_JOB_MODE", "resume");
using (var integration_job = OpenJournal(integration_state_path, "https://api.exhibitday.com/v1", integration_workspace_id, "integration-testing", integration_job_id, JournalFingerprint(new JsonObject { ["workflow_contract_sha256"] = "3808BE3DE866226BE6AAA4C445EBC19FC7903FD96FC8DC2F223F6D6451BA6267", ["event_id"] = integration_event_id, ["initial_name"] = integration_initial_name, ["updated_name"] = integration_updated_name, ["filename"] = FileName(integration_file), ["file_length"] = FileLength(integration_file), ["file_sha256"] = FileSha256(integration_file) }), new JsonArray(new JsonArray("create", "POST", "/v1/tasks"), new JsonArray("edit", "PATCH", "/v1/tasks"), new JsonArray("stale", "PATCH", "/v1/tasks"), new JsonArray("upload", "POST", "/v1/tasks/attachments"), new JsonArray("remove_file", "DELETE", "/v1/tasks/attachments"), new JsonArray("remove_task", "DELETE", "/v1/tasks")), integration_job_mode)) {
var integration_task_id = "";
var integration_attachment_id = "";
if (NotValue(JournalAcknowledged(integration_job, "remove_task"))) {
if (NotValue(JournalAcknowledged(integration_job, "create"))) {
var integration_create_intent = JournalBegin(integration_job, "create", "POST", "/v1/tasks", JournalFingerprint(new JsonObject { ["event_id"] = integration_event_id, ["name"] = integration_initial_name }));
var integration_created_response = await Call("create", new JsonObject { }, new JsonObject { ["event_id"] = integration_event_id, ["name"] = integration_initial_name }, Text(Field(integration_create_intent, "idempotency_key")));
RequireCondition(Equal(ResponseStatus(integration_created_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
var integration_created = integration_created_response.Body;
integration_task_id = PositiveId(Text(Field(integration_created, "id")));
RequireCondition(Both(Equal(Text(Field(integration_created, "id")), integration_task_id), Both(Equal(Text(Field(Field(integration_created, "event"), "id")), integration_event_id), Equal(Text(Field(integration_created, "name")), integration_initial_name))), "The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.");
JournalAcknowledge(integration_job, "create", new JsonObject { ["task_id"] = integration_task_id, ["event_id"] = integration_event_id, ["name"] = integration_initial_name, ["create_key"] = Text(Field(integration_create_intent, "idempotency_key")) });
}
var integration_saved_create = JournalSaved(integration_job, "create");
integration_task_id = PositiveId(Text(Field(integration_saved_create, "task_id")));
RequireCondition(Both(Equal(Text(Field(integration_saved_create, "event_id")), integration_event_id), Equal(Text(Field(integration_saved_create, "name")), integration_initial_name)), "Saved create state differs from this Event/job.");
RequireCondition(Either(NotValue(JournalAcknowledged(integration_job, "remove_file")), Equal(integration_cleanup, "delete")), "Cleanup already removed the test file. Continue with EXHIBITDAY_TEST_CLEANUP=delete to finish this Task cleanup.");
var integration_before_response = await Call("read", new JsonObject { ["id"] = integration_task_id, ["$include_record_revision"] = "true" }, null, null);
RequireCondition(Equal(ResponseStatus(integration_before_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
var integration_before = integration_before_response.Body;
if (NotValue(JournalAcknowledged(integration_job, "edit"))) {
RequireCondition(Both(Equal(Text(Field(integration_before, "id")), integration_task_id), Both(Equal(Text(Field(Field(integration_before, "event"), "id")), integration_event_id), Equal(Text(Field(integration_before, "name")), integration_initial_name))), "The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.");
var integration_original_revision = Text(Field(integration_before, "record_revision"));
RequireCondition(IsPresent(integration_original_revision), "Read the actual created Task revision before editing.");
JournalBegin(integration_job, "edit", "PATCH", "/v1/tasks", JournalFingerprint(new JsonObject { ["id"] = integration_task_id, ["name"] = integration_updated_name, ["expected_revision"] = integration_original_revision }));
var integration_edit_response = await Call("edit", new JsonObject { }, new JsonObject { ["id"] = integration_task_id, ["name"] = integration_updated_name, ["expected_revision"] = integration_original_revision }, null);
RequireCondition(Equal(ResponseStatus(integration_edit_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
var integration_edit_receipt = integration_edit_response.Body;
var integration_saved_revision = Text(Field(integration_edit_receipt, "record_revision"));
RequireCondition(Both(IsPresent(integration_saved_revision), NotValue(Equal(integration_original_revision, integration_saved_revision))), "The distinct test name must produce a checked new revision before the stale test.");
JournalAcknowledge(integration_job, "edit", new JsonObject { ["task_id"] = integration_task_id, ["name"] = integration_updated_name, ["original_revision"] = integration_original_revision, ["record_revision"] = integration_saved_revision });
}
var integration_saved_edit = JournalSaved(integration_job, "edit");
RequireCondition(Both(Equal(Text(Field(integration_saved_edit, "task_id")), integration_task_id), Equal(Text(Field(integration_saved_edit, "name")), integration_updated_name)), "Saved edit state differs from this Task/name.");
if (NotValue(JournalAcknowledged(integration_job, "stale"))) {
JournalBegin(integration_job, "stale", "PATCH", "/v1/tasks", JournalFingerprint(new JsonObject { ["id"] = integration_task_id, ["name"] = "Refused stale test", ["expected_revision"] = Text(Field(integration_saved_edit, "original_revision")) }));
var integration_stale_status = await RequestExpect("stale", new JsonObject { }, new JsonObject { ["id"] = integration_task_id, ["name"] = "Refused stale test", ["expected_revision"] = Text(Field(integration_saved_edit, "original_revision")) }, null, "409");
JournalAcknowledge(integration_job, "stale", new JsonObject { ["task_id"] = integration_task_id, ["observed_status"] = integration_stale_status });
}
var integration_saved_stale = JournalSaved(integration_job, "stale");
RequireCondition(Both(Equal(Text(Field(integration_saved_stale, "task_id")), integration_task_id), Equal(Text(Field(integration_saved_stale, "observed_status")), "409")), "The saved conflict assertion differs from this Task/status.");
var integration_after_edit_response = await Call("after_edit", new JsonObject { ["id"] = integration_task_id, ["$include_record_revision"] = "true" }, null, null);
RequireCondition(Equal(ResponseStatus(integration_after_edit_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
var integration_after_edit = integration_after_edit_response.Body;
RequireCondition(Both(Equal(Text(Field(integration_after_edit, "id")), integration_task_id), Both(Equal(Text(Field(Field(integration_after_edit, "event"), "id")), integration_event_id), Equal(Text(Field(integration_after_edit, "name")), integration_updated_name))), "The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.");
RequireCondition(Equal(Text(Field(integration_after_edit, "record_revision")), Text(Field(integration_saved_edit, "record_revision"))), "The test Task's revision changed; stop before file work or cleanup.");
RequireCondition(Either(NotValue(Equal(integration_cleanup, "delete")), DeepEqual(Field(integration_after_edit, "comments"), new JsonArray())), "The test Task has comments; stop before cleanup.");
if (NotValue(JournalAcknowledged(integration_job, "upload"))) {
RequireCondition(Equal(Text(Field(integration_after_edit, "record_revision")), Text(Field(integration_saved_edit, "record_revision"))), "The Task changed after the conditional edit. Review it before uploading.");
var integration_upload_intent = JournalBegin(integration_job, "upload", "POST", "/v1/tasks/attachments", JournalFingerprint(new JsonObject { ["task_id"] = integration_task_id, ["filename"] = FileName(integration_file), ["file_length"] = FileLength(integration_file), ["file_sha256"] = FileSha256(integration_file) }));
var integration_upload_response = await RequestUpload("upload", new JsonObject { ["task_id"] = integration_task_id }, integration_file, Text(Field(integration_upload_intent, "idempotency_key")));
RequireCondition(Equal(ResponseStatus(integration_upload_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
var integration_upload = integration_upload_response.Body;
RequireCondition(Both(Equal(Text(Field(integration_upload, "records_found")), "1"), Both(Equal(Text(Field(integration_upload, "total_records")), "1"), Equal(Field(integration_upload, "has_more"), false))), "Require exactly one complete uploaded-file receipt.");
var integration_uploaded_file = Single(Field(integration_upload, "list_data"));
integration_attachment_id = PositiveId(Text(Field(integration_uploaded_file, "id")));
RequireCondition(IsPresent(Text(Field(integration_uploaded_file, "filename"))), "The upload receipt needs its actual stored filename.");
JournalAcknowledge(integration_job, "upload", new JsonObject { ["task_id"] = integration_task_id, ["attachment_id"] = integration_attachment_id, ["filename"] = Text(Field(integration_uploaded_file, "filename")), ["attachment_json"] = JsonString(integration_uploaded_file), ["file_length"] = FileLength(integration_file), ["file_sha256"] = FileSha256(integration_file) });
}
var integration_saved_upload = JournalSaved(integration_job, "upload");
integration_attachment_id = PositiveId(Text(Field(integration_saved_upload, "attachment_id")));
RequireCondition(Both(Equal(Text(Field(integration_saved_upload, "task_id")), integration_task_id), Both(Equal(Text(Field(integration_saved_upload, "file_length")), FileLength(integration_file)), Equal(Text(Field(integration_saved_upload, "file_sha256")), FileSha256(integration_file)))), "The confirmed file differs from the saved test Task or file details.");
if (NotValue(JournalAcknowledged(integration_job, "remove_file"))) {
var integration_list_offset = "0";
var integration_file_count = "0";
var integration_file_found = false;
var integration_file_seen = NewIdSet();
var integration_list_query = new JsonObject { ["task_id"] = integration_task_id, ["$limit"] = "25", ["$offset"] = "0" };
while (true) {
integration_list_query["$offset"] = integration_list_offset;
var integration_list_response = await Call("verify_file", integration_list_query, null, null);
RequireCondition(Equal(ResponseStatus(integration_list_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
var integration_list = integration_list_response.Body;
var integration_list_rows = Items(Field(integration_list, "list_data"));
RequireCondition(Equal(Text(Field(integration_list, "records_found")), Text(Count(integration_list_rows))), "The Task file page count differs from its rows.");
RequireCondition(IsPresent(Text(Field(integration_list, "total_records"))), "The Task file page needs total_records.");
RequireCondition(Either(Equal(Field(integration_list, "has_more"), true), Equal(Field(integration_list, "has_more"), false)), "The Task file page needs Boolean has_more.");
foreach (var integration_list_row in Items(integration_list_rows)) {
var integration_list_id = PositiveId(Text(Field(integration_list_row, "id")));
RequireCondition(RememberId(integration_file_seen, integration_list_id), "A Task file ID repeated while paging.");
if (Equal(integration_list_id, integration_attachment_id)) {
RequireCondition(DeepEqual(integration_list_row, ParseJson(Text(Field(integration_saved_upload, "attachment_json")))), "The saved Task file details changed.");
integration_file_found = true;
}
}
integration_file_count = AddOffset(integration_file_count, Count(integration_list_rows));
if (Equal(Field(integration_list, "has_more"), false)) {
break;
}
RequireCondition(NotValue(IsEmpty(integration_list_rows)), "An empty Task file page says has_more=true.");
integration_list_offset = AddOffset(integration_list_offset, Count(integration_list_rows));
}
RequireCondition(integration_file_found, "The saved file is not on this Task; stop before downloading by id or cleaning up.");
RequireCondition(Either(NotValue(Equal(integration_cleanup, "delete")), Equal(integration_file_count, "1")), "Another Task file exists; stop before deleting the test Task.");
var integration_download_response = await RequestDownload("download", new JsonObject { ["id"] = integration_attachment_id });
SaveCheckedDownload(integration_download_response, integration_file, integration_output_path);
}
if (Equal(integration_cleanup, "delete")) {
if (NotValue(JournalAcknowledged(integration_job, "remove_file"))) {
JournalBegin(integration_job, "remove_file", "DELETE", "/v1/tasks/attachments", JournalFingerprint(new JsonObject { ["id"] = integration_attachment_id }));
var integration_file_remove_response = await Call("remove_file", new JsonObject { ["id"] = integration_attachment_id }, null, null);
RequireCondition(Equal(ResponseStatus(integration_file_remove_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
JournalAcknowledge(integration_job, "remove_file", new JsonObject { ["task_id"] = integration_task_id, ["attachment_id"] = integration_attachment_id });
}
if (NotValue(JournalAcknowledged(integration_job, "remove_task"))) {
JournalBegin(integration_job, "remove_task", "DELETE", "/v1/tasks", JournalFingerprint(new JsonObject { ["id"] = integration_task_id }));
var integration_task_remove_response = await Call("remove_task", new JsonObject { ["id"] = integration_task_id }, null, null);
RequireCondition(Equal(ResponseStatus(integration_task_remove_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
JournalAcknowledge(integration_job, "remove_task", new JsonObject { ["task_id"] = integration_task_id });
}
} else {
PrintValue(new JsonObject { ["task_id"] = integration_task_id, ["attachment_id"] = integration_attachment_id, ["cleanup"] = "kept" });
}
}
if (JournalAcknowledged(integration_job, "remove_task")) {
var integration_removed = JournalSaved(integration_job, "remove_task");
integration_task_id = PositiveId(Text(Field(integration_removed, "task_id")));
var integration_missing_status = await RequestExpect("verify_removed", new JsonObject { ["id"] = integration_task_id }, null, null, "404");
PrintValue(new JsonObject { ["task_id"] = integration_task_id, ["cleanup"] = "removed", ["observed_missing_status"] = integration_missing_status });
}
}
}
static Task Main() => Run();
}
// Java 11+ with Gson on the classpath. Set EXHIBITDAY_API_KEY; save as Main.java.
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.ToNumberPolicy;
import java.io.*;
import java.net.*;
import java.net.http.*;
import java.nio.charset.StandardCharsets;
import java.nio.file.*;
import java.time.*;
import java.util.*;
public class Main {
static final Gson JSON = new GsonBuilder().setObjectToNumberStrategy(ToNumberPolicy.LAZILY_PARSED_NUMBER).create();
static final String BASE = "https://api.exhibitday.com/v1";
static final Map<String,Object> SPEC = JSON.fromJson("{\"preserveNumbers\":true,\"requests\":{\"workspace_binding\":{\"method\":\"GET\",\"path\":\"/references/workspace_info\"},\"create\":{\"method\":\"POST\",\"path\":\"/tasks\"},\"read\":{\"method\":\"GET\",\"path\":\"/tasks/info\"},\"edit\":{\"method\":\"PATCH\",\"path\":\"/tasks\"},\"stale\":{\"method\":\"PATCH\",\"path\":\"/tasks\"},\"after_edit\":{\"method\":\"GET\",\"path\":\"/tasks/info\"},\"upload\":{\"method\":\"POST\",\"path\":\"/tasks/attachments\",\"file\":{\"name\":\"file\",\"maximum_bytes\":\"26214400\",\"extensions\":[\"png\",\"jpg\",\"jpeg\",\"bmp\",\"gif\",\"pdf\",\"msg\",\"eml\",\"doc\",\"docx\",\"ppt\",\"pptx\",\"xls\",\"xlsx\",\"csv\",\"rtf\",\"odp\",\"odt\",\"ods\",\"txt\",\"wks\",\"zip\"],\"content_types\":[]}},\"verify_file\":{\"method\":\"GET\",\"path\":\"/tasks/attachments\"},\"download\":{\"method\":\"GET\",\"path\":\"/tasks/attachments/download\",\"binary\":true},\"remove_file\":{\"method\":\"DELETE\",\"path\":\"/tasks/attachments\"},\"remove_task\":{\"method\":\"DELETE\",\"path\":\"/tasks\"},\"verify_removed\":{\"method\":\"GET\",\"path\":\"/tasks/info\"}}}", Map.class);
static final String API_KEY = headerKey(required("EXHIBITDAY_API_KEY"));
static String headerKey(String value){if(value.chars().anyMatch(c->c<32||c>126))throw new IllegalArgumentException("Use the API key as one ASCII header value without control characters");return value;}
static final HttpClient CLIENT = HttpClient.newBuilder().connectTimeout(Duration.ofSeconds(30)).followRedirects(HttpClient.Redirect.NEVER).build();
interface RequestSender { HttpResponse<String> send(HttpRequest request)throws IOException,InterruptedException; }
static RequestSender SEND=request->CLIENT.send(request,HttpResponse.BodyHandlers.ofString(StandardCharsets.UTF_8));
static class Result { int status; Object body; Map<String,String> headers; String raw;
Result(int s, Object b, Map<String,String> h,String r) {status=s;body=b;headers=h;raw=r;} }
// An API error response. Branch on errorCode (and status), never on the message text.
// uncertain is true when a PATCH or DELETE got no response or a server error: it may or may not have been applied.
static class ApiException extends IllegalStateException { final int status; final String errorCode; final boolean uncertain;
ApiException(int status,Object errorCode,String message) {this(status,errorCode,message,false);}
ApiException(int status,Object errorCode,String message,boolean uncertain) {super(message);this.status=status;this.errorCode=errorCode==null?null:String.valueOf(errorCode);this.uncertain=uncertain;} }
static String required(String name) {String value=System.getenv(name);if(value==null||value.trim().isEmpty())throw new IllegalArgumentException("Set "+name);return value;}
static String env(String name,String fallback) {String value=System.getenv(name);return value==null||value.isEmpty()?fallback:value;}
static String text(Object value) {return value==null?"":value.toString();}
@SuppressWarnings("unchecked") static Map<String,Object> obj(Object value) {return value==null?new LinkedHashMap<>(): (Map<String,Object>)value;}
@SuppressWarnings("unchecked") static List<Object> list(Object value) {return value==null?Collections.emptyList():(List<Object>)value;}
static Map<String,Object> map(Object... pairs) {Map<String,Object> result=new LinkedHashMap<>();for(int i=0;i<pairs.length;i+=2)result.put((String)pairs[i],pairs[i+1]);return result;}
static void pause(double seconds) {try {Thread.sleep((long)(Math.max(0,seconds)*1000));}catch(InterruptedException error){Thread.currentThread().interrupt();throw new RuntimeException(error);}}
static Result call(String name,Map<String,Object> query,Object body,String key) {
Map<String,Object> route=obj(obj(SPEC.get("requests")).get(name));String method=text(route.get("method"));
Map<String,Object> headers=map("Authorization","Bearer " + API_KEY,"Accept","application/json");
if(method.equals("POST")){if(key==null||key.isEmpty())throw new IllegalArgumentException("Save a create key before sending POST");headers.put("Idempotency-Key",key);}
String data=body==null?null:JSON.toJson(body);if(data!=null)headers.put("Content-Type","application/json");
StringJoiner queryString=new StringJoiner("&");
if(query!=null)query.forEach((k,v)->queryString.add(URLEncoder.encode(k,StandardCharsets.UTF_8)+"="+URLEncoder.encode(text(v),StandardCharsets.UTF_8)));
String url=BASE+text(route.get("path"))+(queryString.length()==0?"":"?"+queryString);
// Only GET has automatic retries in this workflow. A PATCH or DELETE that got no response or a
// server error is never resent blindly: it may already have been applied, so the caller reads the record first.
boolean resend=method.equals("GET");
for(int attempt=0;attempt<5;attempt++) {
HttpRequest.Builder request=HttpRequest.newBuilder(URI.create(url)).timeout(Duration.ofSeconds(30));
headers.forEach((k,v)->request.header(k,text(v)));
request.method(method,data==null?HttpRequest.BodyPublishers.noBody():HttpRequest.BodyPublishers.ofString(data,StandardCharsets.UTF_8));
HttpResponse<String> response;
try {response=SEND.send(request.build());}
catch(InterruptedException error){Thread.currentThread().interrupt();throw new RuntimeException(error);}
catch(IOException error){if(!resend)throw new ApiException(0,null,"No response",true);if(attempt==4)throw new RuntimeException(error);pause(Math.pow(2,attempt));continue;}
int status=response.statusCode();Object parsed=null;
if(status!=304&&!response.body().isEmpty()) {
try {parsed=JSON.fromJson(response.body(),Object.class);}
catch(RuntimeException error){if(status<400)throw new IllegalStateException("Expected a JSON success response",error);}
}
Map<String,String> responseHeaders=new HashMap<>();response.headers().map().forEach((k,v)->responseHeaders.put(k.toLowerCase(Locale.ROOT),String.join(", ",v)));
if(status>=500&&!resend)throw new ApiException(status,obj(parsed).get("error_code"),"HTTP "+status,true);
boolean retry=resend&&(status==429||status>=500);
if(retry) {
if(attempt==4)throw new IllegalStateException("Retry limit reached; check the outcome before starting a new create");
double seconds=Math.pow(2,attempt);
try {double value=Double.parseDouble(responseHeaders.get("retry-after"));if(Double.isFinite(value)&&value>=0)seconds=value;}catch(Exception ignored){}
pause(seconds);continue;
}
if(status>=400)throw new ApiException(status,obj(parsed).get("error_code"),"HTTP "+status+": "+obj(parsed).get("error_code")+" (request "+obj(parsed).get("request_id")+")");
return new Result(status,parsed,responseHeaders,response.body());
}
throw new IllegalStateException("Retry limit reached");
}
static String add_offset(String offset,long received){long result=Math.addExact(Long.parseLong(offset),received);if(received<=0||result>Integer.MAX_VALUE)throw new IllegalStateException("Cannot advance this int32 offset; reconcile the query");return Long.toString(result);}
static boolean both(boolean left,boolean right){return left&&right;}
static String concat(String left,String right){return left+right;}
static List<Object> items(Object value){if(!(value instanceof List))throw new IllegalStateException("Expected a JSON array");return list(value);}
static long count(Object value){return items(value).size();}
static boolean deep_equal(Object left,Object right){
if(left==null||right==null)return left==right;
if(left instanceof Number&&right instanceof Number)return new java.math.BigDecimal(left.toString()).compareTo(new java.math.BigDecimal(right.toString()))==0;
if(left instanceof Map&&right instanceof Map){Map<?,?> a=(Map<?,?>)left,b=(Map<?,?>)right;if(!a.keySet().equals(b.keySet()))return false;for(Object key:a.keySet())if(!deep_equal(a.get(key),b.get(key)))return false;return true;}
if(left instanceof List&&right instanceof List){List<?> a=(List<?>)left,b=(List<?>)right;if(a.size()!=b.size())return false;for(int i=0;i<a.size();i++)if(!deep_equal(a.get(i),b.get(i)))return false;return true;}
return left.getClass()==right.getClass()&&left.equals(right);
}
static boolean either(boolean left,boolean right){return left||right;}
static boolean equal(Object left,Object right){return Objects.equals(left,right);}
static Object field(Object value,String name){if(!(value instanceof Map)||!obj(value).containsKey(name))throw new IllegalStateException("Missing response field: "+name);return obj(value).get(name);}
static String fileDigest(byte[] data){try{StringBuilder text=new StringBuilder();for(byte b:java.security.MessageDigest.getInstance("SHA-256").digest(data))text.append(String.format(Locale.ROOT,"%02x",b&255));return text.toString();}catch(java.security.NoSuchAlgorithmException error){throw new IllegalStateException(error);}}
static class FileSnapshot { final String name,sha256; final byte[] data;
FileSnapshot(String n,byte[] d){name=n;data=d;sha256=fileDigest(d);} }
static String file_length(FileSnapshot value){return Integer.toString(value.data.length);}
static String file_name(FileSnapshot value){return value.name;}
static String file_sha256(FileSnapshot value){return value.sha256;}
static boolean is_empty(Object value){return count(value)==0;}
static boolean is_present(String value){return value!=null&&!value.isEmpty();}
// Private client restart state only. No transport, application or JSON interpreter.
static final class Journal implements AutoCloseable {
public static final class Refusal extends IllegalStateException { Refusal(String message){super(message);} }
public static final byte[] PREAMBLE="EXHIBITDAY-GUIDE-JOURNAL 1\n".getBytes(StandardCharsets.US_ASCII);
static boolean valid(String value,String pattern){return value!=null&&value.matches(pattern);}
static byte[] utf8(String value)throws java.nio.charset.CharacterCodingException {
if(value==null)throw new Refusal("Journal fields are exact strings");
java.nio.ByteBuffer encoded=StandardCharsets.UTF_8.newEncoder().onMalformedInput(java.nio.charset.CodingErrorAction.REPORT).onUnmappableCharacter(java.nio.charset.CodingErrorAction.REPORT).encode(java.nio.CharBuffer.wrap(value));byte[] raw=new byte[encoded.remaining()];encoded.get(raw);return raw;
}
static String ascii(byte[] raw,int start,int count){for(int i=start;i<start+count;i++)if((raw[i]&255)>127)throw new Refusal("Journal framing must be canonical ASCII");return new String(raw,start,count,StandardCharsets.US_ASCII);}
public static byte[] strings(Collection<String> values)throws IOException {
ByteArrayOutputStream output=new ByteArrayOutputStream();for(String value:values){byte[] raw=utf8(value);output.write((raw.length+":").getBytes(StandardCharsets.US_ASCII));output.write(raw);}return output.toByteArray();
}
static int find(byte[] raw,int offset,int value){for(int i=offset;i<raw.length;i++)if((raw[i]&255)==value)return i;return-1;}
public static List<String> readStrings(byte[] raw)throws IOException {
List<String> values=new ArrayList<>();int offset=0;
while(offset<raw.length){int end=find(raw,offset,58);if(end<0)throw new Refusal("Incomplete journal string length");String text=ascii(raw,offset,end-offset);
if(!valid(text,"0|[1-9][0-9]*"))throw new Refusal("Noncanonical journal string length");java.math.BigInteger size=new java.math.BigInteger(text);offset=end+1;if(size.compareTo(java.math.BigInteger.valueOf(raw.length-offset))>0)throw new Refusal("Incomplete journal string");int count=size.intValueExact();
values.add(StandardCharsets.UTF_8.newDecoder().onMalformedInput(java.nio.charset.CodingErrorAction.REPORT).onUnmappableCharacter(java.nio.charset.CodingErrorAction.REPORT).decode(java.nio.ByteBuffer.wrap(raw,offset,count)).toString());offset+=count;}
return values;
}
public static String digest(byte[] raw){try{byte[] hash=java.security.MessageDigest.getInstance("SHA-256").digest(raw);StringBuilder text=new StringBuilder();for(byte item:hash)text.append(String.format(Locale.ROOT,"%02X",item&255));return text.toString();}catch(java.security.NoSuchAlgorithmException error){throw new IllegalStateException(error);}}
public static String fingerprint(Map<String,String> pairs)throws IOException {
List<String> values=new ArrayList<>();for(String name:new TreeSet<>(pairs.keySet())){if(!valid(name,"[A-Za-z0-9_.-]+")||Arrays.asList("api_key","exhibitday_api_key").contains(name.toLowerCase(Locale.ROOT)))throw new Refusal("Use explicit secret-free fingerprint names");values.add(name);values.add(pairs.get(name));}return digest(strings(values));
}
public static byte[] frame(Collection<String> values)throws IOException {byte[] payload=strings(values);ByteArrayOutputStream output=new ByteArrayOutputStream();output.write((payload.length+" "+digest(payload)+"\n").getBytes(StandardCharsets.US_ASCII));output.write(payload);output.write(10);return output.toByteArray();}
public static List<List<String>> decode(byte[] raw)throws IOException {
if(raw.length<PREAMBLE.length||!Arrays.equals(Arrays.copyOfRange(raw,0,PREAMBLE.length),PREAMBLE))throw new Refusal("Unknown or incomplete journal version");int offset=PREAMBLE.length;List<List<String>> records=new ArrayList<>();
while(offset<raw.length){int end=find(raw,offset,10);if(end<0)throw new Refusal("Incomplete frame header; reconcile before retry");String header=ascii(raw,offset,end-offset);
if(!valid(header,"(0|[1-9][0-9]*) [0-9A-F]{64}"))throw new Refusal("Invalid frame header");String[] fields=header.split(" ");java.math.BigInteger size=new java.math.BigInteger(fields[0]);offset=end+1;
if(size.compareTo(java.math.BigInteger.valueOf(raw.length-offset))>=0)throw new Refusal("Incomplete frame; reconcile before retry");int count=size.intValueExact();byte[] payload=Arrays.copyOfRange(raw,offset,offset+count);offset+=count;
if(raw[offset]!=10||!digest(payload).equals(fields[1]))throw new Refusal("Journal integrity failed; reconcile before retry");records.add(readStrings(payload));offset++;}return records;
}
static void writeAll(java.nio.channels.FileChannel target,byte[] raw)throws IOException {java.nio.ByteBuffer data=java.nio.ByteBuffer.wrap(raw);while(data.hasRemaining())if(target.write(data)<=0)throw new IOException("Journal write did not advance");}
static java.nio.channels.FileChannel createPrivate(Path path,OpenOption... options)throws IOException {
java.nio.file.attribute.FileAttribute<?>[] attributes=FileSystems.getDefault().supportedFileAttributeViews().contains("posix")?new java.nio.file.attribute.FileAttribute<?>[]{java.nio.file.attribute.PosixFilePermissions.asFileAttribute(java.nio.file.attribute.PosixFilePermissions.fromString("rw-------"))}:new java.nio.file.attribute.FileAttribute<?>[0];
return java.nio.channels.FileChannel.open(path,new HashSet<>(Arrays.asList(options)),attributes);
}
final Path path,lockPath;final String owner;final List<String> header;
final Map<String,List<String>> allowed=new LinkedHashMap<>();Map<String,Map<String,String>> intents=new LinkedHashMap<>(),savedValues=new LinkedHashMap<>();
java.nio.channels.FileChannel lock;boolean owned,tainted;Object fileKey;java.nio.file.attribute.FileTime creation;
public Journal(Path path,String apiBase,String workspace,String slug,String job,String inputFingerprint,List<List<String>> writes)throws IOException {this(path,apiBase,workspace,slug,job,inputFingerprint,writes,"resume");}
public Journal(Path path,String apiBase,String workspace,String slug,String job,String inputFingerprint,List<List<String>> writes,String mode)throws IOException {
this.path=path;lockPath=Path.of(path.toString()+".lock");byte[] random=new byte[16];new java.security.SecureRandom().nextBytes(random);StringBuilder token=new StringBuilder();for(byte item:random)token.append(String.format(Locale.ROOT,"%02x",item&255));owner=token.toString();
URI address=URI.create(apiBase);if(!Arrays.asList("https","http").contains(address.getScheme())||address.getHost()==null||address.getUserInfo()!=null||address.getRawQuery()!=null||address.getRawFragment()!=null||!valid(slug,"[a-z][a-z0-9-]*"))throw new Refusal("Use actual API base and closed guide slug");
if(job==null||job.trim().isEmpty()||!valid(workspace,"[1-9][0-9]*")||!valid(inputFingerprint,"[0-9A-F]{64}"))throw new Refusal("Use actual workspace, stable explicit job ID and exact fingerprint");
if(!Arrays.asList("new","resume").contains(mode))throw new Refusal("Choose new or resume for this local job");
List<String> manifest=new ArrayList<>();for(List<String> item:writes){if(item.size()!=3)throw new Refusal("Invalid write manifest shape");String step=item.get(0),method=item.get(1),route=item.get(2);
if(!valid(step,"[a-z][a-z0-9_-]*")||allowed.containsKey(step)||!Arrays.asList("POST","PATCH","DELETE").contains(method)||!valid(route,"/v1/[A-Za-z0-9_/-]+")||route.contains("//"))throw new Refusal("Use a closed unique write manifest");allowed.put(step,List.of(method,route));manifest.addAll(item);}
if(allowed.isEmpty())throw new Refusal("Only write workflows need a restart journal");header=List.of("H","1",apiBase,workspace,slug,job,inputFingerprint,digest(strings(manifest)));strings(header);
try{lock=createPrivate(lockPath,StandardOpenOption.CREATE_NEW,StandardOpenOption.READ,StandardOpenOption.WRITE);owned=true;}catch(FileAlreadyExistsException error){throw new Refusal("This journal is locked; do not overlap jobs or steal a stale lock");}
try{writeAll(lock,owner.getBytes(StandardCharsets.US_ASCII));lock.force(true);java.nio.file.attribute.BasicFileAttributes identity=Files.readAttributes(lockPath,java.nio.file.attribute.BasicFileAttributes.class,LinkOption.NOFOLLOW_LINKS);fileKey=identity.fileKey();creation=identity.creationTime();
if(Files.isSymbolicLink(path))throw new Refusal("Choose a private regular journal file");
if(mode.equals("resume")&&!Files.exists(path))throw new Refusal("Journal missing: stop and reconcile lost state before starting a new job");
if(mode.equals("new")&&Files.exists(path))throw new Refusal("Journal exists; use resume for the same job");
if(mode.equals("new")){try(java.nio.channels.FileChannel target=createPrivate(path,StandardOpenOption.CREATE_NEW,StandardOpenOption.WRITE)){writeAll(target,PREAMBLE);writeAll(target,frame(header));target.force(true);}}
List<List<String>> records=decode(Files.readAllBytes(path));if(records.isEmpty()||!records.get(0).equals(header))throw new Refusal("Journal workspace/base/guide/job/input binding differs");for(List<String> record:records.subList(1,records.size()))apply(record);
if(intents.keySet().stream().anyMatch(step->!savedValues.containsKey(step)))throw new Refusal("Saved intent lacks ACK; stop and reconcile before retry");
}catch(IOException|RuntimeException error){close();throw error;}
}
void apply(List<String> record){
if(record.isEmpty())throw new Refusal("Empty journal record");
if(record.get(0).equals("I")){
if(record.size()!=6)throw new Refusal("Invalid intent shape");String step=record.get(1),method=record.get(2),route=record.get(3),fingerprint=record.get(4),key=record.get(5);
if(!valid(step,"[a-z][a-z0-9_-]*")||intents.containsKey(step)||!List.of(method,route).equals(allowed.get(step))||!valid(fingerprint,"[0-9A-F]{64}")||intents.keySet().stream().anyMatch(name->!savedValues.containsKey(name)))throw new Refusal("Invalid, future or repeated intent");
if(method.equals("POST")&&!valid(key,"[0-9a-f]{32}")||!method.equals("POST")&&!key.isEmpty())throw new Refusal("Invalid persisted action key");intents.put(step,new LinkedHashMap<>(Map.of("method",method,"path",route,"request_fingerprint",fingerprint,"idempotency_key",key)));
}else if(record.get(0).equals("A")){
if(record.size()<3||!valid(record.get(2),"0|[1-9][0-9]*")||!new java.math.BigInteger(record.get(2)).multiply(java.math.BigInteger.TWO).equals(java.math.BigInteger.valueOf(record.size()-3))||!intents.containsKey(record.get(1))||savedValues.containsKey(record.get(1)))throw new Refusal("ACK without exactly one prior intent");
List<String> names=new ArrayList<>();for(int i=3;i<record.size();i+=2)names.add(record.get(i));if(!names.equals(new ArrayList<>(new TreeSet<>(names)))||names.stream().anyMatch(name->!valid(name,"[a-z][a-z0-9_]*")||name.equals("api_key")||name.equals("exhibitday_api_key")))throw new Refusal("ACK fields must be unique sorted secret-free identifiers");
Map<String,String> saved=new LinkedHashMap<>();for(int i=0;i<names.size();i++)saved.put(names.get(i),record.get(4+2*i));savedValues.put(record.get(1),saved);
}else throw new Refusal("Unknown journal transition");
}
void requireActive()throws IOException {
if(!owned||lock==null||tainted)throw new Refusal("Journal is closed or IO outcome needs reconciliation");java.nio.file.attribute.BasicFileAttributes current=Files.readAttributes(lockPath,java.nio.file.attribute.BasicFileAttributes.class,LinkOption.NOFOLLOW_LINKS);
if(!Objects.equals(fileKey,current.fileKey())||!creation.equals(current.creationTime())||!Arrays.equals(Files.readAllBytes(lockPath),owner.getBytes(StandardCharsets.US_ASCII)))throw new Refusal("Journal lock was replaced; stop without deleting it");
}
void append(List<String> record)throws IOException {requireActive();byte[] raw=frame(record);try(java.nio.channels.FileChannel target=java.nio.channels.FileChannel.open(path,StandardOpenOption.WRITE,StandardOpenOption.APPEND)){writeAll(target,raw);target.force(true);}catch(IOException|RuntimeException error){tainted=true;throw error;}}
public boolean acknowledged(String step)throws IOException{requireActive();return savedValues.containsKey(step);}
public Map<String,String> saved(String step)throws IOException{requireActive();if(!savedValues.containsKey(step))throw new Refusal("No confirmed state exists");return new LinkedHashMap<>(savedValues.get(step));}
public Map<String,String> begin(String step,String method,String route,String requestFingerprint)throws IOException {
requireActive();if(intents.containsKey(step))throw new Refusal("Never blindly repeat an existing action");String key="";if(method.equals("POST")){byte[] bytes=new byte[16];new java.security.SecureRandom().nextBytes(bytes);StringBuilder text=new StringBuilder();for(byte item:bytes)text.append(String.format(Locale.ROOT,"%02x",item&255));key=text.toString();}
List<String> record=List.of("I",step,method,route,requestFingerprint,key);Map<String,Map<String,String>> previous=new LinkedHashMap<>(intents);try{apply(record);}finally{intents=previous;}append(record);apply(record);return new LinkedHashMap<>(intents.get(step));
}
public void acknowledge(String step,Map<String,String> saved)throws IOException {
requireActive();List<String> record=new ArrayList<>(List.of("A",step,Integer.toString(saved.size())));for(String name:new TreeSet<>(saved.keySet())){record.add(name);record.add(saved.get(name));}
Map<String,Map<String,String>> previous=new LinkedHashMap<>(savedValues);try{apply(record);strings(record);}finally{savedValues=previous;}append(record);apply(record);
}
public void close()throws IOException {
if(!owned)return;if(tainted){lock.close();lock=null;owned=false;return;}
try{requireActive();}catch(IOException|RuntimeException error){lock.close();lock=null;owned=false;throw error;}lock.close();lock=null;owned=false;Files.delete(lockPath);
}
}
static Map<String,String> journal_values(Object value){if(!(value instanceof Map))throw new Journal.Refusal("Saved/fingerprint values need an explicit object");Map<String,String> result=new LinkedHashMap<>();for(Map.Entry<?,?> field:((Map<?,?>)value).entrySet()){if(!(field.getKey() instanceof String)||!(field.getValue() instanceof String))throw new Journal.Refusal("Saved/fingerprint values must be exact strings");result.put((String)field.getKey(),(String)field.getValue());}return result;}
static void journal_acknowledge(Journal job,String step,Object saved)throws IOException{job.acknowledge(step,journal_values(saved));}
static boolean journal_acknowledged(Journal job,String step)throws IOException{return job.acknowledged(step);}
static Object journal_begin(Journal job,String step,String method,String path,String requestFingerprint)throws IOException{return new LinkedHashMap<String,Object>(job.begin(step,method,path,requestFingerprint));}
static String journal_fingerprint(Object value)throws IOException{return Journal.fingerprint(journal_values(value));}
static Object journal_saved(Journal job,String step)throws IOException{return new LinkedHashMap<String,Object>(job.saved(step));}
static String json_string(Object value){return new GsonBuilder().serializeNulls().create().toJson(value);}
static Set<String> new_id_set(){return new HashSet<>();}
static boolean not_value(boolean value){return !value;}
static Journal open_journal(String path,String base,String workspace,String slug,String job,String inputFingerprint,Object manifest,String mode)throws IOException {
if(!(manifest instanceof List))throw new Journal.Refusal("A closed write manifest is required");List<List<String>> writes=new ArrayList<>();for(Object row:(List<?>)manifest){if(!(row instanceof List)||((List<?>)row).size()!=3)throw new Journal.Refusal("Each write must bind step/method/path");List<String> fields=new ArrayList<>();for(Object value:(List<?>)row){if(!(value instanceof String))throw new Journal.Refusal("Manifest values are exact strings");fields.add((String)value);}writes.add(fields);}return new Journal(Path.of(path),base,workspace,slug,job,inputFingerprint,writes,mode);
}
static String optional(String name,String fallback){String value=System.getenv(name);return value==null||value.isEmpty()?fallback:value;}
static Object parse_json(String value){return JSON.fromJson(value,Object.class);}
static String positive_id(String value){try{if(value==null||!value.matches("[1-9][0-9]*")||Long.parseLong(value)<=0)throw new IllegalArgumentException();return value;}catch(RuntimeException error){throw new IllegalArgumentException("Use a positive record ID");}}
static void print_value(Object value){try{String text=value instanceof String?(String)value:JSON.toJson(value);System.out.write((text+"\n").getBytes(StandardCharsets.UTF_8));}catch(IOException error){throw new UncheckedIOException(error);}}
static FileSnapshot read_file_snapshot(String path,String action) {
Map<String,Object> rule=obj(obj(obj(SPEC.get("requests")).get(action)).get("file"));
if(!"file".equals(text(rule.get("name"))))throw new IllegalStateException("Use the current declared file input");
try {byte[] data=Files.readAllBytes(Path.of(path));if(data.length==0||data.length>Long.parseLong(text(rule.get("maximum_bytes"))))throw new IllegalStateException("The selected file is empty or exceeds this endpoint file limit");
String name=Path.of(path).getFileName().toString();if(name.isEmpty()||name.indexOf('\r')>=0||name.indexOf('\n')>=0||name.indexOf(0)>=0)throw new IllegalStateException("Use a filename without header control characters");return new FileSnapshot(name,data);
}catch(IOException error){throw new IllegalStateException(error);}
}
static boolean remember_id(Set<String> seen,String value){return seen.add(value);}
static String fileUrl(Map<String,Object> route,Map<String,Object> params){StringJoiner query=new StringJoiner("&");params.forEach((k,v)->query.add(URLEncoder.encode(k,StandardCharsets.UTF_8)+"="+URLEncoder.encode(text(v),StandardCharsets.UTF_8)));return BASE+text(route.get("path"))+(query.length()==0?"":"?"+query);}
interface BinaryRequestSender {HttpResponse<byte[]> send(HttpRequest request)throws IOException,InterruptedException;}
static BinaryRequestSender BINARY_SEND=request->CLIENT.send(request,HttpResponse.BodyHandlers.ofByteArray());
static byte[] request_download(String name,Map<String,Object> params){
Map<String,Object> route=obj(obj(SPEC.get("requests")).get(name));
if(!"GET".equals(route.get("method"))||!Boolean.TRUE.equals(route.get("binary")))throw new IllegalStateException("Bind the declared binary GET");
HttpRequest request=HttpRequest.newBuilder(URI.create(fileUrl(route,params))).timeout(Duration.ofSeconds(30)).header("Authorization","Bearer "+API_KEY).header("Accept","application/octet-stream").GET().build();
try{HttpResponse<byte[]> response=BINARY_SEND.send(request);if(response.statusCode()!=200){Object parsed=null;try{parsed=JSON.fromJson(new String(response.body(),StandardCharsets.UTF_8),Object.class);}catch(RuntimeException error){}throw new ApiException(response.statusCode(),obj(parsed).get("error_code"),"HTTP "+response.statusCode());}return response.body();}
catch(InterruptedException error){Thread.currentThread().interrupt();throw new IllegalStateException(error);}catch(IOException error){throw new IllegalStateException(error);}
}
static String request_expect(String name,Map<String,Object> query,Object body,String key,String expected) {
try { call(name,query,body,key); }
catch(ApiException observed) { if(observed.uncertain||!Integer.toString(observed.status).equals(expected))throw observed;return Integer.toString(observed.status); }
throw new IllegalStateException("Expected HTTP "+expected+" refusal; request unexpectedly succeeded");
}
static Result request_upload(String name,Map<String,Object> params,FileSnapshot file,String key){
Map<String,Object> route=obj(obj(SPEC.get("requests")).get(name));
if(!"POST".equals(route.get("method"))||route.get("file")==null||key==null||key.isEmpty())throw new IllegalStateException("Bind one declared upload and its persisted create key");
String boundary;do{boundary="ExhibitDayGuide"+UUID.randomUUID().toString().replace("-","");}while(new String(file.data,StandardCharsets.ISO_8859_1).contains(boundary));
String quoted=file.name.replace("\\","\\\\").replace("\"","\\\"");byte[] data;
try {ByteArrayOutputStream stream=new ByteArrayOutputStream();stream.write(("--"+boundary+"\r\nContent-Disposition: form-data; name=\"file\"; filename=\""+quoted+"\"\r\nContent-Type: application/octet-stream\r\n\r\n").getBytes(StandardCharsets.UTF_8));stream.write(file.data);stream.write(("\r\n--"+boundary+"--\r\n").getBytes(StandardCharsets.US_ASCII));data=stream.toByteArray();}catch(IOException error){throw new IllegalStateException(error);}
HttpRequest request=HttpRequest.newBuilder(URI.create(fileUrl(route,params))).timeout(Duration.ofSeconds(30)).header("Authorization","Bearer "+API_KEY).header("Accept","application/json").header("Idempotency-Key",key).header("Content-Type","multipart/form-data; boundary="+boundary).POST(HttpRequest.BodyPublishers.ofByteArray(data)).build();
HttpResponse<String> response;try{response=SEND.send(request);}catch(InterruptedException error){Thread.currentThread().interrupt();throw new ApiException(0,null,"No response",true);}catch(IOException error){throw new ApiException(0,null,"No response",true);}
Object parsed=null;try{parsed=JSON.fromJson(response.body(),Object.class);}catch(RuntimeException error){}
if(response.statusCode()!=200)throw new ApiException(response.statusCode(),obj(parsed).get("error_code"),"HTTP "+response.statusCode(),response.statusCode()>=500);
if(!(parsed instanceof Map))throw new IllegalStateException("Upload returned no usable JSON receipt; reconcile before retrying");
Map<String,String> headers=new HashMap<>();response.headers().map().forEach((k,v)->headers.put(k.toLowerCase(Locale.ROOT),String.join(", ",v)));return new Result(response.statusCode(),parsed,headers,response.body());
}
static void require_condition(boolean value,String message){if(!value)throw new IllegalStateException(message);}
static String response_status(Result value){return Integer.toString(value.status);}
static void save_checked_download(byte[] data,FileSnapshot file,String path){
if(data.length!=file.data.length||!fileDigest(data).equals(file.sha256))throw new IllegalStateException("Downloaded bytes differ; no output was created");
Path target=Path.of(path);Set<java.nio.file.OpenOption> flags=new HashSet<>(Arrays.asList(StandardOpenOption.CREATE_NEW,StandardOpenOption.WRITE));
try {java.nio.file.attribute.FileAttribute<?>[] attrs=Files.getFileStore(target.toAbsolutePath().getParent()).supportsFileAttributeView("posix")?new java.nio.file.attribute.FileAttribute<?>[]{java.nio.file.attribute.PosixFilePermissions.asFileAttribute(java.nio.file.attribute.PosixFilePermissions.fromString("rw-------"))}:new java.nio.file.attribute.FileAttribute<?>[0];
try(java.nio.channels.FileChannel output=java.nio.channels.FileChannel.open(target,flags,attrs)){java.nio.ByteBuffer buffer=java.nio.ByteBuffer.wrap(data);while(buffer.hasRemaining())output.write(buffer);output.force(true);}
}catch(IOException error){throw new IllegalStateException(error);}
}
static Object single(Object value){List<Object> rows=items(value);if(rows.size()!=1)throw new IllegalStateException("Expected exactly one selected record");return rows.get(0);}
static void run()throws Exception {
String integration_event_id = positive_id(required("EXHIBITDAY_EVENT_ID"));
String integration_job_id = required("EXHIBITDAY_JOB_ID");
String integration_job_hash = journal_fingerprint(map("job_id", integration_job_id));
String integration_initial_name = concat("API integration check ", integration_job_hash);
String integration_updated_name = concat(integration_initial_name, " updated");
FileSnapshot integration_file = read_file_snapshot(required("EXHIBITDAY_FILE"), "upload");
String integration_output_path = required("EXHIBITDAY_DOWNLOAD_PATH");
String integration_cleanup = optional("EXHIBITDAY_TEST_CLEANUP", "keep");
require_condition(either(equal(integration_cleanup, "keep"), equal(integration_cleanup, "delete")), "Use keep or delete for EXHIBITDAY_TEST_CLEANUP.");
Result integration_workspace_response = call("workspace_binding", map(), null, null);
require_condition(equal(response_status(integration_workspace_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
Object integration_workspace = integration_workspace_response.body;
String integration_workspace_id = positive_id(text(field(integration_workspace, "id")));
String integration_state_path = required("EXHIBITDAY_TEST_STATE");
String integration_job_mode = optional("EXHIBITDAY_JOB_MODE", "resume");
try (Journal integration_job = open_journal(integration_state_path, "https://api.exhibitday.com/v1", integration_workspace_id, "integration-testing", integration_job_id, journal_fingerprint(map("workflow_contract_sha256", "3808BE3DE866226BE6AAA4C445EBC19FC7903FD96FC8DC2F223F6D6451BA6267", "event_id", integration_event_id, "initial_name", integration_initial_name, "updated_name", integration_updated_name, "filename", file_name(integration_file), "file_length", file_length(integration_file), "file_sha256", file_sha256(integration_file))), Arrays.asList(Arrays.asList("create", "POST", "/v1/tasks"), Arrays.asList("edit", "PATCH", "/v1/tasks"), Arrays.asList("stale", "PATCH", "/v1/tasks"), Arrays.asList("upload", "POST", "/v1/tasks/attachments"), Arrays.asList("remove_file", "DELETE", "/v1/tasks/attachments"), Arrays.asList("remove_task", "DELETE", "/v1/tasks")), integration_job_mode)) {
String integration_task_id = "";
String integration_attachment_id = "";
if (not_value(journal_acknowledged(integration_job, "remove_task"))) {
if (not_value(journal_acknowledged(integration_job, "create"))) {
Object integration_create_intent = journal_begin(integration_job, "create", "POST", "/v1/tasks", journal_fingerprint(map("event_id", integration_event_id, "name", integration_initial_name)));
Result integration_created_response = call("create", map(), map("event_id", integration_event_id, "name", integration_initial_name), text(field(integration_create_intent, "idempotency_key")));
require_condition(equal(response_status(integration_created_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
Object integration_created = integration_created_response.body;
integration_task_id = positive_id(text(field(integration_created, "id")));
require_condition(both(equal(text(field(integration_created, "id")), integration_task_id), both(equal(text(field(field(integration_created, "event"), "id")), integration_event_id), equal(text(field(integration_created, "name")), integration_initial_name))), "The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.");
journal_acknowledge(integration_job, "create", map("task_id", integration_task_id, "event_id", integration_event_id, "name", integration_initial_name, "create_key", text(field(integration_create_intent, "idempotency_key"))));
}
Object integration_saved_create = journal_saved(integration_job, "create");
integration_task_id = positive_id(text(field(integration_saved_create, "task_id")));
require_condition(both(equal(text(field(integration_saved_create, "event_id")), integration_event_id), equal(text(field(integration_saved_create, "name")), integration_initial_name)), "Saved create state differs from this Event/job.");
require_condition(either(not_value(journal_acknowledged(integration_job, "remove_file")), equal(integration_cleanup, "delete")), "Cleanup already removed the test file. Continue with EXHIBITDAY_TEST_CLEANUP=delete to finish this Task cleanup.");
Result integration_before_response = call("read", map("id", integration_task_id, "$include_record_revision", "true"), null, null);
require_condition(equal(response_status(integration_before_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
Object integration_before = integration_before_response.body;
if (not_value(journal_acknowledged(integration_job, "edit"))) {
require_condition(both(equal(text(field(integration_before, "id")), integration_task_id), both(equal(text(field(field(integration_before, "event"), "id")), integration_event_id), equal(text(field(integration_before, "name")), integration_initial_name))), "The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.");
String integration_original_revision = text(field(integration_before, "record_revision"));
require_condition(is_present(integration_original_revision), "Read the actual created Task revision before editing.");
journal_begin(integration_job, "edit", "PATCH", "/v1/tasks", journal_fingerprint(map("id", integration_task_id, "name", integration_updated_name, "expected_revision", integration_original_revision)));
Result integration_edit_response = call("edit", map(), map("id", integration_task_id, "name", integration_updated_name, "expected_revision", integration_original_revision), null);
require_condition(equal(response_status(integration_edit_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
Object integration_edit_receipt = integration_edit_response.body;
String integration_saved_revision = text(field(integration_edit_receipt, "record_revision"));
require_condition(both(is_present(integration_saved_revision), not_value(equal(integration_original_revision, integration_saved_revision))), "The distinct test name must produce a checked new revision before the stale test.");
journal_acknowledge(integration_job, "edit", map("task_id", integration_task_id, "name", integration_updated_name, "original_revision", integration_original_revision, "record_revision", integration_saved_revision));
}
Object integration_saved_edit = journal_saved(integration_job, "edit");
require_condition(both(equal(text(field(integration_saved_edit, "task_id")), integration_task_id), equal(text(field(integration_saved_edit, "name")), integration_updated_name)), "Saved edit state differs from this Task/name.");
if (not_value(journal_acknowledged(integration_job, "stale"))) {
journal_begin(integration_job, "stale", "PATCH", "/v1/tasks", journal_fingerprint(map("id", integration_task_id, "name", "Refused stale test", "expected_revision", text(field(integration_saved_edit, "original_revision")))));
String integration_stale_status = request_expect("stale", map(), map("id", integration_task_id, "name", "Refused stale test", "expected_revision", text(field(integration_saved_edit, "original_revision"))), null, "409");
journal_acknowledge(integration_job, "stale", map("task_id", integration_task_id, "observed_status", integration_stale_status));
}
Object integration_saved_stale = journal_saved(integration_job, "stale");
require_condition(both(equal(text(field(integration_saved_stale, "task_id")), integration_task_id), equal(text(field(integration_saved_stale, "observed_status")), "409")), "The saved conflict assertion differs from this Task/status.");
Result integration_after_edit_response = call("after_edit", map("id", integration_task_id, "$include_record_revision", "true"), null, null);
require_condition(equal(response_status(integration_after_edit_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
Object integration_after_edit = integration_after_edit_response.body;
require_condition(both(equal(text(field(integration_after_edit, "id")), integration_task_id), both(equal(text(field(field(integration_after_edit, "event"), "id")), integration_event_id), equal(text(field(integration_after_edit, "name")), integration_updated_name))), "The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.");
require_condition(equal(text(field(integration_after_edit, "record_revision")), text(field(integration_saved_edit, "record_revision"))), "The test Task's revision changed; stop before file work or cleanup.");
require_condition(either(not_value(equal(integration_cleanup, "delete")), deep_equal(field(integration_after_edit, "comments"), Arrays.asList())), "The test Task has comments; stop before cleanup.");
if (not_value(journal_acknowledged(integration_job, "upload"))) {
require_condition(equal(text(field(integration_after_edit, "record_revision")), text(field(integration_saved_edit, "record_revision"))), "The Task changed after the conditional edit. Review it before uploading.");
Object integration_upload_intent = journal_begin(integration_job, "upload", "POST", "/v1/tasks/attachments", journal_fingerprint(map("task_id", integration_task_id, "filename", file_name(integration_file), "file_length", file_length(integration_file), "file_sha256", file_sha256(integration_file))));
Result integration_upload_response = request_upload("upload", map("task_id", integration_task_id), integration_file, text(field(integration_upload_intent, "idempotency_key")));
require_condition(equal(response_status(integration_upload_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
Object integration_upload = integration_upload_response.body;
require_condition(both(equal(text(field(integration_upload, "records_found")), "1"), both(equal(text(field(integration_upload, "total_records")), "1"), equal(field(integration_upload, "has_more"), false))), "Require exactly one complete uploaded-file receipt.");
Object integration_uploaded_file = single(field(integration_upload, "list_data"));
integration_attachment_id = positive_id(text(field(integration_uploaded_file, "id")));
require_condition(is_present(text(field(integration_uploaded_file, "filename"))), "The upload receipt needs its actual stored filename.");
journal_acknowledge(integration_job, "upload", map("task_id", integration_task_id, "attachment_id", integration_attachment_id, "filename", text(field(integration_uploaded_file, "filename")), "attachment_json", json_string(integration_uploaded_file), "file_length", file_length(integration_file), "file_sha256", file_sha256(integration_file)));
}
Object integration_saved_upload = journal_saved(integration_job, "upload");
integration_attachment_id = positive_id(text(field(integration_saved_upload, "attachment_id")));
require_condition(both(equal(text(field(integration_saved_upload, "task_id")), integration_task_id), both(equal(text(field(integration_saved_upload, "file_length")), file_length(integration_file)), equal(text(field(integration_saved_upload, "file_sha256")), file_sha256(integration_file)))), "The confirmed file differs from the saved test Task or file details.");
if (not_value(journal_acknowledged(integration_job, "remove_file"))) {
String integration_list_offset = "0";
String integration_file_count = "0";
boolean integration_file_found = false;
Set<String> integration_file_seen = new_id_set();
Map<String,Object> integration_list_query = map("task_id", integration_task_id, "$limit", "25", "$offset", "0");
while (true) {
integration_list_query.put("$offset", integration_list_offset);
Result integration_list_response = call("verify_file", integration_list_query, null, null);
require_condition(equal(response_status(integration_list_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
Object integration_list = integration_list_response.body;
List<Object> integration_list_rows = items(field(integration_list, "list_data"));
require_condition(equal(text(field(integration_list, "records_found")), text(count(integration_list_rows))), "The Task file page count differs from its rows.");
require_condition(is_present(text(field(integration_list, "total_records"))), "The Task file page needs total_records.");
require_condition(either(equal(field(integration_list, "has_more"), true), equal(field(integration_list, "has_more"), false)), "The Task file page needs Boolean has_more.");
for (Object integration_list_row : items(integration_list_rows)) {
String integration_list_id = positive_id(text(field(integration_list_row, "id")));
require_condition(remember_id(integration_file_seen, integration_list_id), "A Task file ID repeated while paging.");
if (equal(integration_list_id, integration_attachment_id)) {
require_condition(deep_equal(integration_list_row, parse_json(text(field(integration_saved_upload, "attachment_json")))), "The saved Task file details changed.");
integration_file_found = true;
}
}
integration_file_count = add_offset(integration_file_count, count(integration_list_rows));
if (equal(field(integration_list, "has_more"), false)) {
break;
}
require_condition(not_value(is_empty(integration_list_rows)), "An empty Task file page says has_more=true.");
integration_list_offset = add_offset(integration_list_offset, count(integration_list_rows));
}
require_condition(integration_file_found, "The saved file is not on this Task; stop before downloading by id or cleaning up.");
require_condition(either(not_value(equal(integration_cleanup, "delete")), equal(integration_file_count, "1")), "Another Task file exists; stop before deleting the test Task.");
byte[] integration_download_response = request_download("download", map("id", integration_attachment_id));
save_checked_download(integration_download_response, integration_file, integration_output_path);
}
if (equal(integration_cleanup, "delete")) {
if (not_value(journal_acknowledged(integration_job, "remove_file"))) {
journal_begin(integration_job, "remove_file", "DELETE", "/v1/tasks/attachments", journal_fingerprint(map("id", integration_attachment_id)));
Result integration_file_remove_response = call("remove_file", map("id", integration_attachment_id), null, null);
require_condition(equal(response_status(integration_file_remove_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
journal_acknowledge(integration_job, "remove_file", map("task_id", integration_task_id, "attachment_id", integration_attachment_id));
}
if (not_value(journal_acknowledged(integration_job, "remove_task"))) {
journal_begin(integration_job, "remove_task", "DELETE", "/v1/tasks", journal_fingerprint(map("id", integration_task_id)));
Result integration_task_remove_response = call("remove_task", map("id", integration_task_id), null, null);
require_condition(equal(response_status(integration_task_remove_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.");
journal_acknowledge(integration_job, "remove_task", map("task_id", integration_task_id));
}
} else {
print_value(map("task_id", integration_task_id, "attachment_id", integration_attachment_id, "cleanup", "kept"));
}
}
if (journal_acknowledged(integration_job, "remove_task")) {
Object integration_removed = journal_saved(integration_job, "remove_task");
integration_task_id = positive_id(text(field(integration_removed, "task_id")));
String integration_missing_status = request_expect("verify_removed", map("id", integration_task_id), null, null, "404");
print_value(map("task_id", integration_task_id, "cleanup", "removed", "observed_missing_status", integration_missing_status));
}
}
}
public static void main(String[] args)throws Exception {run();}
}
<?php
// PHP 8.1+ with the cURL extension. Set EXHIBITDAY_API_KEY before running.
declare(strict_types=1);
const BASE = 'https://api.exhibitday.com/v1';
const SPEC = '{"preserveNumbers":true,"requests":{"workspace_binding":{"method":"GET","path":"/references/workspace_info"},"create":{"method":"POST","path":"/tasks"},"read":{"method":"GET","path":"/tasks/info"},"edit":{"method":"PATCH","path":"/tasks"},"stale":{"method":"PATCH","path":"/tasks"},"after_edit":{"method":"GET","path":"/tasks/info"},"upload":{"method":"POST","path":"/tasks/attachments","file":{"name":"file","maximum_bytes":"26214400","extensions":["png","jpg","jpeg","bmp","gif","pdf","msg","eml","doc","docx","ppt","pptx","xls","xlsx","csv","rtf","odp","odt","ods","txt","wks","zip"],"content_types":[]}},"verify_file":{"method":"GET","path":"/tasks/attachments"},"download":{"method":"GET","path":"/tasks/attachments/download","binary":true},"remove_file":{"method":"DELETE","path":"/tasks/attachments"},"remove_task":{"method":"DELETE","path":"/tasks"},"verify_removed":{"method":"GET","path":"/tasks/info"}}}';
$spec = json_decode(SPEC, true, 512, JSON_THROW_ON_ERROR);
$apiKey = required('EXHIBITDAY_API_KEY');
if(preg_match('/[^\x20-\x7e]/',$apiKey))throw new RuntimeException('Use the API key as one ASCII header value without control characters');
if (trim($apiKey) === '') throw new RuntimeException('Set EXHIBITDAY_API_KEY');
function required(string $name, bool $allowEmpty = false): string {
$value = getenv($name);
if ($value === false || (!$allowEmpty && $value === '')) {
throw new RuntimeException('Set ' . $name);
}
return $value;
}
function optional(string $name, string $fallback): string {
$value = getenv($name);
return $value === false ? $fallback : $value;
}
function decodeJson(string $text): mixed {
global $spec;
if ($spec['preserveNumbers']) {
// Quote NUMBER tokens without changing digits inside JSON strings; CSV decimals stay exact.
$pattern = <<<'JSON_NUMBER'
~"(?:\\.|[^"\\])*"|-?\d+(?:\.\d+)?(?:[eE][+-]?\d+)?~
JSON_NUMBER;
$text = preg_replace_callback($pattern, static function (array $match): string {
return str_starts_with($match[0], '"') ? $match[0] : json_encode($match[0], JSON_THROW_ON_ERROR);
}, $text);
if ($text === null) throw new RuntimeException('Unable to preserve decimal tokens');
}
return json_decode($text, true, 512, JSON_THROW_ON_ERROR);
}
function nativeTransport(string $method, string $url, array $headers, ?string $data): array {
$responseHeaders = [];
$handle = curl_init($url);
if ($handle === false) throw new RuntimeException('Unable to initialize cURL');
$headerLines = [];
foreach ($headers as $name => $value) $headerLines[] = $name . ': ' . $value;
$options = [CURLOPT_CUSTOMREQUEST => $method, CURLOPT_RETURNTRANSFER => true, CURLOPT_FOLLOWLOCATION => false,
CURLOPT_CONNECTTIMEOUT => 30, CURLOPT_TIMEOUT => 30, CURLOPT_HTTPHEADER => $headerLines,
CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
if (str_starts_with($line, 'HTTP/')) $responseHeaders = [];
$separator = strpos($line, ':');
if ($separator !== false) {
$responseHeaders[strtolower(trim(substr($line, 0, $separator)))] = trim(substr($line, $separator + 1));
}
return strlen($line);
}];
if ($data !== null) $options[CURLOPT_POSTFIELDS] = $data;
try {
curl_setopt_array($handle, $options);
$raw = curl_exec($handle);
if ($raw === false) throw new RuntimeException('Network request failed: ' . curl_error($handle));
return [(int)curl_getinfo($handle, CURLINFO_RESPONSE_CODE), $raw, $responseHeaders];
} finally {
curl_close($handle);
}
}
function retryDelay(array $headers, int $attempt): float {
$value = $headers['retry-after'] ?? '';
if (is_numeric($value)) return max(0.0, (float)$value);
$date = $value === '' ? false : strtotime($value);
return $date === false ? (float)(2 ** $attempt) : max(0.0, (float)($date - time()));
}
// An API error response. Branch on errorCode (and status), never on the message text.
// $uncertain is true when a PATCH or DELETE got no response or a server error: it may or may not have been applied.
final class ApiException extends RuntimeException {
public function __construct(public readonly int $status, public readonly ?string $errorCode, string $message, public readonly bool $uncertain = false) {
parent::__construct($message);
}
}
function call(string $name, array $params = [], mixed $body = null, ?string $key = null): array {
global $spec, $apiKey, $transport;
$route = $spec['requests'][$name];
$headers = ['Authorization' => 'Bearer ' . $apiKey, 'Accept' => 'application/json'];
if ($route['method'] === 'POST') {
if ($key === null || $key === '') throw new RuntimeException('Save a create key before sending POST');
$headers['Idempotency-Key'] = $key; // ONCE, before retries.
}
$data = $body === null ? null : json_encode($body, JSON_THROW_ON_ERROR);
if ($data !== null) $headers['Content-Type'] = 'application/json';
$query = http_build_query($params, '', '&', PHP_QUERY_RFC3986);
$url = BASE . $route['path'] . ($query === '' ? '' : '?' . $query);
// Only GET has automatic retries in this workflow. A PATCH or DELETE that got no response or a
// server error is never resent blindly: it may already have been applied, so the caller reads the record first.
$resend = $route['method'] === 'GET';
for ($attempt = 0; $attempt < 5; $attempt++) {
try {
[$status, $raw, $responseHeaders] = $transport($route['method'], $url, $headers, $data);
} catch (RuntimeException $error) {
if (!$resend) throw new ApiException(0, null, 'No response', true);
if ($attempt === 4) throw $error;
usleep((int)((2 ** $attempt) * 1000000));
continue;
}
$responseHeaders = array_change_key_case($responseHeaders, CASE_LOWER);
$result = null;
if ($status !== 304 && $raw !== '') {
try { $result = decodeJson($raw); }
catch (JsonException $error) {
if ($status < 400) throw new RuntimeException('Expected a JSON success response', 0, $error);
}
}
if ($status >= 500 && !$resend) {
throw new ApiException($status, is_array($result) && isset($result['error_code']) ? (string)$result['error_code'] : null, 'HTTP ' . $status, true);
}
$retry = $resend && ($status === 429 || $status >= 500);
if ($retry) {
if ($attempt === 4) throw new RuntimeException('Retry limit reached; check the outcome before starting a new create');
usleep((int)(retryDelay($responseHeaders, $attempt) * 1000000));
continue;
}
if ($status >= 400) {
if (!is_array($result)) throw new ApiException($status, null, 'HTTP ' . $status);
throw new ApiException($status, isset($result['error_code']) ? (string)$result['error_code'] : null, json_encode(['error_code' => $result['error_code'] ?? null,
'error_params' => $result['error_params'] ?? null, 'errors' => $result['errors'] ?? null,
'request_id' => $result['request_id'] ?? null], JSON_THROW_ON_ERROR));
}
return ['status' => $status, 'body' => $result, 'headers' => $responseHeaders, 'raw' => $raw];
}
throw new RuntimeException('Retry limit reached');
}
$transport = Closure::fromCallable('nativeTransport');
function add_offset(string $offset,int $received):string{$result=(int)$offset+$received;if($received<=0||$result>2147483647)throw new RuntimeException("Cannot advance this int32 offset; reconcile the query");return (string)$result;}
function both(bool $left,bool $right):bool{return $left&&$right;}
function concat(string $left,string $right):string{return $left.$right;}
function deep_equal(mixed $left,mixed $right):bool {
if(is_object($left))$left=get_object_vars($left);if(is_object($right))$right=get_object_vars($right);
if(gettype($left)!==gettype($right))return false;
if(!is_array($left))return$left===$right;
if(array_is_list($left)!==array_is_list($right)||count($left)!==count($right))return false;
foreach($left as$key=>$value)if(!array_key_exists($key,$right)||!deep_equal($value,$right[$key]))return false;
return true;
}
function either(bool $left,bool $right):bool{return $left||$right;}
function equal(mixed $left,mixed $right):bool{return $left===$right;}
function field(mixed $value,string $name):mixed{if(!is_array($value)||!array_key_exists($name,$value))throw new RuntimeException("Missing response field: ".$name);return $value[$name];}
function file_length(array $value):string{return (string)strlen($value['data']);}
function file_name(array $value):string{return $value['name'];}
function file_sha256(array $value):string{return $value['sha256'];}
function items(mixed $value):array{if(!is_array($value)||!array_is_list($value))throw new RuntimeException("Expected a JSON array");return $value;}
function is_empty(mixed $value):bool{return count(items($value))===0;}
function is_present(?string $value):bool{return $value!==null&&$value!=="";}
final class JournalRefusal extends RuntimeException {}
final class JournalProtocol
{
public const PREAMBLE="EXHIBITDAY-GUIDE-JOURNAL 1\n";
public static function utf8(mixed $value):string
{if(!is_string($value)||preg_match('//u',$value)!==1)throw new JournalRefusal('Journal fields must be exact valid UTF8 strings');return$value;}
public static function strings(array $values):string
{$raw='';foreach($values as$value){$item=self::utf8($value);$raw.=strlen($item).':'.$item;}return$raw;}
private static function length(string $text,int $remaining):int
{if(!preg_match('/\A(?:0|[1-9][0-9]*)\z/',$text))throw new JournalRefusal('Noncanonical string length');$maximum=(string)$remaining;if(strlen($text)>strlen($maximum)||(strlen($text)===strlen($maximum)&&strcmp($text,$maximum)>0))throw new JournalRefusal('Incomplete journal string/frame');return(int)$text;}
public static function readStrings(string $raw):array
{$values=[];$offset=0;while($offset<strlen($raw)){$end=strpos($raw,':',$offset);if($end===false)throw new JournalRefusal('Incomplete string length');$text=substr($raw,$offset,$end-$offset);$offset=$end+1;$size=self::length($text,strlen($raw)-$offset);$values[]=self::utf8(substr($raw,$offset,$size));$offset+=$size;}return$values;}
public static function digest(string $raw):string{return strtoupper(hash('sha256',$raw));}
public static function fingerprint(array $pairs):string
{$names=array_keys($pairs);sort($names,SORT_STRING);$values=[];foreach($names as$name){if(!is_string($name)||!preg_match('/\A[A-Za-z0-9_.-]+\z/',$name)||in_array(strtolower($name),['api_key','exhibitday_api_key'],true))throw new JournalRefusal('Use explicit secret-free fingerprint names');$values[]=$name;$values[]=$pairs[$name];}return self::digest(self::strings($values));}
public static function frame(array $values):string
{$payload=self::strings($values);return strlen($payload).' '.self::digest($payload)."\n".$payload."\n";}
public static function decode(string $raw):array
{if(!str_starts_with($raw,self::PREAMBLE))throw new JournalRefusal('Unknown or incomplete journal version');$offset=strlen(self::PREAMBLE);$records=[];
while($offset<strlen($raw)){$end=strpos($raw,"\n",$offset);if($end===false)throw new JournalRefusal('Incomplete frame header; reconcile before retry');$header=substr($raw,$offset,$end-$offset);if(!preg_match('/\A(0|[1-9][0-9]*) ([0-9A-F]{64})\z/',$header,$match))throw new JournalRefusal('Invalid frame header');$offset=$end+1;$size=self::length($match[1],strlen($raw)-$offset);if($size>=strlen($raw)-$offset)throw new JournalRefusal('Incomplete frame; reconcile before retry');$payload=substr($raw,$offset,$size);$offset+=$size;if($raw[$offset]!=="\n"||self::digest($payload)!==$match[2])throw new JournalRefusal('Journal integrity failed; reconcile before retry');$records[]=self::readStrings($payload);$offset++;}return$records;}
public static function writeAll($file,string $raw):void
{$offset=0;while($offset<strlen($raw)){$count=fwrite($file,substr($raw,$offset));if($count===false||$count===0)throw new RuntimeException('Journal write did not advance');$offset+=$count;}if(!fflush($file)||!fsync($file))throw new RuntimeException('Journal flush failed; stop and reconcile');}
public static function createPrivate(string $path)
{$mask=umask(0077);try{$file=@fopen($path,'x+b');}finally{umask($mask);}if($file===false)throw new JournalRefusal('Cannot create private journal/lock; check path and do not steal an existing lock');return$file;}
}
final class GuideJournal
{
private string $path,$lockPath,$owner;private array $header,$allowed=[],$intents=[],$savedValues=[],$identity=[];
private $file=null;private bool $owned=false,$tainted=false;
public function __construct(string $path,string $base,string $workspace,string $slug,string $job,string $inputFingerprint,array $writes,string $mode='resume')
{
if(!function_exists('fsync'))throw new JournalRefusal('This runtime must provide native fsync; no permissive fallback');
$this->path=$path;$this->lockPath=$path.'.lock';$this->owner=bin2hex(random_bytes(16));$address=parse_url($base);
if($address===false||!in_array($address['scheme']??null,['https','http'],true)||!isset($address['host'])||isset($address['user'])||isset($address['pass'])||isset($address['query'])||isset($address['fragment'])||!preg_match('/\A[a-z][a-z0-9-]*\z/',$slug))throw new JournalRefusal('Use actual API base and closed guide slug');
if(trim($job)===''||!preg_match('/\A[1-9][0-9]*\z/',$workspace)||!preg_match('/\A[0-9A-F]{64}\z/',$inputFingerprint))throw new JournalRefusal('Use actual workspace, stable explicit job ID and exact fingerprint');
if(!in_array($mode,['new','resume'],true))throw new JournalRefusal('Choose new or resume for this local job');
$manifest=[];foreach($writes as$write){if(!is_array($write)||!array_is_list($write)||count($write)!==3)throw new JournalRefusal('Invalid write manifest');[$step,$method,$route]=$write;
if(!is_string($step)||!preg_match('/\A[a-z][a-z0-9_-]*\z/',$step)||isset($this->allowed[$step])||!in_array($method,['POST','PATCH','DELETE'],true)||!is_string($route)||!preg_match('~\A/v1/[A-Za-z0-9_/-]+\z~',$route)||str_contains($route,'//'))throw new JournalRefusal('Use a closed unique write manifest');$this->allowed[$step]=[$method,$route];array_push($manifest,$step,$method,$route);}
if($this->allowed===[])throw new JournalRefusal('Only write workflows need restart journal');$this->header=['H','1',$base,$workspace,$slug,$job,$inputFingerprint,JournalProtocol::digest(JournalProtocol::strings($manifest))];JournalProtocol::strings($this->header);
$this->file=JournalProtocol::createPrivate($this->lockPath);$this->owned=true;
try{
JournalProtocol::writeAll($this->file,$this->owner);$identity=fstat($this->file);if($identity===false)throw new JournalRefusal('Cannot bind acquired lock identity');$this->identity=$identity;
clearstatcache(true,$path);if(is_link($path))throw new JournalRefusal('Choose private regular journal file');
$exists=file_exists($path);if($mode==='resume'&&!$exists)throw new JournalRefusal('Journal missing: stop and reconcile lost state before starting a new job');if($mode==='new'&&$exists)throw new JournalRefusal('Journal exists; use resume for the same job');
if($mode==='new'){$target=JournalProtocol::createPrivate($path);try{JournalProtocol::writeAll($target,JournalProtocol::PREAMBLE.JournalProtocol::frame($this->header));}finally{fclose($target);}}
$raw=file_get_contents($path);if($raw===false)throw new JournalRefusal('Cannot read journal');$records=JournalProtocol::decode($raw);if($records===[]||$records[0]!==$this->header)throw new JournalRefusal('Journal workspace/base/guide/job/input binding differs');foreach(array_slice($records,1)as$record)$this->apply($record);
if(array_diff(array_keys($this->intents),array_keys($this->savedValues))!==[])throw new JournalRefusal('Saved intent lacks ACK; stop and reconcile before retry');
}catch(Throwable $error){$this->close();throw$error;}
}
private function apply(array $record):void
{
if(($record[0]??null)==='I'){
if(count($record)!==6)throw new JournalRefusal('Invalid intent shape');[,$step,$method,$route,$fingerprint,$key]=$record;
if(!preg_match('/\A[a-z][a-z0-9_-]*\z/',$step)||isset($this->intents[$step])||($this->allowed[$step]??null)!==[$method,$route]||!preg_match('/\A[0-9A-F]{64}\z/',$fingerprint)||array_diff(array_keys($this->intents),array_keys($this->savedValues))!==[])throw new JournalRefusal('Invalid, future or repeated intent');
if(($method==='POST'&&!preg_match('/\A[0-9a-f]{32}\z/',$key))||($method!=='POST'&&$key!==''))throw new JournalRefusal('Invalid persisted action key');$this->intents[$step]=['method'=>$method,'path'=>$route,'request_fingerprint'=>$fingerprint,'idempotency_key'=>$key];
}elseif(($record[0]??null)==='A'){
if(count($record)<3)throw new JournalRefusal('Invalid ACK shape');[,$step,$count]=$record;$pairs=array_slice($record,3);
if(!preg_match('/\A(?:0|[1-9][0-9]*)\z/',$count)||(string)intdiv(count($pairs),2)!==$count||count($pairs)%2!==0||!isset($this->intents[$step])||isset($this->savedValues[$step]))throw new JournalRefusal('ACK without exactly one prior intent');
$names=[];for($i=0;$i<count($pairs);$i+=2)$names[]=$pairs[$i];$unique=array_values(array_unique($names,SORT_STRING));sort($unique,SORT_STRING);
if($names!==$unique)throw new JournalRefusal('ACK fields must be unique sorted names');$saved=[];foreach($names as$i=>$name){if(!preg_match('/\A[a-z][a-z0-9_]*\z/',$name)||in_array($name,['api_key','exhibitday_api_key'],true))throw new JournalRefusal('Use secret-free ACK field names');$saved[$name]=$pairs[$i*2+1];}$this->savedValues[$step]=$saved;
}else throw new JournalRefusal('Unknown journal transition');
}
private function requireActive():void
{
if(!$this->owned||$this->file===null||$this->tainted)throw new JournalRefusal('Journal closed or IO outcome needs reconciliation');clearstatcache(true,$this->lockPath);$current=@lstat($this->lockPath);$token=@file_get_contents($this->lockPath);
if($current===false||($current['dev']??null)!==($this->identity['dev']??null)||($current['ino']??null)!==($this->identity['ino']??null)||$token!==$this->owner)throw new JournalRefusal('Journal lock replaced; stop without deleting it');
}
private function append(array $record):void
{
$this->requireActive();$raw=JournalProtocol::frame($record);$target=null;
try{$target=@fopen($this->path,'ab');if($target===false)throw new JournalRefusal('Cannot append journal; stop and reconcile');JournalProtocol::writeAll($target,$raw);}catch(Throwable $error){$this->tainted=true;throw$error;}finally{if(is_resource($target))fclose($target);}
}
public function acknowledged(string $step):bool{$this->requireActive();return isset($this->savedValues[$step]);}
public function saved(string $step):array{$this->requireActive();if(!isset($this->savedValues[$step]))throw new JournalRefusal('No confirmed state exists');return$this->savedValues[$step];}
public function beginAction(string $step,string $method,string $route,string $requestFingerprint):array
{
$this->requireActive();if(isset($this->intents[$step]))throw new JournalRefusal('Never blindly repeat an existing action');$key=$method==='POST'?bin2hex(random_bytes(16)):'';$record=['I',$step,$method,$route,$requestFingerprint,$key];$previous=$this->intents;try{$this->apply($record);}finally{$this->intents=$previous;}$this->append($record);$this->apply($record);return$this->intents[$step];
}
public function acknowledge(string $step,array $saved):void
{
$this->requireActive();$record=['A',$step,(string)count($saved)];$names=array_keys($saved);sort($names,SORT_STRING);foreach($names as$name){$record[]=$name;$record[]=$saved[$name];}$previous=$this->savedValues;try{$this->apply($record);JournalProtocol::strings($record);}finally{$this->savedValues=$previous;}$this->append($record);$this->apply($record);
}
public function close():void
{
if(!$this->owned)return;if($this->tainted){fclose($this->file);$this->file=null;$this->owned=false;return;}
try{$this->requireActive();}catch(Throwable $error){fclose($this->file);$this->file=null;$this->owned=false;throw$error;}fclose($this->file);$this->file=null;$this->owned=false;if(!unlink($this->lockPath))throw new JournalRefusal('Could not release owned journal lock');
}
}
function journal_values(mixed $value):array{if(!is_object($value))throw new JournalRefusal('Saved/fingerprint values need an explicit object');$result=get_object_vars($value);foreach($result as$name=>$item)if(!is_string($name)||!is_string($item))throw new JournalRefusal('Saved/fingerprint values must be exact strings');return$result;}
function journal_acknowledge(GuideJournal $job,string $step,mixed $saved):void{$job->acknowledge($step,journal_values($saved));}
function journal_acknowledged(GuideJournal $job,string $step):bool{return $job->acknowledged($step);}
function journal_begin(GuideJournal $job,string $step,string $method,string $path,string $requestFingerprint):array{return $job->beginAction($step,$method,$path,$requestFingerprint);}
function journal_fingerprint(mixed $value):string{return JournalProtocol::fingerprint(journal_values($value));}
function journal_saved(GuideJournal $job,string $step):array{return $job->saved($step);}
function json_string(mixed $value):string{return json_encode($value,JSON_THROW_ON_ERROR|JSON_UNESCAPED_UNICODE|JSON_UNESCAPED_SLASHES);}
function new_id_set():array{return [];}
function not_value(bool $value):bool{return !$value;}
function open_journal(string $path,string $base,string $workspace,string $slug,string $job,string $inputFingerprint,array $writes,string $mode):GuideJournal{return new GuideJournal($path,$base,$workspace,$slug,$job,$inputFingerprint,$writes,$mode);}
function parse_json(string $value):mixed{return json_decode($value,true,512,JSON_THROW_ON_ERROR);}
function positive_id(string $value):string{if(!preg_match("/^[1-9][0-9]*$/D",$value)||strlen($value)>19||(strlen($value)===19&&strcmp($value,"9223372036854775807")>0))throw new RuntimeException("Use a positive record ID");return $value;}
function print_value(mixed $value):void{echo (is_string($value)?$value:json_encode($value,JSON_THROW_ON_ERROR))."\n";}
function read_file_snapshot(string $path,string $action): array {
global $spec;$rule=$spec['requests'][$action]['file']??null;
if(!is_array($rule)||$rule['name']!=='file')throw new RuntimeException('Use the current declared file input');
$data=@file_get_contents($path);if($data===false)throw new RuntimeException('Unable to read selected file');
if(strlen($data)===0||strlen($data)>(int)$rule['maximum_bytes'])throw new RuntimeException('The selected file is empty or exceeds this endpoint file limit');
$name=basename($path);if($name===''||strpbrk($name,"\r\n\0")!==false)throw new RuntimeException('Use a filename without header control characters');
return ['name'=>$name,'data'=>$data,'sha256'=>hash('sha256',$data)];
}
function remember_id(array &$seen,string $value):bool{if(array_key_exists($value,$seen))return false;$seen[$value]=true;return true;}
function request_download(string $name,array $params):string {
global $spec,$apiKey,$transport;$route=$spec['requests'][$name];
if($route['method']!=='GET'||($route['binary']??false)!==true)throw new RuntimeException('Bind the declared binary GET');
$query=http_build_query($params,'','&',PHP_QUERY_RFC3986);
[$status,$raw,$headers]=$transport('GET',BASE.$route['path'].($query===''?'':'?'.$query),['Authorization'=>'Bearer '.$apiKey,'Accept'=>'application/octet-stream'],null);
if($status!==200){$body=null;try{$body=decodeJson($raw);}catch(JsonException $error){}throw new ApiException($status,is_array($body)?($body['error_code']??null):null,'HTTP '.$status);}
return $raw;
}
function request_expect(string $name,array $query,mixed $body,?string $key,string $expected):string {
try { call($name,$query,$body,$key); }
catch(ApiException $observed) { if($observed->uncertain||(string)$observed->status!==$expected)throw $observed;return(string)$observed->status; }
throw new RuntimeException("Expected HTTP ".$expected." refusal; request unexpectedly succeeded");
}
function request_upload(string $name,array $params,array $file,string $key):array {
global $spec,$apiKey,$transport;$route=$spec['requests'][$name];
if($route['method']!=='POST'||!isset($route['file'])||$key==='')throw new RuntimeException('Bind one declared upload and its persisted create key');
do{$boundary='ExhibitDayGuide'.bin2hex(random_bytes(24));}while(str_contains($file['data'],$boundary));
$quoted=str_replace(['\\','"'],['\\\\','\\"'],$file['name']);
$data='--'.$boundary."\r\nContent-Disposition: form-data; name=\"file\"; filename=\"".$quoted."\"\r\nContent-Type: application/octet-stream\r\n\r\n".$file['data']."\r\n--".$boundary."--\r\n";
$headers=['Authorization'=>'Bearer '.$apiKey,'Accept'=>'application/json','Idempotency-Key'=>$key,'Content-Type'=>'multipart/form-data; boundary='.$boundary];
$query=http_build_query($params,'','&',PHP_QUERY_RFC3986);$url=BASE.$route['path'].($query===''?'':'?'.$query);
try{[$status,$raw,$headers]=$transport('POST',$url,$headers,$data);}catch(RuntimeException $error){throw new ApiException(0,null,'No response',true);}
$body=null;try{$body=decodeJson($raw);}catch(JsonException $error){}
if($status!==200)throw new ApiException($status,is_array($body)?($body['error_code']??null):null,'HTTP '.$status,$status>=500);
if(!is_array($body)||array_is_list($body))throw new RuntimeException('Upload returned no usable JSON receipt; reconcile before retrying');
return ['status'=>$status,'body'=>$body,'headers'=>array_change_key_case($headers,CASE_LOWER),'raw'=>$raw];
}
function require_condition(bool $value,string $message):void{if(!$value)throw new RuntimeException($message);}
function response_status(array $value):string{return(string)$value["status"];}
function save_checked_download(string $data,array $file,string $path):void {
if(strlen($data)!==strlen($file['data'])||hash('sha256',$data)!==$file['sha256'])throw new RuntimeException('Downloaded bytes differ; no output was created');
$output=@fopen($path,'x+b');if($output===false)throw new RuntimeException('Choose a new output file; existing files are never overwritten');
try{if(!chmod($path,0600))throw new RuntimeException('Unable to restrict output permissions');$offset=0;while($offset<strlen($data)){$count=fwrite($output,substr($data,$offset));if($count===false||$count===0)throw new RuntimeException('Output write stopped');$offset+=$count;}if(!fflush($output)||!fsync($output))throw new RuntimeException('Unable to flush output');}finally{fclose($output);}
}
function single(mixed $value):mixed{$rows=items($value);if(count($rows)!==1)throw new RuntimeException('Expected exactly one selected record');return$rows[0];}
function text(mixed $value):string{if($value===null)return "";if(is_string($value))return $value;if(is_bool($value))return $value?"true":"false";if(is_int($value))return (string)$value;throw new RuntimeException("Expected a scalar response value");}
function main():void {
$integration_event_id = positive_id(required('EXHIBITDAY_EVENT_ID'));
$integration_job_id = required('EXHIBITDAY_JOB_ID');
$integration_job_hash = journal_fingerprint((object)['job_id' => $integration_job_id]);
$integration_initial_name = concat('API integration check ', $integration_job_hash);
$integration_updated_name = concat($integration_initial_name, ' updated');
$integration_file = read_file_snapshot(required('EXHIBITDAY_FILE'), 'upload');
$integration_output_path = required('EXHIBITDAY_DOWNLOAD_PATH');
$integration_cleanup = optional('EXHIBITDAY_TEST_CLEANUP', 'keep');
require_condition(either(equal($integration_cleanup, 'keep'), equal($integration_cleanup, 'delete')), 'Use keep or delete for EXHIBITDAY_TEST_CLEANUP.');
$integration_workspace_response = call('workspace_binding', [], null, null);
require_condition(equal(response_status($integration_workspace_response), '200'), 'Expected the documented HTTP 200 response; stop and review any other outcome.');
$integration_workspace = $integration_workspace_response["body"];
$integration_workspace_id = positive_id(text(field($integration_workspace, 'id')));
$integration_state_path = required('EXHIBITDAY_TEST_STATE');
$integration_job_mode = optional('EXHIBITDAY_JOB_MODE', 'resume');
$integration_job = open_journal($integration_state_path, 'https://api.exhibitday.com/v1', $integration_workspace_id, 'integration-testing', $integration_job_id, journal_fingerprint((object)['workflow_contract_sha256' => '3808BE3DE866226BE6AAA4C445EBC19FC7903FD96FC8DC2F223F6D6451BA6267', 'event_id' => $integration_event_id, 'initial_name' => $integration_initial_name, 'updated_name' => $integration_updated_name, 'filename' => file_name($integration_file), 'file_length' => file_length($integration_file), 'file_sha256' => file_sha256($integration_file)]), [['create', 'POST', '/v1/tasks'], ['edit', 'PATCH', '/v1/tasks'], ['stale', 'PATCH', '/v1/tasks'], ['upload', 'POST', '/v1/tasks/attachments'], ['remove_file', 'DELETE', '/v1/tasks/attachments'], ['remove_task', 'DELETE', '/v1/tasks']], $integration_job_mode);
try {
$integration_task_id = '';
$integration_attachment_id = '';
if (not_value(journal_acknowledged($integration_job, 'remove_task'))) {
if (not_value(journal_acknowledged($integration_job, 'create'))) {
$integration_create_intent = journal_begin($integration_job, 'create', 'POST', '/v1/tasks', journal_fingerprint((object)['event_id' => $integration_event_id, 'name' => $integration_initial_name]));
$integration_created_response = call('create', [], (object)['event_id' => $integration_event_id, 'name' => $integration_initial_name], text(field($integration_create_intent, 'idempotency_key')));
require_condition(equal(response_status($integration_created_response), '200'), 'Expected the documented HTTP 200 response; stop and review any other outcome.');
$integration_created = $integration_created_response["body"];
$integration_task_id = positive_id(text(field($integration_created, 'id')));
require_condition(both(equal(text(field($integration_created, 'id')), $integration_task_id), both(equal(text(field(field($integration_created, 'event'), 'id')), $integration_event_id), equal(text(field($integration_created, 'name')), $integration_initial_name))), 'The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.');
journal_acknowledge($integration_job, 'create', (object)['task_id' => $integration_task_id, 'event_id' => $integration_event_id, 'name' => $integration_initial_name, 'create_key' => text(field($integration_create_intent, 'idempotency_key'))]);
}
$integration_saved_create = journal_saved($integration_job, 'create');
$integration_task_id = positive_id(text(field($integration_saved_create, 'task_id')));
require_condition(both(equal(text(field($integration_saved_create, 'event_id')), $integration_event_id), equal(text(field($integration_saved_create, 'name')), $integration_initial_name)), 'Saved create state differs from this Event/job.');
require_condition(either(not_value(journal_acknowledged($integration_job, 'remove_file')), equal($integration_cleanup, 'delete')), 'Cleanup already removed the test file. Continue with EXHIBITDAY_TEST_CLEANUP=delete to finish this Task cleanup.');
$integration_before_response = call('read', ['id' => $integration_task_id, '$include_record_revision' => 'true'], null, null);
require_condition(equal(response_status($integration_before_response), '200'), 'Expected the documented HTTP 200 response; stop and review any other outcome.');
$integration_before = $integration_before_response["body"];
if (not_value(journal_acknowledged($integration_job, 'edit'))) {
require_condition(both(equal(text(field($integration_before, 'id')), $integration_task_id), both(equal(text(field(field($integration_before, 'event'), 'id')), $integration_event_id), equal(text(field($integration_before, 'name')), $integration_initial_name))), 'The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.');
$integration_original_revision = text(field($integration_before, 'record_revision'));
require_condition(is_present($integration_original_revision), 'Read the actual created Task revision before editing.');
journal_begin($integration_job, 'edit', 'PATCH', '/v1/tasks', journal_fingerprint((object)['id' => $integration_task_id, 'name' => $integration_updated_name, 'expected_revision' => $integration_original_revision]));
$integration_edit_response = call('edit', [], (object)['id' => $integration_task_id, 'name' => $integration_updated_name, 'expected_revision' => $integration_original_revision], null);
require_condition(equal(response_status($integration_edit_response), '200'), 'Expected the documented HTTP 200 response; stop and review any other outcome.');
$integration_edit_receipt = $integration_edit_response["body"];
$integration_saved_revision = text(field($integration_edit_receipt, 'record_revision'));
require_condition(both(is_present($integration_saved_revision), not_value(equal($integration_original_revision, $integration_saved_revision))), 'The distinct test name must produce a checked new revision before the stale test.');
journal_acknowledge($integration_job, 'edit', (object)['task_id' => $integration_task_id, 'name' => $integration_updated_name, 'original_revision' => $integration_original_revision, 'record_revision' => $integration_saved_revision]);
}
$integration_saved_edit = journal_saved($integration_job, 'edit');
require_condition(both(equal(text(field($integration_saved_edit, 'task_id')), $integration_task_id), equal(text(field($integration_saved_edit, 'name')), $integration_updated_name)), 'Saved edit state differs from this Task/name.');
if (not_value(journal_acknowledged($integration_job, 'stale'))) {
journal_begin($integration_job, 'stale', 'PATCH', '/v1/tasks', journal_fingerprint((object)['id' => $integration_task_id, 'name' => 'Refused stale test', 'expected_revision' => text(field($integration_saved_edit, 'original_revision'))]));
$integration_stale_status = request_expect('stale', [], (object)['id' => $integration_task_id, 'name' => 'Refused stale test', 'expected_revision' => text(field($integration_saved_edit, 'original_revision'))], null, '409');
journal_acknowledge($integration_job, 'stale', (object)['task_id' => $integration_task_id, 'observed_status' => $integration_stale_status]);
}
$integration_saved_stale = journal_saved($integration_job, 'stale');
require_condition(both(equal(text(field($integration_saved_stale, 'task_id')), $integration_task_id), equal(text(field($integration_saved_stale, 'observed_status')), '409')), 'The saved conflict assertion differs from this Task/status.');
$integration_after_edit_response = call('after_edit', ['id' => $integration_task_id, '$include_record_revision' => 'true'], null, null);
require_condition(equal(response_status($integration_after_edit_response), '200'), 'Expected the documented HTTP 200 response; stop and review any other outcome.');
$integration_after_edit = $integration_after_edit_response["body"];
require_condition(both(equal(text(field($integration_after_edit, 'id')), $integration_task_id), both(equal(text(field(field($integration_after_edit, 'event'), 'id')), $integration_event_id), equal(text(field($integration_after_edit, 'name')), $integration_updated_name))), 'The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.');
require_condition(equal(text(field($integration_after_edit, 'record_revision')), text(field($integration_saved_edit, 'record_revision'))), 'The test Task\'s revision changed; stop before file work or cleanup.');
require_condition(either(not_value(equal($integration_cleanup, 'delete')), deep_equal(field($integration_after_edit, 'comments'), [])), 'The test Task has comments; stop before cleanup.');
if (not_value(journal_acknowledged($integration_job, 'upload'))) {
require_condition(equal(text(field($integration_after_edit, 'record_revision')), text(field($integration_saved_edit, 'record_revision'))), 'The Task changed after the conditional edit. Review it before uploading.');
$integration_upload_intent = journal_begin($integration_job, 'upload', 'POST', '/v1/tasks/attachments', journal_fingerprint((object)['task_id' => $integration_task_id, 'filename' => file_name($integration_file), 'file_length' => file_length($integration_file), 'file_sha256' => file_sha256($integration_file)]));
$integration_upload_response = request_upload('upload', ['task_id' => $integration_task_id], $integration_file, text(field($integration_upload_intent, 'idempotency_key')));
require_condition(equal(response_status($integration_upload_response), '200'), 'Expected the documented HTTP 200 response; stop and review any other outcome.');
$integration_upload = $integration_upload_response["body"];
require_condition(both(equal(text(field($integration_upload, 'records_found')), '1'), both(equal(text(field($integration_upload, 'total_records')), '1'), equal(field($integration_upload, 'has_more'), false))), 'Require exactly one complete uploaded-file receipt.');
$integration_uploaded_file = single(field($integration_upload, 'list_data'));
$integration_attachment_id = positive_id(text(field($integration_uploaded_file, 'id')));
require_condition(is_present(text(field($integration_uploaded_file, 'filename'))), 'The upload receipt needs its actual stored filename.');
journal_acknowledge($integration_job, 'upload', (object)['task_id' => $integration_task_id, 'attachment_id' => $integration_attachment_id, 'filename' => text(field($integration_uploaded_file, 'filename')), 'attachment_json' => json_string($integration_uploaded_file), 'file_length' => file_length($integration_file), 'file_sha256' => file_sha256($integration_file)]);
}
$integration_saved_upload = journal_saved($integration_job, 'upload');
$integration_attachment_id = positive_id(text(field($integration_saved_upload, 'attachment_id')));
require_condition(both(equal(text(field($integration_saved_upload, 'task_id')), $integration_task_id), both(equal(text(field($integration_saved_upload, 'file_length')), file_length($integration_file)), equal(text(field($integration_saved_upload, 'file_sha256')), file_sha256($integration_file)))), 'The confirmed file differs from the saved test Task or file details.');
if (not_value(journal_acknowledged($integration_job, 'remove_file'))) {
$integration_list_offset = '0';
$integration_file_count = '0';
$integration_file_found = false;
$integration_file_seen = new_id_set();
$integration_list_query = ['task_id' => $integration_task_id, '$limit' => '25', '$offset' => '0'];
while (true) {
$integration_list_query['$offset'] = $integration_list_offset;
$integration_list_response = call('verify_file', $integration_list_query, null, null);
require_condition(equal(response_status($integration_list_response), '200'), 'Expected the documented HTTP 200 response; stop and review any other outcome.');
$integration_list = $integration_list_response["body"];
$integration_list_rows = items(field($integration_list, 'list_data'));
require_condition(equal(text(field($integration_list, 'records_found')), text(count($integration_list_rows))), 'The Task file page count differs from its rows.');
require_condition(is_present(text(field($integration_list, 'total_records'))), 'The Task file page needs total_records.');
require_condition(either(equal(field($integration_list, 'has_more'), true), equal(field($integration_list, 'has_more'), false)), 'The Task file page needs Boolean has_more.');
foreach (items($integration_list_rows) as $integration_list_row) {
$integration_list_id = positive_id(text(field($integration_list_row, 'id')));
require_condition(remember_id($integration_file_seen, $integration_list_id), 'A Task file ID repeated while paging.');
if (equal($integration_list_id, $integration_attachment_id)) {
require_condition(deep_equal($integration_list_row, parse_json(text(field($integration_saved_upload, 'attachment_json')))), 'The saved Task file details changed.');
$integration_file_found = true;
}
}
$integration_file_count = add_offset($integration_file_count, count($integration_list_rows));
if (equal(field($integration_list, 'has_more'), false)) {
break;
}
require_condition(not_value(is_empty($integration_list_rows)), 'An empty Task file page says has_more=true.');
$integration_list_offset = add_offset($integration_list_offset, count($integration_list_rows));
}
require_condition($integration_file_found, 'The saved file is not on this Task; stop before downloading by id or cleaning up.');
require_condition(either(not_value(equal($integration_cleanup, 'delete')), equal($integration_file_count, '1')), 'Another Task file exists; stop before deleting the test Task.');
$integration_download_response = request_download('download', ['id' => $integration_attachment_id]);
save_checked_download($integration_download_response, $integration_file, $integration_output_path);
}
if (equal($integration_cleanup, 'delete')) {
if (not_value(journal_acknowledged($integration_job, 'remove_file'))) {
journal_begin($integration_job, 'remove_file', 'DELETE', '/v1/tasks/attachments', journal_fingerprint((object)['id' => $integration_attachment_id]));
$integration_file_remove_response = call('remove_file', ['id' => $integration_attachment_id], null, null);
require_condition(equal(response_status($integration_file_remove_response), '200'), 'Expected the documented HTTP 200 response; stop and review any other outcome.');
journal_acknowledge($integration_job, 'remove_file', (object)['task_id' => $integration_task_id, 'attachment_id' => $integration_attachment_id]);
}
if (not_value(journal_acknowledged($integration_job, 'remove_task'))) {
journal_begin($integration_job, 'remove_task', 'DELETE', '/v1/tasks', journal_fingerprint((object)['id' => $integration_task_id]));
$integration_task_remove_response = call('remove_task', ['id' => $integration_task_id], null, null);
require_condition(equal(response_status($integration_task_remove_response), '200'), 'Expected the documented HTTP 200 response; stop and review any other outcome.');
journal_acknowledge($integration_job, 'remove_task', (object)['task_id' => $integration_task_id]);
}
} else {
print_value((object)['task_id' => $integration_task_id, 'attachment_id' => $integration_attachment_id, 'cleanup' => 'kept']);
}
}
if (journal_acknowledged($integration_job, 'remove_task')) {
$integration_removed = journal_saved($integration_job, 'remove_task');
$integration_task_id = positive_id(text(field($integration_removed, 'task_id')));
$integration_missing_status = request_expect('verify_removed', ['id' => $integration_task_id], null, null, '404');
print_value((object)['task_id' => $integration_task_id, 'cleanup' => 'removed', 'observed_missing_status' => $integration_missing_status]);
}
} finally {
$integration_job->close();
}
}
if (realpath($_SERVER['SCRIPT_FILENAME'] ?? '') === __FILE__) main();
# Ruby 3.1+; standard library only. Set EXHIBITDAY_API_KEY before running.
require 'net/http'
require 'json'
require 'uri'
require 'csv'
require 'fileutils'
require 'securerandom'
require 'date'
require 'time'
require 'timeout'
BASE = 'https://api.exhibitday.com/v1'
SPEC = JSON.parse('{"preserveNumbers":true,"requests":{"workspace_binding":{"method":"GET","path":"/references/workspace_info"},"create":{"method":"POST","path":"/tasks"},"read":{"method":"GET","path":"/tasks/info"},"edit":{"method":"PATCH","path":"/tasks"},"stale":{"method":"PATCH","path":"/tasks"},"after_edit":{"method":"GET","path":"/tasks/info"},"upload":{"method":"POST","path":"/tasks/attachments","file":{"name":"file","maximum_bytes":"26214400","extensions":["png","jpg","jpeg","bmp","gif","pdf","msg","eml","doc","docx","ppt","pptx","xls","xlsx","csv","rtf","odp","odt","ods","txt","wks","zip"],"content_types":[]}},"verify_file":{"method":"GET","path":"/tasks/attachments"},"download":{"method":"GET","path":"/tasks/attachments/download","binary":true},"remove_file":{"method":"DELETE","path":"/tasks/attachments"},"remove_task":{"method":"DELETE","path":"/tasks"},"verify_removed":{"method":"GET","path":"/tasks/info"}}}')
API_KEY = ENV.fetch('EXHIBITDAY_API_KEY')
raise 'Use the API key as one ASCII header value without control characters' if API_KEY.each_codepoint.any?{|point|point<32||point>126}
def decode_json(text)
if SPEC.fetch('preserveNumbers')
# Preserve JSON NUMBER lexemes for CSV, without replacing digits inside JSON strings.
text = text.gsub(/"(?:\\.|[^"\\])*"|-?\d+(?:\.\d+)?(?:[eE][+-]?\d+)?/) do |token|
token.start_with?('"') ? token : JSON.generate(token)
end
end
JSON.parse(text)
end
def transport(method, url, headers, data)
uri = URI(url)
request_type = { 'GET' => Net::HTTP::Get, 'POST' => Net::HTTP::Post,
'PATCH' => Net::HTTP::Patch, 'DELETE' => Net::HTTP::Delete }.fetch(method)
request = request_type.new(uri.request_uri, headers)
request.body = data unless data.nil?
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'
http.open_timeout = http.read_timeout = http.write_timeout = 30
http.max_retries = 0 # The outer loop owns the bounded retry policy.
response = http.start { |client| client.request(request) }
[response.code.to_i, response.body.to_s, response.each_header.to_h]
end
def retry_delay(headers, attempt)
value = headers['retry-after']
return 2**attempt if value.nil? || value.empty?
begin
[Float(value), 0].max
rescue ArgumentError, TypeError
begin
[Time.httpdate(value) - Time.now, 0].max
rescue ArgumentError
2**attempt
end
end
end
# An API error response. Branch on error_code (and status), never on the message text.
# uncertain is true when a PATCH or DELETE got no response or a server error: it may or may not have been applied.
class ApiError < RuntimeError
attr_reader :status, :error_code, :uncertain
def initialize(status, error_code, message, uncertain = false)
super(message)
@status = status
@error_code = error_code
@uncertain = uncertain
end
end
def call(name, params = {}, body = nil, key = nil)
route = SPEC.fetch('requests').fetch(name)
headers = { 'Authorization' => 'Bearer ' + API_KEY, 'Accept' => 'application/json' }
if route.fetch('method') == 'POST'
headers['Idempotency-Key'] = key || raise('Save a create key before sending POST') # ONCE before retries.
end
data = body.nil? ? nil : JSON.generate(body)
headers['Content-Type'] = 'application/json' unless data.nil?
query = URI.encode_www_form(params)
url = BASE + route.fetch('path') + (query.empty? ? '' : '?' + query)
# Only GET has automatic retries in this workflow. A PATCH or DELETE that got no response or a
# server error is never resent blindly: it may already have been applied, so the caller reads the record first.
resend = route.fetch('method') == 'GET'
5.times do |attempt|
begin
status, raw, response_headers = transport(route.fetch('method'), url, headers, data)
rescue IOError, SystemCallError, Timeout::Error, SocketError
raise ApiError.new(0, nil, 'No response', true) unless resend
raise if attempt == 4
sleep(2**attempt)
next
end
response_headers = response_headers.transform_keys(&:downcase)
result = nil
unless status == 304 || raw.empty?
begin
result = decode_json(raw)
rescue JSON::ParserError, EncodingError
raise 'Expected a JSON success response' if status < 400
end
end
if status >= 500 && !resend
raise ApiError.new(status, result.is_a?(Hash) ? result['error_code'] : nil, "HTTP #{status}", true)
end
transient = resend && (status == 429 || (500..599).cover?(status))
if transient
raise 'Retry limit reached; check the outcome before starting a new create' if attempt == 4
sleep(retry_delay(response_headers, attempt))
next
end
if status >= 400
raise ApiError.new(status, nil, "HTTP #{status}") unless result.is_a?(Hash)
raise ApiError.new(status, result['error_code'], "#{result['error_code']} #{result['error_params'].inspect}: #{result['errors'].inspect} (request #{result['request_id']})")
end
return { status: status, body: result, headers: response_headers, raw: raw }
end
raise 'Retry limit reached'
end
def add_offset(offset,received)
result=Integer(offset)+received
raise "Cannot advance this int32 offset; reconcile the query" if received<=0 || result>2147483647
result.to_s
end
def both(left,right);left&&right;end
def concat(left,right)
left+right
end
def items(value)
raise "Expected a JSON array" unless value.is_a?(Array)
value
end
def count(value)
items(value).length
end
def deep_equal(left,right)
return false unless left.class==right.class
if left.is_a?(Hash)
return left.keys.sort==right.keys.sort&&left.all?{|key,value|deep_equal(value,right[key])}
end
return left.length==right.length&&left.zip(right).all?{|a,b|deep_equal(a,b)} if left.is_a?(Array)
left==right
end
def either(left,right)
raise "Expected Boolean criteria" unless [true,false].include?(left) && [true,false].include?(right)
left || right
end
def equal(left,right)
left.class==right.class && left==right
end
def field(value,name)
raise "Missing response field: #{name}" unless value.is_a?(Hash) && value.key?(name)
value.fetch(name)
end
require 'digest'
require 'pathname'
FileSnapshot = Struct.new(:name,:data,:sha256)
def file_length(value);value.data.bytesize.to_s;end
def file_name(value);value.name;end
def file_sha256(value);value.sha256;end
def is_empty(value)
count(value)==0
end
def is_present(value)
!value.nil? && value!=""
end
require 'digest'
require 'securerandom'
require 'uri'
# Private client restart state, with no transport or application dependency.
module GuideJournalProtocol
PREAMBLE="EXHIBITDAY-GUIDE-JOURNAL 1\n".b.freeze
class Refusal < StandardError; end
def self.utf8(value)
raise Refusal,'Journal fields are exact strings' unless value.is_a?(String)&&value.valid_encoding?
raw=value.encode(Encoding::UTF_8)
raise Refusal,'Invalid UTF8 journal field' unless raw.valid_encoding?
raw.b
end
def self.strings(values)
values.map{|value|raw=utf8(value);raw.bytesize.to_s.b+':'.b+raw}.join.b
end
def self.read_strings(raw)
values=[];offset=0
while offset<raw.bytesize
ending=raw.index(':'.b,offset);raise Refusal,'Incomplete string length' unless ending
length=raw.byteslice(offset,ending-offset);raise Refusal,'Noncanonical string length' unless length.match?(/\A(?:0|[1-9][0-9]*)\z/)
size=length.to_i;offset=ending+1;raise Refusal,'Incomplete journal string' if size>raw.bytesize-offset
value=raw.byteslice(offset,size).dup.force_encoding(Encoding::UTF_8);raise Refusal,'Invalid UTF8 string' unless value.valid_encoding?
values<<value;offset+=size
end
values
end
def self.digest(raw);Digest::SHA256.hexdigest(raw).upcase;end
def self.fingerprint(pairs)
values=[];pairs.keys.sort.each do|name|
raise Refusal,'Use explicit secret-free fingerprint names' unless name.is_a?(String)&&name.match?(/\A[A-Za-z0-9_.-]+\z/)&&!['api_key','exhibitday_api_key'].include?(name.downcase)
values.concat([name,pairs.fetch(name)])
end
digest(strings(values))
end
def self.frame(values)
raw=strings(values);raw.bytesize.to_s.b+' '.b+digest(raw).b+"\n".b+raw+"\n".b
end
def self.decode(raw)
raw=raw.b;raise Refusal,'Unknown or incomplete journal version' unless raw.start_with?(PREAMBLE)
offset=PREAMBLE.bytesize;records=[]
while offset<raw.bytesize
ending=raw.index("\n".b,offset);raise Refusal,'Incomplete frame header; reconcile before retry' unless ending
header=raw.byteslice(offset,ending-offset);match=/\A(0|[1-9][0-9]*) ([0-9A-F]{64})\z/.match(header);raise Refusal,'Invalid frame header' unless match
size=match[1].to_i;offset=ending+1;raise Refusal,'Incomplete frame; reconcile before retry' if size>=raw.bytesize-offset
payload=raw.byteslice(offset,size);offset+=size
raise Refusal,'Journal integrity failed; reconcile before retry' unless raw.getbyte(offset)==10&&digest(payload)==match[2]
records<<read_strings(payload);offset+=1
end
records
end
def self.write_all(file,raw)
offset=0
while offset<raw.bytesize
written=file.syswrite(raw.byteslice(offset,raw.bytesize-offset));raise IOError,'Journal write did not advance' unless written&&written>0
offset+=written
end
file.flush;file.fsync
end
end
class GuideJournal
P=GuideJournalProtocol
def initialize(path,base,workspace,slug,job,input_fingerprint,writes,mode='resume')
@path=path.dup;@lock_path=path+'.lock';@file=nil;@owned=false;@tainted=false;@intents={};@saved={};@allowed={}
address=URI(base)
raise P::Refusal,'Use actual API base and closed guide slug' unless ['https','http'].include?(address.scheme)&&address.host&&address.userinfo.nil?&&address.query.nil?&&address.fragment.nil?&&slug.match?(/\A[a-z][a-z0-9-]*\z/)
raise P::Refusal,'Use actual workspace, stable explicit job ID and exact fingerprint' unless !job.strip.empty?&&workspace.match?(/\A[1-9][0-9]*\z/)&&input_fingerprint.match?(/\A[0-9A-F]{64}\z/)
raise P::Refusal,'Choose new or resume for this local job' unless ['new','resume'].include?(mode)
manifest=[]
writes.each do|step,method,route|
raise P::Refusal,'Use closed unique write manifest' unless step.match?(/\A[a-z][a-z0-9_-]*\z/)&&!@allowed.key?(step)&&['POST','PATCH','DELETE'].include?(method)&&route.match?(/\A\/v1\/[A-Za-z0-9_\/-]+\z/)&&!route.include?('//')
@allowed[step.dup.freeze]=[method.dup.freeze,route.dup.freeze].freeze;manifest.concat([step,method,route])
end
raise P::Refusal,'Only write workflows need a restart journal' if @allowed.empty?
@header=['H','1',base,workspace,slug,job,input_fingerprint,P.digest(P.strings(manifest))].map{|value|value.dup.freeze}.freeze;P.strings(@header)
begin
@file=File.open(@lock_path,File::RDWR|File::CREAT|File::EXCL,0o600);@file.binmode;@owned=true
rescue Errno::EEXIST
raise P::Refusal,'This journal is locked; do not overlap jobs or steal a stale lock'
end
begin
@owner=SecureRandom.hex(16).freeze;P.write_all(@file,@owner.b);@identity=@file.stat
# Ruby's Windows fstat reports dev=0 while lstat reports the drive number.
# Both expose the same exact inode. Retain it plus the initial path device;
# compare like-for-like instead of treating the differing dev APIs as equal.
named_identity=File.lstat(@lock_path);raise P::Refusal,'Lock identity did not bind' unless named_identity.ino==@identity.ino
@path_device=named_identity.dev
raise P::Refusal,'Choose a private regular journal file' if File.symlink?(@path)
raise P::Refusal,'Journal missing: stop and reconcile lost state before starting a new job' if mode=='resume'&&!File.exist?(@path)
raise P::Refusal,'Journal exists; use resume for the same job' if mode=='new'&&File.exist?(@path)
if mode=='new'
File.open(@path,File::WRONLY|File::CREAT|File::EXCL,0o600){|target|target.binmode;P.write_all(target,P::PREAMBLE+P.frame(@header))}
end
records=P.decode(File.binread(@path));raise P::Refusal,'Journal workspace/base/guide/job/input binding differs' if records.empty?||records[0]!=@header
records.drop(1).each{|record|apply(record)}
raise P::Refusal,'Saved intent lacks ACK; stop and reconcile before retry' if @intents.keys.any?{|step|!@saved.key?(step)}
rescue Exception
close;raise
end
end
def apply(record)
case record[0]
when 'I'
raise P::Refusal,'Invalid intent shape' unless record.length==6
_,step,method,route,fingerprint,key=record
raise P::Refusal,'Invalid, future or repeated intent' unless step.match?(/\A[a-z][a-z0-9_-]*\z/)&&!@intents.key?(step)&&@allowed[step]==[method,route]&&fingerprint.match?(/\A[0-9A-F]{64}\z/)&&!@intents.keys.any?{|name|!@saved.key?(name)}
raise P::Refusal,'Invalid persisted action key' unless (method=='POST'&&key.match?(/\A[0-9a-f]{32}\z/))||(method!='POST'&&key=='')
@intents[step.dup.freeze]={'method'=>method.dup.freeze,'path'=>route.dup.freeze,'request_fingerprint'=>fingerprint.dup.freeze,'idempotency_key'=>key.dup.freeze}.freeze
when 'A'
raise P::Refusal,'Invalid ACK shape' unless record.length>=3
_,step,count,*pairs=record
raise P::Refusal,'ACK without exactly one prior intent' unless count.match?(/\A(?:0|[1-9][0-9]*)\z/)&&pairs.length==2*count.to_i&&@intents.key?(step)&&!@saved.key?(step)
names=pairs.each_slice(2).map(&:first)
raise P::Refusal,'ACK fields must be unique sorted secret-free identifiers' unless names==names.uniq.sort&&names.all?{|name|name.match?(/\A[a-z][a-z0-9_]*\z/)&&!['api_key','exhibitday_api_key'].include?(name)}
@saved[step.dup.freeze]=pairs.each_slice(2).to_h.transform_values{|value|value.dup.freeze}.freeze
else
raise P::Refusal,'Unknown journal transition'
end
end
def require_active
raise P::Refusal,'Journal is closed or IO outcome needs reconciliation' unless @owned&&@file&&!@tainted
current=File.lstat(@lock_path)
raise P::Refusal,'Journal lock replaced; stop without deleting it' unless current.dev==@path_device&¤t.ino==@identity.ino&&File.binread(@lock_path)==@owner.b
end
def append(record)
require_active;raw=P.frame(record)
begin
File.open(@path,'ab'){|target|P.write_all(target,raw)}
rescue Exception
@tainted=true;raise
end
end
def acknowledged(step);require_active;@saved.key?(step);end
def saved(step)
require_active;raise P::Refusal,'No confirmed state exists' unless @saved.key?(step)
@saved.fetch(step).transform_values(&:dup)
end
def begin_action(step,method,route,request_fingerprint)
require_active;raise P::Refusal,'Never blindly repeat an action' if @intents.key?(step)
record=['I',step,method,route,request_fingerprint,method=='POST'?SecureRandom.hex(16):'']
previous=@intents.dup;begin;apply(record);ensure;@intents=previous;end
append(record);apply(record);@intents.fetch(step).transform_values(&:dup)
end
def acknowledge(step,saved)
require_active;record=['A',step,saved.length.to_s];saved.keys.sort.each{|name|record.concat([name,saved.fetch(name)])}
previous=@saved.dup;begin;apply(record);P.strings(record);ensure;@saved=previous;end
append(record);apply(record)
end
def close
return unless @owned
if @tainted;@file.close;@file=nil;@owned=false;return;end
begin;require_active;rescue Exception;@file.close;@file=nil;@owned=false;raise;end
@file.close;@file=nil;@owned=false;File.unlink(@lock_path)
end
end
def journal_values(value)
raise GuideJournalProtocol::Refusal,'Saved/fingerprint values must be exact strings' unless value.is_a?(Hash)&&value.all?{|name,item|name.is_a?(String)&&item.is_a?(String)}
value.transform_values(&:dup)
end
def journal_acknowledge(job,step,saved);job.acknowledge(step,journal_values(saved));end
def journal_acknowledged(job,step);job.acknowledged(step);end
def journal_begin(job,step,method,path,request_fingerprint);job.begin_action(step,method,path,request_fingerprint);end
def journal_fingerprint(value);GuideJournalProtocol.fingerprint(journal_values(value));end
def journal_saved(job,step);job.saved(step);end
def json_string(value)
JSON.generate(value)
end
def new_id_set
{}
end
def not_value(value)
raise "Expected a Boolean" unless value==true || value==false
!value
end
def open_journal(path,base,workspace,slug,job,input_fingerprint,writes,mode);GuideJournal.new(path,base,workspace,slug,job,input_fingerprint,writes,mode);end
def optional(name,fallback)
value=ENV[name]
value.nil? || value.empty? ? fallback : value
end
def parse_json(value)
JSON.parse(value)
end
def positive_id(value)
raise "Use a positive record ID" unless /\A[1-9][0-9]*\z/.match?(value) && Integer(value)<=9223372036854775807
value
end
def print_value(value)
STDOUT.binmode.write((value.is_a?(String)?value:JSON.generate(value))+"\n")
end
def read_file_snapshot(path,action)
rule=SPEC.fetch('requests').fetch(action)['file']
raise 'Use the current declared file input' unless rule && rule['name']=='file'
data=File.binread(path).freeze
raise 'The selected file is empty or exceeds this endpoint file limit' if data.empty? || data.bytesize>Integer(rule.fetch('maximum_bytes'))
name=File.basename(path)
raise 'Use a filename without header control characters' if name.empty? || name.match?(/[\r\n\x00]/)
FileSnapshot.new(name.freeze,data,Digest::SHA256.hexdigest(data).freeze).freeze
end
def remember_id(seen,value)
return false if seen.key?(value)
seen[value]=true
true
end
def request_download(name,params)
route=SPEC.fetch('requests').fetch(name)
raise 'Bind the declared binary GET' unless route['method']=='GET' && route['binary']==true
query=URI.encode_www_form(params)
status,raw,headers=transport('GET',BASE+route.fetch('path')+(query.empty? ? '' : '?'+query),{'Authorization'=>'Bearer '+API_KEY,'Accept'=>'application/octet-stream'},nil)
unless status==200
body=nil;begin body=decode_json(raw);rescue JSON::ParserError,EncodingError;end
raise ApiError.new(status,body.is_a?(Hash) ? body['error_code'] : nil,"HTTP #{status}")
end
raw.b
end
def request_expect(name,query,body,key,expected)
begin
call(name,query,body,key)
rescue ApiError => observed
raise if observed.uncertain || observed.status.to_s != expected
return observed.status.to_s
end
raise "Expected HTTP #{expected} refusal; request unexpectedly succeeded"
end
def request_upload(name,params,file,key)
route=SPEC.fetch('requests').fetch(name)
raise 'Bind one declared upload and its persisted create key' unless route['method']=='POST' && route['file'] && key && !key.empty?
begin boundary='ExhibitDayGuide'+SecureRandom.hex(24) end while file.data.include?(boundary)
quoted=file.name.gsub('\\','\\\\').gsub('"','\\"')
data=("--#{boundary}\r\nContent-Disposition: form-data; name=\"file\"; filename=\"#{quoted}\"\r\nContent-Type: application/octet-stream\r\n\r\n").b+file.data+("\r\n--#{boundary}--\r\n").b
headers={'Authorization'=>'Bearer '+API_KEY,'Accept'=>'application/json','Idempotency-Key'=>key,'Content-Type'=>'multipart/form-data; boundary='+boundary}
query=URI.encode_www_form(params);url=BASE+route.fetch('path')+(query.empty? ? '' : '?'+query)
begin status,raw,response_headers=transport('POST',url,headers,data)
rescue IOError,SystemCallError,Timeout::Error,SocketError;raise ApiError.new(0,nil,'No response',true);end
body=nil;begin body=decode_json(raw);rescue JSON::ParserError,EncodingError;end
raise ApiError.new(status,body.is_a?(Hash) ? body['error_code'] : nil,"HTTP #{status}",status>=500) unless status==200
raise 'Upload returned no usable JSON receipt; reconcile before retrying' unless body.is_a?(Hash)
{status:status,body:body,headers:response_headers.transform_keys(&:downcase),raw:raw}
end
def require_condition(value,message)
raise message unless value==true
end
def required(name)
value=ENV[name]
raise "Set #{name}" if value.nil? || value.strip.empty?
value
end
def response_status(value);value.fetch(:status).to_s;end
def save_checked_download(data,file,path)
raise 'Downloaded bytes differ; no output was created' unless data.bytesize==file.data.bytesize && Digest::SHA256.hexdigest(data)==file.sha256
File.open(path,File::WRONLY|File::CREAT|File::EXCL,0600){|output|output.binmode;output.write(data);output.flush;output.fsync}
end
def single(value);rows=items(value);raise 'Expected exactly one selected record' unless rows.length==1;rows[0];end
def text(value)
return "" if value.nil?
return value.to_s if value.is_a?(String)||value.is_a?(Integer)||value==true||value==false
raise "Expected a scalar response value"
end
def main
integration_event_id = positive_id(required('EXHIBITDAY_EVENT_ID'))
integration_job_id = required('EXHIBITDAY_JOB_ID')
integration_job_hash = journal_fingerprint({'job_id' => integration_job_id})
integration_initial_name = concat('API integration check ', integration_job_hash)
integration_updated_name = concat(integration_initial_name, ' updated')
integration_file = read_file_snapshot(required('EXHIBITDAY_FILE'), 'upload')
integration_output_path = required('EXHIBITDAY_DOWNLOAD_PATH')
integration_cleanup = optional('EXHIBITDAY_TEST_CLEANUP', 'keep')
require_condition(either(equal(integration_cleanup, 'keep'), equal(integration_cleanup, 'delete')), 'Use keep or delete for EXHIBITDAY_TEST_CLEANUP.')
integration_workspace_response = call('workspace_binding', {}, nil, nil)
require_condition(equal(response_status(integration_workspace_response), '200'), 'Expected the documented HTTP 200 response; stop and review any other outcome.')
integration_workspace = integration_workspace_response.fetch(:body)
integration_workspace_id = positive_id(text(field(integration_workspace, 'id')))
integration_state_path = required('EXHIBITDAY_TEST_STATE')
integration_job_mode = optional('EXHIBITDAY_JOB_MODE', 'resume')
integration_job = open_journal(integration_state_path, 'https://api.exhibitday.com/v1', integration_workspace_id, 'integration-testing', integration_job_id, journal_fingerprint({'workflow_contract_sha256' => '3808BE3DE866226BE6AAA4C445EBC19FC7903FD96FC8DC2F223F6D6451BA6267', 'event_id' => integration_event_id, 'initial_name' => integration_initial_name, 'updated_name' => integration_updated_name, 'filename' => file_name(integration_file), 'file_length' => file_length(integration_file), 'file_sha256' => file_sha256(integration_file)}), [['create', 'POST', '/v1/tasks'], ['edit', 'PATCH', '/v1/tasks'], ['stale', 'PATCH', '/v1/tasks'], ['upload', 'POST', '/v1/tasks/attachments'], ['remove_file', 'DELETE', '/v1/tasks/attachments'], ['remove_task', 'DELETE', '/v1/tasks']], integration_job_mode)
begin
integration_task_id = ''
integration_attachment_id = ''
if not_value(journal_acknowledged(integration_job, 'remove_task'))
if not_value(journal_acknowledged(integration_job, 'create'))
integration_create_intent = journal_begin(integration_job, 'create', 'POST', '/v1/tasks', journal_fingerprint({'event_id' => integration_event_id, 'name' => integration_initial_name}))
integration_created_response = call('create', {}, {'event_id' => integration_event_id, 'name' => integration_initial_name}, text(field(integration_create_intent, 'idempotency_key')))
require_condition(equal(response_status(integration_created_response), '200'), 'Expected the documented HTTP 200 response; stop and review any other outcome.')
integration_created = integration_created_response.fetch(:body)
integration_task_id = positive_id(text(field(integration_created, 'id')))
require_condition(both(equal(text(field(integration_created, 'id')), integration_task_id), both(equal(text(field(field(integration_created, 'event'), 'id')), integration_event_id), equal(text(field(integration_created, 'name')), integration_initial_name))), 'The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.')
journal_acknowledge(integration_job, 'create', {'task_id' => integration_task_id, 'event_id' => integration_event_id, 'name' => integration_initial_name, 'create_key' => text(field(integration_create_intent, 'idempotency_key'))})
end
integration_saved_create = journal_saved(integration_job, 'create')
integration_task_id = positive_id(text(field(integration_saved_create, 'task_id')))
require_condition(both(equal(text(field(integration_saved_create, 'event_id')), integration_event_id), equal(text(field(integration_saved_create, 'name')), integration_initial_name)), 'Saved create state differs from this Event/job.')
require_condition(either(not_value(journal_acknowledged(integration_job, 'remove_file')), equal(integration_cleanup, 'delete')), 'Cleanup already removed the test file. Continue with EXHIBITDAY_TEST_CLEANUP=delete to finish this Task cleanup.')
integration_before_response = call('read', {'id' => integration_task_id, '$include_record_revision' => 'true'}, nil, nil)
require_condition(equal(response_status(integration_before_response), '200'), 'Expected the documented HTTP 200 response; stop and review any other outcome.')
integration_before = integration_before_response.fetch(:body)
if not_value(journal_acknowledged(integration_job, 'edit'))
require_condition(both(equal(text(field(integration_before, 'id')), integration_task_id), both(equal(text(field(field(integration_before, 'event'), 'id')), integration_event_id), equal(text(field(integration_before, 'name')), integration_initial_name))), 'The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.')
integration_original_revision = text(field(integration_before, 'record_revision'))
require_condition(is_present(integration_original_revision), 'Read the actual created Task revision before editing.')
journal_begin(integration_job, 'edit', 'PATCH', '/v1/tasks', journal_fingerprint({'id' => integration_task_id, 'name' => integration_updated_name, 'expected_revision' => integration_original_revision}))
integration_edit_response = call('edit', {}, {'id' => integration_task_id, 'name' => integration_updated_name, 'expected_revision' => integration_original_revision}, nil)
require_condition(equal(response_status(integration_edit_response), '200'), 'Expected the documented HTTP 200 response; stop and review any other outcome.')
integration_edit_receipt = integration_edit_response.fetch(:body)
integration_saved_revision = text(field(integration_edit_receipt, 'record_revision'))
require_condition(both(is_present(integration_saved_revision), not_value(equal(integration_original_revision, integration_saved_revision))), 'The distinct test name must produce a checked new revision before the stale test.')
journal_acknowledge(integration_job, 'edit', {'task_id' => integration_task_id, 'name' => integration_updated_name, 'original_revision' => integration_original_revision, 'record_revision' => integration_saved_revision})
end
integration_saved_edit = journal_saved(integration_job, 'edit')
require_condition(both(equal(text(field(integration_saved_edit, 'task_id')), integration_task_id), equal(text(field(integration_saved_edit, 'name')), integration_updated_name)), 'Saved edit state differs from this Task/name.')
if not_value(journal_acknowledged(integration_job, 'stale'))
journal_begin(integration_job, 'stale', 'PATCH', '/v1/tasks', journal_fingerprint({'id' => integration_task_id, 'name' => 'Refused stale test', 'expected_revision' => text(field(integration_saved_edit, 'original_revision'))}))
integration_stale_status = request_expect('stale', {}, {'id' => integration_task_id, 'name' => 'Refused stale test', 'expected_revision' => text(field(integration_saved_edit, 'original_revision'))}, nil, '409')
journal_acknowledge(integration_job, 'stale', {'task_id' => integration_task_id, 'observed_status' => integration_stale_status})
end
integration_saved_stale = journal_saved(integration_job, 'stale')
require_condition(both(equal(text(field(integration_saved_stale, 'task_id')), integration_task_id), equal(text(field(integration_saved_stale, 'observed_status')), '409')), 'The saved conflict assertion differs from this Task/status.')
integration_after_edit_response = call('after_edit', {'id' => integration_task_id, '$include_record_revision' => 'true'}, nil, nil)
require_condition(equal(response_status(integration_after_edit_response), '200'), 'Expected the documented HTTP 200 response; stop and review any other outcome.')
integration_after_edit = integration_after_edit_response.fetch(:body)
require_condition(both(equal(text(field(integration_after_edit, 'id')), integration_task_id), both(equal(text(field(field(integration_after_edit, 'event'), 'id')), integration_event_id), equal(text(field(integration_after_edit, 'name')), integration_updated_name))), 'The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.')
require_condition(equal(text(field(integration_after_edit, 'record_revision')), text(field(integration_saved_edit, 'record_revision'))), 'The test Task\'s revision changed; stop before file work or cleanup.')
require_condition(either(not_value(equal(integration_cleanup, 'delete')), deep_equal(field(integration_after_edit, 'comments'), [])), 'The test Task has comments; stop before cleanup.')
if not_value(journal_acknowledged(integration_job, 'upload'))
require_condition(equal(text(field(integration_after_edit, 'record_revision')), text(field(integration_saved_edit, 'record_revision'))), 'The Task changed after the conditional edit. Review it before uploading.')
integration_upload_intent = journal_begin(integration_job, 'upload', 'POST', '/v1/tasks/attachments', journal_fingerprint({'task_id' => integration_task_id, 'filename' => file_name(integration_file), 'file_length' => file_length(integration_file), 'file_sha256' => file_sha256(integration_file)}))
integration_upload_response = request_upload('upload', {'task_id' => integration_task_id}, integration_file, text(field(integration_upload_intent, 'idempotency_key')))
require_condition(equal(response_status(integration_upload_response), '200'), 'Expected the documented HTTP 200 response; stop and review any other outcome.')
integration_upload = integration_upload_response.fetch(:body)
require_condition(both(equal(text(field(integration_upload, 'records_found')), '1'), both(equal(text(field(integration_upload, 'total_records')), '1'), equal(field(integration_upload, 'has_more'), false))), 'Require exactly one complete uploaded-file receipt.')
integration_uploaded_file = single(field(integration_upload, 'list_data'))
integration_attachment_id = positive_id(text(field(integration_uploaded_file, 'id')))
require_condition(is_present(text(field(integration_uploaded_file, 'filename'))), 'The upload receipt needs its actual stored filename.')
journal_acknowledge(integration_job, 'upload', {'task_id' => integration_task_id, 'attachment_id' => integration_attachment_id, 'filename' => text(field(integration_uploaded_file, 'filename')), 'attachment_json' => json_string(integration_uploaded_file), 'file_length' => file_length(integration_file), 'file_sha256' => file_sha256(integration_file)})
end
integration_saved_upload = journal_saved(integration_job, 'upload')
integration_attachment_id = positive_id(text(field(integration_saved_upload, 'attachment_id')))
require_condition(both(equal(text(field(integration_saved_upload, 'task_id')), integration_task_id), both(equal(text(field(integration_saved_upload, 'file_length')), file_length(integration_file)), equal(text(field(integration_saved_upload, 'file_sha256')), file_sha256(integration_file)))), 'The confirmed file differs from the saved test Task or file details.')
if not_value(journal_acknowledged(integration_job, 'remove_file'))
integration_list_offset = '0'
integration_file_count = '0'
integration_file_found = false
integration_file_seen = new_id_set()
integration_list_query = {'task_id' => integration_task_id, '$limit' => '25', '$offset' => '0'}
while true
integration_list_query['$offset'] = integration_list_offset
integration_list_response = call('verify_file', integration_list_query, nil, nil)
require_condition(equal(response_status(integration_list_response), '200'), 'Expected the documented HTTP 200 response; stop and review any other outcome.')
integration_list = integration_list_response.fetch(:body)
integration_list_rows = items(field(integration_list, 'list_data'))
require_condition(equal(text(field(integration_list, 'records_found')), text(count(integration_list_rows))), 'The Task file page count differs from its rows.')
require_condition(is_present(text(field(integration_list, 'total_records'))), 'The Task file page needs total_records.')
require_condition(either(equal(field(integration_list, 'has_more'), true), equal(field(integration_list, 'has_more'), false)), 'The Task file page needs Boolean has_more.')
items(integration_list_rows).each do |integration_list_row|
integration_list_id = positive_id(text(field(integration_list_row, 'id')))
require_condition(remember_id(integration_file_seen, integration_list_id), 'A Task file ID repeated while paging.')
if equal(integration_list_id, integration_attachment_id)
require_condition(deep_equal(integration_list_row, parse_json(text(field(integration_saved_upload, 'attachment_json')))), 'The saved Task file details changed.')
integration_file_found = true
end
end
integration_file_count = add_offset(integration_file_count, count(integration_list_rows))
if equal(field(integration_list, 'has_more'), false)
break
end
require_condition(not_value(is_empty(integration_list_rows)), 'An empty Task file page says has_more=true.')
integration_list_offset = add_offset(integration_list_offset, count(integration_list_rows))
end
require_condition(integration_file_found, 'The saved file is not on this Task; stop before downloading by id or cleaning up.')
require_condition(either(not_value(equal(integration_cleanup, 'delete')), equal(integration_file_count, '1')), 'Another Task file exists; stop before deleting the test Task.')
integration_download_response = request_download('download', {'id' => integration_attachment_id})
save_checked_download(integration_download_response, integration_file, integration_output_path)
end
if equal(integration_cleanup, 'delete')
if not_value(journal_acknowledged(integration_job, 'remove_file'))
journal_begin(integration_job, 'remove_file', 'DELETE', '/v1/tasks/attachments', journal_fingerprint({'id' => integration_attachment_id}))
integration_file_remove_response = call('remove_file', {'id' => integration_attachment_id}, nil, nil)
require_condition(equal(response_status(integration_file_remove_response), '200'), 'Expected the documented HTTP 200 response; stop and review any other outcome.')
journal_acknowledge(integration_job, 'remove_file', {'task_id' => integration_task_id, 'attachment_id' => integration_attachment_id})
end
if not_value(journal_acknowledged(integration_job, 'remove_task'))
journal_begin(integration_job, 'remove_task', 'DELETE', '/v1/tasks', journal_fingerprint({'id' => integration_task_id}))
integration_task_remove_response = call('remove_task', {'id' => integration_task_id}, nil, nil)
require_condition(equal(response_status(integration_task_remove_response), '200'), 'Expected the documented HTTP 200 response; stop and review any other outcome.')
journal_acknowledge(integration_job, 'remove_task', {'task_id' => integration_task_id})
end
else
print_value({'task_id' => integration_task_id, 'attachment_id' => integration_attachment_id, 'cleanup' => 'kept'})
end
end
if journal_acknowledged(integration_job, 'remove_task')
integration_removed = journal_saved(integration_job, 'remove_task')
integration_task_id = positive_id(text(field(integration_removed, 'task_id')))
integration_missing_status = request_expect('verify_removed', {'id' => integration_task_id}, nil, nil, '404')
print_value({'task_id' => integration_task_id, 'cleanup' => 'removed', 'observed_missing_status' => integration_missing_status})
end
ensure
integration_job.close()
end
end
main if $PROGRAM_NAME == __FILE__
// Go 1.18+; standard library only. Set EXHIBITDAY_API_KEY.
package main
import (
"bytes"
"crypto/rand"
"crypto/sha256"
"encoding/hex"
"regexp"
"sort"
"unicode/utf8"
"mime/multipart"
"path/filepath"
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"os"
"strconv"
"strings"
"time"
)
const base = "https://api.exhibitday.com/v1"
const specification = "{\"preserveNumbers\":true,\"requests\":{\"workspace_binding\":{\"method\":\"GET\",\"path\":\"/references/workspace_info\"},\"create\":{\"method\":\"POST\",\"path\":\"/tasks\"},\"read\":{\"method\":\"GET\",\"path\":\"/tasks/info\"},\"edit\":{\"method\":\"PATCH\",\"path\":\"/tasks\"},\"stale\":{\"method\":\"PATCH\",\"path\":\"/tasks\"},\"after_edit\":{\"method\":\"GET\",\"path\":\"/tasks/info\"},\"upload\":{\"method\":\"POST\",\"path\":\"/tasks/attachments\",\"file\":{\"name\":\"file\",\"maximum_bytes\":\"26214400\",\"extensions\":[\"png\",\"jpg\",\"jpeg\",\"bmp\",\"gif\",\"pdf\",\"msg\",\"eml\",\"doc\",\"docx\",\"ppt\",\"pptx\",\"xls\",\"xlsx\",\"csv\",\"rtf\",\"odp\",\"odt\",\"ods\",\"txt\",\"wks\",\"zip\"],\"content_types\":[]}},\"verify_file\":{\"method\":\"GET\",\"path\":\"/tasks/attachments\"},\"download\":{\"method\":\"GET\",\"path\":\"/tasks/attachments/download\",\"binary\":true},\"remove_file\":{\"method\":\"DELETE\",\"path\":\"/tasks/attachments\"},\"remove_task\":{\"method\":\"DELETE\",\"path\":\"/tasks\"},\"verify_removed\":{\"method\":\"GET\",\"path\":\"/tasks/info\"}}}"
var spec map[string]any
var apiKey string
var client = &http.Client{Timeout: 30 * time.Second, CheckRedirect: func(req *http.Request, via []*http.Request) error { return http.ErrUseLastResponse }}
var send = client.Do
type result struct { status int; body any; headers http.Header; raw []byte }
// An API error response (raised with panic). Branch on code (and status), never on the message text.
// uncertain is true when a PATCH or DELETE got no response or a server error: it may or may not have been applied.
type apiError struct { status int; code string; message string; uncertain bool }
func (failure apiError) Error() string { return failure.message }
func required(name string) string {
value := os.Getenv(name); if strings.TrimSpace(value) == "" { panic("Set " + name) }; return value
}
func text(value any) string { if value == nil { return "" }; return fmt.Sprint(value) }
func object(value any) map[string]any { if value == nil { return map[string]any{} }; return value.(map[string]any) }
func array(value any) []any { if value == nil { return nil }; return value.([]any) }
func decode(raw []byte) (any, error) {
var value any
decoder := json.NewDecoder(bytes.NewReader(raw)); decoder.UseNumber() // keeps exact decimal tokens
err := decoder.Decode(&value); return value, err
}
func call(name string, query map[string]string, body any, key string) result {
route := object(object(spec["requests"])[name]); method := text(route["method"])
headers := map[string]string{"Authorization": "Bearer " + apiKey, "Accept": "application/json"}
if method == "POST" { if key == "" { panic("Save a create key before sending POST") }; headers["Idempotency-Key"] = key } // before retry loop
var data []byte
if body != nil { var err error; data, err = json.Marshal(body); if err != nil { panic(err) }; headers["Content-Type"] = "application/json" }
values := url.Values{}; for k,v := range query { values.Set(k,v) }
address := base + text(route["path"]); if len(values) > 0 { address += "?" + values.Encode() }
// Only GET has automatic retries in this workflow. A PATCH or DELETE that got no response or a
// server error is never resent blindly: it may already have been applied, so the caller reads the record first.
resend := method == "GET"
for attempt := 0; attempt < 5; attempt++ {
request, err := http.NewRequest(method, address, bytes.NewReader(data)); if err != nil { panic(err) }
for k,v := range headers { request.Header.Set(k,v) }
response, err := send(request)
if err != nil { if !resend { panic(apiError{0, "", "No response", true}) }; if attempt == 4 { panic(err) }; time.Sleep(time.Second*time.Duration(1<<attempt)); continue }
raw, readErr := io.ReadAll(response.Body); response.Body.Close()
if readErr != nil { if !resend { panic(apiError{0, "", "No response", true}) }; if attempt == 4 { panic(readErr) }; time.Sleep(time.Second*time.Duration(1<<attempt)); continue }
var parsed any
if response.StatusCode != 304 && len(raw)>0 {
parsed, err = decode(raw)
if err != nil && response.StatusCode < 400 { panic("Expected a JSON success response") }
}
errorBody, _ := parsed.(map[string]any)
if response.StatusCode >= 500 && !resend { panic(apiError{response.StatusCode, text(errorBody["error_code"]), fmt.Sprintf("HTTP %d", response.StatusCode), true}) }
retry := resend && (response.StatusCode == 429 || response.StatusCode >= 500)
if retry {
if attempt == 4 { panic("Retry limit reached; check the outcome before starting a new create") }
seconds := float64(int64(1)<<attempt)
if value, err := strconv.ParseFloat(response.Header.Get("Retry-After"),64); err == nil && value >= 0 { seconds = value }
time.Sleep(time.Duration(seconds*float64(time.Second))); continue
}
if response.StatusCode >= 400 { panic(apiError{response.StatusCode, text(errorBody["error_code"]), fmt.Sprintf("HTTP %d: %v (request %v)",response.StatusCode,errorBody["error_code"],errorBody["request_id"]), false}) }
return result{response.StatusCode, parsed, response.Header, raw}
}
panic("Retry limit reached")
}
func add_offset(offset string,received int64)string{previous,err:=strconv.ParseInt(offset,10,32);if err!=nil||received<=0||received>2147483647-previous{panic("Cannot advance this int32 offset; reconcile the query")};return strconv.FormatInt(previous+received,10)}
func both(left,right bool)bool{return left&&right}
func concat(left,right string)string{return left+right}
func items(value any)[]any{result,ok:=value.([]any);if !ok{panic("Expected a JSON array")};return result}
func count(value any)int64{return int64(len(items(value)))}
func deep_equal(left,right any)bool{a,e:=json.Marshal(left);if e!=nil{panic(e)};b,e:=json.Marshal(right);if e!=nil{panic(e)};return string(a)==string(b)}
func either(left,right bool)bool{return left||right}
func equal(left,right any)bool{switch a:=left.(type){case string:b,ok:=right.(string);return ok&&a==b;case bool:b,ok:=right.(bool);return ok&&a==b;case int64:b,ok:=right.(int64);return ok&&a==b};return left==nil&&right==nil}
func field(value any,name string)any{obj,ok:=value.(map[string]any);if !ok{panic("Missing response object")};item,found:=obj[name];if !found{panic("Missing response field: "+name)};return item}
type fileSnapshot struct { name string; data []byte; sha256 string }
func file_length(value *fileSnapshot)string{return strconv.Itoa(len(value.data))}
func file_name(value *fileSnapshot)string{return value.name}
func file_sha256(value *fileSnapshot)string{return value.sha256}
func is_empty(value any)bool{return count(value)==0}
func is_present(value string)bool{return value!=""}
// Private client restart state only; no API transport or workflow interpreter.
const journalPreamble = "EXHIBITDAY-GUIDE-JOURNAL 1\n"
type journalRefusal struct{ message string }
func (e journalRefusal) Error() string { return e.message }
func journalNeed(ok bool, message string) { if !ok { panic(journalRefusal{message}) } }
func journalMatch(value, pattern string) bool { return regexp.MustCompile("\\A(?:"+pattern+")\\z").MatchString(value) }
func journalStrings(values []string) []byte {
var output bytes.Buffer
for _,value:=range values { journalNeed(utf8.ValidString(value),"Journal fields must be valid UTF8 strings"); output.WriteString(strconv.Itoa(len(value))+":");output.WriteString(value) }
return output.Bytes()
}
func journalReadStrings(raw []byte) []string {
values:=[]string{};offset:=0
for offset<len(raw) { relative:=bytes.IndexByte(raw[offset:],':');journalNeed(relative>=0,"Incomplete journal string length");end:=offset+relative;text:=string(raw[offset:end]);journalNeed(journalMatch(text,"0|[1-9][0-9]*"),"Noncanonical journal string length");size,err:=strconv.ParseUint(text,10,64);offset=end+1;journalNeed(err==nil&&size<=uint64(len(raw)-offset),"Incomplete journal string");count:=int(size);value:=string(raw[offset:offset+count]);journalNeed(utf8.ValidString(value),"Invalid UTF8 journal field");values=append(values,value);offset+=count }
return values
}
func journalDigest(raw []byte) string { hash:=sha256.Sum256(raw);return strings.ToUpper(hex.EncodeToString(hash[:])) }
func journalFingerprint(pairs map[string]string) string {
names:=make([]string,0,len(pairs));for name:=range pairs { names=append(names,name) };sort.Strings(names);values:=[]string{}
for _,name:=range names { lower:=strings.ToLower(name);journalNeed(journalMatch(name,"[A-Za-z0-9_.-]+")&&lower!="api_key"&&lower!="exhibitday_api_key","Use explicit secret-free fingerprint names");values=append(values,name,pairs[name]) }
return journalDigest(journalStrings(values))
}
func journalFrame(values []string) []byte { raw:=journalStrings(values);header:=[]byte(strconv.Itoa(len(raw))+" "+journalDigest(raw)+"\n");result:=append(header,raw...);return append(result,'\n') }
func journalDecode(raw []byte) [][]string {
journalNeed(bytes.HasPrefix(raw,[]byte(journalPreamble)),"Unknown or incomplete journal version");offset:=len(journalPreamble);records:=[][]string{}
for offset<len(raw) { relative:=bytes.IndexByte(raw[offset:],'\n');journalNeed(relative>=0,"Incomplete frame header; reconcile before retry");end:=offset+relative;header:=string(raw[offset:end]);journalNeed(journalMatch(header,"(0|[1-9][0-9]*) [0-9A-F]{64}"),"Invalid frame header");fields:=strings.Split(header," ");size,err:=strconv.ParseUint(fields[0],10,64);offset=end+1;journalNeed(err==nil&&size<uint64(len(raw)-offset),"Incomplete frame; reconcile before retry");count:=int(size);payload:=raw[offset:offset+count];offset+=count;journalNeed(raw[offset]=='\n'&&journalDigest(payload)==fields[1],"Journal integrity failed; reconcile before retry");records=append(records,journalReadStrings(payload));offset++ }
return records
}
func journalWriteAll(file *os.File, raw []byte) error {
for len(raw)>0 { count,err:=file.Write(raw);if err!=nil{return err};if count<=0{return io.ErrShortWrite};raw=raw[count:] }
return file.Sync()
}
func journalWriteFile(path string,flags int,raw []byte) (err error) {
file,err:=os.OpenFile(path,flags,0600);if err!=nil{return err};defer func(){closed:=file.Close();if err==nil{err=closed}}();return journalWriteAll(file,raw)
}
func journalCopy(source map[string]string) map[string]string { copy:=map[string]string{};for name,value:=range source{copy[name]=value};return copy }
func journalCopyStates(source map[string]map[string]string) map[string]map[string]string { copy:=map[string]map[string]string{};for name,value:=range source{copy[name]=journalCopy(value)};return copy }
type guideJournal struct {
path,lockPath,owner string
header []string
allowed map[string][2]string
intents,savedValues map[string]map[string]string
file *os.File
identity os.FileInfo
owned,tainted bool
}
func openGuideJournal(path,base,workspace,slug,job,inputFingerprint string,writes [][3]string,modes ...string) (result *guideJournal) {
mode:="resume";journalNeed(len(modes)<=1,"Choose one local job mode");if len(modes)==1{mode=modes[0]};journalNeed(mode=="new"||mode=="resume","Choose new or resume for this local job")
address,err:=url.Parse(base);journalNeed(err==nil&&address.Hostname()!=""&&(address.Scheme=="https"||address.Scheme=="http")&&address.User==nil&&address.RawQuery==""&&address.Fragment==""&&journalMatch(slug,"[a-z][a-z0-9-]*"),"Use actual API base and closed guide slug")
journalNeed(strings.TrimSpace(job)!=""&&journalMatch(workspace,"[1-9][0-9]*")&&journalMatch(inputFingerprint,"[0-9A-F]{64}"),"Use actual workspace, stable explicit job ID and exact fingerprint")
j:=&guideJournal{path:path,lockPath:path+".lock",allowed:map[string][2]string{},intents:map[string]map[string]string{},savedValues:map[string]map[string]string{}}
manifest:=[]string{};for _,write:=range writes { step,method,route:=write[0],write[1],write[2];_,exists:=j.allowed[step];journalNeed(journalMatch(step,"[a-z][a-z0-9_-]*")&&!exists&&(method=="POST"||method=="PATCH"||method=="DELETE")&&journalMatch(route,"/v1/[A-Za-z0-9_/-]+")&&!strings.Contains(route,"//"),"Use a closed unique write manifest");j.allowed[step]=[2]string{method,route};manifest=append(manifest,step,method,route) }
journalNeed(len(j.allowed)>0,"Only write workflows need a restart journal");j.header=[]string{"H","1",base,workspace,slug,job,inputFingerprint,journalDigest(journalStrings(manifest))};journalStrings(j.header)
j.file,err=os.OpenFile(j.lockPath,os.O_RDWR|os.O_CREATE|os.O_EXCL,0600);if err!=nil { if os.IsExist(err){panic(journalRefusal{"This journal is locked; do not overlap jobs or steal a stale lock"})};panic(err) };j.owned=true
defer func(){ if observed:=recover();observed!=nil { j.Close();panic(observed) } }()
random:=make([]byte,16);if _,err=io.ReadFull(rand.Reader,random);err!=nil{panic(err)};j.owner=hex.EncodeToString(random);if err=journalWriteAll(j.file,[]byte(j.owner));err!=nil{panic(err)};j.identity,err=j.file.Stat();if err!=nil{panic(err)}
info,err:=os.Lstat(path);if err!=nil&&!os.IsNotExist(err){panic(err)};exists:=err==nil;if exists{journalNeed(info.Mode()&os.ModeSymlink==0,"Choose a private regular journal file")};journalNeed(mode!="resume"||exists,"Journal missing: stop and reconcile lost state before starting a new job");journalNeed(mode!="new"||!exists,"Journal exists; use resume for the same job");if mode=="new"{raw:=append([]byte(journalPreamble),journalFrame(j.header)...);if err=journalWriteFile(path,os.O_WRONLY|os.O_CREATE|os.O_EXCL,raw);err!=nil{panic(err)}}
raw,err:=os.ReadFile(path);if err!=nil{panic(err)};records:=journalDecode(raw);journalNeed(len(records)>0&&stringsEqual(records[0],j.header),"Journal workspace/base/guide/job/input binding differs");for _,record:=range records[1:]{j.apply(record)};for step:=range j.intents{_,ok:=j.savedValues[step];journalNeed(ok,"Saved intent lacks ACK; stop and reconcile before retry")};return j
}
func stringsEqual(left,right []string) bool { if len(left)!=len(right){return false};for i,value:=range left{if value!=right[i]{return false}};return true }
func (j *guideJournal) apply(record []string) {
journalNeed(len(record)>0,"Empty journal record")
if record[0]=="I" { journalNeed(len(record)==6,"Invalid intent shape");step,method,route,fingerprint,key:=record[1],record[2],record[3],record[4],record[5];_,exists:=j.intents[step];expected,allowed:=j.allowed[step];pending:=false;for name:=range j.intents{if _,ok:=j.savedValues[name];!ok{pending=true}}
journalNeed(journalMatch(step,"[a-z][a-z0-9_-]*")&&!exists&&allowed&&expected==[2]string{method,route}&&journalMatch(fingerprint,"[0-9A-F]{64}")&&!pending,"Invalid, future or repeated intent");journalNeed(method=="POST"&&journalMatch(key,"[0-9a-f]{32}")||method!="POST"&&key=="","Invalid persisted action key");j.intents[step]=map[string]string{"method":method,"path":route,"request_fingerprint":fingerprint,"idempotency_key":key}
}else if record[0]=="A" { journalNeed(len(record)>=3,"Invalid ACK shape");step,text:=record[1],record[2];count,err:=strconv.ParseUint(text,10,64);_,prior:=j.intents[step];_,done:=j.savedValues[step];journalNeed(journalMatch(text,"0|[1-9][0-9]*")&&err==nil&&len(record)%2==1&&count==uint64((len(record)-3)/2)&&prior&&!done,"ACK without exactly one prior intent");names:=[]string{};for i:=3;i<len(record);i+=2{names=append(names,record[i])};ordered:=append([]string{},names...);sort.Strings(ordered);journalNeed(stringsEqual(names,ordered),"ACK names must be sorted");saved:=map[string]string{};for i,name:=range names{_,exists:=saved[name];journalNeed(!exists&&journalMatch(name,"[a-z][a-z0-9_]*")&&name!="api_key"&&name!="exhibitday_api_key","ACK names must be unique secret-free identifiers");saved[name]=record[4+2*i]};j.savedValues[step]=saved
}else{panic(journalRefusal{"Unknown journal transition"})}
}
func (j *guideJournal) requireActive() {
journalNeed(j.owned&&j.file!=nil&&j.identity!=nil&&!j.tainted,"Journal is closed or IO outcome needs reconciliation");info,err:=os.Lstat(j.lockPath);if err!=nil{panic(err)};journalNeed(os.SameFile(j.identity,info),"Journal lock replaced; stop without deleting it");raw,err:=os.ReadFile(j.lockPath);if err!=nil{panic(err)};journalNeed(string(raw)==j.owner,"Journal lock token changed; stop without deleting it")
}
func (j *guideJournal) append(record []string) { j.requireActive();raw:=journalFrame(record);if err:=journalWriteFile(j.path,os.O_WRONLY|os.O_APPEND,raw);err!=nil{j.tainted=true;panic(err)} }
func (j *guideJournal) Acknowledged(step string) bool {j.requireActive();_,ok:=j.savedValues[step];return ok}
func (j *guideJournal) Saved(step string) map[string]string {j.requireActive();value,ok:=j.savedValues[step];journalNeed(ok,"No confirmed state exists");return journalCopy(value)}
func (j *guideJournal) Begin(step,method,route,requestFingerprint string) map[string]string {
j.requireActive();_,exists:=j.intents[step];journalNeed(!exists,"Never blindly repeat an existing action");key:="";if method=="POST"{raw:=make([]byte,16);if _,err:=io.ReadFull(rand.Reader,raw);err!=nil{panic(err)};key=hex.EncodeToString(raw)};record:=[]string{"I",step,method,route,requestFingerprint,key}
previous:=journalCopyStates(j.intents);func(){defer func(){j.intents=previous}();j.apply(record)}();j.append(record);j.apply(record);return journalCopy(j.intents[step])
}
func (j *guideJournal) Acknowledge(step string,saved map[string]string) {
j.requireActive();record:=[]string{"A",step,strconv.Itoa(len(saved))};names:=make([]string,0,len(saved));for name:=range saved{names=append(names,name)};sort.Strings(names);for _,name:=range names{record=append(record,name,saved[name])};previous:=journalCopyStates(j.savedValues);func(){defer func(){j.savedValues=previous}();j.apply(record);journalStrings(record)}();j.append(record);j.apply(record)
}
func (j *guideJournal) Close() {
if !j.owned{return};if j.tainted{err:=j.file.Close();j.file=nil;j.owned=false;if err!=nil{panic(err)};return}
func(){defer func(){if observed:=recover();observed!=nil{j.file.Close();j.file=nil;j.owned=false;panic(observed)}}();j.requireActive()}();if err:=j.file.Close();err!=nil{j.file=nil;j.owned=false;panic(err)};j.file=nil;j.owned=false;if err:=os.Remove(j.lockPath);err!=nil{panic(err)}
}
func journal_values(value any)map[string]string{fields,ok:=value.(map[string]any);journalNeed(ok,"Saved/fingerprint values need an explicit object");result:=map[string]string{};for name,item:=range fields{text,valid:=item.(string);journalNeed(valid,"Saved/fingerprint values must be exact strings");result[name]=text};return result}
func journal_object(fields map[string]string)any{result:=map[string]any{};for name,value:=range fields{result[name]=value};return result}
func journal_acknowledge(job *guideJournal,step string,saved any){job.Acknowledge(step,journal_values(saved))}
func journal_acknowledged(job *guideJournal,step string)bool{return job.Acknowledged(step)}
func journal_begin(job *guideJournal,step,method,path,requestFingerprint string)any{return journal_object(job.Begin(step,method,path,requestFingerprint))}
func journal_fingerprint(value any)string{return journalFingerprint(journal_values(value))}
func journal_saved(job *guideJournal,step string)any{return journal_object(job.Saved(step))}
func json_string(value any)string{raw,e:=json.Marshal(value);if e!=nil{panic(e)};return string(raw)}
func new_id_set()map[string]bool{return map[string]bool{}}
func not_value(value bool)bool{return !value}
func open_journal(path,base,workspace,slug,job,inputFingerprint string,manifest any,mode string)*guideJournal{rows,ok:=manifest.([]any);journalNeed(ok,"A closed write manifest is required");writes:=[][3]string{};for _,row:=range rows{fields,valid:=row.([]any);journalNeed(valid&&len(fields)==3,"Each write must bind step/method/path");var values [3]string;for index,item:=range fields{text,valid:=item.(string);journalNeed(valid,"Manifest values are exact strings");values[index]=text};writes=append(writes,values)};return openGuideJournal(path,base,workspace,slug,job,inputFingerprint,writes,mode)}
func optional(name,fallback string)string{value:=os.Getenv(name);if value==""{return fallback};return value}
func parse_json(value string)any{decoder:=json.NewDecoder(strings.NewReader(value));decoder.UseNumber();var parsed any;if e:=decoder.Decode(&parsed);e!=nil{panic(e)};return parsed}
func positive_id(value string)string{valid:=len(value)>0&&value[0]!='0';for _,ch:=range value{valid=valid&&ch>='0'&&ch<='9'};id,err:=strconv.ParseInt(value,10,64);if !valid||err!=nil||id<=0{panic("Use a positive record ID")};return value}
func print_value(value any){if result,ok:=value.(string);ok{fmt.Println(result);return};raw,err:=json.Marshal(value);if err!=nil{panic(err)};fmt.Println(string(raw))}
func read_file_snapshot(path string,action string)*fileSnapshot {
rule:=object(object(object(spec["requests"])[action])["file"])
if text(rule["name"])!="file" {panic("Use the current declared file input")}
data,err:=os.ReadFile(path);if err!=nil{panic(err)};maximum,err:=strconv.ParseInt(text(rule["maximum_bytes"]),10,64);if err!=nil{panic(err)}
if len(data)==0||int64(len(data))>maximum{panic("The selected file is empty or exceeds this endpoint file limit")}
name:=filepath.Base(path);if name==""||strings.ContainsAny(name,"\r\n\x00"){panic("Use a filename without header control characters")}
return &fileSnapshot{name,append([]byte(nil),data...),fmt.Sprintf("%x",sha256.Sum256(data))}
}
func remember_id(seen map[string]bool,value string)bool{if seen[value]{return false};seen[value]=true;return true}
func file_address(route map[string]any,params map[string]string)string{query:=url.Values{};for k,v:=range params{query.Set(k,v)};address:=base+text(route["path"]);if len(query)>0{address+="?"+query.Encode()};return address}
func request_download(name string,params map[string]string)[]byte {
route:=object(object(spec["requests"])[name]);if text(route["method"])!="GET"||route["binary"]!=true{panic("Bind the declared binary GET")}
request,err:=http.NewRequest("GET",file_address(route,params),nil);if err!=nil{panic(err)};request.Header.Set("Authorization","Bearer "+apiKey);request.Header.Set("Accept","application/octet-stream")
response,err:=send(request);if err!=nil{panic(err)};defer response.Body.Close();data,err:=io.ReadAll(response.Body);if err!=nil{panic(err)}
if response.StatusCode!=200{parsed,_:=decode(data);body,_:=parsed.(map[string]any);panic(apiError{response.StatusCode,text(body["error_code"]),fmt.Sprintf("HTTP %d",response.StatusCode),false})};return data
}
func request_expect(name string,query map[string]string,body any,key string,expected string)(observed string) {
defer func(){if failure:=recover();failure!=nil{apiFailure,okay:=failure.(apiError);if !okay||apiFailure.uncertain||strconv.Itoa(apiFailure.status)!=expected{panic(failure)};observed=strconv.Itoa(apiFailure.status)}}()
call(name,query,body,key)
panic("Expected HTTP "+expected+" refusal; request unexpectedly succeeded")
}
func request_upload(name string,params map[string]string,file *fileSnapshot,key string)result {
route:=object(object(spec["requests"])[name]);if text(route["method"])!="POST"||route["file"]==nil||key==""{panic("Bind one declared upload and its persisted create key")}
var data bytes.Buffer;writer:=multipart.NewWriter(&data);part,err:=writer.CreateFormFile("file",file.name);if err!=nil{panic(err)};if _,err=part.Write(file.data);err!=nil{panic(err)};if err=writer.Close();err!=nil{panic(err)}
request,err:=http.NewRequest("POST",file_address(route,params),bytes.NewReader(data.Bytes()));if err!=nil{panic(err)}
request.Header.Set("Authorization","Bearer "+apiKey);request.Header.Set("Accept","application/json");request.Header.Set("Idempotency-Key",key);request.Header.Set("Content-Type",writer.FormDataContentType())
response,err:=send(request);if err!=nil{panic(apiError{0,"","No response",true})};defer response.Body.Close();raw,err:=io.ReadAll(response.Body);if err!=nil{panic(apiError{0,"","No response",true})}
parsed,_:=decode(raw);body,_:=parsed.(map[string]any);if response.StatusCode!=200{panic(apiError{response.StatusCode,text(body["error_code"]),fmt.Sprintf("HTTP %d",response.StatusCode),response.StatusCode>=500})}
if body==nil{panic("Upload returned no usable JSON receipt; reconcile before retrying")};return result{response.StatusCode,parsed,response.Header,raw}
}
func require_condition(value bool,message string){if !value{panic(message)}}
func response_status(value result)string{return strconv.Itoa(value.status)}
func save_checked_download(data []byte,file *fileSnapshot,path string) {
if len(data)!=len(file.data)||fmt.Sprintf("%x",sha256.Sum256(data))!=file.sha256{panic("Downloaded bytes differ; no output was created")}
output,err:=os.OpenFile(path,os.O_CREATE|os.O_EXCL|os.O_WRONLY,0600);if err!=nil{panic(err)};defer output.Close();if _,err=output.Write(data);err!=nil{panic(err)};if err=output.Sync();err!=nil{panic(err)}
}
func single(value any)any{rows:=items(value);if len(rows)!=1{panic("Expected exactly one selected record")};return rows[0]}
func workflow() {
integration_event_id := positive_id(required("EXHIBITDAY_EVENT_ID"))
integration_job_id := required("EXHIBITDAY_JOB_ID")
integration_job_hash := journal_fingerprint(map[string]any{"job_id": integration_job_id})
integration_initial_name := concat("API integration check ", integration_job_hash)
integration_updated_name := concat(integration_initial_name, " updated")
integration_file := read_file_snapshot(required("EXHIBITDAY_FILE"), "upload")
integration_output_path := required("EXHIBITDAY_DOWNLOAD_PATH")
integration_cleanup := optional("EXHIBITDAY_TEST_CLEANUP", "keep")
require_condition(either(equal(integration_cleanup, "keep"), equal(integration_cleanup, "delete")), "Use keep or delete for EXHIBITDAY_TEST_CLEANUP.")
integration_workspace_response := call("workspace_binding", map[string]string{}, nil, "")
require_condition(equal(response_status(integration_workspace_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_workspace := integration_workspace_response.body
integration_workspace_id := positive_id(text(field(integration_workspace, "id")))
integration_state_path := required("EXHIBITDAY_TEST_STATE")
integration_job_mode := optional("EXHIBITDAY_JOB_MODE", "resume")
func() {
integration_job := open_journal(integration_state_path, "https://api.exhibitday.com/v1", integration_workspace_id, "integration-testing", integration_job_id, journal_fingerprint(map[string]any{"workflow_contract_sha256": "3808BE3DE866226BE6AAA4C445EBC19FC7903FD96FC8DC2F223F6D6451BA6267", "event_id": integration_event_id, "initial_name": integration_initial_name, "updated_name": integration_updated_name, "filename": file_name(integration_file), "file_length": file_length(integration_file), "file_sha256": file_sha256(integration_file)}), []any{[]any{"create", "POST", "/v1/tasks"}, []any{"edit", "PATCH", "/v1/tasks"}, []any{"stale", "PATCH", "/v1/tasks"}, []any{"upload", "POST", "/v1/tasks/attachments"}, []any{"remove_file", "DELETE", "/v1/tasks/attachments"}, []any{"remove_task", "DELETE", "/v1/tasks"}}, integration_job_mode)
defer integration_job.Close()
integration_task_id := ""
integration_attachment_id := ""
if not_value(journal_acknowledged(integration_job, "remove_task")) {
if not_value(journal_acknowledged(integration_job, "create")) {
integration_create_intent := journal_begin(integration_job, "create", "POST", "/v1/tasks", journal_fingerprint(map[string]any{"event_id": integration_event_id, "name": integration_initial_name}))
integration_created_response := call("create", map[string]string{}, map[string]any{"event_id": integration_event_id, "name": integration_initial_name}, text(field(integration_create_intent, "idempotency_key")))
require_condition(equal(response_status(integration_created_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_created := integration_created_response.body
integration_task_id = positive_id(text(field(integration_created, "id")))
require_condition(both(equal(text(field(integration_created, "id")), integration_task_id), both(equal(text(field(field(integration_created, "event"), "id")), integration_event_id), equal(text(field(integration_created, "name")), integration_initial_name))), "The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.")
journal_acknowledge(integration_job, "create", map[string]any{"task_id": integration_task_id, "event_id": integration_event_id, "name": integration_initial_name, "create_key": text(field(integration_create_intent, "idempotency_key"))})
}
integration_saved_create := journal_saved(integration_job, "create")
integration_task_id = positive_id(text(field(integration_saved_create, "task_id")))
require_condition(both(equal(text(field(integration_saved_create, "event_id")), integration_event_id), equal(text(field(integration_saved_create, "name")), integration_initial_name)), "Saved create state differs from this Event/job.")
require_condition(either(not_value(journal_acknowledged(integration_job, "remove_file")), equal(integration_cleanup, "delete")), "Cleanup already removed the test file. Continue with EXHIBITDAY_TEST_CLEANUP=delete to finish this Task cleanup.")
integration_before_response := call("read", map[string]string{"id": integration_task_id, "$include_record_revision": "true"}, nil, "")
require_condition(equal(response_status(integration_before_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_before := integration_before_response.body
if not_value(journal_acknowledged(integration_job, "edit")) {
require_condition(both(equal(text(field(integration_before, "id")), integration_task_id), both(equal(text(field(field(integration_before, "event"), "id")), integration_event_id), equal(text(field(integration_before, "name")), integration_initial_name))), "The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.")
integration_original_revision := text(field(integration_before, "record_revision"))
require_condition(is_present(integration_original_revision), "Read the actual created Task revision before editing.")
journal_begin(integration_job, "edit", "PATCH", "/v1/tasks", journal_fingerprint(map[string]any{"id": integration_task_id, "name": integration_updated_name, "expected_revision": integration_original_revision}))
integration_edit_response := call("edit", map[string]string{}, map[string]any{"id": integration_task_id, "name": integration_updated_name, "expected_revision": integration_original_revision}, "")
require_condition(equal(response_status(integration_edit_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_edit_receipt := integration_edit_response.body
integration_saved_revision := text(field(integration_edit_receipt, "record_revision"))
require_condition(both(is_present(integration_saved_revision), not_value(equal(integration_original_revision, integration_saved_revision))), "The distinct test name must produce a checked new revision before the stale test.")
journal_acknowledge(integration_job, "edit", map[string]any{"task_id": integration_task_id, "name": integration_updated_name, "original_revision": integration_original_revision, "record_revision": integration_saved_revision})
}
integration_saved_edit := journal_saved(integration_job, "edit")
require_condition(both(equal(text(field(integration_saved_edit, "task_id")), integration_task_id), equal(text(field(integration_saved_edit, "name")), integration_updated_name)), "Saved edit state differs from this Task/name.")
if not_value(journal_acknowledged(integration_job, "stale")) {
journal_begin(integration_job, "stale", "PATCH", "/v1/tasks", journal_fingerprint(map[string]any{"id": integration_task_id, "name": "Refused stale test", "expected_revision": text(field(integration_saved_edit, "original_revision"))}))
integration_stale_status := request_expect("stale", map[string]string{}, map[string]any{"id": integration_task_id, "name": "Refused stale test", "expected_revision": text(field(integration_saved_edit, "original_revision"))}, "", "409")
journal_acknowledge(integration_job, "stale", map[string]any{"task_id": integration_task_id, "observed_status": integration_stale_status})
}
integration_saved_stale := journal_saved(integration_job, "stale")
require_condition(both(equal(text(field(integration_saved_stale, "task_id")), integration_task_id), equal(text(field(integration_saved_stale, "observed_status")), "409")), "The saved conflict assertion differs from this Task/status.")
integration_after_edit_response := call("after_edit", map[string]string{"id": integration_task_id, "$include_record_revision": "true"}, nil, "")
require_condition(equal(response_status(integration_after_edit_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_after_edit := integration_after_edit_response.body
require_condition(both(equal(text(field(integration_after_edit, "id")), integration_task_id), both(equal(text(field(field(integration_after_edit, "event"), "id")), integration_event_id), equal(text(field(integration_after_edit, "name")), integration_updated_name))), "The saved test Task changed or belongs to another Event. Stop; do not create or overwrite another Task.")
require_condition(equal(text(field(integration_after_edit, "record_revision")), text(field(integration_saved_edit, "record_revision"))), "The test Task's revision changed; stop before file work or cleanup.")
require_condition(either(not_value(equal(integration_cleanup, "delete")), deep_equal(field(integration_after_edit, "comments"), []any{})), "The test Task has comments; stop before cleanup.")
if not_value(journal_acknowledged(integration_job, "upload")) {
require_condition(equal(text(field(integration_after_edit, "record_revision")), text(field(integration_saved_edit, "record_revision"))), "The Task changed after the conditional edit. Review it before uploading.")
integration_upload_intent := journal_begin(integration_job, "upload", "POST", "/v1/tasks/attachments", journal_fingerprint(map[string]any{"task_id": integration_task_id, "filename": file_name(integration_file), "file_length": file_length(integration_file), "file_sha256": file_sha256(integration_file)}))
integration_upload_response := request_upload("upload", map[string]string{"task_id": integration_task_id}, integration_file, text(field(integration_upload_intent, "idempotency_key")))
require_condition(equal(response_status(integration_upload_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_upload := integration_upload_response.body
require_condition(both(equal(text(field(integration_upload, "records_found")), "1"), both(equal(text(field(integration_upload, "total_records")), "1"), equal(field(integration_upload, "has_more"), false))), "Require exactly one complete uploaded-file receipt.")
integration_uploaded_file := single(field(integration_upload, "list_data"))
integration_attachment_id = positive_id(text(field(integration_uploaded_file, "id")))
require_condition(is_present(text(field(integration_uploaded_file, "filename"))), "The upload receipt needs its actual stored filename.")
journal_acknowledge(integration_job, "upload", map[string]any{"task_id": integration_task_id, "attachment_id": integration_attachment_id, "filename": text(field(integration_uploaded_file, "filename")), "attachment_json": json_string(integration_uploaded_file), "file_length": file_length(integration_file), "file_sha256": file_sha256(integration_file)})
}
integration_saved_upload := journal_saved(integration_job, "upload")
integration_attachment_id = positive_id(text(field(integration_saved_upload, "attachment_id")))
require_condition(both(equal(text(field(integration_saved_upload, "task_id")), integration_task_id), both(equal(text(field(integration_saved_upload, "file_length")), file_length(integration_file)), equal(text(field(integration_saved_upload, "file_sha256")), file_sha256(integration_file)))), "The confirmed file differs from the saved test Task or file details.")
if not_value(journal_acknowledged(integration_job, "remove_file")) {
integration_list_offset := "0"
integration_file_count := "0"
integration_file_found := false
integration_file_seen := new_id_set()
integration_list_query := map[string]string{"task_id": integration_task_id, "$limit": "25", "$offset": "0"}
for true {
integration_list_query["$offset"] = integration_list_offset
integration_list_response := call("verify_file", integration_list_query, nil, "")
require_condition(equal(response_status(integration_list_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
integration_list := integration_list_response.body
integration_list_rows := items(field(integration_list, "list_data"))
require_condition(equal(text(field(integration_list, "records_found")), text(count(integration_list_rows))), "The Task file page count differs from its rows.")
require_condition(is_present(text(field(integration_list, "total_records"))), "The Task file page needs total_records.")
require_condition(either(equal(field(integration_list, "has_more"), true), equal(field(integration_list, "has_more"), false)), "The Task file page needs Boolean has_more.")
for _, integration_list_row := range items(integration_list_rows) {
integration_list_id := positive_id(text(field(integration_list_row, "id")))
require_condition(remember_id(integration_file_seen, integration_list_id), "A Task file ID repeated while paging.")
if equal(integration_list_id, integration_attachment_id) {
require_condition(deep_equal(integration_list_row, parse_json(text(field(integration_saved_upload, "attachment_json")))), "The saved Task file details changed.")
integration_file_found = true
}
}
integration_file_count = add_offset(integration_file_count, count(integration_list_rows))
if equal(field(integration_list, "has_more"), false) {
break
}
require_condition(not_value(is_empty(integration_list_rows)), "An empty Task file page says has_more=true.")
integration_list_offset = add_offset(integration_list_offset, count(integration_list_rows))
}
require_condition(integration_file_found, "The saved file is not on this Task; stop before downloading by id or cleaning up.")
require_condition(either(not_value(equal(integration_cleanup, "delete")), equal(integration_file_count, "1")), "Another Task file exists; stop before deleting the test Task.")
integration_download_response := request_download("download", map[string]string{"id": integration_attachment_id})
save_checked_download(integration_download_response, integration_file, integration_output_path)
}
if equal(integration_cleanup, "delete") {
if not_value(journal_acknowledged(integration_job, "remove_file")) {
journal_begin(integration_job, "remove_file", "DELETE", "/v1/tasks/attachments", journal_fingerprint(map[string]any{"id": integration_attachment_id}))
integration_file_remove_response := call("remove_file", map[string]string{"id": integration_attachment_id}, nil, "")
require_condition(equal(response_status(integration_file_remove_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
journal_acknowledge(integration_job, "remove_file", map[string]any{"task_id": integration_task_id, "attachment_id": integration_attachment_id})
}
if not_value(journal_acknowledged(integration_job, "remove_task")) {
journal_begin(integration_job, "remove_task", "DELETE", "/v1/tasks", journal_fingerprint(map[string]any{"id": integration_task_id}))
integration_task_remove_response := call("remove_task", map[string]string{"id": integration_task_id}, nil, "")
require_condition(equal(response_status(integration_task_remove_response), "200"), "Expected the documented HTTP 200 response; stop and review any other outcome.")
journal_acknowledge(integration_job, "remove_task", map[string]any{"task_id": integration_task_id})
}
} else {
print_value(map[string]any{"task_id": integration_task_id, "attachment_id": integration_attachment_id, "cleanup": "kept"})
}
}
if journal_acknowledged(integration_job, "remove_task") {
integration_removed := journal_saved(integration_job, "remove_task")
integration_task_id = positive_id(text(field(integration_removed, "task_id")))
integration_missing_status := request_expect("verify_removed", map[string]string{"id": integration_task_id}, nil, "", "404")
print_value(map[string]any{"task_id": integration_task_id, "cleanup": "removed", "observed_missing_status": integration_missing_status})
}
}()
}
func header_key(value string)string{for _,ch:=range value{if ch<32||ch>126{panic("Use the API key as one ASCII header value without control characters")}};return value}
func main(){apiKey=header_key(required("EXHIBITDAY_API_KEY"));if err:=json.Unmarshal([]byte(specification),&spec);err!=nil{panic(err)};workflow()}
Example response
{
"id": 34567,
"exhibitday_url": "https://www.exhibitday.com/Workspace/TaskView/98765?tid=34567",
"event_task_section_id": null,
"event_task_section": "Uncategorized",
"display_rank": 1,
"name": "API integration check BCE394471E84081015B3CBC18C3E6DAFD6B8C490CA1F678D193666D1B7B7D66C",
"due_date": null,
"assignee": null,
"is_completed": false,
"task_completed_timestamp": null,
"task_completed_by": null,
"details": "",
"comments": [],
"event": {
"id": 12345,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=12345",
"name": "Spring Expo 2030",
"start_date": "2030-01-14",
"end_date": "2030-01-16",
"participation_type_id": 1,
"participation_type": "Committed",
"format_id": 1,
"format": "In-Person",
"event_created_timestamp": "2029-12-01T17:00:00Z",
"event_last_update_timestamp": "2030-01-02T17:00:00Z"
},
"task_created_by": {
"id": null,
"first_name": "ExhibitDay",
"last_name": "API",
"display_name": "ExhibitDay API",
"email": null,
"type": null,
"workspace_role": null,
"is_active": true
},
"task_created_timestamp": "2030-01-03T12:00:00Z",
"task_last_update_timestamp": "2030-01-03T12:00:00Z",
"integration_metadata_field_1": "",
"integration_metadata_field_2": "",
"integration_metadata_field_3": "",
"integration_metadata_field_4": "",
"integration_metadata_field_5": ""
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "This Idempotency-Key was already used with a different request. Use a new key for a new request.",
"error_code": "idempotency_key_reused",
"errors": [
"This Idempotency-Key was already used with a different request. Use a new key for a new request."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "Invalid value for the contributor_user_ids parameter. Each contributor must be a current workspace user who can be assigned tasks. You can get a list of users in your workspace from the /v1/references/users_and_resources endpoint.",
"error_code": "invalid_request",
"errors": [
"Invalid value for the contributor_user_ids parameter. Each contributor must be a current workspace user who can be assigned tasks. You can get a list of users in your workspace from the /v1/references/users_and_resources endpoint."
],
"error_params": [
"contributor_user_ids"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "Invalid value for the contributor_user_ids parameter. Send a JSON array of unique user IDs, for example [\"user-id\",\"other-user-id\"], or one user ID. Send null or [] to remove all contributors.",
"error_code": "invalid_request",
"errors": [
"Invalid value for the contributor_user_ids parameter. Send a JSON array of unique user IDs, for example [\"user-id\",\"other-user-id\"], or one user ID. Send null or [] to remove all contributors."
],
"error_params": [
"contributor_user_ids"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "A request with this Idempotency-Key is still being processed. Retry after a moment.",
"error_code": "idempotency_key_in_use",
"errors": [
"A request with this Idempotency-Key is still being processed. Retry after a moment."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "A previous request with this Idempotency-Key did not finish and its outcome is unknown, so this retry was not run to avoid creating a duplicate. Check whether the earlier request succeeded; to try again, use a new Idempotency-Key.",
"error_code": "idempotency_key_indeterminate",
"errors": [
"A previous request with this Idempotency-Key did not finish and its outcome is unknown, so this retry was not run to avoid creating a duplicate. Check whether the earlier request succeeded; to try again, use a new Idempotency-Key."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The saved response cannot be replayed safely.",
"error_code": "idempotency_key_indeterminate",
"errors": [
"The earlier request with this Idempotency-Key completed, but its saved response cannot be returned safely. This retry was not run and its key was not released. Look for the existing record with a GET; use a new Idempotency-Key only after checking whether another create is needed."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"We couldn't confirm whether the Task was saved. Before sending it again, look for it with GET /v1/tasks using filter_by_task_name_contains_text and, when applicable, filter_by_event_id. You can also filter by an integration metadata value you supplied. If you find it, do not send it again. If you need to retry, use the same Idempotency-Key if you supplied one. This request was not automatically retried."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Things to keep in mind
- The stale-revision check is deliberate. If it gives a different result, stop and inspect the test Task.
- Cleanup runs only after the checks and uses this run's saved IDs. The journal and downloaded file stay on your machine.
- Keep the cleanup choice and original file the same when you continue the same job. Review the test records before starting a different run.
If a run stops
- Keep the journal private. It records which changes the program attempted and confirmed.
- To continue a run with no unresolved save, use
EXHIBITDAY_JOB_MODE=resumewith the same job ID, journal path and inputs. - If a write has an uncertain outcome, check the affected records in ExhibitDay before making another change. The program stops and leaves the pending step in the journal.
- Run one copy per journal. If a crash leaves a
.lockfile, make sure no copy is running or can start with that journal before removing the lock file.