[Core] PSCID uniqueness

[xlecours]

Brief summary of changes

Add PSCID uniqueness check to Candidate::createNew.

To test:

1. Make sure PSCID generation os set to user in yoru config file.
2. Create a candidate
3. try to create a second candidate with the same PSCID
4. Error should say that PSCID must be unique

[driusan]

When is a \LorisException or an \InvalidArgumentException not an \Exception?

[xlecours]

When PSCID is not provided and generation is user

[xlecours]

You mean that by adding \Exception I should remove the other two because they are subclasses?

[driusan]

That was my question, yes.

[xlecours]

@kongtiaowang would you know why this is failing? I'am not changing the file that triggers the error.

[driusan]

It looks like it's the test that you're adding in the PR that's failing?

There was 1 failure:

1) LorisApiCandidatesTest::testPostCandidatesUserGeneratedPSCID
Failed asserting that 201 matches expected 400.

/app/raisinbread/test/api/LorisApiCandidatesTest.php:405
phpvfscomposer:///app/vendor/phpunit/phpunit/phpunit:60

[xlecours]

My bad, I was looking a the warning. Thanks, I'll look into it.

[zaliqarosli]

API docs says PSCID uniqueness throws 409 but i believe this throws 400. can we resolve this either in the docs or in the endpoint?

otherwise, the code does work to not let candidate creation happen if PSCID already exists

curl -H "Authorization: Bearer $token" https://copn-stg.loris.ca/api/v0.0.3/candidates -d '{"Candidate":{"PSCID":"MNI0054","Project":"COPN","Site":"Montreal Neurological Institute","DoB":"1998-01","Sex":"Female"}}'
{"error":"PSCID must be unique"}

[zaliqarosli]

@xlecours i can review/test once testing is fixed/passes

[driusan]

Looks like it's just PHPCS:

FILE: ...nner/work/Loris/Loris/php/exceptions/ConflictException.class.inc
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 7 | ERROR | [x] Tag value for @license tag indented incorrectly;
   |       |     expected 1 spaces but found 2
----------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------

[zaliqarosli]

duplicate PSCID is not created but no error is thrown

lorisadmin@copn-dev:/var/www/loris/project$ curl -H "Authorizatio/api/v0.0.3/candidates -d '{"Candidate":{"PSCID":"MNI0054","Project":"COPN","Site":"Montreal Neurological Institute","DoB":"1998-01-01","Sex":"Female"}}'
{"CandID":"148989","Project":"COPN","PSCID":"MNI0054","Site":"Montreal Neurological Institute","EDC":null,"DoB":"1998-01-01","Sex":"Female"}
lorisadmin@copn-dev:/var/www/loris/project$ curl -H "Authorization: Bearer $/api/v0.0.3/candidates -d '{"Candidate":{"PSCID":"MNI0054","Project":"COPN","Site":"Montreal Neurological Institute","DoB":"1998-01-01","Sex":"Female"}}'

[xlecours]

duplicate PSCID is not created but no error is thrown

@zaliqarosli Can you try with -v curl option and the apache error log if any please?

[zaliqarosli]

@xlecours 500 error, Conflict Exception class not found ..

[Mon Jun 26 13:07:31.861163 2023] [php:error] [pid 2258] [client 192.168.122.1:42732] PHP Fatal error:  Uncaught Error: Class "ConflictException" not found in /var/www/loris/project/libraries/Candidate.class.inc:276\nStack trace:\n#0 /var/www/loris/project/modules/api/php/endpoints/candidates.class.inc(242): Candidate::createNew()\n#1 /var/www/loris/project/modules/api/php/endpoints/candidates.class.inc(107): LORIS\\api\\Endpoints\\Candidates->_handlePOST()\n#2 /var/www/loris/src/Middleware/ETag.php(78): LORIS\\api\\Endpoints\\Candidates->handle()\n#3 /var/www/loris/src/Http/Endpoint.php(46): LORIS\\Middleware\\ETag->process()\n#4 /var/www/loris/project/modules/api/php/endpoint.class.inc(65): LORIS\\Http\\Endpoint->process()\n#5 /var/www/loris/project/modules/api/php/module.class.inc(125): LORIS\\Api\\Endpoint->process()\n#6 /var/www/loris/src/Router/ModuleRouter.php(77): LORIS\\api\\Module->handle()\n#7 /var/www/loris/src/Middleware/ExceptionHandlingMiddleware.php(54): LORIS\\Router\\ModuleRouter->handle()\n#8 /var/www/loris/src/Router/BaseRouter.php(126): LORIS\\Middleware\\ExceptionHandlingMiddleware->process()\n#9 /var/www/loris/src/Middleware/ResponseGenerator.php(50): LORIS\\Router\\BaseRouter->handle()\n#10 /var/www/loris/src/Middleware/ContentLength.php(52): LORIS\\Middleware\\ResponseGenerator->process()\n#11 /var/www/loris/htdocs/index.php(55): LORIS\\Middleware\\ContentLength->process()\n#12 {main}\n  thrown in /var/www/loris/project/libraries/Candidate.class.inc on line 276
[Mon Jun 26 13:07:31.861343 2023] [php:notice] [pid 2258] [client 192.168.122.1:42732] [CRITICAL] /var/www/loris/project/libraries/Candidate.class.inc:276: Uncaught Error: Class "ConflictException" not found in /var/www/loris/project/libraries/Candidate.class.inc:276\nStack trace:\n#0 /var/www/loris/project/modules/api/php/endpoints/candidates.class.inc(242): Candidate::createNew()\n#1 /var/www/loris/project/modules/api/php/endpoints/candidates.class.inc(107): LORIS\\api\\Endpoints\\Candidates->_handlePOST()\n#2 /var/www/loris/src/Middleware/ETag.php(78): LORIS\\api\\Endpoints\\Candidates->handle()\n#3 /var/www/loris/src/Http/Endpoint.php(46): LORIS\\Middleware\\ETag->process()\n#4 /var/www/loris/project/modules/api/php/endpoint.class.inc(65): LORIS\\Http\\Endpoint->process()\n#5 /var/www/loris/project/modules/api/php/module.class.inc(125): LORIS\\Api\\Endpoint->process()\n#6 /var/www/loris/src/Router/ModuleRouter.php(77): LORIS\\api\\Module->handle()\n#7 /var/www/loris/src/Middleware/ExceptionHandlingMiddleware.php(54): LORIS\\Router\\ModuleRouter->handle()\n#8 /var/www/loris/src/Router/BaseRouter.php(126): LORIS\\Middleware\\ExceptionHandlingMiddleware->process()\n#9 /var/www/loris/src/Middleware/ResponseGenerator.php(50): LORIS\\Router\\BaseRouter->handle()\n#10 /var/www/loris/src/Middleware/ContentLength.php(52): LORIS\\Middleware\\ResponseGenerator->process()\n#11 /var/www/loris/htdocs/index.php(55): LORIS\\Middleware\\ContentLength->process()\n#12 {main}\n  thrown

this might be specific to my set up. i'll look into it, but anything obvious sticking out to you?

[driusan]

Have you run make or make dev?

[zaliqarosli]

tested again and it works great 💪