@remit/backend 0.0.142 → 0.0.144

package/src/service/trigger-sync.test.ts

@@ -1,205 +0,0 @@
-import assert from "node:assert/strict";
-import { describe, it } from "node:test";
-import { SendMessageCommand, type SQSClient } from "@aws-sdk/client-sqs";
-import {
-	buildScheduledSyncDedupId,
-	buildSyncMailboxesCommand,
-	triggerAccountSync,
-} from "./trigger-sync.js";
-
-const FIFO_QUEUE_URL =
-	"https://sqs.eu-west-1.amazonaws.com/123456789012/remit-dev-mailboxes.fifo";
-const STANDARD_QUEUE_URL =
-	"http://localhost:9324/000000000000/remit-dev-mailboxes";
-
-const parseBody = (cmd: SendMessageCommand): Record<string, unknown> => {
-	const body = cmd.input.MessageBody ?? "{}";
-	return JSON.parse(body) as Record<string, unknown>;
-};
-
-describe("buildSyncMailboxesCommand", () => {
-	it("sets MessageGroupId to accountId for FIFO queues", () => {
-		const cmd = buildSyncMailboxesCommand({
-			queueUrl: FIFO_QUEUE_URL,
-			accountId: "account-abc",
-		});
-
-		assert.equal(cmd.input.MessageGroupId, "account-abc");
-	});
-
-	it("defaults MessageDeduplicationId to the event's own id for FIFO queues", () => {
-		const cmd = buildSyncMailboxesCommand({
-			queueUrl: FIFO_QUEUE_URL,
-			accountId: "account-abc",
-		});
-
-		assert.equal(cmd.input.MessageDeduplicationId, parseBody(cmd).eventId);
-	});
-
-	// Issue #37: a shared, time-bucketed dedup id let SQS FIFO's 5-minute
-	// window discard the second sync of an account, so mail that arrived after
-	// a sync stayed invisible until the window elapsed. Back-to-back triggers
-	// must each reach the queue.
-	it("gives two triggers for one account distinct dedup ids", () => {
-		const first = buildSyncMailboxesCommand({
-			queueUrl: FIFO_QUEUE_URL,
-			accountId: "account-abc",
-		});
-		const second = buildSyncMailboxesCommand({
-			queueUrl: FIFO_QUEUE_URL,
-			accountId: "account-abc",
-		});
-
-		assert.notEqual(
-			first.input.MessageDeduplicationId,
-			second.input.MessageDeduplicationId,
-		);
-	});
-
-	// The worker's fan-out gate reads this off the event: it is what lets a
-	// sync asked for by name cover every folder while a side-effect trigger
-	// skips the ones that were just enumerated.
-	it("marks an explicitly-requested trigger on the event", () => {
-		const cmd = buildSyncMailboxesCommand({
-			queueUrl: FIFO_QUEUE_URL,
-			accountId: "account-abc",
-			explicitRequest: true,
-		});
-
-		assert.equal(parseBody(cmd).explicitRequest, true);
-	});
-
-	it("leaves a side-effect trigger unmarked", () => {
-		const cmd = buildSyncMailboxesCommand({
-			queueUrl: FIFO_QUEUE_URL,
-			accountId: "account-abc",
-		});
-
-		assert.equal(parseBody(cmd).explicitRequest, undefined);
-	});
-
-	it("does not set FIFO params for standard queues", () => {
-		const cmd = buildSyncMailboxesCommand({
-			queueUrl: STANDARD_QUEUE_URL,
-			accountId: "account-abc",
-		});
-
-		assert.equal(cmd.input.MessageGroupId, undefined);
-		assert.equal(cmd.input.MessageDeduplicationId, undefined);
-	});
-
-	it("builds a SYNC_MAILBOXES event body with accountId and eventId", () => {
-		const cmd = buildSyncMailboxesCommand({
-			queueUrl: FIFO_QUEUE_URL,
-			accountId: "account-abc",
-		});
-
-		const event = parseBody(cmd);
-		assert.equal(event.type, "SYNC_MAILBOXES");
-		assert.equal(event.accountId, "account-abc");
-		assert.equal(typeof event.eventId, "string");
-		assert.equal(typeof event.timestamp, "number");
-	});
-
-	it("targets the configured queue url", () => {
-		const cmd = buildSyncMailboxesCommand({
-			queueUrl: FIFO_QUEUE_URL,
-			accountId: "account-abc",
-		});
-
-		assert.equal(cmd.input.QueueUrl, FIFO_QUEUE_URL);
-	});
-
-	it("uses the caller-supplied dedupId instead of the manual default", () => {
-		const cmd = buildSyncMailboxesCommand({
-			queueUrl: FIFO_QUEUE_URL,
-			accountId: "account-abc",
-			dedupId: "SYNC_MAILBOXES:scheduled:account-abc:12345",
-		});
-
-		assert.equal(
-			cmd.input.MessageDeduplicationId,
-			"SYNC_MAILBOXES:scheduled:account-abc:12345",
-		);
-	});
-});
-
-describe("buildScheduledSyncDedupId", () => {
-	const FIVE_MINUTES_MS = 5 * 60 * 1000;
-
-	it("is stable within the same time bucket (dedupes a retried tick)", () => {
-		const bucketStart = 10 * FIVE_MINUTES_MS;
-
-		const first = buildScheduledSyncDedupId(
-			"account-abc",
-			bucketStart,
-			FIVE_MINUTES_MS,
-		);
-		const second = buildScheduledSyncDedupId(
-			"account-abc",
-			bucketStart + 1_000,
-			FIVE_MINUTES_MS,
-		);
-
-		assert.equal(first, second);
-	});
-
-	it("changes across a bucket boundary (never dedupes two ticks apart)", () => {
-		const bucketStart = 10 * FIVE_MINUTES_MS;
-
-		const thisTick = buildScheduledSyncDedupId(
-			"account-abc",
-			bucketStart,
-			FIVE_MINUTES_MS,
-		);
-		const nextTick = buildScheduledSyncDedupId(
-			"account-abc",
-			bucketStart + FIVE_MINUTES_MS,
-			FIVE_MINUTES_MS,
-		);
-
-		assert.notEqual(thisTick, nextTick);
-	});
-});
-
-describe("triggerAccountSync", () => {
-	it("sends a SendMessageCommand to the client", async () => {
-		const sent: SendMessageCommand[] = [];
-		const sqsClient = {
-			send: async (cmd: SendMessageCommand) => {
-				sent.push(cmd);
-				return {};
-			},
-		} as unknown as SQSClient;
-
-		const result = await triggerAccountSync({
-			sqsClient,
-			queueUrl: FIFO_QUEUE_URL,
-			accountId: "account-xyz",
-		});
-
-		assert.equal(sent.length, 1);
-		const cmd = sent[0];
-		if (!cmd) throw new Error("expected command");
-		assert.ok(cmd instanceof SendMessageCommand);
-		assert.equal(cmd.input.MessageGroupId, "account-xyz");
-		assert.equal(typeof result.eventId, "string");
-	});
-
-	it("propagates SQS send errors to the caller", async () => {
-		const sqsClient = {
-			send: async () => {
-				throw new Error("MissingRequiredParameterException");
-			},
-		} as unknown as SQSClient;
-
-		await assert.rejects(
-			triggerAccountSync({
-				sqsClient,
-				queueUrl: FIFO_QUEUE_URL,
-				accountId: "account-xyz",
-			}),
-			/MissingRequiredParameterException/,
-		);
-	});
-});

package/src/service/trigger-sync.ts

@@ -1,100 +0,0 @@
-import { randomUUID } from "node:crypto";
-import { SendMessageCommand, type SQSClient } from "@aws-sdk/client-sqs";
-
-interface SyncMailboxesEvent {
-	type: "SYNC_MAILBOXES";
-	eventId: string;
-	timestamp: number;
-	accountId: string;
-	explicitRequest?: boolean;
-}
-
-interface TriggerAccountSyncInput {
-	sqsClient: SQSClient;
-	queueUrl: string;
-	accountId: string;
-	/**
-	 * Set by POST /sync, whose callers ask for a sync of one named account: the
-	 * refresh control, pull-to-refresh, and the web client's automatic poll
-	 * (`useStaleAccountSync`) — a timer, not a person. It travels on the event
-	 * and makes the worker's fan-out sync every mailbox even if one just ran.
-	 *
-	 * Everything else triggers a sync as a side effect of doing something else
-	 * (config load, OAuth connect, account create, the scheduled tick), leaves
-	 * this unset, and takes the freshness gate — see `mailboxNeedsSync` in
-	 * imap-worker's sync-mailboxes handler.
-	 *
-	 * How often a timer may do that is bounded on the client, by the poll's own
-	 * floor (`MIN_POLL_INTERVAL_MS` in the client hook, 30s) rather than by the
-	 * gate: `mailboxPollIntervalSeconds` can lengthen the interval, never
-	 * shorten it past that.
-	 */
-	explicitRequest?: boolean;
-	/**
-	 * Override the FIFO `MessageDeduplicationId`. Defaults to the event's own
-	 * id, so the queue suppresses a re-send of one event and nothing else —
-	 * every manual call site (POST /sync, OAuth connect, config load,
-	 * pull-to-refresh, the client's online-poll) always enqueues. A shared,
-	 * time-bucketed id instead turned SQS's 5-minute window into a rate limiter
-	 * and silently discarded a sync the user asked for whenever one had run
-	 * recently (issue #37). What a trigger costs is bounded in the worker's
-	 * fan-out (`mailboxNeedsSync`), by skipping mailboxes not worth
-	 * re-enumerating — never by dropping the trigger.
-	 *
-	 * The scheduled-sync tick (#1247) passes `buildScheduledSyncDedupId()`,
-	 * which is bucketed by the tick's own cadence: there it collapses a
-	 * re-invocation of a single tick, never two ticks or a manual trigger.
-	 */
-	dedupId?: string;
-}
-
-const isFifoQueue = (queueUrl: string): boolean => queueUrl.endsWith(".fifo");
-
-/**
- * Build the scheduler's own dedup namespace, bucketed by tick interval so
- * consecutive ticks each get a fresh id (never colliding with each other)
- * while still deduping a genuine double-invocation of the same tick (e.g. a
- * retried Lambda) — see `dedupId` above.
- */
-export const buildScheduledSyncDedupId = (
-	accountId: string,
-	now: number,
-	bucketMs: number,
-): string => {
-	const bucket = Math.floor(now / bucketMs);
-	return `SYNC_MAILBOXES:scheduled:${accountId}:${bucket}`;
-};
-
-export const buildSyncMailboxesCommand = (
-	input: Omit<TriggerAccountSyncInput, "sqsClient">,
-): SendMessageCommand => {
-	const { queueUrl, accountId, dedupId, explicitRequest } = input;
-	const event: SyncMailboxesEvent = {
-		type: "SYNC_MAILBOXES",
-		eventId: randomUUID(),
-		timestamp: Date.now(),
-		accountId,
-		...(explicitRequest && { explicitRequest }),
-	};
-
-	const useFifo = isFifoQueue(queueUrl);
-
-	return new SendMessageCommand({
-		QueueUrl: queueUrl,
-		MessageBody: JSON.stringify(event),
-		...(useFifo && {
-			MessageGroupId: accountId,
-			MessageDeduplicationId: dedupId ?? event.eventId,
-		}),
-	});
-};
-
-export const triggerAccountSync = async (
-	input: TriggerAccountSyncInput,
-): Promise<{ eventId: string }> => {
-	const command = buildSyncMailboxesCommand(input);
-	await input.sqsClient.send(command);
-	const body = command.input.MessageBody ?? "{}";
-	const parsed = JSON.parse(body) as SyncMailboxesEvent;
-	return { eventId: parsed.eventId };
-};

package/src/stdout-capture-fixture.ts

@@ -1,40 +0,0 @@
-/**
- * A test's view of what a request wrote to the log.
- *
- * pino writes through `process.stdout` once its `write` is replaced, so the hook
- * is installed when this module is evaluated — import it above anything that
- * pulls in the logger. Writes pass through whenever nothing is capturing, so the
- * test runner's own output still reaches the terminal.
- */
-
-const originalWrite = process.stdout.write.bind(process.stdout);
-const written: string[] = [];
-let capturing = false;
-
-process.stdout.write = ((
-	chunk: string | Uint8Array,
-	...rest: unknown[]
-): boolean => {
-	if (capturing && typeof chunk === "string") {
-		written.push(chunk);
-		return true;
-	}
-	return (originalWrite as (...args: unknown[]) => boolean)(chunk, ...rest);
-}) as typeof process.stdout.write;
-
-export const captureStdout = async <T>(
-	run: () => Promise<T>,
-): Promise<{ result: T; logged: string }> => {
-	written.length = 0;
-	capturing = true;
-	try {
-		const result = await run();
-		return { result, logged: written.join("") };
-	} finally {
-		capturing = false;
-	}
-};
-
-export const restoreStdout = (): void => {
-	process.stdout.write = originalWrite as typeof process.stdout.write;
-};

package/src/types.ts

@@ -1,271 +0,0 @@
-import type { Context } from "openapi-backend";
-
-type MatchPrefix<
-	Prefix extends string,
-	S extends string,
-> = S extends `${Prefix}${infer _}` ? S : never;
-
-export type OperationIds =
-	| "MeOperations_deleteMe"
-	| "MeOperations_listVipSuggestions"
-	| "MeOperations_createExport"
-	| "MeOperations_getExport"
-	| "MeOperations_listQuarantine"
-	| "ConfigOperations_getConfig"
-	| "ConfigOperations_exportConfig"
-	| "ConfigOperations_importConfig"
-	| "SystemOperations_getSystemUpdate"
-	| "SystemOperations_applySystemUpdate"
-	| "AccountOperations_createAccount"
-	| "AccountOperations_testConnection"
-	| "AccountDetailOperations_updateAccount"
-	| "AccountDetailOperations_deleteAccount"
-	| "MicrosoftOAuthOperations_microsoftOAuthStart"
-	| "MicrosoftOAuthOperations_microsoftOAuthCallback"
-	| "MailboxOperations_listMailboxes"
-	| "MailboxOperations_createMailbox"
-	| "MailboxDetailOperations_getMailbox"
-	| "MailboxDetailOperations_renameMailbox"
-	| "MailboxDetailOperations_deleteMailbox"
-	| "FolderRoleOperations_appointFolderRole"
-	| "FilterOperations_listFilters"
-	| "FilterOperations_createFilter"
-	| "FilterDetailOperations_getFilter"
-	| "FilterDetailOperations_updateFilter"
-	| "FilterDetailOperations_deleteFilter"
-	| "LabelOperations_listLabels"
-	| "LabelOperations_createLabel"
-	| "LabelDetailOperations_getLabel"
-	| "LabelDetailOperations_updateLabel"
-	| "LabelDetailOperations_deleteLabel"
-	| "OrganizeOperations_createOrganizeJob"
-	| "OrganizeOperations_previewOrganize"
-	| "OrganizeJobDetailOperations_getOrganizeJob"
-	| "SyncOperations_triggerSync"
-	| "SyncOperations_getSyncStatus"
-	| "SemanticSearchOperations_semanticSearch"
-	| "ThreadDetailOperations_listThreadMessages"
-	| "UnifiedThreadOperations_listAllThreads"
-	| "ThreadOperations_listThreads"
-	| "ThreadOperations_searchThreads"
-	| "MessageOperations_describeMessage"
-	| "MessageOperations_getRawMessage"
-	| "MessageOperations_updateMessageFlags"
-	| "MessageBulkOperations_deleteMessages"
-	| "MessageBulkOperations_moveMessages"
-	| "MessageBulkOperations_updateFlags"
-	| "MessageBulkOperations_copyMessages"
-	| "MessageBulkOperations_updateMessageLabels"
-	| "MessageBulkOperations_reportSpam"
-	| "MessageBulkOperations_notSpam"
-	| "CalendarOperations_listCalendars"
-	| "CalendarOperations_createCalendar"
-	| "CalendarDetailOperations_getCalendar"
-	| "CalendarDetailOperations_updateCalendar"
-	| "CalendarDetailOperations_deleteCalendar"
-	| "CalendarDetailOperations_getCalendarFeed"
-	| "CalendarDetailOperations_putCalendarFeed"
-	| "CalendarDetailOperations_revokeCalendarFeed"
-	| "CalendarFeedOperations_getCalendarFeedIcal"
-	| "CalendarEventOperations_listCalendarEvents"
-	| "CalendarEventOperations_createCalendarEvent"
-	| "CalendarEventDetailOperations_getCalendarEvent"
-	| "CalendarEventDetailOperations_updateCalendarEvent"
-	| "CalendarEventDetailOperations_deleteCalendarEvent"
-	| "CalendarFreeBusyOperations_listCalendarFreeBusy"
-	| "TrashOperations_emptyTrash"
-	| "OutboxOperations_createOutboxMessage"
-	| "OutboxOperations_listOutboxMessages"
-	| "OutboxDetailOperations_getOutboxMessage"
-	| "OutboxDetailOperations_updateOutboxMessage"
-	| "OutboxDetailOperations_deleteOutboxMessage"
-	| "OutboxDetailOperations_sendOutboxMessage"
-	| "OutboxDetailOperations_mintOutboxAttachment"
-	| "OutboxAttachmentOperations_completeOutboxAttachment"
-	| "AddressOperations_searchAddresses"
-	| "AddressDetailOperations_updateAddress"
-	| "CalendarSuggestionOperations_listCalendarSuggestions"
-	| "MessageCalendarSuggestionOperations_listMessageCalendarSuggestions"
-	| "CalendarSuggestionActionOperations_acceptCalendarSuggestion"
-	| "CalendarSuggestionActionOperations_declineCalendarSuggestion"
-	| "CalendarSuggestionActionOperations_dismissCalendarSuggestion"
-	| "CalendarSuggestionActionOperations_reopenCalendarSuggestion";
-
-export type MeOperationIds = MatchPrefix<"MeOperations_", OperationIds>;
-
-export type ConfigOperationIds = MatchPrefix<"ConfigOperations_", OperationIds>;
-
-export type SystemOperationIds = MatchPrefix<"SystemOperations_", OperationIds>;
-
-export type AccountOperationIds = MatchPrefix<
-	"AccountOperations_",
-	OperationIds
->;
-
-export type AccountDetailOperationIds = MatchPrefix<
-	"AccountDetailOperations_",
-	OperationIds
->;
-
-export type MailboxOperationIds = MatchPrefix<
-	"MailboxOperations_",
-	OperationIds
->;
-
-export type MailboxDetailOperationIds = MatchPrefix<
-	"MailboxDetailOperations_",
-	OperationIds
->;
-
-export type FolderRoleOperationIds = MatchPrefix<
-	"FolderRoleOperations_",
-	OperationIds
->;
-
-export type FilterOperationIds = MatchPrefix<"FilterOperations_", OperationIds>;
-
-export type FilterDetailOperationIds = MatchPrefix<
-	"FilterDetailOperations_",
-	OperationIds
->;
-
-export type LabelOperationIds = MatchPrefix<"LabelOperations_", OperationIds>;
-
-export type LabelDetailOperationIds = MatchPrefix<
-	"LabelDetailOperations_",
-	OperationIds
->;
-
-export type OrganizeOperationIds = MatchPrefix<
-	"OrganizeOperations_",
-	OperationIds
->;
-
-export type OrganizeJobDetailOperationIds = MatchPrefix<
-	"OrganizeJobDetailOperations_",
-	OperationIds
->;
-
-export type SyncOperationIds = MatchPrefix<"SyncOperations_", OperationIds>;
-
-export type ThreadDetailOperationIds = MatchPrefix<
-	"ThreadDetailOperations_",
-	OperationIds
->;
-
-export type UnifiedThreadOperationIds = MatchPrefix<
-	"UnifiedThreadOperations_",
-	OperationIds
->;
-
-export type ThreadOperationIds = MatchPrefix<"ThreadOperations_", OperationIds>;
-
-export type SemanticSearchOperationIds = MatchPrefix<
-	"SemanticSearchOperations_",
-	OperationIds
->;
-
-export type MessageOperationIds = MatchPrefix<
-	"MessageOperations_",
-	OperationIds
->;
-
-export type MessageBulkOperationIds = MatchPrefix<
-	"MessageBulkOperations_",
-	OperationIds
->;
-
-export type CalendarOperationIds = MatchPrefix<
-	"CalendarOperations_",
-	OperationIds
->;
-
-export type CalendarDetailOperationIds = MatchPrefix<
-	"CalendarDetailOperations_",
-	OperationIds
->;
-
-/**
- * The feed sub-resource of `/calendars/{calendarId}`, handled beside the
- * collection itself rather than inside it: minting a credential and serving one
- * calendar's settings are different jobs on the same path.
- */
-export type CalendarFeedDetailOperationIds =
-	| "CalendarDetailOperations_getCalendarFeed"
-	| "CalendarDetailOperations_putCalendarFeed"
-	| "CalendarDetailOperations_revokeCalendarFeed";
-
-export type CalendarCollectionDetailOperationIds = Exclude<
-	CalendarDetailOperationIds,
-	CalendarFeedDetailOperationIds
->;
-
-export type CalendarFeedOperationIds = MatchPrefix<
-	"CalendarFeedOperations_",
-	OperationIds
->;
-
-export type CalendarEventOperationIds = MatchPrefix<
-	"CalendarEventOperations_",
-	OperationIds
->;
-
-export type CalendarEventDetailOperationIds = MatchPrefix<
-	"CalendarEventDetailOperations_",
-	OperationIds
->;
-
-export type CalendarFreeBusyOperationIds = MatchPrefix<
-	"CalendarFreeBusyOperations_",
-	OperationIds
->;
-
-export type TrashOperationIds = MatchPrefix<"TrashOperations_", OperationIds>;
-
-export type OutboxOperationIds = MatchPrefix<"OutboxOperations_", OperationIds>;
-
-export type OutboxDetailOperationIds = MatchPrefix<
-	"OutboxDetailOperations_",
-	OperationIds
->;
-
-export type OutboxAttachmentOperationIds = MatchPrefix<
-	"OutboxAttachmentOperations_",
-	OperationIds
->;
-
-export type AddressOperationIds = MatchPrefix<
-	"AddressOperations_",
-	OperationIds
->;
-
-export type AddressDetailOperationIds = MatchPrefix<
-	"AddressDetailOperations_",
-	OperationIds
->;
-
-export type MicrosoftOAuthOperationIds = MatchPrefix<
-	"MicrosoftOAuthOperations_",
-	OperationIds
->;
-
-export type CalendarSuggestionOperationIds = MatchPrefix<
-	"CalendarSuggestionOperations_",
-	OperationIds
->;
-
-export type MessageCalendarSuggestionOperationIds = MatchPrefix<
-	"MessageCalendarSuggestionOperations_",
-	OperationIds
->;
-
-export type CalendarSuggestionActionOperationIds = MatchPrefix<
-	"CalendarSuggestionActionOperations_",
-	OperationIds
->;
-
-// biome-ignore lint/suspicious/noExplicitAny: handler responses vary by operation
-type HandlerResponse = Record<string, any>;
-export type OperationHandler<_T extends OperationIds = OperationIds> = (
-	context: Context,
-) => Promise<HandlerResponse>;

package/tsconfig.json

@@ -1,7 +0,0 @@
-{
-	"extends": "../../tsconfig.json",
-	"compilerOptions": {
-		"outDir": "dist"
-	},
-	"include": ["src/**/*.ts", "dev-server/**/*.ts", "scripts/**/*.ts"]
-}