@friggframework/core 0.2.31-v1-alpha-package-update.0 → 1.0.1-v1-alpha-package-update.0

package/logs/logger.test.js

@@ -0,0 +1,76 @@
+const { debug, initDebugLog, flushDebugLog } = require('./logger');
+const sinon = require('sinon');
+const {
+    overrideEnvironment,
+    restoreEnvironment,
+} = require('../test-environment');
+
+/* eslint-disable no-console */
+
+describe('Logger', () => {
+    beforeEach(() => {
+        sinon.stub(console, 'debug');
+        sinon.stub(console, 'error');
+    });
+
+    afterEach(() => {
+        console.debug.restore();
+        console.error.restore();
+        restoreEnvironment();
+    });
+
+    it('runs', () => {
+        initDebugLog('Test Event', { test: true });
+        debug('Add a message', 'or two', { or: 3 });
+        flushDebugLog(new Error());
+
+        expect(console.debug).toHaveProperty('callCount', 2);
+        expect(console.error).toHaveProperty('callCount', 1);
+    });
+
+    it('logs immediately when environment variable set', () => {
+        overrideEnvironment({ DEBUG_VERBOSE: '1' });
+
+        debug('Add a message', 'or two', { or: 3 });
+        debug('And another');
+
+        expect(console.debug).toHaveProperty('callCount', 2);
+        expect(console.error).toHaveProperty('callCount', 0);
+    });
+
+    it('is resilient to missing parameters', () => {
+        initDebugLog();
+        debug();
+        flushDebugLog();
+
+        expect(console.debug).toHaveProperty('callCount', 0);
+        expect(console.error).toHaveProperty('callCount', 1);
+    });
+
+    it('outputs parent errors', () => {
+        initDebugLog();
+
+        const error = new Error();
+        error.cause = new Error();
+        error.cause.cause = new Error();
+        error.cause.cause.cause = new Error();
+
+        flushDebugLog(error);
+
+        expect(console.debug).toHaveProperty('callCount', 0);
+        expect(console.error).toHaveProperty('callCount', 7); // 1 + 2 for each cause
+    });
+
+    it('adds a debug message if more than 1 error encountered', () => {
+        initDebugLog();
+        flushDebugLog(new Error());
+
+        expect(console.debug).toHaveProperty('callCount', 0);
+        expect(console.error).toHaveProperty('callCount', 1);
+
+        flushDebugLog(new Error());
+
+        expect(console.debug).toHaveProperty('callCount', 1);
+        expect(console.error).toHaveProperty('callCount', 2);
+    });
+});

package/migrations/README.md

@@ -0,0 +1,3 @@
+# migrations
+
+This package exports the `migrations` class and functions used in [Frigg](https://friggframework.org). You can find its documentation [on Frigg's website](https://docs.friggframework.org/packages/migrations).

package/migrations/index.js

@@ -0,0 +1,9 @@
+const MigrationManager = require('./manager');
+const Migrator = require('./migrator');
+const MigrationOptions = require('./options');
+
+module.exports = {
+    MigrationManager,
+    Migrator,
+    MigrationOptions
+}

package/migrations/jest.config.js

@@ -0,0 +1,3 @@
+module.exports = async () => {
+  preset: "@friggframework/test-environment";
+};

package/migrations/manager.js

@@ -0,0 +1,33 @@
+const hubspotMigrator = require("./HubSpotMigrator");
+const salesforceMigrator = require("./SalesforceMigrator");
+
+class MigrationManager {
+  static migratorClasses = [hubspotMigrator, salesforceMigrator];
+
+  static integrationTypes = MigrationManager.migratorClasses.map(
+    (MigratorClass) => MigratorClass.getName()
+  );
+
+  constructor() {
+    // ...
+  }
+
+  static async getMigrator(params) {
+    const { integrationType, fromVersion, toVersion } = params;
+    const indexOfMigrator =
+      MigrationManager.integrationTypes.indexOf(integrationType);
+    if (indexOfMigrator < 0) {
+      throw new Error(
+        `Error: Invalid integration type of ${
+          params.integrationType
+        }, options are ${MigrationManager.integrationTypes.join(", ")}`
+      );
+    }
+    const instance = await MigrationManager.migratorClasses[
+      indexOfMigrator
+    ].getInstance();
+    return instance;
+  }
+}
+
+module.exports = MigrationManager;

package/migrations/migrator.js

@@ -0,0 +1,170 @@
+const { Delegate } = require('../core');
+const { Integration } = require('../integrations');
+const { get } = require('../assertions');
+
+class Migrator extends Delegate {
+  constructor(params) {
+    super(params);
+    this.options = [];
+  }
+
+  static getInstance() {
+    const instance = new this();
+    return instance;
+  }
+
+  static getName() {
+    return this.integrationManager.getName();
+  }
+
+  async migrate(params) {
+    try {
+      const fromVersion = get(params, "fromVersion", null);
+      const toVersion = get(params, "toVersion");
+
+      console.log("Migrate called. First validating whether it can be done.");
+      if (
+        !this.integrationManager.Config.supportedVersions.some(
+          (version) => version === toVersion
+        )
+      ) {
+        return this.throwException(
+          `Attempting to migrate to an unsupported version. Current supported versions are ${this.integrationManager.Config.supportedVersions.join(
+            ", "
+          )}`,
+          "Migration Error"
+        );
+      }
+      const migrationOption = this.options
+        .map((val) => val.get())
+        .find(
+          (option) =>
+            option.fromVersion === fromVersion && option.toVersion === toVersion
+        );
+      if (!migrationOption)
+        return this.throwException(
+          `No migration option found for version ${fromVersion} to ${toVersion}`,
+          "Migration Error"
+        );
+      // Run all general functions
+      for (const generalFunct of migrationOption.generalFunctions) {
+        console.log("Running general functions first");
+        const res = await generalFunct();
+        console.log(res);
+      }
+      // Get all integration records based on fromVersion
+      const filter = {
+        "config.type": this.integrationManager.getName(),
+      };
+      console.log(
+        `Retrieved all ${this.integrationManager.getName()} integrations`
+      );
+
+      const integrations = await Integration.find(filter);
+      const filteredIntegrations = integrations.filter((int) => {
+        const isNotToVersion = int.version !== toVersion;
+        let isFromVersion = true;
+        if (fromVersion && fromVersion !== "*") {
+          isFromVersion = int.version === fromVersion;
+        }
+        return isNotToVersion && isFromVersion;
+      });
+      const results = {
+        integrationType: this.integrationManager.getName(),
+        totalIntegrations: integrations.length,
+        versionReport: {
+          startVersions: {},
+          endVersions: {},
+        },
+        statusReport: {
+          startStatuses: {},
+          endStatuses: {},
+        },
+        toMigrate: filteredIntegrations.length,
+        migrationResults: {
+          success: 0,
+          needsConfig: 0,
+          error: 0,
+        },
+      };
+
+      for (const integration of integrations) {
+        if (results.versionReport.startVersions[integration.version]) {
+          results.versionReport.startVersions[integration.version] += 1;
+        } else {
+          results.versionReport.startVersions[integration.version] = 1;
+        }
+        if (results.statusReport.startStatuses[integration.status]) {
+          results.statusReport.startStatuses[integration.status] += 1;
+        } else {
+          results.statusReport.startStatuses[integration.status] = 1;
+        }
+      }
+
+      // Instantiate the integrationManager based on integration ID, run all specific functions for each integration
+      for (const integration of filteredIntegrations) {
+        let integrationManagerInstance;
+        try {
+          integrationManagerInstance =
+            await this.integrationManager.getInstanceFromIntegrationId({
+              integrationId: integration.id,
+              userId: integration.user.id,
+            });
+        } catch (e) {
+          console.log(e);
+        }
+        // Test Auth
+        if (integrationManagerInstance) {
+          await integrationManagerInstance.testAuth();
+
+          // Run functions
+          if (integrationManagerInstance.integration.status !== "ERROR") {
+            for (const func of migrationOption.perIntegrationFunctions) {
+              const res = await func(integrationManagerInstance);
+              console.log(res);
+            }
+          }
+
+          // Validate Config
+          if (integrationManagerInstance.integration.status !== "ERROR") {
+            await integrationManagerInstance.validateConfig();
+          }
+
+          // Add to results tally
+          const currentStatus = integrationManagerInstance.integration.status;
+          if (currentStatus === "ENABLED") {
+            integrationManagerInstance.integration.version = toVersion;
+            await integrationManagerInstance.integration.save();
+            results.migrationResults.success += 1;
+          }
+          if (currentStatus === "NEEDS_CONFIG") {
+            integrationManagerInstance.integration.version = toVersion;
+            await integrationManagerInstance.integration.save();
+            results.migrationResults.needsConfig += 1;
+          }
+          if (currentStatus === "ERROR") results.migrationResults.error += 1;
+        }
+      }
+
+      const freshRetrieve = await Integration.find(filter);
+      for (const int of freshRetrieve) {
+        if (results.versionReport.endVersions[int.version]) {
+          results.versionReport.endVersions[int.version] += 1;
+        } else {
+          results.versionReport.endVersions[int.version] = 1;
+        }
+        if (results.statusReport.endStatuses[int.status]) {
+          results.statusReport.endStatuses[int.status] += 1;
+        } else {
+          results.statusReport.endStatuses[int.status] = 1;
+        }
+      }
+
+      return results;
+    } catch (e) {
+      this.throwException(e.message, "Migrate Error");
+    }
+  }
+}
+
+module.exports = Migrator;

package/migrations/options.js

@@ -0,0 +1,28 @@
+const IntegrationManager = require('../integrations');
+const { get, getAndVerifyType } = require('../assertions');
+
+class Options {
+  constructor(params) {
+    this.integrationManager = getAndVerifyType(
+      params,
+      "integrationManager",
+      IntegrationManager
+    );
+    this.fromVersion = get(params, "fromVersion");
+    this.toVersion = get(params, "toVersion");
+    this.generalFunctions = get(params, "generalFunctions", []);
+    this.perIntegrationFunctions = get(params, "perIntegrationFunctions", []);
+  }
+
+  get() {
+    return {
+      type: this.integrationManager.getName(),
+      fromVersion: this.fromVersion,
+      toVersion: this.toVersion,
+      generalFunctions: this.generalFunctions,
+      perIntegrationFunctions: this.perIntegrationFunctions,
+    };
+  }
+}
+
+module.exports = Options;

package/module-plugin/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+    "extends": "@friggframework/eslint-config"
+}

package/module-plugin/CHANGELOG.md

@@ -0,0 +1,224 @@
+# v1.1.0 (Wed Sep 06 2023)
+
+#### 🚀 Enhancement
+
+- Slack lookup by externalId, remove the user requirement from Mongoose DB models [#218](https://github.com/friggframework/frigg/pull/218) ([@seanspeaks](https://github.com/seanspeaks))
+
+#### 🐛 Bug Fix
+
+- Looking good ([@seanspeaks](https://github.com/seanspeaks))
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 1
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.0.27 (Thu Jun 08 2023)
+
+#### 🐛 Bug Fix
+
+- Fr/gdrive lef 280 [#175](https://github.com/friggframework/frigg/pull/175) (michael.webber@lefthook.com [@seanspeaks](https://github.com/seanspeaks))
+- Google Drive update ([@seanspeaks](https://github.com/seanspeaks))
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- Michael Webber (michael.webber@lefthook.com)
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.0.26 (Thu May 25 2023)
+
+#### 🐛 Bug Fix
+
+- Support calling localhost for ironclad api [#160](https://github.com/friggframework/frigg/pull/160) ([@debbie-yu](https://github.com/debbie-yu))
+- remove agent at method call level ([@debbie-yu](https://github.com/debbie-yu))
+- address feedback to put agent in requester class ([@debbie-yu](https://github.com/debbie-yu))
+- support calling localhost for ironclad api ([@debbie-yu](https://github.com/debbie-yu))
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- [@debbie-yu](https://github.com/debbie-yu)
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.0.25 (Tue Apr 04 2023)
+
+:tada: This release contains work from a new contributor! :tada:
+
+Thank you, null[@debbie-yu](https://github.com/debbie-yu), for all your work!
+
+#### 🐛 Bug Fix
+
+- Adding new IntegrationMapping collection [#142](https://github.com/friggframework/frigg/pull/142) ([@debbie-yu](https://github.com/debbie-yu))
+- Merge branch 'main' of https://github.com/friggframework/frigg into debbie.yu/integration-mapping ([@debbie-yu](https://github.com/debbie-yu))
+- addressing PR feedback and adding unit tests around IntegrationMapping ([@debbie-yu](https://github.com/debbie-yu))
+- adding new IntegrationMapping collection to better handle keeping track of mappings for integrations ([@debbie-yu](https://github.com/debbie-yu))
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- [@debbie-yu](https://github.com/debbie-yu)
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.0.24 (Tue Feb 21 2023)
+
+#### 🐛 Bug Fix
+
+- Updates to HubSpot Module [#132](https://github.com/friggframework/frigg/pull/132) ([@seanspeaks](https://github.com/seanspeaks))
+- Merge branch 'main' into hubspot-updates ([@seanspeaks](https://github.com/seanspeaks))
+- WIP Updates... cleanup, simplify, and fix ([@seanspeaks](https://github.com/seanspeaks))
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 1
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.0.23 (Wed Feb 08 2023)
+
+#### 🐛 Bug Fix
+
+- Fixed a Slack bug via requester improvement [#125](https://github.com/friggframework/frigg/pull/125) ([@seanspeaks](https://github.com/seanspeaks))
+- Fixed a Slack bug via requester improvement ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 1
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.0.22 (Tue Jan 31 2023)
+
+#### 🐛 Bug Fix
+
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 1
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.0.21 (Wed Jan 18 2023)
+
+#### 🐛 Bug Fix
+
+- Ironclad and slack updates [#96](https://github.com/friggframework/frigg/pull/96) ([@seanspeaks](https://github.com/seanspeaks))
+- Refresh Auth attempt only once, instead of potential for infinite loop [#95](https://github.com/friggframework/frigg/pull/95) ([@seanspeaks](https://github.com/seanspeaks))
+- Refresh Auth attempt only once, instead of potential for infinite loop ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 1
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.0.20 (Wed Jan 11 2023)
+
+#### 🐛 Bug Fix
+
+- Ironclad updates and sub type [#91](https://github.com/friggframework/frigg/pull/91) ([@JonathanEdMoore](https://github.com/JonathanEdMoore) [@seanspeaks](https://github.com/seanspeaks))
+- subType support for ironclad ([@seanspeaks](https://github.com/seanspeaks))
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- Jonathan Moore ([@JonathanEdMoore](https://github.com/JonathanEdMoore))
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.0.19 (Tue Jan 10 2023)
+
+:tada: This release contains work from a new contributor! :tada:
+
+Thank you, Jonathan O'Donnell ([@joncodo](https://github.com/joncodo)), for all your work!
+
+#### 🐛 Bug Fix
+
+- Merge branch 'main' of github.com:friggframework/frigg into doc-updates ([@joncodo](https://github.com/joncodo))
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- Jonathan O'Donnell ([@joncodo](https://github.com/joncodo))
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.0.18 (Mon Jan 09 2023)
+
+#### 🐛 Bug Fix
+
+- Merge remote-tracking branch 'origin/main' into gitbook-updates [#48](https://github.com/friggframework/frigg/pull/48) ([@seanspeaks](https://github.com/seanspeaks))
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+- Updates to managers [#24](https://github.com/friggframework/frigg/pull/24) ([@seanspeaks](https://github.com/seanspeaks))
+- Update integrationManager createIntegration function to accept EntityManager param (WIP) (Could be improved) ([@seanspeaks](https://github.com/seanspeaks))
+- module-plugin manager file uses MO instead of just Entity ([@seanspeaks](https://github.com/seanspeaks))
+- A lot of changes all rolled into one [#21](https://github.com/friggframework/frigg/pull/21) ([@seanspeaks](https://github.com/seanspeaks))
+- Bumped versions with patches ([@seanspeaks](https://github.com/seanspeaks))
+- Mongoose models tweak for sls offline as per https://nesin.io/blog/fix-mongoose-cannot-overwrite-model-once-compiled-error ([@seanspeaks](https://github.com/seanspeaks))
+- Continued updating of references and refactoring API modules ([@seanspeaks](https://github.com/seanspeaks))
+- Merge remote-tracking branch 'origin/main' into simplify-mongoose-models ([@seanspeaks](https://github.com/seanspeaks))
+- Change references to the module instead of local file reference ([@seanspeaks](https://github.com/seanspeaks))
+- Added core as a dependency of module-plugin ([@seanspeaks](https://github.com/seanspeaks))
+- Add READMEs for all packages and api-modules [#20](https://github.com/friggframework/frigg/pull/20) ([@seanspeaks](https://github.com/seanspeaks))
+- Add READMEs for all packages and api-modules ([@seanspeaks](https://github.com/seanspeaks))
+- Begin tweaks for mongo/mongoose models ([@seanspeaks](https://github.com/seanspeaks))
+
+#### ⚠️ Pushed to `main`
+
+- Merge branch 'main' into gitbook-updates ([@seanspeaks](https://github.com/seanspeaks))
+- Refactored for more conventional naming (at least for packages) ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 1
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.0.17 (Fri Dec 23 2022)
+
+#### 🐛 Bug Fix
+
+- this may break folks' implementations, but that's what unit tests are… [#81](https://github.com/friggframework/frigg/pull/81) ([@seanspeaks](https://github.com/seanspeaks))
+- this may break folks' implementations, but that's what unit tests are for. ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 1
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.0.15 (Tue Dec 06 2022)
+
+#### 🐛 Bug Fix
+
+- fix modules to @friggframework [#74](https://github.com/friggframework/frigg/pull/74) ([@sheehantoufiq](https://github.com/sheehantoufiq))
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+- Sheehan Toufiq Khan ([@sheehantoufiq](https://github.com/sheehantoufiq))
+
+---
+
+# v1.0.12 (Mon Sep 19 2022)
+
+#### 🐛 Bug Fix
+
+- Merge remote-tracking branch 'origin/main' into gitbook-updates [#48](https://github.com/friggframework/frigg/pull/48) ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 1
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))

package/module-plugin/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2022 Left Hook Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/module-plugin/ModuleConstants.js

@@ -0,0 +1,10 @@
+const ModuleConstants = {
+    authType: {
+        oauth2: 'oauth2',
+        oauth1: 'oauth1',
+        basic: 'basic',
+        apiKey: 'apiKey',
+    },
+};
+
+module.exports = { ModuleConstants };

package/module-plugin/README.md

@@ -0,0 +1,3 @@
+# module-plugin
+
+This package exports the `module-plugin` library of models, classes, and functions used in [Frigg](https://friggframework.org). You can find its documentation [on Frigg's website](https://docs.friggframework.org/packages/module-plugin).