feat(#6390): update phone widget to allow not checking for dupes #9340
Conversation
jkuester
force-pushed
the
6390_optional_dup_check_for_tel
branch
from
dd6b542 to
5ecbdd4
Compare
| @@ -14,7 +14,7 @@ | |||
| "overrides": [ | |||
| { | |||
| "files": [ | |||
| "src/js/bootstrapper/*.js" | |||
| "src/js/**/*.js" | |||
There was a problem hiding this comment.
Seems like it is fine to let any of the js files log to the console. Right?
| }; | ||
|
|
||
| // Remove this when we no longer support the tel xlsxform type | ||
| const deprecated = { |
There was a problem hiding this comment.
Following a similar pattern we used in the countdown timer widget. I put all the deprecated functionality in this object, so when we remove support for the tel type, it is more clear what parts of the code need to be updated (basically just the places where we use this object).
| constructor( element, options, Settings = window.CHTCore.Settings ) { | ||
| super(element, options); | ||
|
|
||
| _init() { |
There was a problem hiding this comment.
The Enketo Widget class has an _init function that is intended to be overridden to include initialization logic. We use that method in our other custom widgets, so just cleaning up this old code to follow the new convention.
|
|
||
| // Add a proxy input field, which will send its input, formatted, to the real input field. | ||
| // TODO(estellecomment): format the visible field onBlur to user-friendly format. |
| .get() | ||
| .then( function( settings ) { | ||
| if ( !phoneNumber.validate( settings, fieldValue ) ) { | ||
| throw new Error( 'invalid phone number: "' + fieldValue + '"' ); |
There was a problem hiding this comment.
Looking at the implementation of the other Enketo Type validations, it seems that none of them are deliberately throwing an error. Instead they just return false when the validation fails. The main behavior difference that I could find between returning false and just throwing an error is that an invalidated event is not properly emitted for the input when an error is thrown.
To remain more consistent with existing Enketo behavior, I have updated the validation logic to just return false instead of throwing errors.
jkuester
changed the title
Description
Closes #6390
medic/cht-docs#1498
This PR add support for a new way to configure a phone number field in a form. Previously, the phone widget was configured in an xlsxform field by setting
type: tel. By default, the phone widget both validates the phone number value and checks for existing contacts that have the same number.With these new changes, the existing (now deprecated) functionality stays the same, but going forwards, phone number fields should be configured in an xlsxform by setting
type: stringwithappearance: number tel. Fields with this new configuration will always validate the phone number value, but by default they will not check for existing contacts with the same number. To enforce a unique phone number with the new style of field, you should add a new column withinstance::cht:unique_tel: trueTesting considerations
We had some existing coverage of the phone widget in the enekto_widgets tests both in
e2eandintegration/cht-form. However, as we determined when we did the countdown timer feature, it seems more sustainable to break out tests/forms for specific widgets instead of trying to cram everything into theenketo_widgetstests. So, I have created a newphone_widgetform and added tests for that, both ine2eandintegration/cht-form. I covered as much as possible in the cht-form tests, but part of the phone-widget functionality involves querying the database to check for other contacts with the same phone number. This functionality cannot be properly validated in the cht-form tests, so I added a few cases to thee2etests.Code review checklist
Compose URLs
If Build CI hasn't passed, these may 404:
License
The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.