mongoose-query-logger/src/plugin.ts

   ![license](https://badgen.net/npm/license/mongoos

import mongoose from 'mongoose';
import { findQueryPlanners } from './explain';

import { defaultQueryLogger, defaultExplainLogger } from './logger';
import {
  QueryHook,
  QueryLoggerOptions,
  TARGET_METHODS,
  EXPLAIN_METHODS,
  QUERY_MIDDLEWARE,
  TargetMethod,
  ExplainMethod,
  QueryLogger,
  ExplainLogger,
  AGGREGATE_MIDDLEWARE,
  COUNT_MIDDLEWARE,
} from './types';
import { assert } from './utils';

const DEFAULT_OPTIONS: QueryLoggerOptions = {
  targetMethods: TARGET_METHODS,
  explainMethods: EXPLAIN_METHODS,
  queryLogger: defaultQueryLogger,
  explainLogger: defaultExplainLogger,
  explain: true,
  additionalLogProperties: false,
};

export class MongooseQueryLogger {
  private options: QueryLoggerOptions;

  constructor(options: Partial<QueryLoggerOptions> = {}) {
    this.options = { ...DEFAULT_OPTIONS, ...options };
  }

  public setQueryMethods({
    targetMethods,
    explainMethods,
  }: {
    targetMethods?: TargetMethod[];
    explainMethods?: ExplainMethod[];
  } = {}) {
    if (targetMethods) {
      this.options.targetMethods = targetMethods;
    }
    if (explainMethods) {
      this.options.explainMethods = explainMethods;
    }
    return this;
  }

  public setExplain(explain = false) {
    this.options.explain = explain;
    return this;
  }

  public setAdditionalLogProperties(logAdditionalProperties = false) {
    this.options.additionalLogProperties = logAdditionalProperties;
    return this;
  }

  public setQueryLogger(queryLogger: QueryLogger) {
    this.options.queryLogger = queryLogger;
    return this;
  }

  public setExplainLogger(explainLogger: ExplainLogger) {
    this.options.explainLogger = explainLogger;
    return this;
  }

  private getPreQueryHook(): QueryHook {
    return function() {
      this.__startTime = Date.now();
    };
  }

  private getPostQueryHook(): QueryHook {
    const instance = this;

    return function(this) {
      try {
        assert(this.__startTime !== null, 'startTime was null');
        assert(this._collection, 'no this._collection');

        const baseArgs = {
          operation: this.op,
          collectionName: this._collection.collectionName,
          executionTimeMS: Date.now() - this.__startTime,
          filter: this._conditions,
          fields: this._fields,
          options: { ...this._options, ...this.options },
          update: this._update,
          additionalLogProperties: this.__additionalProperties,
        };

        if (
          instance.options.explain &&
          instance.options.explainMethods.includes(this.op)
        ) {
          // execute the same query but with explain: true
          this._collection[this.op](
            this._conditions,
            {
              explain: true,
              ...this.options,
            },
            (error, result) => {
              assert(!error && !!result, 'error running explain');

              if (!Array.isArray(result)) {
                result = [result];
              }
              const plans = findQueryPlanners(result);
              assert(plans.length !== 0, 'no plans found');

              instance.options.queryLogger(baseArgs);
              instance.options.explainLogger({
                ...baseArgs,
                queryPlanners: plans,
              });
            }
          );
        } else {
          instance.options.queryLogger(baseArgs);
        }
        // prevent this middleware from stopping the middleware chain
      } catch (e) {
        console.error('Error in post middleware: ', e);
      }
    };
  }

  private getPostAggregateHook(): QueryHook {
    const instance = this;

    return async function(this) {
      try {
        assert(this.__startTime !== null, 'startTime was null');
        assert(this._model, 'no this._model');

        const baseArgs = {
          operation: 'aggregate',
          collectionName: this._model.collection.name,
          executionTimeMS: Date.now() - this.__startTime,
          filter: this._pipeline,
          fields: {},
          options: { ...this._options, ...this.options },
          update: {},
          additionalLogProperties: this.__additionalProperties,
        };

        if (
          instance.options.explain &&
          instance.options.explainMethods.includes('aggregate') &&
          !this.options?.explain
        ) {
          const result = await this._model.collection.collection
            .aggregate(this._pipeline, { ...this.options, explain: true })
            .toArray();

          assert(
            Array.isArray(result) && result.length > 0,
            'no aggregate explain'
          );

          const plans = findQueryPlanners(result);
          assert(plans.length !== 0, 'no plans found');

          instance.options.queryLogger(baseArgs);
          instance.options.explainLogger({
            ...baseArgs,
            queryPlanners: plans,
          });
        } else {
          instance.options.queryLogger(baseArgs);
        }
        // prevent this middleware from stopping the middleware chain
      } catch (e) {
        console.error('Error in post middleware: ', e);
      }
    };
  }

  public getPlugin() {
    const instance = this;

    return function(schema: mongoose.Schema) {
      // expose a method to log additional information
      // eg: User.find().additionalLogProperties('something')
      if (instance.options.additionalLogProperties) {
        schema.query.additionalLogProperties = function(
          additionalProperties: Object | string | number | boolean
        ) {
          this.__additionalProperties = additionalProperties;
          return this;
        };
      }

      // hook into query middlewares
      instance.options.targetMethods
        .filter(method => QUERY_MIDDLEWARE.includes(method))
        .forEach(method => {
          schema.pre(method, instance.getPreQueryHook());
          // @ts-ignore // TODO: FIX
          schema.post(method, instance.getPostQueryHook());
        });

      // hook into aggregate
      instance.options.targetMethods
        .filter(method => AGGREGATE_MIDDLEWARE.includes(method))
        .forEach(method => {
          schema.pre(method, instance.getPreQueryHook());
          // @ts-ignore // TODO: FIX
          schema.post(method, instance.getPostAggregateHook());
        });

      // hook into counts
      instance.options.targetMethods
        .filter(method => COUNT_MIDDLEWARE.includes(method))
        .forEach(method => {
          schema.pre(method, instance.getPreQueryHook());
          // @ts-ignore // TODO: FIX
          schema.post(method, instance.getPostQueryHook());
        });
    };
  }
}