@friggframework/core 2.0.0-next.122 → 2.0.0-next.124

package/handlers/app-definition-loader.js

@@ -1,6 +1,9 @@
 const { findNearestBackendPackageJson } = require('@friggframework/core/utils');
 const path = require('node:path');
 const fs = require('fs-extra');
+const {
+    applyAppDefinitionDefaults,
+} = require('@friggframework/schemas/app-definition');
 const { resolveTelemetryConfig } = require('../telemetry/telemetry-config');
 const { registerDeniedKeys } = require('../logs/denied-keys');
 const {
@@ -33,7 +36,9 @@ function registerCredentialLogKeys(appDefinition, integrations) {
  * @function loadAppDefinition
  * @description Searches for the nearest backend package.json, loads the corresponding index.js file,
  * and extracts the application definition containing integrations and user configuration.
- * @returns {{integrations: Array<object>, userConfig: object | null, adminScripts: Array<object>, reports: Array<object>, admin: object, telemetry: object, logging: object | null}} An object containing the application definition.
+ * The defaults declared in the app-definition schema are applied first (ADR-051), so
+ * `userConfig` always holds a complete user config, also when the app omits `user`.
+ * @returns {{integrations: Array<object>, userConfig: object, adminScripts: Array<object>, reports: Array<object>, admin: object, telemetry: object, logging: object | null}} An object containing the application definition.
  * @throws {Error} Throws error if backend package.json cannot be found.
  * @throws {Error} Throws error if index.js file cannot be found in the backend directory.
  * @example
@@ -53,7 +58,9 @@ function loadAppDefinition() {
     }
 
     const backendJsFile = require(backendFilePath);
-    const appDefinition = backendJsFile.Definition;
+    // The one place schema defaults are applied at runtime (ADR-051): a
+    // default in app-definition.schema.json is the value core sees.
+    const appDefinition = applyAppDefinitionDefaults(backendJsFile.Definition);
 
     const {
         integrations = [],

package/integrations/integration-router.js

@@ -42,6 +42,9 @@ const {
 } = require('../modules/use-cases/get-entity-options-by-type');
 const { TestModuleAuth } = require('../modules/use-cases/test-module-auth');
 const { GetModule } = require('../modules/use-cases/get-module');
+const {
+    CreateEntityFromCredential,
+} = require('../modules/use-cases/create-entity-from-credential');
 const {
     GetEntityOptionsById,
 } = require('../modules/use-cases/get-entity-options-by-id');
@@ -198,6 +201,13 @@ function createIntegrationRouter() {
             getModulesDefinitionFromIntegrationClasses(integrationClasses),
     });
 
+    const createEntityFromCredential = new CreateEntityFromCredential({
+        processAuthorizationCallback,
+        credentialRepository,
+        moduleDefinitions:
+            getModulesDefinitionFromIntegrationClasses(integrationClasses),
+    });
+
     const router = express();
 
     setIntegrationRoutes(router, authenticateUser, {
@@ -218,6 +228,7 @@ function createIntegrationRouter() {
         getEntityOptionsById,
         refreshEntityOptions,
         processAuthorizationCallback,
+        createEntityFromCredential,
     });
     return router;
 }
@@ -502,6 +513,7 @@ function setEntityRoutes(router, authenticateUser, useCases) {
         getEntityOptionsById,
         refreshEntityOptions,
         processAuthorizationCallback,
+        createEntityFromCredential,
     } = useCases;
 
     router.route('/api/authorize').get(
@@ -566,35 +578,19 @@ function setEntityRoutes(router, authenticateUser, useCases) {
     router.route('/api/entity').post(
         catchAsyncError(async (req, res) => {
             const user = await authenticateUser.execute(req);
-            const userId = user.getId();
             const params = checkRequiredParams(req.body, [
                 'entityType',
                 'data',
             ]);
             checkRequiredParams(req.body.data, ['credential_id']);
 
-            // May want to pass along the user ID as well so credential ID's can't be fished???
-            const credential = await getCredentialForUser.execute(
-                params.data.credential_id,
-                userId
-            );
-
-            if (!credential) {
-                throw Boom.badRequest('Invalid credential ID');
-            }
-
-            const module = await getModuleInstanceFromType.execute(
-                userId,
-                params.entityType
+            res.json(
+                await createEntityFromCredential.execute({
+                    user,
+                    entityType: params.entityType,
+                    credentialId: params.data.credential_id,
+                })
             );
-            const entityDetails = await module.getEntityDetails(
-                module.api,
-                null,
-                null,
-                userId
-            );
-
-            res.json(await module.findOrCreateEntity(entityDetails));
         })
     );
 

package/modules/use-cases/create-entity-from-credential.js

@@ -0,0 +1,105 @@
+const Boom = require('@hapi/boom');
+const { Module } = require('../module');
+
+const sameId = (a, b) =>
+    a !== undefined &&
+    a !== null &&
+    b !== undefined &&
+    b !== null &&
+    String(a) === String(b);
+
+/**
+ * Creates (or finds) the entity for a credential the caller already holds:
+ * the v1 `POST /api/entity`.
+ *
+ * The module is built with the stored credential loaded, so the API can call
+ * the provider and a token refresh during `getEntityDetails` updates that
+ * credential. Persistence reuses `ProcessAuthorizationCallback.findOrCreateEntity`,
+ * the same find-or-create (and credential repointing) the authorization flow
+ * uses, so the two paths cannot drift.
+ */
+class CreateEntityFromCredential {
+    /**
+     * @param {Object} params
+     * @param {import('./process-authorization-callback').ProcessAuthorizationCallback} params.processAuthorizationCallback
+     * @param {Object} params.credentialRepository
+     * @param {Array<Object>} params.moduleDefinitions
+     * @param {Function} [params.createModule] - builds a Module; injectable for tests
+     */
+    constructor({
+        processAuthorizationCallback,
+        credentialRepository,
+        moduleDefinitions,
+        createModule,
+    }) {
+        this.processAuthorizationCallback = processAuthorizationCallback;
+        this.credentialRepository = credentialRepository;
+        this.moduleDefinitions = moduleDefinitions || [];
+        this.createModule = createModule || ((params) => new Module(params));
+    }
+
+    /**
+     * @param {Object} params
+     * @param {Object} params.user - authenticated User
+     * @param {string} params.entityType
+     * @param {string} params.credentialId
+     * @returns {Promise<Object>} the persisted entity
+     */
+    async execute({ user, entityType, credentialId }) {
+        const userId = user?.getId?.();
+        if (userId === undefined || userId === null) {
+            throw Boom.unauthorized('No authenticated user');
+        }
+
+        const definition = this.moduleDefinitions.find(
+            (def) => def && def.moduleName === entityType
+        );
+        if (!definition) {
+            throw Boom.badRequest(`Unknown entity type ${entityType}`, {
+                code: 'ENTITY_TYPE_NOT_FOUND',
+            });
+        }
+
+        const credential =
+            await this.credentialRepository.findCredentialById(credentialId);
+        // A missing credential and someone else's get the same answer, so
+        // credential ids cannot be probed.
+        if (!credential || !sameId(credential.userId, userId)) {
+            throw Boom.badRequest('Invalid credential ID', {
+                code: 'INVALID_CREDENTIAL',
+            });
+        }
+
+        // The repository returns the tokens flat; a Module reads them from
+        // `credential.data`.
+        const { id, userId: ownerId, externalId, authIsValid, ...data } =
+            credential;
+        const module = this.createModule({
+            userId,
+            definition,
+            entity: {
+                credential: { id, userId: ownerId, externalId, authIsValid, data },
+            },
+        });
+
+        const entityDetails =
+            await definition.requiredAuthMethods.getEntityDetails(
+                module.api,
+                null,
+                null,
+                userId
+            );
+        Object.assign(
+            entityDetails.details,
+            module.apiParamsFromEntity(module.api)
+        );
+
+        return this.processAuthorizationCallback.findOrCreateEntity(
+            entityDetails,
+            definition.moduleName,
+            credential.id
+        );
+    }
+}
+
+module.exports = { CreateEntityFromCredential };

package/modules/use-cases/get-entity-options-by-id.js

@@ -1,4 +1,7 @@
 const { Module } = require('../module');
+const {
+    findModuleDefinitionForEntity,
+} = require('../utils/find-module-definition');
 
 class GetEntityOptionsById {
     /**
@@ -45,11 +48,10 @@ class GetEntityOptionsById {
         }
 
         const entityType = entity.moduleName;
-        const moduleDefinition = this.moduleDefinitions.find((def) => {
-            const modelName =
-                Module.getEntityModelFromDefinition(def).modelName;
-            return entityType === modelName;
-        });
+        const moduleDefinition = findModuleDefinitionForEntity(
+            this.moduleDefinitions,
+            entity
+        );
 
         if (!moduleDefinition) {
             throw new Error(

package/modules/use-cases/get-module.js

@@ -1,4 +1,7 @@
 const { Module } = require('../module');
+const {
+    findModuleDefinitionForEntity,
+} = require('../utils/find-module-definition');
 
 class GetModule {
     constructor({ moduleRepository, moduleDefinitions }) {
@@ -42,10 +45,10 @@ class GetModule {
         }
 
         const entityType = entity.moduleName;
-        const moduleDefinition = this.moduleDefinitions.find((def) => {
-            const modelName = Module.getEntityModelFromDefinition(def).modelName;
-            return entityType === modelName;
-        });
+        const moduleDefinition = findModuleDefinitionForEntity(
+            this.moduleDefinitions,
+            entity
+        );
 
         if (!moduleDefinition) {
             throw new Error(
@@ -59,15 +62,33 @@ class GetModule {
             definition: moduleDefinition,
         });
 
-        // todo: this properties should be methods in the Module class
+        // The credential itself (tokens, API keys) never leaves the server:
+        // the response names it and says whether it still works, as the v2
+        // entity DTO does.
+        const credential = module.credential;
+        const credentialId =
+            credential && typeof credential === 'object'
+                ? credential.id
+                : credential;
+        const ownerId = module.entity.userId ?? module.entity.user;
         return {
             id: module.entity.id,
             name: module.entity.name,
             moduleName: module.entity.moduleName,
-            credential: module.credential,
+            credentialId:
+                credentialId === undefined || credentialId === null
+                    ? null
+                    : String(credentialId),
+            authIsValid:
+                typeof credential?.authIsValid === 'boolean'
+                    ? credential.authIsValid
+                    : null,
             externalId: module.entity.externalId,
-            userId: module.entity.user.toString(),
-        }
+            userId:
+                ownerId === undefined || ownerId === null
+                    ? null
+                    : String(ownerId),
+        };
     }
 }
 

package/modules/use-cases/refresh-entity-options.js

@@ -1,4 +1,7 @@
 const { Module } = require('../module');
+const {
+    findModuleDefinitionForEntity,
+} = require('../utils/find-module-definition');
 
 class RefreshEntityOptions {
     /**
@@ -46,11 +49,10 @@ class RefreshEntityOptions {
         }
 
         const entityType = entity.moduleName;
-        const moduleDefinition = this.moduleDefinitions.find((def) => {
-            const modelName =
-                Module.getEntityModelFromDefinition(def).modelName;
-            return entityType === modelName;
-        });
+        const moduleDefinition = findModuleDefinitionForEntity(
+            this.moduleDefinitions,
+            entity
+        );
 
         if (!moduleDefinition) {
             throw new Error(

package/modules/use-cases/test-module-auth.js

@@ -1,4 +1,7 @@
 const { Module } = require('../module');
+const {
+    findModuleDefinitionForEntity,
+} = require('../utils/find-module-definition');
 
 class TestModuleAuth {
     /**
@@ -45,11 +48,10 @@ class TestModuleAuth {
         }
 
         const entityType = entity.moduleName;
-        const moduleDefinition = this.moduleDefinitions.find((def) => {
-            const modelName =
-                Module.getEntityModelFromDefinition(def).modelName;
-            return entityType === modelName;
-        });
+        const moduleDefinition = findModuleDefinitionForEntity(
+            this.moduleDefinitions,
+            entity
+        );
 
         if (!moduleDefinition) {
             throw new Error(

package/modules/utils/find-module-definition.js

@@ -0,0 +1,23 @@
+/**
+ * The API module definition a stored entity belongs to.
+ *
+ * Entities are persisted with `moduleName` set to the definition's
+ * `moduleName` (see ProcessAuthorizationCallback.findOrCreateEntity). A
+ * definition's legacy `modelName` is accepted as well, for entities written
+ * before the two were the same.
+ *
+ * @param {Array<Object>} moduleDefinitions
+ * @param {Object} entity - entity record with a `moduleName`
+ * @returns {Object|undefined}
+ */
+function findModuleDefinitionForEntity(moduleDefinitions, entity) {
+    const entityType = entity?.moduleName;
+    if (!entityType) return undefined;
+    return (moduleDefinitions || []).find(
+        (def) =>
+            def &&
+            (def.moduleName === entityType || def.modelName === entityType)
+    );
+}
+
+module.exports = { findModuleDefinitionForEntity };

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@friggframework/core",
     "prettier": "@friggframework/prettier-config",
-    "version": "2.0.0-next.122",
+    "version": "2.0.0-next.124",
     "dependencies": {
         "@aws-sdk/client-apigatewaymanagementapi": "^3.588.0",
         "@aws-sdk/client-kms": "^3.588.0",
@@ -11,6 +11,7 @@
         "@aws-sdk/client-sqs": "^3.588.0",
         "@aws-sdk/client-ssm": "^3.588.0",
         "@aws-sdk/s3-request-presigner": "^3.588.0",
+        "@friggframework/schemas": "2.0.0-next.124",
         "@hapi/boom": "^10.0.1",
         "@opentelemetry/api": "^1.9.1",
         "@opentelemetry/context-async-hooks": "^2.9.0",
@@ -48,9 +49,9 @@
         }
     },
     "devDependencies": {
-        "@friggframework/eslint-config": "2.0.0-next.122",
-        "@friggframework/prettier-config": "2.0.0-next.122",
-        "@friggframework/test": "2.0.0-next.122",
+        "@friggframework/eslint-config": "2.0.0-next.124",
+        "@friggframework/prettier-config": "2.0.0-next.124",
+        "@friggframework/test": "2.0.0-next.124",
         "@prisma/client": "^6.19.3",
         "@types/lodash": "4.17.15",
         "@typescript-eslint/eslint-plugin": "^8.0.0",
@@ -91,5 +92,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "d9e2755c836c7cfb4f2de7a8e3d003c6d7167d03"
+    "gitHead": "679a3f0f550136151563c34f9a8c7680b88b6984"
 }