@friggframework/core 2.0.0--canary.681.2df9ef0.0 → 2.0.0--canary.683.f45da33.0

package/integrations/integration-router.js

@@ -31,9 +31,6 @@ const {
     GetIntegrationInstance,
 } = require('./use-cases/get-integration-instance');
 const { UpdateIntegration } = require('./use-cases/update-integration');
-const {
-    getModulesDefinitionFromIntegrationClasses,
-} = require('./utils/map-integration-dto');
 const {
     GetModuleInstanceFromType,
 } = require('../modules/use-cases/get-module-instance-from-type');
@@ -64,12 +61,29 @@ const {
 const {
     ProcessAuthorizationCallback,
 } = require('../modules/use-cases/process-authorization-callback');
+const { createScopePolicy } = require('../modules/scope-policy');
+const {
+    AuthorizeEntityForUser,
+} = require('../modules/use-cases/authorize-entity-for-user');
+const {
+    ResolveIntegrationOwnership,
+} = require('./use-cases/resolve-integration-ownership');
+const { GetOwnedIntegrationRecord } = require('./use-cases/integration-operations-for-user');
 
 const log = getLogger('frigg.integrations');
 
 function createIntegrationRouter() {
-    const { integrations: integrationClasses, userConfig } =
-        loadAppDefinition();
+    // moduleDefinitions is the app registry's definitions (ADR-059), so
+    // /api/authorize and friends accept a type no integration binds.
+    const {
+        integrations: integrationClasses,
+        userConfig,
+        moduleDefinitions,
+        ownership,
+        entityTypeRegistry,
+    } = loadAppDefinition();
+    // Ownership by scope (ADR-056 §3): one object every use case asks.
+    const scopePolicy = createScopePolicy({ ownership, entityTypeRegistry });
     const moduleRepository = createModuleRepository();
     const integrationRepository = createIntegrationRepository();
     const credentialRepository = createCredentialRepository();
@@ -92,8 +106,7 @@ function createIntegrationRouter() {
 
     const moduleFactory = new ModuleFactory({
         moduleRepository,
-        moduleDefinitions:
-            getModulesDefinitionFromIntegrationClasses(integrationClasses),
+        moduleDefinitions,
     });
     const deleteIntegrationForUser = new DeleteIntegrationForUser({
         integrationRepository,
@@ -106,6 +119,19 @@ function createIntegrationRouter() {
         integrationClasses,
         moduleFactory,
         moduleRepository,
+        scopePolicy,
+    });
+
+    // Decides who owns a new integration and which entities the caller may bind
+    // (the v1 create used to check neither), and who may reach an existing one.
+    const resolveIntegrationOwnership = new ResolveIntegrationOwnership({
+        moduleRepository,
+        integrationClasses,
+        scopePolicy,
+    });
+    const getOwnedIntegrationRecord = new GetOwnedIntegrationRecord({
+        integrationRepository,
+        scopePolicy,
     });
 
     const getCredentialForUser = new GetCredentialForUser({
@@ -120,8 +146,8 @@ function createIntegrationRouter() {
 
     const getEntitiesForUser = new GetEntitiesForUser({
         moduleRepository,
-        moduleDefinitions:
-            getModulesDefinitionFromIntegrationClasses(integrationClasses),
+        moduleDefinitions,
+        scopePolicy,
     });
 
     const getIntegrationInstance = new GetIntegrationInstance({
@@ -137,54 +163,57 @@ function createIntegrationRouter() {
     });
 
     const getModuleInstanceFromType = new GetModuleInstanceFromType({
-        moduleDefinitions:
-            getModulesDefinitionFromIntegrationClasses(integrationClasses),
+        moduleDefinitions,
     });
 
     const getEntityOptionsByType = new GetEntityOptionsByType({
-        moduleDefinitions:
-            getModulesDefinitionFromIntegrationClasses(integrationClasses),
+        moduleDefinitions,
     });
 
     const testModuleAuth = new TestModuleAuth({
         moduleRepository,
-        moduleDefinitions:
-            getModulesDefinitionFromIntegrationClasses(integrationClasses),
+        moduleDefinitions,
+        scopePolicy,
     });
 
     const getModule = new GetModule({
         moduleRepository,
-        moduleDefinitions:
-            getModulesDefinitionFromIntegrationClasses(integrationClasses),
+        moduleDefinitions,
+        scopePolicy,
     });
 
     const getEntityOptionsById = new GetEntityOptionsById({
         moduleRepository,
-        moduleDefinitions:
-            getModulesDefinitionFromIntegrationClasses(integrationClasses),
+        moduleDefinitions,
+        scopePolicy,
     });
 
     const refreshEntityOptions = new RefreshEntityOptions({
         moduleRepository,
-        moduleDefinitions:
-            getModulesDefinitionFromIntegrationClasses(integrationClasses),
+        moduleDefinitions,
+        scopePolicy,
     });
 
     const getPossibleIntegrations = new GetPossibleIntegrations({
         integrationClasses,
     });
 
-    const processAuthorizationCallback = new ProcessAuthorizationCallback({
-        moduleRepository,
-        credentialRepository,
-        integrationRepository,
-        moduleDefinitions:
-            getModulesDefinitionFromIntegrationClasses(integrationClasses),
+    // The owner of what an authorization creates follows its scope (ADR-056 §3.2).
+    const authorizeEntityForUser = new AuthorizeEntityForUser({
+        scopePolicy,
+        processAuthorizationCallback: new ProcessAuthorizationCallback({
+            moduleRepository,
+            credentialRepository,
+            integrationRepository,
+            moduleDefinitions,
+        }),
     });
 
     const router = express();
 
     setIntegrationRoutes(router, authenticateUser, {
+        resolveIntegrationOwnership,
+        getOwnedIntegrationRecord,
         createIntegration,
         deleteIntegrationForUser,
         getIntegrationsForUser,
@@ -201,7 +230,7 @@ function createIntegrationRouter() {
         getModule,
         getEntityOptionsById,
         refreshEntityOptions,
-        processAuthorizationCallback,
+        authorizeEntityForUser,
     });
     return router;
 }
@@ -238,6 +267,8 @@ function checkRequiredParams(params, requiredKeys) {
  */
 function setIntegrationRoutes(router, authenticateUser, useCases) {
     const {
+        resolveIntegrationOwnership,
+        getOwnedIntegrationRecord,
         createIntegration,
         deleteIntegrationForUser,
         getIntegrationsForUser,
@@ -246,15 +277,22 @@ function setIntegrationRoutes(router, authenticateUser, useCases) {
         updateIntegration,
         getPossibleIntegrations,
     } = useCases;
+
+    // The owner of an integration the caller may reach (404 otherwise), which is
+    // what the id-and-owner use cases below expect. `manage: true` is for
+    // changing or deleting: an organization's integration needs an admin (403).
+    const ownerOf = async (integrationId, user, options) =>
+        (await getOwnedIntegrationRecord.execute(integrationId, user, options))
+            .userId;
+
     router.route('/api/integrations').get(
         catchAsyncError(async (req, res) => {
             const user = await authenticateUser.execute(req);
-            const userId = user.getId();
-            const integrations = await getIntegrationsForUser.execute(userId);
+            const integrations = await getIntegrationsForUser.execute(user);
             const results = {
                 entities: {
                     options: await getPossibleIntegrations.execute(),
-                    authorized: await getEntitiesForUser.execute(userId),
+                    authorized: await getEntitiesForUser.execute(user),
                 },
                 integrations: integrations,
             };
@@ -266,7 +304,6 @@ function setIntegrationRoutes(router, authenticateUser, useCases) {
     router.route('/api/integrations').post(
         catchAsyncError(async (req, res) => {
             const user = await authenticateUser.execute(req);
-            const userId = user.getId();
             const params = checkRequiredParams(req.body, [
                 'entities',
                 'config',
@@ -274,10 +311,17 @@ function setIntegrationRoutes(router, authenticateUser, useCases) {
 
             get(params.config, 'type');
 
+            const { ownerId, organizationId, adoptUnscoped } =
+                await resolveIntegrationOwnership.execute({
+                    entityIds: params.entities,
+                    config: params.config,
+                    user,
+                });
             const integration = await createIntegration.execute(
                 params.entities,
-                userId,
-                params.config
+                ownerId,
+                params.config,
+                { organizationId, adoptUnscoped }
             );
 
             res.status(201).json(integration);
@@ -287,12 +331,11 @@ function setIntegrationRoutes(router, authenticateUser, useCases) {
     router.route('/api/integrations/:integrationId').patch(
         catchAsyncError(async (req, res) => {
             const user = await authenticateUser.execute(req);
-            const userId = user.getId();
             const params = checkRequiredParams(req.body, ['config']);
 
             const integration = await updateIntegration.execute(
                 req.params.integrationId,
-                userId,
+                await ownerOf(req.params.integrationId, user, { manage: true }),
                 params.config
             );
             res.json(integration);
@@ -305,7 +348,7 @@ function setIntegrationRoutes(router, authenticateUser, useCases) {
             const params = checkRequiredParams(req.params, ['integrationId']);
             await deleteIntegrationForUser.execute(
                 params.integrationId,
-                user.getId()
+                await ownerOf(params.integrationId, user, { manage: true })
             );
             res.status(204).json({});
         })
@@ -317,7 +360,7 @@ function setIntegrationRoutes(router, authenticateUser, useCases) {
             const params = checkRequiredParams(req.params, ['integrationId']);
             const integration = await getIntegrationInstance.execute(
                 params.integrationId,
-                user.getId()
+                await ownerOf(params.integrationId, user)
             );
             res.json(await integration.send('GET_CONFIG_OPTIONS'));
         })
@@ -333,7 +376,7 @@ function setIntegrationRoutes(router, authenticateUser, useCases) {
                 ]);
                 const integration = await getIntegrationInstance.execute(
                     params.integrationId,
-                    user.getId()
+                    await ownerOf(params.integrationId, user)
                 );
 
                 res.json(
@@ -347,7 +390,7 @@ function setIntegrationRoutes(router, authenticateUser, useCases) {
             const params = checkRequiredParams(req.params, ['integrationId']);
             const integration = await getIntegrationInstance.execute(
                 params.integrationId,
-                user.getId()
+                await ownerOf(params.integrationId, user)
             );
             res.json(await integration.send('GET_USER_ACTIONS', req.body));
         })
@@ -364,7 +407,7 @@ function setIntegrationRoutes(router, authenticateUser, useCases) {
                 ]);
                 const integration = await getIntegrationInstance.execute(
                     params.integrationId,
-                    user.getId()
+                    await ownerOf(params.integrationId, user)
                 );
 
                 res.json(
@@ -389,7 +432,7 @@ function setIntegrationRoutes(router, authenticateUser, useCases) {
                 ]);
                 const integration = await getIntegrationInstance.execute(
                     params.integrationId,
-                    user.getId()
+                    await ownerOf(params.integrationId, user)
                 );
 
                 res.json(
@@ -410,7 +453,7 @@ function setIntegrationRoutes(router, authenticateUser, useCases) {
             ]);
             const integration = await getIntegrationInstance.execute(
                 params.integrationId,
-                user.getId()
+                await ownerOf(params.integrationId, user)
             );
             res.json(await integration.send(params.actionId, req.body));
         })
@@ -427,7 +470,7 @@ function setIntegrationRoutes(router, authenticateUser, useCases) {
             const params = checkRequiredParams(req.params, ['integrationId']);
             const integration = await getIntegrationInstance.execute(
                 params.integrationId,
-                user.getId()
+                await ownerOf(params.integrationId, user)
             );
 
             // We could perhaps augment router with dynamic options? Haven't decided yet, but here may be the place
@@ -447,7 +490,7 @@ function setIntegrationRoutes(router, authenticateUser, useCases) {
             const params = checkRequiredParams(req.params, ['integrationId']);
             const instance = await getIntegrationInstance.execute(
                 params.integrationId,
-                user.getId()
+                await ownerOf(params.integrationId, user)
             );
 
             if (!instance) {
@@ -485,7 +528,7 @@ function setEntityRoutes(router, authenticateUser, useCases) {
         getModule,
         getEntityOptionsById,
         refreshEntityOptions,
-        processAuthorizationCallback,
+        authorizeEntityForUser,
     } = useCases;
 
     router.route('/api/authorize').get(
@@ -513,11 +556,15 @@ function setEntityRoutes(router, authenticateUser, useCases) {
     router.route('/api/authorize').post(
         catchAsyncError(async (req, res) => {
             const user = await authenticateUser.execute(req);
-            const userId = user.getId();
             const params = checkRequiredParams(req.body, [
                 'entityType',
                 'data',
             ]);
+            const ownership = authorizeEntityForUser.resolveOwnership({
+                user,
+                entityType: params.entityType,
+            });
+            const userId = ownership.ownerId;
 
             const dataKeys =
                 params.data && typeof params.data === 'object'
@@ -529,11 +576,13 @@ function setEntityRoutes(router, authenticateUser, useCases) {
                 dataKeys,
             });
 
-            const entityDetails = await processAuthorizationCallback.execute(
-                userId,
-                params.entityType,
-                params.data
-            );
+            const { result: entityDetails } =
+                await authorizeEntityForUser.execute({
+                    user,
+                    entityType: params.entityType,
+                    data: params.data,
+                    ownership,
+                });
 
             log.info('Entity authorized', {
                 eventName: 'frigg.integrations.authorized',

package/integrations/repositories/integration-not-found.js

@@ -0,0 +1,14 @@
+/**
+ * The error `findIntegrationById` throws for an id with no row, and the one
+ * predicate that recognises it. The adapters build the error here and the
+ * use cases match it here, so the message is written once and a missing
+ * integration can be told from any other failure without widening a regex.
+ */
+const MESSAGE = /^Integration with id .+ not found$/;
+
+const integrationNotFoundError = (id) =>
+    new Error(`Integration with id ${id} not found`);
+
+const isIntegrationNotFound = (error) => MESSAGE.test(error?.message || '');
+
+module.exports = { integrationNotFoundError, isIntegrationNotFound };

package/integrations/repositories/integration-repository-documentdb.js

@@ -14,6 +14,7 @@ const {
     IntegrationRepositoryInterface,
 } = require('./integration-repository-interface');
 const { validateConfigPatch } = require('./config-patch-shared');
+const { integrationNotFoundError } = require('./integration-not-found');
 
 class IntegrationRepositoryDocumentDB extends IntegrationRepositoryInterface {
     constructor() {
@@ -28,6 +29,27 @@ class IntegrationRepositoryDocumentDB extends IntegrationRepositoryInterface {
         return records.map((doc) => this._mapIntegration(doc));
     }
 
+    /**
+     * Find integrations matching any of the owner/organization pairs, in one
+     * query. `organizationId: null` matches rows with no organization (a raw
+     * MongoDB `null` also matches a missing field). The caller (a use case)
+     * decides which pairs; this only runs them.
+     *
+     * @param {Array<{userId: string, organizationId: (string|null)}>} clauses
+     * @returns {Promise<Array>}
+     */
+    async findIntegrationsByOwnership(clauses) {
+        if (!Array.isArray(clauses) || clauses.length === 0) return [];
+        const records = await findMany(this.prisma, 'Integration', {
+            $or: clauses.map(({ userId, organizationId }) => ({
+                userId: toObjectId(userId),
+                organizationId:
+                    organizationId === null ? null : toObjectId(organizationId),
+            })),
+        });
+        return records.map((doc) => this._mapIntegration(doc));
+    }
+
     async findIntegrations({ type, status } = {}) {
         const filter = {};
         if (type) {
@@ -68,11 +90,11 @@ class IntegrationRepositoryDocumentDB extends IntegrationRepositoryInterface {
     async findIntegrationById(id) {
         const objectId = toObjectId(id);
         if (!objectId) {
-            throw new Error(`Integration with id ${id} not found`);
+            throw integrationNotFoundError(id);
         }
         const doc = await findOne(this.prisma, 'Integration', { _id: objectId });
         if (!doc) {
-            throw new Error(`Integration with id ${id} not found`);
+            throw integrationNotFoundError(id);
         }
         return this._mapIntegration(doc);
     }
@@ -132,10 +154,18 @@ class IntegrationRepositoryDocumentDB extends IntegrationRepositoryInterface {
         return true;
     }
 
-    async createIntegration(entities, userId, config) {
+    /**
+     * @param {Array<string>} entities - entity ids
+     * @param {string} userId - owner (the person, or the organization's user)
+     * @param {Object} config - Integration configuration
+     * @param {{organizationId?: (string|null)}} [tenancy] - the organization the
+     *   integration is created in (ADR-056 §3.6)
+     */
+    async createIntegration(entities, userId, config, tenancy = {}) {
         const now = new Date();
         const document = {
             userId: toObjectId(userId) || null,
+            organizationId: toObjectId(tenancy.organizationId) || null,
             config,
             version: '0.0.0',
             status: 'IN_CREATION',
@@ -298,6 +328,7 @@ class IntegrationRepositoryDocumentDB extends IntegrationRepositoryInterface {
             id: fromObjectId(doc?._id),
             entitiesIds: (doc?.entityIds || []).map((value) => fromObjectId(value)),
             userId: fromObjectId(doc?.userId),
+            organizationId: fromObjectId(doc?.organizationId) ?? null,
             config: doc?.config ?? null,
             version: doc?.version ?? null,
             status: doc?.status ?? null,

package/integrations/repositories/integration-repository-interface.js

@@ -10,6 +10,20 @@
  * @abstract
  */
 class IntegrationRepositoryInterface {
+    /**
+     * Find integrations matching any of the owner/organization pairs, in one
+     * query (ADR-056 §3.6). `organizationId: null` matches rows with no
+     * organization. Which pairs is decided by the caller
+     * (modules/entity-scope.js), not here.
+     *
+     * @param {Array<{userId: string|number, organizationId: (string|number|null)}>} clauses
+     * @returns {Promise<Array>} Array of integration objects
+     * @abstract
+     */
+    async findIntegrationsByOwnership(clauses) {
+        throw new Error('Method findIntegrationsByOwnership must be implemented by subclass');
+    }
+
     /**
      * Find all integrations for a user
      *
@@ -123,10 +137,12 @@ class IntegrationRepositoryInterface {
      * @param {Array<string|number>} entities - Array of entity IDs
      * @param {string|number} userId - User ID
      * @param {Object} config - Integration configuration
+     * @param {{organizationId?: (string|number|null)}} [tenancy] - the organization the
+     *   integration is created in (ADR-056 §3.6)
      * @returns {Promise<Object>} Created integration object
      * @abstract
      */
-    async createIntegration(entities, userId, config) {
+    async createIntegration(entities, userId, config, tenancy) {
         throw new Error('Method createIntegration must be implemented by subclass');
     }