Wire cloud workflow and integration runtime defaults#136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
khaliqgant merged 8 commits into from
May 23, 2026
Merged

Wire cloud workflow and integration runtime defaults #136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
99eba9b
Wire cloud workflow and integration defaults
May 23, 2026
4712f1a
Align workflow invocation header
May 23, 2026
069b4ab
Harden workflow status polling
May 23, 2026
81e8e3d
Match workflow run status response
May 23, 2026
eeb06da
Retry transient workflow authorization errors
May 23, 2026
68ea4ae
Trim workflow status run ids
May 23, 2026
e288520
Document workflow 403 retry rationale
May 23, 2026
e84cf6c
Retry transient workflow authentication errors
May 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions packages/runtime/src/clients/github.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('github.comment writes a draft comment file under issues/<n>/comments/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.comment({ owner: 'o', repo: 'r', number: 2 }, 'hello');

const dir = path.join(root, 'github/repos/o/r/issues/2/comments');
Expand All@@ -29,7 +29,7 @@ test('github.comment writes a draft comment file under issues/<n>/comments/', as
test('github.createIssue writes a draft issue file under issues/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({
owner: 'o',
repo: 'r',
Expand All@@ -55,7 +55,7 @@ test('github.createIssue writes a draft issue file under issues/', async () => {
test('github.createPullRequest writes a draft pull request file under pulls/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createPullRequest({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -97,7 +97,7 @@ test('github.upsertIssue updates an existing flat issue match', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -130,7 +130,7 @@ test('github.upsertIssue ignores a closed issue title match', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand All@@ -153,7 +153,7 @@ test('github.upsertIssue ignores a closed issue title match', async () => {
test('github.upsertIssue creates a draft when no open match exists', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -188,7 +188,7 @@ test('github.getPr reads meta + diff from canonical paths', async () => {
);
await writeFile(path.join(pullRoot, 'diff.patch'), 'diff --git a/x b/x\n');

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const pr = await client.getPr({ owner: 'o', repo: 'r', number: 42 });
assert.equal(pr.title, 'Add deploy v1');
assert.equal(pr.head, 'feature');
Expand DownExpand Up@@ -217,7 +217,7 @@ test('github.getPr reads a flat canonical pull request file', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const pr = await client.getPr({ owner: 'o', repo: 'r', number: 42 });
assert.equal(pr.title, 'Add deploy v1');
assert.equal(pr.head, 'feature');
Expand All@@ -232,7 +232,7 @@ test('github.getPr reads a flat canonical pull request file', async () => {
test('github.postReview writes a review draft under pulls/<n>/reviews/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.postReview(
{ owner: 'o', repo: 'r', number: 42 },
{
Expand All@@ -256,7 +256,7 @@ test('github.postReview writes a review draft under pulls/<n>/reviews/', async (
test('github.postReview accepts COMMENT/APPROVE/REQUEST_CHANGES events', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
for (const event of ['COMMENT', 'APPROVE', 'REQUEST_CHANGES'] as const) {
await client.postReview({ owner: 'o', repo: 'r', number: event === 'COMMENT' ? 1 : event === 'APPROVE' ? 2 : 3 }, {
body: event.toLowerCase(),
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/jira.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('jira createIssue writes a Jira issue draft', async () => {
const root = await tempMount();
try {
const client = createJiraClient({ relayfileMountRoot: root });
const client = createJiraClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({
cloudId: 'cloud_1',
fields: { project: { key: 'ENG' }, summary: 'Ship it', issuetype: { name: 'Task' } }
Expand All@@ -33,7 +33,7 @@ test('jira createIssue writes a Jira issue draft', async () => {
test('jira transition writes an issue transition draft', async () => {
const root = await tempMount();
try {
const client = createJiraClient({ relayfileMountRoot: root });
const client = createJiraClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.transition({ cloudId: 'cloud_1', issueIdOrKey: 'ENG-1' }, '31');

const dir = path.join(root, 'jira/issues/ENG-1/transitions');
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/linear.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('linear createIssue writes an issue draft', async () => {
const root = await tempMount();
try {
const client = createLinearClient({ relayfileMountRoot: root });
const client = createLinearClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({ teamId: 'team_1', title: 'Ship it', description: 'Soon' });

const dir = path.join(root, 'linear/issues');
Expand All@@ -38,7 +38,7 @@ test('linear getIssue reads a canonical issue file', async () => {
JSON.stringify({ id: 'i1', identifier: 'ENG-1', title: 'Ship it', description: null, url: 'https://linear.app/i1', state: null })
);

const client = createLinearClient({ relayfileMountRoot: root });
const client = createLinearClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
assert.equal((await client.getIssue('ENG-1')).identifier, 'ENG-1');
} finally {
await rm(root, { recursive: true, force: true });
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/notion.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('notion createPage writes a database page draft', async () => {
const root = await tempMount();
try {
const client = createNotionClient({ relayfileMountRoot: root });
const client = createNotionClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createPage(
{ database_id: 'db_1' },
{ Name: { title: [{ text: { content: 'Digest' } }] } },
Expand All@@ -32,7 +32,7 @@ test('notion createPage writes a database page draft', async () => {
});

test('notion createPage requires a database parent for file writeback', async () => {
const client = createNotionClient({ relayfileMountRoot: '/tmp/unused' });
const client = createNotionClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.createPage({}, {}, []),
/parent\.database_id/
Expand Down
15 changes: 8 additions & 7 deletions packages/runtime/src/clients/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,8 +16,8 @@ import { WorkforceIntegrationError } from '../errors.js';
*
* The handler-side ergonomics stay identical to the direct-REST shape
* — `await ctx.github.comment(target, body)` returns when the write
* lands. Whether the receipt is awaited synchronously, polled, or
* fired-and-forgotten depends on `writebackTimeoutMs`.
* lands and, by default, waits briefly for the provider receipt.
* Setting `writebackTimeoutMs` to `0` keeps fire-and-forget behavior.
*/
export interface IntegrationClientOptions {
/** Absolute path to the Relayfile mount the handler is running in. */
Expand All@@ -30,9 +30,8 @@ export interface IntegrationClientOptions {
workspaceCwd?: string;
/**
* Max wait, in ms, for the Relayfile writeback worker to emit a
* receipt onto the just-written draft. `0` (default) means
* fire-and-forget — the client returns immediately and the receipt
* is whatever was readable at write time.
* receipt onto the just-written draft. Defaults to 3000ms. `0` means
* fire-and-forget — the client returns immediately without a receipt.
*/
writebackTimeoutMs?: number;
/** Poll interval while waiting for a receipt. Default 250ms. */
Expand DownExpand Up@@ -71,6 +70,8 @@ export interface WritebackResult {
receipt?: WritebackReceipt;
}

const DEFAULT_WRITEBACK_TIMEOUT_MS = 3_000;

function isRecord(value: unknown): value is Record<string, unknown> {
return typeof value === 'object' && value !== null && !Array.isArray(value);
}
Expand DownExpand Up@@ -196,7 +197,7 @@ function isNoEntryError(error: unknown): boolean {
/**
* Write a draft JSON payload atomically (write-then-rename) so the
* writeback worker never sees a partial file. Waits for a receipt
* when `writebackTimeoutMs > 0`; otherwise returns immediately.
* by default; pass `writebackTimeoutMs: 0` to return immediately.
*/
export async function writeJsonFile(
client: IntegrationClientOptions,
Expand All@@ -222,7 +223,7 @@ async function waitForReceipt(
absolutePath: string,
client: IntegrationClientOptions
): Promise<WritebackReceipt | undefined> {
const timeoutMs = client.writebackTimeoutMs ?? 0;
const timeoutMs = client.writebackTimeoutMs ?? DEFAULT_WRITEBACK_TIMEOUT_MS;
// Fire-and-forget: never reinterpret the just-written draft as a
// receipt. The draft payload may legitimately carry top-level `id` /
// `path` / `created` fields (e.g. an upsert update writing back the
Expand Down
39 changes: 34 additions & 5 deletions packages/runtime/src/clients/slack.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import test from 'node:test';
import assert from 'node:assert/strict';
import { mkdtemp, readFile, readdir, rm } from 'node:fs/promises';
import { mkdtemp, readFile, readdir, rm, writeFile } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import path from 'node:path';
import { WorkforceIntegrationError } from '../errors.js';
Expand All@@ -13,7 +13,7 @@ async function tempMount(): Promise<string> {
test('slack post writes a channel message draft', async () => {
const root = await tempMount();
try {
const client = createSlackClient({ relayfileMountRoot: root });
const client = createSlackClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.post('C123', 'hello');

const dir = path.join(root, 'slack/channels/C123/messages');
Expand All@@ -27,10 +27,39 @@ test('slack post writes a channel message draft', async () => {
}
});

test('slack post waits for the writeback receipt by default', async () => {
const root = await tempMount();
const dir = path.join(root, 'slack/channels/C123/messages');
let timer: NodeJS.Timeout | undefined;
try {
const client = createSlackClient({ relayfileMountRoot: root, writebackPollMs: 10 });
timer = setInterval(() => {
void readdir(dir)
.then(async (files) => {
const file = files.find((name) => name.endsWith('.json'));
if (!file) return;
await writeFile(
path.join(dir, file),
JSON.stringify({ created: '1716490000.123456', url: 'https://slack.example/C123/p1716490000123456' }),
'utf8'
);
if (timer) clearInterval(timer);
})
.catch(() => undefined);
}, 10);

const result = await client.post('C123', 'hello');
assert.equal(result.ts, '1716490000.123456');
} finally {
if (timer) clearInterval(timer);
await rm(root, { recursive: true, force: true });
}
});

test('slack dm writes a user direct-message draft', async () => {
const root = await tempMount();
try {
const client = createSlackClient({ relayfileMountRoot: root });
const client = createSlackClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.dm('U123', 'ping');

const dir = path.join(root, 'slack/users/U123/messages');
Expand All@@ -45,15 +74,15 @@ test('slack dm writes a user direct-message draft', async () => {
});

test('slack reply rejects malformed string thread refs', async () => {
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused' });
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.reply('missing-ts', 'hello'),
(error) => error instanceof WorkforceIntegrationError && error.provider === 'slack'
);
});

test('slack reply rejects malformed object thread refs', async () => {
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused' });
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.reply({ channel: '', ts: '123.456' }, 'hello'),
(error) => error instanceof WorkforceIntegrationError && error.provider === 'slack'
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks"); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Wire cloud workflow and integration runtime defaults#136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
khaliqgant merged 8 commits into from
May 23, 2026
Merged

Wire cloud workflow and integration runtime defaults #136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
99eba9b
Wire cloud workflow and integration defaults
May 23, 2026
4712f1a
Align workflow invocation header
May 23, 2026
069b4ab
Harden workflow status polling
May 23, 2026
81e8e3d
Match workflow run status response
May 23, 2026
eeb06da
Retry transient workflow authorization errors
May 23, 2026
68ea4ae
Trim workflow status run ids
May 23, 2026
e288520
Document workflow 403 retry rationale
May 23, 2026
e84cf6c
Retry transient workflow authentication errors
May 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions packages/runtime/src/clients/github.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('github.comment writes a draft comment file under issues/<n>/comments/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.comment({ owner: 'o', repo: 'r', number: 2 }, 'hello');

const dir = path.join(root, 'github/repos/o/r/issues/2/comments');
Expand All@@ -29,7 +29,7 @@ test('github.comment writes a draft comment file under issues/<n>/comments/', as
test('github.createIssue writes a draft issue file under issues/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({
owner: 'o',
repo: 'r',
Expand All@@ -55,7 +55,7 @@ test('github.createIssue writes a draft issue file under issues/', async () => {
test('github.createPullRequest writes a draft pull request file under pulls/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createPullRequest({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -97,7 +97,7 @@ test('github.upsertIssue updates an existing flat issue match', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -130,7 +130,7 @@ test('github.upsertIssue ignores a closed issue title match', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand All@@ -153,7 +153,7 @@ test('github.upsertIssue ignores a closed issue title match', async () => {
test('github.upsertIssue creates a draft when no open match exists', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -188,7 +188,7 @@ test('github.getPr reads meta + diff from canonical paths', async () => {
);
await writeFile(path.join(pullRoot, 'diff.patch'), 'diff --git a/x b/x\n');

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const pr = await client.getPr({ owner: 'o', repo: 'r', number: 42 });
assert.equal(pr.title, 'Add deploy v1');
assert.equal(pr.head, 'feature');
Expand DownExpand Up@@ -217,7 +217,7 @@ test('github.getPr reads a flat canonical pull request file', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const pr = await client.getPr({ owner: 'o', repo: 'r', number: 42 });
assert.equal(pr.title, 'Add deploy v1');
assert.equal(pr.head, 'feature');
Expand All@@ -232,7 +232,7 @@ test('github.getPr reads a flat canonical pull request file', async () => {
test('github.postReview writes a review draft under pulls/<n>/reviews/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.postReview(
{ owner: 'o', repo: 'r', number: 42 },
{
Expand All@@ -256,7 +256,7 @@ test('github.postReview writes a review draft under pulls/<n>/reviews/', async (
test('github.postReview accepts COMMENT/APPROVE/REQUEST_CHANGES events', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
for (const event of ['COMMENT', 'APPROVE', 'REQUEST_CHANGES'] as const) {
await client.postReview({ owner: 'o', repo: 'r', number: event === 'COMMENT' ? 1 : event === 'APPROVE' ? 2 : 3 }, {
body: event.toLowerCase(),
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/jira.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('jira createIssue writes a Jira issue draft', async () => {
const root = await tempMount();
try {
const client = createJiraClient({ relayfileMountRoot: root });
const client = createJiraClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({
cloudId: 'cloud_1',
fields: { project: { key: 'ENG' }, summary: 'Ship it', issuetype: { name: 'Task' } }
Expand All@@ -33,7 +33,7 @@ test('jira createIssue writes a Jira issue draft', async () => {
test('jira transition writes an issue transition draft', async () => {
const root = await tempMount();
try {
const client = createJiraClient({ relayfileMountRoot: root });
const client = createJiraClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.transition({ cloudId: 'cloud_1', issueIdOrKey: 'ENG-1' }, '31');

const dir = path.join(root, 'jira/issues/ENG-1/transitions');
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/linear.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('linear createIssue writes an issue draft', async () => {
const root = await tempMount();
try {
const client = createLinearClient({ relayfileMountRoot: root });
const client = createLinearClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({ teamId: 'team_1', title: 'Ship it', description: 'Soon' });

const dir = path.join(root, 'linear/issues');
Expand All@@ -38,7 +38,7 @@ test('linear getIssue reads a canonical issue file', async () => {
JSON.stringify({ id: 'i1', identifier: 'ENG-1', title: 'Ship it', description: null, url: 'https://linear.app/i1', state: null })
);

const client = createLinearClient({ relayfileMountRoot: root });
const client = createLinearClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
assert.equal((await client.getIssue('ENG-1')).identifier, 'ENG-1');
} finally {
await rm(root, { recursive: true, force: true });
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/notion.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('notion createPage writes a database page draft', async () => {
const root = await tempMount();
try {
const client = createNotionClient({ relayfileMountRoot: root });
const client = createNotionClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createPage(
{ database_id: 'db_1' },
{ Name: { title: [{ text: { content: 'Digest' } }] } },
Expand All@@ -32,7 +32,7 @@ test('notion createPage writes a database page draft', async () => {
});

test('notion createPage requires a database parent for file writeback', async () => {
const client = createNotionClient({ relayfileMountRoot: '/tmp/unused' });
const client = createNotionClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.createPage({}, {}, []),
/parent\.database_id/
Expand Down
15 changes: 8 additions & 7 deletions packages/runtime/src/clients/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,8 +16,8 @@ import { WorkforceIntegrationError } from '../errors.js';
*
* The handler-side ergonomics stay identical to the direct-REST shape
* — `await ctx.github.comment(target, body)` returns when the write
* lands. Whether the receipt is awaited synchronously, polled, or
* fired-and-forgotten depends on `writebackTimeoutMs`.
* lands and, by default, waits briefly for the provider receipt.
* Setting `writebackTimeoutMs` to `0` keeps fire-and-forget behavior.
*/
export interface IntegrationClientOptions {
/** Absolute path to the Relayfile mount the handler is running in. */
Expand All@@ -30,9 +30,8 @@ export interface IntegrationClientOptions {
workspaceCwd?: string;
/**
* Max wait, in ms, for the Relayfile writeback worker to emit a
* receipt onto the just-written draft. `0` (default) means
* fire-and-forget — the client returns immediately and the receipt
* is whatever was readable at write time.
* receipt onto the just-written draft. Defaults to 3000ms. `0` means
* fire-and-forget — the client returns immediately without a receipt.
*/
writebackTimeoutMs?: number;
/** Poll interval while waiting for a receipt. Default 250ms. */
Expand DownExpand Up@@ -71,6 +70,8 @@ export interface WritebackResult {
receipt?: WritebackReceipt;
}

const DEFAULT_WRITEBACK_TIMEOUT_MS = 3_000;

function isRecord(value: unknown): value is Record<string, unknown> {
return typeof value === 'object' && value !== null && !Array.isArray(value);
}
Expand DownExpand Up@@ -196,7 +197,7 @@ function isNoEntryError(error: unknown): boolean {
/**
* Write a draft JSON payload atomically (write-then-rename) so the
* writeback worker never sees a partial file. Waits for a receipt
* when `writebackTimeoutMs > 0`; otherwise returns immediately.
* by default; pass `writebackTimeoutMs: 0` to return immediately.
*/
export async function writeJsonFile(
client: IntegrationClientOptions,
Expand All@@ -222,7 +223,7 @@ async function waitForReceipt(
absolutePath: string,
client: IntegrationClientOptions
): Promise<WritebackReceipt | undefined> {
const timeoutMs = client.writebackTimeoutMs ?? 0;
const timeoutMs = client.writebackTimeoutMs ?? DEFAULT_WRITEBACK_TIMEOUT_MS;
// Fire-and-forget: never reinterpret the just-written draft as a
// receipt. The draft payload may legitimately carry top-level `id` /
// `path` / `created` fields (e.g. an upsert update writing back the
Expand Down
39 changes: 34 additions & 5 deletions packages/runtime/src/clients/slack.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import test from 'node:test';
import assert from 'node:assert/strict';
import { mkdtemp, readFile, readdir, rm } from 'node:fs/promises';
import { mkdtemp, readFile, readdir, rm, writeFile } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import path from 'node:path';
import { WorkforceIntegrationError } from '../errors.js';
Expand All@@ -13,7 +13,7 @@ async function tempMount(): Promise<string> {
test('slack post writes a channel message draft', async () => {
const root = await tempMount();
try {
const client = createSlackClient({ relayfileMountRoot: root });
const client = createSlackClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.post('C123', 'hello');

const dir = path.join(root, 'slack/channels/C123/messages');
Expand All@@ -27,10 +27,39 @@ test('slack post writes a channel message draft', async () => {
}
});

test('slack post waits for the writeback receipt by default', async () => {
const root = await tempMount();
const dir = path.join(root, 'slack/channels/C123/messages');
let timer: NodeJS.Timeout | undefined;
try {
const client = createSlackClient({ relayfileMountRoot: root, writebackPollMs: 10 });
timer = setInterval(() => {
void readdir(dir)
.then(async (files) => {
const file = files.find((name) => name.endsWith('.json'));
if (!file) return;
await writeFile(
path.join(dir, file),
JSON.stringify({ created: '1716490000.123456', url: 'https://slack.example/C123/p1716490000123456' }),
'utf8'
);
if (timer) clearInterval(timer);
})
.catch(() => undefined);
}, 10);

const result = await client.post('C123', 'hello');
assert.equal(result.ts, '1716490000.123456');
} finally {
if (timer) clearInterval(timer);
await rm(root, { recursive: true, force: true });
}
});

test('slack dm writes a user direct-message draft', async () => {
const root = await tempMount();
try {
const client = createSlackClient({ relayfileMountRoot: root });
const client = createSlackClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.dm('U123', 'ping');

const dir = path.join(root, 'slack/users/U123/messages');
Expand All@@ -45,15 +74,15 @@ test('slack dm writes a user direct-message draft', async () => {
});

test('slack reply rejects malformed string thread refs', async () => {
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused' });
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.reply('missing-ts', 'hello'),
(error) => error instanceof WorkforceIntegrationError && error.provider === 'slack'
);
});

test('slack reply rejects malformed object thread refs', async () => {
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused' });
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.reply({ channel: '', ts: '123.456' }, 'hello'),
(error) => error instanceof WorkforceIntegrationError && error.provider === 'slack'
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Wire cloud workflow and integration runtime defaults#136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
khaliqgant merged 8 commits into from
May 23, 2026
Merged

Wire cloud workflow and integration runtime defaults #136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
99eba9b
Wire cloud workflow and integration defaults
May 23, 2026
4712f1a
Align workflow invocation header
May 23, 2026
069b4ab
Harden workflow status polling
May 23, 2026
81e8e3d
Match workflow run status response
May 23, 2026
eeb06da
Retry transient workflow authorization errors
May 23, 2026
68ea4ae
Trim workflow status run ids
May 23, 2026
e288520
Document workflow 403 retry rationale
May 23, 2026
e84cf6c
Retry transient workflow authentication errors
May 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions packages/runtime/src/clients/github.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('github.comment writes a draft comment file under issues/<n>/comments/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.comment({ owner: 'o', repo: 'r', number: 2 }, 'hello');

const dir = path.join(root, 'github/repos/o/r/issues/2/comments');
Expand All@@ -29,7 +29,7 @@ test('github.comment writes a draft comment file under issues/<n>/comments/', as
test('github.createIssue writes a draft issue file under issues/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({
owner: 'o',
repo: 'r',
Expand All@@ -55,7 +55,7 @@ test('github.createIssue writes a draft issue file under issues/', async () => {
test('github.createPullRequest writes a draft pull request file under pulls/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createPullRequest({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -97,7 +97,7 @@ test('github.upsertIssue updates an existing flat issue match', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -130,7 +130,7 @@ test('github.upsertIssue ignores a closed issue title match', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand All@@ -153,7 +153,7 @@ test('github.upsertIssue ignores a closed issue title match', async () => {
test('github.upsertIssue creates a draft when no open match exists', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -188,7 +188,7 @@ test('github.getPr reads meta + diff from canonical paths', async () => {
);
await writeFile(path.join(pullRoot, 'diff.patch'), 'diff --git a/x b/x\n');

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const pr = await client.getPr({ owner: 'o', repo: 'r', number: 42 });
assert.equal(pr.title, 'Add deploy v1');
assert.equal(pr.head, 'feature');
Expand DownExpand Up@@ -217,7 +217,7 @@ test('github.getPr reads a flat canonical pull request file', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const pr = await client.getPr({ owner: 'o', repo: 'r', number: 42 });
assert.equal(pr.title, 'Add deploy v1');
assert.equal(pr.head, 'feature');
Expand All@@ -232,7 +232,7 @@ test('github.getPr reads a flat canonical pull request file', async () => {
test('github.postReview writes a review draft under pulls/<n>/reviews/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.postReview(
{ owner: 'o', repo: 'r', number: 42 },
{
Expand All@@ -256,7 +256,7 @@ test('github.postReview writes a review draft under pulls/<n>/reviews/', async (
test('github.postReview accepts COMMENT/APPROVE/REQUEST_CHANGES events', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
for (const event of ['COMMENT', 'APPROVE', 'REQUEST_CHANGES'] as const) {
await client.postReview({ owner: 'o', repo: 'r', number: event === 'COMMENT' ? 1 : event === 'APPROVE' ? 2 : 3 }, {
body: event.toLowerCase(),
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/jira.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('jira createIssue writes a Jira issue draft', async () => {
const root = await tempMount();
try {
const client = createJiraClient({ relayfileMountRoot: root });
const client = createJiraClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({
cloudId: 'cloud_1',
fields: { project: { key: 'ENG' }, summary: 'Ship it', issuetype: { name: 'Task' } }
Expand All@@ -33,7 +33,7 @@ test('jira createIssue writes a Jira issue draft', async () => {
test('jira transition writes an issue transition draft', async () => {
const root = await tempMount();
try {
const client = createJiraClient({ relayfileMountRoot: root });
const client = createJiraClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.transition({ cloudId: 'cloud_1', issueIdOrKey: 'ENG-1' }, '31');

const dir = path.join(root, 'jira/issues/ENG-1/transitions');
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/linear.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('linear createIssue writes an issue draft', async () => {
const root = await tempMount();
try {
const client = createLinearClient({ relayfileMountRoot: root });
const client = createLinearClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({ teamId: 'team_1', title: 'Ship it', description: 'Soon' });

const dir = path.join(root, 'linear/issues');
Expand All@@ -38,7 +38,7 @@ test('linear getIssue reads a canonical issue file', async () => {
JSON.stringify({ id: 'i1', identifier: 'ENG-1', title: 'Ship it', description: null, url: 'https://linear.app/i1', state: null })
);

const client = createLinearClient({ relayfileMountRoot: root });
const client = createLinearClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
assert.equal((await client.getIssue('ENG-1')).identifier, 'ENG-1');
} finally {
await rm(root, { recursive: true, force: true });
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/notion.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('notion createPage writes a database page draft', async () => {
const root = await tempMount();
try {
const client = createNotionClient({ relayfileMountRoot: root });
const client = createNotionClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createPage(
{ database_id: 'db_1' },
{ Name: { title: [{ text: { content: 'Digest' } }] } },
Expand All@@ -32,7 +32,7 @@ test('notion createPage writes a database page draft', async () => {
});

test('notion createPage requires a database parent for file writeback', async () => {
const client = createNotionClient({ relayfileMountRoot: '/tmp/unused' });
const client = createNotionClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.createPage({}, {}, []),
/parent\.database_id/
Expand Down
15 changes: 8 additions & 7 deletions packages/runtime/src/clients/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,8 +16,8 @@ import { WorkforceIntegrationError } from '../errors.js';
*
* The handler-side ergonomics stay identical to the direct-REST shape
* — `await ctx.github.comment(target, body)` returns when the write
* lands. Whether the receipt is awaited synchronously, polled, or
* fired-and-forgotten depends on `writebackTimeoutMs`.
* lands and, by default, waits briefly for the provider receipt.
* Setting `writebackTimeoutMs` to `0` keeps fire-and-forget behavior.
*/
export interface IntegrationClientOptions {
/** Absolute path to the Relayfile mount the handler is running in. */
Expand All@@ -30,9 +30,8 @@ export interface IntegrationClientOptions {
workspaceCwd?: string;
/**
* Max wait, in ms, for the Relayfile writeback worker to emit a
* receipt onto the just-written draft. `0` (default) means
* fire-and-forget — the client returns immediately and the receipt
* is whatever was readable at write time.
* receipt onto the just-written draft. Defaults to 3000ms. `0` means
* fire-and-forget — the client returns immediately without a receipt.
*/
writebackTimeoutMs?: number;
/** Poll interval while waiting for a receipt. Default 250ms. */
Expand DownExpand Up@@ -71,6 +70,8 @@ export interface WritebackResult {
receipt?: WritebackReceipt;
}

const DEFAULT_WRITEBACK_TIMEOUT_MS = 3_000;

function isRecord(value: unknown): value is Record<string, unknown> {
return typeof value === 'object' && value !== null && !Array.isArray(value);
}
Expand DownExpand Up@@ -196,7 +197,7 @@ function isNoEntryError(error: unknown): boolean {
/**
* Write a draft JSON payload atomically (write-then-rename) so the
* writeback worker never sees a partial file. Waits for a receipt
* when `writebackTimeoutMs > 0`; otherwise returns immediately.
* by default; pass `writebackTimeoutMs: 0` to return immediately.
*/
export async function writeJsonFile(
client: IntegrationClientOptions,
Expand All@@ -222,7 +223,7 @@ async function waitForReceipt(
absolutePath: string,
client: IntegrationClientOptions
): Promise<WritebackReceipt | undefined> {
const timeoutMs = client.writebackTimeoutMs ?? 0;
const timeoutMs = client.writebackTimeoutMs ?? DEFAULT_WRITEBACK_TIMEOUT_MS;
// Fire-and-forget: never reinterpret the just-written draft as a
// receipt. The draft payload may legitimately carry top-level `id` /
// `path` / `created` fields (e.g. an upsert update writing back the
Expand Down
39 changes: 34 additions & 5 deletions packages/runtime/src/clients/slack.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import test from 'node:test';
import assert from 'node:assert/strict';
import { mkdtemp, readFile, readdir, rm } from 'node:fs/promises';
import { mkdtemp, readFile, readdir, rm, writeFile } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import path from 'node:path';
import { WorkforceIntegrationError } from '../errors.js';
Expand All@@ -13,7 +13,7 @@ async function tempMount(): Promise<string> {
test('slack post writes a channel message draft', async () => {
const root = await tempMount();
try {
const client = createSlackClient({ relayfileMountRoot: root });
const client = createSlackClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.post('C123', 'hello');

const dir = path.join(root, 'slack/channels/C123/messages');
Expand All@@ -27,10 +27,39 @@ test('slack post writes a channel message draft', async () => {
}
});

test('slack post waits for the writeback receipt by default', async () => {
const root = await tempMount();
const dir = path.join(root, 'slack/channels/C123/messages');
let timer: NodeJS.Timeout | undefined;
try {
const client = createSlackClient({ relayfileMountRoot: root, writebackPollMs: 10 });
timer = setInterval(() => {
void readdir(dir)
.then(async (files) => {
const file = files.find((name) => name.endsWith('.json'));
if (!file) return;
await writeFile(
path.join(dir, file),
JSON.stringify({ created: '1716490000.123456', url: 'https://slack.example/C123/p1716490000123456' }),
'utf8'
);
if (timer) clearInterval(timer);
})
.catch(() => undefined);
}, 10);

const result = await client.post('C123', 'hello');
assert.equal(result.ts, '1716490000.123456');
} finally {
if (timer) clearInterval(timer);
await rm(root, { recursive: true, force: true });
}
});

test('slack dm writes a user direct-message draft', async () => {
const root = await tempMount();
try {
const client = createSlackClient({ relayfileMountRoot: root });
const client = createSlackClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.dm('U123', 'ping');

const dir = path.join(root, 'slack/users/U123/messages');
Expand All@@ -45,15 +74,15 @@ test('slack dm writes a user direct-message draft', async () => {
});

test('slack reply rejects malformed string thread refs', async () => {
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused' });
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.reply('missing-ts', 'hello'),
(error) => error instanceof WorkforceIntegrationError && error.provider === 'slack'
);
});

test('slack reply rejects malformed object thread refs', async () => {
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused' });
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.reply({ channel: '', ts: '123.456' }, 'hello'),
(error) => error instanceof WorkforceIntegrationError && error.provider === 'slack'
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \u003e 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Wire cloud workflow and integration runtime defaults#136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
khaliqgant merged 8 commits into from
May 23, 2026
Merged

Wire cloud workflow and integration runtime defaults #136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
99eba9b
Wire cloud workflow and integration defaults
May 23, 2026
4712f1a
Align workflow invocation header
May 23, 2026
069b4ab
Harden workflow status polling
May 23, 2026
81e8e3d
Match workflow run status response
May 23, 2026
eeb06da
Retry transient workflow authorization errors
May 23, 2026
68ea4ae
Trim workflow status run ids
May 23, 2026
e288520
Document workflow 403 retry rationale
May 23, 2026
e84cf6c
Retry transient workflow authentication errors
May 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions packages/runtime/src/clients/github.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('github.comment writes a draft comment file under issues/<n>/comments/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.comment({ owner: 'o', repo: 'r', number: 2 }, 'hello');

const dir = path.join(root, 'github/repos/o/r/issues/2/comments');
Expand All@@ -29,7 +29,7 @@ test('github.comment writes a draft comment file under issues/<n>/comments/', as
test('github.createIssue writes a draft issue file under issues/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({
owner: 'o',
repo: 'r',
Expand All@@ -55,7 +55,7 @@ test('github.createIssue writes a draft issue file under issues/', async () => {
test('github.createPullRequest writes a draft pull request file under pulls/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createPullRequest({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -97,7 +97,7 @@ test('github.upsertIssue updates an existing flat issue match', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -130,7 +130,7 @@ test('github.upsertIssue ignores a closed issue title match', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand All@@ -153,7 +153,7 @@ test('github.upsertIssue ignores a closed issue title match', async () => {
test('github.upsertIssue creates a draft when no open match exists', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -188,7 +188,7 @@ test('github.getPr reads meta + diff from canonical paths', async () => {
);
await writeFile(path.join(pullRoot, 'diff.patch'), 'diff --git a/x b/x\n');

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const pr = await client.getPr({ owner: 'o', repo: 'r', number: 42 });
assert.equal(pr.title, 'Add deploy v1');
assert.equal(pr.head, 'feature');
Expand DownExpand Up@@ -217,7 +217,7 @@ test('github.getPr reads a flat canonical pull request file', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const pr = await client.getPr({ owner: 'o', repo: 'r', number: 42 });
assert.equal(pr.title, 'Add deploy v1');
assert.equal(pr.head, 'feature');
Expand All@@ -232,7 +232,7 @@ test('github.getPr reads a flat canonical pull request file', async () => {
test('github.postReview writes a review draft under pulls/<n>/reviews/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.postReview(
{ owner: 'o', repo: 'r', number: 42 },
{
Expand All@@ -256,7 +256,7 @@ test('github.postReview writes a review draft under pulls/<n>/reviews/', async (
test('github.postReview accepts COMMENT/APPROVE/REQUEST_CHANGES events', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
for (const event of ['COMMENT', 'APPROVE', 'REQUEST_CHANGES'] as const) {
await client.postReview({ owner: 'o', repo: 'r', number: event === 'COMMENT' ? 1 : event === 'APPROVE' ? 2 : 3 }, {
body: event.toLowerCase(),
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/jira.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('jira createIssue writes a Jira issue draft', async () => {
const root = await tempMount();
try {
const client = createJiraClient({ relayfileMountRoot: root });
const client = createJiraClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({
cloudId: 'cloud_1',
fields: { project: { key: 'ENG' }, summary: 'Ship it', issuetype: { name: 'Task' } }
Expand All@@ -33,7 +33,7 @@ test('jira createIssue writes a Jira issue draft', async () => {
test('jira transition writes an issue transition draft', async () => {
const root = await tempMount();
try {
const client = createJiraClient({ relayfileMountRoot: root });
const client = createJiraClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.transition({ cloudId: 'cloud_1', issueIdOrKey: 'ENG-1' }, '31');

const dir = path.join(root, 'jira/issues/ENG-1/transitions');
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/linear.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('linear createIssue writes an issue draft', async () => {
const root = await tempMount();
try {
const client = createLinearClient({ relayfileMountRoot: root });
const client = createLinearClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({ teamId: 'team_1', title: 'Ship it', description: 'Soon' });

const dir = path.join(root, 'linear/issues');
Expand All@@ -38,7 +38,7 @@ test('linear getIssue reads a canonical issue file', async () => {
JSON.stringify({ id: 'i1', identifier: 'ENG-1', title: 'Ship it', description: null, url: 'https://linear.app/i1', state: null })
);

const client = createLinearClient({ relayfileMountRoot: root });
const client = createLinearClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
assert.equal((await client.getIssue('ENG-1')).identifier, 'ENG-1');
} finally {
await rm(root, { recursive: true, force: true });
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/notion.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('notion createPage writes a database page draft', async () => {
const root = await tempMount();
try {
const client = createNotionClient({ relayfileMountRoot: root });
const client = createNotionClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createPage(
{ database_id: 'db_1' },
{ Name: { title: [{ text: { content: 'Digest' } }] } },
Expand All@@ -32,7 +32,7 @@ test('notion createPage writes a database page draft', async () => {
});

test('notion createPage requires a database parent for file writeback', async () => {
const client = createNotionClient({ relayfileMountRoot: '/tmp/unused' });
const client = createNotionClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.createPage({}, {}, []),
/parent\.database_id/
Expand Down
15 changes: 8 additions & 7 deletions packages/runtime/src/clients/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,8 +16,8 @@ import { WorkforceIntegrationError } from '../errors.js';
*
* The handler-side ergonomics stay identical to the direct-REST shape
* — `await ctx.github.comment(target, body)` returns when the write
* lands. Whether the receipt is awaited synchronously, polled, or
* fired-and-forgotten depends on `writebackTimeoutMs`.
* lands and, by default, waits briefly for the provider receipt.
* Setting `writebackTimeoutMs` to `0` keeps fire-and-forget behavior.
*/
export interface IntegrationClientOptions {
/** Absolute path to the Relayfile mount the handler is running in. */
Expand All@@ -30,9 +30,8 @@ export interface IntegrationClientOptions {
workspaceCwd?: string;
/**
* Max wait, in ms, for the Relayfile writeback worker to emit a
* receipt onto the just-written draft. `0` (default) means
* fire-and-forget — the client returns immediately and the receipt
* is whatever was readable at write time.
* receipt onto the just-written draft. Defaults to 3000ms. `0` means
* fire-and-forget — the client returns immediately without a receipt.
*/
writebackTimeoutMs?: number;
/** Poll interval while waiting for a receipt. Default 250ms. */
Expand DownExpand Up@@ -71,6 +70,8 @@ export interface WritebackResult {
receipt?: WritebackReceipt;
}

const DEFAULT_WRITEBACK_TIMEOUT_MS = 3_000;

function isRecord(value: unknown): value is Record<string, unknown> {
return typeof value === 'object' && value !== null && !Array.isArray(value);
}
Expand DownExpand Up@@ -196,7 +197,7 @@ function isNoEntryError(error: unknown): boolean {
/**
* Write a draft JSON payload atomically (write-then-rename) so the
* writeback worker never sees a partial file. Waits for a receipt
* when `writebackTimeoutMs > 0`; otherwise returns immediately.
* by default; pass `writebackTimeoutMs: 0` to return immediately.
*/
export async function writeJsonFile(
client: IntegrationClientOptions,
Expand All@@ -222,7 +223,7 @@ async function waitForReceipt(
absolutePath: string,
client: IntegrationClientOptions
): Promise<WritebackReceipt | undefined> {
const timeoutMs = client.writebackTimeoutMs ?? 0;
const timeoutMs = client.writebackTimeoutMs ?? DEFAULT_WRITEBACK_TIMEOUT_MS;
// Fire-and-forget: never reinterpret the just-written draft as a
// receipt. The draft payload may legitimately carry top-level `id` /
// `path` / `created` fields (e.g. an upsert update writing back the
Expand Down
39 changes: 34 additions & 5 deletions packages/runtime/src/clients/slack.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import test from 'node:test';
import assert from 'node:assert/strict';
import { mkdtemp, readFile, readdir, rm } from 'node:fs/promises';
import { mkdtemp, readFile, readdir, rm, writeFile } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import path from 'node:path';
import { WorkforceIntegrationError } from '../errors.js';
Expand All@@ -13,7 +13,7 @@ async function tempMount(): Promise<string> {
test('slack post writes a channel message draft', async () => {
const root = await tempMount();
try {
const client = createSlackClient({ relayfileMountRoot: root });
const client = createSlackClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.post('C123', 'hello');

const dir = path.join(root, 'slack/channels/C123/messages');
Expand All@@ -27,10 +27,39 @@ test('slack post writes a channel message draft', async () => {
}
});

test('slack post waits for the writeback receipt by default', async () => {
const root = await tempMount();
const dir = path.join(root, 'slack/channels/C123/messages');
let timer: NodeJS.Timeout | undefined;
try {
const client = createSlackClient({ relayfileMountRoot: root, writebackPollMs: 10 });
timer = setInterval(() => {
void readdir(dir)
.then(async (files) => {
const file = files.find((name) => name.endsWith('.json'));
if (!file) return;
await writeFile(
path.join(dir, file),
JSON.stringify({ created: '1716490000.123456', url: 'https://slack.example/C123/p1716490000123456' }),
'utf8'
);
if (timer) clearInterval(timer);
})
.catch(() => undefined);
}, 10);

const result = await client.post('C123', 'hello');
assert.equal(result.ts, '1716490000.123456');
} finally {
if (timer) clearInterval(timer);
await rm(root, { recursive: true, force: true });
}
});

test('slack dm writes a user direct-message draft', async () => {
const root = await tempMount();
try {
const client = createSlackClient({ relayfileMountRoot: root });
const client = createSlackClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.dm('U123', 'ping');

const dir = path.join(root, 'slack/users/U123/messages');
Expand All@@ -45,15 +74,15 @@ test('slack dm writes a user direct-message draft', async () => {
});

test('slack reply rejects malformed string thread refs', async () => {
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused' });
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.reply('missing-ts', 'hello'),
(error) => error instanceof WorkforceIntegrationError && error.provider === 'slack'
);
});

test('slack reply rejects malformed object thread refs', async () => {
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused' });
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.reply({ channel: '', ts: '123.456' }, 'hello'),
(error) => error instanceof WorkforceIntegrationError && error.provider === 'slack'
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Wire cloud workflow and integration runtime defaults#136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
khaliqgant merged 8 commits into from
May 23, 2026
Merged

Wire cloud workflow and integration runtime defaults #136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
99eba9b
Wire cloud workflow and integration defaults
May 23, 2026
4712f1a
Align workflow invocation header
May 23, 2026
069b4ab
Harden workflow status polling
May 23, 2026
81e8e3d
Match workflow run status response
May 23, 2026
eeb06da
Retry transient workflow authorization errors
May 23, 2026
68ea4ae
Trim workflow status run ids
May 23, 2026
e288520
Document workflow 403 retry rationale
May 23, 2026
e84cf6c
Retry transient workflow authentication errors
May 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions packages/runtime/src/clients/github.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('github.comment writes a draft comment file under issues/<n>/comments/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.comment({ owner: 'o', repo: 'r', number: 2 }, 'hello');

const dir = path.join(root, 'github/repos/o/r/issues/2/comments');
Expand All@@ -29,7 +29,7 @@ test('github.comment writes a draft comment file under issues/<n>/comments/', as
test('github.createIssue writes a draft issue file under issues/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({
owner: 'o',
repo: 'r',
Expand All@@ -55,7 +55,7 @@ test('github.createIssue writes a draft issue file under issues/', async () => {
test('github.createPullRequest writes a draft pull request file under pulls/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createPullRequest({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -97,7 +97,7 @@ test('github.upsertIssue updates an existing flat issue match', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -130,7 +130,7 @@ test('github.upsertIssue ignores a closed issue title match', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand All@@ -153,7 +153,7 @@ test('github.upsertIssue ignores a closed issue title match', async () => {
test('github.upsertIssue creates a draft when no open match exists', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -188,7 +188,7 @@ test('github.getPr reads meta + diff from canonical paths', async () => {
);
await writeFile(path.join(pullRoot, 'diff.patch'), 'diff --git a/x b/x\n');

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const pr = await client.getPr({ owner: 'o', repo: 'r', number: 42 });
assert.equal(pr.title, 'Add deploy v1');
assert.equal(pr.head, 'feature');
Expand DownExpand Up@@ -217,7 +217,7 @@ test('github.getPr reads a flat canonical pull request file', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const pr = await client.getPr({ owner: 'o', repo: 'r', number: 42 });
assert.equal(pr.title, 'Add deploy v1');
assert.equal(pr.head, 'feature');
Expand All@@ -232,7 +232,7 @@ test('github.getPr reads a flat canonical pull request file', async () => {
test('github.postReview writes a review draft under pulls/<n>/reviews/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.postReview(
{ owner: 'o', repo: 'r', number: 42 },
{
Expand All@@ -256,7 +256,7 @@ test('github.postReview writes a review draft under pulls/<n>/reviews/', async (
test('github.postReview accepts COMMENT/APPROVE/REQUEST_CHANGES events', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
for (const event of ['COMMENT', 'APPROVE', 'REQUEST_CHANGES'] as const) {
await client.postReview({ owner: 'o', repo: 'r', number: event === 'COMMENT' ? 1 : event === 'APPROVE' ? 2 : 3 }, {
body: event.toLowerCase(),
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/jira.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('jira createIssue writes a Jira issue draft', async () => {
const root = await tempMount();
try {
const client = createJiraClient({ relayfileMountRoot: root });
const client = createJiraClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({
cloudId: 'cloud_1',
fields: { project: { key: 'ENG' }, summary: 'Ship it', issuetype: { name: 'Task' } }
Expand All@@ -33,7 +33,7 @@ test('jira createIssue writes a Jira issue draft', async () => {
test('jira transition writes an issue transition draft', async () => {
const root = await tempMount();
try {
const client = createJiraClient({ relayfileMountRoot: root });
const client = createJiraClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.transition({ cloudId: 'cloud_1', issueIdOrKey: 'ENG-1' }, '31');

const dir = path.join(root, 'jira/issues/ENG-1/transitions');
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/linear.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('linear createIssue writes an issue draft', async () => {
const root = await tempMount();
try {
const client = createLinearClient({ relayfileMountRoot: root });
const client = createLinearClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({ teamId: 'team_1', title: 'Ship it', description: 'Soon' });

const dir = path.join(root, 'linear/issues');
Expand All@@ -38,7 +38,7 @@ test('linear getIssue reads a canonical issue file', async () => {
JSON.stringify({ id: 'i1', identifier: 'ENG-1', title: 'Ship it', description: null, url: 'https://linear.app/i1', state: null })
);

const client = createLinearClient({ relayfileMountRoot: root });
const client = createLinearClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
assert.equal((await client.getIssue('ENG-1')).identifier, 'ENG-1');
} finally {
await rm(root, { recursive: true, force: true });
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/notion.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('notion createPage writes a database page draft', async () => {
const root = await tempMount();
try {
const client = createNotionClient({ relayfileMountRoot: root });
const client = createNotionClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createPage(
{ database_id: 'db_1' },
{ Name: { title: [{ text: { content: 'Digest' } }] } },
Expand All@@ -32,7 +32,7 @@ test('notion createPage writes a database page draft', async () => {
});

test('notion createPage requires a database parent for file writeback', async () => {
const client = createNotionClient({ relayfileMountRoot: '/tmp/unused' });
const client = createNotionClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.createPage({}, {}, []),
/parent\.database_id/
Expand Down
15 changes: 8 additions & 7 deletions packages/runtime/src/clients/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,8 +16,8 @@ import { WorkforceIntegrationError } from '../errors.js';
*
* The handler-side ergonomics stay identical to the direct-REST shape
* — `await ctx.github.comment(target, body)` returns when the write
* lands. Whether the receipt is awaited synchronously, polled, or
* fired-and-forgotten depends on `writebackTimeoutMs`.
* lands and, by default, waits briefly for the provider receipt.
* Setting `writebackTimeoutMs` to `0` keeps fire-and-forget behavior.
*/
export interface IntegrationClientOptions {
/** Absolute path to the Relayfile mount the handler is running in. */
Expand All@@ -30,9 +30,8 @@ export interface IntegrationClientOptions {
workspaceCwd?: string;
/**
* Max wait, in ms, for the Relayfile writeback worker to emit a
* receipt onto the just-written draft. `0` (default) means
* fire-and-forget — the client returns immediately and the receipt
* is whatever was readable at write time.
* receipt onto the just-written draft. Defaults to 3000ms. `0` means
* fire-and-forget — the client returns immediately without a receipt.
*/
writebackTimeoutMs?: number;
/** Poll interval while waiting for a receipt. Default 250ms. */
Expand DownExpand Up@@ -71,6 +70,8 @@ export interface WritebackResult {
receipt?: WritebackReceipt;
}

const DEFAULT_WRITEBACK_TIMEOUT_MS = 3_000;

function isRecord(value: unknown): value is Record<string, unknown> {
return typeof value === 'object' && value !== null && !Array.isArray(value);
}
Expand DownExpand Up@@ -196,7 +197,7 @@ function isNoEntryError(error: unknown): boolean {
/**
* Write a draft JSON payload atomically (write-then-rename) so the
* writeback worker never sees a partial file. Waits for a receipt
* when `writebackTimeoutMs > 0`; otherwise returns immediately.
* by default; pass `writebackTimeoutMs: 0` to return immediately.
*/
export async function writeJsonFile(
client: IntegrationClientOptions,
Expand All@@ -222,7 +223,7 @@ async function waitForReceipt(
absolutePath: string,
client: IntegrationClientOptions
): Promise<WritebackReceipt | undefined> {
const timeoutMs = client.writebackTimeoutMs ?? 0;
const timeoutMs = client.writebackTimeoutMs ?? DEFAULT_WRITEBACK_TIMEOUT_MS;
// Fire-and-forget: never reinterpret the just-written draft as a
// receipt. The draft payload may legitimately carry top-level `id` /
// `path` / `created` fields (e.g. an upsert update writing back the
Expand Down
39 changes: 34 additions & 5 deletions packages/runtime/src/clients/slack.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import test from 'node:test';
import assert from 'node:assert/strict';
import { mkdtemp, readFile, readdir, rm } from 'node:fs/promises';
import { mkdtemp, readFile, readdir, rm, writeFile } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import path from 'node:path';
import { WorkforceIntegrationError } from '../errors.js';
Expand All@@ -13,7 +13,7 @@ async function tempMount(): Promise<string> {
test('slack post writes a channel message draft', async () => {
const root = await tempMount();
try {
const client = createSlackClient({ relayfileMountRoot: root });
const client = createSlackClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.post('C123', 'hello');

const dir = path.join(root, 'slack/channels/C123/messages');
Expand All@@ -27,10 +27,39 @@ test('slack post writes a channel message draft', async () => {
}
});

test('slack post waits for the writeback receipt by default', async () => {
const root = await tempMount();
const dir = path.join(root, 'slack/channels/C123/messages');
let timer: NodeJS.Timeout | undefined;
try {
const client = createSlackClient({ relayfileMountRoot: root, writebackPollMs: 10 });
timer = setInterval(() => {
void readdir(dir)
.then(async (files) => {
const file = files.find((name) => name.endsWith('.json'));
if (!file) return;
await writeFile(
path.join(dir, file),
JSON.stringify({ created: '1716490000.123456', url: 'https://slack.example/C123/p1716490000123456' }),
'utf8'
);
if (timer) clearInterval(timer);
})
.catch(() => undefined);
}, 10);

const result = await client.post('C123', 'hello');
assert.equal(result.ts, '1716490000.123456');
} finally {
if (timer) clearInterval(timer);
await rm(root, { recursive: true, force: true });
}
});

test('slack dm writes a user direct-message draft', async () => {
const root = await tempMount();
try {
const client = createSlackClient({ relayfileMountRoot: root });
const client = createSlackClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.dm('U123', 'ping');

const dir = path.join(root, 'slack/users/U123/messages');
Expand All@@ -45,15 +74,15 @@ test('slack dm writes a user direct-message draft', async () => {
});

test('slack reply rejects malformed string thread refs', async () => {
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused' });
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.reply('missing-ts', 'hello'),
(error) => error instanceof WorkforceIntegrationError && error.provider === 'slack'
);
});

test('slack reply rejects malformed object thread refs', async () => {
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused' });
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.reply({ channel: '', ts: '123.456' }, 'hello'),
(error) => error instanceof WorkforceIntegrationError && error.provider === 'slack'
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Wire cloud workflow and integration runtime defaults#136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
khaliqgant merged 8 commits into from
May 23, 2026
Merged

Wire cloud workflow and integration runtime defaults #136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
99eba9b
Wire cloud workflow and integration defaults
May 23, 2026
4712f1a
Align workflow invocation header
May 23, 2026
069b4ab
Harden workflow status polling
May 23, 2026
81e8e3d
Match workflow run status response
May 23, 2026
eeb06da
Retry transient workflow authorization errors
May 23, 2026
68ea4ae
Trim workflow status run ids
May 23, 2026
e288520
Document workflow 403 retry rationale
May 23, 2026
e84cf6c
Retry transient workflow authentication errors
May 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions packages/runtime/src/clients/github.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('github.comment writes a draft comment file under issues/<n>/comments/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.comment({ owner: 'o', repo: 'r', number: 2 }, 'hello');

const dir = path.join(root, 'github/repos/o/r/issues/2/comments');
Expand All@@ -29,7 +29,7 @@ test('github.comment writes a draft comment file under issues/<n>/comments/', as
test('github.createIssue writes a draft issue file under issues/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({
owner: 'o',
repo: 'r',
Expand All@@ -55,7 +55,7 @@ test('github.createIssue writes a draft issue file under issues/', async () => {
test('github.createPullRequest writes a draft pull request file under pulls/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createPullRequest({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -97,7 +97,7 @@ test('github.upsertIssue updates an existing flat issue match', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -130,7 +130,7 @@ test('github.upsertIssue ignores a closed issue title match', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand All@@ -153,7 +153,7 @@ test('github.upsertIssue ignores a closed issue title match', async () => {
test('github.upsertIssue creates a draft when no open match exists', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -188,7 +188,7 @@ test('github.getPr reads meta + diff from canonical paths', async () => {
);
await writeFile(path.join(pullRoot, 'diff.patch'), 'diff --git a/x b/x\n');

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const pr = await client.getPr({ owner: 'o', repo: 'r', number: 42 });
assert.equal(pr.title, 'Add deploy v1');
assert.equal(pr.head, 'feature');
Expand DownExpand Up@@ -217,7 +217,7 @@ test('github.getPr reads a flat canonical pull request file', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const pr = await client.getPr({ owner: 'o', repo: 'r', number: 42 });
assert.equal(pr.title, 'Add deploy v1');
assert.equal(pr.head, 'feature');
Expand All@@ -232,7 +232,7 @@ test('github.getPr reads a flat canonical pull request file', async () => {
test('github.postReview writes a review draft under pulls/<n>/reviews/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.postReview(
{ owner: 'o', repo: 'r', number: 42 },
{
Expand All@@ -256,7 +256,7 @@ test('github.postReview writes a review draft under pulls/<n>/reviews/', async (
test('github.postReview accepts COMMENT/APPROVE/REQUEST_CHANGES events', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
for (const event of ['COMMENT', 'APPROVE', 'REQUEST_CHANGES'] as const) {
await client.postReview({ owner: 'o', repo: 'r', number: event === 'COMMENT' ? 1 : event === 'APPROVE' ? 2 : 3 }, {
body: event.toLowerCase(),
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/jira.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('jira createIssue writes a Jira issue draft', async () => {
const root = await tempMount();
try {
const client = createJiraClient({ relayfileMountRoot: root });
const client = createJiraClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({
cloudId: 'cloud_1',
fields: { project: { key: 'ENG' }, summary: 'Ship it', issuetype: { name: 'Task' } }
Expand All@@ -33,7 +33,7 @@ test('jira createIssue writes a Jira issue draft', async () => {
test('jira transition writes an issue transition draft', async () => {
const root = await tempMount();
try {
const client = createJiraClient({ relayfileMountRoot: root });
const client = createJiraClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.transition({ cloudId: 'cloud_1', issueIdOrKey: 'ENG-1' }, '31');

const dir = path.join(root, 'jira/issues/ENG-1/transitions');
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/linear.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('linear createIssue writes an issue draft', async () => {
const root = await tempMount();
try {
const client = createLinearClient({ relayfileMountRoot: root });
const client = createLinearClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({ teamId: 'team_1', title: 'Ship it', description: 'Soon' });

const dir = path.join(root, 'linear/issues');
Expand All@@ -38,7 +38,7 @@ test('linear getIssue reads a canonical issue file', async () => {
JSON.stringify({ id: 'i1', identifier: 'ENG-1', title: 'Ship it', description: null, url: 'https://linear.app/i1', state: null })
);

const client = createLinearClient({ relayfileMountRoot: root });
const client = createLinearClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
assert.equal((await client.getIssue('ENG-1')).identifier, 'ENG-1');
} finally {
await rm(root, { recursive: true, force: true });
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/notion.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('notion createPage writes a database page draft', async () => {
const root = await tempMount();
try {
const client = createNotionClient({ relayfileMountRoot: root });
const client = createNotionClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createPage(
{ database_id: 'db_1' },
{ Name: { title: [{ text: { content: 'Digest' } }] } },
Expand All@@ -32,7 +32,7 @@ test('notion createPage writes a database page draft', async () => {
});

test('notion createPage requires a database parent for file writeback', async () => {
const client = createNotionClient({ relayfileMountRoot: '/tmp/unused' });
const client = createNotionClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.createPage({}, {}, []),
/parent\.database_id/
Expand Down
15 changes: 8 additions & 7 deletions packages/runtime/src/clients/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,8 +16,8 @@ import { WorkforceIntegrationError } from '../errors.js';
*
* The handler-side ergonomics stay identical to the direct-REST shape
* — `await ctx.github.comment(target, body)` returns when the write
* lands. Whether the receipt is awaited synchronously, polled, or
* fired-and-forgotten depends on `writebackTimeoutMs`.
* lands and, by default, waits briefly for the provider receipt.
* Setting `writebackTimeoutMs` to `0` keeps fire-and-forget behavior.
*/
export interface IntegrationClientOptions {
/** Absolute path to the Relayfile mount the handler is running in. */
Expand All@@ -30,9 +30,8 @@ export interface IntegrationClientOptions {
workspaceCwd?: string;
/**
* Max wait, in ms, for the Relayfile writeback worker to emit a
* receipt onto the just-written draft. `0` (default) means
* fire-and-forget — the client returns immediately and the receipt
* is whatever was readable at write time.
* receipt onto the just-written draft. Defaults to 3000ms. `0` means
* fire-and-forget — the client returns immediately without a receipt.
*/
writebackTimeoutMs?: number;
/** Poll interval while waiting for a receipt. Default 250ms. */
Expand DownExpand Up@@ -71,6 +70,8 @@ export interface WritebackResult {
receipt?: WritebackReceipt;
}

const DEFAULT_WRITEBACK_TIMEOUT_MS = 3_000;

function isRecord(value: unknown): value is Record<string, unknown> {
return typeof value === 'object' && value !== null && !Array.isArray(value);
}
Expand DownExpand Up@@ -196,7 +197,7 @@ function isNoEntryError(error: unknown): boolean {
/**
* Write a draft JSON payload atomically (write-then-rename) so the
* writeback worker never sees a partial file. Waits for a receipt
* when `writebackTimeoutMs > 0`; otherwise returns immediately.
* by default; pass `writebackTimeoutMs: 0` to return immediately.
*/
export async function writeJsonFile(
client: IntegrationClientOptions,
Expand All@@ -222,7 +223,7 @@ async function waitForReceipt(
absolutePath: string,
client: IntegrationClientOptions
): Promise<WritebackReceipt | undefined> {
const timeoutMs = client.writebackTimeoutMs ?? 0;
const timeoutMs = client.writebackTimeoutMs ?? DEFAULT_WRITEBACK_TIMEOUT_MS;
// Fire-and-forget: never reinterpret the just-written draft as a
// receipt. The draft payload may legitimately carry top-level `id` /
// `path` / `created` fields (e.g. an upsert update writing back the
Expand Down
39 changes: 34 additions & 5 deletions packages/runtime/src/clients/slack.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import test from 'node:test';
import assert from 'node:assert/strict';
import { mkdtemp, readFile, readdir, rm } from 'node:fs/promises';
import { mkdtemp, readFile, readdir, rm, writeFile } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import path from 'node:path';
import { WorkforceIntegrationError } from '../errors.js';
Expand All@@ -13,7 +13,7 @@ async function tempMount(): Promise<string> {
test('slack post writes a channel message draft', async () => {
const root = await tempMount();
try {
const client = createSlackClient({ relayfileMountRoot: root });
const client = createSlackClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.post('C123', 'hello');

const dir = path.join(root, 'slack/channels/C123/messages');
Expand All@@ -27,10 +27,39 @@ test('slack post writes a channel message draft', async () => {
}
});

test('slack post waits for the writeback receipt by default', async () => {
const root = await tempMount();
const dir = path.join(root, 'slack/channels/C123/messages');
let timer: NodeJS.Timeout | undefined;
try {
const client = createSlackClient({ relayfileMountRoot: root, writebackPollMs: 10 });
timer = setInterval(() => {
void readdir(dir)
.then(async (files) => {
const file = files.find((name) => name.endsWith('.json'));
if (!file) return;
await writeFile(
path.join(dir, file),
JSON.stringify({ created: '1716490000.123456', url: 'https://slack.example/C123/p1716490000123456' }),
'utf8'
);
if (timer) clearInterval(timer);
})
.catch(() => undefined);
}, 10);

const result = await client.post('C123', 'hello');
assert.equal(result.ts, '1716490000.123456');
} finally {
if (timer) clearInterval(timer);
await rm(root, { recursive: true, force: true });
}
});

test('slack dm writes a user direct-message draft', async () => {
const root = await tempMount();
try {
const client = createSlackClient({ relayfileMountRoot: root });
const client = createSlackClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.dm('U123', 'ping');

const dir = path.join(root, 'slack/users/U123/messages');
Expand All@@ -45,15 +74,15 @@ test('slack dm writes a user direct-message draft', async () => {
});

test('slack reply rejects malformed string thread refs', async () => {
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused' });
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.reply('missing-ts', 'hello'),
(error) => error instanceof WorkforceIntegrationError && error.provider === 'slack'
);
});

test('slack reply rejects malformed object thread refs', async () => {
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused' });
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.reply({ channel: '', ts: '123.456' }, 'hello'),
(error) => error instanceof WorkforceIntegrationError && error.provider === 'slack'
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Wire cloud workflow and integration runtime defaults#136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
khaliqgant merged 8 commits into from
May 23, 2026
Merged

Wire cloud workflow and integration runtime defaults #136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
99eba9b
Wire cloud workflow and integration defaults
May 23, 2026
4712f1a
Align workflow invocation header
May 23, 2026
069b4ab
Harden workflow status polling
May 23, 2026
81e8e3d
Match workflow run status response
May 23, 2026
eeb06da
Retry transient workflow authorization errors
May 23, 2026
68ea4ae
Trim workflow status run ids
May 23, 2026
e288520
Document workflow 403 retry rationale
May 23, 2026
e84cf6c
Retry transient workflow authentication errors
May 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions packages/runtime/src/clients/github.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('github.comment writes a draft comment file under issues/<n>/comments/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.comment({ owner: 'o', repo: 'r', number: 2 }, 'hello');

const dir = path.join(root, 'github/repos/o/r/issues/2/comments');
Expand All@@ -29,7 +29,7 @@ test('github.comment writes a draft comment file under issues/<n>/comments/', as
test('github.createIssue writes a draft issue file under issues/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({
owner: 'o',
repo: 'r',
Expand All@@ -55,7 +55,7 @@ test('github.createIssue writes a draft issue file under issues/', async () => {
test('github.createPullRequest writes a draft pull request file under pulls/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createPullRequest({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -97,7 +97,7 @@ test('github.upsertIssue updates an existing flat issue match', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -130,7 +130,7 @@ test('github.upsertIssue ignores a closed issue title match', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand All@@ -153,7 +153,7 @@ test('github.upsertIssue ignores a closed issue title match', async () => {
test('github.upsertIssue creates a draft when no open match exists', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -188,7 +188,7 @@ test('github.getPr reads meta + diff from canonical paths', async () => {
);
await writeFile(path.join(pullRoot, 'diff.patch'), 'diff --git a/x b/x\n');

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const pr = await client.getPr({ owner: 'o', repo: 'r', number: 42 });
assert.equal(pr.title, 'Add deploy v1');
assert.equal(pr.head, 'feature');
Expand DownExpand Up@@ -217,7 +217,7 @@ test('github.getPr reads a flat canonical pull request file', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const pr = await client.getPr({ owner: 'o', repo: 'r', number: 42 });
assert.equal(pr.title, 'Add deploy v1');
assert.equal(pr.head, 'feature');
Expand All@@ -232,7 +232,7 @@ test('github.getPr reads a flat canonical pull request file', async () => {
test('github.postReview writes a review draft under pulls/<n>/reviews/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.postReview(
{ owner: 'o', repo: 'r', number: 42 },
{
Expand All@@ -256,7 +256,7 @@ test('github.postReview writes a review draft under pulls/<n>/reviews/', async (
test('github.postReview accepts COMMENT/APPROVE/REQUEST_CHANGES events', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
for (const event of ['COMMENT', 'APPROVE', 'REQUEST_CHANGES'] as const) {
await client.postReview({ owner: 'o', repo: 'r', number: event === 'COMMENT' ? 1 : event === 'APPROVE' ? 2 : 3 }, {
body: event.toLowerCase(),
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/jira.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('jira createIssue writes a Jira issue draft', async () => {
const root = await tempMount();
try {
const client = createJiraClient({ relayfileMountRoot: root });
const client = createJiraClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({
cloudId: 'cloud_1',
fields: { project: { key: 'ENG' }, summary: 'Ship it', issuetype: { name: 'Task' } }
Expand All@@ -33,7 +33,7 @@ test('jira createIssue writes a Jira issue draft', async () => {
test('jira transition writes an issue transition draft', async () => {
const root = await tempMount();
try {
const client = createJiraClient({ relayfileMountRoot: root });
const client = createJiraClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.transition({ cloudId: 'cloud_1', issueIdOrKey: 'ENG-1' }, '31');

const dir = path.join(root, 'jira/issues/ENG-1/transitions');
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/linear.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('linear createIssue writes an issue draft', async () => {
const root = await tempMount();
try {
const client = createLinearClient({ relayfileMountRoot: root });
const client = createLinearClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({ teamId: 'team_1', title: 'Ship it', description: 'Soon' });

const dir = path.join(root, 'linear/issues');
Expand All@@ -38,7 +38,7 @@ test('linear getIssue reads a canonical issue file', async () => {
JSON.stringify({ id: 'i1', identifier: 'ENG-1', title: 'Ship it', description: null, url: 'https://linear.app/i1', state: null })
);

const client = createLinearClient({ relayfileMountRoot: root });
const client = createLinearClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
assert.equal((await client.getIssue('ENG-1')).identifier, 'ENG-1');
} finally {
await rm(root, { recursive: true, force: true });
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/notion.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('notion createPage writes a database page draft', async () => {
const root = await tempMount();
try {
const client = createNotionClient({ relayfileMountRoot: root });
const client = createNotionClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createPage(
{ database_id: 'db_1' },
{ Name: { title: [{ text: { content: 'Digest' } }] } },
Expand All@@ -32,7 +32,7 @@ test('notion createPage writes a database page draft', async () => {
});

test('notion createPage requires a database parent for file writeback', async () => {
const client = createNotionClient({ relayfileMountRoot: '/tmp/unused' });
const client = createNotionClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.createPage({}, {}, []),
/parent\.database_id/
Expand Down
15 changes: 8 additions & 7 deletions packages/runtime/src/clients/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,8 +16,8 @@ import { WorkforceIntegrationError } from '../errors.js';
*
* The handler-side ergonomics stay identical to the direct-REST shape
* — `await ctx.github.comment(target, body)` returns when the write
* lands. Whether the receipt is awaited synchronously, polled, or
* fired-and-forgotten depends on `writebackTimeoutMs`.
* lands and, by default, waits briefly for the provider receipt.
* Setting `writebackTimeoutMs` to `0` keeps fire-and-forget behavior.
*/
export interface IntegrationClientOptions {
/** Absolute path to the Relayfile mount the handler is running in. */
Expand All@@ -30,9 +30,8 @@ export interface IntegrationClientOptions {
workspaceCwd?: string;
/**
* Max wait, in ms, for the Relayfile writeback worker to emit a
* receipt onto the just-written draft. `0` (default) means
* fire-and-forget — the client returns immediately and the receipt
* is whatever was readable at write time.
* receipt onto the just-written draft. Defaults to 3000ms. `0` means
* fire-and-forget — the client returns immediately without a receipt.
*/
writebackTimeoutMs?: number;
/** Poll interval while waiting for a receipt. Default 250ms. */
Expand DownExpand Up@@ -71,6 +70,8 @@ export interface WritebackResult {
receipt?: WritebackReceipt;
}

const DEFAULT_WRITEBACK_TIMEOUT_MS = 3_000;

function isRecord(value: unknown): value is Record<string, unknown> {
return typeof value === 'object' && value !== null && !Array.isArray(value);
}
Expand DownExpand Up@@ -196,7 +197,7 @@ function isNoEntryError(error: unknown): boolean {
/**
* Write a draft JSON payload atomically (write-then-rename) so the
* writeback worker never sees a partial file. Waits for a receipt
* when `writebackTimeoutMs > 0`; otherwise returns immediately.
* by default; pass `writebackTimeoutMs: 0` to return immediately.
*/
export async function writeJsonFile(
client: IntegrationClientOptions,
Expand All@@ -222,7 +223,7 @@ async function waitForReceipt(
absolutePath: string,
client: IntegrationClientOptions
): Promise<WritebackReceipt | undefined> {
const timeoutMs = client.writebackTimeoutMs ?? 0;
const timeoutMs = client.writebackTimeoutMs ?? DEFAULT_WRITEBACK_TIMEOUT_MS;
// Fire-and-forget: never reinterpret the just-written draft as a
// receipt. The draft payload may legitimately carry top-level `id` /
// `path` / `created` fields (e.g. an upsert update writing back the
Expand Down
39 changes: 34 additions & 5 deletions packages/runtime/src/clients/slack.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import test from 'node:test';
import assert from 'node:assert/strict';
import { mkdtemp, readFile, readdir, rm } from 'node:fs/promises';
import { mkdtemp, readFile, readdir, rm, writeFile } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import path from 'node:path';
import { WorkforceIntegrationError } from '../errors.js';
Expand All@@ -13,7 +13,7 @@ async function tempMount(): Promise<string> {
test('slack post writes a channel message draft', async () => {
const root = await tempMount();
try {
const client = createSlackClient({ relayfileMountRoot: root });
const client = createSlackClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.post('C123', 'hello');

const dir = path.join(root, 'slack/channels/C123/messages');
Expand All@@ -27,10 +27,39 @@ test('slack post writes a channel message draft', async () => {
}
});

test('slack post waits for the writeback receipt by default', async () => {
const root = await tempMount();
const dir = path.join(root, 'slack/channels/C123/messages');
let timer: NodeJS.Timeout | undefined;
try {
const client = createSlackClient({ relayfileMountRoot: root, writebackPollMs: 10 });
timer = setInterval(() => {
void readdir(dir)
.then(async (files) => {
const file = files.find((name) => name.endsWith('.json'));
if (!file) return;
await writeFile(
path.join(dir, file),
JSON.stringify({ created: '1716490000.123456', url: 'https://slack.example/C123/p1716490000123456' }),
'utf8'
);
if (timer) clearInterval(timer);
})
.catch(() => undefined);
}, 10);

const result = await client.post('C123', 'hello');
assert.equal(result.ts, '1716490000.123456');
} finally {
if (timer) clearInterval(timer);
await rm(root, { recursive: true, force: true });
}
});

test('slack dm writes a user direct-message draft', async () => {
const root = await tempMount();
try {
const client = createSlackClient({ relayfileMountRoot: root });
const client = createSlackClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.dm('U123', 'ping');

const dir = path.join(root, 'slack/users/U123/messages');
Expand All@@ -45,15 +74,15 @@ test('slack dm writes a user direct-message draft', async () => {
});

test('slack reply rejects malformed string thread refs', async () => {
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused' });
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.reply('missing-ts', 'hello'),
(error) => error instanceof WorkforceIntegrationError && error.provider === 'slack'
);
});

test('slack reply rejects malformed object thread refs', async () => {
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused' });
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.reply({ channel: '', ts: '123.456' }, 'hello'),
(error) => error instanceof WorkforceIntegrationError && error.provider === 'slack'
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Wire cloud workflow and integration runtime defaults#136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
khaliqgant merged 8 commits into from
May 23, 2026
Merged

Wire cloud workflow and integration runtime defaults #136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
99eba9b
Wire cloud workflow and integration defaults
May 23, 2026
4712f1a
Align workflow invocation header
May 23, 2026
069b4ab
Harden workflow status polling
May 23, 2026
81e8e3d
Match workflow run status response
May 23, 2026
eeb06da
Retry transient workflow authorization errors
May 23, 2026
68ea4ae
Trim workflow status run ids
May 23, 2026
e288520
Document workflow 403 retry rationale
May 23, 2026
e84cf6c
Retry transient workflow authentication errors
May 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions packages/runtime/src/clients/github.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('github.comment writes a draft comment file under issues/<n>/comments/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.comment({ owner: 'o', repo: 'r', number: 2 }, 'hello');

const dir = path.join(root, 'github/repos/o/r/issues/2/comments');
Expand All@@ -29,7 +29,7 @@ test('github.comment writes a draft comment file under issues/<n>/comments/', as
test('github.createIssue writes a draft issue file under issues/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({
owner: 'o',
repo: 'r',
Expand All@@ -55,7 +55,7 @@ test('github.createIssue writes a draft issue file under issues/', async () => {
test('github.createPullRequest writes a draft pull request file under pulls/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createPullRequest({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -97,7 +97,7 @@ test('github.upsertIssue updates an existing flat issue match', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -130,7 +130,7 @@ test('github.upsertIssue ignores a closed issue title match', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand All@@ -153,7 +153,7 @@ test('github.upsertIssue ignores a closed issue title match', async () => {
test('github.upsertIssue creates a draft when no open match exists', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const result = await client.upsertIssue({
owner: 'o',
repo: 'r',
Expand DownExpand Up@@ -188,7 +188,7 @@ test('github.getPr reads meta + diff from canonical paths', async () => {
);
await writeFile(path.join(pullRoot, 'diff.patch'), 'diff --git a/x b/x\n');

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const pr = await client.getPr({ owner: 'o', repo: 'r', number: 42 });
assert.equal(pr.title, 'Add deploy v1');
assert.equal(pr.head, 'feature');
Expand DownExpand Up@@ -217,7 +217,7 @@ test('github.getPr reads a flat canonical pull request file', async () => {
})
);

const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
const pr = await client.getPr({ owner: 'o', repo: 'r', number: 42 });
assert.equal(pr.title, 'Add deploy v1');
assert.equal(pr.head, 'feature');
Expand All@@ -232,7 +232,7 @@ test('github.getPr reads a flat canonical pull request file', async () => {
test('github.postReview writes a review draft under pulls/<n>/reviews/', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.postReview(
{ owner: 'o', repo: 'r', number: 42 },
{
Expand All@@ -256,7 +256,7 @@ test('github.postReview writes a review draft under pulls/<n>/reviews/', async (
test('github.postReview accepts COMMENT/APPROVE/REQUEST_CHANGES events', async () => {
const root = await tempMount();
try {
const client = createGithubClient({ relayfileMountRoot: root });
const client = createGithubClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
for (const event of ['COMMENT', 'APPROVE', 'REQUEST_CHANGES'] as const) {
await client.postReview({ owner: 'o', repo: 'r', number: event === 'COMMENT' ? 1 : event === 'APPROVE' ? 2 : 3 }, {
body: event.toLowerCase(),
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/jira.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('jira createIssue writes a Jira issue draft', async () => {
const root = await tempMount();
try {
const client = createJiraClient({ relayfileMountRoot: root });
const client = createJiraClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({
cloudId: 'cloud_1',
fields: { project: { key: 'ENG' }, summary: 'Ship it', issuetype: { name: 'Task' } }
Expand All@@ -33,7 +33,7 @@ test('jira createIssue writes a Jira issue draft', async () => {
test('jira transition writes an issue transition draft', async () => {
const root = await tempMount();
try {
const client = createJiraClient({ relayfileMountRoot: root });
const client = createJiraClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.transition({ cloudId: 'cloud_1', issueIdOrKey: 'ENG-1' }, '31');

const dir = path.join(root, 'jira/issues/ENG-1/transitions');
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/linear.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('linear createIssue writes an issue draft', async () => {
const root = await tempMount();
try {
const client = createLinearClient({ relayfileMountRoot: root });
const client = createLinearClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createIssue({ teamId: 'team_1', title: 'Ship it', description: 'Soon' });

const dir = path.join(root, 'linear/issues');
Expand All@@ -38,7 +38,7 @@ test('linear getIssue reads a canonical issue file', async () => {
JSON.stringify({ id: 'i1', identifier: 'ENG-1', title: 'Ship it', description: null, url: 'https://linear.app/i1', state: null })
);

const client = createLinearClient({ relayfileMountRoot: root });
const client = createLinearClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
assert.equal((await client.getIssue('ENG-1')).identifier, 'ENG-1');
} finally {
await rm(root, { recursive: true, force: true });
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/clients/notion.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ async function tempMount(): Promise<string> {
test('notion createPage writes a database page draft', async () => {
const root = await tempMount();
try {
const client = createNotionClient({ relayfileMountRoot: root });
const client = createNotionClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.createPage(
{ database_id: 'db_1' },
{ Name: { title: [{ text: { content: 'Digest' } }] } },
Expand All@@ -32,7 +32,7 @@ test('notion createPage writes a database page draft', async () => {
});

test('notion createPage requires a database parent for file writeback', async () => {
const client = createNotionClient({ relayfileMountRoot: '/tmp/unused' });
const client = createNotionClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.createPage({}, {}, []),
/parent\.database_id/
Expand Down
15 changes: 8 additions & 7 deletions packages/runtime/src/clients/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,8 +16,8 @@ import { WorkforceIntegrationError } from '../errors.js';
*
* The handler-side ergonomics stay identical to the direct-REST shape
* — `await ctx.github.comment(target, body)` returns when the write
* lands. Whether the receipt is awaited synchronously, polled, or
* fired-and-forgotten depends on `writebackTimeoutMs`.
* lands and, by default, waits briefly for the provider receipt.
* Setting `writebackTimeoutMs` to `0` keeps fire-and-forget behavior.
*/
export interface IntegrationClientOptions {
/** Absolute path to the Relayfile mount the handler is running in. */
Expand All@@ -30,9 +30,8 @@ export interface IntegrationClientOptions {
workspaceCwd?: string;
/**
* Max wait, in ms, for the Relayfile writeback worker to emit a
* receipt onto the just-written draft. `0` (default) means
* fire-and-forget — the client returns immediately and the receipt
* is whatever was readable at write time.
* receipt onto the just-written draft. Defaults to 3000ms. `0` means
* fire-and-forget — the client returns immediately without a receipt.
*/
writebackTimeoutMs?: number;
/** Poll interval while waiting for a receipt. Default 250ms. */
Expand DownExpand Up@@ -71,6 +70,8 @@ export interface WritebackResult {
receipt?: WritebackReceipt;
}

const DEFAULT_WRITEBACK_TIMEOUT_MS = 3_000;

function isRecord(value: unknown): value is Record<string, unknown> {
return typeof value === 'object' && value !== null && !Array.isArray(value);
}
Expand DownExpand Up@@ -196,7 +197,7 @@ function isNoEntryError(error: unknown): boolean {
/**
* Write a draft JSON payload atomically (write-then-rename) so the
* writeback worker never sees a partial file. Waits for a receipt
* when `writebackTimeoutMs > 0`; otherwise returns immediately.
* by default; pass `writebackTimeoutMs: 0` to return immediately.
*/
export async function writeJsonFile(
client: IntegrationClientOptions,
Expand All@@ -222,7 +223,7 @@ async function waitForReceipt(
absolutePath: string,
client: IntegrationClientOptions
): Promise<WritebackReceipt | undefined> {
const timeoutMs = client.writebackTimeoutMs ?? 0;
const timeoutMs = client.writebackTimeoutMs ?? DEFAULT_WRITEBACK_TIMEOUT_MS;
// Fire-and-forget: never reinterpret the just-written draft as a
// receipt. The draft payload may legitimately carry top-level `id` /
// `path` / `created` fields (e.g. an upsert update writing back the
Expand Down
39 changes: 34 additions & 5 deletions packages/runtime/src/clients/slack.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import test from 'node:test';
import assert from 'node:assert/strict';
import { mkdtemp, readFile, readdir, rm } from 'node:fs/promises';
import { mkdtemp, readFile, readdir, rm, writeFile } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import path from 'node:path';
import { WorkforceIntegrationError } from '../errors.js';
Expand All@@ -13,7 +13,7 @@ async function tempMount(): Promise<string> {
test('slack post writes a channel message draft', async () => {
const root = await tempMount();
try {
const client = createSlackClient({ relayfileMountRoot: root });
const client = createSlackClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.post('C123', 'hello');

const dir = path.join(root, 'slack/channels/C123/messages');
Expand All@@ -27,10 +27,39 @@ test('slack post writes a channel message draft', async () => {
}
});

test('slack post waits for the writeback receipt by default', async () => {
const root = await tempMount();
const dir = path.join(root, 'slack/channels/C123/messages');
let timer: NodeJS.Timeout | undefined;
try {
const client = createSlackClient({ relayfileMountRoot: root, writebackPollMs: 10 });
timer = setInterval(() => {
void readdir(dir)
.then(async (files) => {
const file = files.find((name) => name.endsWith('.json'));
if (!file) return;
await writeFile(
path.join(dir, file),
JSON.stringify({ created: '1716490000.123456', url: 'https://slack.example/C123/p1716490000123456' }),
'utf8'
);
if (timer) clearInterval(timer);
})
.catch(() => undefined);
}, 10);

const result = await client.post('C123', 'hello');
assert.equal(result.ts, '1716490000.123456');
} finally {
if (timer) clearInterval(timer);
await rm(root, { recursive: true, force: true });
}
});

test('slack dm writes a user direct-message draft', async () => {
const root = await tempMount();
try {
const client = createSlackClient({ relayfileMountRoot: root });
const client = createSlackClient({ relayfileMountRoot: root, writebackTimeoutMs: 0 });
await client.dm('U123', 'ping');

const dir = path.join(root, 'slack/users/U123/messages');
Expand All@@ -45,15 +74,15 @@ test('slack dm writes a user direct-message draft', async () => {
});

test('slack reply rejects malformed string thread refs', async () => {
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused' });
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.reply('missing-ts', 'hello'),
(error) => error instanceof WorkforceIntegrationError && error.provider === 'slack'
);
});

test('slack reply rejects malformed object thread refs', async () => {
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused' });
const client = createSlackClient({ relayfileMountRoot: '/tmp/unused', writebackTimeoutMs: 0 });
await assert.rejects(
() => client.reply({ channel: '', ts: '123.456' }, 'hello'),
(error) => error instanceof WorkforceIntegrationError && error.provider === 'slack'
Expand Down
Loading
Loading