counterfact 0.21.3 → 0.22.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # counterfact
 
+## 0.22.0
+
+### Minor Changes
+
+- 4dcfa06: add CORS headers to support local development (Thanks, [dethell-jh](https://github.com/dethell-jh)!)
+
+### Patch Changes
+
+- dec64f4: Add CORS headers
+
 ## 0.21.3
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "counterfact",
-  "version": "0.21.3",
+  "version": "0.22.0",
   "description": "a library for building a fake REST API for testing",
   "type": "module",
   "main": "./src/server/counterfact.js",

package/src/server/koa-middleware.js

@@ -2,6 +2,21 @@ import koaProxy from "koa-proxy";
 
 const HTTP_STATUS_CODE_OK = 200;
 
+function addCors(ctx, headers) {
+  // Always append CORS headers, reflecting back the headers requested if any
+  ctx.set("Access-Control-Allow-Origin", headers?.origin || "*");
+  ctx.set("Access-Control-Allow-Methods", "GET,HEAD,PUT,POST,DELETE,PATCH");
+  ctx.set(
+    "Access-Control-Allow-Headers",
+    headers?.["access-control-request-headers"]
+  );
+  ctx.set(
+    "Access-Control-Expose-Headers",
+    headers?.["access-control-request-headers"]
+  );
+  ctx.set("Access-Control-Allow-Credentials", "true");
+}
+
 export function koaMiddleware(dispatcher, options = {}, proxy = koaProxy) {
   return async function middleware(ctx, next) {
     const { method, path, headers, body, query } = ctx.request;
@@ -10,19 +25,26 @@ export function koaMiddleware(dispatcher, options = {}, proxy = koaProxy) {
       return proxy({ host: options.proxyUrl })(ctx, next);
     }
 
-    const response = await dispatcher.request({
-      method,
-      path,
-      headers,
-      body,
-      query,
-      req: ctx.req,
-    });
-
-    /* eslint-disable require-atomic-updates */
-    ctx.body = response.body;
-    ctx.status = response.status ?? HTTP_STATUS_CODE_OK;
-    /* eslint-enable require-atomic-updates */
+    addCors(ctx, headers);
+
+    // If the method is OPTIONS then always return OK
+    if (method === "OPTIONS") {
+      ctx.status = HTTP_STATUS_CODE_OK;
+    } else {
+      const response = await dispatcher.request({
+        method,
+        path,
+        headers,
+        body,
+        query,
+        req: ctx.req,
+      });
+
+      /* eslint-disable require-atomic-updates */
+      ctx.body = response.body;
+      ctx.status = response.status ?? HTTP_STATUS_CODE_OK;
+      /* eslint-enable require-atomic-updates */
+    }
 
     return undefined;
   };

package/test/server/koa-middleware.test.js

@@ -1,3 +1,6 @@
+// eslint-disable-next-line import/no-extraneous-dependencies, n/no-extraneous-import, @typescript-eslint/no-shadow, no-shadow
+import { jest } from "@jest/globals";
+
 import { Registry } from "../../src/server/registry.js";
 import { Dispatcher } from "../../src/server/dispatcher.js";
 import { koaMiddleware } from "../../src/server/koa-middleware.js";
@@ -24,11 +27,17 @@ describe("koa middleware", () => {
     const dispatcher = new Dispatcher(registry, new ContextRegistry());
     const middleware = koaMiddleware(dispatcher);
     const ctx = {
-      request: { path: "/hello", method: "POST", body: { name: "Homer" } },
+      request: {
+        path: "/hello",
+        method: "POST",
+        body: { name: "Homer" },
+      },
 
       req: {
         path: "/hello",
       },
+
+      set: jest.fn(),
     };
 
     await middleware(ctx);
@@ -52,6 +61,8 @@ describe("koa middleware", () => {
     const middleware = koaMiddleware(dispatcher);
     const ctx = {
       request: { path: "/not-modified", method: "GET" },
+      // eslint-disable-next-line no-empty-function
+      set: () => {},
     };
 
     await middleware(ctx);
@@ -82,4 +93,104 @@ describe("koa middleware", () => {
 
     expect(ctx.mockProxyHost).toBe("https://example.com");
   });
+
+  it("adds default CORS headers if none are requested", async () => {
+    const registry = new Registry();
+
+    registry.add("/hello", {
+      POST({ body }) {
+        return {
+          body: `Hello, ${body.name}!`,
+        };
+      },
+    });
+
+    const dispatcher = new Dispatcher(registry, new ContextRegistry());
+    const middleware = koaMiddleware(dispatcher);
+    const ctx = {
+      request: {
+        path: "/hello",
+        method: "POST",
+        body: { name: "Homer" },
+      },
+
+      req: {
+        path: "/hello",
+      },
+
+      set: jest.fn(),
+    };
+
+    await middleware(ctx);
+
+    expect(ctx.status).toBe(200);
+    expect(ctx.body).toBe("Hello, Homer!");
+    expect(ctx.set).toHaveBeenCalledWith("Access-Control-Allow-Origin", "*");
+    expect(ctx.set).toHaveBeenCalledWith(
+      "Access-Control-Allow-Methods",
+      "GET,HEAD,PUT,POST,DELETE,PATCH"
+    );
+    expect(ctx.set).toHaveBeenCalledWith(
+      "Access-Control-Allow-Headers",
+      undefined
+    );
+    expect(ctx.set).toHaveBeenCalledWith(
+      "Access-Control-Expose-Headers",
+      undefined
+    );
+  });
+
+  it("reflects desired CORS headers if specific headers are requested", async () => {
+    const registry = new Registry();
+
+    registry.add("/hello", {
+      POST({ body }) {
+        return {
+          body: `Hello, ${body.name}!`,
+        };
+      },
+    });
+
+    const dispatcher = new Dispatcher(registry, new ContextRegistry());
+    const middleware = koaMiddleware(dispatcher);
+    const ctx = {
+      request: {
+        path: "/hello",
+        method: "POST",
+        body: { name: "Homer" },
+
+        headers: {
+          origin: "https://my.local.app:3000",
+          "access-control-request-headers": "X-My-Header,X-Another-Header",
+        },
+      },
+
+      req: {
+        path: "/hello",
+      },
+
+      set: jest.fn(),
+    };
+
+    await middleware(ctx);
+
+    expect(ctx.status).toBe(200);
+    expect(ctx.body).toBe("Hello, Homer!");
+    expect(ctx.set).toHaveBeenCalledWith(
+      "Access-Control-Allow-Origin",
+      "https://my.local.app:3000"
+    );
+    expect(ctx.set).toHaveBeenCalledWith(
+      "Access-Control-Allow-Methods",
+      "GET,HEAD,PUT,POST,DELETE,PATCH"
+    );
+    expect(ctx.set).toHaveBeenCalledWith(
+      "Access-Control-Allow-Headers",
+      "X-My-Header,X-Another-Header"
+    );
+    expect(ctx.set).toHaveBeenCalledWith(
+      "Access-Control-Expose-Headers",
+      "X-My-Header,X-Another-Header"
+    );
+  });
 });