@solidstarters/solid-core 1.2.123 → 1.2.125

package/src/solid-core.module.ts

@@ -83,14 +83,14 @@ import { SolidRegistry } from './helpers/solid-registry';
 import { LoggingInterceptor } from './interceptors/logging.interceptor';
 import { ApiEmailQueuePublisher } from './jobs/api-email-publisher.service';
 import { ApiEmailQueueSubscriber } from './jobs/api-email-subscriber.service';
+import { TestQueueDbPublisher } from './jobs/database/queue-test-db-publisher.service';
+import { TestQueueDbSubscriber } from './jobs/database/queue-test-db-subscriber.service';
 import { EmailQueuePublisher } from './jobs/email-publisher.service';
 import { EmailQueueSubscriber } from './jobs/email-subscriber.service';
 import { OTPQueuePublisher } from './jobs/otp-publisher.service';
 import { OTPQueueSubscriber } from './jobs/otp-subscriber.service';
 import { TestQueuePublisher } from './jobs/queue-test-publisher.service';
-import { TestQueueDbPublisher } from './jobs/database/queue-test-db-publisher.service';
 import { TestQueueSubscriber } from './jobs/queue-test-subscriber.service';
-import { TestQueueDbSubscriber } from './jobs/database/queue-test-db-subscriber.service';
 import { SmsQueuePublisher } from './jobs/sms-publisher.service';
 import { SmsQueueSubscriber } from './jobs/sms-subscriber.service';
 import { WhatsappQueuePublisher } from './jobs/whatsapp-publisher.service';
@@ -127,70 +127,75 @@ import { PermissionMetadataController } from './controllers/permission-metadata.
 import { PermissionMetadata } from './entities/permission-metadata.entity';
 import { PermissionMetadataService } from './services/permission-metadata.service';
 
+import { ClsModule } from 'nestjs-cls';
+import { ChatterMessageDetailsController } from './controllers/chatter-message-details.controller';
+import { ChatterMessageController } from './controllers/chatter-message.controller';
+import { ExportTemplateController } from './controllers/export-template.controller';
+import { ExportTransactionController } from './controllers/export-transaction.controller';
+import { ImportTransactionErrorLogController } from './controllers/import-transaction-error-log.controller';
+import { ImportTransactionController } from './controllers/import-transaction.controller';
+import { ListOfValuesController } from './controllers/list-of-values.controller';
+import { LocaleController } from './controllers/locale.controller';
 import { RoleMetadataController } from './controllers/role-metadata.controller';
+import { SavedFiltersController } from './controllers/saved-filters.controller';
+import { SecurityRuleController } from './controllers/security-rule.controller';
+import { SettingController } from './controllers/setting.controller';
+import { UserActivityHistoryController } from './controllers/user-activity-history.controller';
+import { UserViewMetadataController } from './controllers/user-view-metadata.controller';
 import { UserController } from './controllers/user.controller';
+import { ChatterMessageDetails } from './entities/chatter-message-details.entity';
+import { ChatterMessage } from './entities/chatter-message.entity';
+import { ExportTemplate } from './entities/export-template.entity';
+import { ExportTransaction } from './entities/export-transaction.entity';
+import { ImportTransactionErrorLog } from './entities/import-transaction-error-log.entity';
+import { ImportTransaction } from './entities/import-transaction.entity';
+import { Locale } from './entities/locale.entity';
 import { RoleMetadata } from './entities/role-metadata.entity';
-import { User } from './entities/user.entity';
-import { PermissionMetadataSeederService } from './seeders/permission-metadata-seeder.service';
-import { RoleMetadataService } from './services/role-metadata.service';
-import { UserService } from './services/user.service';
+import { SavedFilters } from './entities/saved-filters.entity';
+import { SecurityRule } from './entities/security-rule.entity';
 import { Setting } from './entities/setting.entity';
-import { SettingService } from './services/setting.service';
-import { SettingController } from './controllers/setting.controller';
+import { UserActivityHistory } from './entities/user-activity-history.entity';
+import { UserViewMetadata } from './entities/user-view-metadata.entity';
+import { User } from './entities/user.entity';
+import { ModelMetadataHelperService } from './helpers/model-metadata-helper.service';
 import { ModuleMetadataHelperService } from './helpers/module-metadata-helper.service';
-import { ConcatComputedFieldProvider } from './services/computed-fields/concat-computed-field-provider.service';
-import { FileS3StorageProvider } from './services/mediaStorageProviders/file-s3-storage-provider';
-import { FileStorageProvider } from './services/mediaStorageProviders/file-storage-provider';
+import { ComputedFieldEvaluationPublisher } from './jobs/database/computed-field-evaluation-publisher.service';
+import { ComputedFieldEvaluationSubscriber } from './jobs/database/computed-field-evaluation-subscriber.service';
+import { GenerateCodePublisher } from './jobs/database/generate-code-publisher.service';
+import { GenerateCodeSubscriber } from './jobs/database/generate-code-subscriber.service';
+import { FieldMetadataRepository } from './repository/field-metadata.repository';
+import { FieldRepository } from './repository/field.repository';
 import { MediaRepository } from './repository/media.repository';
-import { ViewMetadataSubsciber } from './subscribers/view-metadata.subscriber';
-import { SavedFilters } from './entities/saved-filters.entity';
-import { SavedFiltersService } from './services/saved-filters.service';
-import { SavedFiltersController } from './controllers/saved-filters.controller';
-import { UserViewMetadata } from './entities/user-view-metadata.entity';
-import { UserViewMetadataService } from './services/user-view-metadata.service';
-import { UserViewMetadataController } from './controllers/user-view-metadata.controller';
-import { SecurityRule } from './entities/security-rule.entity';
-import { SecurityRuleService } from './services/security-rule.service';
-import { SecurityRuleController } from './controllers/security-rule.controller';
-import { RequestContextService } from './services/request-context.service';
 import { SecurityRuleRepository } from './repository/security-rule.repository';
-import { SecurityRuleSubscriber } from './subscribers/security-rule.subscriber';
-import { ListOfValuesController } from './controllers/list-of-values.controller';
-import { ChatterMessage } from './entities/chatter-message.entity';
-import { ChatterMessageService } from './services/chatter-message.service';
-import { ChatterMessageController } from './controllers/chatter-message.controller';
-import { ChatterMessageDetails } from './entities/chatter-message-details.entity';
+import { PermissionMetadataSeederService } from './seeders/permission-metadata-seeder.service';
+import { SystemFieldsSeederService } from './seeders/system-fields-seeder.service';
 import { ChatterMessageDetailsService } from './services/chatter-message-details.service';
-import { ChatterMessageDetailsController } from './controllers/chatter-message-details.controller';
-import { Locale } from './entities/locale.entity';
-import { LocaleService } from './services/locale.service';
-import { LocaleController } from './controllers/locale.controller';
-import { AuditSubscriber } from './subscribers/audit.subscriber';
-import { ExportTemplate } from './entities/export-template.entity';
+import { ChatterMessageService } from './services/chatter-message.service';
+import { ConcatComputedFieldProvider } from './services/computed-fields/concat-computed-field-provider.service';
+import { ConcatEntityComputedFieldProvider } from './services/computed-fields/entity/concat-entity-computed-field-provider.service';
+import { CsvService } from './services/csv.service';
+import { ExcelService } from './services/excel.service';
 import { ExportTemplateService } from './services/export-template.service';
-import { ExportTemplateController } from './controllers/export-template.controller';
-import { ExportTransaction } from './entities/export-transaction.entity';
 import { ExportTransactionService } from './services/export-transaction.service';
-import { ExportTransactionController } from './controllers/export-transaction.controller';
-import { ExcelService } from './services/excel.service';
-import { CsvService } from './services/csv.service';
-import { ClsModule } from 'nestjs-cls';
-import { FieldRepository } from './repository/field.repository';
-import { ImportTransaction } from './entities/import-transaction.entity';
-import { ImportTransactionService } from './services/import-transaction.service';
-import { ImportTransactionController } from './controllers/import-transaction.controller';
-import { ImportTransactionErrorLog } from './entities/import-transaction-error-log.entity';
 import { ImportTransactionErrorLogService } from './services/import-transaction-error-log.service';
-import { ImportTransactionErrorLogController } from './controllers/import-transaction-error-log.controller';
+import { ImportTransactionService } from './services/import-transaction.service';
+import { LocaleService } from './services/locale.service';
+import { FileS3StorageProvider } from './services/mediaStorageProviders/file-s3-storage-provider';
+import { FileStorageProvider } from './services/mediaStorageProviders/file-storage-provider';
+import { RequestContextService } from './services/request-context.service';
+import { RoleMetadataService } from './services/role-metadata.service';
+import { SavedFiltersService } from './services/saved-filters.service';
+import { SecurityRuleService } from './services/security-rule.service';
 import { LocaleListSelectionProvider } from './services/selection-providers/locale-list-selection-provider.service';
-import { CreatedByUpdatedBySubscriber } from './subscribers/created-by-updated-by.subscriber';
-import { SystemFieldsSeederService } from './seeders/system-fields-seeder.service';
-import { ModelMetadataHelperService } from './helpers/model-metadata-helper.service';
-import { GenerateCodePublisher } from './jobs/database/generate-code-publisher.service';
-import { GenerateCodeSubscriber } from './jobs/database/generate-code-subscriber.service';
-import { UserActivityHistory } from './entities/user-activity-history.entity';
+import { SettingService } from './services/setting.service';
 import { UserActivityHistoryService } from './services/user-activity-history.service';
-import { UserActivityHistoryController } from './controllers/user-activity-history.controller';
+import { UserViewMetadataService } from './services/user-view-metadata.service';
+import { UserService } from './services/user.service';
+import { AuditSubscriber } from './subscribers/audit.subscriber';
+import { ComputedEntityFieldSubscriber } from './subscribers/computed-entity-field.subscriber';
+import { CreatedByUpdatedBySubscriber } from './subscribers/created-by-updated-by.subscriber';
+import { SecurityRuleSubscriber } from './subscribers/security-rule.subscriber';
+import { ViewMetadataSubsciber } from './subscribers/view-metadata.subscriber';
 
 
 @Global()
@@ -405,6 +410,11 @@ import { UserActivityHistoryController } from './controllers/user-activity-histo
     ImportTransactionErrorLogService,
     CreatedByUpdatedBySubscriber,
     SystemFieldsSeederService,
+    FieldMetadataRepository,
+    ComputedEntityFieldSubscriber,
+    ComputedFieldEvaluationPublisher,
+    ComputedFieldEvaluationSubscriber,
+    ConcatEntityComputedFieldProvider,
     UserActivityHistoryService,
     
   ],
@@ -437,7 +447,7 @@ import { UserActivityHistoryController } from './controllers/user-activity-histo
     RequestContextService,
     SecurityRuleRepository,
     FieldRepository,
-    UserActivityHistoryService
+    UserActivityHistoryService,
   ],
 })
 export class SolidCoreModule { }

package/src/subscribers/computed-entity-field.subscriber.ts

@@ -0,0 +1,108 @@
+import { camelize } from "@angular-devkit/core/src/utils/strings";
+import { Injectable } from "@nestjs/common";
+import { InjectDataSource } from "@nestjs/typeorm";
+import { ComputedFieldTriggerOperation } from "src/dtos/create-field-metadata.dto";
+import { ComputedFieldMetadata, SolidRegistry } from "src/helpers/solid-registry";
+import { IEntityPreComputeFieldProvider } from "src/interfaces";
+import { ComputedFieldEvaluationPublisher } from "src/jobs/database/computed-field-evaluation-publisher.service";
+import { DataSource, EntitySubscriberInterface, EventSubscriber, InsertEvent, UpdateEvent } from "typeorm";
+
+// Create an interface i.e ComputedFieldEvaluationPayload which has same fields as the ComputedFieldMetadata and an additional field for the database entity
+export interface ComputedFieldEvaluationPayload extends ComputedFieldMetadata {
+    databaseEntity: any;
+}
+
+@Injectable()
+@EventSubscriber()
+export class ComputedEntityFieldSubscriber implements EntitySubscriberInterface {
+    constructor(
+        @InjectDataSource()
+        private readonly dataSource: DataSource,
+        private readonly solidRegistry: SolidRegistry,
+        private readonly computedFieldPublisher: ComputedFieldEvaluationPublisher,
+    ) {
+        this.dataSource.subscribers.push(this);
+    }
+
+    async beforeInsert(event: InsertEvent<any>): Promise<any> {
+        await this.handleComputedFieldEvaluation(event.entity, ComputedFieldTriggerOperation.beforeInsert);
+    }
+
+    async beforeUpdate(event: UpdateEvent<any>): Promise<any>{
+        await this.handleComputedFieldEvaluation(event.databaseEntity, ComputedFieldTriggerOperation.beforeUpdate);
+    }
+
+    async afterInsert(event: InsertEvent<any>) {
+        await this.handleComputedFieldEvaluationJob(event.entity, ComputedFieldTriggerOperation.afterInsert);
+    }
+
+    async afterUpdate(event: UpdateEvent<any>) {
+        await this.handleComputedFieldEvaluationJob(event.databaseEntity, ComputedFieldTriggerOperation.afterUpdate);
+    }
+
+    async afterRemove(event: any) {
+        await this.handleComputedFieldEvaluationJob(event.databaseEntity, ComputedFieldTriggerOperation.afterRemove);
+    }
+
+    //FIXME: Need to add support for beforeRemmove, beforeSoftRemove, afterSoftRemove, beforeRecover, afterRecover
+
+    private async handleComputedFieldEvaluation(entity: any, currentOperation: ComputedFieldTriggerOperation): Promise<void> {
+        if (!entity) {
+            return;
+        }
+        const currentModelName = camelize(entity.constructor.name); // Resolve the model name from the entity class name
+        const computedFieldsTobeEvaluated = this.getComputedFieldsToBeEvaluated(
+            this.solidRegistry.getComputedFieldMetadata(),
+            currentOperation,
+            currentModelName
+        );
+        for (const computedFieldMetadata of computedFieldsTobeEvaluated) {
+            const computedValue = await this.getComputedValue(computedFieldMetadata, entity); //FIXME: There should some way to check/assert if the provider actually has a postComputeAndSaveValue
+            entity[computedFieldMetadata.fieldName] = computedValue; // Set the computed value on the entity
+        }
+    }
+
+    private async handleComputedFieldEvaluationJob(entity: any, currentOperation: ComputedFieldTriggerOperation): Promise<void> {
+        if (!entity) {
+            return;
+        }
+        const currentModelName = camelize(entity.constructor.name); //Resolve the model name from the entity class name
+        const computedFieldsTobeEvaluated = this.getComputedFieldsToBeEvaluated(
+            this.solidRegistry.getComputedFieldMetadata(),
+            currentOperation,
+            currentModelName
+        );
+        for (const computedField of computedFieldsTobeEvaluated) {
+            this.enqueueComputedFieldEvaluationJob(computedField, entity);
+        }
+    }
+
+    private async getComputedValue(computedFieldMetadata: ComputedFieldMetadata<any>, entity: any) {
+        const provider = this.solidRegistry.getComputedFieldProvider(computedFieldMetadata.computedFieldValueProviderName);
+        // Get the instance of the provider and assert it is of type IEntityComputedFieldProvider
+        const providerInstance = provider.instance as IEntityPreComputeFieldProvider<any, any, any>; // IEntityComputedFieldProvider
+        const computedValue = await providerInstance.preComputeValue(entity, computedFieldMetadata); //FIXME There should some way to check/assert if the provider actually has a postComputeAndSaveValue
+        return computedValue;
+    }
+
+    private enqueueComputedFieldEvaluationJob(computedField: ComputedFieldMetadata<any>, databaseEntity: any) {
+        const payload = {
+            ...computedField,
+            databaseEntity,
+        };
+        this.computedFieldPublisher.publish({
+            payload
+        });
+    }
+
+    // Based on the current model name and current operation, identify all the computed providers that need to be evaluated
+    // Pass the database entity and the context to the provider of type IEntityComputedFieldProvider
+    private getComputedFieldsToBeEvaluated(computedFieldMetadata: ComputedFieldMetadata[], currentOperation: ComputedFieldTriggerOperation, currentModelName: string) {
+        return computedFieldMetadata.filter(
+            (computedField) => computedField.computedFieldTriggerConfig.some(
+                (trigger) => trigger.operations.includes(currentOperation) &&
+                    trigger.modelName === currentModelName
+            )
+        );
+    }
+}