apitally 0.7.0 → 0.8.1

package/dist/common/types.d.ts

@@ -8,19 +8,24 @@ type ApitallyConfig = {
     appVersion?: string;
     logger?: Logger;
 };
+type ApitallyConsumer = {
+    identifier: string;
+    name?: string | null;
+    group?: string | null;
+};
 type PathInfo = {
     method: string;
     path: string;
 };
-type AppInfo = {
+type StartupData = {
     paths: PathInfo[];
     versions: Record<string, string>;
     client: string;
 };
-type AppInfoPayload = {
+type StartupPayload = {
     instance_uuid: string;
     message_uuid: string;
-} & AppInfo;
+} & StartupData;
 type ConsumerMethodPath = {
     consumer?: string | null;
     method: string;
@@ -64,13 +69,15 @@ type ServerErrorsItem = ConsumerMethodPath & {
     sentry_event_id: string | null;
     error_count: number;
 };
-type RequestsDataPayload = {
+type ConsumerItem = ApitallyConsumer;
+type SyncPayload = {
     time_offset: number;
     instance_uuid: string;
     message_uuid: string;
     requests: Array<RequestsItem>;
     validation_errors: Array<ValidationErrorsItem>;
     server_errors: Array<ServerErrorsItem>;
+    consumers: Array<ConsumerItem>;
 };
 
-export type { ApitallyConfig, AppInfo, AppInfoPayload, ConsumerMethodPath, PathInfo, RequestInfo, RequestsDataPayload, RequestsItem, ServerError, ServerErrorsItem, ValidationError, ValidationErrorsItem };
+export type { ApitallyConfig, ApitallyConsumer, ConsumerItem, ConsumerMethodPath, PathInfo, RequestInfo, RequestsItem, ServerError, ServerErrorsItem, StartupData, StartupPayload, SyncPayload, ValidationError, ValidationErrorsItem };

package/dist/express/index.cjs

@@ -44,6 +44,62 @@ var import_perf_hooks = require("perf_hooks");
 var import_crypto3 = require("crypto");
 var import_fetch_retry = __toESM(require("fetch-retry"), 1);
 
+// src/common/consumerRegistry.ts
+var consumerFromStringOrObject = /* @__PURE__ */ __name((consumer) => {
+  var _a2, _b;
+  if (typeof consumer === "string") {
+    consumer = String(consumer).trim().substring(0, 128);
+    return consumer ? {
+      identifier: consumer
+    } : null;
+  } else {
+    consumer.identifier = String(consumer.identifier).trim().substring(0, 128);
+    consumer.name = (_a2 = consumer.name) == null ? void 0 : _a2.trim().substring(0, 64);
+    consumer.group = (_b = consumer.group) == null ? void 0 : _b.trim().substring(0, 64);
+    return consumer.identifier ? consumer : null;
+  }
+}, "consumerFromStringOrObject");
+var _ConsumerRegistry = class _ConsumerRegistry {
+  consumers;
+  updated;
+  constructor() {
+    this.consumers = /* @__PURE__ */ new Map();
+    this.updated = /* @__PURE__ */ new Set();
+  }
+  addOrUpdateConsumer(consumer) {
+    if (!consumer || !consumer.name && !consumer.group) {
+      return;
+    }
+    const existing = this.consumers.get(consumer.identifier);
+    if (!existing) {
+      this.consumers.set(consumer.identifier, consumer);
+      this.updated.add(consumer.identifier);
+    } else {
+      if (consumer.name && consumer.name !== existing.name) {
+        existing.name = consumer.name;
+        this.updated.add(consumer.identifier);
+      }
+      if (consumer.group && consumer.group !== existing.group) {
+        existing.group = consumer.group;
+        this.updated.add(consumer.identifier);
+      }
+    }
+  }
+  getAndResetUpdatedConsumers() {
+    const data = [];
+    this.updated.forEach((identifier) => {
+      const consumer = this.consumers.get(identifier);
+      if (consumer) {
+        data.push(consumer);
+      }
+    });
+    this.updated.clear();
+    return data;
+  }
+};
+__name(_ConsumerRegistry, "ConsumerRegistry");
+var ConsumerRegistry = _ConsumerRegistry;
+
 // src/common/logging.ts
 var import_winston = require("winston");
 var getLogger = /* @__PURE__ */ __name(() => {
@@ -321,13 +377,14 @@ var _ApitallyClient = class _ApitallyClient {
   clientId;
   env;
   instanceUuid;
-  requestsDataQueue;
+  syncDataQueue;
   syncIntervalId;
-  appInfo;
-  appInfoSent = false;
+  startupData;
+  startupDataSent = false;
   requestCounter;
   validationErrorCounter;
   serverErrorCounter;
+  consumerRegistry;
   logger;
   constructor({ clientId, env = "dev", logger }) {
     if (_ApitallyClient.instance) {
@@ -343,10 +400,11 @@ var _ApitallyClient = class _ApitallyClient {
     this.clientId = clientId;
     this.env = env;
     this.instanceUuid = (0, import_crypto3.randomUUID)();
-    this.requestsDataQueue = [];
+    this.syncDataQueue = [];
     this.requestCounter = new RequestCounter();
     this.validationErrorCounter = new ValidationErrorCounter();
     this.serverErrorCounter = new ServerErrorCounter();
+    this.consumerRegistry = new ConsumerRegistry();
     this.logger = logger || getLogger();
     this.startSync();
     this.handleShutdown = this.handleShutdown.bind(this);
@@ -364,15 +422,15 @@ var _ApitallyClient = class _ApitallyClient {
   }
   async handleShutdown() {
     this.stopSync();
-    await this.sendRequestsData();
+    await this.sendSyncData();
     _ApitallyClient.instance = void 0;
   }
   getHubUrlPrefix() {
     const baseURL = process.env.APITALLY_HUB_BASE_URL || "https://hub.apitally.io";
-    const version = "v1";
+    const version = "v2";
     return `${baseURL}/${version}/${this.clientId}/${this.env}/`;
   }
-  async makeHubRequest(url, payload) {
+  async sendData(url, payload) {
     const fetchWithRetry = (0, import_fetch_retry.default)(fetch, {
       retries: 3,
       retryDelay: 1e3,
@@ -411,10 +469,10 @@ var _ApitallyClient = class _ApitallyClient {
   async sync() {
     try {
       const promises = [
-        this.sendRequestsData()
+        this.sendSyncData()
       ];
-      if (!this.appInfoSent) {
-        promises.push(this.sendAppInfo());
+      if (!this.startupDataSent) {
+        promises.push(this.sendStartupData());
       }
       await Promise.all(promises);
     } catch (error) {
@@ -429,62 +487,63 @@ var _ApitallyClient = class _ApitallyClient {
       this.syncIntervalId = void 0;
     }
   }
-  setAppInfo(appInfo) {
-    this.appInfo = appInfo;
-    this.appInfoSent = false;
-    this.sendAppInfo();
+  setStartupData(data) {
+    this.startupData = data;
+    this.startupDataSent = false;
+    this.sendStartupData();
   }
-  async sendAppInfo() {
-    if (this.appInfo) {
-      this.logger.debug("Sending app info to Apitally Hub");
+  async sendStartupData() {
+    if (this.startupData) {
+      this.logger.debug("Sending startup data to Apitally Hub");
       const payload = {
         instance_uuid: this.instanceUuid,
         message_uuid: (0, import_crypto3.randomUUID)(),
-        ...this.appInfo
+        ...this.startupData
       };
       try {
-        await this.makeHubRequest("info", payload);
-        this.appInfoSent = true;
+        await this.sendData("startup", payload);
+        this.startupDataSent = true;
       } catch (error) {
         const handled = this.handleHubError(error);
         if (!handled) {
           this.logger.error(error.message);
-          this.logger.debug("Error while sending app info to Apitally Hub (will retry)", {
+          this.logger.debug("Error while sending startup data to Apitally Hub (will retry)", {
             error
           });
         }
       }
     }
   }
-  async sendRequestsData() {
-    this.logger.debug("Sending requests data to Apitally Hub");
+  async sendSyncData() {
+    this.logger.debug("Synchronizing data with Apitally Hub");
     const newPayload = {
       time_offset: 0,
       instance_uuid: this.instanceUuid,
       message_uuid: (0, import_crypto3.randomUUID)(),
       requests: this.requestCounter.getAndResetRequests(),
       validation_errors: this.validationErrorCounter.getAndResetValidationErrors(),
-      server_errors: this.serverErrorCounter.getAndResetServerErrors()
+      server_errors: this.serverErrorCounter.getAndResetServerErrors(),
+      consumers: this.consumerRegistry.getAndResetUpdatedConsumers()
     };
-    this.requestsDataQueue.push([
+    this.syncDataQueue.push([
       Date.now(),
       newPayload
     ]);
     const failedItems = [];
-    while (this.requestsDataQueue.length > 0) {
-      const queueItem = this.requestsDataQueue.shift();
+    while (this.syncDataQueue.length > 0) {
+      const queueItem = this.syncDataQueue.shift();
       if (queueItem) {
         const [time, payload] = queueItem;
         try {
           const timeOffset = Date.now() - time;
           if (timeOffset <= MAX_QUEUE_TIME) {
             payload.time_offset = timeOffset / 1e3;
-            await this.makeHubRequest("requests", payload);
+            await this.sendData("sync", payload);
           }
         } catch (error) {
           const handled = this.handleHubError(error);
           if (!handled) {
-            this.logger.debug("Error while sending requests data to Apitally Hub (will retry)", {
+            this.logger.debug("Error while synchronizing data with Apitally Hub (will retry)", {
               error
             });
             failedItems.push(queueItem);
@@ -492,7 +551,7 @@ var _ApitallyClient = class _ApitallyClient {
         }
       }
     }
-    this.requestsDataQueue = failedItems;
+    this.syncDataQueue = failedItems;
   }
   handleHubError(error) {
     if (error instanceof HTTPError) {
@@ -527,9 +586,10 @@ function getPackageVersion(name) {
 __name(getPackageVersion, "getPackageVersion");
 
 // src/express/listEndpoints.js
-var regExpToParseExpressPathRegExp = /^\/\^\\\/(?:(:?[\w\\.-]*(?:\\\/:?[\w\\.-]*)*)|(\(\?:\(\[\^\\\/]\+\?\)\)))\\\/.*/;
-var regExpToReplaceExpressPathRegExpParams = /\(\?:\(\[\^\\\/]\+\?\)\)/;
-var regexpExpressParamRegexp = /\(\?:\(\[\^\\\/]\+\?\)\)/g;
+var regExpToParseExpressPathRegExp = /^\/\^\\\/(?:(:?[\w\\.-]*(?:\\\/:?[\w\\.-]*)*)|(\(\?:\([^)]+\)\)))\\\/.*/;
+var regExpToReplaceExpressPathRegExpParams = /\(\?:\([^)]+\)\)/;
+var regexpExpressParamRegexp = /\(\?:\([^)]+\)\)/g;
+var regexpExpressPathParamRegexp = /(:[^)]+)\([^)]+\)/g;
 var EXPRESS_ROOT_PATH_REGEXP_VALUE = "/^\\/?(?=\\/|$)/i";
 var STACK_ITEM_VALID_NAMES = [
   "router",
@@ -560,7 +620,7 @@ var parseExpressRoute = /* @__PURE__ */ __name(function(route, basePath) {
   const endpoints = paths.map((path) => {
     const completePath = basePath && path === "/" ? basePath : `${basePath}${path}`;
     const endpoint = {
-      path: completePath,
+      path: completePath.replace(regexpExpressPathParamRegexp, "$1"),
       methods: getRouteMethods(route),
       middlewares: getRouteMiddlewares(route)
     };
@@ -569,8 +629,8 @@ var parseExpressRoute = /* @__PURE__ */ __name(function(route, basePath) {
   return endpoints;
 }, "parseExpressRoute");
 var parseExpressPath = /* @__PURE__ */ __name(function(expressPathRegExp, params) {
-  let expressPathRegExpExec = regExpToParseExpressPathRegExp.exec(expressPathRegExp);
   let parsedRegExp = expressPathRegExp.toString();
+  let expressPathRegExpExec = regExpToParseExpressPathRegExp.exec(parsedRegExp);
   let paramIndex = 0;
   while (hasParams(parsedRegExp)) {
     const paramName = params[paramIndex].name;
@@ -589,13 +649,15 @@ var parseEndpoints = /* @__PURE__ */ __name(function(app, basePath, endpoints) {
   endpoints = endpoints || [];
   basePath = basePath || "";
   if (!stack) {
-    endpoints = addEndpoints(endpoints, [
-      {
-        path: basePath,
-        methods: [],
-        middlewares: []
-      }
-    ]);
+    if (endpoints.length) {
+      endpoints = addEndpoints(endpoints, [
+        {
+          path: basePath,
+          methods: [],
+          middlewares: []
+        }
+      ]);
+    }
   } else {
     endpoints = parseStack(stack, basePath, endpoints);
   }
@@ -603,7 +665,7 @@ var parseEndpoints = /* @__PURE__ */ __name(function(app, basePath, endpoints) {
 }, "parseEndpoints");
 var addEndpoints = /* @__PURE__ */ __name(function(currentEndpoints, endpointsToAdd) {
   endpointsToAdd.forEach((newEndpoint) => {
-    const existingEndpoint = currentEndpoints.find((item) => item.path === newEndpoint.path);
+    const existingEndpoint = currentEndpoints.find((endpoint) => endpoint.path === newEndpoint.path);
     if (existingEndpoint !== void 0) {
       const newMethods = newEndpoint.methods.filter((method) => !existingEndpoint.methods.includes(method));
       existingEndpoint.methods = existingEndpoint.methods.concat(newMethods);
@@ -651,7 +713,7 @@ var useApitally = /* @__PURE__ */ __name((app, config) => {
   const middleware = getMiddleware(app, client);
   app.use(middleware);
   setTimeout(() => {
-    client.setAppInfo(getAppInfo(app, config.appVersion));
+    client.setStartupData(getAppInfo(app, config.appVersion));
   }, 1e3);
 }, "useApitally");
 var getMiddleware = /* @__PURE__ */ __name((app, client) => {
@@ -680,8 +742,9 @@ var getMiddleware = /* @__PURE__ */ __name((app, client) => {
           if (req.route) {
             const responseTime = import_perf_hooks.performance.now() - startTime;
             const consumer = getConsumer(req);
+            client.consumerRegistry.addOrUpdateConsumer(consumer);
             client.requestCounter.addRequest({
-              consumer,
+              consumer: consumer == null ? void 0 : consumer.identifier,
               method: req.method,
               path: req.route.path,
               statusCode: res.statusCode,
@@ -702,7 +765,7 @@ var getMiddleware = /* @__PURE__ */ __name((app, client) => {
               }
               validationErrors.forEach((error) => {
                 client.validationErrorCounter.addValidationError({
-                  consumer,
+                  consumer: consumer == null ? void 0 : consumer.identifier,
                   method: req.method,
                   path: req.route.path,
                   ...error
@@ -712,7 +775,7 @@ var getMiddleware = /* @__PURE__ */ __name((app, client) => {
             if (res.statusCode === 500 && res.locals.serverError) {
               const serverError = res.locals.serverError;
               client.serverErrorCounter.addServerError({
-                consumer,
+                consumer: consumer == null ? void 0 : consumer.identifier,
                 method: req.method,
                 path: req.route.path,
                 type: serverError.name,
@@ -742,9 +805,10 @@ var getMiddleware = /* @__PURE__ */ __name((app, client) => {
 }, "getMiddleware");
 var getConsumer = /* @__PURE__ */ __name((req) => {
   if (req.apitallyConsumer) {
-    return String(req.apitallyConsumer);
+    return consumerFromStringOrObject(req.apitallyConsumer);
   } else if (req.consumerIdentifier) {
-    return String(req.consumerIdentifier);
+    process.emitWarning("The consumerIdentifier property on the request object is deprecated. Use apitallyConsumer instead.", "DeprecationWarning");
+    return consumerFromStringOrObject(req.consumerIdentifier);
   }
   return null;
 }, "getConsumer");