fix: Prevent REST API client to be a type of function

neet · neet · commit 42abe50ae932 · 2024-02-22T13:13:50.000+09:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -59,7 +59,7 @@ jobs:
           cache: yarn
 
       - name: Setup Mastodon
-        run: docker compose up -d
+        run: docker compose up -d --quiet-pull
 
       - name: Install dependencies
         run: yarn install --frozen-lockfile
diff --git a/package.json b/package.json
@@ -23,7 +23,7 @@
     "test:e2e": "jest --coverage --config=jest.config.js --selectProjects e2e",
     "lint": "npm-run-all lint:*",
     "lint:eslint": "eslint --ext ts --report-unused-disable-directives --cache '{src,tests,test-utils}/**/*'",
-    "lint:spellcheck": "cspell '{src,test,test-utils}/**/*.{ts,tsx,js,json,md}'",
+    "lint:spellcheck": "cspell --quiet '{src,test,test-utils}/**/*.{ts,tsx,js,json,md}'",
     "build": "rollup -c rollup.config.js",
     "prepublishOnly": "yarn run build",
     "docs:build": "typedoc ./src/index.ts && touch ./docs/.nojekyll",
diff --git a/src/adapters/action/proxy.spec.ts b/src/adapters/action/proxy.spec.ts
@@ -38,7 +38,7 @@ describe("RequestBuilder", () => {
           return {} as T;
         },
       },
-      ["root"],
+      { context: ["root"] },
     );
     const data = {};
     builder.$select("foo").bar.fetch(data);
@@ -58,7 +58,9 @@ describe("RequestBuilder", () => {
           return {} as T;
         },
       },
-      ["root"],
+      {
+        context: ["root"],
+      },
     );
     const data = {};
     builder.$select("foo").bar.create(data);
@@ -78,7 +80,7 @@ describe("RequestBuilder", () => {
           return {} as T;
         },
       },
-      ["root"],
+      { context: ["root"] },
     );
     const data = {};
     builder.$select("AlphaBeta").gammaDelta.create(data);
@@ -87,13 +89,17 @@ describe("RequestBuilder", () => {
     expect(action?.data).toBe(data);
   });
 
-  it("cannot invoke without context", () => {
-    const builder: any = createActionProxy({
-      dispatch: Promise.resolve,
-    });
+  it("cannot invoke with too few context", () => {
+    const api: any = createActionProxy(
+      {
+        dispatch: async <T>(_: AnyAction) => {
+          return {} as T;
+        },
+      },
+      { context: [] },
+    );
 
-    expect(() => {
-      builder();
-    }).toThrow();
+    expect(() => api()).toThrow(TypeError);
+    expect(() => api.close()).not.toThrow(TypeError);
   });
 });
diff --git a/src/adapters/action/proxy.ts b/src/adapters/action/proxy.ts
@@ -7,14 +7,28 @@ import {
 } from "../../interfaces";
 import { noop } from "../../utils/noop";
 
+type CreateActionProxyOptions = {
+  readonly context?: string[];
+  readonly applicable?: boolean;
+};
+
 export const createActionProxy = <T>(
   actionDispatcher: ActionDispatcher<AnyAction>,
-  context: string[] = [],
+  options: CreateActionProxyOptions = {},
 ): T => {
-  return new Proxy(noop, {
+  const { context = [], applicable = false } = options;
+
+  let target = {};
+  const handler: ProxyHandler<typeof noop> = {
     get: get(actionDispatcher, context),
-    apply: apply(actionDispatcher, context),
-  }) as T;
+  };
+
+  if (applicable) {
+    target = noop;
+    handler.apply = apply(actionDispatcher, context);
+  }
+
+  return new Proxy(target, handler) as T;
 };
 
 const SPECIAL_PROPERTIES = new Set([
@@ -38,37 +52,44 @@ const SPECIAL_PROPERTIES = new Set([
 ]);
 
 const get =
-  <T>(actionDispatcher: ActionDispatcher<AnyAction>, context: string[]) =>
+  <T>(
+    actionDispatcher: ActionDispatcher<AnyAction>,
+    context: readonly string[],
+  ) =>
   (_: unknown, property: string | symbol) => {
     if (typeof property === "string" && SPECIAL_PROPERTIES.has(property)) {
       return;
     }
     if (typeof property === "symbol") {
       return;
     }
-    if (property === "$select") {
-      return createActionProxy<T>(actionDispatcher, [...context, property]);
+    if (property.startsWith("$")) {
+      return createActionProxy<T>(actionDispatcher, {
+        context: [...context, property],
+        applicable: true,
+      });
     }
-    return createActionProxy<T>(actionDispatcher, [
-      ...context,
-      snakeCase(property),
-    ]);
+    return createActionProxy<T>(actionDispatcher, {
+      context: [...context, snakeCase(property)],
+      applicable: true,
+    });
   };
 
 const apply =
   <T>(actionDispatcher: ActionDispatcher<AnyAction>, context: string[]) =>
   (_1: unknown, _2: unknown, args: unknown[]): unknown => {
     const action = context.pop();
 
+    /* istanbul ignore next */
     if (action == undefined) {
       throw new Error("No action specified");
     }
 
     if (action === "$select") {
-      return createActionProxy<T>(actionDispatcher, [
-        ...context,
-        ...(args as string[]),
-      ]);
+      return createActionProxy<T>(actionDispatcher, {
+        context: [...context, ...(args as string[])],
+        applicable: true,
+      });
     }
 
     const path = "/" + context.join("/");
diff --git a/src/adapters/clients.ts b/src/adapters/clients.ts
@@ -30,9 +30,9 @@ export const createRestAPIClient = (
   const http = new HttpNativeImpl(serializer, config, logger);
   const hook = new HttpActionDispatcherHookMastodon(http);
   const actionDispatcher = new HttpActionDispatcher(http, hook);
-  const actionProxy = createActionProxy(actionDispatcher, [
-    "api",
-  ]) as mastodon.rest.Client;
+  const actionProxy = createActionProxy(actionDispatcher, {
+    context: ["api"],
+  }) as mastodon.rest.Client;
   return actionProxy;
 };
 
@@ -45,9 +45,9 @@ export const createOAuthAPIClient = (
   const http = new HttpNativeImpl(serializer, config, logger);
   const hook = new HttpActionDispatcherHookMastodon(http);
   const actionDispatcher = new HttpActionDispatcher(http, hook);
-  const actionProxy = createActionProxy(actionDispatcher, [
-    "oauth",
-  ]) as mastodon.oauth.Client;
+  const actionProxy = createActionProxy(actionDispatcher, {
+    context: ["oauth"],
+  }) as mastodon.oauth.Client;
   return actionProxy;
 };
 
