fix: res.set check

azu · Jul 21, 2023 · 807732b · 807732b
1 parent 38d3ece
commit 807732b
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 6 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -11,18 +11,23 @@ const findRouting = async ({ AST, fileContent }: { AST: any; fileContent: string
             const results = query(AST, selector);
             // router.{get,post,delete,put,use}
             return results.flatMap((node: any) => {
+                // TODO: improve query to avoid this check
+                // res.set("X-Content-Type-Options", req.get("test")));
+                if (node.callee.property.name !== method) {
+                    return [];
+                }
+                // single argument should be ignored
+                // req.get("host");  it is not routing
+                if (node.arguments.length === 1) {
+                    return [];
+                }
                 const pathValue =
                     node.arguments[0] !== undefined &&
                     node.arguments[0].type === "StringLiteral" &&
                     node.arguments[0].value;
                 if (!pathValue) {
                     return []; // skip: it will only includes middleware
                 }
-                // single argument should be ignored
-                // req.get("host");  it is not routing
-                if (node.arguments.length === 1) {
-                    return [];
-                }
                 const middlewareArguments =
                     method === "use"
                         ? // @ts-ignore

diff --git a/test/fixtures/res.set-get-but-it-is-not-router/app.ts b/test/fixtures/res.set-get-but-it-is-not-router/app.ts
@@ -0,0 +1,8 @@
+import { Router } from "express";
+
+const app = Router();
+
+app.get("/get", (req, res) => {
+    res.set("key", req.get("host"));
+});
+export default app;
diff --git a/test/index.test.ts b/test/index.test.ts
@@ -257,7 +257,7 @@ describe("app snapshot", function () {
 |        | use    | /useEvents | Anonymous Function | app.ts#L5-L7 |`
         );
     });
-    it("should ignore req.get() for getting paramter", async () => {
+    it("should ignore req.get() for getting parameter", async () => {
         const rootDir = path.join(__dirname, "fixtures/req.get-but-it-is-not-router");
         const mdResults = await analyzeDependencies({
             filePaths: await globby(["**/*.ts"], { cwd: rootDir }),
@@ -271,6 +271,23 @@ describe("app snapshot", function () {
 | File   | Method | Routing | Middlewares | FilePath     |
 | ------ | ------ | ------- | ----------- | ------------ |
 | app.ts |        |         |             |              |
+|        | get    | /get    |             | app.ts#L5-L7 |`
+        );
+    });
+    it("should ignore res.set(key, req.get()) for getting parameter", async () => {
+        const rootDir = path.join(__dirname, "fixtures/res.set-get-but-it-is-not-router");
+        const mdResults = await analyzeDependencies({
+            filePaths: await globby(["**/*.ts"], { cwd: rootDir }),
+            cwd: rootDir,
+            rootBaseUrl: "",
+            outputFormat: "markdown"
+        });
+        assert.strictEqual(
+            mdResults,
+            `\
+| File   | Method | Routing | Middlewares | FilePath     |
+| ------ | ------ | ------- | ----------- | ------------ |
+| app.ts |        |         |             |              |
 |        | get    | /get    |             | app.ts#L5-L7 |`
         );
     });