Merge pull request #10 from galaxiajs/dev

dev

.changeset/proud-peaches-watch.md

@@ -0,0 +1,5 @@
+---
+"@galaxiajs/cloudflare-kit": patch
+---
+
+Add method to execute code after request handling

package.json

@@ -17,7 +17,7 @@
 		"---------------------------------------------------------------------------------": "",
 		"test": "turbo run test",
 		"test:watch": "turbo run test:watch",
-		"coverage": "turbo run coverage",
+		"coverage": "vitest run --coverage",
 		"----------------------------------------------------------------------------------": "",
 		"release": "changeset publish"
 	},
@@ -27,8 +27,10 @@
 		"@changesets/cli": "^2.27.5",
 		"@commitlint/cli": "^19.3.0",
 		"@commitlint/config-conventional": "^19.2.2",
+		"@vitest/coverage-istanbul": "1.5.0",
 		"lefthook": "^1.6.14",
-		"turbo": "^1.13.3"
+		"turbo": "^1.13.3",
+		"vitest": "1.5.0"
 	},
 	"packageManager": "[email protected]",
 	"engines": {

packages/cloudflare/package.json

@@ -44,44 +44,23 @@
 			"default": "./dist/vitest/index.js"
 		}
 	},
-	"files": [
-		"dist",
-		"package.json"
-	],
+	"files": ["dist", "package.json"],
 	"typesVersions": {
 		"*": {
-			".": [
-				"./dist/index"
-			],
-			"esbuild": [
-				"./dist/esbuild/index"
-			],
-			"cache": [
-				"./dist/cache/index"
-			],
-			"context": [
-				"./dist/context/index"
-			],
-			"cookies": [
-				"./dist/cookies/index"
-			],
-			"user-agent": [
-				"./dist/user-agent/index"
-			],
-			"vitest": [
-				"./dist/vitest/index"
-			],
-			"types": [
-				"./dist/index"
-			]
+			".": ["./dist/index"],
+			"esbuild": ["./dist/esbuild/index"],
+			"cache": ["./dist/cache/index"],
+			"context": ["./dist/context/index"],
+			"cookies": ["./dist/cookies/index"],
+			"user-agent": ["./dist/user-agent/index"],
+			"vitest": ["./dist/vitest/index"],
+			"types": ["./dist/index"]
 		}
 	},
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org"
 	},
-	"workspaces": [
-		"examples/**/*"
-	],
+	"workspaces": ["examples/**/*"],
 	"keywords": [
 		"api-kit",
 		"web",
@@ -131,7 +110,6 @@
 		"@types/node": "^20.13.0",
 		"@types/set-cookie-parser": "2.4.7",
 		"@types/ua-parser-js": "0.7.39",
-		"@vitest/coverage-istanbul": "1.5.0",
 		"publint": "^0.2.8",
 		"tsup": "^8.0.2",
 		"typescript": "^5.4.5",

packages/cloudflare/src/exports.ts

@@ -27,7 +27,7 @@ export {
 	type $Locals as Locals,
 	type $Secrets as Secrets,
 } from "./modules/env";
-export { executionContext, waitUntil } from "./modules/execution-context";
+export { executionContext, waitUntil, after } from "./modules/execution-context";
 export {
 	headers,
 	ip,

packages/cloudflare/src/handler.ts

@@ -8,6 +8,7 @@ import {
 } from "./modules/context/context";
 import { createContext, createLocals } from "./modules/context/utils";
 import type { Env } from "./modules/env";
+import { afters } from "./modules/execution-context";
 import type { ExportedWorker, Handler, MakeAsync, Promisable } from "./types";
 
 /**
@@ -77,12 +78,14 @@ export function handleRequest(ctx: IHandlerContext, handle: () => Promisable<Res
 		const injected = await createLocals();
 		return await LocalsContext.run(injected, async () => {
 			const result = await handle();
+			let response: Response;
+
 			if (result instanceof Response) {
 				for (const [key, value] of result.headers.entries()) {
 					ctx.response.headers.append(key, value);
 				}
 
-				return new Response(result.body, {
+				response = new Response(result.body, {
 					statusText: result.statusText,
 					status: result.status,
 					headers: ctx.response.headers as unknown as Headers,
@@ -93,12 +96,19 @@ export function handleRequest(ctx: IHandlerContext, handle: () => Promisable<Res
 					// @ts-expect-error is a CF only type
 					encodeBody: result.encodeBody,
 				});
+			} else {
+				response = createResponse(result, {
+					status: ctx.response.status,
+					headers: ctx.response.headers as unknown as Headers,
+				});
 			}
 
-			return createResponse(result, {
-				status: ctx.response.status,
-				headers: ctx.response.headers as unknown as Headers,
-			});
+			ctx.executionContext.waitUntil(handleAfter());
+			return response;
 		});
 	});
 }
+
+async function handleAfter() {
+	await Promise.all(afters.map((r) => r()));
+}

packages/cloudflare/src/modules/execution-context.ts

@@ -22,3 +22,32 @@ export function waitUntil(promise: Promise<any>): void {
 	const ctx = executionContext();
 	ctx.waitUntil(promise);
 }
+
+export const afters: Array<() => any> = [];
+
+/**
+ * Allows you to schedule work to be executed after a response is finished.
+ * This is useful for tasks and other side effects that should not block
+ * the response, such as logging and analytics.
+ *
+ * Unlike {@linkcode waitUntil}, this will run _after_ the response has turned,
+ * rather than being kicked off concurrently during the request cycle.
+ *
+ * `after()` will be executed even if the response didn't complete successfully,
+ * including when an error is thrown or when `redirect()` is called.
+ *
+ * Note that you cannot:
+ *
+ * - Set cookies
+ * - Modify response headers
+ * - Modify response status
+ *
+ * Inside `after()` as the response will have already been sent. Doing any of these
+ * will throw a Cloudflare error.
+ *
+ * @param {() => any} callback A function that will be executed after the response is finished.
+ * @returns {void}
+ */
+export function after(callback: () => any): void {
+	afters.push(callback);
+}

packages/cloudflare/vitest.config.ts

@@ -1,21 +1,12 @@
-import { defineWorkersConfig } from "@cloudflare/vitest-pool-workers/config";
+import { defineWorkersProject } from "@cloudflare/vitest-pool-workers/config";
 import paths from "vite-tsconfig-paths";
 
 const COMPATIBILITY_DATE = "2024-04-05";
 const COMPATIBILITY_FLAGS = ["nodejs_compat"];
 
-export default defineWorkersConfig({
+export default defineWorkersProject({
 	plugins: [paths()],
-	esbuild: {
-		// https://github.com/vitejs/vite/issues/15464#issuecomment-1872485703
-		target: "es2020",
-	},
 	test: {
-		coverage: {
-			all: true,
-			reportOnFailure: true,
-			provider: "istanbul",
-		},
 		poolOptions: {
 			workers: {
 				singleWorker: true,

vitest.config.ts

@@ -0,0 +1,20 @@
+import { coverageConfigDefaults, defineConfig } from "vitest/config";
+
+export default defineConfig({
+	test: {
+		coverage: {
+			provider: "istanbul",
+			reportOnFailure: true,
+			// TODO: Remove this once https://github.com/vitest-dev/vitest/issues/5856 is fixed
+			all: false,
+			exclude: [
+				...coverageConfigDefaults.exclude,
+				"**/__test__/**/*",
+				"**/__tests__/**/*",
+				"**/__mocks__/**/*",
+				"**/test/**/*",
+				"**/tests/**/*",
+			],
+		},
+	},
+});

vitest.workspace.ts

@@ -0,0 +1,9 @@
+import { defineWorkspace } from "vitest/config";
+
+export default defineWorkspace([
+	"packages/*/vite.config.ts",
+	"packages/*/vite.config.*.ts",
+	"packages/*/vitest.config.ts",
+	"packages/*/vitest.config.*.ts",
+	"!packages/**/*.d.ts",
+]);