@nocobase/database 0.9.3-alpha.1 → 0.9.4-alpha.1

package/lib/update-guard.d.ts

@@ -12,6 +12,7 @@ export declare class UpdateGuard {
     private associationKeysToBeUpdate;
     private blackList;
     private whiteList;
+    static fromOptions(model: any, options: any): UpdateGuard;
     setAction(action: UpdateAction): void;
     setModel(model: ModelStatic<any>): void;
     setAssociationKeysToBeUpdate(associationKeysToBeUpdate: AssociationKeysToBeUpdate): void;
@@ -22,6 +23,5 @@ export declare class UpdateGuard {
      * @param values
      */
     sanitize(values: UpdateValues): {};
-    static fromOptions(model: any, options: any): UpdateGuard;
 }
 export {};

package/lib/update-guard.js

@@ -22,6 +22,18 @@ class UpdateGuard {
     this.blackList = void 0;
     this.whiteList = void 0;
   }
+  static fromOptions(model, options) {
+    const guard = new UpdateGuard();
+    guard.setModel(model);
+    guard.setWhiteList(options.whitelist);
+    guard.setBlackList(options.blacklist);
+    guard.setAction(_lodash().default.get(options, 'action', 'update'));
+    guard.setAssociationKeysToBeUpdate(options.updateAssociationValues);
+    if (options.underscored) {
+      guard.underscored = options.underscored;
+    }
+    return guard;
+  }
   setAction(action) {
     this.action = action;
   }
@@ -67,6 +79,9 @@ class UpdateGuard {
     Object.keys(associationsValues).forEach(association => {
       let associationValues = associationsValues[association];
       const filterAssociationToBeUpdate = value => {
+        if (value === null) {
+          return value;
+        }
         const associationKeysToBeUpdate = this.associationKeysToBeUpdate || [];
         if (associationKeysToBeUpdate.includes(association)) {
           return value;
@@ -88,7 +103,7 @@ class UpdateGuard {
       };
       if (Array.isArray(associationValues)) {
         associationValues = associationValues.map(value => {
-          if (typeof value == 'string' || typeof value == 'number') {
+          if (value === undefined || value === null || typeof value == 'string' || typeof value == 'number') {
             return value;
           } else {
             return sanitizeValue(value);
@@ -123,17 +138,5 @@ class UpdateGuard {
     }, {});
     return result;
   }
-  static fromOptions(model, options) {
-    const guard = new UpdateGuard();
-    guard.setModel(model);
-    guard.setWhiteList(options.whitelist);
-    guard.setBlackList(options.blacklist);
-    guard.setAction(_lodash().default.get(options, 'action', 'update'));
-    guard.setAssociationKeysToBeUpdate(options.updateAssociationValues);
-    if (options.underscored) {
-      guard.underscored = options.underscored;
-    }
-    return guard;
-  }
 }
 exports.UpdateGuard = UpdateGuard;

package/lib/utils.d.ts

@@ -1,14 +1,7 @@
 import Database from './database';
-import { Model } from './model';
-declare type HandleAppendsQueryOptions = {
-    templateModel: any;
-    queryPromises: Array<any>;
-};
-export declare function handleAppendsQuery(options: HandleAppendsQueryOptions): Promise<Model<any, any>[]>;
 export declare function md5(value: string): string;
 export declare function checkIdentifier(value: string): void;
 export declare function getTableName(collectionName: string, options: any): any;
 export declare function snakeCase(name: string): any;
 export declare function patchSequelizeQueryInterface(db: Database): void;
 export declare function percent2float(value: string): number;
-export {};

package/lib/utils.js

@@ -5,7 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.checkIdentifier = checkIdentifier;
 exports.getTableName = getTableName;
-exports.handleAppendsQuery = handleAppendsQuery;
 exports.md5 = md5;
 exports.patchSequelizeQueryInterface = patchSequelizeQueryInterface;
 exports.percent2float = percent2float;
@@ -26,81 +25,6 @@ function _lodash() {
   return data;
 }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-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; }
-function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
-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 _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 _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; }
-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 handleAppendsQuery(_x) {
-  return _handleAppendsQuery.apply(this, arguments);
-}
-function _handleAppendsQuery() {
-  _handleAppendsQuery = _asyncToGenerator(function* (options) {
-    const templateModel = options.templateModel,
-      queryPromises = options.queryPromises;
-    if (!templateModel) {
-      return [];
-    }
-    const primaryKey = templateModel.constructor.primaryKeyAttribute;
-    const results = yield Promise.all(queryPromises);
-    let rows;
-    var _iterator = _createForOfIteratorHelper(results),
-      _step;
-    try {
-      for (_iterator.s(); !(_step = _iterator.n()).done;) {
-        const appendedResult = _step.value;
-        if (!rows) {
-          rows = appendedResult.rows;
-          if (rows.length == 0) {
-            return [];
-          }
-          const modelOptions = templateModel['_options'];
-          var _iterator2 = _createForOfIteratorHelper(rows),
-            _step2;
-          try {
-            for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
-              const row = _step2.value;
-              row['_options'] = _objectSpread(_objectSpread({}, row['_options']), {}, {
-                include: modelOptions['include'],
-                includeNames: modelOptions['includeNames'],
-                includeMap: modelOptions['includeMap']
-              });
-            }
-          } catch (err) {
-            _iterator2.e(err);
-          } finally {
-            _iterator2.f();
-          }
-          continue;
-        }
-        for (let i = 0; i < appendedResult.rows.length; i++) {
-          const appendingRow = appendedResult.rows[i];
-          const key = appendedResult.include.association;
-          const val = appendingRow.get(key);
-          const rowKey = appendingRow.get(primaryKey);
-          const targetIndex = rows.findIndex(row => row.get(primaryKey) === rowKey);
-          if (targetIndex === -1) {
-            throw new Error('target row not found');
-          }
-          rows[targetIndex].set(key, val, {
-            raw: true
-          });
-        }
-      }
-    } catch (err) {
-      _iterator.e(err);
-    } finally {
-      _iterator.f();
-    }
-    return rows;
-  });
-  return _handleAppendsQuery.apply(this, arguments);
-}
 function md5(value) {
   return _crypto().default.createHash('md5').update(value).digest('hex');
 }

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@nocobase/database",
-  "version": "0.9.3-alpha.1",
+  "version": "0.9.4-alpha.1",
   "description": "",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "license": "Apache-2.0",
   "dependencies": {
-    "@nocobase/logger": "0.9.3-alpha.1",
-    "@nocobase/utils": "0.9.3-alpha.1",
+    "@nocobase/logger": "0.9.4-alpha.1",
+    "@nocobase/utils": "0.9.4-alpha.1",
     "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": "24979bc561537c0b84469c161eeef1a6de4c4684"
+  "gitHead": "0b4936be557be918dbdf8196dadcbc7eb395906d"
 }

package/src/__tests__/eager-loading/eager-loading-tree.test.ts

@@ -0,0 +1,393 @@
+import Database, { mockDatabase } from '@nocobase/database';
+import { EagerLoadingTree } from '../../eager-loading/eager-loading-tree';
+
+describe('Eager loading tree', () => {
+  let db: Database;
+  beforeEach(async () => {
+    db = mockDatabase({
+      tablePrefix: '',
+    });
+
+    await db.clean({ drop: true });
+  });
+
+  afterEach(async () => {
+    await db.close();
+  });
+
+  it('should handle fields filter', async () => {
+    const User = db.collection({
+      name: 'users',
+      fields: [
+        { type: 'string', name: 'name' },
+        { type: 'hasOne', name: 'profile' },
+      ],
+    });
+
+    const Profile = db.collection({
+      name: 'profiles',
+      fields: [
+        { type: 'integer', name: 'age' },
+        { type: 'string', name: 'address' },
+      ],
+    });
+
+    await db.sync();
+
+    const users = await User.repository.create({
+      values: [
+        {
+          name: 'u1',
+          profile: { age: 1, address: 'u1 address' },
+        },
+        {
+          name: 'u2',
+          profile: { age: 2, address: 'u2 address' },
+        },
+      ],
+    });
+
+    const findOptions = User.repository.buildQueryOptions({
+      fields: ['profile', 'profile.age', 'name'],
+    });
+
+    const eagerLoadingTree = EagerLoadingTree.buildFromSequelizeOptions({
+      model: User.model,
+      rootAttributes: findOptions.attributes,
+      includeOption: findOptions.include,
+    });
+
+    await eagerLoadingTree.load(users.map((item) => item.id));
+    const root = eagerLoadingTree.root;
+
+    const u1 = root.instances.find((item) => item.get('name') === 'u1');
+    const data = u1.toJSON();
+    expect(data['id']).not.toBeDefined();
+    expect(data['name']).toBeDefined();
+    expect(data['profile']).toBeDefined();
+    expect(data['profile']['age']).toBeDefined();
+  });
+
+  it('should load has many', async () => {
+    const User = db.collection({
+      name: 'users',
+      fields: [
+        { type: 'string', name: 'name' },
+        { type: 'hasMany', name: 'posts' },
+      ],
+    });
+
+    const Post = db.collection({
+      name: 'posts',
+      fields: [{ type: 'string', name: 'title' }],
+    });
+
+    await db.sync();
+
+    await User.repository.create({
+      values: [
+        {
+          name: 'u1',
+          posts: [{ title: 'u1p1' }, { title: 'u1p2' }],
+        },
+        {
+          name: 'u2',
+          posts: [{ title: 'u2p1' }, { title: 'u2p2' }],
+        },
+      ],
+    });
+
+    const findOptions = User.repository.buildQueryOptions({
+      appends: ['posts'],
+    });
+
+    const eagerLoadingTree = EagerLoadingTree.buildFromSequelizeOptions({
+      model: User.model,
+      rootAttributes: findOptions.attributes,
+      includeOption: findOptions.include,
+    });
+
+    await eagerLoadingTree.load([1, 2]);
+
+    const root = eagerLoadingTree.root;
+    const u1 = root.instances.find((item) => item.get('name') === 'u1');
+    const u1Posts = u1.get('posts') as any;
+    expect(u1Posts.length).toBe(2);
+
+    const u1JSON = u1.toJSON();
+    expect(u1JSON['posts'].length).toBe(2);
+  });
+
+  it('should load has one', async () => {
+    const User = db.collection({
+      name: 'users',
+      fields: [
+        { type: 'string', name: 'name' },
+        { type: 'hasOne', name: 'profile' },
+      ],
+    });
+
+    const Profile = db.collection({
+      name: 'profiles',
+      fields: [{ type: 'integer', name: 'age' }],
+    });
+
+    await db.sync();
+
+    const users = await User.repository.create({
+      values: [
+        {
+          name: 'u1',
+          profile: { age: 1 },
+        },
+        {
+          name: 'u2',
+          profile: { age: 2 },
+        },
+      ],
+    });
+
+    const findOptions = User.repository.buildQueryOptions({
+      appends: ['profile'],
+    });
+
+    const eagerLoadingTree = EagerLoadingTree.buildFromSequelizeOptions({
+      model: User.model,
+      rootAttributes: findOptions.attributes,
+      includeOption: findOptions.include,
+    });
+
+    await eagerLoadingTree.load(users.map((item) => item.id));
+
+    const root = eagerLoadingTree.root;
+    const u1 = root.instances.find((item) => item.get('name') === 'u1');
+    const u1Profile = u1.get('profile') as any;
+    expect(u1Profile).toBeDefined();
+    expect(u1Profile.get('age')).toBe(1);
+  });
+
+  it('should load belongs to', async () => {
+    const Post = db.collection({
+      name: 'posts',
+      fields: [
+        { type: 'string', name: 'title' },
+        {
+          type: 'belongsTo',
+          name: 'user',
+        },
+      ],
+    });
+
+    const User = db.collection({
+      name: 'users',
+      fields: [{ type: 'string', name: 'name' }],
+    });
+
+    await db.sync();
+
+    await Post.repository.create({
+      values: [
+        {
+          title: 'p1',
+          user: {
+            name: 'u1',
+          },
+        },
+        {
+          title: 'p2',
+          user: {
+            name: 'u2',
+          },
+        },
+      ],
+    });
+
+    const findOptions = Post.repository.buildQueryOptions({
+      appends: ['user'],
+    });
+
+    const eagerLoadingTree = EagerLoadingTree.buildFromSequelizeOptions({
+      model: Post.model,
+      rootAttributes: findOptions.attributes,
+      includeOption: findOptions.include,
+    });
+
+    await eagerLoadingTree.load([1, 2]);
+
+    const root = eagerLoadingTree.root;
+    const p1 = root.instances.find((item) => item.get('title') === 'p1');
+    const p1User = p1.get('user') as any;
+    expect(p1User).toBeDefined();
+    expect(p1User.get('name')).toBe('u1');
+  });
+
+  it('should load belongs to many', async () => {
+    const Post = db.collection({
+      name: 'posts',
+      fields: [
+        { type: 'string', name: 'title' },
+        { type: 'belongsToMany', name: 'tags' },
+      ],
+    });
+
+    const Tag = db.collection({
+      name: 'tags',
+      fields: [{ type: 'string', name: 'name' }],
+    });
+
+    await db.sync();
+
+    const tags = await Tag.repository.create({
+      values: [
+        {
+          name: 't1',
+        },
+        {
+          name: 't2',
+        },
+        {
+          name: 't3',
+        },
+      ],
+    });
+
+    await Post.repository.create({
+      values: [
+        {
+          title: 'p1',
+          tags: [{ id: tags[0].id }, { id: tags[1].id }],
+        },
+        {
+          title: 'p2',
+          tags: [{ id: tags[1].id }, { id: tags[2].id }],
+        },
+      ],
+    });
+
+    const findOptions = Post.repository.buildQueryOptions({
+      appends: ['tags'],
+    });
+
+    const eagerLoadingTree = EagerLoadingTree.buildFromSequelizeOptions({
+      model: Post.model,
+      rootAttributes: findOptions.attributes,
+      includeOption: findOptions.include,
+    });
+    await eagerLoadingTree.load([1, 2]);
+    const root = eagerLoadingTree.root;
+
+    const p1 = root.instances.find((item) => item.get('title') === 'p1');
+    const p1Tags = p1.get('tags') as any;
+    expect(p1Tags).toBeDefined();
+    expect(p1Tags.length).toBe(2);
+    expect(p1Tags.map((t) => t.get('name'))).toEqual(['t1', 't2']);
+
+    const p2 = root.instances.find((item) => item.get('title') === 'p2');
+    const p2Tags = p2.get('tags') as any;
+    expect(p2Tags).toBeDefined();
+    expect(p2Tags.length).toBe(2);
+    expect(p2Tags.map((t) => t.get('name'))).toEqual(['t2', 't3']);
+  });
+
+  it('should build eager loading tree', async () => {
+    const User = db.collection({
+      name: 'users',
+      fields: [
+        {
+          type: 'string',
+          name: 'name',
+        },
+        {
+          type: 'hasMany',
+          name: 'posts',
+        },
+      ],
+    });
+
+    const Post = db.collection({
+      name: 'posts',
+      fields: [
+        {
+          type: 'array',
+          name: 'tags',
+        },
+        {
+          type: 'string',
+          name: 'title',
+        },
+        {
+          type: 'belongsToMany',
+          name: 'tags',
+        },
+      ],
+    });
+
+    const Tag = db.collection({
+      name: 'tags',
+      fields: [
+        { type: 'string', name: 'name' },
+        { type: 'belongsTo', name: 'tagCategory' },
+      ],
+    });
+
+    const TagCategory = db.collection({
+      name: 'tagCategories',
+      fields: [{ type: 'string', name: 'name' }],
+    });
+
+    await db.sync();
+
+    await User.repository.create({
+      values: [
+        {
+          name: 'u1',
+          posts: [
+            {
+              title: 'u1p1',
+              tags: [
+                { name: 't1', tagCategory: { name: 'c1' } },
+                { name: 't2', tagCategory: { name: 'c2' } },
+              ],
+            },
+          ],
+        },
+        {
+          name: 'u2',
+          posts: [
+            {
+              title: 'u2p1',
+              tags: [
+                { name: 't3', tagCategory: { name: 'c3' } },
+                { name: 't4', tagCategory: { name: 'c4' } },
+              ],
+            },
+          ],
+        },
+      ],
+    });
+
+    const findOptions = User.repository.buildQueryOptions({
+      appends: ['posts.tags.tagCategory'],
+    });
+
+    const eagerLoadingTree = EagerLoadingTree.buildFromSequelizeOptions({
+      model: User.model,
+      rootAttributes: findOptions.attributes,
+      includeOption: findOptions.include,
+    });
+
+    expect(eagerLoadingTree.root.children).toHaveLength(1);
+    expect(eagerLoadingTree.root.children[0].model).toBe(Post.model);
+    expect(eagerLoadingTree.root.children[0].children[0].model).toBe(Tag.model);
+    expect(eagerLoadingTree.root.children[0].children[0].children[0].model).toBe(TagCategory.model);
+
+    await eagerLoadingTree.load((await User.model.findAll()).map((item) => item[User.model.primaryKeyAttribute]));
+
+    expect(eagerLoadingTree.root.instances).toHaveLength(2);
+    const u1 = eagerLoadingTree.root.instances.find((item) => item.get('name') === 'u1');
+    expect(u1.get('posts')).toHaveLength(1);
+    expect(u1.get('posts')[0].get('tags')).toHaveLength(2);
+    expect(u1.get('posts')[0].get('tags')[0].get('tagCategory')).toBeDefined();
+    expect(u1.get('posts')[0].get('tags')[0].get('tagCategory').get('name')).toBe('c1');
+  });
+});

package/src/__tests__/migrator.test.ts

@@ -18,6 +18,10 @@ describe('migrator', () => {
     await db.close();
   });
 
+  test('migrations', async () => {
+    expect(db.getModel('migrations').tableName).toBe('test_migrations');
+  });
+
   test('addMigrations', async () => {
     db.addMigrations({
       directory: resolve(__dirname, './fixtures/migrations'),

package/src/__tests__/relation-repository/hasone-repository.test.ts

@@ -93,6 +93,7 @@ describe('has one repository', () => {
     });
 
     const data = profile.toJSON();
+
     expect(data['a1']).toBeDefined();
     expect(data['a2']).toBeDefined();
   });