@ossy/workspaces 1.17.2 → 1.17.3

package/src/workspaces.events.js

@@ -1,171 +1,77 @@
-/**
- * Field
- * @typedef {Object} Field
- * @property {string} type - field type
- * @property {string} name - name of field
- */
-
- /**
-  * ResourceTemplate
-  * @typedef {Object} ResourceTemplate
-  * @property {string} name - Displayname of the resource template
-  * @property {Field[]} fields - Allowed fields
-  */
-
+import { nanoid } from 'nanoid'
+import { WorkspaceSchema } from './schema-ids.js'
 
 /**
-  * @class
-  */
+ * ADR 0008 workspace entity events.
+ */
 export class WorkspacesEvents {
 
-  /**
-   * Return type of WorkspacesEvents.Created
-   * @typedef {Object} Created
-   * @property {string} type - Created
-   * @property {string} createdBy - userId of user who created the workspace
-   * @property {CreatedPayload} payload - event payload
-   */
+  static Created ({ resourceId, createdBy, name }) {
+    return {
+      type: WorkspaceSchema.workspace,
+      resourceId: resourceId ?? nanoid(),
+      event: 'Created',
+      createdBy,
+      payload: { name },
+    }
+  }
 
-   /**
-    * Payload of Workspace.Created event
-    * @typedef {Object} CreatedPayload
-    * @property {string} name - Name of workspace
-    */
+  static SchemasImported ({ createdBy, schemas }) {
+    return {
+      event: 'SchemasImported',
+      createdBy,
+      payload: { schemas },
+    }
+  }
 
-  /**
-   * Input for WorkspacesEvents.Created
-   * @typedef {Object} CreatedInput
-   * @property {string} name - Name of workspace
-   * @property {string} createdBy - userId of user who created the workspace
-   */
+  static ApiTokenCreated ({ createdBy, description, token }) {
+    return {
+      event: 'ApiTokenCreated',
+      createdBy,
+      payload: { description, token },
+    }
+  }
 
-  /**
-   *  Use this to indicate that a new workspace have been created
-   *
-   * @param {CreatedInput} input
-   * @return {Created} - Workspace created event
-   *
-   * @example
-   * const name = 'ossy.se'
-   * const createdBy = 'fake-user-id-123'
-   *
-   * const event = WorkspacesEvents.Created({ name, createdBy })
-   *
-   * Aggregate.Of(Workspace, event)
-   */
-  static Created({ createdBy, name }) {
-    return ({
-      type: 'Created',
-      createdBy: createdBy,
+  static UserInvited ({ createdBy, email, expiresAt }) {
+    return {
+      event: 'UserInvited',
+      createdBy,
       payload: {
-        name: name
-      }
-    })
-   }
-
-   /**
-    * Return type of WorkspacesEvents.ResourceTemplatesImported
-    * @typedef {Object} ResourceTemplatesImported
-    * @property {string} type - ResourceTemplatesImported
-    * @property {string} createdBy - userId of user who created the workspace
-    * @property {ResourceTemplate[]} payload - event payload
-    */
-
-   /**
-    * Input for WorkspacesEvents.Created
-    * @typedef {Object} ResourceTemplatesImportedInput
-    * @property {ResourceTemplate[]} templates - List of resource templates
-    * @property {string} createdBy - userId of user who created the workspace
-    */
-
-   /**
-    *  Use this to save imported resource templates
-    *
-    * @param {ResourceTemplatesImportedInput} input
-    * @return {ResourceTemplatesImported} - Resource templates imported event
-    *
-    * @example
-    * const templates = []
-    * const createdBy = 'fake-user-123'
-    *
-    * const event = WorkspacesEvents.Created({ templates, createdBy })
-    *
-    * Aggregate.Of(Workspace, userId)
-    *  .then(Aggregate.Add(event))
-    */
-   static ResourceTemplatesImported({ createdBy, templates }) {
-     return ({
-       type: 'ResourceTemplatesImported',
-       createdBy: createdBy,
-       payload: {
-         templates: templates
-       }
-     })
-   }
-
-   // Not in use atm, use API TOKENS in the user aggregate instead.
-   // Caller is responsible for generating the token value.
-   static ApiTokenCreated({ createdBy, description, token }) {
-     return ({
-       type: 'ApiTokenCreated',
-       createdBy: createdBy,
-       payload: {
-         description: description,
-         token: token
-       }
-     })
-   }
-   
-
-   static UserInvited({ createdBy, email, expiresAt }) {
-     return ({
-       type: 'UserInvited',
-       createdBy: createdBy,
-       payload: {
-         email: email,
-         expiresAt: new Date().getTime() + 1000 * 60 * 60 * 24 * 7, // One week
-       }
-     })
-   }
+        email,
+        expiresAt: expiresAt ?? Date.now() + 1000 * 60 * 60 * 24 * 7,
+      },
+    }
+  }
 
-   static UserInvitationAccepted({ createdBy, email }) {
-     return ({
-       type: 'UserInvitationAccepted',
-       createdBy: createdBy,
-       payload: {
-        email: email
-       }
-     })
-   }
-   
-   static ServiceEnabled({ createdBy, service }) {
-     return ({
-       type: 'ServiceEnabled',
-       createdBy: createdBy,
-       payload: {
-         service: service
-       }
-     })
+  static UserInvitationAccepted ({ createdBy, email }) {
+    return {
+      event: 'UserInvitationAccepted',
+      createdBy,
+      payload: { email },
+    }
   }
 
-  static ServiceDisabled({ createdBy, service }) {
-    return ({
-      type: 'ServiceDisabled',
-      createdBy: createdBy,
-      payload: {
-        service: service
-      }
-    })
+  static ServiceEnabled ({ createdBy, service }) {
+    return {
+      event: 'ServiceEnabled',
+      createdBy,
+      payload: { service },
+    }
   }
 
-  static UserRemoved({ createdBy, userId }) {
-    return ({
-      type: 'UserRemoved',
-      createdBy: createdBy,
-      payload: {
-        userId: userId
-      }
-    })
+  static ServiceDisabled ({ createdBy, service }) {
+    return {
+      event: 'ServiceDisabled',
+      createdBy,
+      payload: { service },
+    }
   }
 
+  static UserRemoved ({ createdBy, userId }) {
+    return {
+      event: 'UserRemoved',
+      createdBy,
+      payload: { userId },
+    }
+  }
 }

package/src/{workspaces.spec.js → workspaces.integration.spec.js}

@@ -1,6 +1,8 @@
 import casual from 'casual'
 import { TestUtil } from '@ossy/platform/test'
 
+const WORKSPACE_SCHEMA = '@ossy/workspaces/schema/workspace'
+
 function authHeaders(token) {
   return {
     'Content-Type': 'application/json',
@@ -16,10 +18,10 @@ function workspaceHeaders(userToken, workspaceId) {
   }
 }
 
-describe('[workspaces/create]', () => {
+describe('[workspaces/actions/create]', () => {
 
   TestUtil.AssertActionAuthenticationNeeded({
-    actionId: 'workspaces/create',
+    actionId: '@ossy/workspaces/actions/create',
   })
 
   describe('given a workspace name', () => {
@@ -28,7 +30,7 @@ describe('[workspaces/create]', () => {
       const workspaceName = casual.word
 
       const response = await TestUtil.InvokeAction({
-        actionId: 'workspaces/create',
+        actionId: '@ossy/workspaces/actions/create',
         headers: authHeaders(user.token),
         payload: { name: workspaceName },
       })
@@ -36,8 +38,8 @@ describe('[workspaces/create]', () => {
       const body = await response.json()
 
       const workspaceCreatedEvent = await TestUtil.GetEvent({
-        aggregateType: 'Workspace',
-        type: 'Created',
+        type: WORKSPACE_SCHEMA,
+        event: 'Created',
         createdBy: user.id,
         'payload.name': workspaceName
       })
@@ -45,35 +47,35 @@ describe('[workspaces/create]', () => {
       expect(!!workspaceCreatedEvent).toEqual(true)
       expect(response.status).toEqual(200)
       expect(response.headers.get('Content-Type').includes('application/json')).toEqual(true)
-      expect(body.id).toEqual(workspaceCreatedEvent.aggregateId)
+      expect(body.id).toEqual(workspaceCreatedEvent.resourceId)
       expect(body.name).toEqual(workspaceName)
       expect(body.createdBy).toEqual(user.id)
       expect(body.created).toEqual(workspaceCreatedEvent.created)
       expect(body.apiTokens).toEqual([])
-      expect(Array.isArray(body.resourceTemplates)).toBe(true)
-      expect(body.resourceTemplates.length).toEqual(0)
+      expect(Array.isArray(body.schemas)).toBe(true)
+      expect(body.schemas.length).toEqual(0)
     })
   })
 
 })
 
-describe('[workspaces/list]', () => {
+describe('[workspaces/actions/list]', () => {
 
   TestUtil.AssertActionAuthenticationNeeded({
-    actionId: 'workspaces/list',
+    actionId: '@ossy/workspaces/actions/list',
   })
 
   it('must return a minified list of workspaces the user have created', async () => {
     const user = await TestUtil.GetAuthenticatedTestUser()
 
     const workspace = await TestUtil.InvokeAction({
-      actionId: 'workspaces/create',
+      actionId: '@ossy/workspaces/actions/create',
       headers: authHeaders(user.token),
       payload: { name: casual.word },
     }).then(response => response.json())
 
     const response = await TestUtil.InvokeAction({
-      actionId: 'workspaces/list',
+      actionId: '@ossy/workspaces/actions/list',
       headers: authHeaders(user.token),
     })
 
@@ -89,10 +91,10 @@ describe('[workspaces/list]', () => {
 
 })
 
-describe('[workspaces/get]', () => {
+describe('[workspaces/actions/get]', () => {
 
   TestUtil.AssertWorkspaceActionAuthenticationNeeded({
-    actionId: 'workspaces/get',
+    actionId: '@ossy/workspaces/actions/get',
     payload: { workspaceId: '123' },
   })
 
@@ -100,13 +102,13 @@ describe('[workspaces/get]', () => {
     const user = await TestUtil.GetAuthenticatedTestUser()
 
     const workspace = await TestUtil.InvokeAction({
-      actionId: 'workspaces/create',
+      actionId: '@ossy/workspaces/actions/create',
       headers: authHeaders(user.token),
       payload: { name: casual.word },
     }).then(response => response.json())
 
     const response = await TestUtil.InvokeAction({
-      actionId: 'workspaces/get',
+      actionId: '@ossy/workspaces/actions/get',
       headers: workspaceHeaders(user.token, workspace.id),
       payload: { workspaceId: workspace.id },
     })
@@ -120,19 +122,19 @@ describe('[workspaces/get]', () => {
 
 })
 
-describe('[workspaces/import-resource-templates]', () => {
+describe('[workspaces/actions/import-schemas]', () => {
 
   TestUtil.AssertWorkspaceActionAuthenticationNeeded({
-    actionId: 'workspaces/import-resource-templates',
-    payload: { templates: [] },
+    actionId: '@ossy/workspaces/actions/import-schemas',
+    payload: { schemas: [] },
     headers: { workspaceId: 'ws-test' },
   })
 
-  it('must return the saved templates and create a ResourceTemplatesImported event', async () => {
+  it('must return the saved schemas and create a SchemasImported event', async () => {
     const user = await TestUtil.GetAuthenticatedTestUser()
 
     const workspace = await TestUtil.InvokeAction({
-      actionId: 'workspaces/create',
+      actionId: '@ossy/workspaces/actions/create',
       headers: authHeaders(user.token),
       payload: { name: casual.word },
     }).then(response => response.json())
@@ -146,40 +148,40 @@ describe('[workspaces/import-resource-templates]', () => {
     ]
 
     const response = await TestUtil.InvokeAction({
-      actionId: 'workspaces/import-resource-templates',
+      actionId: '@ossy/workspaces/actions/import-schemas',
       headers: workspaceHeaders(user.token, workspace.id),
-      payload: { templates: imported },
+      payload: { schemas: imported },
     })
 
     const responseBody = await response.json()
 
-    const resourceTemplatesImportedEvent = await TestUtil.GetEvent({
-      aggregateType: 'Workspace',
-      type: 'ResourceTemplatesImported',
+    const schemasImportedEvent = await TestUtil.GetEvent({
+      type: WORKSPACE_SCHEMA,
+      event: 'SchemasImported',
       createdBy: user.id,
-      'payload.templates': imported
+      'payload.schemas': imported
     })
 
     expect(response.status).toEqual(200)
     expect(responseBody).toEqual(imported)
-    expect(!!resourceTemplatesImportedEvent).toEqual(true)
+    expect(!!schemasImportedEvent).toEqual(true)
 
   })
 
 })
 
-describe('[workspaces/get-resource-templates]', () => {
+describe('[workspaces/actions/get-schemas]', () => {
 
   TestUtil.AssertWorkspaceActionAuthenticationNeeded({
-    actionId: 'workspaces/get-resource-templates',
+    actionId: '@ossy/workspaces/actions/get-schemas',
     headers: { workspaceId: 'ws-test' },
   })
 
-  it('must return the saved templates event', async () => {
+  it('must return the saved schemas', async () => {
     const user = await TestUtil.GetAuthenticatedTestUser()
 
     const workspace = await TestUtil.InvokeAction({
-      actionId: 'workspaces/create',
+      actionId: '@ossy/workspaces/actions/create',
       headers: authHeaders(user.token),
       payload: { name: casual.word },
     }).then(response => response.json())
@@ -193,9 +195,9 @@ describe('[workspaces/get-resource-templates]', () => {
     ]
 
     const response = await TestUtil.InvokeAction({
-      actionId: 'workspaces/import-resource-templates',
+      actionId: '@ossy/workspaces/actions/import-schemas',
       headers: workspaceHeaders(user.token, workspace.id),
-      payload: { templates: imported },
+      payload: { schemas: imported },
     })
 
     const responseBody = await response.json()
@@ -207,10 +209,10 @@ describe('[workspaces/get-resource-templates]', () => {
 
 })
 
-describe('[workspaces/create-api-token]', () => {
+describe('[workspaces/actions/create-api-token]', () => {
 
   TestUtil.AssertWorkspaceActionAuthenticationNeeded({
-    actionId: 'workspaces/create-api-token',
+    actionId: '@ossy/workspaces/actions/create-api-token',
     payload: { description: 'Api token for GitHub Actions' },
     headers: { workspaceId: 'ws-test' },
   })
@@ -219,13 +221,13 @@ describe('[workspaces/create-api-token]', () => {
     const user = await TestUtil.GetAuthenticatedTestUser()
 
     const workspace = await TestUtil.InvokeAction({
-      actionId: 'workspaces/create',
+      actionId: '@ossy/workspaces/actions/create',
       headers: authHeaders(user.token),
       payload: { name: casual.word },
     }).then(response => response.json())
 
     const response = await TestUtil.InvokeAction({
-      actionId: 'workspaces/create-api-token',
+      actionId: '@ossy/workspaces/actions/create-api-token',
       headers: workspaceHeaders(user.token, workspace.id),
       payload: { description: 'Api token for GitHub Actions' },
     })

package/src/workspaces.queries.js

@@ -1,33 +1,48 @@
 import { EventStore } from '@ossy/event-store'
 import { createLogger } from '@ossy/observability'
+import { WorkspaceSchema } from './schema-ids.js'
 
 const log = createLogger('workspaces')
 
 export class WorkspacesQueries {
-  static getAllByUserIncluded(userId) {
+  static getAllByUserIncluded (userId) {
     log.info('[WorkspacesQueries] getAllByUserIncluded()')
     return EventStore.Aggregate([
-      { $group: { _id: { aggregateId: '$aggregateId', aggregateType: '$aggregateType' }, events: { $push: '$$ROOT' } } },
+      { $match: { type: WorkspaceSchema.workspace, resourceId: { $exists: true } } },
+      { $group: { _id: '$resourceId', events: { $push: '$$ROOT' } } },
       {
         $match: {
-          '_id.aggregateType': 'Workspace',
-          'events.createdBy': userId,
-          'events.type': { $nin: ['Deleted'], $in: ['Created', 'UserInvitationAccepted'] },
+          $or: [
+            { 'events.createdBy': userId },
+            { 'events.event': 'UserInvitationAccepted', 'events.createdBy': userId },
+          ],
+          'events.event': { $in: ['Created', 'UserInvitationAccepted'] },
         },
       },
       {
         $project: {
-          events: '$events',
-          currentState: {
-            $reduce: {
-              input: '$events',
-              initialValue: {},
-              in: { id: '$_id.aggregateId', name: { $ifNull: ['$$this.payload.name', '$$value.name'] } },
+          id: '$_id',
+          name: {
+            $let: {
+              vars: {
+                created: {
+                  $arrayElemAt: [
+                    {
+                      $filter: {
+                        input: '$events',
+                        as: 'e',
+                        cond: { $eq: ['$$e.event', 'Created'] },
+                      },
+                    },
+                    0,
+                  ],
+                },
+              },
+              in: '$$created.payload.name',
             },
           },
         },
       },
-      { $project: { _id: 0, id: '$currentState.id', name: '$currentState.name' } },
     ]).catch(() => [])
   }
 }

package/src/get-resource-templates.action.js

@@ -1 +0,0 @@
-export const metadata = { id: 'workspaces/get-resource-templates', access: 'workspace' }

package/src/get-resource-templates.task.js

@@ -1,18 +0,0 @@
-import { Aggregate } from '@ossy/event-store'
-import { Workspace } from '@ossy/workspaces/server'
-import { getSystemResourceTemplates } from '@ossy/platform'
-
-export const metadata = { id: 'workspaces/get-resource-templates' }
-
-export async function run({ payload, req }) {
-  const workspaceId = payload?.workspaceId ?? req?.workspaceId
-
-  const workspace = await Aggregate.Of(Workspace, workspaceId).then(Aggregate.View())
-  const systemTemplates = getSystemResourceTemplates()
-  const workspaceTemplates = workspace.resourceTemplates || []
-  const workspaceIds = new Set(workspaceTemplates.map(t => t.id))
-  return [
-    ...systemTemplates.filter(t => !workspaceIds.has(t.id)),
-    ...workspaceTemplates,
-  ]
-}

package/src/import-resource-templates.action.js

@@ -1 +0,0 @@
-export const metadata = { id: 'workspaces/import-resource-templates', access: 'workspace' }

package/src/import-resource-templates.task.js

@@ -1,26 +0,0 @@
-import { Aggregate } from '@ossy/event-store'
-import { Workspace, WorkspacesEvents } from '@ossy/workspaces/server'
-import { validateResourceTemplatesForImport } from '@ossy/platform'
-
-export const metadata = { id: 'workspaces/import-resource-templates' }
-
-export async function run({ payload, req }) {
-  const userId = payload?.userId ?? req?.userId
-  const workspaceId = payload?.workspaceId ?? req?.workspaceId
-  const templates = payload?.templates ?? payload
-
-  if (!Array.isArray(templates)) {
-    throw Object.assign(new Error('templates must be an array'), { status: 400 })
-  }
-
-  const reservedIds = new Set([])
-  const validation = validateResourceTemplatesForImport(templates, reservedIds)
-  if (!validation.ok) {
-    throw Object.assign(new Error(validation.message), { status: 400, type: validation.code })
-  }
-
-  const event = WorkspacesEvents.ResourceTemplatesImported({ createdBy: userId, templates })
-
-  await Aggregate.Of(Workspace, workspaceId).then(Aggregate.Add(event))
-  return event.payload.templates
-}