@friggframework/core 2.0.0--canary.397.17c930a.0 → 2.0.0--canary.397.fadaaf6.0

package/integrations/integration-base.js

@@ -1,7 +1,8 @@
 const { IntegrationMapping } = require('./integration-mapping');
 const { Options } = require('./options');
-const { EnableIntegration } = require('./use-cases/enable-integration');
+const { UpdateIntegrationStatus } = require('./use-cases/update-integration-status');
 const { IntegrationRepository } = require('./integration-repository');
+const { UpdateIntegrationMessages } = require('./use-cases/update-integration-messages');
 
 const constantsToBeMigrated = {
     defaultEvents: {
@@ -23,6 +24,11 @@ const constantsToBeMigrated = {
 
 class IntegrationBase {
 
+    // todo: maybe we can pass this as Dependency Injection in the sub-class constructor
+    integrationRepository = new IntegrationRepository();
+    updateIntegrationStatus = new UpdateIntegrationStatus({ integrationRepository: this.integrationRepository });
+    updateIntegrationMessages = new UpdateIntegrationMessages({ integrationRepository: this.integrationRepository });
+
     static getOptionDetails() {
         const options = new Options({
             module: Object.values(this.Definition.modules)[0], // This is a placeholder until we revamp the frontend
@@ -79,12 +85,6 @@ class IntegrationBase {
 
     constructor(params) {
 
-        // todo: maybe we can pass this as Dependency Injection in the sub-class constructor
-        const { integrationRepository } = new IntegrationRepository();
-        this.enableIntegration = new EnableIntegration({
-            integrationRepository,
-        });
-
         this.defaultEvents = {
             [constantsToBeMigrated.defaultEvents.ON_CREATE]: {
                 type: constantsToBeMigrated.types.LIFE_CYCLE_EVENT,
@@ -133,7 +133,7 @@ class IntegrationBase {
 
     async validateConfig() {
         const configOptions = await this.getConfigOptions();
-        const currentConfig = this.record.config;
+        const currentConfig = this.getConfig();
         let needsConfig = false;
         for (const option of configOptions) {
             if (option.required) {
@@ -145,17 +145,18 @@ class IntegrationBase {
                     )
                 ) {
                     needsConfig = true;
-                    this.record.messages.warnings.push({
-                        title: 'Config Validation Error',
-                        message: `Missing required field of ${option.label}`,
-                        timestamp: Date.now(),
-                    });
+                    await this.updateIntegrationMessages.execute(
+                        this.id,
+                        'warnings',
+                        'Config Validation Error',
+                        `Missing required field of ${option.label}`,
+                        Date.now()
+                    );
                 }
             }
         }
         if (needsConfig) {
-            this.record.status = 'NEEDS_CONFIG';
-            await this.record.save();
+            await this.updateIntegrationStatus.execute(this.id, 'NEEDS_CONFIG');
         }
     }
 
@@ -167,34 +168,36 @@ class IntegrationBase {
                 await this[module].testAuth();
             } catch {
                 didAuthPass = false;
-                this.record.messages.errors.push({
-                    title: 'Authentication Error',
-                    message: `There was an error with your ${this[
+                await this.updateIntegrationMessages.execute(
+                    this.id,
+                    'errors',
+                    'Authentication Error',
+                    `There was an error with your ${this[
                         module
                     ].constructor.getName()} Entity.
                 Please reconnect/re-authenticate, or reach out to Support for assistance.`,
-                    timestamp: Date.now(),
-                });
+                    Date.now()
+                );
             }
         }
 
         if (!didAuthPass) {
-            this.record.status = 'ERROR';
-            this.record.markModified('messages.error');
-            await this.record.save();
+            await this.updateIntegrationStatus.execute(this.id, 'ERROR');
         }
     }
 
     async getMapping(sourceId) {
-        return IntegrationMapping.findBy(this.record.id, sourceId);
+        // todo: this should be a use case
+        return IntegrationMapping.findBy(this.id, sourceId);
     }
 
     async upsertMapping(sourceId, mapping) {
         if (!sourceId) {
             throw new Error(`sourceId must be set`);
         }
+        // todo: this should be a use case
         return await IntegrationMapping.upsert(
-            this.record.id,
+            this.id,
             sourceId,
             mapping
         );
@@ -204,7 +207,7 @@ class IntegrationBase {
      * CHILDREN CAN OVERRIDE THESE CONFIGURATION METHODS
      */
     async onCreate({ integrationId }) {
-        await this.enableIntegration.execute(integrationId);
+        await this.updateIntegrationStatus.execute(integrationId, 'ENABLED');
     }
 
     async onUpdate(params) { }

package/integrations/integration-repository.js

@@ -31,17 +31,17 @@ class IntegrationRepository {
         }
     }
 
-    async updateIntegration(integrationId, status) {
+    async updateIntegrationStatus(integrationId, status) {
         const integrationRecord = await IntegrationModel.updateOne({ _id: integrationId }, { status });
-        return {
-            id: integrationRecord._id,
-            entitiesIds: integrationRecord.entities.map(e => e._id),
-            userId: integrationRecord.user.toString(),
-            config: integrationRecord.config,
-            version: integrationRecord.version,
-            status: integrationRecord.status,
-            messages: integrationRecord.messages,
-        };
+        return integrationRecord.acknowledged;
+    }
+
+    async updateIntegrationMessages(integrationId, messageType, messageTitle, messageBody, messageTimestamp) {
+        const integrationRecord = await IntegrationModel.updateOne(
+            { _id: integrationId },
+            { $push: { [`messages.${messageType}`]: { title: messageTitle, message: messageBody, timestamp: messageTimestamp } } }
+        );
+        return integrationRecord.acknowledged;
     }
 
     async createIntegration(entities, userId, config) {

package/integrations/integration.js

@@ -148,6 +148,10 @@ class Integration {
     // Core methods that should always be on Integration entity
     // These override any behavior methods with the same name
 
+    getConfig() {
+        return this.config;
+    }
+
     // Module access helpers
     getModule(key) {
         return this.modules[key];

package/integrations/use-cases/create-integration.js

@@ -48,7 +48,7 @@ class CreateIntegration {
         });
 
         await integrationInstance.initialize();
-        await integrationInstance.send('ON_CREATE', {});
+        await integrationInstance.send('ON_CREATE', { integrationId: integrationRecord.id });
 
         return mapIntegrationClassToIntegrationDTO(integrationInstance);
     }

package/integrations/use-cases/update-integration-messages.js

@@ -0,0 +1,20 @@
+class UpdateIntegrationMessages {
+    constructor({ integrationRepository }) {
+        this.integrationRepository = integrationRepository;
+    }
+
+    /**
+     * @param {string} integrationId
+     * @param {string} messageType - 'errors', 'warnings', 'info' or 'logs'
+     * @param {string} messageTitle,
+     * @param {string} messageBody,
+     * @param {string} messageTimestamp,
+     * @returns {Promise<Object>}
+     */
+    async execute(integrationId, messageType, messageTitle, messageBody, messageTimestamp) {
+        const integration = await this.integrationRepository.updateIntegrationMessages(integrationId, messageType, messageTitle, messageBody, messageTimestamp);
+        return integration;
+    }
+}
+
+module.exports = { UpdateIntegrationMessages };

package/integrations/use-cases/{enable-integration.js → update-integration-status.js}

@@ -1,12 +1,12 @@
-class EnableIntegration {
+class UpdateIntegrationStatus {
     constructor({ integrationRepository }) {
         this.integrationRepository = integrationRepository;
     }
 
-    async execute(integrationId) {
-        const integration = await this.integrationRepository.updateIntegration(integrationId, 'ENABLED');
+    async execute(integrationId, status) {
+        const integration = await this.integrationRepository.updateIntegrationStatus(integrationId, status);
         return integration;
     }
 }
 
-module.exports = { EnableIntegration };
+module.exports = { UpdateIntegrationStatus };

package/modules/module-repository.js

@@ -40,24 +40,35 @@ class ModuleRepository {
     }
 
     async findEntitiesByUserId(userId) {
-        return Entity.find(
+        const entitiesRecords = await Entity.find(
             { user: userId },
             '-dateCreated -dateUpdated -user -credentials -credential -__t -__v',
             { lean: true }
-        );
+        ).populate('credential');
+
+        return entitiesRecords.map(e => ({
+            id: e._id.toString(),
+            accountId: e.accountId,
+            credential: e.credential,
+            userId: e.user.toString(),
+            name: e.name,
+            externalId: e.externalId,
+            type: e.__t,
+            moduleName: e.moduleName,
+        }));
     }
 
-    async findEntitiesByIds(entityIds) {
-        const entities = await Entity.find(
-            { _id: { $in: entityIds } },
+    async findEntitiesByIds(entitiesIds) {
+        const entitiesRecords = await Entity.find(
+            { _id: { $in: entitiesIds } },
             '',
             { lean: true }
-        );
+        ).populate('credential');
 
-        return entities.map(e => ({
+        return entitiesRecords.map(e => ({
             id: e._id.toString(),
             accountId: e.accountId,
-            credentialId: e.credential.toString(),
+            credential: e.credential,
             userId: e.user.toString(),
             name: e.name,
             externalId: e.externalId,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@friggframework/core",
   "prettier": "@friggframework/prettier-config",
-  "version": "2.0.0--canary.397.17c930a.0",
+  "version": "2.0.0--canary.397.fadaaf6.0",
   "dependencies": {
     "@hapi/boom": "^10.0.1",
     "aws-sdk": "^2.1200.0",
@@ -22,9 +22,9 @@
     "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@friggframework/eslint-config": "2.0.0--canary.397.17c930a.0",
-    "@friggframework/prettier-config": "2.0.0--canary.397.17c930a.0",
-    "@friggframework/test": "2.0.0--canary.397.17c930a.0",
+    "@friggframework/eslint-config": "2.0.0--canary.397.fadaaf6.0",
+    "@friggframework/prettier-config": "2.0.0--canary.397.fadaaf6.0",
+    "@friggframework/test": "2.0.0--canary.397.fadaaf6.0",
     "@types/lodash": "4.17.15",
     "@typescript-eslint/eslint-plugin": "^8.0.0",
     "chai": "^4.3.6",
@@ -53,5 +53,5 @@
   },
   "homepage": "https://github.com/friggframework/frigg#readme",
   "description": "",
-  "gitHead": "17c930a2dfe417f16b61c1facd6c04b17a6b7d83"
+  "gitHead": "fadaaf6990abc87d718814725fbd94173b9ca2bc"
 }