@lenne.tech/nest-server 10.0.4 → 10.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lenne.tech/nest-server",
-  "version": "10.0.4",
+  "version": "10.0.6",
   "description": "Modern, fast, powerful Node.js web framework in TypeScript based on Nest with a GraphQL API and a connection to MongoDB (or other databases).",
   "keywords": [
     "node",
@@ -71,7 +71,7 @@
     "@nestjs/mongoose": "10.0.1",
     "@nestjs/passport": "10.0.0",
     "@nestjs/platform-express": "10.1.3",
-    "@nestjs/schedule": "3.0.1",
+    "@nestjs/schedule": "3.0.2",
     "@nestjs/terminus": "10.0.1",
     "apollo-server-core": "3.11.1",
     "apollo-server-express": "3.11.1",
@@ -108,30 +108,30 @@
   "devDependencies": {
     "@babel/plugin-proposal-private-methods": "7.18.6",
     "@compodoc/compodoc": "1.1.21",
-    "@lenne.tech/eslint-config-ts": "0.0.8",
+    "@lenne.tech/eslint-config-ts": "0.0.9",
     "@nestjs/cli": "10.1.11",
-    "@nestjs/schematics": "10.0.1",
+    "@nestjs/schematics": "10.0.2",
     "@nestjs/testing": "10.1.3",
     "@swc/cli": "0.1.62",
-    "@swc/core": "1.3.73",
-    "@swc/jest": "0.2.27",
+    "@swc/core": "1.3.76",
+    "@swc/jest": "0.2.28",
     "@types/compression": "1.7.2",
     "@types/cookie-parser": "1.4.3",
     "@types/cron": "2.0.1",
     "@types/ejs": "3.1.2",
     "@types/express": "4.17.17",
     "@types/jest": "29.5.3",
-    "@types/lodash": "4.14.196",
+    "@types/lodash": "4.14.197",
     "@types/multer": "1.4.7",
-    "@types/node": "20.4.5",
+    "@types/node": "20.4.9",
     "@types/nodemailer": "6.4.9",
     "@types/passport": "1.0.12",
     "@types/supertest": "2.0.12",
-    "@typescript-eslint/eslint-plugin": "6.2.1",
-    "@typescript-eslint/parser": "6.2.1",
+    "@typescript-eslint/eslint-plugin": "6.3.0",
+    "@typescript-eslint/parser": "6.3.0",
     "coffeescript": "2.7.0",
     "eslint": "8.46.0",
-    "eslint-config-prettier": "8.9.0",
+    "eslint-config-prettier": "9.0.0",
     "eslint-plugin-unused-imports": "3.0.0",
     "find-file-up": "2.0.1",
     "grunt": "1.6.1",
@@ -143,7 +143,7 @@
     "jest": "29.6.2",
     "npm-watch": "0.11.0",
     "pm2": "5.3.0",
-    "prettier": "3.0.0",
+    "prettier": "3.0.1",
     "pretty-quick": "3.1.3",
     "supertest": "6.3.3",
     "ts-jest": "29.1.1",

package/src/core/common/helpers/filter.helper.ts

@@ -90,8 +90,10 @@ export function findFilter(options?: {
 
   // Optimizations
   if (!filterOptions[config.type].length) {
+    // If there are no conditions, return an empty object
     filterOptions = {};
   } else if (filterOptions[config.type].length === 1) {
+    // if there is only one condition, integrate it directly into the filter options
     const additionalProperties = filterOptions[config.type][0];
     delete filterOptions[config.type];
     assignPlain(filterOptions, additionalProperties);
@@ -150,22 +152,29 @@ export function generateFilterQuery<T = any>(
   // Process single filter
   if (filter.singleFilter) {
     // Init variables
-    const { not, options, field, convertToObjectId, isReference } = filter.singleFilter;
+    const { not, options, convertToObjectId, isReference } = filter.singleFilter;
+    let field = filter.singleFilter.field;
     let value = filter.singleFilter.value;
 
-    // Convert value to object ID(s)
+    // Convert value to object ID(s), but don't change the name or the filter itself
     if (convertToObjectId || isReference) {
       value = getObjectIds(value);
 
       // Check if value is a string ID and automatic ObjectID filtering is activated
     } else if (config.automaticObjectIdFiltering && checkStringIds(value)) {
-      // Set both the string filter and the ObjectID filtering in an OR construction
-      const alternativeQuery = clone(filter.singleFilter, { circles: false });
-      alternativeQuery.value = getObjectIds(value);
-      const conf = Object.assign({}, config, { automaticObjectIdFiltering: false });
-      return {
-        $or: [generateFilterQuery(filter, conf), generateFilterQuery({ singleFilter: alternativeQuery }, conf)],
-      };
+      if (field === 'id') {
+        // Replace field name id with _id and convert value to ObjectId
+        field = '_id';
+        value = getObjectIds(value);
+      } else {
+        // For every other fields set both the string filter and the ObjectID filtering in an OR construction
+        const alternativeQuery = clone(filter.singleFilter, { circles: false });
+        alternativeQuery.value = getObjectIds(value);
+        const conf = Object.assign({}, config, { automaticObjectIdFiltering: false });
+        return {
+          $or: [generateFilterQuery(filter, conf), generateFilterQuery({ singleFilter: alternativeQuery }, conf)],
+        };
+      }
     }
 
     // Convert filter

package/src/core/common/helpers/input.helper.ts

@@ -1,3 +1,5 @@
+import * as inspector from 'inspector';
+import * as util from 'util';
 import { BadRequestException, UnauthorizedException } from '@nestjs/common';
 import { plainToInstance } from 'class-transformer';
 import { validate } from 'class-validator';
@@ -323,9 +325,8 @@ export function checkAndGetDate(input: any): Date {
  * Clone object
  * @param object Any object
  * @param options Finetuning of rfdc cloning
- * @param options.proto Copy prototype properties as well as own properties into the new object.
- *                      It's marginally faster to allow enumerable properties on the prototype to be copied into the
- *                      cloned object (not onto it's prototype, directly onto the object).
+ * @param options.checkResult Whether to compare object and cloned object via JSON.stringify and try alternative cloning
+ *                            methods if they are not equal
  * @param options.circles Keeping track of circular references will slow down performance with an additional 25% overhead.
  *                        Even if an object doesn't have any circular references, the tracking overhead is the cost.
  *                        By default if an object with a circular reference is passed to rfdc, it will throw
@@ -333,26 +334,48 @@ export function checkAndGetDate(input: any): Date {
  *                        circular references in the object. If performance is important, try removing the circular
  *                        reference from the object (set to undefined) and then add it back manually after cloning
  *                        instead of using this option.
+ * @param options.debug Whether to shoe console.debug messages
+ * @param options.proto Copy prototype properties as well as own properties into the new object.
+ *                      It's marginally faster to allow enumerable properties on the prototype to be copied into the
+ *                      cloned object (not onto it's prototype, directly onto the object).
  */
-export function clone(object: any, options?: { proto?: boolean; circles?: boolean }) {
+export function clone(object: any, options?: { checkResult?: boolean; circles?: boolean; proto?: boolean }) {
   const config = {
-    proto: false,
+    checkResult: true,
     circles: true,
+    debug: inspector.url() !== undefined,
+    proto: false,
     ...options,
   };
+
   try {
-    return rfdc(config)(object);
+    const cloned = rfdc(config)(object);
+    if (config.checkResult && !util.isDeepStrictEqual(object, cloned)) {
+      throw new Error('Cloned object differs from original object');
+    }
+    return cloned;
   } catch (e) {
-    console.debug(e, config, object, 'automatic try to use rfdc with circles');
     if (!config.circles) {
+      if (config.debug) {
+        console.debug(e, config, object, 'automatic try to use rfdc with circles');
+      }
       try {
-        return rfdc({ ...config, ...{ circles: true } })(object);
+        const clonedWithCircles = rfdc({ ...config, ...{ circles: true } })(object);
+        if (config.checkResult && !util.isDeepStrictEqual(object, clonedWithCircles)) {
+          throw new Error('Cloned object differs from original object');
+        }
+        return clonedWithCircles;
       } catch (e) {
-        console.debug(e, 'rfcd with circles did not work automatic use of _.clone!');
-        return _.clone(object);
+        if (config.debug) {
+          console.debug(e, 'rfcd with circles did not work => automatic use of _.clone!');
+        }
+        return _.cloneDeep(object);
       }
     } else {
-      return _.clone(object);
+      if (config.debug) {
+        console.debug(e, config, object, 'automatic try to use _.clone instead rfdc');
+      }
+      return _.cloneDeep(object);
     }
   }
 }

package/src/core/common/interfaces/server-options.interface.ts

@@ -60,7 +60,9 @@ export interface IJwt {
 export interface IServerOptions {
   /**
    * Automatically detect ObjectIds in string values in FilterQueries
-   * and expand them as OR query with string and ObjectId
+   * and expand them as OR query with string and ObjectId.
+   * Fields with the name "id" are renamed to "_id" and the value is converted to ObjectId,
+   * without changing the filter into an OR combined filter.
    * See generateFilterQuery in Filter helper (src/core/common/helpers/filter.helper.ts)
    */
   automaticObjectIdFiltering?: boolean;
@@ -319,6 +321,11 @@ export interface IServerOptions {
    * Configuration for Mongoose
    */
   mongoose?: {
+
+    /**
+     * Collation allows users to specify language-specific rules for string comparison,
+     * such as rules for letter-case and accent marks.
+     */
     collation?: CollationOptions;
 
     /**
@@ -336,6 +343,15 @@ export interface IServerOptions {
      * Mongoose module options
      */
     options?: MongooseModuleOptions;
+
+    /**
+     * Mongoose supports a separate strictQuery option to avoid strict mode for query filters.
+     * This is because empty query filters cause Mongoose to return all documents in the model, which can cause issues.
+     * See: https://github.com/Automattic/mongoose/issues/10763
+     * and: https://mongoosejs.com/docs/guide.html#strictQuery
+     * default: false
+     */
+    strictQuery?: boolean;
   };
 
   /**

package/src/core.module.ts

@@ -5,6 +5,7 @@ import { GraphQLModule } from '@nestjs/graphql';
 import { MongooseModule } from '@nestjs/mongoose';
 import { Context } from 'apollo-server-core';
 import graphqlUploadExpress = require('graphql-upload/graphqlUploadExpress.js');
+import mongoose from 'mongoose';
 import { merge } from './core/common/helpers/config.helper';
 import { IServerOptions } from './core/common/interfaces/server-options.interface';
 import { MapAndValidatePipe } from './core/common/pipes/map-and-validate.pipe';
@@ -154,6 +155,11 @@ export class CoreModule implements NestModule {
       providers.push(ModelDocService);
     }
 
+    // Set strict query to false by default
+    // See: https://github.com/Automattic/mongoose/issues/10763
+    // and: https://mongoosejs.com/docs/guide.html#strictQuery
+    mongoose.set('strictQuery', config.mongoose.strictQuery || false);
+
     const imports: any[] = [
       MongooseModule.forRoot(config.mongoose.uri, config.mongoose.options),
       GraphQLModule.forRootAsync<ApolloDriverConfig>(