refactor: replace request param metadata from map to builder

jbl428 · jbl428 · commit fa6ddb5cdc97 · 2023-04-16T19:31:45.000+09:00
diff --git a/lib/builders/payload-builder.spec.ts b/lib/builders/payload-builder.spec.ts
@@ -0,0 +1,16 @@
+import { describe, test, expect } from "vitest";
+import { PayloadBuilder } from "./payload-builder";
+
+describe("PayloadBuilder", () => {
+  test("should return undefined when no metadata is provided", () => {
+    // given
+    const args = ["arg"];
+    const urlBuilder = new PayloadBuilder(args);
+
+    // when
+    const actual = urlBuilder.build();
+
+    // then
+    expect(actual).toBeUndefined();
+  });
+});
diff --git a/lib/builders/payload-builder.ts b/lib/builders/payload-builder.ts
@@ -1,4 +1,4 @@
-import { TupleArrayBuilder } from "./tuple-array-builder";
+import { TupleArrayBuilder } from "./tuple-array.builder";
 import {
   type RequestBodyMetadata,
   type RequestFormMetadata,
diff --git a/lib/builders/request-param.builder.ts b/lib/builders/request-param.builder.ts
@@ -0,0 +1,39 @@
+import { TupleArrayBuilder } from "./tuple-array.builder";
+
+export class RequestParamBuilder {
+  metadata: Array<[index: number, key: string | undefined]> = [];
+
+  constructor(index: number, key?: string) {
+    this.metadata.push([index, key]);
+  }
+
+  get length(): number {
+    return this.metadata.length;
+  }
+
+  add(index: number, key?: string): void {
+    this.metadata.push([index, key]);
+  }
+
+  build(args: any[]): string {
+    if (this.metadata.length === 0) {
+      return "";
+    }
+
+    const searchParams = new URLSearchParams();
+    this.metadata.forEach(([index, key]) => {
+      if (key != null) {
+        searchParams.set(key, args[index]);
+        return;
+      }
+
+      TupleArrayBuilder.of<string, unknown>(args[index]).forEach(
+        ([key, value]) => {
+          searchParams.set(key, `${value?.toString() ?? ""}`);
+        }
+      );
+    });
+
+    return "?" + searchParams.toString();
+  }
+}
diff --git a/lib/builders/tuple-array.builder.ts b/lib/builders/tuple-array.builder.ts
@@ -1,6 +1,6 @@
 export class TupleArrayBuilder {
   static of<A, B>(value: unknown): Array<[A, B]> {
-    if (typeof value === "undefined") {
+    if (value === undefined) {
       return [];
     }
 
diff --git a/lib/builders/url.builder.spec.ts b/lib/builders/url.builder.spec.ts
@@ -1,18 +1,16 @@
 import { describe, test, expect } from "vitest";
-import { URLBuilder } from "./url-builder";
-import {
-  type PathVariableMetadata,
-  type RequestParamMetadata,
-} from "../decorators";
+import { RequestParamBuilder } from "./request-param.builder";
+import { UrlBuilder } from "./url.builder";
+import { type PathVariableMetadata } from "../decorators";
 import { MetadataMap } from "../types/metadata-map";
 
-describe("URLBuilder", () => {
+describe("UrlBuilder", () => {
   test("should build with base url", () => {
     // given
     const host = "https://example.com";
     const path = "//api/1";
     const args = [1];
-    const urlBuilder = new URLBuilder(host, path, args);
+    const urlBuilder = new UrlBuilder(host, path, args);
 
     // when
     const actual = urlBuilder.build();
@@ -27,7 +25,7 @@ describe("URLBuilder", () => {
     const path = "api/users/{id}";
     const args = [1, 2];
     const pathParam: PathVariableMetadata = new MetadataMap([[1, "id"]]);
-    const urlBuilder = new URLBuilder(host, path, args, { pathParam });
+    const urlBuilder = new UrlBuilder(host, path, args, { pathParam });
 
     // when
     const actual = urlBuilder.build();
@@ -41,8 +39,8 @@ describe("URLBuilder", () => {
     const host = "https://example.com";
     const path = "";
     const args = ["search"];
-    const queryParam: RequestParamMetadata = new MetadataMap([[0, "keyword"]]);
-    const urlBuilder = new URLBuilder(host, path, args, { queryParam });
+    const queryParam = new RequestParamBuilder(0, "keyword");
+    const urlBuilder = new UrlBuilder(host, path, args, { queryParam });
 
     // when
     const actual = urlBuilder.build();
@@ -56,8 +54,8 @@ describe("URLBuilder", () => {
     const host = "https://example.com";
     const path = "api/user";
     const args = [{ keyword: "search" }];
-    const queryParam: RequestParamMetadata = new MetadataMap([[0, undefined]]);
-    const urlBuilder = new URLBuilder(host, path, args, { queryParam });
+    const queryParam = new RequestParamBuilder(0, undefined);
+    const urlBuilder = new UrlBuilder(host, path, args, { queryParam });
 
     // when
     const actual = urlBuilder.build();
diff --git a/lib/builders/url.builder.ts b/lib/builders/url.builder.ts
@@ -1,32 +1,32 @@
-import { TupleArrayBuilder } from "./tuple-array-builder";
-import {
-  type PathVariableMetadata,
-  type RequestParamMetadata,
-} from "../decorators";
+import { type RequestParamBuilder } from "./request-param.builder";
+import { type PathVariableMetadata } from "../decorators";
 
-export class URLBuilder {
+export class UrlBuilder {
   #pathParams: Array<[number, string]> = [];
-  #queryParams: Array<[number, string | undefined]> = [];
+  #requestParamBuilder: RequestParamBuilder | undefined;
 
   constructor(
     private readonly host: string,
     private readonly path: string,
     private readonly args: any[],
     metadata: {
       pathParam?: PathVariableMetadata;
-      queryParam?: RequestParamMetadata;
+      queryParam?: RequestParamBuilder;
     } = {}
   ) {
     if (this.host.length === 0) {
       this.host = this.path;
       this.path = "";
     }
     this.#pathParams = metadata.pathParam?.toArray() ?? [];
-    this.#queryParams = metadata.queryParam?.toArray() ?? [];
+    this.#requestParamBuilder = metadata.queryParam;
   }
 
   build(): string {
-    return this.replacePathVariable() + this.appendQueryParams();
+    return (
+      this.replacePathVariable() +
+      (this.#requestParamBuilder?.build(this.args) ?? "")
+    );
   }
 
   private replacePathVariable(): string {
@@ -37,28 +37,6 @@ export class URLBuilder {
     );
   }
 
-  private appendQueryParams(): string {
-    if (this.#queryParams.length === 0) {
-      return "";
-    }
-
-    const searchParams = new URLSearchParams();
-    this.#queryParams.forEach(([paramIndex, queryParamKey]) => {
-      if (typeof queryParamKey !== "undefined") {
-        searchParams.set(queryParamKey, this.args[paramIndex]);
-        return;
-      }
-
-      TupleArrayBuilder.of<string, unknown>(this.args[paramIndex]).forEach(
-        ([key, value]) => {
-          searchParams.set(key, `${value?.toString() ?? ""}`);
-        }
-      );
-    });
-
-    return "?" + searchParams.toString();
-  }
-
   get url(): string {
     if (this.path === "") {
       return this.host;
diff --git a/lib/decorators/http-interface.decorator.spec.ts b/lib/decorators/http-interface.decorator.spec.ts
@@ -9,7 +9,7 @@ describe("HttpInterface", () => {
     class TestService {}
 
     // when
-    const result = Reflect.getMetadata(
+    const result: string = Reflect.getMetadata(
       HTTP_INTERFACE_METADATA,
       TestService.prototype
     );
@@ -24,7 +24,7 @@ describe("HttpInterface", () => {
     class TestService {}
 
     // when
-    const result = Reflect.getMetadata(
+    const result: string = Reflect.getMetadata(
       HTTP_INTERFACE_METADATA,
       TestService.prototype
     );
diff --git a/lib/decorators/request-param.decorator.spec.ts b/lib/decorators/request-param.decorator.spec.ts
@@ -1,9 +1,7 @@
 import { describe, test, expect } from "vitest";
 import { REQUEST_PARAM_METADATA } from "./constants";
-import {
-  RequestParam,
-  type RequestParamMetadata,
-} from "./request-param.decorator";
+import { RequestParam } from "./request-param.decorator";
+import { type RequestParamBuilder } from "../builders/request-param.builder";
 
 describe("RequestParam", () => {
   test("should set request param metadata with empty key", () => {
@@ -15,34 +13,59 @@ describe("RequestParam", () => {
     }
 
     // when
-    const result: RequestParamMetadata = Reflect.getMetadata(
+    const result: RequestParamBuilder = Reflect.getMetadata(
       REQUEST_PARAM_METADATA,
       TestService.prototype,
       "request"
     );
 
     // then
-    expect(result).toHaveLength(1);
-    expect(result.get(0)).toBeUndefined();
+    expect(result.metadata).toHaveLength(1);
+    expect(result.metadata[0]).toEqual([0, undefined]);
   });
 
   test("should set request param metadata with key", () => {
     // given
     class TestService {
-      request(@RequestParam("foo") bar: string): string {
+      request(_foo: string, @RequestParam("bar") bar: string): string {
         return bar;
       }
     }
 
     // when
-    const result: RequestParamMetadata = Reflect.getMetadata(
+    const result: RequestParamBuilder = Reflect.getMetadata(
       REQUEST_PARAM_METADATA,
       TestService.prototype,
       "request"
     );
 
     // then
-    expect(result).toHaveLength(1);
-    expect(result.get(0)).toBe("foo");
+    expect(result.metadata).toHaveLength(1);
+    expect(result.metadata[0]).toEqual([1, "bar"]);
+  });
+
+  test("should set request param metadata with multiple decorator", () => {
+    // given
+    class TestService {
+      request(
+        @RequestParam("foo") foo: string,
+        @RequestParam() bar: { bar: string }
+      ): string {
+        return foo;
+      }
+    }
+
+    // when
+    const result: RequestParamBuilder = Reflect.getMetadata(
+      REQUEST_PARAM_METADATA,
+      TestService.prototype,
+      "request"
+    );
+
+    // then
+    expect(result.metadata).toEqual([
+      [1, undefined],
+      [0, "foo"],
+    ]);
   });
 });
diff --git a/lib/decorators/request-param.decorator.ts b/lib/decorators/request-param.decorator.ts
@@ -1,23 +1,26 @@
 import { REQUEST_PARAM_METADATA } from "./constants";
-import { MetadataMap } from "../types/metadata-map";
-
-export type RequestParamMetadata = MetadataMap<number, string | undefined>;
+import { RequestParamBuilder } from "../builders/request-param.builder";
 
 export function RequestParam(key?: string): ParameterDecorator {
   return (target, propertyKey, parameterIndex) => {
-    if (typeof propertyKey === "undefined") {
+    if (propertyKey == null) {
       return;
     }
 
-    const metadata =
-      Reflect.getMetadata(REQUEST_PARAM_METADATA, target, propertyKey) ??
-      new MetadataMap();
+    const metadata: RequestParamBuilder | undefined = Reflect.getMetadata(
+      REQUEST_PARAM_METADATA,
+      target,
+      propertyKey
+    );
 
-    metadata.set(parameterIndex, key);
+    if (metadata != null) {
+      metadata.add(parameterIndex, key);
+      return;
+    }
 
     Reflect.defineMetadata(
       REQUEST_PARAM_METADATA,
-      metadata,
+      new RequestParamBuilder(parameterIndex, key),
       target,
       propertyKey
     );
diff --git a/lib/node-fetch.injector.ts b/lib/node-fetch.injector.ts
@@ -1,6 +1,9 @@
 import { Injectable, type OnModuleInit } from "@nestjs/common";
 import { DiscoveryService, MetadataScanner } from "@nestjs/core";
 import { type InstanceWrapper } from "@nestjs/core/injector/instance-wrapper";
+import { type RequestParamBuilder } from "./builders/request-param.builder";
+import { TupleArrayBuilder } from "./builders/tuple-array.builder";
+import { UrlBuilder } from "./builders/url.builder";
 import {
   HTTP_EXCHANGE_METADATA,
   HTTP_INTERFACE_METADATA,
@@ -10,11 +13,8 @@ import {
   REQUEST_BODY_METADATA,
   REQUEST_PARAM_METADATA,
   type RequestBodyMetadata,
-  type RequestParamMetadata,
 } from "./decorators";
 import { HttpClient } from "./types/http-client.interface";
-import { TupleArrayBuilder } from "./utils/tuple-array-builder";
-import { URLBuilder } from "./utils/url-builder";
 
 @Injectable()
 export class NodeFetchInjector implements OnModuleInit {
@@ -53,7 +53,7 @@ export class NodeFetchInjector implements OnModuleInit {
           const pathMetadata = getMetadata<PathVariableMetadata>(
             PATH_VARIABLE_METADATA
           );
-          const requestParamMetadata = getMetadata<RequestParamMetadata>(
+          const requestParamMetadata = getMetadata<RequestParamBuilder>(
             REQUEST_PARAM_METADATA
           );
           const requestBodyMetadata = getMetadata<RequestBodyMetadata>(
@@ -84,7 +84,7 @@ export class NodeFetchInjector implements OnModuleInit {
                 {}
               );
 
-            const urlBuilder = new URLBuilder(
+            const urlBuilder = new UrlBuilder(
               baseUrl,
               httpExchangeMetadata.url,
               args,
diff --git a/lib/types/metadata-map.ts b/lib/types/metadata-map.ts
@@ -1,4 +1,4 @@
-import { TupleArrayBuilder } from "../utils/tuple-array-builder";
+import { TupleArrayBuilder } from "../builders/tuple-array.builder";
 
 export class MetadataMap<K, V> extends Map<K, V> {
   toArray(): Array<[K, V]> {

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { TupleArrayBuilder } from "./tuple-array-builder";`
	`1`	`+import { TupleArrayBuilder } from "./tuple-array.builder";`
`2`	`2`	`import {`
`3`	`3`	`type RequestBodyMetadata,`
`4`	`4`	`type RequestFormMetadata,`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`export class TupleArrayBuilder {`
`2`	`2`	`static of<A, B>(value: unknown): Array<[A, B]> {`
`3`		`- if (typeof value === "undefined") {`
	`3`	`+ if (value === undefined) {`
`4`	`4`	`return [];`
`5`	`5`	`}`
`6`	`6`