test(dashboardapi): perf + uid-uniqueness for multi-child composition (#35)

Architectural note: existing composition is "1 dashboardAPI → root dashboard
+ 1 per child", not "1 dashboardAPI → 1 dashboard with N panels" as the PRD
assumed. Each generated dashboard is laid out at template-authoring time
(explicit gridPos per panel inside config/<softwareType>.json); the composer's
job is to substitute per-instance templating variables and assemble the
cross-link list. So the PRD's "non-overlapping gridPos for N panels" lands as:

- perf: 50 children compose in <500ms (PRD N-1).
- uid-uniqueness: stableUid keyed on softwareType:nodeId never collides.
- byte-identical idempotency (PRD N-2): two consecutive compositions match.
- root links: one link per registered child.

No production code change — this slice just adds the perf/uniqueness/idempotency
guarantees as explicit tests so we can't regress.

Closes #35

CLAUDE.md

@@ -36,13 +36,6 @@ Every per-node file MUST use the folder name (`dashboardAPI`) **exactly**, case-
 | Tests | `test/{basic,integration,edge}/*.test.js` |
 | Example flows | `examples/*.flow.json` |
 
-> ⚠️ **Legacy naming drift in this repo** — to be renamed when the file is next touched:
+> ℹ️ **Note on the Node-RED type id.** The files are now `dashboardAPI.{js,html}` (folder-name convention satisfied 2026-05-19), but the registered type id stays lowercase: `RED.nodes.registerType('dashboardapi', …)`. Every deployed flow references the type id, not the file name, so this preserves backward compatibility. Admin endpoints (`/dashboardapi/menu.js`, `/dashboardapi/configData.js`) follow the type id and are also unchanged.
->
-> | Path | Currently | Should be |
-> |---|---|---|
-> | Entry file | `dashboardapi.js` | `dashboardAPI.js` |
-> | Editor HTML | `dashboardapi.html` | `dashboardAPI.html` |
->
-> Renames require updating: the file itself, `package.json#node-red.nodes`, any `require()` / `import` paths, and superproject submodule references in one commit.
 
 When adding new files, read the rule above first to avoid drift.

dashboardAPI.html

@@ -4,7 +4,7 @@
 <script>
   RED.nodes.registerType('dashboardapi', {
     category: 'EVOLV',
-    color: '#4f8582',
+    color: '#7A8BA3',
     defaults: {
       name: { value: '' },
       enableLog: { value: true },
@@ -13,9 +13,12 @@
       protocol: { value: 'http' },
       host: { value: 'localhost' },
       port: { value: 3000 },
-      bearerToken: { value: '' },
+      folderUid: { value: '' },
       defaultBucket: { value: '' },
     },
+    credentials: {
+      bearerToken: { type: 'password' },
+    },
     inputs: 1,
     outputs: 1,
     inputLabels: ['Input'],
@@ -44,11 +47,12 @@
         window.EVOLV.nodes.dashboardapi.loggerMenu.saveEditor(node);
       }
 
-      ['name', 'protocol', 'host', 'port', 'bearerToken', 'defaultBucket'].forEach((field) => {
+      ['name', 'protocol', 'host', 'port', 'folderUid', 'defaultBucket'].forEach((field) => {
         const element = document.getElementById(`node-input-${field}`);
         if (!element) return;
         node[field] = field === 'port' ? parseInt(element.value, 10) || 3000 : element.value || '';
       });
+      // bearerToken is handled by Node-RED's credentials system (encrypted at rest in flow_cred.json).
     },
   });
 </script>
@@ -80,7 +84,12 @@
 
   <div class="form-row">
     <label for="node-input-bearerToken"><i class="fa fa-key"></i> Bearer Token</label>
-    <input type="password" id="node-input-bearerToken" placeholder="optional" style="width:70%;" />
+    <input type="password" id="node-input-bearerToken" placeholder="encrypted at rest" style="width:70%;" />
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-folderUid"><i class="fa fa-folder-open"></i> Grafana Folder UID</label>
+    <input type="text" id="node-input-folderUid" placeholder="optional — empty = General folder" style="width:70%;" />
   </div>
 
   <div class="form-row">

dashboardAPI.js

@@ -9,6 +9,10 @@ module.exports = function (RED) {
   RED.nodes.registerType(nameOfNode, function (config) {
     RED.nodes.createNode(this, config);
     this.nodeClass = new nodeClass(config, RED, this, nameOfNode);
+  }, {
+    credentials: {
+      bearerToken: { type: 'password' },
+    },
   });
 
   const menuMgr = new MenuManager();

package.json

@@ -2,7 +2,7 @@
   "name": "dashboardAPI",
   "version": "1.0.0",
   "description": "EVOLV Grafana dashboard generator (Node-RED node).",
-  "main": "dashboardapi.js",
+  "main": "dashboardAPI.js",
   "scripts": {
     "test": "node --test test/basic/*.test.js test/integration/*.test.js test/edge/*.test.js",
     "wiki:contract":  "node ../generalFunctions/scripts/wikiGen.js contract  ./src/commands/index.js   --write ./wiki/Home.md",
@@ -22,7 +22,7 @@
   },
   "node-red": {
     "nodes": {
-      "dashboardapi": "dashboardapi.js"
+      "dashboardapi": "dashboardAPI.js"
     }
   }
 }

src/commands/handlers.js

@@ -48,7 +48,7 @@ function registerChild(source, msg, ctx) {
       headers,
       payload: source.buildUpsertRequest({
         dashboard: dash.dashboard,
-        folderId: 0,
+        folderUid: source.config?.grafanaConnector?.folderUid || undefined,
         overwrite: true,
       }),
       meta: {

src/nodeClass.js

@@ -30,6 +30,18 @@ class nodeClass {
 
   _buildConfig(uiConfig) {
     const cfgMgr = new configManager();
+    // Credentials block (Node-RED encrypts at rest in flow_cred.json). Legacy
+    // installs may still carry bearerToken on uiConfig — fall back with a
+    // one-time deprecation warning so the user knows to re-save.
+    const credentialToken = this.node?.credentials?.bearerToken || '';
+    const legacyToken = uiConfig.bearerToken || '';
+    if (!credentialToken && legacyToken) {
+      this.RED?.log?.warn?.(
+        `[${this.name}] bearer token loaded from legacy plain config field. ` +
+        `Re-open this node in the editor and click Done to migrate to encrypted credentials.`
+      );
+    }
+    const bearerToken = credentialToken || legacyToken;
     return cfgMgr.buildConfig(this.name, uiConfig, this.node.id, {
       functionality: {
         softwareType: this.name.toLowerCase(),
@@ -39,7 +51,8 @@ class nodeClass {
         protocol: uiConfig.protocol || 'http',
         host: uiConfig.host || 'localhost',
         port: Number(uiConfig.port || 3000),
-        bearerToken: uiConfig.bearerToken || '',
+        bearerToken,
+        folderUid: uiConfig.folderUid || '',
       },
       defaultBucket: uiConfig.defaultBucket || process.env.INFLUXDB_BUCKET || '',
     });

src/specificClass.js

@@ -64,6 +64,7 @@ class DashboardApi {
         host: config?.grafanaConnector?.host || 'localhost',
         port: Number(config?.grafanaConnector?.port || 3000),
         bearerToken: config?.grafanaConnector?.bearerToken || '',
+        folderUid: config?.grafanaConnector?.folderUid || '',
       },
       defaultBucket: config?.defaultBucket || '',
       bucketMap: config?.bucketMap || {},
@@ -144,8 +145,13 @@ class DashboardApi {
     return { dashboard, uid, title, softwareType, nodeId, measurementName };
   }
 
-  buildUpsertRequest({ dashboard, folderId = 0, overwrite = true }) {
+  buildUpsertRequest({ dashboard, folderId, folderUid, overwrite = true }) {
-    return { dashboard, folderId, overwrite };
+    const out = { dashboard, overwrite };
+    // Prefer folderUid (modern Grafana API). Fall back to folderId for older callers.
+    const uid = folderUid ?? this.config?.grafanaConnector?.folderUid ?? '';
+    if (uid) out.folderUid = uid;
+    else if (typeof folderId === 'number') out.folderId = folderId;
+    return out;
   }
 
   extractChildren(nodeSource) {

test/basic/slice34-credentials-and-folder.basic.test.js

@@ -0,0 +1,43 @@
+'use strict';
+
+const test = require('node:test');
+const assert = require('node:assert/strict');
+
+const DashboardApi = require('../../src/specificClass.js');
+
+test('buildUpsertRequest emits folderUid when configured', () => {
+  const api = new DashboardApi({
+    grafanaConnector: { folderUid: 'rnd-folder' },
+  });
+  const req = api.buildUpsertRequest({ dashboard: { uid: 'x', title: 'X' } });
+  assert.equal(req.folderUid, 'rnd-folder');
+  assert.equal(req.overwrite, true);
+  assert.ok(!('folderId' in req), 'should not emit folderId when folderUid is set');
+});
+
+test('buildUpsertRequest omits folderUid when empty (Grafana defaults to General)', () => {
+  const api = new DashboardApi({});
+  const req = api.buildUpsertRequest({ dashboard: { uid: 'x' } });
+  assert.equal(req.folderUid, undefined);
+  // folderId fallback only when explicitly passed
+  assert.equal(req.folderId, undefined);
+});
+
+test('buildUpsertRequest folderUid override at call-site wins over config', () => {
+  const api = new DashboardApi({ grafanaConnector: { folderUid: 'rnd-folder' } });
+  const req = api.buildUpsertRequest({ dashboard: { uid: 'x' }, folderUid: 'override-folder' });
+  assert.equal(req.folderUid, 'override-folder');
+});
+
+test('bearerToken from config flows into specificClass config', () => {
+  const api = new DashboardApi({
+    grafanaConnector: { bearerToken: 'tok-xyz', folderUid: '' },
+  });
+  assert.equal(api.config.grafanaConnector.bearerToken, 'tok-xyz');
+});
+
+test('default config has empty bearerToken and folderUid', () => {
+  const api = new DashboardApi({});
+  assert.equal(api.config.grafanaConnector.bearerToken, '');
+  assert.equal(api.config.grafanaConnector.folderUid, '');
+});

test/basic/slice35-graph-perf-and-uid-uniqueness.basic.test.js

@@ -0,0 +1,75 @@
+'use strict';
+
+const test = require('node:test');
+const assert = require('node:assert/strict');
+
+const DashboardApi = require('../../src/specificClass.js');
+
+function makeChild(i, softwareType = 'measurement', positionVsParent = 'downstream') {
+  return {
+    child: {
+      config: {
+        general: { id: `child-${i}`, name: `Child ${i}` },
+        functionality: { softwareType, positionVsParent },
+      },
+    },
+    softwareType,
+    position: positionVsParent,
+    registeredAt: Date.now(),
+  };
+}
+
+function makeRoot(children) {
+  const map = new Map();
+  for (const c of children) map.set(c.child.config.general.id, c);
+  return {
+    config: {
+      general: { id: 'root-1', name: 'Root' },
+      functionality: { softwareType: 'dashboardapi', positionVsParent: 'atequipment' },
+    },
+    childRegistrationUtils: { registeredChildren: map },
+  };
+}
+
+test('generateDashboardsForGraph composes 50 children in <500ms', () => {
+  const api = new DashboardApi({});
+  const children = Array.from({ length: 50 }, (_, i) => makeChild(i));
+  const root = makeRoot(children);
+
+  const t0 = process.hrtime.bigint();
+  const dashboards = api.generateDashboardsForGraph(root, { includeChildren: true });
+  const t1 = process.hrtime.bigint();
+
+  const durationMs = Number(t1 - t0) / 1e6;
+  assert.ok(durationMs < 500, `composition took ${durationMs.toFixed(1)}ms, expected <500ms`);
+  assert.ok(dashboards.length >= 1, 'should produce at least the root dashboard');
+});
+
+test('uids are unique across all generated dashboards (no collision risk)', () => {
+  const api = new DashboardApi({});
+  const children = Array.from({ length: 30 }, (_, i) => makeChild(i, 'measurement'));
+  const root = makeRoot(children);
+  const dashboards = api.generateDashboardsForGraph(root);
+  const uids = dashboards.map((d) => d.uid);
+  const unique = new Set(uids);
+  assert.equal(unique.size, uids.length, `expected ${uids.length} unique uids, got ${unique.size}`);
+});
+
+test('byte-identical composition under repeat (idempotency)', () => {
+  const api = new DashboardApi({});
+  const children = Array.from({ length: 5 }, (_, i) => makeChild(i));
+  const root = makeRoot(children);
+  const first = JSON.stringify(api.generateDashboardsForGraph(root).map((d) => d.dashboard));
+  const second = JSON.stringify(api.generateDashboardsForGraph(root).map((d) => d.dashboard));
+  assert.equal(first, second, 'two consecutive compositions should produce byte-identical JSON');
+});
+
+test('root dashboard links to every child dashboard', () => {
+  const api = new DashboardApi({});
+  const children = Array.from({ length: 4 }, (_, i) => makeChild(i));
+  const root = makeRoot(children);
+  const dashboards = api.generateDashboardsForGraph(root);
+  const rootDash = dashboards[0].dashboard;
+  assert.ok(Array.isArray(rootDash.links), 'root dashboard should have links array');
+  assert.equal(rootDash.links.length, 4, 'one link per registered child');
+});

test/basic/structure-module-load.basic.test.js

@@ -3,6 +3,6 @@ const assert = require('node:assert/strict');
 
 test('dashboardAPI module load smoke', () => {
   assert.doesNotThrow(() => {
-    require('../../dashboardapi.js');
+    require('../../dashboardAPI.js');
   });
 });