[NDB_BVL_Instrument_LINST] Add Metadata Fields after adding to dictionary

[skarya22]

Brief summary of changes

• raisinbread BMI instrument was not opening due to a change I made in [NDB_BVL_Instrument] Hide inactive examiners for site from selection, unless if already selected #9416 where getExaminerFields in NDB_BVL_Instrument now relied on data being present in the instrument's dictionary.
• Unfortunately, when loading a LINST instrument with Direct Entry enabled, it would first run _addMetadataFields, and then add metadata fields to the dictionary
• _addMetadataFields would then call getExaminerFields causing it to fail, since getExaminerFields relies on the dictionary having metadata, but the metadata is added after _addMetadataFields
• The change has been made so _addMetadataFields is run after metadata is entered in the instance's dictionary. Further, metadata fields are only added to the instances dictionary if direct entry is not enabled. Otherwise they were added to the dictionary when they did not exist.

WHEN REVIEWING THIS PR, PRESS THE GEAR ICON, THEN HIDE WHITESPACE

Testing instructions (if applicable)

1. Try to open the raisinbread LINST instrument
2. See that it opens
3. Try setting direct entry to true, see that it still opens

Link(s) to related issue(s)

• Resolves [raisinbread] Can't open bmi instrument #9582, [score_instrument] test #9644

[adamdaudrich]

This was complicated !
but - Yes it makes sense to call _addMetaDataFields after building the dictionary !
However, I am getting an error, as follows :

[Tue Mar 04 19:31:14.362177 2025] [php:error] [pid 15578] [client 192.168.122.1:56428] PHP Fatal error: Uncaught TypeError: NDB_BVL_InstrumentStatus_ControlPanel::__construct(): Argument #2 ($testname) must be of type string, null given, called in /var/www/loris/php/libraries/NDB_BVL_Instrument.class.inc on line 2797 and defined in /var/www/loris/php/libraries/NDB_BVL_InstrumentStatus_ControlPanel.class.inc:57\nStack trace:\n#0 /var/www/loris/php/libraries/NDB_BVL_Instrument.class.inc(2797): NDB_BVL_InstrumentStatus_ControlPanel->__construct()\n#1 /var/www/loris/src/Middleware/UserPageDecorationMiddleware.php(266): NDB_BVL_Instrument->getControlPanel()\n#2 /var/www/loris/src/Middleware/PageDecorationMiddleware.php(59): LORIS\\Middleware\\UserPageDecorationMiddleware->process()\n#3 /var/www/loris/php/libraries/NDB_Page.class.inc(731): LORIS\\Middleware\\PageDecorationMiddleware->process()\n#4 /var/www/loris/php/libraries/NDB_BVL_Instrument.class.inc(3236): NDB_Page->process()\n#5 /var/www/loris/modules/instruments/php/module.class.inc(97): NDB_BVL_Instrument->process()\n#6 /var/www/loris/src/Middleware/ResponseGenerator.php(51): LORIS\\instruments\\Module->handle()\n#7 /var/www/loris/src/Middleware/AuthMiddleware.php(64): LORIS\\Middleware\\ResponseGenerator->process()\n#8 /var/www/loris/src/Router/ModuleRouter.php(75): LORIS\\Middleware\\AuthMiddleware->process()\n#9 /var/www/loris/src/Middleware/ExceptionHandlingMiddleware.php(55): LORIS\\Router\\ModuleRouter->handle()\n#10 /var/www/loris/src/Router/BaseRouter.php(138): LORIS\\Middleware\\ExceptionHandlingMiddleware->process()\n#11 /var/www/loris/src/Middleware/ResponseGenerator.php(51): LORIS\\Router\\BaseRouter->handle()\n#12 /var/www/loris/src/Middleware/ContentLength.php(53): LORIS\\Middleware\\ResponseGenerator->process()\n#13 /var/www/loris/htdocs/index.php(74): LORIS\\Middleware\\ContentLength->process()\n#14 {main}\n thrown in /var/www/loris/php/libraries/NDB_BVL_InstrumentStatus_ControlPanel.class.inc on line 57, referer: https://adaudrich-dev.loris.ca/instrument_list/?candID=300001&sessionID=1

[ridz1208]

Suggested change

	if ($this->DataEntryType!=="DirectEntry") {
	// The sequence of if statements below building the data dictionary is designed to
	// mimic the same logic in the _addMetadataFields() function of
	// NDB_BVL_Instrument to keep the dictionary in sync with the fields added
	// to the form, make sure to modify it accordingly
	if ($this->DataEntryType!=="DirectEntry") {

[ridz1208]

@saagar, small suggestion. I would also suggest adding a similar statement at the top of metadata fields in case someone decides to modify that part and forgets this

[saagar]

@ridz1208 -- think you have the wrong person!

[ridz1208]

@skarya22 I have not tested it but I will help Adam give it a test. For the changes themselves, I think its good enough for a bugfix. I do think a better fix is warranted for the next release and it could come with a slight refactor of some of the convoluted logic in this class.

[skarya22]

@adamdaudrich Can you let me know what you were trying to do when you received that error so I can recreate it? I can't find that error

[adamdaudrich]

@adamdaudrich Can you let me know what you were trying to do when you received that error so I can recreate it? I can't find that error

I got the controlPanel() error when loading bmi.linst. It essentially means control panel is not getting a testname (type: string).

[skarya22]

@adamdaudrich that's strange, I am able to open the bmi instrument from candidate profile with no errors :/

I opened https://my-vm-dev.loris.ca/instruments/bmi/?commentID=300010MTL01010221465351037&sessionID=10&candID=300010