@bedrockio/model 0.11.0 → 0.11.2

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.11.2
+
+- Fixed issue with non-async hooks hanging.
+- Further verson bumps.
+
+## 0.11.1
+
+- Changed default sort field in search to `_id`.
+- Some verson bumps.
+
 ## 0.11.0
 
 - Added clone module.

package/README.md

@@ -755,6 +755,32 @@ The [validation](#validation) generated for search using `getSearchValidation`
 is inherently looser and allows more fields to be passed to allow complex
 searches compatible with the above.
 
+#### Default Sort Order
+
+When using `search` the default sort order is:
+
+```json
+{
+  "field": "_id",
+  "order": "asc"
+}
+```
+
+The justification for this as the default is:
+
+- Ascending sort order matches the behavior of `find` methods.
+- For the majority of cases `_id` behaves identically to `createdAt` with one
+  major difference: for very large collections queries can become signifcantly
+  slow without an index on the `createdAt` field. Using `_id` prefers the
+  default (and heavily optimized) `_id` index instead. For cases where
+  `createdAt` is semantically distinct, simply pass it as the sort field
+  instead.
+- Mongo collections use `$natural` sort by default which follows disk order. For
+  small collections this is **generally** the same as insert order, however
+  documents may appear out of order for a number of different reasons which is
+  not acceptable for search operations. When maximum efficiency is needed (logs,
+  event streams, etc), `$natural` can still be passed.
+
 ### Cache
 
 The cache module allows a simple way to cache foreign fields on a document and

package/dist/cjs/const.js

@@ -7,8 +7,8 @@ exports.SEARCH_DEFAULTS = exports.POPULATE_MAX_DEPTH = void 0;
 const SEARCH_DEFAULTS = exports.SEARCH_DEFAULTS = {
   limit: 50,
   sort: {
-    field: 'createdAt',
-    order: 'desc'
+    field: '_id',
+    order: 'asc'
   }
 };
 const POPULATE_MAX_DEPTH = exports.POPULATE_MAX_DEPTH = 5;

package/dist/cjs/search.js

@@ -26,11 +26,7 @@ function applySearch(schema, definition) {
     search: config = {}
   } = definition;
   schema.static('search', function search(body = {}) {
-    const options = {
-      ..._const.SEARCH_DEFAULTS,
-      ...config.query,
-      ...body
-    };
+    const options = mergeOptions(_const.SEARCH_DEFAULTS, config.query, body);
     const {
       ids,
       keyword,
@@ -113,9 +109,13 @@ function resolveSort(sort, schema) {
     sort = [sort];
   }
   for (let {
+    name,
     field
   } of sort) {
-    if (!field || !schema.path(field)) {
+    if (name) {
+      throw new Error('Sort property "name" is not allowed. Use "field" instead.');
+    }
+    if (!field.startsWith('$') && !schema.path(field)) {
       throw new Error(`Unknown sort field "${field}".`);
     }
   }
@@ -371,4 +371,27 @@ function isForeignField(schema, path) {
     return false;
   }
   return !!(0, _utils.resolveRefPath)(schema, path);
+}
+
+// Merge options together. Do not perform deep merge
+// however the sort options do need to also be merged.
+function mergeOptions(...sources) {
+  let result = {};
+  for (let source of sources) {
+    result = {
+      ...result,
+      ...source,
+      sort: mergeSort(result.sort, source?.sort)
+    };
+  }
+  return result;
+}
+function mergeSort(sort1, sort2) {
+  if (Array.isArray(sort2)) {
+    return sort2;
+  }
+  return {
+    ...sort1,
+    ...sort2
+  };
 }

package/dist/cjs/soft-delete.js

@@ -485,6 +485,8 @@ function runHook(query, fn, check, next, args) {
     const ret = fn.apply(query, args);
     if (ret instanceof Promise) {
       ret.finally(next);
+    } else {
+      next();
     }
   } else {
     next();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrockio/model",
-  "version": "0.11.0",
+  "version": "0.11.2",
   "description": "Bedrock utilities for model creation.",
   "type": "module",
   "scripts": {
@@ -30,8 +30,8 @@
     "lodash": "^4.17.21"
   },
   "peerDependencies": {
-    "@bedrockio/yada": "^1.3.0",
-    "mongoose": "^8.6.2"
+    "@bedrockio/yada": "^1.4.1",
+    "mongoose": "^8.13.1"
   },
   "devDependencies": {
     "@babel/cli": "^7.26.4",
@@ -40,18 +40,18 @@
     "@bedrockio/eslint-plugin": "^1.1.7",
     "@bedrockio/prettier-config": "^1.0.2",
     "@bedrockio/yada": "^1.4.1",
-    "@shelf/jest-mongodb": "^4.3.2",
+    "@shelf/jest-mongodb": "^5.1.0",
     "eslint": "^9.19.0",
     "jest": "^29.7.0",
     "jest-environment-node": "^29.7.0",
-    "mongodb": "^6.12.0",
-    "mongoose": "^8.8.4",
+    "mongodb": "^6.15.0",
+    "mongoose": "^8.13.1",
     "prettier": "^3.4.2",
     "typescript": "^5.7.2"
   },
   "prettier": "@bedrockio/prettier-config",
   "volta": {
-    "node": "23.7.0",
+    "node": "22.14.0",
     "yarn": "1.22.22"
   }
 }

package/src/const.js

@@ -1,8 +1,8 @@
 export const SEARCH_DEFAULTS = {
   limit: 50,
   sort: {
-    field: 'createdAt',
-    order: 'desc',
+    field: '_id',
+    order: 'asc',
   },
 };
 

package/src/search.js

@@ -27,11 +27,7 @@ export function applySearch(schema, definition) {
   const { search: config = {} } = definition;
 
   schema.static('search', function search(body = {}) {
-    const options = {
-      ...SEARCH_DEFAULTS,
-      ...config.query,
-      ...body,
-    };
+    const options = mergeOptions(SEARCH_DEFAULTS, config.query, body);
 
     const { ids, keyword, skip = 0, limit, sort, ...rest } = options;
 
@@ -133,8 +129,13 @@ function resolveSort(sort, schema) {
   } else if (!Array.isArray(sort)) {
     sort = [sort];
   }
-  for (let { field } of sort) {
-    if (!field || !schema.path(field)) {
+  for (let { name, field } of sort) {
+    if (name) {
+      throw new Error(
+        'Sort property "name" is not allowed. Use "field" instead.',
+      );
+    }
+    if (!field.startsWith('$') && !schema.path(field)) {
       throw new Error(`Unknown sort field "${field}".`);
     }
   }
@@ -411,3 +412,25 @@ function isForeignField(schema, path) {
   }
   return !!resolveRefPath(schema, path);
 }
+
+// Merge options together. Do not perform deep merge
+// however the sort options do need to also be merged.
+function mergeOptions(...sources) {
+  let result = {};
+  for (let source of sources) {
+    result = {
+      ...result,
+      ...source,
+      sort: mergeSort(result.sort, source?.sort),
+    };
+  }
+
+  return result;
+}
+
+function mergeSort(sort1, sort2) {
+  if (Array.isArray(sort2)) {
+    return sort2;
+  }
+  return { ...sort1, ...sort2 };
+}

package/src/soft-delete.js

@@ -538,6 +538,8 @@ function runHook(query, fn, check, next, args) {
     const ret = fn.apply(query, args);
     if (ret instanceof Promise) {
       ret.finally(next);
+    } else {
+      next();
     }
   } else {
     next();

package/types/search.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../src/search.js"],"names":[],"mappings":"AAsBA,gEAwDC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAWY,CAAC;;;;;;;;;;;;;;;;;EAcZ"}
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../src/search.js"],"names":[],"mappings":"AAsBA,gEAoDC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAYa,CAAC;;;;;;;;;;;;;;;;;EAab"}