@remit/backend 0.0.143 → 0.0.145

package/src/handlers/organize.test.ts

@@ -1,277 +0,0 @@
-import assert from "node:assert/strict";
-import { afterEach, describe, it, mock } from "node:test";
-import type { SendMessageCommand } from "@aws-sdk/client-sqs";
-import type { OrganizeInput } from "@remit/api-openapi-types";
-import type {
-	CreateOrganizeJobRequestInput,
-	FilterItem,
-	IAccountRepository,
-	IOrganizeJobRequestRepository,
-	OrganizeJobRequestItem,
-} from "@remit/data-ports";
-import { BadRequestError, NotFoundError } from "@remit/data-ports/errors";
-import { FilterMatchOperator } from "@remit/domain-enums";
-import type { APIGatewayProxyEvent, APIGatewayProxyResult } from "aws-lambda";
-import type { Context } from "openapi-backend";
-import { deriveAccountConfigId } from "../auth.js";
-import { handleError } from "../error.js";
-import { formatResponse } from "../response.js";
-import {
-	_resetForTest,
-	type RemitClient,
-	setClient,
-} from "../service/data-client.js";
-import { sqsClient } from "../service/sqs.js";
-import { OrganizeOperations, predicateFromInput } from "./organize.js";
-
-const input = (over: Partial<OrganizeInput> = {}): OrganizeInput => ({
-	matchOperator: FilterMatchOperator.And,
-	literalClauses: [],
-	actionLabelId: "None",
-	actionMailboxId: "None",
-	...over,
-});
-
-// A move back-apply is accepted end to end: createOrganizeJob and
-// previewOrganize no longer reject `actionMailboxId` up front (the removed
-// label-only 400). Both endpoints flatten the request into the predicate the
-// job row and the matcher share, so the proof of acceptance is that the move
-// action survives that mapping verbatim — the worker then applies it through
-// the wired placement mover (see service/organize.test.ts).
-describe("predicateFromInput (move back-apply accepted)", () => {
-	it("carries a requested move action through to the predicate", () => {
-		const predicate = predicateFromInput(
-			input({ actionMailboxId: "mbox-target" }),
-		);
-		assert.equal(predicate.actionMailboxId, "mbox-target");
-		assert.equal(predicate.actionLabelId, "None");
-	});
-
-	it("carries a combined move + label action through to the predicate", () => {
-		const predicate = predicateFromInput(
-			input({ actionLabelId: "lbl-1", actionMailboxId: "mbox-target" }),
-		);
-		assert.equal(predicate.actionMailboxId, "mbox-target");
-		assert.equal(predicate.actionLabelId, "lbl-1");
-	});
-
-	it("preserves the None sentinel for an absent action", () => {
-		const predicate = predicateFromInput(input());
-		assert.equal(predicate.actionMailboxId, "None");
-		assert.equal(predicate.actionLabelId, "None");
-	});
-});
-
-// The matcher returns a body-content (HasWords) refusal as a result (see
-// service/organize.test.ts); previewOrganize is the boundary that words it as a
-// BadRequestError. Proving the 4xx actually reaches the wire — not just that the
-// right class is raised — means proving the shared error handler maps it, since
-// a plain Error would otherwise fall through to a 500 (reader #457).
-describe("previewOrganize rejected-rule response (reader #457)", () => {
-	it("maps a rejected HasWords clause to a 400 naming the reason, not a 500", async () => {
-		const error = new BadRequestError(
-			"Organize literal matching cannot evaluate a body-content (HasWords) clause without the vector pipeline — it requires the semantic widen path",
-		);
-
-		const response = await handleError(error);
-
-		assert.equal(response.statusCode, 400);
-		assert.match(JSON.parse(response.body).message, /HasWords/);
-	});
-});
-
-const SUB = "cognito-sub-995";
-const ACCOUNT_CONFIG_ID = deriveAccountConfigId(SUB);
-const ACCOUNT_ID = "acc-995";
-
-const createdRows: CreateOrganizeJobRequestInput[] = [];
-const enqueued: SendMessageCommand[] = [];
-
-const installClient = (): void => {
-	createdRows.length = 0;
-	setClient({
-		account: {
-			get: async () => ({
-				accountId: ACCOUNT_ID,
-				accountConfigId: ACCOUNT_CONFIG_ID,
-			}),
-		} as unknown as IAccountRepository,
-		organizeJobRequest: {
-			create: async (input: CreateOrganizeJobRequestInput) => {
-				createdRows.push(input);
-				return {
-					...input,
-					organizeJobId: `job-${createdRows.length}`,
-					state: "Pending",
-				} as unknown as OrganizeJobRequestItem;
-			},
-		} as unknown as IOrganizeJobRequestRepository,
-	} as unknown as RemitClient);
-};
-
-const authorizedEvent = (): APIGatewayProxyEvent =>
-	({
-		body: null,
-		requestContext: { authorizer: { claims: { sub: SUB } } },
-	}) as unknown as APIGatewayProxyEvent;
-
-const createJob = OrganizeOperations.OrganizeOperations_createOrganizeJob as (
-	context: Context,
-	event: APIGatewayProxyEvent,
-) => Promise<Record<string, unknown>>;
-
-/** The response the browser receives, error funnel included. */
-const postOrganize = async (
-	body: OrganizeInput,
-): Promise<APIGatewayProxyResult> => {
-	const context = {
-		request: { params: { accountId: ACCOUNT_ID }, requestBody: body },
-	} as unknown as Context;
-	return createJob(context, authorizedEvent()).then(
-		(response) => formatResponse(response),
-		(error: unknown) => handleError(error),
-	);
-};
-
-// A rule the matcher can never honour — a body-content clause with no anchor to
-// widen from — is refused on the request instead of accepted with a 202 for a
-// job the worker can only fail (reader #463, #995). The contract now declares
-// the 400, so the proof is the response the client gets plus the absence of the
-// two side effects a 202 promises: a job row and a queued message.
-describe("createOrganizeJob rejected-rule refusal (reader #995)", () => {
-	afterEach(() => {
-		mock.restoreAll();
-		_resetForTest();
-	});
-
-	const withStubbedQueue = (): void => {
-		process.env.SQS_QUEUE_URL_ACCOUNT_FANOUT =
-			"http://localhost:9324/queue/account-fanout-test";
-		enqueued.length = 0;
-		mock.method(sqsClient, "send", async (command: SendMessageCommand) => {
-			enqueued.push(command);
-			return {};
-		});
-		installClient();
-	};
-
-	it("refuses an anchorless body-content clause with a 400 and creates nothing", async () => {
-		withStubbedQueue();
-
-		const response = await postOrganize(
-			input({ literalClauses: [{ field: "HasWords", value: "invoice" }] }),
-		);
-
-		assert.equal(response.statusCode, 400);
-		assert.match(JSON.parse(response.body).message, /HasWords/);
-		assert.deepEqual(createdRows, []);
-		assert.deepEqual(enqueued, []);
-	});
-
-	it("accepts the same clause when an anchor gives the widen something to run on", async () => {
-		withStubbedQueue();
-
-		const response = await postOrganize(
-			input({
-				anchorMessageId: "msg-anchor",
-				literalClauses: [{ field: "HasWords", value: "invoice" }],
-			}),
-		);
-
-		assert.equal(response.statusCode, 202);
-		assert.equal(createdRows.length, 1);
-		assert.equal(enqueued.length, 1);
-		assert.match(
-			String(enqueued[0]?.input.MessageBody),
-			new RegExp(String(JSON.parse(response.body).organizeJobId)),
-		);
-	});
-});
-
-describe("createOrganizeJob by filterId — Run now (#1354)", () => {
-	afterEach(() => {
-		mock.restoreAll();
-		_resetForTest();
-	});
-
-	const standing = (state: FilterItem["state"]): FilterItem => ({
-		filterId: "flt-1",
-		accountConfigId: ACCOUNT_CONFIG_ID,
-		name: "Invoices",
-		scope: "Standing",
-		state,
-		disabledReason: state === "Active" ? "None" : "UserDisabled",
-		hasAnchor: false,
-		ruleChangedAt: 1,
-		actionChangedAt: 1,
-		matchOperator: FilterMatchOperator.And,
-		literalClauses: [{ field: "From", value: "billing@example.com" }],
-		actionLabelId: "None",
-		actionMailboxId: "mbx-invoices",
-		createdAt: 0,
-		updatedAt: 0,
-	});
-
-	const withFilter = (filter: FilterItem): void => {
-		process.env.SQS_QUEUE_URL_ACCOUNT_FANOUT =
-			"http://localhost:9324/queue/account-fanout-test";
-		enqueued.length = 0;
-		createdRows.length = 0;
-		mock.method(sqsClient, "send", async (command: SendMessageCommand) => {
-			enqueued.push(command);
-			return {};
-		});
-		setClient({
-			account: {
-				get: async () => ({
-					accountId: ACCOUNT_ID,
-					accountConfigId: ACCOUNT_CONFIG_ID,
-				}),
-			},
-			filter: {
-				get: async () => filter,
-			},
-			organizeJobRequest: {
-				create: async (row: CreateOrganizeJobRequestInput) => {
-					createdRows.push(row);
-					return { ...row, organizeJobId: "job-run", state: "Pending" };
-				},
-			},
-		} as unknown as RemitClient);
-	};
-
-	it("queues a job that names only the filter", async () => {
-		withFilter(standing("Active"));
-
-		const response = await postOrganize(input({ filterId: "flt-1" }));
-
-		assert.equal(response.statusCode, 202);
-		assert.equal(createdRows[0]?.filterId, "flt-1");
-		assert.equal(createdRows[0]?.actionMailboxId, "None");
-		assert.deepEqual(createdRows[0]?.literalClauses, []);
-		assert.equal(enqueued.length, 1);
-	});
-
-	it("answers an unknown filter with a 404 and queues nothing", async () => {
-		withFilter(standing("Active"));
-		setClient({
-			account: {
-				get: async () => ({
-					accountId: ACCOUNT_ID,
-					accountConfigId: ACCOUNT_CONFIG_ID,
-				}),
-			},
-			filter: {
-				get: async () => {
-					throw new NotFoundError("Filter not found: flt-gone");
-				},
-			},
-		} as unknown as RemitClient);
-
-		const response = await postOrganize(input({ filterId: "flt-gone" }));
-
-		assert.equal(response.statusCode, 404);
-		assert.deepEqual(createdRows, []);
-		assert.deepEqual(enqueued, []);
-	});
-});

package/src/handlers/organize.ts

@@ -1,197 +0,0 @@
-import type {
-	CreateOrganizeJobResponse,
-	OrganizeInput,
-	OrganizeJobResponse,
-	OrganizePreviewResponse,
-} from "@remit/api-openapi-types";
-import { BadRequestError, NotFoundError } from "@remit/data-ports/errors";
-import type { APIGatewayProxyEvent } from "aws-lambda";
-import type { Context } from "openapi-backend";
-import { getAccountConfigIdFromEvent, getSubFromEvent } from "../auth.js";
-import { getClient, type RemitClient } from "../service/data-client.js";
-import {
-	buildOrganizeMatchDeps,
-	matchOrganize,
-	ORGANIZE_MATCH_LIMIT,
-	type OrganizePredicate,
-	organizePredicateRejection,
-} from "../service/organize.js";
-import {
-	type OrganizeJobRequest,
-	queueOrganizeJob,
-} from "../service/organize-queue.js";
-import type {
-	OperationHandler,
-	OrganizeJobDetailOperationIds,
-	OrganizeOperationIds,
-} from "../types.js";
-import { assertAccountOwnership } from "./account-ownership.js";
-
-const NONE = "None";
-
-/**
- * Normalize the request body into the flattened predicate the job row and the
- * matcher share. `anchorMessageId` collapses to the `"None"` sentinel when
- * absent, and `similarityThreshold` to the server default — the persisted entity
- * carries no optional fields (RFC 032).
- */
-export const predicateFromInput = (
-	input: OrganizeInput,
-): OrganizePredicate => ({
-	anchorMessageId: input.anchorMessageId ?? NONE,
-	matchOperator: input.matchOperator,
-	literalClauses: input.literalClauses,
-	similarityThreshold: input.similarityThreshold ?? 0.75,
-	actionLabelId: input.actionLabelId,
-	actionMailboxId: input.actionMailboxId,
-});
-
-const assertAccount = async (
-	client: RemitClient,
-	accountId: string,
-	accountConfigId: string,
-	mode: "read" | "act",
-): Promise<void> => {
-	const account = await client.account.get(accountId);
-	assertAccountOwnership(account, accountConfigId, mode);
-};
-
-const toOrganizeJobResponse = (
-	job: Awaited<ReturnType<RemitClient["organizeJobRequest"]["get"]>>,
-): OrganizeJobResponse => ({
-	organizeJobId: job.organizeJobId,
-	accountConfigId: job.accountConfigId,
-	userId: job.userId,
-	state: job.state,
-	filterId: job.filterId,
-	anchorMessageId: job.anchorMessageId,
-	matchOperator: job.matchOperator,
-	literalClauses: job.literalClauses,
-	similarityThreshold: job.similarityThreshold,
-	actionLabelId: job.actionLabelId,
-	actionMailboxId: job.actionMailboxId,
-	matchedCount: job.matchedCount,
-	appliedCount: job.appliedCount,
-	failedCount: job.failedCount,
-	errorMessage: job.errorMessage,
-	createdAt: job.createdAt,
-	updatedAt: job.updatedAt,
-});
-
-/**
- * What a create asks the worker to run. A saved filter is named and read when
- * the job runs, so Run now and a filter's create share one path (#1354); an
- * "all like these" predicate the matcher can never honour is answered here,
- * not with a 202 the worker has to fail later (reader #463).
- */
-const requestedJob = async (
-	client: RemitClient,
-	owner: { accountConfigId: string; userId: string },
-	input: OrganizeInput,
-): Promise<OrganizeJobRequest> => {
-	if (input.filterId) {
-		await client.filter.get(owner.accountConfigId, input.filterId);
-		return { ...owner, filterId: input.filterId };
-	}
-	const predicate = predicateFromInput(input);
-	const rejection = organizePredicateRejection(predicate);
-	if (rejection) throw new BadRequestError(rejection.message);
-	return { ...owner, predicate };
-};
-
-export const OrganizeOperations: Record<
-	OrganizeOperationIds,
-	OperationHandler<OrganizeOperationIds>
-> = {
-	OrganizeOperations_createOrganizeJob: async (
-		context: Context,
-		...args: unknown[]
-	): Promise<CreateOrganizeJobResponse> => {
-		const event = args[0] as APIGatewayProxyEvent;
-		const accountConfigId = getAccountConfigIdFromEvent(event);
-		const { accountId } = context.request.params as { accountId: string };
-		const input = context.request.requestBody as OrganizeInput;
-
-		const userId = getSubFromEvent(event);
-		if (!userId) {
-			throw new Error(
-				"Missing Cognito `sub`: cannot attribute an organize job to a user",
-			);
-		}
-
-		const client = await getClient();
-		await assertAccount(client, accountId, accountConfigId, "act");
-
-		const job = await queueOrganizeJob(
-			client,
-			await requestedJob(client, { accountConfigId, userId }, input),
-		);
-
-		return {
-			statusCode: 202,
-			organizeJobId: job.organizeJobId,
-			state: job.state,
-		};
-	},
-
-	OrganizeOperations_previewOrganize: async (
-		context: Context,
-		...args: unknown[]
-	): Promise<OrganizePreviewResponse> => {
-		const event = args[0] as APIGatewayProxyEvent;
-		const accountConfigId = getAccountConfigIdFromEvent(event);
-		const { accountId } = context.request.params as { accountId: string };
-		const input = context.request.requestBody as OrganizeInput;
-
-		const client = await getClient();
-		await assertAccount(client, accountId, accountConfigId, "read");
-
-		if (input.filterId) {
-			throw new BadRequestError(
-				"Preview takes a rule, not a saved filter. Run the filter to apply it.",
-			);
-		}
-		const result = await matchOrganize(
-			buildOrganizeMatchDeps(client),
-			accountConfigId,
-			predicateFromInput(input),
-			ORGANIZE_MATCH_LIMIT,
-		);
-		if (result.rejected) throw new BadRequestError(result.rejected.message);
-
-		const response: OrganizePreviewResponse = {
-			matchedCount: result.messageIds.length,
-			messageIds: result.messageIds,
-		};
-		if (result.semanticUnavailable) response.semanticUnavailable = true;
-		if (result.semanticIndexEmpty) response.semanticIndexEmpty = true;
-		return response;
-	},
-};
-
-export const OrganizeJobDetailOperations: Record<
-	OrganizeJobDetailOperationIds,
-	OperationHandler<OrganizeJobDetailOperationIds>
-> = {
-	OrganizeJobDetailOperations_getOrganizeJob: async (
-		context: Context,
-		...args: unknown[]
-	): Promise<OrganizeJobResponse> => {
-		const event = args[0] as APIGatewayProxyEvent;
-		const accountConfigId = getAccountConfigIdFromEvent(event);
-		const { accountId, organizeJobId } = context.request.params as {
-			accountId: string;
-			organizeJobId: string;
-		};
-
-		const client = await getClient();
-		await assertAccount(client, accountId, accountConfigId, "read");
-
-		const job = await client.organizeJobRequest.get(organizeJobId);
-		if (job.accountConfigId !== accountConfigId) {
-			throw new NotFoundError(`Organize job not found: ${organizeJobId}`);
-		}
-
-		return toOrganizeJobResponse(job);
-	},
-};