refactor PV list getting out to function, add test for it

Author: rerpha

app/components/Instrument.test.ts

@@ -10,6 +10,8 @@ import {
   getExtraPVsForBlock,
   toPrecision,
   yesToBoolean,
+  getAllBlockPVs,
+  Instrument,
 } from "@/app/components/Instrument";
 import {
   ConfigOutput,
@@ -180,16 +182,14 @@ test("getGroupsWithBlocksFromConfigOutput gets blocks from blockserver groups",
     component_iocs: [],
     history: [],
   };
-  const groups = getGroupsWithBlocksFromConfigOutput(
-    configOutput,
-  );
+  const groups = getGroupsWithBlocksFromConfigOutput(configOutput);
   expect(groups[0].name).toBe(groupNameToTest);
   expect(groups[0].blocks[0].human_readable_name).toBe(blockNameToTest);
 });
 
 test("subscribeToBlockPVs subscribes to blocks, their run control and their SP:RBV PVs", () => {
   const blockAddress = "IN:INST:CS:SB:Block1";
-  expect(getExtraPVsForBlock( blockAddress)).toEqual(
+  expect(getExtraPVsForBlock(blockAddress)).toEqual(
     expect.arrayContaining([
       blockAddress,
       blockAddress + RC_ENABLE,
@@ -210,3 +210,49 @@ test("storePrecision adds precision to a block if it is the first update", () =>
   storePrecision(message, blockWithoutPrecision);
   expect(blockWithoutPrecision.precision).toEqual(precision);
 });
+
+test("getAllBlockPVs returns flat list of blocks, their RC and SPRBV pvs", () => {
+  const block1Name = "blockName";
+  const block2Name = "block2Name";
+  const prefix = "IN:TEST:";
+
+  let inst = new Instrument(prefix);
+
+  inst.groups = [
+    {
+      name: "aGroup",
+      blocks: [
+        {
+          human_readable_name: block1Name,
+          pvaddress: "some:underlying:pv:name",
+        },
+      ],
+    },
+    {
+      name: "aDifferentGroup",
+      blocks: [
+        {
+          human_readable_name: block2Name,
+          pvaddress: "someother:underlying:pv:name",
+        },
+      ],
+    },
+  ];
+
+  const res = getAllBlockPVs(inst);
+
+  expect(res.length).toBe(2 * 4); // 2 blocks, which means 4 PVs to subscribe to
+
+  expect(res).toEqual(
+    expect.arrayContaining([
+      prefix + CSSB + block1Name,
+      prefix + CSSB + block1Name + RC_ENABLE,
+      prefix + CSSB + block1Name + RC_INRANGE,
+      prefix + CSSB + block1Name + SP_RBV,
+      prefix + CSSB + block2Name,
+      prefix + CSSB + block2Name + RC_ENABLE,
+      prefix + CSSB + block2Name + RC_INRANGE,
+      prefix + CSSB + block2Name + SP_RBV,
+    ]),
+  );
+});

app/components/Instrument.ts

@@ -6,8 +6,6 @@ import {
   IfcGroup,
   IfcPV,
   IfcPVWSMessage,
-  IfcPVWSRequest,
-  PVWSRequestType,
 } from "@/app/types";
 import {
   ExponentialOnThresholdFormat,
@@ -226,18 +224,16 @@ export function yesToBoolean(pvVal: string | number): boolean {
   return pvVal == "YES";
 }
 
-export function getExtraPVsForBlock(
-  block_address: string,
-): Array<string> {
+export function getExtraPVsForBlock(block_address: string): Array<string> {
   /**
    * Given a block name, give the run control and sp_rbv PVs.
    */
   return [
-      block_address,
-      block_address + RC_ENABLE,
-      block_address + RC_INRANGE,
-      block_address + SP_RBV,
-    ];
+    block_address,
+    block_address + RC_ENABLE,
+    block_address + RC_INRANGE,
+    block_address + SP_RBV,
+  ];
 }
 
 /**
@@ -286,3 +282,15 @@ export function findPVInGroups(
         updatedPVName == prefix + CSSB + block.human_readable_name,
     );
 }
+
+export function getAllBlockPVs(currentInstrument: Instrument): Array<string> {
+  return currentInstrument.groups
+    .map((g: IfcGroup) => g.blocks)
+    .flat(1) // flatten to a big array of blocks
+    .map((b: IfcBlock) =>
+      getExtraPVsForBlock(
+        currentInstrument.prefix + CSSB + b.human_readable_name,
+      ),
+    )
+    .flat(1); //flatten block, rc, sp_rbv pvs for every block to a 1d array
+}

app/components/InstrumentData.tsx

@@ -1,17 +1,21 @@
 "use client";
 import { useEffect, useState } from "react";
-import {IfcBlock, IfcGroup, IfcPV, IfcPVWSMessage, IfcPVWSRequest, PVWSRequestType} from "@/app/types";
 import {
-  CSSB,
+  IfcPV,
+  IfcPVWSMessage,
+  IfcPVWSRequest,
+  PVWSRequestType,
+} from "@/app/types";
+import {
   findPVInDashboard,
   findPVInGroups,
+  getAllBlockPVs,
   getGroupsWithBlocksFromConfigOutput,
   Instrument,
   RC_ENABLE,
   RC_INRANGE,
   SP_RBV,
   storePrecision,
-  getExtraPVsForBlock,
   toPrecision,
   yesToBoolean,
 } from "@/app/components/Instrument";
@@ -100,22 +104,14 @@ export function InstrumentData({ instrumentName }: { instrumentName: string }) {
           return;
         }
         setLastUpdate(updatedPVbytes);
-        const res = dehex_and_decompress(atob(updatedPVbytes));
         currentInstrument.groups = getGroupsWithBlocksFromConfigOutput(
-          JSON.parse(res),
+          JSON.parse(dehex_and_decompress(atob(updatedPVbytes))),
         );
 
         sendJsonMessage({
           type: PVWSRequestType.subscribe,
-          pvs: currentInstrument.groups
-            .map((g: IfcGroup) => g.blocks)
-            .flat(1)  // flatten to a big array of blocks
-            .map((b: IfcBlock) =>
-              getExtraPVsForBlock(
-                  currentInstrument.prefix + CSSB + b.human_readable_name
-            )).flat(1), //flatten block, rc, sp_rbv pvs for every block to a 1d array
+          pvs: getAllBlockPVs(currentInstrument),
         });
-
       } else {
         const pvVal = getPvValue(updatedPV);