Refactor runtime packages to conform to the Remix server runtime inte…

…rface (#2359) * feat(@remix-run/server-runtime): define interface for remix server runtimes * refactor(@remix-run/server-runtime): organize exports group types that should be re-exported by each remix server runtime * refactor(@remix-run/server-runtime): factories for crypto-dependent interface functions * docs(@remix-run/server-runtime): rewrite readme to explain the "remix server runtime interface" * refactor(@remix-run/node): conform to the remix server runtime interface instead of relying on magic exports * refactor(@remix-run/node): implement crypto-dependent interface functions * feat(@remix-run/cloudflare): create new server runtime package for cloudflare * refactor(@remix-run/cloudflare): implement crypto-dependent interface functions * refactor(remix-deno): conform to the remix server runtime interface * refactor(remix-deno): implement crypto-dependent interface functions * refactor(@remix-run/architect): use `@remix-run/node` instead of `@remix-run/server-runtime` * refactor(@remix-run/express): use `@remix-run/node` instead of `@remix-run/server-runtime` * refactor(@remix-run/netlify): use `@remix-run/node` instead of `@remix-run/server-runtime` * refactor(@remix-run/vercel): use `@remix-run/node` instead of `@remix-run/server-runtime` * refactor(@remix-run/cloudflare-workers): use `@remix-run/cloudflare` instead of `@remix-run/server-runtime` * refactor(@remix-run/cloudflare-pages): use `@remix-run/cloudflare` instead of `@remix-run/server-runtime` * refactor(server-runtimes,adapters): remove unused `platform` arg from `createRequestHandler`
remix-run · Mar 21, 2022 · 8cd7f65 · 8cd7f65
1 parent 765c928
commit 8cd7f65
Show file tree

Hide file tree

Showing 72 changed files with 732 additions and 525 deletions.
diff --git a/package.json b/package.json
@@ -21,6 +21,7 @@
     "packages/create-remix",
     "packages/remix",
     "packages/remix-architect",
+    "packages/remix-cloudflare",
     "packages/remix-cloudflare-pages",
     "packages/remix-cloudflare-workers",
     "packages/remix-dev",

diff --git a/packages/remix-architect/__tests__/server-test.ts b/packages/remix-architect/__tests__/server-test.ts
@@ -2,10 +2,10 @@ import fsp from "fs/promises";
 import path from "path";
 import lambdaTester from "lambda-tester";
 import type { APIGatewayProxyEventV2 } from "aws-lambda";
-import { createRequestHandler as createRemixRequestHandler } from "@remix-run/server-runtime";
 import {
   // This has been added as a global in node 15+
   AbortController,
+  createRequestHandler as createRemixRequestHandler,
   Response as NodeResponse,
 } from "@remix-run/node";
 
@@ -18,7 +18,13 @@ import {
 
 // We don't want to test that the remix server works here (that's what the
 // puppetteer tests do), we just want to test the architect adapter
-jest.mock("@remix-run/server-runtime");
+jest.mock("@remix-run/node", () => {
+  let original = jest.requireActual("@remix-run/node");
+  return {
+      ...original,
+      createRequestHandler: jest.fn()
+  };
+});
 let mockedCreateRequestHandler =
   createRemixRequestHandler as jest.MockedFunction<
     typeof createRemixRequestHandler

diff --git a/packages/remix-architect/package.json b/packages/remix-architect/package.json
@@ -13,9 +13,8 @@
   },
   "dependencies": {
     "@architect/functions": "^5.0.2",
-    "@types/aws-lambda": "^8.10.82",
     "@remix-run/node": "1.3.2",
-    "@remix-run/server-runtime": "1.3.2"
+    "@types/aws-lambda": "^8.10.82"
   },
   "devDependencies": {
     "@types/architect__functions": "^3.13.6",

diff --git a/packages/remix-architect/server.ts b/packages/remix-architect/server.ts
@@ -3,6 +3,7 @@ import {
   AbortController,
   Headers as NodeHeaders,
   Request as NodeRequest,
+  createRequestHandler as createRemixRequestHandler,
 } from "@remix-run/node";
 import type {
   APIGatewayProxyEventHeaders,
@@ -13,10 +14,8 @@ import type {
 import type {
   AppLoadContext,
   ServerBuild,
-  ServerPlatform,
-} from "@remix-run/server-runtime";
-import { createRequestHandler as createRemixRequestHandler } from "@remix-run/server-runtime";
-import type { Response as NodeResponse } from "@remix-run/node";
+  Response as NodeResponse,
+} from "@remix-run/node";
 
 import { isBinaryType } from "./binary-types";
 
@@ -46,8 +45,7 @@ export function createRequestHandler({
   getLoadContext?: GetLoadContextFunction;
   mode?: string;
 }): APIGatewayProxyHandlerV2 {
-  let platform: ServerPlatform = {};
-  let handleRequest = createRemixRequestHandler(build, platform, mode);
+  let handleRequest = createRemixRequestHandler(build, mode);
 
   return async (event, _context) => {
     let abortController = new AbortController();

diff --git a/packages/remix-architect/sessions/arcTableSessionStorage.ts b/packages/remix-architect/sessions/arcTableSessionStorage.ts
@@ -1,9 +1,6 @@
 import * as crypto from "crypto";
-import type {
-  SessionStorage,
-  SessionIdStorageStrategy,
-} from "@remix-run/server-runtime";
-import { createSessionStorage } from "@remix-run/server-runtime";
+import type { SessionStorage, SessionIdStorageStrategy } from "@remix-run/node";
+import { createSessionStorage } from "@remix-run/node";
 import arc from "@architect/functions";
 import type { ArcTable } from "@architect/functions/tables";
 

diff --git a/packages/remix-cloudflare-pages/globals.ts b/packages/remix-cloudflare-pages/globals.ts
diff --git a/packages/remix-cloudflare-pages/index.ts b/packages/remix-cloudflare-pages/index.ts
@@ -1,8 +1,2 @@
-import { installGlobals } from "./globals";
-
-export { createCloudflareKVSessionStorage } from "./sessions/cloudflareKVSessionStorage";
-
 export type { createPagesFunctionHandlerParams } from "./worker";
 export { createPagesFunctionHandler, createRequestHandler } from "./worker";
-
-installGlobals();
diff --git a/packages/remix-cloudflare-pages/magicExports/remix.ts b/packages/remix-cloudflare-pages/magicExports/remix.ts
@@ -1,3 +1,3 @@
 // Re-export everything from this package that is available in `remix`.
 
-export { createCloudflareKVSessionStorage } from "@remix-run/cloudflare-pages";
+export { createCloudflareKVSessionStorage } from "@remix-run/cloudflare";
diff --git a/packages/remix-cloudflare-pages/package.json b/packages/remix-cloudflare-pages/package.json
@@ -14,7 +14,7 @@
     "url": "https://github.com/remix-run/remix/issues"
   },
   "dependencies": {
-    "@remix-run/server-runtime": "1.3.2"
+    "@remix-run/cloudflare": "1.3.2"
   },
   "peerDependencies": {
     "@cloudflare/workers-types": "^3.2.0"

diff --git a/packages/remix-cloudflare-pages/responses.ts b/packages/remix-cloudflare-pages/responses.ts
diff --git a/packages/remix-cloudflare-pages/sessions/cloudflareKVSessionStorage.ts b/packages/remix-cloudflare-pages/sessions/cloudflareKVSessionStorage.ts
diff --git a/packages/remix-cloudflare-pages/worker.ts b/packages/remix-cloudflare-pages/worker.ts
@@ -12,8 +12,7 @@ export function createRequestHandler<Env = any>({
   getLoadContext,
   mode,
 }: createPagesFunctionHandlerParams<Env>): PagesFunction<Env> {
-  let platform = {};
-  let handleRequest = createRemixRequestHandler(build, platform, mode);
+  let handleRequest = createRemixRequestHandler(build, mode);
 
   return (context) => {
     let loadContext =

diff --git a/packages/remix-cloudflare-workers/cookieSigning.ts b/packages/remix-cloudflare-workers/cookieSigning.ts
diff --git a/packages/remix-cloudflare-workers/globals.ts b/packages/remix-cloudflare-workers/globals.ts
diff --git a/packages/remix-cloudflare-workers/index.ts b/packages/remix-cloudflare-workers/index.ts
@@ -1,12 +1,6 @@
-import { installGlobals } from "./globals";
-
-export { createCloudflareKVSessionStorage } from "./sessions/cloudflareKVSessionStorage";
-
 export type { GetLoadContextFunction, RequestHandler } from "./worker";
 export {
   createEventHandler,
   createRequestHandler,
   handleAsset,
 } from "./worker";
-
-installGlobals();
diff --git a/packages/remix-cloudflare-workers/magicExports/remix.ts b/packages/remix-cloudflare-workers/magicExports/remix.ts
@@ -1,3 +1,3 @@
 // Re-export everything from this package that is available in `remix`.
 
-export { createCloudflareKVSessionStorage } from "@remix-run/cloudflare-workers";
+export { createCloudflareKVSessionStorage } from "@remix-run/cloudflare";
diff --git a/packages/remix-cloudflare-workers/package.json b/packages/remix-cloudflare-workers/package.json
@@ -15,7 +15,7 @@
   },
   "dependencies": {
     "@cloudflare/kv-asset-handler": "^0.1.3",
-    "@remix-run/server-runtime": "1.3.2"
+    "@remix-run/cloudflare": "1.3.2"
   },
   "peerDependencies": {
     "@cloudflare/workers-types": "^2.2.2"

diff --git a/packages/remix-cloudflare-workers/responses.ts b/packages/remix-cloudflare-workers/responses.ts
diff --git a/packages/remix-cloudflare-workers/worker.ts b/packages/remix-cloudflare-workers/worker.ts
@@ -7,9 +7,8 @@ import {
 import type {
   AppLoadContext,
   ServerBuild,
-  ServerPlatform,
-} from "@remix-run/server-runtime";
-import { createRequestHandler as createRemixRequestHandler } from "@remix-run/server-runtime";
+} from "@remix-run/cloudflare";
+import { createRequestHandler as createRemixRequestHandler } from "@remix-run/cloudflare";
 
 /**
  * A function that returns the value to use as `context` in route `loader` and
@@ -37,8 +36,7 @@ export function createRequestHandler({
   getLoadContext?: GetLoadContextFunction;
   mode?: string;
 }) {
-  let platform: ServerPlatform = {};
-  let handleRequest = createRemixRequestHandler(build, platform, mode);
+  let handleRequest = createRemixRequestHandler(build, mode);
 
   return (event: FetchEvent) => {
     let loadContext =

diff --git a/...s/remix-cloudflare-pages/cookieSigning.ts → packages/remix-cloudflare/crypto.ts b/...s/remix-cloudflare-pages/cookieSigning.ts → packages/remix-cloudflare/crypto.ts
@@ -1,6 +1,8 @@
+import type { SignFunction, UnsignFunction } from "@remix-run/server-runtime";
+
 const encoder = new TextEncoder();
 
-export async function sign(value: string, secret: string): Promise<string> {
+export const sign: SignFunction = async (value, secret) => {
   let key = await crypto.subtle.importKey(
     "raw",
     encoder.encode(secret),
@@ -19,10 +21,7 @@ export async function sign(value: string, secret: string): Promise<string> {
   return value + "." + hash;
 }
 
-export async function unsign(
-  cookie: string,
-  secret: string
-): Promise<string | false> {
+export const unsign: UnsignFunction = async (cookie, secret) => {
   let key = await crypto.subtle.importKey(
     "raw",
     encoder.encode(secret),
@@ -49,4 +48,4 @@ function byteStringToUint8Array(byteString: string): Uint8Array {
   }
 
   return array;
-}
+}
diff --git a/packages/remix-cloudflare/globals.ts b/packages/remix-cloudflare/globals.ts
@@ -0,0 +1,12 @@
+// https://stackoverflow.com/a/59499895
+export {};
+
+declare global {
+  interface ProcessEnv {
+    NODE_ENV: "development" | "production" | "test";
+  }
+
+  interface WorkerGlobalScope {
+    process: { env: ProcessEnv };
+  }
+}
diff --git a/packages/remix-cloudflare/implementations.ts b/packages/remix-cloudflare/implementations.ts
@@ -0,0 +1,13 @@
+import {
+  createCookieFactory,
+  createCookieSessionStorageFactory,
+  createMemorySessionStorageFactory,
+  createSessionStorageFactory,
+} from "@remix-run/server-runtime";
+
+import { sign, unsign } from "./crypto";
+
+export const createCookie = createCookieFactory({ sign, unsign });
+export const createCookieSessionStorage = createCookieSessionStorageFactory(createCookie);
+export const createSessionStorage = createSessionStorageFactory(createCookie);
+export const createMemorySessionStorage = createMemorySessionStorageFactory(createSessionStorage);