refactor: move request converters to @workflow/builders (#503)

sveltekit and astro use the exact same code for normalizing requests so it's been refactored to `request-converter.ts` inside `@workflow/builders`

Author: adriandlam

.changeset/deep-falcons-pick.md

@@ -0,0 +1,7 @@
+---
+"@workflow/sveltekit": patch
+"@workflow/builders": patch
+"@workflow/astro": patch
+---
+
+Refactor request converter code in SvelteKit and Astro builder to @workflow/builders

packages/astro/src/builder.ts

@@ -5,22 +5,9 @@ import {
   VercelBuildOutputAPIBuilder,
   createBaseBuilderConfig,
   type AstroConfig,
+  NORMALIZE_REQUEST_CODE,
 } from '@workflow/builders';
 
-// NOTE: This is the same as SvelteKit request converter, should merge
-const NORMALIZE_REQUEST_CONVERTER = `
-async function normalizeRequestConverter(request) {
-  const options = {
-    method: request.method,
-    headers: new Headers(request.headers)
-  };
-  if (!['GET', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'].includes(request.method)) {
-    options.body = await request.arrayBuffer();
-  }
-  return new Request(request.url, options);
-}
-`;
-
 const WORKFLOW_ROUTES = [
   {
     src: '^/\\.well-known/workflow/v1/flow/?$',
@@ -105,9 +92,9 @@ export class LocalBuilder extends BaseBuilder {
     // Normalize request, needed for preserving request through astro
     stepsRouteContent = stepsRouteContent.replace(
       /export\s*\{\s*stepEntrypoint\s+as\s+POST\s*\}\s*;?$/m,
-      `${NORMALIZE_REQUEST_CONVERTER}
+      `${NORMALIZE_REQUEST_CODE}
 export const POST = async ({request}) => {
-  const normalRequest = await normalizeRequestConverter(request);
+  const normalRequest = await normalizeRequest(request);
   return stepEntrypoint(normalRequest);
 }
 
@@ -143,9 +130,9 @@ export const prerender = false;`
     // Normalize request, needed for preserving request through astro
     workflowsRouteContent = workflowsRouteContent.replace(
       /export const POST = workflowEntrypoint\(workflowCode\);?$/m,
-      `${NORMALIZE_REQUEST_CONVERTER}
+      `${NORMALIZE_REQUEST_CODE}
 export const POST = async ({request}) => {
-  const normalRequest = await normalizeRequestConverter(request);
+  const normalRequest = await normalizeRequest(request);
   return workflowEntrypoint(workflowCode)(normalRequest);
 }
 
@@ -185,9 +172,9 @@ export const prerender = false;`
     // Normalize request, needed for preserving request through astro
     webhookRouteContent = webhookRouteContent.replace(
       /export const GET = handler;\nexport const POST = handler;\nexport const PUT = handler;\nexport const PATCH = handler;\nexport const DELETE = handler;\nexport const HEAD = handler;\nexport const OPTIONS = handler;/,
-      `${NORMALIZE_REQUEST_CONVERTER}
+      `${NORMALIZE_REQUEST_CODE}
 const createHandler = (method) => async ({ request, params, platform }) => {
-  const normalRequest = await normalizeRequestConverter(request);
+  const normalRequest = await normalizeRequest(request);
   const response = await handler(normalRequest, params.token);
   return response;
 };

packages/builders/src/index.ts

@@ -19,3 +19,4 @@ export type {
 export { isValidBuildTarget, validBuildTargets } from './types.js';
 export { VercelBuildOutputAPIBuilder } from './vercel-build-output-api.js';
 export { createBuildQueue } from './build-queue.js';
+export { NORMALIZE_REQUEST_CODE } from './request-converter.js';

packages/builders/src/request-converter.ts

@@ -0,0 +1,14 @@
+const NORMALIZE_REQUEST_CODE = `
+async function normalizeRequest(request) {
+  const options = {
+    method: request.method,
+    headers: new Headers(request.headers)
+  };
+  if (!['GET', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'].includes(request.method)) {
+    options.body = await request.arrayBuffer();
+  }
+  return new Request(request.url, options);
+}
+`;
+
+export { NORMALIZE_REQUEST_CODE };

packages/sveltekit/src/builder.ts

@@ -1,21 +1,11 @@
 import { constants } from 'node:fs';
 import { access, mkdir, readFile, stat, writeFile } from 'node:fs/promises';
 import { join, resolve } from 'node:path';
-import { BaseBuilder, type SvelteKitConfig } from '@workflow/builders';
-
-// Helper function code for converting SvelteKit requests to standard Request objects
-const SVELTEKIT_REQUEST_CONVERTER = `
-async function convertSvelteKitRequest(request) {
-  const options = {
-    method: request.method,
-    headers: new Headers(request.headers)
-  };
-  if (!['GET', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'].includes(request.method)) {
-    options.body = await request.arrayBuffer();
-  }
-  return new Request(request.url, options);
-}
-`;
+import {
+  BaseBuilder,
+  type SvelteKitConfig,
+  NORMALIZE_REQUEST_CODE,
+} from '@workflow/builders';
 
 export class SvelteKitBuilder extends BaseBuilder {
   constructor(config?: Partial<SvelteKitConfig>) {
@@ -93,9 +83,9 @@ export class SvelteKitBuilder extends BaseBuilder {
     // Replace the default export with SvelteKit-compatible handler
     stepsRouteContent = stepsRouteContent.replace(
       /export\s*\{\s*stepEntrypoint\s+as\s+POST\s*\}\s*;?$/m,
-      `${SVELTEKIT_REQUEST_CONVERTER}
+      `${NORMALIZE_REQUEST_CODE}
 export const POST = async ({request}) => {
-  const normalRequest = await convertSvelteKitRequest(request);
+  const normalRequest = await normalizeRequest(request);
   return stepEntrypoint(normalRequest);
 }`
     );
@@ -134,9 +124,9 @@ export const POST = async ({request}) => {
     // Replace the default export with SvelteKit-compatible handler
     workflowsRouteContent = workflowsRouteContent.replace(
       /export const POST = workflowEntrypoint\(workflowCode\);?$/m,
-      `${SVELTEKIT_REQUEST_CONVERTER}
+      `${NORMALIZE_REQUEST_CODE}
 export const POST = async ({request}) => {
-  const normalRequest = await convertSvelteKitRequest(request);
+  const normalRequest = await normalizeRequest(request);
   return workflowEntrypoint(workflowCode)(normalRequest);
 }`
     );
@@ -177,9 +167,9 @@ export const POST = async ({request}) => {
     // Replace all HTTP method exports with SvelteKit-compatible handlers
     webhookRouteContent = webhookRouteContent.replace(
       /export const GET = handler;\nexport const POST = handler;\nexport const PUT = handler;\nexport const PATCH = handler;\nexport const DELETE = handler;\nexport const HEAD = handler;\nexport const OPTIONS = handler;/,
-      `${SVELTEKIT_REQUEST_CONVERTER}
+      `${NORMALIZE_REQUEST_CODE}
 const createSvelteKitHandler = (method) => async ({ request, params, platform }) => {
-  const normalRequest = await convertSvelteKitRequest(request);
+  const normalRequest = await normalizeRequest(request);
   const response = await handler(normalRequest, params.token);
   return response;
 };