[Consent] New module #7583

CamilleBeau · 2021-09-24T18:20:23Z

Brief summary of changes

#7363
New module for consent and eConsent. See "README.md" for more information

Have you updated related documentation?

Testing instructions (if applicable)

Run patches & make sure to compile before testing.
See TestPlan

modules/consent/jsx/consentEntry.js

zaliqarosli

initial comments

SQL/New_patches/2021-09-22-ConsentModule.sql

zaliqarosli · 2021-10-01T21:22:36Z

SQL/New_patches/2021-09-22-ConsentModule.sql

+  `ConsentGroupID` int(10) unsigned NOT NULL,
+  `CenterID` int(10) unsigned DEFAULT NULL,
+  `ConsentDisplayID` int(10) unsigned NOT NULL,
+  CONSTRAINT `FK_consent_group_consent_display_rel_1` FOREIGN KEY (`ConsentGroupID`) REFERENCES `consent_group` (`ConsentGroupID`) ON DELETE CASCADE ON UPDATE CASCADE,


would be good to specifiy what the primary keys are here

Most rel tables have every field as a primary key. However, in this case CenterID can not be included in the primary key since it is nullable. It also cannot be (ConsentGroupID,ConsentDisplayID) because it's possible that these columns will need to hold the same values with a different CenterID. Do you have a suggestion for what the primary key should be? I think it would be good to have a constraint that ensures no duplicate rows are entered in this table but I'm having some trouble implementing it

sounds like the PK combination needs to be (ConsentGroupID,ConsentDisplayID,CenterID). Is there a reason why CenterID is nullable?

Null CenterID is default, i.e. it represents all sites. The CenterID would not be null if there is a site-specific change in the consent form. For example, if all sites have the same consent form except for site A, then there would be a row with a null CenterID linking to the general consent form, and a row with the CenterID for site A linking to the site-specific consent form.

SQL/New_patches/2021-09-22-ConsentModule.sql

zaliqarosli · 2021-10-01T21:29:02Z

SQL/New_patches/2021-09-22-ConsentModule.sql

+
+-- Relates different sites and consent groups to their 
+-- respective displays
+CREATE TABLE `consent_display_rel` (


so a consent group can have multiple displays and display IDs can also be attached to different consent groups right?

can you give me an example of this?

For example, for CTU, the REB for UBC has approved different wording in the eConsent form than other sites. There are also different acknowledgements that the candidate has to submit. These are all written in the z-json, so a different file is written for sites that have unique needs. This table points to the right row in consent_display that holds the name of the zjson file relevant to that site. It is possible that multiple sites will have the same form, whereas others have a different form, so multiple sites may need to link to the same display. Null centerID indicates the default (we discussed this in one of our meetings). However, I don't see a reason why different consent groups would need the same display although I suppose if it's a generic display where people want wording such as "Please enter consent for the following:", then it is possible.

as far as i can understand, it looks like there is a many to many relationship between consent group and displays, when there should maybe be a 1 to many in the direction of 1 consent group to many displays (based on site). is this something you could address if you haven't already?

zaliqarosli · 2021-10-01T21:38:04Z

SQL/New_patches/2021-09-22-ConsentModule.sql

+  `CandidateID` int(6) NOT NULL,
+  `ConsentGroupID` integer unsigned NOT NULL,


I wonder if this should be DirectConsentID as the primary key, that is referenced as a foreign key from the candidate_consent_rel table i.e. add DirectConsentID as a column in the candidate_consent_rel table.

did we already discuss that option and shut it down for a reason?

No I don't think we discussed that option

Just thought about this a bit more. I'm not sure that candidate_consent_rel is the best place to have a DirectConsentID since entries in the candidate_consent_rel are not necessarily eConsent related, and also the table is not organized by consent group. I feel like it complicates the use of the tables

DirectConsentID here would be for the direct_consent table, not the candidate_consent_rel table

modules/consent/php/consentdatahandler.class.inc

kongtiaowang · 2024-01-15T19:10:46Z

php/libraries/Candidate.class.inc

-        $query = "SELECT ConsentID, Name, Status, DateGiven, DateWithdrawn, Label
-            FROM candidate_consent_rel cc JOIN consent c USING (ConsentID)
-            WHERE CandidateID=:cid";
+        $query = "SELECT 


@CamilleBeau please update the unittest in the /var/www/loris/test/unittests/CandidateTest.php line 1052 to 1065
$result = [
['ConsentID' => 1,
'Name' => 'name1',
'Status' => 'done',
'DateGiven' => 'today',
'DateWithdrawn' => 'tomorrow',
'Label' => 'label',
'Comment' => 'comment'
]
];

$this->_dbMock->expects($this->once()) ->method('pselectWithIndexKey') ->with( $this->stringContains( "SELECT ConsentID, Name, Status, DateGiven, DateWithdrawn, Label, Comment" ) ) ->willReturn($result);

Thanks so much for your help @kongtiaowang !! Unfortunately I made this change but am still getting a similar failure in the tests

kongtiaowang · 2024-01-18T16:49:44Z

@CamilleBeau
kongtiaowang#383
the last two commits fixed the issue

CamilleBeau · 2024-01-23T15:37:33Z

@kongtiaowang Thanks for your help, I added the changes from those 2 commits but I'm still getting the error in test suite

kongtiaowang · 2024-11-11T18:51:10Z

SQL/9999-99-99-drop_tables.sql

@@ -213,6 +213,9 @@ DROP TABLE IF EXISTS `psc`;
 DROP TABLE IF EXISTS `visit_project_cohort_rel`;
 DROP TABLE IF EXISTS `visit`;
 DROP TABLE IF EXISTS `project_cohort_rel`;
+DROP TABLE IF EXISTS `consent_display_rel`;


Missing "candidate_consent_history" in the drop table list.

kongtiaowang · 2024-11-11T20:49:43Z

SQL/0000-00-00-schema.sql

@@ -2297,8 +2297,9 @@ CREATE TABLE `candidate_consent_rel` (
  `CandidateID` int(6) NOT NULL,
  `ConsentID` integer unsigned NOT NULL,
  `Status` enum('yes','no', 'not_applicable') DEFAULT NULL,
-  `DateGiven` date DEFAULT NULL,
-  `DateWithdrawn` date DEFAULT NULL,
+  `DateGiven` datetime DEFAULT NULL,


rm line 2308-2359 "candidate_consent_history" create table twice.

CamilleBeau commented Sep 24, 2021

View reviewed changes

modules/consent/jsx/consentEntry.js Show resolved Hide resolved

zaliqarosli self-requested a review September 27, 2021 18:52

zaliqarosli reviewed Oct 1, 2021

View reviewed changes

CamilleBeau commented Oct 15, 2021

View reviewed changes

modules/consent/php/consentdatahandler.class.inc Outdated Show resolved Hide resolved

CamilleBeau commented Oct 15, 2021

View reviewed changes

modules/consent/php/consentdatahandler.class.inc Outdated Show resolved Hide resolved

maltheism added the Needs Rebase PR contains conflicts with the current target branch or was issued to the wrong branch label Oct 17, 2022

CamilleBeau added the Needs Work PR awaiting additional changes by the author or contains issues that the author needs to fix label Dec 1, 2022

cmadjar assigned CamilleBeau Dec 6, 2022

CamilleBeau added Needs Rebase PR contains conflicts with the current target branch or was issued to the wrong branch and removed Needs Rebase PR contains conflicts with the current target branch or was issued to the wrong branch labels Dec 6, 2022

CamilleBeau force-pushed the 2021_09_22_Consent_module branch from 993abf2 to 70a4f7f Compare December 21, 2023 19:50

CamilleBeau removed Needs Rebase PR contains conflicts with the current target branch or was issued to the wrong branch Needs Work PR awaiting additional changes by the author or contains issues that the author needs to fix labels Dec 21, 2023

kongtiaowang reviewed Jan 16, 2024

View reviewed changes

ridz1208 added the Priority: High PR or issue should be prioritised over others for review and testing label Jul 2, 2024

ridz1208 assigned regisoc Jul 2, 2024

CamilleBeau and others added 12 commits July 8, 2024 15:36

Adding module

d212a5f

Add raisinbread changes + phpcs

a1f004e

Add README, fix doctypes

45b5d7b

Cleanup

9f29137

Update SQL and phan fixes

476649c

Updates

d6fc084

Changes from Jess' CCNA code review

19a2edb

ExpireConsent message

dedd7ea

phan fix

fe47d6a

Update modules/consent/php/consentdatahandler.class.inc

7e59503

Update modules/consent/php/consentdatahandler.class.inc

4dc4c3e

Line too long

766dc53

CamilleBeau and others added 14 commits July 8, 2024 15:41

phpcs

199693e

small changes

82397d5

Update

0fa0561

phan

08a11c8

Phan pt 2

1de59b9

Phan js changes

b0f4bb5

Add PropTypes import & candidate test change

36ea7bc

Candidate test

3097090

Some more js changes, gitignore

636b9a0

leftover changes in js

562c6ca

CandidateTest

31a6c8d

Update CandidateTest.php

6207abb

Update Candidate.class.inc

d235a68

Update permission description

b5aef9e

CamilleBeau force-pushed the 2021_09_22_Consent_module branch from 7bf6386 to b5aef9e Compare July 8, 2024 19:49

driusan mentioned this pull request Sep 24, 2024

[candidate_profile] Can see consent card without Candidate Parameters permissions #8709

Open

CamilleBeau and others added 3 commits October 29, 2024 14:41

Merge branch 'main' into 2021_09_22_Consent_module

128318c

Add phpcs changes

093aeb8

fixing some errors

c21e32f

kongtiaowang reviewed Nov 11, 2024

View reviewed changes

CamilleBeau added 2 commits November 18, 2024 11:21

Fix drop statements / schema

1510d5b

Try allHistory

db87ad4

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Consent] New module #7583

[Consent] New module #7583

CamilleBeau commented Sep 24, 2021 •

edited

Loading

zaliqarosli left a comment

zaliqarosli Oct 1, 2021

CamilleBeau Oct 5, 2021

zaliqarosli Nov 8, 2021

CamilleBeau Nov 23, 2021

zaliqarosli Oct 1, 2021

CamilleBeau Oct 5, 2021

zaliqarosli Oct 5, 2021

CamilleBeau Oct 5, 2021

zaliqarosli Nov 8, 2021

zaliqarosli Oct 1, 2021

CamilleBeau Oct 5, 2021

CamilleBeau Oct 5, 2021

zaliqarosli Nov 8, 2021 •

edited

Loading

kongtiaowang Jan 15, 2024

CamilleBeau Jan 16, 2024

kongtiaowang commented Jan 18, 2024

CamilleBeau commented Jan 23, 2024

kongtiaowang Nov 11, 2024

kongtiaowang Nov 11, 2024

		`CandidateID` int(6) NOT NULL,
		`ConsentGroupID` integer unsigned NOT NULL,

[Consent] New module #7583

Are you sure you want to change the base?

[Consent] New module #7583

Conversation

CamilleBeau commented Sep 24, 2021 • edited Loading

Brief summary of changes

Testing instructions (if applicable)

zaliqarosli left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zaliqarosli Nov 8, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kongtiaowang commented Jan 18, 2024

CamilleBeau commented Jan 23, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CamilleBeau commented Sep 24, 2021 •

edited

Loading

zaliqarosli Nov 8, 2021 •

edited

Loading