Scoring not run when instrument saved from the API

[driusan]

Describe the bug
When a PUT request is handled to save instrument data for the API, it calls the _save function. This bypasses the scoring, which is done through the front end with save (no underscore).

To Reproduce
Save an instrument which uses scoring with the API. Look in frontend to see if scoring was run.

What did you expect to happen?
Scoring should happen.

[xlecours]

If there is scoring happening then I think it should be a post request. But, the documentation clearly state what is to be expected when a score field is provided in the request body:
A PUT request MAY not specify score columns that will be calculated/overwriten by server-side scoring. If the client attempted to score fields client-side and the value passed by the PUT request conflict with the server-side calculation of the score, the server-side calculation will win. Any keys specified in the document PUT that do not match a corresponding field in the form MAY be ignored.

[xlecours]

Is the same fix expected for PATCH requests as well?

[GabrielPelletier]

I believe that POST is not supported for ... /candidates/$CandID/$VisitLabel/instruments/$InstrumentName.

To clarify, the issue occurs with a PUT or PATCH request without any Score fields provided in the request body. I expected the PUT or PATCH to run the scoring function, using the data that is loaded in the different fields to calculate scores and populate the score fields. The API documentation actually does not mention that a PUT/PATCH request runs the score function, so it should be added, I guess. (Yes, for both PUT and PATCH requests)

[driusan]

Why should it be a POST request? If you PUT the same content twice you should get the same score, so it is still idempotent.

I would expect the same behaviour from PATCH

[ridz1208]

@driusan @xlecours

$instrumentname = $this->_instrument->testName;
$this->_instrument->clearInstrument();
$this->_instrument->_save($data[$instrumentname]);

This is currently what the instrument endpoint does. I see 2 options here

1. call $this->_instrument->save() Which is called before _save() and has all the proper process (calculate candidate age, validate, .....)
2. add a line $this->_instrument->score(); ad the end of this section to only run the scoring.

I think #1 is the way to go but the potential issue with it is that the save() function does not expect any parameters with the instrument data like _save($data) does. If you wanna take a look here are the functions save() and _save()

[driusan]

Option 1 will not work.

save starts with:

       if ($this->form->validate()) {
            $this->form->process([&$this, '_saveValues'], true);
            $this->score();

            // determine the data entry completion status, and store that in
            // the database
            $dataEntryCompletionStatus
                = $this->_determineDataEntryCompletionStatus();
            $this->_setDataEntryCompletionStatus(
                $dataEntryCompletionStatus
            ); 
        } else {

(the else handles printing an error if validation fails). All it does is wrap Quick/LorisForm's validate function and call _saveValues and score. Calling it directly without data posted will just result in the validation failure logic always getting run.

[ridz1208]

So we should probable reproduce the functionality of save in the API class

[driusan]

Yes.