subscribe in one go

Author: rerpha

app/components/Instrument.test.ts

@@ -7,7 +7,7 @@ import {
   RC_INRANGE,
   SP_RBV,
   storePrecision,
-  subscribeToBlockPVs,
+  getExtraPVsForBlock,
   toPrecision,
   yesToBoolean,
 } from "@/app/components/Instrument";
@@ -18,8 +18,6 @@ import {
   IfcGroup,
   IfcPV,
   IfcPVWSMessage,
-  IfcPVWSRequest,
-  PVWSRequestType,
 } from "@/app/types";
 
 test("findPVinDashboard finds a pv in the dashboard and returns it", () => {
@@ -109,20 +107,6 @@ test("findPVInGroups returns a block when it finds one", () => {
   findPVInGroups(groups, prefix, prefix + CSSB + blockName);
 });
 
-test("subscribeToBlockPVs subscribes to all run control PVs", () => {
-  const mockSendJsonMessage = jest.fn();
-  const aBlock = "INST:CS:SB:SomeBlock";
-  subscribeToBlockPVs(mockSendJsonMessage, aBlock);
-  expect(mockSendJsonMessage.mock.calls.length).toBe(1);
-  const expectedCall: IfcPVWSRequest = {
-    type: PVWSRequestType.subscribe,
-    pvs: [aBlock, aBlock + RC_ENABLE, aBlock + RC_INRANGE, aBlock + SP_RBV],
-  };
-  expect(JSON.stringify(mockSendJsonMessage.mock.calls[0][0])).toBe(
-    JSON.stringify(expectedCall),
-  );
-});
-
 test("toPrecision does nothing to string value ", () => {
   const expectedValue = "untouched";
   const aBlock: IfcBlock = {
@@ -165,8 +149,6 @@ test("yesToBoolean works with NO as value", () => {
 test("getGroupsWithBlocksFromConfigOutput gets blocks from blockserver groups", () => {
   const blockNameToTest = "aBlock";
   const groupNameToTest = "aGroup";
-  const prefix = "TESTING";
-  const mockSendJsonMessage = jest.fn();
 
   const configOutput: ConfigOutput = {
     groups: [{ blocks: [blockNameToTest], name: groupNameToTest }],
@@ -200,20 +182,14 @@ test("getGroupsWithBlocksFromConfigOutput gets blocks from blockserver groups",
   };
   const groups = getGroupsWithBlocksFromConfigOutput(
     configOutput,
-    mockSendJsonMessage,
-    prefix,
   );
   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 mockSendJsonMessage = jest.fn();
   const blockAddress = "IN:INST:CS:SB:Block1";
-  subscribeToBlockPVs(mockSendJsonMessage, blockAddress);
-  expect(mockSendJsonMessage).toBeCalledTimes(1);
-  const call: Array<string> = mockSendJsonMessage.mock.calls[0][0].pvs;
-  expect(call).toEqual(
+  expect(getExtraPVsForBlock( blockAddress)).toEqual(
     expect.arrayContaining([
       blockAddress,
       blockAddress + RC_ENABLE,

app/components/Instrument.ts

@@ -211,34 +211,33 @@ export function toPrecision(
     : pvVal;
 }
 
-export function storePrecision(updatedPV: IfcPVWSMessage, block: IfcBlock) {
+export function storePrecision(
+  updatedPV: IfcPVWSMessage,
+  block: IfcBlock,
+): void {
   const prec = updatedPV.precision;
   if (prec != null && prec > 0 && !block.precision) {
     // this is likely the first update, and contains precision information which is not repeated on a normal value update - store this in the block for later truncation (see below)
     block.precision = prec;
   }
 }
 
-export function yesToBoolean(pvVal: string | number) {
+export function yesToBoolean(pvVal: string | number): boolean {
   return pvVal == "YES";
 }
 
-export function subscribeToBlockPVs(
-  sendJsonMessage: (a: IfcPVWSRequest) => void,
+export function getExtraPVsForBlock(
   block_address: string,
-) {
+): Array<string> {
   /**
-   * Subscribes to a block and its associated run control PVs
+   * Given a block name, give the run control and sp_rbv PVs.
    */
-  sendJsonMessage({
-    type: PVWSRequestType.subscribe,
-    pvs: [
+  return [
       block_address,
       block_address + RC_ENABLE,
       block_address + RC_INRANGE,
       block_address + SP_RBV,
-    ],
-  });
+    ];
 }
 
 /**
@@ -247,17 +246,15 @@ export function subscribeToBlockPVs(
  */
 export function getGroupsWithBlocksFromConfigOutput(
   configOutput: ConfigOutput,
-  sendJsonMessage: (a: IfcPVWSRequest) => void,
-  prefix: string,
 ): Array<IfcGroup> {
-  const groups = configOutput.groups;
+  const configOutputGroups = configOutput.groups;
   let newGroups: Array<IfcGroup> = [];
-  for (const group of groups) {
-    const groupName = group.name;
+  for (const configOutputGroup of configOutputGroups) {
+    const groupName = configOutputGroup.name;
     let blocks: Array<IfcBlock> = [];
-    for (const block of group.blocks) {
+    for (const configOutputBlock of configOutputGroup.blocks) {
       const newBlock = configOutput.blocks.find(
-        (b: ConfigOutputBlock) => b.name === block,
+        (b: ConfigOutputBlock) => b.name === configOutputBlock,
       );
       if (newBlock) {
         blocks.push({
@@ -267,8 +264,6 @@ export function getGroupsWithBlocksFromConfigOutput(
           high_rc: newBlock.highlimit,
           visible: newBlock.visible,
         });
-        const fullyQualifiedBlockPVAddress = prefix + CSSB + newBlock.name;
-        subscribeToBlockPVs(sendJsonMessage, fullyQualifiedBlockPVAddress);
       }
     }
     newGroups.push({

app/components/InstrumentData.tsx

@@ -1,7 +1,8 @@
 "use client";
 import { useEffect, useState } from "react";
-import { IfcPVWSMessage, IfcPVWSRequest, PVWSRequestType } from "@/app/types";
+import {IfcBlock, IfcGroup, IfcPV, IfcPVWSMessage, IfcPVWSRequest, PVWSRequestType} from "@/app/types";
 import {
+  CSSB,
   findPVInDashboard,
   findPVInGroups,
   getGroupsWithBlocksFromConfigOutput,
@@ -10,6 +11,7 @@ import {
   RC_INRANGE,
   SP_RBV,
   storePrecision,
+  getExtraPVsForBlock,
   toPrecision,
   yesToBoolean,
 } from "@/app/components/Instrument";
@@ -69,25 +71,18 @@ export function InstrumentData({ instrumentName }: { instrumentName: string }) {
       const updatedPVbytes: string | null | undefined = updatedPV.b64byt;
 
       if (updatedPVName == instListPV && updatedPVbytes != null) {
-        const instlist = instListFromBytes(updatedPVbytes);
-        const prefix = getPrefix(instlist, instName);
+        const prefix = getPrefix(instListFromBytes(updatedPVbytes), instName);
         const instrument = new Instrument(prefix);
         setCurrentInstrument(instrument);
 
+        // subscribe to dashboard and run info PVs
         sendJsonMessage({
           type: PVWSRequestType.subscribe,
-          pvs: [`${prefix}${CONFIG_DETAILS}`],
+          pvs: instrument.runInfoPVs
+            .concat(instrument.dashboard.flat(3))
+            .map((v: IfcPV) => v.pvaddress)
+            .concat([`${prefix}${CONFIG_DETAILS}`]),
         });
-
-        // subscribe to dashboard and run info PVs
-        for (const pv of instrument.runInfoPVs.concat(
-          instrument.dashboard.flat(3),
-        )) {
-          sendJsonMessage({
-            type: PVWSRequestType.subscribe,
-            pvs: [pv.pvaddress],
-          });
-        }
         return;
       }
 
@@ -108,9 +103,19 @@ export function InstrumentData({ instrumentName }: { instrumentName: string }) {
         const res = dehex_and_decompress(atob(updatedPVbytes));
         currentInstrument.groups = getGroupsWithBlocksFromConfigOutput(
           JSON.parse(res),
-          sendJsonMessage,
-          currentInstrument.prefix,
         );
+
+        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
+        });
+
       } else {
         const pvVal = getPvValue(updatedPV);