wirejs-deploy-amplify-basic 0.0.121 → 0.0.122-async-api

package/amplify-backend-assets/backend.ts

@@ -1,3 +1,4 @@
+import { randomUUID } from 'crypto';
 import {
   defineBackend,
 } from '@aws-amplify/backend';
@@ -6,6 +7,7 @@ import { FunctionUrlAuthType } from 'aws-cdk-lib/aws-lambda';
 import { Bucket, BlockPublicAccess } from 'aws-cdk-lib/aws-s3';
 import { Table, AttributeType, BillingMode } from 'aws-cdk-lib/aws-dynamodb';
 import { PolicyStatement } from 'aws-cdk-lib/aws-iam';
+
 import { TableDefinition, Resource, indexName } from 'wirejs-resources';
 import { TableIndexes } from './constructs/table-indexes';
 import { RealtimeService } from './constructs/realtime-service';
@@ -14,12 +16,19 @@ import { auth } from './auth/resource';
 
 // @ts-ignore
 import generatedResources from './generated-resources';
+
 const generated: any[] = generatedResources;
 
 const APP_ID = process.env.AWS_APP_ID ?? process.env.PWD?.replace(/[^a-zA-Z0-9-_]/g, '_');
 const BRANCH_ID = process.env.AWS_BRANCH ?? process.env.USER ?? 'anonymous';
 const TABLE_NAME_PREFIX = `${APP_ID}-${BRANCH_ID}-`;
 
+/**
+ * Simple secret ID used for backend jobs to authenticate themselves with
+ * each other. I.e., for API to trigger background jobs.
+ */
+const SELF_INVOCATION_ID = randomUUID();
+
 /**
  * Amplify resources
  */
@@ -177,6 +186,9 @@ backend.api.addEnvironment(
 backend.api.addEnvironment(
   'TABLE_NAME_PREFIX', TABLE_NAME_PREFIX
 );
+backend.api.addEnvironment(
+  'SELF_INVOCATION_ID', SELF_INVOCATION_ID
+);
 
 
 /**

package/amplify-backend-assets/functions/api/handler.ts

@@ -1,6 +1,11 @@
 import { env } from 'process';
 import { LambdaFunctionURLHandler, APIGatewayProxyEventV2 } from 'aws-lambda';
-import { CookieJar, Context, requiresContext } from 'wirejs-resources';
+import {
+	BackgroundJob,
+	CookieJar,
+	Context,
+	requiresContext,
+} from 'wirejs-resources';
 
 // @ts-ignore
 import * as api from '../../../api/index';
@@ -44,33 +49,75 @@ async function callApiMethod(api: any, call: any, context: any) {
 	}
 }
 
+function isBackgroundJob(o: any): o is BackgroundJob<any> {
+	return typeof o === 'object' && typeof o.start === 'function';
+}
+
 export const handler: LambdaFunctionURLHandler = async (event, context) => {
 	const calls = JSON.parse(event.body!);
-	const responses = [];
-	const wjsContext = createContext(event);
 
-	for (const call of calls) {
-		console.log('handling API call', call);
-		responses.push(await callApiMethod(api, call, wjsContext));
-	}
+	if (Array.isArray(calls)) {
+		const responses = [];
+		const wjsContext = createContext(event);
+		for (const call of calls) {
+			console.log('handling API call', call);
+			responses.push(await callApiMethod(api, call, wjsContext));
+		}
+
+		console.log('setting cookies', wjsContext.cookies.getSetCookies());
+
+		const cookies: string[] = [];
+		for (const cookie of wjsContext.cookies.getSetCookies()) {
+			const cookieOptions = [];
+			if (cookie.maxAge) cookieOptions.push(`Max-Age=${cookie.maxAge}`);
+			if (cookie.httpOnly) cookieOptions.push('HttpOnly');
+			if (cookie.secure) cookieOptions.push('Secure');
+			cookies.push(`${cookie.name}=${cookie.value}; ${cookieOptions.join('; ')}`);
+		}
 	
-	console.log('setting cookies', wjsContext.cookies.getSetCookies());
+		return {
+			statusCode: 200,
+			cookies,
+			headers: {
+				'Content-Type': 'application/json; charset=utf-8'
+			},
+			body: JSON.stringify(responses)
+		}
+	} else if (typeof calls === 'object' && calls.async) {
+		console.log('handling async execution', calls);
 
-	const cookies: string[] = [];
-	for (const cookie of wjsContext.cookies.getSetCookies()) {
-		const cookieOptions = [];
-		if (cookie.maxAge) cookieOptions.push(`Max-Age=${cookie.maxAge}`);
-		if (cookie.httpOnly) cookieOptions.push('HttpOnly');
-		if (cookie.secure) cookieOptions.push('Secure');
-		cookies.push(`${cookie.name}=${cookie.value}; ${cookieOptions.join('; ')}`);
-	}
+		if (!calls.absoluteId) {
+			return {
+				statusCode: 400,
+				body: JSON.stringify({ error: 'Missing absoluteId' })
+			};
+		}
+
+		if (calls.selfInvocationId !== env.SELF_INVOCATION_ID) {
+			return {
+				statusCode: 403,
+				body: JSON.stringify({ error: 'Forbidden' })
+			};
+		}
+
+		const job = (BackgroundJob as any).registeredJobs[calls.absoluteId];
+		if (!job || !isBackgroundJob(job)) {
+			return {
+				statusCode: 404,
+				body: JSON.stringify({ error: 'Background job not found' })
+			};
+		}
+
+		await job.start(...calls.args)
 
-	return {
-		statusCode: 200,
-		cookies,
-		headers: {
-			'Content-Type': 'application/json; charset=utf-8'
-		},
-		body: JSON.stringify(responses)
+		return {
+			statusCode: 200,
+			body: JSON.stringify({ message: 'Background job complete' })
+		};
+	} else {
+		return {
+			statusCode: 400,
+			body: JSON.stringify({ error: 'Invalid request format' })
+		};
 	}
 }

package/amplify-hosting-assets/compute/default/package.json

@@ -3,6 +3,6 @@
 	"dependencies": {
 		"jsdom": "^25.0.1",
 		"wirejs-dom": "^1.0.41",
-		"wirejs-resources": "^0.1.89"
+		"wirejs-resources": "^0.1.90-async-api"
 	}
 }

package/dist/resources/background-job.d.ts

@@ -0,0 +1,36 @@
+import { Resource, BackgroundJob as BaseBackgroundJob } from 'wirejs-resources';
+export type BackgroundJobDefinition = {
+    absoluteId: string;
+    timeoutSeconds: number;
+};
+/**
+ * A function that will be executed in the background.
+ *
+ * Intended for longer-running work that will continue after an initial API response
+ * to the client.
+ *
+ * ## WARNINGS
+ *
+ * 1. It may execute in a completely different environment that the one that invoked it.
+ * DO NOT depend on global variables, closures, or other process state that is not lazily
+ * created or constructed in-place by the script.
+ * 2. Fire-and-forget behavior is undefined. As soon as the `Promise` returned by your
+ * function resolves, the execution environment is free to terminate the process.
+ * 3. In local development, **timeouts are not enforced.** (Yet.)
+ */
+export declare class BackgroundJob<T extends (...args: any) => Promise<void>> extends Resource implements Omit<BaseBackgroundJob<T>, '#private'> {
+    #private;
+    static registeredJobs: Record<string, BackgroundJob<any>>;
+    constructor(scope: Resource | string, id: string, options: {
+        handler: T;
+        timeoutSeconds?: number;
+    });
+    /**
+     * Serializes parameter data and schedules background execution.
+     *
+     * **NOTE:** This resolves once the job is scheduled; *not when it completes!*
+     *
+     * @param data
+     */
+    start(...args: Parameters<T>): Promise<void>;
+}

package/dist/resources/background-job.js

@@ -0,0 +1,59 @@
+import { env } from 'process';
+import { LambdaClient, InvokeCommand } from '@aws-sdk/client-lambda';
+import { Resource, } from 'wirejs-resources';
+import { addResource } from '../resource-collector.js';
+/**
+ * A function that will be executed in the background.
+ *
+ * Intended for longer-running work that will continue after an initial API response
+ * to the client.
+ *
+ * ## WARNINGS
+ *
+ * 1. It may execute in a completely different environment that the one that invoked it.
+ * DO NOT depend on global variables, closures, or other process state that is not lazily
+ * created or constructed in-place by the script.
+ * 2. Fire-and-forget behavior is undefined. As soon as the `Promise` returned by your
+ * function resolves, the execution environment is free to terminate the process.
+ * 3. In local development, **timeouts are not enforced.** (Yet.)
+ */
+export class BackgroundJob extends Resource {
+    #handler;
+    #timeoutSeconds;
+    static registeredJobs = {};
+    constructor(scope, id, options) {
+        super(scope, id);
+        this.#handler = options.handler;
+        if (options.timeoutSeconds && (options.timeoutSeconds < 1 || options.timeoutSeconds > 900)) {
+            throw new Error('timeoutSeconds must be between 1 and 900 seconds.');
+        }
+        this.#timeoutSeconds = options.timeoutSeconds ?? 900;
+        addResource('BackgroundJob', {
+            absoluteId: this.absoluteId,
+            timeoutSeconds: this.#timeoutSeconds,
+        });
+        BackgroundJob.registeredJobs[this.absoluteId] = this;
+    }
+    /**
+     * Serializes parameter data and schedules background execution.
+     *
+     * **NOTE:** This resolves once the job is scheduled; *not when it completes!*
+     *
+     * @param data
+     */
+    async start(...args) {
+        const client = new LambdaClient();
+        const command = new InvokeCommand({
+            FunctionName: env.AWS_LAMBDA_FUNCTION_NAME,
+            InvocationType: 'Event',
+            Payload: JSON.stringify({
+                body: {
+                    absoluteId: this.absoluteId,
+                    selfInvocationId: env.SELF_INVOCATION_ID,
+                    args,
+                },
+            }),
+        });
+        await client.send(command);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wirejs-deploy-amplify-basic",
-	"version": "0.0.121",
+	"version": "0.0.122-async-api",
 	"type": "module",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",
@@ -32,6 +32,7 @@
 		"@aws-sdk/client-dynamodb": "^3.774.0",
 		"@aws-sdk/client-s3": "^3.738.0",
 		"@aws-sdk/credential-provider-node": "^3.806.0",
+		"@aws-sdk/client-lambda": "3.821.0",
 		"@aws-sdk/lib-dynamodb": "^3.778.0",
 		"@aws-sdk/protocol-http": "^3.370.0",
 		"@aws-sdk/signature-v4": "^3.370.0",
@@ -41,7 +42,7 @@
 		"recursive-copy": "^2.0.14",
 		"rimraf": "^6.0.1",
 		"wirejs-dom": "^1.0.41",
-		"wirejs-resources": "^0.1.89"
+		"wirejs-resources": "^0.1.90-async-api"
 	},
 	"devDependencies": {
 		"@aws-amplify/backend": "^1.14.0",