[Core] PSCID uniqueness #8411

xlecours · 2023-02-24T15:16:35Z

Brief summary of changes

Add PSCID uniqueness check to Candidate::createNew.

To test:

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

finishing tests

driusan · 2023-02-24T20:03:31Z

modules/api/php/endpoints/candidates.class.inc

@@ -241,7 +241,7 @@ class Candidates extends Endpoint implements \LORIS\Middleware\ETagCalculator
                $pscid,
                $project->getId()
            );
-        } catch (\LorisException | \InvalidArgumentException $e) {
+        } catch (\Exception | \LorisException | \InvalidArgumentException $e) {


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

When PSCID is not provided and generation is user

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

That was my question, yes.

xlecours · 2023-03-07T17:08:07Z

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

driusan · 2023-03-07T18:05:02Z

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 · 2023-03-07T19:00:22Z

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"}

modules/api/php/endpoints/candidates.class.inc

zaliqarosli · 2023-06-20T20:32:22Z

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

driusan · 2023-06-21T12:22:00Z

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 · 2023-06-22T15:06:48Z

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 · 2023-06-26T17:14:37Z

@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 · 2023-06-26T19:31:03Z

Have you run make or make dev?

zaliqarosli

tested again and it works great 💪

xlecours added 2 commits February 24, 2023 10:11

changes to Candidate class

57dc72e

catching missing pscid exception

07c0423

finishing tests

driusan reviewed Feb 24, 2023

View reviewed changes

laemtl added the Needs Work PR awaiting additional changes by the author or contains issues that the author needs to fix label Mar 7, 2023

xlecours added 2 commits March 21, 2023 12:10

removing test because of static calls

a802995

remove unwanted changes

ec8c975

xlecours marked this pull request as ready for review March 21, 2023 17:39

driusan mentioned this pull request Jun 12, 2023

[api] Able to create duplicate candidates with same PSCID #8771

Closed

zaliqarosli requested changes Jun 12, 2023

View reviewed changes

zaliqarosli linked an issue Jun 12, 2023 that may be closed by this pull request

[api] Able to create duplicate candidates with same PSCID #8771

Closed

specificaly use Conflict Exception to return 409

00c8166

driusan reviewed Jun 20, 2023

View reviewed changes

modules/api/php/endpoints/candidates.class.inc Show resolved Hide resolved

phpcs

d584813

zaliqarosli requested changes Jun 21, 2023

View reviewed changes

zaliqarosli approved these changes Jun 26, 2023

View reviewed changes

zaliqarosli added the Passed Manual Tests PR has undergone proper testing by at least one peer label Jun 26, 2023

driusan merged commit c521659 into aces:24.1-release Jun 27, 2023

ridz1208 added this to the 24.1.5 milestone Jul 10, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Core] PSCID uniqueness #8411

[Core] PSCID uniqueness #8411

xlecours commented Feb 24, 2023 •

edited

Loading

driusan Feb 24, 2023

xlecours Feb 24, 2023

xlecours Jun 20, 2023

driusan Jun 20, 2023

xlecours commented Mar 7, 2023

driusan commented Mar 7, 2023

xlecours commented Mar 7, 2023

zaliqarosli left a comment •

edited

Loading

zaliqarosli commented Jun 20, 2023

driusan commented Jun 21, 2023

zaliqarosli left a comment

xlecours commented Jun 22, 2023 •

edited

Loading

zaliqarosli commented Jun 26, 2023

driusan commented Jun 26, 2023

zaliqarosli left a comment

[Core] PSCID uniqueness #8411

[Core] PSCID uniqueness #8411

Conversation

xlecours commented Feb 24, 2023 • edited Loading

Brief summary of changes

driusan Feb 24, 2023

Choose a reason for hiding this comment

xlecours Feb 24, 2023

Choose a reason for hiding this comment

xlecours Jun 20, 2023

Choose a reason for hiding this comment

driusan Jun 20, 2023

Choose a reason for hiding this comment

xlecours commented Mar 7, 2023

driusan commented Mar 7, 2023

xlecours commented Mar 7, 2023

zaliqarosli left a comment • edited Loading

Choose a reason for hiding this comment

zaliqarosli commented Jun 20, 2023

driusan commented Jun 21, 2023

zaliqarosli left a comment

Choose a reason for hiding this comment

xlecours commented Jun 22, 2023 • edited Loading

zaliqarosli commented Jun 26, 2023

driusan commented Jun 26, 2023

zaliqarosli left a comment

Choose a reason for hiding this comment

xlecours commented Feb 24, 2023 •

edited

Loading

zaliqarosli left a comment •

edited

Loading

xlecours commented Jun 22, 2023 •

edited

Loading