Fix getting versions for app info (#2)

package.json

@@ -74,7 +74,8 @@
       "import": "./lib/esm/nestjs/index.js",
       "require": "./lib/cjs/nestjs/index.cjs",
       "types": "./lib/types/nestjs/index.d.ts"
-    }
+    },
+    "./package.json": "./package.json"
   },
   "eslintConfig": {
     "parser": "@typescript-eslint/parser",
@@ -93,7 +94,13 @@
     },
     "root": true
   },
+  "prettier": {
+    "printWidth": 80
+  },
   "babel": {
+    "ignore": [
+      "**/__mocks__"
+    ],
     "presets": [
       [
         "@babel/preset-env",
@@ -124,6 +131,7 @@
           ]
         ],
         "plugins": [
+          "babel-plugin-transform-import-meta",
           [
             "transform-require-extensions",
             {
@@ -151,9 +159,17 @@
     "preset": "ts-jest",
     "testEnvironment": "node",
     "transform": {
-      "^.+\\.ts$": "ts-jest",
+      "^.+\\.ts$": [
+        "ts-jest",
+        {
+          "useESM": true
+        }
+      ],
       "^.+\\.js$": "babel-jest"
     },
+    "modulePathIgnorePatterns": [
+      "<rootDir>/lib"
+    ],
     "moduleNameMapper": {
       "^(\\.{1,2}/.*)\\.js$": "$1"
     },
@@ -223,6 +239,7 @@
     "@typescript-eslint/eslint-plugin": "^6.11.0",
     "@typescript-eslint/parser": "^6.11.0",
     "babel-jest": "^29.7.0",
+    "babel-plugin-transform-import-meta": "^2.2.1",
     "babel-plugin-transform-require-extensions": "^2.0.1",
     "celebrate": "^15.0.3",
     "class-transformer": "^0.5.1",

src/common/__mocks__/packageVersions.ts

@@ -0,0 +1,4 @@
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export function getPackageVersion(name: string): string | null {
+  return "0.0.0";
+}

src/common/client.ts

@@ -4,14 +4,14 @@ import { randomUUID } from "crypto";
 
 import { KeyCacheBase, KeyRegistry } from "./keyRegistry.js";
 import { Logger, getLogger } from "./logging.js";
+import { isValidClientId, isValidEnv } from "./paramValidation.js";
 import RequestLogger from "./requestLogger.js";
 import {
   ApitallyConfig,
   AppInfo,
   AppInfoPayload,
   RequestsDataPayload,
 } from "./types.js";
-import { isValidClientId, isValidEnv } from "./utils.js";
 import ValidationErrorLogger from "./validationErrorLogger.js";
 
 const SYNC_INTERVAL = 60000; // 60 seconds
@@ -211,7 +211,7 @@ export class ApitallyClient {
     };
     this.requestsDataQueue.push([Date.now(), newPayload]);
 
-    const failedItems = [];
+    const failedItems: [number, RequestsDataPayload][] = [];
     while (this.requestsDataQueue.length > 0) {
       const queueItem = this.requestsDataQueue.shift();
       if (queueItem) {

src/common/packageVersions.ts

@@ -0,0 +1,10 @@
+import { createRequire } from "module";
+
+export function getPackageVersion(name: string): string | null {
+  try {
+    const _require = createRequire(import.meta.url);
+    return _require(`${name}/package.json`).version || null;
+  } catch (error) {
+    return null;
+  }
+}

src/common/utils.ts → src/common/paramValidation.ts

@@ -8,11 +8,3 @@ export function isValidEnv(env: string): boolean {
   const regexExp = /^[\w-]{1,32}$/;
   return regexExp.test(env);
 }
-
-export function getPackageVersion(name: string): string | null {
-  try {
-    return require(`${name}/package.json`).version || null; // eslint-disable-line @typescript-eslint/no-var-requires
-  } catch (error) {
-    return null;
-  }
-}

src/common/types.ts

@@ -17,8 +17,8 @@ export type PathInfo = {
 };
 
 export type AppInfo = {
-  paths: Array<PathInfo>;
-  versions: Map<string, string>;
+  paths: PathInfo[];
+  versions: Record<string, string>;
   client: string;
 };
 

src/express/middleware.ts

@@ -3,8 +3,8 @@ import { performance } from "perf_hooks";
 
 import { ApitallyClient } from "../common/client.js";
 import { KeyInfo } from "../common/keyRegistry.js";
+import { getPackageVersion } from "../common/packageVersions.js";
 import { ApitallyConfig, AppInfo, ValidationError } from "../common/types.js";
-import { getPackageVersion } from "../common/utils.js";
 import listEndpoints from "./listEndpoints.js";
 
 declare module "express" {
@@ -172,7 +172,9 @@ const subsetJoiMessage = (message: string, key: string) => {
 };
 
 const getAppInfo = (app: Express, appVersion?: string): AppInfo => {
-  const versions: Array<[string, string]> = [["nodejs", process.version]];
+  const versions: Array<[string, string]> = [
+    ["nodejs", process.version.replace(/^v/, "")],
+  ];
   const expressVersion = getPackageVersion("express");
   const apitallyVersion = getPackageVersion("../..");
   if (expressVersion) {
@@ -186,7 +188,7 @@ const getAppInfo = (app: Express, appVersion?: string): AppInfo => {
   }
   return {
     paths: listEndpoints(app),
-    versions: new Map(versions),
+    versions: Object.fromEntries(versions),
     client: "js:express",
   };
 };

src/fastify/plugin.ts

@@ -3,8 +3,8 @@ import fp from "fastify-plugin";
 
 import { ApitallyClient } from "../common/client.js";
 import { KeyInfo } from "../common/keyRegistry.js";
+import { getPackageVersion } from "../common/packageVersions.js";
 import { ApitallyConfig, PathInfo, ValidationError } from "../common/types.js";
-import { getPackageVersion } from "../common/utils.js";
 
 declare module "fastify" {
   interface FastifyReply {
@@ -33,7 +33,6 @@ const apitallyPlugin: FastifyPluginAsync<ApitallyConfig> = async (
       ? routeOptions.method
       : [routeOptions.method];
     methods.forEach((method) => {
-      routeOptions.onSend;
       if (!["HEAD", "OPTIONS"].includes(method.toUpperCase())) {
         routes.push({
           method: method.toUpperCase(),
@@ -92,7 +91,9 @@ const apitallyPlugin: FastifyPluginAsync<ApitallyConfig> = async (
 };
 
 const getAppInfo = (routes: PathInfo[], appVersion?: string) => {
-  const versions: Array<[string, string]> = [["nodejs", process.version]];
+  const versions: Array<[string, string]> = [
+    ["nodejs", process.version.replace(/^v/, "")],
+  ];
   const fastifyVersion = getPackageVersion("fastify");
   const apitallyVersion = getPackageVersion("../..");
   if (fastifyVersion) {
@@ -106,7 +107,7 @@ const getAppInfo = (routes: PathInfo[], appVersion?: string) => {
   }
   return {
     paths: routes,
-    versions: new Map(versions),
+    versions: Object.fromEntries(versions),
     client: "js:fastify",
   };
 };

src/koa/middleware.ts

@@ -2,8 +2,8 @@ import Koa from "koa";
 
 import { ApitallyClient } from "../common/client.js";
 import { KeyInfo } from "../common/keyRegistry.js";
+import { getPackageVersion } from "../common/packageVersions.js";
 import { ApitallyConfig, AppInfo, PathInfo } from "../common/types.js";
-import { getPackageVersion } from "../common/utils.js";
 
 export const useApitally = (app: Koa, config: ApitallyConfig) => {
   const client = new ApitallyClient(config);
@@ -56,7 +56,9 @@ const getConsumer = (ctx: Koa.Context) => {
 };
 
 const getAppInfo = (app: Koa, appVersion?: string): AppInfo => {
-  const versions: Array<[string, string]> = [["nodejs", process.version]];
+  const versions: Array<[string, string]> = [
+    ["nodejs", process.version.replace(/^v/, "")],
+  ];
   const koaVersion = getPackageVersion("koa");
   const apitallyVersion = getPackageVersion("../..");
   if (koaVersion) {
@@ -70,7 +72,7 @@ const getAppInfo = (app: Koa, appVersion?: string): AppInfo => {
   }
   return {
     paths: listEndpoints(app),
-    versions: new Map(versions),
+    versions: Object.fromEntries(versions),
     client: "js:koa",
   };
 };

tests/common/client.test.ts

@@ -45,7 +45,7 @@ describe("Client", () => {
       env: ENV,
     });
     jest.spyOn(client.logger, "error").mockImplementation(() => {});
-    client.setAppInfo({ paths: [], versions: new Map(), client: "js:test" });
+    client.setAppInfo({ paths: [], versions: {}, client: "js:test" });
 
     await new Promise((resolve) => setTimeout(resolve, 10));
     expect(client["syncIntervalId"]).toBeUndefined();

tests/express/app.test.ts

@@ -1,11 +1,20 @@
-import { afterEach, beforeEach, describe, expect, it } from "@jest/globals";
+import {
+  afterEach,
+  beforeEach,
+  describe,
+  expect,
+  it,
+  jest,
+} from "@jest/globals";
 import { Express } from "express";
 import request from "supertest";
 
 import { ApitallyClient } from "../../src/common/client.js";
 import { API_KEY, mockApitallyHub } from "../utils.js";
 import { getAppWithCelebrate, getAppWithValidator } from "./app.js";
 
+jest.mock("../../src/common/packageVersions.ts");
+
 const testCases = [
   {
     name: "Middleware for Express with celebrate",

tests/fastify/app.test.ts

@@ -1,11 +1,20 @@
-import { afterEach, beforeEach, describe, expect, it } from "@jest/globals";
+import {
+  afterEach,
+  beforeEach,
+  describe,
+  expect,
+  it,
+  jest,
+} from "@jest/globals";
 import { FastifyInstance } from "fastify";
 import request from "supertest";
 
 import { ApitallyClient } from "../../src/common/client.js";
 import { API_KEY, mockApitallyHub } from "../utils.js";
 import { getApp } from "./app.js";
 
+jest.mock("../../src/common/packageVersions.ts");
+
 const testCases = [
   {
     name: "Plugin for Fastify",

tests/koa/app.test.ts

@@ -14,6 +14,8 @@ import { ApitallyClient } from "../../src/common/client.js";
 import { API_KEY, mockApitallyHub } from "../utils.js";
 import { getAppWithKoaRoute, getAppWithKoaRouter } from "./app.js";
 
+jest.mock("../../src/common/packageVersions.ts");
+
 const testCases = [
   {
     name: "Middleware for Koa with koa-router",

tests/nestjs/app.test.ts

@@ -15,6 +15,8 @@ import { ApitallyApiKeyGuard } from "../../src/nestjs/auth.js";
 import { API_KEY, mockApitallyHub } from "../utils.js";
 import { getApp } from "./app.js";
 
+jest.mock("../../src/common/packageVersions.ts");
+
 describe("Middleware for NestJS", () => {
   let app: INestApplication;
   let appTest: request.SuperTest<request.Test>;