tango-app-api-trax 3.9.23 → 3.9.24

package/src/logging/config.js

@@ -0,0 +1,24 @@
+/**
+ * Self-contained configuration for the activity logging module.
+ *
+ * Read directly from process.env so this module has zero dependency on
+ * consumers' env.js layout. Getters (not cached values) so dotenv can load
+ * after this module is imported.
+ */
+
+const DEFAULT_INDEX = 'trax-activity-logs-test';
+const LOG_VERSION = 'v1';
+
+export const loggingConfig = {
+  get enabled() {
+    return process.env.TRAX_ACTIVITY_LOGGING === 'true';
+  },
+  get index() {
+    try {
+      return JSON.parse( process.env.OPENSEARCH || '{}' )?.traxActivityLog || DEFAULT_INDEX;
+    } catch ( _e ) {
+      return DEFAULT_INDEX;
+    }
+  },
+  version: LOG_VERSION,
+};

package/src/logging/createLoggableService.js

@@ -0,0 +1,46 @@
+import { getLogContext, pushStep, pushStepFailure } from './activityLogStore.js';
+import { loggingConfig } from './config.js';
+
+const WRITE_OPS = [
+  'create',
+  'updateOne',
+  'updateMany',
+  'deleteOne',
+  'deleteMany',
+  'upsertOne',
+  'insertMany',
+  'bulkUpsert',
+  'bulkWrite',
+  'removeKeys',
+  'findOneAndUpdate',
+  'findOneAndUpdate2',
+  'updateOneArrayItem',
+  'update',
+];
+
+export function createLoggableService( serviceModule, collectionName ) {
+  // Install the proxy unconditionally. The enabled-check happens at call time
+  // inside the `get` trap so env vars loaded after module import (via dotenv)
+  // are observed correctly.
+  return new Proxy( serviceModule, {
+    get( target, prop ) {
+      const original = target[prop];
+      if ( !WRITE_OPS.includes( prop ) || typeof original !== 'function' ) return original;
+      if ( !loggingConfig.enabled ) return original;
+
+      return async function( ...args ) {
+        const ctx = getLogContext();
+        const start = Date.now();
+        const stepName = `${ collectionName }.${ prop }`;
+        try {
+          const result = await original.apply( target, args );
+          if ( ctx ) pushStep( { name: stepName, type: 'db', status: 'success', ms: Date.now() - start } );
+          return result;
+        } catch ( e ) {
+          if ( ctx ) pushStepFailure( { name: stepName, type: 'db', ms: Date.now() - start }, e );
+          throw e;
+        }
+      };
+    },
+  } );
+}

package/src/logging/logExternalCall.js

@@ -0,0 +1,37 @@
+import { pushStep, pushStepFailure } from './activityLogStore.js';
+
+export async function logExternalCall( serviceName, url, options = {} ) {
+  const start = Date.now();
+  const stepName = `external.${ serviceName }`;
+  try {
+    const res = await fetch( url, options );
+    pushStep( {
+      name: stepName,
+      type: 'external',
+      status: res.ok ? 'success' : 'failed',
+      ms: Date.now() - start,
+    } );
+    return res;
+  } catch ( e ) {
+    pushStepFailure( { name: stepName, type: 'external', ms: Date.now() - start }, e );
+    throw e;
+  }
+}
+
+export async function logQueueMessage( serviceName, queueUrl, messageBody, sendMessageToQueueFn ) {
+  const start = Date.now();
+  const stepName = `external.${ serviceName }`;
+  try {
+    const result = await sendMessageToQueueFn( queueUrl, messageBody );
+    pushStep( {
+      name: stepName,
+      type: 'external',
+      status: 'success',
+      ms: Date.now() - start,
+    } );
+    return result;
+  } catch ( e ) {
+    pushStepFailure( { name: stepName, type: 'external', ms: Date.now() - start }, e );
+    throw e;
+  }
+}

package/src/services/app.service.js

@@ -1,14 +1,20 @@
-import model from 'tango-api-schema';
-
-export const aggregate = async ( query ={} ) => {
-  return model.appVersionModel.aggregate( query );
-};
-
-export const updateOne = async ( query, record ) => {
-  return model.appVersionModel.updateOne( query, { $set: record }, { upsert: true } );
-};
-
-export const findOne = async ( query ={}, field={} ) => {
-  return model.appVersionModel.findOne( query, field );
-};
-
+import model from 'tango-api-schema';
+import { createLoggableService } from '../logging/createLoggableService.js';
+
+const _methods = {
+  async aggregate( query ={} ) {
+    return model.appVersionModel.aggregate( query );
+  },
+  async updateOne( query, record ) {
+    return model.appVersionModel.updateOne( query, { $set: record }, { upsert: true } );
+  },
+  async findOne( query ={}, field={} ) {
+    return model.appVersionModel.findOne( query, field );
+  },
+};
+
+const _svc = createLoggableService( _methods, 'appversions' );
+
+export const aggregate = ( ...args ) => _svc.aggregate( ...args );
+export const updateOne = ( ...args ) => _svc.updateOne( ...args );
+export const findOne   = ( ...args ) => _svc.findOne( ...args );

package/src/services/approver.service.js

@@ -1,20 +1,28 @@
-import model from 'tango-api-schema';
-
-export const create = async ( data ) => {
-  return model.traxApproverModel.create( data );
-};
-
-export const updateMany = async ( query={}, record={} ) => {
-  return model.traxApproverModel.updateMany( query, { $set: record } );
-};
-
-export const insertMany = async ( data = [] ) => {
-  return model.traxApproverModel.insertMany( data );
-};
-
-export const find = async ( query ={}, field={} ) => {
-  return model.traxApproverModel.find( query, field );
-};
-export const findOne = async ( query ={}, field={} ) => {
-  return model.traxApproverModel.findOne( query, field );
-};
+import model from 'tango-api-schema';
+import { createLoggableService } from '../logging/createLoggableService.js';
+
+const _methods = {
+  async create( data ) {
+    return model.traxApproverModel.create( data );
+  },
+  async updateMany( query={}, record={} ) {
+    return model.traxApproverModel.updateMany( query, { $set: record } );
+  },
+  async insertMany( data = [] ) {
+    return model.traxApproverModel.insertMany( data );
+  },
+  async find( query ={}, field={} ) {
+    return model.traxApproverModel.find( query, field );
+  },
+  async findOne( query ={}, field={} ) {
+    return model.traxApproverModel.findOne( query, field );
+  },
+};
+
+const _svc = createLoggableService( _methods, 'approvers' );
+
+export const create     = ( ...args ) => _svc.create( ...args );
+export const updateMany = ( ...args ) => _svc.updateMany( ...args );
+export const insertMany = ( ...args ) => _svc.insertMany( ...args );
+export const find       = ( ...args ) => _svc.find( ...args );
+export const findOne    = ( ...args ) => _svc.findOne( ...args );

package/src/services/authentication.service.js

@@ -1,6 +1,12 @@
-import authenticationModel from 'tango-api-schema/schema/authentication.model.js';
-
-export async function create( data ) {
-  return authenticationModel.create( data );
-}
-
+import authenticationModel from 'tango-api-schema/schema/authentication.model.js';
+import { createLoggableService } from '../logging/createLoggableService.js';
+
+const _methods = {
+  async create( data ) {
+    return authenticationModel.create( data );
+  },
+};
+
+const _svc = createLoggableService( _methods, 'authentications' );
+
+export const create = ( ...args ) => _svc.create( ...args );

package/src/services/camera.service.js

@@ -1,18 +1,24 @@
-import model from 'tango-api-schema';
-
-export const aggregate = async ( query ={} ) => {
-  return model.cameraModel.aggregate( query );
-};
-
-export const updateOne = async ( query, record ) => {
-  return model.cameraModel.updateOne( query, { $set: record }, { upsert: true } );
-};
-
-export const findOne = async ( query ={}, field={} ) => {
-  return model.cameraModel.findOne( query, field );
-};
-
-export const find = async ( query ={}, field={} ) => {
-  return model.cameraModel.find( query, field );
-};
-
+import model from 'tango-api-schema';
+import { createLoggableService } from '../logging/createLoggableService.js';
+
+const _methods = {
+  async aggregate( query ={} ) {
+    return model.cameraModel.aggregate( query );
+  },
+  async updateOne( query, record ) {
+    return model.cameraModel.updateOne( query, { $set: record }, { upsert: true } );
+  },
+  async findOne( query ={}, field={} ) {
+    return model.cameraModel.findOne( query, field );
+  },
+  async find( query ={}, field={} ) {
+    return model.cameraModel.find( query, field );
+  },
+};
+
+const _svc = createLoggableService( _methods, 'cameras' );
+
+export const aggregate = ( ...args ) => _svc.aggregate( ...args );
+export const updateOne = ( ...args ) => _svc.updateOne( ...args );
+export const findOne   = ( ...args ) => _svc.findOne( ...args );
+export const find      = ( ...args ) => _svc.find( ...args );

package/src/services/checklist.service.js

@@ -1,31 +1,36 @@
-import model from 'tango-api-schema';
-
-export const findOne = async ( query={}, field={} ) => {
-  return model.checklistconfigModel.findOne( query, field );
-};
-
-export const find = async ( query={}, field={} ) => {
-  return model.checklistconfigModel.find( query, field );
-};
-
-export const create = async ( document = {} ) => {
-  return model.checklistconfigModel.create( document );
-};
-
-export const deleteOne = async ( query = {} ) => {
-  return model.checklistconfigModel.deleteOne( query );
-};
-
-export const updateOne = async ( query = {}, record={} ) => {
-  return model.checklistconfigModel.updateOne( query, { $set: record }, { upsert: true } );
-};
-
-export const updateMany = async ( query = {}, record={} ) => {
-  return model.checklistconfigModel.updateMany( query, { $set: record } );
-};
-
-export const aggregate = async ( query = {} ) => {
-  return model.checklistconfigModel.aggregate( query );
-};
-
-
+import model from 'tango-api-schema';
+import { createLoggableService } from '../logging/createLoggableService.js';
+
+const _methods = {
+  async findOne( query={}, field={} ) {
+    return model.checklistconfigModel.findOne( query, field );
+  },
+  async find( query={}, field={} ) {
+    return model.checklistconfigModel.find( query, field );
+  },
+  async create( document = {} ) {
+    return model.checklistconfigModel.create( document );
+  },
+  async deleteOne( query = {} ) {
+    return model.checklistconfigModel.deleteOne( query );
+  },
+  async updateOne( query = {}, record={} ) {
+    return model.checklistconfigModel.updateOne( query, { $set: record }, { upsert: true } );
+  },
+  async updateMany( query = {}, record={} ) {
+    return model.checklistconfigModel.updateMany( query, { $set: record } );
+  },
+  async aggregate( query = {} ) {
+    return model.checklistconfigModel.aggregate( query );
+  },
+};
+
+const _svc = createLoggableService( _methods, 'checklists' );
+
+export const findOne    = ( ...args ) => _svc.findOne( ...args );
+export const find       = ( ...args ) => _svc.find( ...args );
+export const create     = ( ...args ) => _svc.create( ...args );
+export const deleteOne  = ( ...args ) => _svc.deleteOne( ...args );
+export const updateOne  = ( ...args ) => _svc.updateOne( ...args );
+export const updateMany = ( ...args ) => _svc.updateMany( ...args );
+export const aggregate  = ( ...args ) => _svc.aggregate( ...args );

package/src/services/checklistAssign.service.js

@@ -1,39 +1,44 @@
-import model from 'tango-api-schema';
-
-export const find = async ( query={}, field={} ) => {
-  return model.checklistassignconfigModel.find( query, field );
-};
-
-export const findOne = async ( query={}, field={} ) => {
-  return model.checklistassignconfigModel.findOne( query, field );
-};
-
-export const create = async ( document = {} ) => {
-  return model.checklistassignconfigModel.create( document );
-};
-
-export const insertMany = async ( document = {} ) => {
-  return model.checklistassignconfigModel.insertMany( document );
-};
-
-export const deleteMany = async ( document = {} ) => {
-  return model.checklistassignconfigModel.deleteMany( document );
-};
-
-export const updateMany = async ( query = {}, record={} ) => {
-  return model.checklistassignconfigModel.updateMany( query, { $set: record } );
-};
-
-export const updateOne = async ( query = {}, record={} ) => {
-  return model.checklistassignconfigModel.updateOne( query, { $set: record }, { upsert: true } );
-};
-
-export const aggregate = async ( query = {} ) => {
-  return model.checklistassignconfigModel.aggregate( query );
-};
-
-export const count = async ( query = {} ) => {
-  return model.checklistassignconfigModel.countDocuments( query );
-};
-
-
+import model from 'tango-api-schema';
+import { createLoggableService } from '../logging/createLoggableService.js';
+
+const _methods = {
+  async find( query={}, field={} ) {
+    return model.checklistassignconfigModel.find( query, field );
+  },
+  async findOne( query={}, field={} ) {
+    return model.checklistassignconfigModel.findOne( query, field );
+  },
+  async create( document = {} ) {
+    return model.checklistassignconfigModel.create( document );
+  },
+  async insertMany( document = {} ) {
+    return model.checklistassignconfigModel.insertMany( document );
+  },
+  async deleteMany( document = {} ) {
+    return model.checklistassignconfigModel.deleteMany( document );
+  },
+  async updateMany( query = {}, record={} ) {
+    return model.checklistassignconfigModel.updateMany( query, { $set: record } );
+  },
+  async updateOne( query = {}, record={} ) {
+    return model.checklistassignconfigModel.updateOne( query, { $set: record }, { upsert: true } );
+  },
+  async aggregate( query = {} ) {
+    return model.checklistassignconfigModel.aggregate( query );
+  },
+  async count( query = {} ) {
+    return model.checklistassignconfigModel.countDocuments( query );
+  },
+};
+
+const _svc = createLoggableService( _methods, 'checklistassigns' );
+
+export const find       = ( ...args ) => _svc.find( ...args );
+export const findOne    = ( ...args ) => _svc.findOne( ...args );
+export const create     = ( ...args ) => _svc.create( ...args );
+export const insertMany = ( ...args ) => _svc.insertMany( ...args );
+export const deleteMany = ( ...args ) => _svc.deleteMany( ...args );
+export const updateMany = ( ...args ) => _svc.updateMany( ...args );
+export const updateOne  = ( ...args ) => _svc.updateOne( ...args );
+export const aggregate  = ( ...args ) => _svc.aggregate( ...args );
+export const count      = ( ...args ) => _svc.count( ...args );

package/src/services/checklistQuestion.service.js

@@ -1,35 +1,40 @@
-import model from 'tango-api-schema';
-
-export const find = async ( query={}, field={} ) => {
-  return model.checklistquestionconfigModel.find( query, field );
-};
-
-export const findOne = async ( query={}, field={} ) => {
-  return model.checklistquestionconfigModel.findOne( query, field );
-};
-
-export const create = async ( document = {} ) => {
-  return model.checklistquestionconfigModel.create( document );
-};
-
-export const insertMany = async ( document = {} ) => {
-  return model.checklistquestionconfigModel.insertMany( document );
-};
-
-export const updateMany = async ( query = {}, record={} ) => {
-  return model.checklistquestionconfigModel.updateMany( query, { $set: record } );
-};
-
-export const deleteMany = async ( query = {} ) => {
-  return model.checklistquestionconfigModel.deleteMany( query );
-};
-
-export const aggregate = async ( query = {} ) => {
-  return model.checklistquestionconfigModel.aggregate( query );
-};
-
-export const findSort = async ( query={}, field={}, sort = {} ) => {
-  return model.checklistquestionconfigModel.find( query, field ).sort( sort );
-};
-
-
+import model from 'tango-api-schema';
+import { createLoggableService } from '../logging/createLoggableService.js';
+
+const _methods = {
+  async find( query={}, field={} ) {
+    return model.checklistquestionconfigModel.find( query, field );
+  },
+  async findOne( query={}, field={} ) {
+    return model.checklistquestionconfigModel.findOne( query, field );
+  },
+  async create( document = {} ) {
+    return model.checklistquestionconfigModel.create( document );
+  },
+  async insertMany( document = {} ) {
+    return model.checklistquestionconfigModel.insertMany( document );
+  },
+  async updateMany( query = {}, record={} ) {
+    return model.checklistquestionconfigModel.updateMany( query, { $set: record } );
+  },
+  async deleteMany( query = {} ) {
+    return model.checklistquestionconfigModel.deleteMany( query );
+  },
+  async aggregate( query = {} ) {
+    return model.checklistquestionconfigModel.aggregate( query );
+  },
+  async findSort( query={}, field={}, sort = {} ) {
+    return model.checklistquestionconfigModel.find( query, field ).sort( sort );
+  },
+};
+
+const _svc = createLoggableService( _methods, 'checklistquestions' );
+
+export const find       = ( ...args ) => _svc.find( ...args );
+export const findOne    = ( ...args ) => _svc.findOne( ...args );
+export const create     = ( ...args ) => _svc.create( ...args );
+export const insertMany = ( ...args ) => _svc.insertMany( ...args );
+export const updateMany = ( ...args ) => _svc.updateMany( ...args );
+export const deleteMany = ( ...args ) => _svc.deleteMany( ...args );
+export const aggregate  = ( ...args ) => _svc.aggregate( ...args );
+export const findSort   = ( ...args ) => _svc.findSort( ...args );

package/src/services/checklistlog.service.js

@@ -1,35 +1,40 @@
-import model from 'tango-api-schema';
-
-export const findOne = async ( query={}, field={} ) => {
-  return model.checklistlogModel.findOne( query, field );
-};
-
-export const find = async ( query={}, field={} ) => {
-  return model.checklistlogModel.find( query, field );
-};
-
-export const create = async ( document = {} ) => {
-  return model.checklistlogModel.create( document );
-};
-
-export const deleteOne = async ( query = {} ) => {
-  return model.checklistlogModel.deleteOne( query );
-};
-
-export const updateOne = async ( query = {}, record={} ) => {
-  return model.checklistlogModel.updateOne( query, { $set: record } );
-};
-
-export const updateMany = async ( query = {}, record={} ) => {
-  return model.checklistlogModel.updateMany( query, { $set: record } );
-};
-
-export const deleteMany = async ( query = {} ) => {
-  return model.checklistlogModel.deleteMany( query );
-};
-
-export const aggregate = async ( query = {} ) => {
-  return model.checklistlogModel.aggregate( query );
-};
-
-
+import model from 'tango-api-schema';
+import { createLoggableService } from '../logging/createLoggableService.js';
+
+const _methods = {
+  async findOne( query={}, field={} ) {
+    return model.checklistlogModel.findOne( query, field );
+  },
+  async find( query={}, field={} ) {
+    return model.checklistlogModel.find( query, field );
+  },
+  async create( document = {} ) {
+    return model.checklistlogModel.create( document );
+  },
+  async deleteOne( query = {} ) {
+    return model.checklistlogModel.deleteOne( query );
+  },
+  async updateOne( query = {}, record={} ) {
+    return model.checklistlogModel.updateOne( query, { $set: record } );
+  },
+  async updateMany( query = {}, record={} ) {
+    return model.checklistlogModel.updateMany( query, { $set: record } );
+  },
+  async deleteMany( query = {} ) {
+    return model.checklistlogModel.deleteMany( query );
+  },
+  async aggregate( query = {} ) {
+    return model.checklistlogModel.aggregate( query );
+  },
+};
+
+const _svc = createLoggableService( _methods, 'checklistlogs' );
+
+export const findOne     = ( ...args ) => _svc.findOne( ...args );
+export const find        = ( ...args ) => _svc.find( ...args );
+export const create      = ( ...args ) => _svc.create( ...args );
+export const deleteOne   = ( ...args ) => _svc.deleteOne( ...args );
+export const updateOne   = ( ...args ) => _svc.updateOne( ...args );
+export const updateMany  = ( ...args ) => _svc.updateMany( ...args );
+export const deleteMany  = ( ...args ) => _svc.deleteMany( ...args );
+export const aggregate   = ( ...args ) => _svc.aggregate( ...args );

package/src/services/clientRequest.service.js

@@ -1,5 +1,12 @@
-import model from 'tango-api-schema';
-
-export const create = async ( document ) => {
-  return model.clientRequestModel.create( document );
-};
+import model from 'tango-api-schema';
+import { createLoggableService } from '../logging/createLoggableService.js';
+
+const _methods = {
+  async create( document ) {
+    return model.clientRequestModel.create( document );
+  },
+};
+
+const _svc = createLoggableService( _methods, 'clientrequests' );
+
+export const create = ( ...args ) => _svc.create( ...args );

package/src/services/clients.services.js

@@ -1,23 +1,28 @@
 import model from 'tango-api-schema';
+import { createLoggableService } from '../logging/createLoggableService.js';
 
-export const find = ( query = {}, record = {} ) => {
-  return model.clientModel.find( query, record );
-};
-
-export const findOne = ( query = {}, record = {} ) => {
-  return model.clientModel.findOne( query, record ).sort( { updatedAt: -1 } );
-};
-
-export const updateOne = ( query = {}, record = {} ) => {
-  return model.clientModel.updateOne( query, { $set: record } );
-};
-
-export const aggregate = ( query = [] ) => {
-  return model.clientModel.aggregate( query );
-};
-
-export const getClientCount = ( query = {} ) => {
-  return model.clientModel.count( query );
+const _methods = {
+  find( query = {}, record = {} ) {
+    return model.clientModel.find( query, record );
+  },
+  findOne( query = {}, record = {} ) {
+    return model.clientModel.findOne( query, record ).sort( { updatedAt: -1 } );
+  },
+  updateOne( query = {}, record = {} ) {
+    return model.clientModel.updateOne( query, { $set: record } );
+  },
+  aggregate( query = [] ) {
+    return model.clientModel.aggregate( query );
+  },
+  getClientCount( query = {} ) {
+    return model.clientModel.count( query );
+  },
 };
 
+const _svc = createLoggableService( _methods, 'clients' );
 
+export const find = ( ...args ) => _svc.find( ...args );
+export const findOne = ( ...args ) => _svc.findOne( ...args );
+export const updateOne = ( ...args ) => _svc.updateOne( ...args );
+export const aggregate = ( ...args ) => _svc.aggregate( ...args );
+export const getClientCount = ( ...args ) => _svc.getClientCount( ...args );