-
Notifications
You must be signed in to change notification settings - Fork 13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: update form timer to handle groups #4437
Open
thiessenp-cds
wants to merge
13
commits into
main
Choose a base branch
from
fix/form-timer-update
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+319
−15
Open
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
1f40415
Initial commit
thiessenp-cds 268d987
Adds back some comments
thiessenp-cds 4d51166
Refactors to use a formDelay context
thiessenp-cds a6bdbed
updates comments
thiessenp-cds 0f2df3f
Merge branch 'main' into fix/form-timer-update
thiessenp-cds 322675c
Fixes a few typos
thiessenp-cds 187e821
Adds some basic logging
thiessenp-cds c9a7f81
Adds unit tests
thiessenp-cds 2cd4701
Merge branch 'main' into fix/form-timer-update
thiessenp-cds a49be31
Simplifies start time
thiessenp-cds ab52e47
Updates logger to be off by default
thiessenp-cds 13e3c4f
Updates comments and debugging
thiessenp-cds a9266a0
Updates comments
thiessenp-cds File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,114 @@ | ||
{ | ||
"formElementsNonGroups": [ | ||
{ | ||
"id": 1, | ||
"type": "textField", | ||
"properties": { | ||
"choices": [ | ||
{ | ||
"en": "", | ||
"fr": "" | ||
} | ||
], | ||
"titleEn": "Q1", | ||
"titleFr": "1", | ||
"validation": { | ||
"required": true | ||
}, | ||
"subElements": [], | ||
"descriptionEn": "", | ||
"descriptionFr": "", | ||
"placeholderEn": "", | ||
"placeholderFr": "" | ||
} | ||
}, | ||
{ | ||
"id": 2, | ||
"type": "textField", | ||
"properties": { | ||
"choices": [ | ||
{ | ||
"en": "", | ||
"fr": "" | ||
} | ||
], | ||
"titleEn": "Q2", | ||
"titleFr": "1", | ||
"validation": { | ||
"required": false | ||
}, | ||
"subElements": [], | ||
"descriptionEn": "", | ||
"descriptionFr": "", | ||
"placeholderEn": "", | ||
"placeholderFr": "" | ||
} | ||
}, | ||
{ | ||
"id": 3, | ||
"type": "textField", | ||
"properties": { | ||
"choices": [ | ||
{ | ||
"en": "", | ||
"fr": "" | ||
} | ||
], | ||
"titleEn": "Q3", | ||
"titleFr": "1", | ||
"validation": { | ||
"required": true | ||
}, | ||
"subElements": [], | ||
"descriptionEn": "", | ||
"descriptionFr": "", | ||
"placeholderEn": "", | ||
"placeholderFr": "" | ||
} | ||
}, | ||
{ | ||
"id": 4, | ||
"type": "textField", | ||
"properties": { | ||
"choices": [ | ||
{ | ||
"en": "", | ||
"fr": "" | ||
} | ||
], | ||
"titleEn": "Q4", | ||
"titleFr": "1", | ||
"validation": { | ||
"required": true | ||
}, | ||
"subElements": [], | ||
"descriptionEn": "", | ||
"descriptionFr": "", | ||
"placeholderEn": "", | ||
"placeholderFr": "" | ||
} | ||
}, | ||
{ | ||
"id": 5, | ||
"type": "textField", | ||
"properties": { | ||
"choices": [ | ||
{ | ||
"en": "", | ||
"fr": "" | ||
} | ||
], | ||
"titleEn": "Q5 (not required)", | ||
"titleFr": "1", | ||
"validation": { | ||
"required": false | ||
}, | ||
"subElements": [], | ||
"descriptionEn": "", | ||
"descriptionFr": "", | ||
"placeholderEn": "", | ||
"placeholderFr": "" | ||
} | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,118 @@ | ||
import { logMessage } from "@lib/logger"; | ||
import { FormElement, FormProperties } from "@lib/types"; | ||
import { createContext, useContext, useState } from "react"; | ||
|
||
interface FormDelay { | ||
startTime: number; | ||
requiredQuestions: number; | ||
} | ||
|
||
const timerDefault: FormDelay = { | ||
startTime: 0, | ||
requiredQuestions: 0, | ||
}; | ||
|
||
const FormDelayContext = createContext<{ | ||
formDelay: FormDelay; | ||
setFormDelay: React.Dispatch<React.SetStateAction<FormDelay>>; | ||
}>({ | ||
formDelay: timerDefault, | ||
setFormDelay: () => {}, | ||
}); | ||
|
||
export const FormDelayProvider = ({ children }: { children: React.ReactNode }) => { | ||
const [formDelay, setFormDelay] = useState(timerDefault); | ||
return ( | ||
<FormDelayContext.Provider value={{ formDelay, setFormDelay }}> | ||
{children} | ||
</FormDelayContext.Provider> | ||
); | ||
}; | ||
|
||
// Adds in a little math to make it more unpredictable and calculates the final form delay | ||
const calculateSubmitDelay = (delayFromFormData: number) => { | ||
const secondsBaseDelay = 2; // To help test group forms, make this big e.g. 20000 | ||
const secondsPerFormElement = 2; | ||
return secondsBaseDelay + delayFromFormData * secondsPerFormElement; | ||
}; | ||
|
||
export const calculateDelayWithGroups = ( | ||
startTime: number, | ||
endTime: number, | ||
requiredQuestions: number | ||
) => { | ||
if (isNaN(startTime) || isNaN(endTime) || isNaN(requiredQuestions)) { | ||
return -1; | ||
} | ||
const elapsedTime = Math.floor((endTime - startTime) / 1000); | ||
const delayFromFormData = requiredQuestions - elapsedTime; | ||
return calculateSubmitDelay(delayFromFormData); | ||
}; | ||
|
||
export const calculateDelayWithoutGroups = (formElements: FormElement[]) => { | ||
if (!Array.isArray(formElements)) { | ||
return -1; | ||
} | ||
const delayFromFormData = formElements.filter( | ||
(element) => element.properties.validation?.required === true | ||
).length; | ||
return calculateSubmitDelay(delayFromFormData); | ||
}; | ||
|
||
// Turn on for local testing | ||
const debug = false; | ||
|
||
export const useFormDelay = () => { | ||
const { formDelay, setFormDelay } = useContext(FormDelayContext); | ||
return { | ||
/** | ||
* Adds the number of required questions in the current group to the form delay state. | ||
* @param form the current form | ||
* @param currentGroupId group Id of the current page | ||
*/ | ||
addRequiredQuestions: (form: FormProperties, currentGroupId: string) => { | ||
try { | ||
const groupIds = form?.groups?.[currentGroupId].elements; | ||
if (!groupIds) { | ||
return; | ||
} | ||
|
||
const currentGroupRequiredQuestions = form.elements | ||
.filter((element) => groupIds.find((id) => String(id) === String(element.id))) | ||
.filter((element) => element.properties.validation?.required === true).length; | ||
|
||
setFormDelay({ | ||
requiredQuestions: formDelay.requiredQuestions + currentGroupRequiredQuestions, | ||
// Set start time timestamp on initial call | ||
startTime: formDelay.startTime === 0 ? Date.now() : formDelay.startTime, | ||
}); | ||
} catch (error) { | ||
logMessage.info("Error adding required questions to form delay"); | ||
} | ||
}, | ||
/** | ||
* Gets the form delay based on the form type. For non-group forms, just send the required | ||
* questions on a form. For group forms, subtract the time spent on the form from the tally of | ||
* required questions from their group history (pages navigated). | ||
* @param form current form | ||
* @param hasGroups boolean to determine if the form has groups | ||
* @returns delay in seconds or in the case of an error -1 is used to fallback to no delay | ||
*/ | ||
getFormDelay: (formElements: FormElement[], hasGroups: boolean) => { | ||
try { | ||
const endTime = Date.now(); | ||
const delay = hasGroups | ||
? calculateDelayWithGroups(formDelay.startTime, endTime, formDelay.requiredQuestions) | ||
: calculateDelayWithoutGroups(formElements); | ||
|
||
debug && logMessage.info(`Delay: ${delay}, formDelay: ${JSON.stringify(formDelay)}`); | ||
|
||
// Avoid 0 because the SubmitButton relies on this to disable itself | ||
return delay === 0 ? -1 : delay; | ||
} catch (error) { | ||
logMessage.info("Error calculating form delay."); | ||
return -1; | ||
} | ||
}, | ||
}; | ||
}; |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rename to "updateFormDelay" and mention setting the time in the comments