@nocobase/database 0.10.0-alpha.2 → 0.10.0-alpha.3

package/lib/repository.js

@@ -39,6 +39,10 @@ function _flat() {
   return data;
 }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
@@ -46,7 +50,7 @@ function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typ
 function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
 function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
-function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e2) { throw _e2; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e3) { didErr = true; err = _e3; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
 function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
 function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
 var __decorate = void 0 && (void 0).__decorate || function (decorators, target, key, desc) {
@@ -454,6 +458,43 @@ class Repository {
       }));
       const values = guard.sanitize(options.values);
       const queryOptions = _this10.buildQueryOptions(options);
+      // NOTE:
+      // 1. better to be moved to separated API like bulkUpdate/updateMany
+      // 2. strictly `false` comparing for compatibility of legacy api invoking
+      if (options.individualHooks === false) {
+        const Model = _this10.collection.model;
+        // @ts-ignore
+        const primaryKeyField = Model.primaryKeyField || Model.primaryKeyAttribute;
+        // NOTE:
+        // 1. find ids first for reusing `queryOptions` logic
+        // 2. estimation memory usage will be N * M bytes (N = rows, M = model object memory)
+        // 3. would be more efficient up to 100000 ~ 1000000 rows
+        const rows = yield Model.findAll(_objectSpread(_objectSpread({}, queryOptions), {}, {
+          attributes: [primaryKeyField],
+          group: `${Model.name}.${primaryKeyField}`,
+          include: queryOptions.include.filter(include => {
+            var _JSON$stringify3;
+            return Object.keys(include.where || {}).length > 0 || ((_JSON$stringify3 = JSON.stringify(queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.filter)) === null || _JSON$stringify3 === void 0 ? void 0 : _JSON$stringify3.includes(include.association));
+          }),
+          transaction
+        }));
+        const _yield$Model$update = yield Model.update(values, {
+            where: {
+              [primaryKeyField]: rows.map(row => row.get(primaryKeyField))
+            },
+            fields: options.fields,
+            hooks: options.hooks,
+            validate: options.validate,
+            sideEffects: options.sideEffects,
+            limit: options.limit,
+            silent: options.silent,
+            transaction
+          }),
+          _yield$Model$update2 = _slicedToArray(_yield$Model$update, 1),
+          result = _yield$Model$update2[0];
+        // TODO: not support association fields except belongsTo
+        return result;
+      }
       const instances = yield _this10.find(_objectSpread(_objectSpread({}, queryOptions), {}, {
         transaction
       }));

package/lib/update-guard.js

@@ -78,6 +78,7 @@ class UpdateGuard {
     // sanitize association values
     Object.keys(associationsValues).forEach(association => {
       let associationValues = associationsValues[association];
+      const associationObj = associations[association];
       const filterAssociationToBeUpdate = value => {
         if (value === null) {
           return value;
@@ -86,7 +87,6 @@ class UpdateGuard {
         if (associationKeysToBeUpdate.includes(association)) {
           return value;
         }
-        const associationObj = associations[association];
         const associationKeyName = associationObj.associationType == 'BelongsTo' || associationObj.associationType == 'HasOne' ? associationObj.targetKey : associationObj.target.primaryKeyAttribute;
         if (value[associationKeyName]) {
           return _lodash().default.pick(value, [associationKeyName, ...Object.keys(associationObj.target.associations)]);
@@ -114,6 +114,15 @@ class UpdateGuard {
       }
       // set association values to sanitized value
       values[association] = associationValues;
+      if (associationObj.associationType === 'BelongsTo') {
+        if (typeof associationValues === 'object' && associationValues !== null) {
+          if (associationValues[associationObj.targetKey] != null) {
+            values[associationObj.foreignKey] = associationValues[associationObj.targetKey];
+          }
+        } else {
+          values[associationObj.foreignKey] = associationValues;
+        }
+      }
     });
     if (values instanceof _model.Model) {
       return values;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@nocobase/database",
-  "version": "0.10.0-alpha.2",
+  "version": "0.10.0-alpha.3",
   "description": "",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "license": "Apache-2.0",
   "dependencies": {
-    "@nocobase/logger": "0.10.0-alpha.2",
-    "@nocobase/utils": "0.10.0-alpha.2",
+    "@nocobase/logger": "0.10.0-alpha.3",
+    "@nocobase/utils": "0.10.0-alpha.3",
     "async-mutex": "^0.3.2",
     "cron-parser": "4.4.0",
     "deepmerge": "^4.2.2",
@@ -28,5 +28,5 @@
     "url": "git+https://github.com/nocobase/nocobase.git",
     "directory": "packages/database"
   },
-  "gitHead": "85028ae1733fcbd46ecd5d291dacbdc175f7f073"
+  "gitHead": "1f0b27fc9ab2398cd41c308a6b01a986e025cd20"
 }

package/src/__tests__/repository.test.ts

@@ -398,6 +398,7 @@ describe('repository.update', () => {
       fields: [
         { type: 'string', name: 'name' },
         { type: 'hasMany', name: 'comments' },
+        { type: 'belongsTo', name: 'user' },
       ],
     });
     Comment = db.collection({
@@ -411,7 +412,7 @@ describe('repository.update', () => {
     await db.close();
   });
 
-  it('update1', async () => {
+  it('update with filterByTk and with associations', async () => {
     const user = await User.model.create<any>({
       name: 'user1',
     });
@@ -454,7 +455,7 @@ describe('repository.update', () => {
     expect(updated2.posts.length).toBe(2);
   });
 
-  it('update2', async () => {
+  it('update with filterByTk', async () => {
     const user = await User.model.create<any>({
       name: 'user1',
     });
@@ -463,6 +464,9 @@ describe('repository.update', () => {
       name: 'user2',
     });
 
+    const hook = jest.fn();
+    db.on('users.afterUpdate', hook);
+
     await User.repository.update({
       filterByTk: user.id,
       values: {
@@ -470,6 +474,8 @@ describe('repository.update', () => {
       },
     });
 
+    expect(hook).toBeCalledTimes(1);
+
     const updated = await User.model.findByPk(user.id);
 
     expect(updated.get('name')).toEqual('user11');
@@ -477,6 +483,119 @@ describe('repository.update', () => {
     const u2 = await User.model.findByPk(user2.id);
     expect(u2.get('name')).toEqual('user2');
   });
+
+  it('update with filter one by one when individualHooks is not set', async () => {
+    const u1 = await User.repository.create({ values: { name: 'u1' } });
+
+    const p1 = await Post.repository.create({ values: { name: 'p1', userId: u1.id } });
+    const p2 = await Post.repository.create({ values: { name: 'p2', userId: u1.id } });
+    const p3 = await Post.repository.create({ values: { name: 'p3' } });
+
+    const hook = jest.fn();
+    db.on('posts.afterUpdate', hook);
+
+    await Post.repository.update({
+      filter: {
+        userId: u1.id,
+      },
+      values: {
+        name: 'pp',
+      },
+    });
+
+    const postsAfterUpdated = await Post.repository.find({ order: [['id', 'ASC']] });
+    expect(postsAfterUpdated[0].name).toBe('pp');
+    expect(postsAfterUpdated[1].name).toBe('pp');
+    expect(postsAfterUpdated[2].name).toBe('p3');
+
+    expect(hook).toBeCalledTimes(2);
+  });
+
+  it('update in batch when individualHooks is false', async () => {
+    const u1 = await User.repository.create({ values: { name: 'u1' } });
+
+    const p1 = await Post.repository.create({ values: { name: 'p1', userId: u1.id } });
+    const p2 = await Post.repository.create({ values: { name: 'p2', userId: u1.id } });
+    const p3 = await Post.repository.create({ values: { name: 'p3' } });
+
+    const hook = jest.fn();
+    db.on('posts.afterUpdate', hook);
+
+    await Post.repository.update({
+      filter: {
+        userId: u1.id,
+      },
+      values: {
+        name: 'pp',
+      },
+      individualHooks: false,
+    });
+
+    const postsAfterUpdated = await Post.repository.find({ order: [['id', 'ASC']] });
+    expect(postsAfterUpdated[0].name).toBe('pp');
+    expect(postsAfterUpdated[1].name).toBe('pp');
+    expect(postsAfterUpdated[2].name).toBe('p3');
+
+    expect(hook).toBeCalledTimes(0);
+  });
+
+  it('update in batch with belongsTo field as foreignKey', async () => {
+    const u1 = await User.repository.create({ values: { name: 'u1' } });
+    const u2 = await User.repository.create({ values: { name: 'u2' } });
+    const p1 = await Post.repository.create({ values: { name: 'p1', userId: u1.id } });
+    const p2 = await Post.repository.create({ values: { name: 'p2', userId: u1.id } });
+
+    const r1 = await Post.repository.update({
+      filter: {
+        name: p1.name,
+      },
+      values: {
+        user: u2.id,
+      },
+      individualHooks: false,
+    });
+
+    expect(r1).toEqual(1);
+
+    const p1Updated = await Post.repository.findOne({
+      filterByTk: p1.id,
+    });
+    expect(p1Updated.userId).toBe(u2.id);
+
+    const r2 = await Post.repository.update({
+      filter: {
+        id: p2.id,
+      },
+      values: {
+        user: null,
+      },
+      individualHooks: false,
+    });
+
+    expect(r2).toEqual(1);
+
+    const p2Updated = await Post.repository.findOne({
+      filterByTk: p2.id,
+    });
+    expect(p2Updated.userId).toBe(null);
+
+    const r3 = await Post.repository.update({
+      filter: {
+        id: p1.id,
+      },
+      values: {
+        user: { id: u1.id },
+      },
+      individualHooks: false,
+    });
+
+    expect(r3).toEqual(1);
+
+    const p1Updated2 = await Post.repository.findOne({
+      filterByTk: p1.id,
+    });
+    expect(p1Updated2.userId).toBe(u1.id);
+  });
 });
 
 describe('repository.destroy', () => {

package/src/__tests__/update-guard.test.ts

@@ -370,6 +370,7 @@ describe('One2One Association', () => {
         uid: 1,
         name: '123',
       },
+      userId: 1,
     };
 
     const guard = new UpdateGuard();
@@ -381,6 +382,7 @@ describe('One2One Association', () => {
       user: {
         uid: 1,
       },
+      userId: 1,
     });
 
     guard.setAssociationKeysToBeUpdate(['user']);

package/src/repository.ts

@@ -609,6 +609,45 @@ export class Repository<TModelAttributes extends {} = any, TCreationAttributes e
 
     const queryOptions = this.buildQueryOptions(options);
 
+    // NOTE:
+    // 1. better to be moved to separated API like bulkUpdate/updateMany
+    // 2. strictly `false` comparing for compatibility of legacy api invoking
+    if (options.individualHooks === false) {
+      const { model: Model } = this.collection;
+      // @ts-ignore
+      const primaryKeyField = Model.primaryKeyField || Model.primaryKeyAttribute;
+      // NOTE:
+      // 1. find ids first for reusing `queryOptions` logic
+      // 2. estimation memory usage will be N * M bytes (N = rows, M = model object memory)
+      // 3. would be more efficient up to 100000 ~ 1000000 rows
+      const rows = await Model.findAll({
+        ...queryOptions,
+        attributes: [primaryKeyField],
+        group: `${Model.name}.${primaryKeyField}`,
+        include: queryOptions.include.filter((include) => {
+          return (
+            Object.keys(include.where || {}).length > 0 ||
+            JSON.stringify(queryOptions?.filter)?.includes(include.association)
+          );
+        }),
+        transaction,
+      });
+      const [result] = await Model.update(values, {
+        where: {
+          [primaryKeyField]: rows.map((row) => row.get(primaryKeyField)),
+        },
+        fields: options.fields,
+        hooks: options.hooks,
+        validate: options.validate,
+        sideEffects: options.sideEffects,
+        limit: options.limit,
+        silent: options.silent,
+        transaction,
+      });
+      // TODO: not support association fields except belongsTo
+      return result;
+    }
+
     const instances = await this.find({
       ...queryOptions,
       transaction,

package/src/update-guard.ts

@@ -93,6 +93,8 @@ export class UpdateGuard {
     Object.keys(associationsValues).forEach((association) => {
       let associationValues = associationsValues[association];
 
+      const associationObj = associations[association];
+
       const filterAssociationToBeUpdate = (value) => {
         if (value === null) {
           return value;
@@ -104,8 +106,6 @@ export class UpdateGuard {
           return value;
         }
 
-        const associationObj = associations[association];
-
         const associationKeyName =
           associationObj.associationType == 'BelongsTo' || associationObj.associationType == 'HasOne'
             ? (<any>associationObj).targetKey
@@ -143,6 +143,16 @@ export class UpdateGuard {
 
       // set association values to sanitized value
       values[association] = associationValues;
+
+      if (associationObj.associationType === 'BelongsTo') {
+        if (typeof associationValues === 'object' && associationValues !== null) {
+          if (associationValues[(associationObj as any).targetKey] != null) {
+            values[(associationObj as any).foreignKey] = associationValues[(associationObj as any).targetKey];
+          }
+        } else {
+          values[(associationObj as any).foreignKey] = associationValues;
+        }
+      }
     });
 
     if (values instanceof Model) {