feat: Refactor SchemaControler to make it stateless

Author: pzawadzki-pronos

spec/DatabaseController.spec.js

@@ -69,16 +69,16 @@ describe('DatabaseController', function () {
       'getExpectedType',
     ]);
 
-    it('should not decorate query if no pointer CLPs are present', done => {
+    it('should not decorate query if no pointer CLPs are present', async done => {
       const clp = buildCLP();
       const query = { a: 'b' };
 
       schemaController.testPermissionsForClassName
         .withArgs(CLASS_NAME, ACL_GROUP, OPERATION)
         .and.returnValue(true);
-      schemaController.getClassLevelPermissions.withArgs(CLASS_NAME).and.returnValue(clp);
+      await schemaController.getClassLevelPermissions.withArgs(CLASS_NAME).and.returnValue(clp);
 
-      const output = databaseController.addPointerPermissions(
+      const output = await databaseController.addPointerPermissions(
         schemaController,
         CLASS_NAME,
         OPERATION,
@@ -91,7 +91,7 @@ describe('DatabaseController', function () {
       done();
     });
 
-    it('should decorate query if a pointer CLP entry is present', done => {
+    it('should decorate query if a pointer CLP entry is present', async done => {
       const clp = buildCLP(['user']);
       const query = { a: 'b' };
 
@@ -103,7 +103,7 @@ describe('DatabaseController', function () {
         .withArgs(CLASS_NAME, 'user')
         .and.returnValue({ type: 'Pointer' });
 
-      const output = databaseController.addPointerPermissions(
+      const output = await databaseController.addPointerPermissions(
         schemaController,
         CLASS_NAME,
         OPERATION,
@@ -116,7 +116,7 @@ describe('DatabaseController', function () {
       done();
     });
 
-    it('should decorate query if an array CLP entry is present', done => {
+    it('should decorate query if an array CLP entry is present', async done => {
       const clp = buildCLP(['users']);
       const query = { a: 'b' };
 
@@ -128,7 +128,7 @@ describe('DatabaseController', function () {
         .withArgs(CLASS_NAME, 'users')
         .and.returnValue({ type: 'Array' });
 
-      const output = databaseController.addPointerPermissions(
+      const output = await databaseController.addPointerPermissions(
         schemaController,
         CLASS_NAME,
         OPERATION,
@@ -144,7 +144,7 @@ describe('DatabaseController', function () {
       done();
     });
 
-    it('should decorate query if an object CLP entry is present', done => {
+    it('should decorate query if an object CLP entry is present', async done => {
       const clp = buildCLP(['user']);
       const query = { a: 'b' };
 
@@ -156,7 +156,7 @@ describe('DatabaseController', function () {
         .withArgs(CLASS_NAME, 'user')
         .and.returnValue({ type: 'Object' });
 
-      const output = databaseController.addPointerPermissions(
+      const output = await databaseController.addPointerPermissions(
         schemaController,
         CLASS_NAME,
         OPERATION,
@@ -172,7 +172,7 @@ describe('DatabaseController', function () {
       done();
     });
 
-    it('should decorate query if a pointer CLP is present and the same field is part of the query', done => {
+    it('should decorate query if a pointer CLP is present and the same field is part of the query', async done => {
       const clp = buildCLP(['user']);
       const query = { a: 'b', user: 'a' };
 
@@ -184,7 +184,7 @@ describe('DatabaseController', function () {
         .withArgs(CLASS_NAME, 'user')
         .and.returnValue({ type: 'Pointer' });
 
-      const output = databaseController.addPointerPermissions(
+      const output = await databaseController.addPointerPermissions(
         schemaController,
         CLASS_NAME,
         OPERATION,
@@ -199,7 +199,7 @@ describe('DatabaseController', function () {
       done();
     });
 
-    it('should transform the query to an $or query if multiple array/pointer CLPs are present', done => {
+    it('should transform the query to an $or query if multiple array/pointer CLPs are present', async done => {
       const clp = buildCLP(['user', 'users', 'userObject']);
       const query = { a: 'b' };
 
@@ -217,7 +217,7 @@ describe('DatabaseController', function () {
         .withArgs(CLASS_NAME, 'userObject')
         .and.returnValue({ type: 'Object' });
 
-      const output = databaseController.addPointerPermissions(
+      const output = await databaseController.addPointerPermissions(
         schemaController,
         CLASS_NAME,
         OPERATION,
@@ -236,7 +236,7 @@ describe('DatabaseController', function () {
       done();
     });
 
-    it('should not return a $or operation if the query involves one of the two fields also used as array/pointer permissions', done => {
+    it('should not return a $or operation if the query involves one of the two fields also used as array/pointer permissions', async done => {
       const clp = buildCLP(['users', 'user']);
       const query = { a: 'b', user: createUserPointer(USER_ID) };
       schemaController.testPermissionsForClassName
@@ -249,7 +249,7 @@ describe('DatabaseController', function () {
       schemaController.getExpectedType
         .withArgs(CLASS_NAME, 'users')
         .and.returnValue({ type: 'Array' });
-      const output = databaseController.addPointerPermissions(
+      const output = await databaseController.addPointerPermissions(
         schemaController,
         CLASS_NAME,
         OPERATION,
@@ -260,7 +260,7 @@ describe('DatabaseController', function () {
       done();
     });
 
-    it('should not return a $or operation if the query involves one of the fields also used as array/pointer permissions', done => {
+    it('should not return a $or operation if the query involves one of the fields also used as array/pointer permissions', async done => {
       const clp = buildCLP(['user', 'users', 'userObject']);
       const query = { a: 'b', user: createUserPointer(USER_ID) };
       schemaController.testPermissionsForClassName
@@ -276,7 +276,7 @@ describe('DatabaseController', function () {
       schemaController.getExpectedType
         .withArgs(CLASS_NAME, 'userObject')
         .and.returnValue({ type: 'Object' });
-      const output = databaseController.addPointerPermissions(
+      const output = await databaseController.addPointerPermissions(
         schemaController,
         CLASS_NAME,
         OPERATION,
@@ -287,7 +287,7 @@ describe('DatabaseController', function () {
       done();
     });
 
-    it('should throw an error if for some unexpected reason the property specified in the CLP is neither a pointer nor an array', done => {
+    it('should throw an error if for some unexpected reason the property specified in the CLP is neither a pointer nor an array', async done => {
       const clp = buildCLP(['user']);
       const query = { a: 'b' };
 
@@ -299,15 +299,15 @@ describe('DatabaseController', function () {
         .withArgs(CLASS_NAME, 'user')
         .and.returnValue({ type: 'Number' });
 
-      expect(() => {
+      await expectAsync(
         databaseController.addPointerPermissions(
           schemaController,
           CLASS_NAME,
           OPERATION,
           query,
           ACL_GROUP
-        );
-      }).toThrow(
+        )
+      ).toBeRejectedWith(
         Error(
           `An unexpected condition occurred when resolving pointer permissions: ${CLASS_NAME} user`
         )

spec/Schema.spec.js

@@ -875,6 +875,14 @@ describe('SchemaController', () => {
             addField: { '*': true },
             protectedFields: { '*': [] },
           },
+          indexes: {
+            _id_: {
+              _id: 1,
+            },
+            name_1: {
+              name: 1,
+            },
+          },
         };
         expect(dd(actualSchema, expectedSchema)).toEqual(undefined);
         done();
@@ -1097,14 +1105,15 @@ describe('SchemaController', () => {
         })
         .then(() => schema.deleteField('relationField', 'NewClass', config.database))
         .then(() => schema.reloadData())
-        .then(() => {
+        .then(async () => {
           const expectedSchema = {
             objectId: { type: 'String' },
             updatedAt: { type: 'Date' },
             createdAt: { type: 'Date' },
             ACL: { type: 'ACL' },
           };
-          expect(dd(schema.schemaData.NewClass.fields, expectedSchema)).toEqual(undefined);
+          const schemaData = await schema.getSchemaData();
+          expect(dd(schemaData.NewClass.fields, expectedSchema)).toEqual(undefined);
         })
         .then(done)
         .catch(done.fail);
@@ -1331,14 +1340,16 @@ describe('SchemaController', () => {
         schema = s;
         return schema.getOneSchema('_User', false);
       })
-      .then(userSchema => {
+      .then(async userSchema => {
         validateSchemaStructure(userSchema);
-        validateSchemaDataStructure(schema.schemaData);
+        const schemaData = await schema.getSchemaData();
+        validateSchemaDataStructure(schemaData);
         return schema.getOneSchema('_PushStatus', true);
       })
-      .then(pushStatusSchema => {
+      .then(async pushStatusSchema => {
+        const schemaData = await schema.getSchemaData();
         validateSchemaStructure(pushStatusSchema);
-        validateSchemaDataStructure(schema.schemaData);
+        validateSchemaDataStructure(schemaData);
       })
       .then(done)
       .catch(done.fail);
@@ -1353,7 +1364,7 @@ describe('SchemaController', () => {
   it('ensureFields should throw when schema is not set', async () => {
     const schema = await config.database.loadSchema();
     try {
-      schema.ensureFields([
+      await schema.ensureFields([
         {
           className: 'NewClass',
           fieldName: 'fieldName',

spec/SchemaPerformance.spec.js

@@ -202,6 +202,6 @@ describe('Schema Performance', function () {
       {},
       config.database
     );
-    expect(getAllSpy.calls.count()).toBe(2);
+    expect(getAllSpy.calls.count()).toBe(4);
   });
 });

spec/schemas.spec.js

@@ -1556,7 +1556,7 @@ describe('schemas', () => {
 
   it('ensure refresh cache after deleting a class', async done => {
     config = Config.get('test');
-    spyOn(config.schemaCache, 'del').and.callFake(() => {});
+    spyOn(config.schemaCache, 'clear').and.callFake(() => {});
     spyOn(SchemaController.prototype, 'reloadData').and.callFake(() => Promise.resolve());
     await request({
       url: 'http://localhost:8378/1/schemas',

src/Adapters/Cache/SchemaCache.js

@@ -0,0 +1,42 @@
+import type { Schema } from '../../Controllers/types';
+import { SchemaData } from '../../Controllers/SchemaController';
+
+export default class InMemorySchemaCache {
+  dataProvider: () => Promise<{ allClasses: Array<Schema>, schemaData: SchemaData }>;
+  fetchingSchemaPromise: any;
+  cache = {};
+
+  setDataProvider(
+    dataProvider: () => Promise<{ allClasses: Array<Schema>, schemaData: SchemaData }>
+  ) {
+    this.dataProvider = dataProvider;
+  }
+
+  async fetchSchema(): Promise<{ allClasses: Array<Schema>, schemaData: SchemaData }> {
+    if (this.cache.isCached) {
+      return {
+        allClasses: this.cache.allClasses,
+        schemaData: this.cache.schemaData,
+      };
+    }
+    if (!this.fetchingSchemaPromise) {
+      this.fetchingSchemaPromise = this.dataProvider();
+    }
+    const result = await this.fetchingSchemaPromise;
+    this.cache.isCached = true;
+    this.cache.allClasses = result ? result.allClasses : undefined;
+    this.cache.schemaData = result ? result.schemaData : undefined;
+
+    return {
+      allClasses: this.cache.allClasses,
+      schemaData: this.cache.schemaData,
+    };
+  }
+
+  clear(): Promise<void> {
+    this.cache.isCached = false;
+    this.cache.allClasses = undefined;
+    this.cache.schemaData = undefined;
+    this.fetchingSchemaPromise = undefined;
+  }
+}