Merge branch 'master' of github.com:codex-team/hawk.api.nodejs into feat/add-daily-events-indexes

Author: slaveeks

.env.sample

@@ -20,6 +20,8 @@ JWT_SECRET_REFRESH_TOKEN=abacaba
 # JWT secret for user's access token
 JWT_SECRET_ACCESS_TOKEN=belarus
 
+# max document could for one read request to the database
+MAX_DB_READ_BATCH_SIZE=100000
 
 # JWT secret for signing tokens for processing billing requests
 JWT_SECRET_BILLING_CHECKSUM=checksum_secret

README.md

@@ -25,7 +25,8 @@ To execute the request, enter it in the input field on the left and click on the
 On the right side you will see the result of the query.
 
 ## GraphQL Voyager
-You can view API Schema visualization in `/voyager` page in your browser. To see current production schema go to [here](https://api.beta.hawk.so/voyager)
+You can view API Schema visualization in `/voyager` page in your browser.
+To see current production schema go to [here](https://api.beta.hawk.so/voyager)
 
 ## Migrations
 

docs/METRICS.md

@@ -55,7 +55,7 @@ Duration of HTTP requests in seconds, labeled by:
 - `route` - Request route/path
 - `status_code` - HTTP status code
 
-Buckets: 0.001, 0.005, 0.01, 0.05, 0.1, 0.5, 1, 5, 10 seconds
+Buckets: 0.01, 0.05, 0.1, 0.5, 1, 5, 10 seconds
 
 #### http_requests_total (Counter)
 
@@ -64,6 +64,77 @@ Total number of HTTP requests, labeled by:
 - `route` - Request route/path
 - `status_code` - HTTP status code
 
+### GraphQL Metrics
+
+#### hawk_gql_operation_duration_seconds (Histogram)
+
+Histogram of total GraphQL operation duration by operation name and type.
+
+Labels:
+- `operation_name` - Name of the GraphQL operation
+- `operation_type` - Type of operation (query, mutation, subscription)
+
+Buckets: 0.01, 0.05, 0.1, 0.5, 1, 5, 10 seconds
+
+**Purpose**: Identify slow API operations (P95/P99 latency).
+
+#### hawk_gql_operation_errors_total (Counter)
+
+Counter of failed GraphQL operations grouped by operation name and error class.
+
+Labels:
+- `operation_name` - Name of the GraphQL operation
+- `error_type` - Type/class of the error
+
+**Purpose**: Detect increased error rates and failing operations.
+
+#### hawk_gql_resolver_duration_seconds (Histogram)
+
+Histogram of resolver execution time per type, field, and operation.
+
+Labels:
+- `type_name` - GraphQL type name
+- `field_name` - Field name being resolved
+- `operation_name` - Name of the GraphQL operation
+
+Buckets: 0.01, 0.05, 0.1, 0.5, 1, 5 seconds
+
+**Purpose**: Find slow or CPU-intensive resolvers that degrade overall performance.
+
+### MongoDB Metrics
+
+#### hawk_mongo_command_duration_seconds (Histogram)
+
+Histogram of MongoDB command duration by command, collection family, and database.
+
+Labels:
+- `command` - MongoDB command name (find, insert, update, etc.)
+- `collection_family` - Collection family name (extracted from dynamic collection names to reduce cardinality)
+- `db` - Database name
+
+Buckets: 0.01, 0.05, 0.1, 0.5, 1, 5, 10 seconds
+
+**Purpose**: Detect slow queries and high-latency collections.
+
+**Note on Collection Families**: To reduce metric cardinality, dynamic collection names are grouped into families. For example:
+- `events:projectId` → `events`
+- `dailyEvents:projectId` → `dailyEvents`
+- `repetitions:projectId` → `repetitions`
+- `membership:userId` → `membership`
+- `team:workspaceId` → `team`
+
+This prevents metric explosion when dealing with thousands of projects, users, or workspaces, while still providing meaningful insights into collection performance patterns.
+
+#### hawk_mongo_command_errors_total (Counter)
+
+Counter of failed MongoDB commands grouped by command and error code.
+
+Labels:
+- `command` - MongoDB command name
+- `error_code` - MongoDB error code
+
+**Purpose**: Track transient or persistent database errors.
+
 ## Testing
 
 ### Manual Testing
@@ -98,11 +169,25 @@ The metrics implementation uses the `prom-client` library and consists of:
    - Initializes a Prometheus registry
    - Configures default Node.js metrics collection
    - Defines custom HTTP metrics (duration histogram and request counter)
+   - Registers GraphQL and MongoDB metrics
    - Provides middleware for tracking HTTP requests
    - Creates a separate Express app for serving metrics
 
-2. **Integration** (`src/index.ts`):
+2. **GraphQL Metrics** (`src/metrics/graphql.ts`):
+   - Implements Apollo Server plugin for tracking GraphQL operations
+   - Tracks operation duration, errors, and resolver execution time
+   - Automatically captures operation name, type, and field information
+
+3. **MongoDB Metrics** (`src/metrics/mongodb.ts`):
+   - Implements MongoDB command monitoring
+   - Tracks command duration and errors
+   - Uses MongoDB's command monitoring events
+   - Extracts collection families from dynamic collection names to reduce cardinality
+
+4. **Integration** (`src/index.ts`, `src/mongo.ts`):
+   - Adds GraphQL metrics plugin to Apollo Server
    - Adds metrics middleware to the main Express app
+   - Enables MongoDB command monitoring on database clients
    - Starts metrics server on a separate port
    - Keeps metrics server isolated from main API traffic
 

jest-mongodb-config.js

@@ -5,7 +5,7 @@ module.exports = {
       dbName: 'hawk',
     },
     binary: {
-      version: '4.2.13',
+      version: '6.0.2',
       skipMD5: true,
     },
     autoStart: false,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hawk.api",
-  "version": "1.1.43",
+  "version": "1.2.13",
   "main": "index.ts",
   "license": "BUSL-1.1",
   "scripts": {

src/billing/cloudpayments.ts

@@ -272,7 +272,10 @@ export default class CloudPaymentsWebhooks {
 
     try {
       await businessOperation.setStatus(BusinessOperationStatus.Confirmed);
-      await workspace.changePlan(tariffPlan._id);
+
+      if (!data.isCardLinkOperation) {
+        await workspace.changePlan(tariffPlan._id);
+      }
 
       const subscriptionId = body.SubscriptionId;
 
@@ -339,17 +342,22 @@ export default class CloudPaymentsWebhooks {
      * }
      */
 
-    try {
-      await publish('cron-tasks', 'cron-tasks/limiter', JSON.stringify({
-        type: 'unblock-workspace',
-        workspaceId: data.workspaceId,
-      }));
-    } catch (e) {
-      const error = e as Error;
+    /**
+     * If it is not a card linking operation then unblock workspace
+     */
+    if (!data.isCardLinkOperation) {
+      try {
+        await publish('cron-tasks', 'cron-tasks/limiter', JSON.stringify({
+          type: 'unblock-workspace',
+          workspaceId: data.workspaceId,
+        }));
+      } catch (e) {
+        const error = e as Error;
 
-      this.sendError(res, PayCodes.SUCCESS, `[Billing / Pay] Error while sending task to limiter worker ${error.toString()}`, body);
+        this.sendError(res, PayCodes.SUCCESS, `[Billing / Pay] Error while sending task to limiter worker ${error.toString()}`, body);
 
-      return;
+        return;
+      }
     }
 
     try {

src/dataLoaders.ts

@@ -1,6 +1,10 @@
 import DataLoader from 'dataloader';
 import { Db, ObjectId } from 'mongodb';
-import { PlanDBScheme, UserDBScheme, WorkspaceDBScheme, ProjectDBScheme } from '@hawk.so/types';
+import { PlanDBScheme, UserDBScheme, WorkspaceDBScheme, ProjectDBScheme, EventData, EventAddons } from '@hawk.so/types';
+
+type EventDbScheme = {
+  _id: ObjectId;
+} & EventData<EventAddons>;
 
 /**
  * Class for setting up data loaders
@@ -65,7 +69,7 @@ export default class DataLoaders {
    * @param collectionName - collection name to get entities
    * @param ids - ids for resolving
    */
-  private async batchByIds<T extends {_id: ObjectId}>(collectionName: string, ids: ReadonlyArray<string>): Promise<(T | null | Error)[]> {
+  private async batchByIds<T extends { _id: ObjectId }>(collectionName: string, ids: ReadonlyArray<string>): Promise<(T | null | Error)[]> {
     return this.batchByField<T, ObjectId>(collectionName, ids.map(id => new ObjectId(id)), '_id');
   }
 
@@ -77,12 +81,18 @@ export default class DataLoaders {
    */
   private async batchByField<
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    T extends {[key: string]: any},
-    FieldType extends object | string
-    >(collectionName: string, values: ReadonlyArray<FieldType>, fieldName: string): Promise<(T | null | Error)[]> {
+    T extends { [key: string]: any },
+    FieldType extends ObjectId | string
+  >(collectionName: string, values: ReadonlyArray<FieldType>, fieldName: string): Promise<(T | null | Error)[]> {
+    const valuesMap = new Map<string, FieldType>();
+
+    for (const value of values) {
+      valuesMap.set(value.toString(), value);
+    }
+
     const queryResult = await this.dbConnection.collection(collectionName)
       .find({
-        [fieldName]: { $in: values },
+        [fieldName]: { $in: Array.from(valuesMap.values()) },
       })
       .toArray();
 
@@ -99,3 +109,34 @@ export default class DataLoaders {
     return values.map((field) => entitiesMap[field.toString()] || null);
   }
 }
+
+/**
+ * Create DataLoader for events in dynamic collections `events:<projectId>` stored in the events DB
+ *
+ * @param eventsDb - MongoDB connection to the events database
+ * @param projectId - project id used to pick a dynamic collection
+ */
+export function createProjectEventsByIdLoader(
+  eventsDb: Db,
+  projectId: string
+): DataLoader<string, EventDbScheme | null> {
+  return new DataLoader<string, EventDbScheme | null>(async (ids) => {
+    /**
+     * Deduplicate only for the DB query; keep original ids array for mapping
+     */
+    const objectIds = [ ...new Set(ids) ].map(id => new ObjectId(id));
+
+    const docs = await eventsDb
+      .collection(`events:${projectId}`)
+      .find({ _id: { $in: objectIds } })
+      .toArray();
+
+    const map: Record<string, EventDbScheme> = {};
+
+    docs.forEach((doc) => {
+      map[doc._id.toString()] = doc as EventDbScheme;
+    });
+
+    return ids.map((id) => map[id] || null);
+  }, { cache: true });
+}

src/index.ts

@@ -26,8 +26,8 @@ import PlansFactory from './models/plansFactory';
 import BusinessOperationsFactory from './models/businessOperationsFactory';
 import schema from './schema';
 import { graphqlUploadExpress } from 'graphql-upload';
-import morgan from 'morgan';
-import { metricsMiddleware, createMetricsServer } from './metrics';
+import { metricsMiddleware, createMetricsServer, graphqlMetricsPlugin } from './metrics';
+import { requestLogger } from './utils/logger';
 
 /**
  * Option to enable playground
@@ -85,19 +85,17 @@ class HawkAPI {
       next();
     });
 
-    /**
-     * Setup request logger.
-     * Uses 'combined' format in production for Apache-style logging,
-     * and 'dev' format in development for colored, concise output.
-     */
-    this.app.use(morgan(process.env.NODE_ENV === 'production' ? 'combined' : 'dev'));
-
     /**
      * Add metrics middleware to track HTTP requests
      */
     this.app.use(metricsMiddleware);
 
     this.app.use(express.json());
+
+    /**
+     * Setup request logger with custom formatters (GraphQL operation name support)
+     */
+    this.app.use(requestLogger);
     this.app.use(bodyParser.urlencoded({ extended: false }));
     this.app.use('/static', express.static(`./static`));
 
@@ -122,6 +120,7 @@ class HawkAPI {
         process.env.NODE_ENV === 'production'
           ? ApolloServerPluginLandingPageDisabled()
           : ApolloServerPluginLandingPageGraphQLPlayground(),
+        graphqlMetricsPlugin,
       ],
       context: ({ req }): ResolverContextBase => req.context,
       formatError: (error): GraphQLError => {