Merge branch 'main' into dependabot/npm_and_yarn/eslint-plugin-n-17.16.2

Author: ppawlowski

.github/scripts/detect_changed_files.sh

@@ -0,0 +1,76 @@
+#!/usr/bin/env bash
+
+set -e
+
+# Script to check if files from specific pattern groups have changed in a PR
+# Groups: backend, postgres, ui
+
+if [[ "$GITHUB_REF" == "refs/heads/main" ]]; then
+  echo "Running on main branch, comparing with previous commit"
+  changed_files=$(git diff --name-only HEAD^ HEAD)
+else
+  echo "Running on non-default branch, comparing with $GITHUB_BASE_REF branch"
+  changed_files=$(git diff --name-only origin/$GITHUB_BASE_REF...HEAD)
+fi
+
+
+if [ -z "$changed_files" ]; then
+  echo "No files changed in this PR compared to $GITHUB_BASE_REF branch."
+  echo "backend_changed=false" >> $GITHUB_OUTPUT
+  echo "postgres_changed=false" >> $GITHUB_OUTPUT
+  echo "ui_changed=false" >> $GITHUB_OUTPUT
+  exit 0
+fi
+
+backend_changed=false
+postgres_changed=false
+ui_changed=false
+
+for file in $changed_files; do
+  if [[ $file == forge/* || 
+        $file == test/unit/* || 
+        $file == test/system/* || 
+        $file == frontend/* || 
+        $file == test/e2e/frontend/* || 
+        $file == test/unit/frontend/* || 
+        $file == package.json || 
+        $file == package-lock.json || 
+        $file == .eslintrc ]]; then
+    backend_changed=true
+  fi
+
+  if [[ $file == forge/* || 
+        $file == test/unit/* || 
+        $file == test/system/* || 
+        $file == package.json || 
+        $file == package-lock.json ]]; then
+    postgres_changed=true
+  fi
+
+  if [[ $file == forge/* || 
+        $file == test/unit/* || 
+        $file == test/system/* || 
+        $file == frontend/* || 
+        $file == test/e2e/frontend/* || 
+        $file == test/unit/frontend/* || 
+        $file == package.json || 
+        $file == package-lock.json || 
+        $file == .eslintrc ]]; then
+    ui_changed=true
+  fi
+  
+  if $backend_changed && $postgres_changed && $ui_changed; then
+    break
+  fi
+done
+
+echo "Changed groups:"
+echo "  Backend: $backend_changed"
+echo "  postgres: $postgres_changed"
+echo "  UI: $ui_changed"
+
+echo "backend_changed=$backend_changed" >> $GITHUB_OUTPUT
+echo "postgres_changed=$postgres_changed" >> $GITHUB_OUTPUT
+echo "ui_changed=$ui_changed" >> $GITHUB_OUTPUT
+
+exit 0

.github/workflows/release-publish.yml

@@ -21,9 +21,3 @@ jobs:
       - uses: JS-DevTools/npm-publish@v3
         with:
           token: ${{ secrets.NPM_PUBLISH_TOKEN }}
-      - name: Resync Maintenance
-        if: ${{ endsWith(github.ref, '.0') }}
-        run: |
-          git checkout maintenance
-          git reset --hard origin/main
-          git push --force origin maintenance

.github/workflows/tests.yml

@@ -16,53 +16,19 @@ jobs:
     name: Verify changes
     runs-on: ubuntu-latest
     outputs:
-      run_backend_tests: ${{ steps.set-outputs.outputs.backend_tests }}
-      run_postgres_tests: ${{ steps.set-outputs.outputs.postgres_tests }}
-      run_ui_tests: ${{ steps.set-outputs.outputs.ui_tests }}
+      run_backend_tests: ${{ steps.changed-files.outputs.backend_changed }}
+      run_postgres_tests: ${{ steps.changed-files.outputs.postgres_changed }}
+      run_ui_tests: ${{ steps.changed-files.outputs.ui_changed }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Get changed files
+      - name: Find changed files
         id: changed-files
-        uses: tj-actions/changed-files@v45
-        with:
-          files_yaml: |
-            backend:
-              - 'forge/**'
-              - 'test/unit/**'
-              - 'test/system/**'
-              - 'frontend/**'
-              - 'test/e2e/frontend/**'
-              - 'test/unit/frontend/**'
-              - 'package.json'
-              - 'package-lock.json'
-              - '.eslintrc'
-            postgres:
-              - 'forge/**'
-              - 'test/unit/**'
-              - 'test/system/**'
-              - 'package.json'
-              - 'package-lock.json'
-            ui:
-              - 'forge/**'
-              - 'test/unit/**'
-              - 'test/system/**'
-              - 'frontend/**'
-              - 'test/e2e/frontend/**'
-              - 'test/unit/frontend/**'
-              - 'package.json'
-              - 'package-lock.json'
-              - '.eslintrc'
-      - name: Set outputs
-        id: set-outputs
-        shell: bash
         run: |
-          echo "backend_tests=${{ steps.changed-files.outputs.backend_any_changed }}" >> "$GITHUB_OUTPUT"
-          echo "postgres_tests=${{ steps.changed-files.outputs.postgres_any_changed }}" >> "$GITHUB_OUTPUT"
-          echo "ui_tests=${{ steps.changed-files.outputs.ui_any_changed }}" >> "$GITHUB_OUTPUT"
-  
+          ./.github/scripts/detect_changed_files.sh
+
   backend-tests:
     if: ${{ needs.check-changes.outputs.run_backend_tests == 'true' }}
     name: Backend tests
@@ -220,14 +186,15 @@ jobs:
           echo "SUMMARY_ICON=no_entry" >> $GITHUB_ENV
           echo "SUMMARY_MESSAGE= Deployment to FFC environments will not happen until this issue is resolved." >> $GITHUB_ENV
           echo "LAST_COMMIT_SHA=${{ github.sha}}" >> $GITHUB_ENV
+          echo "PR_LINK=*Branch:* ${{ github.ref_name }}" >> $GITHUB_ENV
         else
           echo "HEADER_MESSAGE=Tests failed against ${{ github.event.number }} pull request" >> $GITHUB_ENV
           echo "SUMMARY_ICON=warning" >> $GITHUB_ENV
           echo "SUMMARY_MESSAGE= Please resolve the problem before merging your changes into the main branch." >> $GITHUB_ENV
           echo "LAST_COMMIT_SHA=${{ github.event.pull_request.head.sha }}" >> $GITHUB_ENV
+          echo "PR_LINK=*Pull request:* <https://github.com/FlowFuse/flowfuse/pull/${{ github.event.pull_request.number }}|${{ github.event.pull_request.number }}>" >> $GITHUB_ENV
         fi
 
-
     - name: Send notification
       uses: slackapi/slack-github-action@v2.0.0
       with:
@@ -279,13 +246,17 @@ jobs:
                     "type": "mrkdwn",
                     "text": "*Author:* <@${{ steps.map-actor-to-slack.outputs.actor-mapping }}>"
                   },
+                  {
+                    "type": "mrkdwn",
+                    "text": "<${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|View failed workflow>"
+                  },
                   {
                     "type": "mrkdwn",
                     "text": "*Last commit:* <${{ github.server_url }}/${{ github.repository }}/commit/${{ env.LAST_COMMIT_SHA }}|${{ env.LAST_COMMIT_SHA }}>"
                   },
                   {
                     "type": "mrkdwn",
-                    "text": "<${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|View workflow run>"
+                    "text": "${{ env.PR_LINK }}"
                   }
                 ]
               }

CHANGELOG.md

@@ -1,3 +1,71 @@
+#### 2.15.0: Release
+
+ - Sort instance table by date desc by default (#5311) @Steve-Mcl
+ - Fix UNS exit route guard (#5244) @cstns
+ - Add topic "Delete" button to Broker Schema (#5305) @Steve-Mcl
+ - Fix mqtt protocol version not remembered (#5306) @Steve-Mcl
+ - Bump axios from 1.7.4 to 1.8.3 (#5303) @app/dependabot
+ - Remove `Resync Maintenance` step from the release pipeline (#5302) @ppawlowski
+ - Add filter to snapshot views (#5288) @Steve-Mcl
+ - Fix generated API doc for external MQTT Broker API (#5296) @hardillb
+ - Pass npmrc and catalogue to instance/device (#5212) @hardillb
+ - Add `npm` to the restricted project name list (#5281) @hardillb
+ - Restore "Set Target Snapshot" option when creating Snapshot (#5273) @joepavitt
+ - Support Multiple Device Groups in pipeline - backend (#5259) @Steve-Mcl
+ - Allow a trial team to downgrade to freemium (#5262) @knolleary
+ - Add option to disable billing requirement for a team type (#5237) @knolleary
+ - Allow MQTT Schema agent on Docker (#5118) @hardillb
+ - Changed Bill Of Materials instance link to instance palette settings. (#5250) @78wesley
+ - Expose schema objects suggestions (#5226) @cstns
+ - Add the external url in the UI (#5247) @cstns
+ - Prevent duplicate tour, and don't show the "standard" welcome tour for Free Tier (#5242) @joepavitt
+ - Add externalUrl column on the FlowTemplate table (#5180) @cstns
+ - Broker docs schema metadata (#5207) @cstns
+ - Improve the labelling of a Pipeline for improved navigation (#5234) @joepavitt
+ - Onboarding: Improve clarification in the "Add Remote Instance" dialog (#5239) @joepavitt
+ - Fix invalid template conditional in dynamic component that was causing the device timeline to crash (#5236) @cstns
+ - Add the ability to pass down vue components to the global dialog modal (#5225) @cstns
+ - Styling: Make it clearer that Pipeline header is interactive (#5233) @joepavitt
+ - Docs: Add video walkthrough for FlowFuse Device agent (#5231) @gstout52
+ - Add API endpoint for private npm registry catalogue (#5173) @hardillb
+ - Add deviceLastSeen and remote broker counts to telemetry (#5220) @knolleary
+ - docs: Add suggested hardware requirements for self-hosted deployments (#5224) @ppawlowski
+ - Add topic suggestions (#5195) @cstns
+ - Ensure schema buttons are always shown (#5221) @knolleary
+ - Interactive device timeline events (#5205) @cstns
+ - Add a device snapshot created audit log event (#5176) @cstns
+ - Device timeline quick fixes (#5175) @cstns
+ - Update device doc references to new nomenclature (#5152) @cstns
+ - Add a device snapshot deployed audit log event (#5170) @cstns
+ - Add a device.project.deployed event to track device state changes from the device perspective (#5155) @cstns
+ - Add a device.pipeline.deployed event to track device state changes from the device perspective (#5149) @cstns
+ - Add new "Broker Error" component which details issues with connecting to 3rd party broker (#5218) @joepavitt
+ - Fix Team trial billing prompt after team creation (#5219) @cstns
+ - Add feature details on the "Delete Team" dialog (#5217) @joepavitt
+ - Ensure free tour shows when new Free Tier members sign up (#5215) @joepavitt
+ - Bump @aws-sdk/client-ses from 3.621.0 to 3.750.0 (#5174) @app/dependabot
+ - Fix missing prop on the template settings environment component (#5210) @cstns
+ - Fix incorrect status code in broker api (#5209) @knolleary
+ - Update device agent install information and fix ffox copy text utility (#5168) @cstns
+ - Split the brokers page into components pt2 (#5197) @cstns
+ - Split the brokers hierarchy into manageable chunks (#5188) @cstns
+ - Fix position of Team Broker settings in TeamType edit dialog (#5198) @knolleary
+ - Ensure non-node modules are included in snapshot package.json (#5196) @knolleary
+ - Fix Sentry Bug - MQTT client may be null (#5181) @hardillb
+ - Allow team suspend when subscription has expired (#5172) @knolleary
+ - Test for undefinded/null not true/false in ff-listbox (#5163) @hardillb
+ - Extend invitation expiration date when resending it (#5159) @cstns
+ - Show the user's email for external invitations in the action dialogs (#5158) @joepavitt
+ - Resend team invitations (#5151) @cstns
+ - Device docs installation (#5147) @joepavitt
+ - Improve the instructions for the Device Agent onboarding (#5145) @joepavitt
+ - Replace the application activity instance selector, and FormRow dropdown with the listbox component (#4591) @cstns
+ - Reset store state on logout (#5120) @cstns
+ - Add a team link component to simplify routing (#4942) @cstns
+ - docs: First iteration of FlowFuse on OpenShift (#5138) @ppawlowski
+ - Add a new start tour button in the main dropdown menu that restarts the product tour (#5140) @cstns
+ - Filter topic hierarchy list (#5144) @cstns
+
 #### 2.14.1: Release
 
  - BUG: display the refresh button for the team-broker (#5137) @cstns

docs/user/custom-npm-packages.md

@@ -0,0 +1,114 @@
+---
+navTitle: Custom Node Packages
+---
+
+# Custom Node Packages
+
+FlowFuse has access to the wide range of Node-RED nodes listed in the
+[public catalogue](https://flows.nodered.org). But occasionally there
+will be the need for a custom node for a situation that is specific
+to your Team.
+
+If you decide to [develop](https://nodered.org/docs/creating-nodes/) your 
+own nodes, you will need somewhere to host both the node and a Node-RED 
+catalogue file. FlowFuse has two solutions for this:
+
+1. FlowFuse Hosted Nodes - Use the private NPM registry hosted by FlowFuse to store and manage your custom npm packages.
+2. Third-Party NPM Registries - If you already have a private npm registry, you can enable access to these in your Instance's settings.
+
+## FlowFuse Hosted Nodes
+
+If you want to create a Node-RED node for private use by Instances in your 
+FlowFuse Team then you can publish them to the FlowFuse Custom Node Registry 
+(available to Teams and Enterprise level teams on FlowFuse Cloud).
+
+### Publishing Nodes
+
+After developing your node you can publish it to your Teams Custom Nodes 
+registry with the following steps
+
+#### Authenticating
+
+Before publishing to the registry you need to authenticate. This step should 
+only need to be done once.
+
+The credentials can be found by navigating to the "Custom Nodes" tab under 
+the Team Library and clicking on the "Publish" button.
+
+![Publish Custom Package](./images/publish-custom-package.png){data-zoomable}{style="max-width: 600px;"}
+_Screenshot fo the "Publish Custom Package" dialog shown in the FlowFuse UI_
+
+```
+npm login --registry=https://registry.flowfuse.cloud
+```
+
+#### Packaging
+
+There are steps required to ensure your node is correctly packaged for the 
+FlowFuse Custom Nodes registry
+
+1. Make sure the package name contains the correct scope prefix e.g. 
+`@flowfuse-[team id]/node-name`. The correct prefix will be shown on the in 
+the FlowFuse application
+2. Add a `publishConfig` section with a `registry` entry
+
+
+e.g. for a Team with ID `6Rag1kQj4k`
+```json
+{
+    "name": "@flowfuse-6Rag1kQj4k/bar",
+    "version": "0.0.1",
+    "description": "...",
+    "publishConfig": {
+        "registry": "https://registry.flowfuse.cloud"
+    },
+    ...
+}
+```
+
+#### Publishing
+
+In the same directory as the `package.json` file run the following command
+
+```
+npm publish
+```
+
+Once published you should see the Node listed in the "Custom Nodes" section 
+of the Team Library.
+
+![Screenshot of the "Custom Nodes" view in the Team Library](./images/custom-node-library.png){data-zoomable}{style="max-width: 850px;"}
+_Screenshot of the "Custom Nodes" view in the Team Library_
+
+### Installing Nodes
+
+Any packages uploaded to the Team Library will be published to your Instances 
+under a custom catalogue with the name "FlowFuse Team [team name] Catalogue"
+
+![Node-RED Custom Catalogue](./images/custom-catalogue.png){data-zoomable}{style="max-width: 600px;"}
+_Screenshot of the contents of a FlowFUse catalogue appearing in the "install" tab of the Node-RED Palette Manager_
+
+## 3rd Party NPM Registries or Private npmjs.org packages
+
+The following features are available to Team and Enterprise users of FlowFuse
+Cloud.
+
+### NPM Registries
+
+If you have already published packages to an existing NPM Registry then you 
+can enable access to this by adding the required values to a `.npmrc" file
+in the Instance Settings.
+
+This can include authentication tokens to access private packages.
+
+![.npmrc file](./images/instance-settings-npmrc.png){data-zoomable}{style="max-width: 600px;"}
+_Screenshot from the FlowFuse platform, showing the input for defining an .npmrc file_
+
+### Node-RED Catalogues
+
+In order to be able to install packages in the Node-RED editor they need to 
+in a Node-RED Catalogue file that is loaded from a HTTPS URL. You can 
+supply a list of Catalogue URLs in the Instance Settings.
+
+![Node Catalogues](./images/instance-settings-catalogues.png){data-zoomable}{style="max-width: 600px;"}
+_Screenshot of the listed Node Catalogues configured on an Instance_