Add user to flow to StorageFlows table, to record who triggered auto snapshot

forge/db/controllers/ProjectSnapshot.js

@@ -321,7 +321,12 @@ const instanceAutoSnapshotUtils = {
             // 2. log the snapshot creation in audit log
             // 3. delete older auto snapshots if the limit is reached (10)
             //    do NOT delete any snapshots that are currently in use by an target (instance/device/device group)
-            const user = meta?.user || { id: null } // if no user is available, use `null` (system user)
+            const currentFlow = await app.db.models.StorageFlow.byProject(project.id)
+            let flowUser = null
+            if (currentFlow.UserId !== null) {
+                flowUser = currentFlow.UserId
+            }
+            const user = meta?.user || { id: flowUser } // if no user is available, use `null` (system user)
 
             // 1. create a snapshot from the instance
             const snapShot = await app.db.controllers.ProjectSnapshot.createSnapshot(

forge/db/migrations/20240920-02-add-flow-user.js

@@ -0,0 +1,21 @@
+/**
+ * Add User to StorageFlows table
+ */
+const { DataTypes } = require('sequelize')
+
+module.exports = {
+    up: async (context) => {
+        await context.addColumn('StorageFlows', 'UserId', {
+            type: DataTypes.INTEGER,
+            allowNull: true,
+            defaultValue: null,
+            references: { model: 'Users', key: 'id' },
+            // CHECK ME
+            onDelete: 'SET NULL',
+            // CHECK ME
+            onUpdate: 'CASCADE'
+        })
+    },
+    down: async (context) => {
+    }
+}

forge/db/models/StorageFlow.js

@@ -15,14 +15,15 @@ module.exports = {
     },
     associations: function (M) {
         this.belongsTo(M.Project)
+        this.belongsTo(M.User)
     },
     finders: function (M) {
         return {
             static: {
                 byProject: async (project) => {
                     return this.findOne({
                         where: { ProjectId: project },
-                        attributes: ['id', 'flow', 'updatedAt']
+                        attributes: ['id', 'flow', 'updatedAt', 'UserId']
                     })
                 }
             }

forge/routes/storage/index.js

@@ -25,14 +25,20 @@ module.exports = async function (app) {
 
     app.post('/:projectId/flows', async (request, response) => {
         const id = request.params.projectId
+        let UserId = null
+        if (request.headers['ff-user']) {
+            UserId = app.db.models.User.decodeHashid(request.headers['ff-user'])[0]
+        }
         // Check if the project exists first
         let flow = await app.db.models.StorageFlow.byProject(id)
         if (flow) {
             flow.flow = JSON.stringify(request.body)
+            flow.UserId = UserId
             await flow.save()
         } else {
             flow = await app.db.models.StorageFlow.create({
                 flow: JSON.stringify(request.body),
+                UserId,
                 ProjectId: id
             })
 

test/unit/forge/routes/storage/index_spec.js

@@ -147,6 +147,31 @@ describe('Storage API', function () {
             const flow = response.json()
             should(flow).eqls(newFlow)
         })
+
+        it('Save Flow with user', async function () {
+            const newFlow = [{ id: '1', type: 'tab', label: 'tab1', disabled: false, info: '' }]
+            const flowURL = `/storage/${project.id}/flows`
+            await app.inject({
+                method: 'POST',
+                url: flowURL,
+                headers: {
+                    authorization: `Bearer ${tokens.token}`,
+                    'ff-user': app.adminUser.hashid
+                },
+                payload: newFlow
+            })
+            const response = await app.inject({
+                method: 'GET',
+                url: flowURL,
+                headers: {
+                    authorization: `Bearer ${tokens.token}`
+                }
+            })
+            const flow = response.json()
+            should(flow).eqls(newFlow)
+            const dbFlow = await app.db.models.StorageFlow.byProject(project.id)
+            dbFlow.should.have.property('UserId', app.adminUser.id)
+        })
     })
 
     describe('/credentials', function () {