fix(grpc-sdk,commons,database,cms): modelOptions conflict between Con…

…duitSchema and SchemaDefinitions (ConduitSchema.modelOptions -> ConduitSchema.schemaOptions)
ConduitPlatform · Dec 2, 2021 · e7a9381 · e7a9381
1 parent 6413184
commit e7a9381
Show file tree

Hide file tree

Showing 10 changed files with 26 additions and 23 deletions.
diff --git a/libraries/grpc-sdk/src/classes/ConduitActiveSchema.ts b/libraries/grpc-sdk/src/classes/ConduitActiveSchema.ts
@@ -9,10 +9,10 @@ export class ConduitActiveSchema<T> extends ConduitSchema {
     dbInstance: DatabaseProvider,
     name: string,
     fields?: ConduitModel,
-    modelOptions?: ConduitModelOptions,
+    schemaOptions?: ConduitModelOptions,
     collectionName?: string
   ) {
-    super(name, fields ?? {}, modelOptions, collectionName);
+    super(name, fields ?? {}, schemaOptions, collectionName);
     this.dbInstance = dbInstance;
   }
 

diff --git a/libraries/grpc-sdk/src/classes/ConduitSchema.ts b/libraries/grpc-sdk/src/classes/ConduitSchema.ts
@@ -4,18 +4,18 @@ export class ConduitSchema {
   readonly name: string;
   readonly fields: ConduitModel;
   readonly collectionName: string;
-  modelOptions: ConduitModelOptions;
+  readonly schemaOptions: ConduitModelOptions;
   private ownerModule?: string;
 
   constructor(
     name: string,
     fields: ConduitModel,
-    modelOptions?: ConduitModelOptions,
+    schemaOptions?: ConduitModelOptions,
     collectionName?: string
   ) {
     this.name = name;
     this.fields = fields;
-    this.modelOptions = modelOptions ? modelOptions : {};
+    this.schemaOptions = schemaOptions ?? {};
     if (collectionName && collectionName !== '') {
       this.collectionName = collectionName;
     } else {

diff --git a/libraries/grpc-sdk/src/modules/databaseProvider/index.ts b/libraries/grpc-sdk/src/modules/databaseProvider/index.ts
@@ -65,7 +65,7 @@ export class DatabaseProvider extends ConduitModule<DatabaseProviderClient> {
           schema: {
             name: schema.name,
             modelSchema: JSON.stringify(schema.fields ?? schema.modelSchema),
-            modelOptions: JSON.stringify(schema.modelOptions),
+            modelOptions: JSON.stringify(schema.schemaOptions),
             collectionName: schema.collectionName,
           },
         },

diff --git a/modules/cms/src/admin/schema.admin.ts b/modules/cms/src/admin/schema.admin.ts
@@ -126,7 +126,7 @@ export class SchemaAdmin {
 
     if (newSchema.enabled) {
       this.schemaController.createSchema(
-        new ConduitSchema(newSchema.name, newSchema.fields, newSchema.modelOptions),
+        new ConduitSchema(newSchema.name, newSchema.fields, newSchema.schemaOptions),
       );
     }
 
@@ -170,7 +170,7 @@ export class SchemaAdmin {
         new ConduitSchema(
           updatedSchema.name,
           updatedSchema.fields,
-          updatedSchema.modelOptions,
+          updatedSchema.schemaOptions,
         ),
       );
     }
@@ -256,7 +256,7 @@ export class SchemaAdmin {
       new ConduitSchema(
         requestedSchema.name,
         requestedSchema.fields,
-        requestedSchema.modelOptions,
+        requestedSchema.schemaOptions,
       ),
     );
 

diff --git a/modules/cms/src/models/SchemaDefinitions.schema.ts b/modules/cms/src/models/SchemaDefinitions.schema.ts
@@ -17,8 +17,10 @@ const schema = {
     required: true,
     systemRequired: true,
   },
-  //todo The properties in JSON, replace adequetly
-  modelOptions: { type: TYPE.String, systemRequired: true },
+  modelOptions: { // TODO: The properties in JSON, replace adequetly
+    type: TYPE.String,
+    systemRequired: true
+  },
   enabled: {
     type: TYPE.Boolean,
     default: true,
@@ -46,6 +48,7 @@ export class SchemaDefinitions extends ConduitActiveSchema<SchemaDefinitions> {
   _id!: string;
   name!: string;
   fields!: any;
+  modelOptions!: string;
   enabled!: boolean;
   authentication!: boolean;
   crudOperations!: boolean;

diff --git a/modules/database/src/DatabaseProvider.ts b/modules/database/src/DatabaseProvider.ts
@@ -148,7 +148,7 @@ export class DatabaseProvider extends ConduitServiceModule {
         let originalSchema = {
           name: schemaAdapter.originalSchema.name,
           modelSchema: JSON.stringify(schemaAdapter.originalSchema.modelSchema),
-          modelOptions: JSON.stringify(schemaAdapter.originalSchema.modelOptions),
+          modelOptions: JSON.stringify(schemaAdapter.originalSchema.schemaOptions),
           collectionName: schemaAdapter.originalSchema.collectionName,
         };
         this.publishSchema({
@@ -182,7 +182,7 @@ export class DatabaseProvider extends ConduitServiceModule {
         schema: {
           name: schemaAdapter.name,
           modelSchema: JSON.stringify(schemaAdapter.modelSchema),
-          modelOptions: JSON.stringify(schemaAdapter.modelOptions),
+          modelOptions: JSON.stringify(schemaAdapter.schemaOptions),
           collectionName: schemaAdapter.collectionName,
         },
       });
@@ -202,7 +202,7 @@ export class DatabaseProvider extends ConduitServiceModule {
           return {
             name: schema.name,
             modelSchema: JSON.stringify(schema.modelSchema),
-            modelOptions: JSON.stringify(schema.modelOptions),
+            modelOptions: JSON.stringify(schema.schemaOptions),
             collectionName: schema.collectionName,
           };
         }),

diff --git a/modules/database/src/adapters/DatabaseAdapter.ts b/modules/database/src/adapters/DatabaseAdapter.ts
@@ -49,7 +49,7 @@ export abstract class DatabaseAdapter<T extends SchemaAdapter<any>> {
           {
             name: schema.name,
             fields: schema.fields,
-            modelOptions: JSON.stringify(schema.modelOptions),
+            modelOptions: JSON.stringify(schema.schemaOptions),
             ownerModule: schema.owner,
           }
         );
@@ -58,7 +58,7 @@ export abstract class DatabaseAdapter<T extends SchemaAdapter<any>> {
         .create({
           name: schema.name,
           fields: schema.fields,
-          modelOptions: JSON.stringify(schema.modelOptions),
+          modelOptions: JSON.stringify(schema.schemaOptions),
           ownerModule: schema.owner,
         });
     }

diff --git a/modules/database/src/adapters/mongoose-adapter/MongooseSchema.ts b/modules/database/src/adapters/mongoose-adapter/MongooseSchema.ts
@@ -17,7 +17,7 @@ export class MongooseSchema implements SchemaAdapter<Model<any>> {
     private readonly adapter: MongooseAdapter
   ) {
     this.originalSchema = originalSchema;
-    let mongooseSchema = new Schema(schema.modelSchema as any, schema.modelOptions);
+    let mongooseSchema = new Schema(schema.modelSchema as any, schema.schemaOptions);
     mongooseSchema.plugin(deepPopulate, {});
     this.model = mongoose.model(schema.name, mongooseSchema);
   }

diff --git a/modules/database/src/adapters/mongoose-adapter/index.ts b/modules/database/src/adapters/mongoose-adapter/index.ts
@@ -139,7 +139,7 @@ export class MongooseAdapter extends DatabaseAdapter<MongooseSchema> {
    async deleteSchema(schemaName: string, deleteData: boolean): Promise<string> {
     if (!this.models?.[schemaName])
       throw ConduitError.notFound('Requested schema not found');
-    if (this.models![schemaName].originalSchema.modelOptions.systemRequired) {
+    if (this.models![schemaName].originalSchema.schemaOptions.systemRequired) {
       throw ConduitError.forbidden("Can't delete system required schema");
     }
     if(deleteData){

diff --git a/packages/commons/src/models/ConduitSchema.ts b/packages/commons/src/models/ConduitSchema.ts
@@ -4,18 +4,18 @@ export class ConduitSchema {
   private readonly _name: string;
   private readonly _fields: ConduitModel;
   private readonly _collectionName: string;
-  private readonly _modelOptions: ConduitModelOptions;
+  private readonly _schemaOptions: ConduitModelOptions;
   private _ownerModule?: string;
 
   constructor(
     name: string,
     fields: ConduitModel,
-    modelOptions?: ConduitModelOptions,
+    schemaOptions?: ConduitModelOptions,
     collectionName?: string
   ) {
     this._name = name;
     this._fields = fields;
-    this._modelOptions = modelOptions ? modelOptions : {};
+    this._schemaOptions = schemaOptions ?? {};
     // todo should pluralize like mongoose
     if (collectionName && collectionName !== '') {
       this._collectionName = collectionName;
@@ -48,7 +48,7 @@ export class ConduitSchema {
     return this._collectionName;
   }
 
-  get modelOptions(): ConduitModelOptions {
-    return this._modelOptions;
+  get schemaOptions(): ConduitModelOptions {
+    return this._schemaOptions;
   }
 }