Merge pull request #5081 from FlowFuse/fix-db-views-add-status

Add 3rd Party broker endpoint
FlowFuse · Feb 7, 2025 · 00be7f6 · 00be7f6
2 parents 7ce94e9 + a215e0f
commit 00be7f6
Show file tree

Hide file tree

Showing 2 changed files with 94 additions and 60 deletions.
diff --git a/forge/db/views/BrokerCredentials.js b/forge/db/views/BrokerCredentials.js
@@ -1,31 +1,41 @@
-module.exports = {
-    credentials: function (app, credentials) {
-        const filtered = []
-        credentials.forEach(c => {
-            filtered.push(this.clean(app, c))
-        })
-        return filtered
-    },
-    clean: function (app, cred) {
-        const result = cred.toJSON()
-        const cleaned = {
-            id: result.hashid,
-            name: result.name,
-            host: result.host,
-            port: result.port,
-            protocol: result.protocol,
-            ssl: result.ssl,
-            verifySSL: result.verifySSL,
-            clientId: result.clientId
+module.exports = function (app) {
+    app.addSchema({
+        $id: 'MQTTBroker',
+        type: 'object',
+        properties: {
+            id: { type: 'string' },
+            name: { type: 'string' },
+            host: { type: 'string' },
+            port: { type: 'number' },
+            protocol: { type: 'string' },
+            ssl: { type: 'boolean' },
+            verifySSL: { type: 'boolean' },
+            clientId: { type: 'string' }
+        },
+        additionalProperties: true
+    })
+    return {
+        clean: function (cred) {
+            const result = cred.toJSON()
+            const cleaned = {
+                id: result.hashid,
+                name: result.name,
+                host: result.host,
+                port: result.port,
+                protocol: result.protocol,
+                ssl: result.ssl,
+                verifySSL: result.verifySSL,
+                clientId: result.clientId
+            }
+            return cleaned
+        },
+        cleanList: function (list) {
+            const filtered = []
+            list.brokers.forEach(u => {
+                filtered.push(this.clean(u))
+            })
+            list.brokers = filtered
+            return list
         }
-        return cleaned
-    },
-    cleanList: function (app, list) {
-        const filtered = []
-        list.brokers.forEach(u => {
-            filtered.push(this.clean(app, u))
-        })
-        list.brokers = filtered
-        return list
     }
 }
diff --git a/forge/ee/routes/teamBroker/3rdPartyBroker.js b/forge/ee/routes/teamBroker/3rdPartyBroker.js
@@ -62,7 +62,14 @@ module.exports = async function (app) {
                 200: {
                     type: 'object',
                     properties: {
-
+                        meta: { $ref: 'PaginationMeta' },
+                        count: { type: 'number' },
+                        brokers: {
+                            type: 'array',
+                            items: {
+                                $ref: 'MQTTBroker'
+                            }
+                        }
                     },
                     additionalProperties: true
                 },
@@ -98,28 +105,11 @@ module.exports = async function (app) {
                 }
             },
             body: {
-                type: 'object',
-                properties: {
-                    name: { type: 'string' },
-                    host: { type: 'string' },
-                    port: { type: 'number' },
-                    protocol: { type: 'string' },
-                    protocolVersion: { type: 'number' },
-                    ssl: { type: 'boolean' },
-                    verifySSL: { type: 'boolean' },
-                    clientId: { type: 'string' },
-                    credentials: {
-                        type: 'object'
-                    }
-                }
+                $ref: 'MQTTBroker'
             },
             response: {
                 201: {
-                    type: 'object',
-                    properties: {
-
-                    },
-                    additionalProperties: true
+                    $ref: 'MQTTBroker'
                 },
                 '4xx': {
                     $ref: 'APIError'
@@ -190,11 +180,7 @@ module.exports = async function (app) {
             },
             response: {
                 200: {
-                    type: 'object',
-                    properties: {
-
-                    },
-                    additionalProperties: true
+                    $ref: 'MQTTBroker'
                 },
                 '4xx': {
                     $ref: 'APIError'
@@ -262,11 +248,7 @@ module.exports = async function (app) {
             },
             response: {
                 200: {
-                    type: 'object',
-                    properties: {
-
-                    },
-                    additionalProperties: true
+                    $ref: 'MQTTBroker'
                 },
                 '4xx': {
                     $ref: 'APIError'
@@ -293,6 +275,48 @@ module.exports = async function (app) {
         }
     })
 
+    /**
+     * Get details and status of a 3rd Party Broker
+     */
+    app.get('/:brokerId', {
+        preHandler: app.needsPermission('broker:credentials:list'),
+        schema: {
+            summary: 'Get 3rd Party Broker details and status',
+            tags: ['MQTT Broker'],
+            params: {
+                type: 'object',
+                properties: {
+                    teamId: { type: 'string' },
+                    brokerId: { type: 'string' }
+                }
+            },
+            response: {
+                200: {
+                    $ref: 'MQTTBroker'
+                },
+                '4xx': {
+                    $ref: 'APIError'
+                },
+                500: {
+                    $ref: 'APIError'
+                }
+            }
+        }
+    }, async (request, reply) => {
+        if (request.params.brokerId !== 'team-broker') {
+            try {
+                const state = await app.containers.getBrokerAgentState(request.broker)
+                const clean = app.db.views.BrokerCredentials.clean(request.broker)
+                clean.state = state
+                reply.send(clean)
+            } catch (err) {
+                reply.status(500).send({ error: 'unknown_error', message: err.toString() })
+            }
+        } else {
+            reply.status(40).send({ error: 'not_supported', message: 'not supported' })
+        }
+    })
+
     /**
      * Remove 3rd Party Broker credentials
      * @name /api/v1/teams/:teamId/brokers/:brokerId
@@ -336,10 +360,10 @@ module.exports = async function (app) {
                 await request.broker.destroy()
                 reply.send({})
             } catch (err) {
-                reply.status(500).send({ error: 'unknown_erorr', message: err.toString() })
+                reply.status(500).send({ error: 'unknown_error', message: err.toString() })
             }
         } else {
-            reply.status(404).send({})
+            reply.status(404).send({ error: 'not_found', message: 'not found' })
         }
     })