Add validation for simple XPaths in form config #486
Merged
Conversation
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
jkuester
commented
Jul 1, 2022
| @@ -11,7 +11,7 @@ | |||
| "eslint": "eslint 'src/**/*.js' test/*.js 'test/**/*.js'", | |||
| "docker-start-couchdb": "npm run docker-stop-couchdb && docker run -d -p 6984:5984 --rm --name cht-conf-couchdb couchdb:2.3.1 && sh test/scripts/wait_for_response_code.sh 6984 200 CouchDB", | |||
| "docker-stop-couchdb": "docker stop cht-conf-couchdb || true", | |||
| "test": "npm run eslint && npm run docker-start-couchdb && npm run clean && mkdir -p build/test && cp -r test/data build/test/data && cd build/test && nyc --reporter=html mocha --forbid-only ../../test/**/*.spec.js && cd ../.. && npm run docker-stop-couchdb", | |||
| "test": "npm run eslint && npm run docker-start-couchdb && npm run clean && mkdir -p build/test && cp -r test/data build/test/data && cd build/test && nyc --reporter=html mocha --forbid-only \"../../test/**/*.spec.js\" && cd ../.. && npm run docker-stop-couchdb", | |||
There was a problem hiding this comment.
Note that I needed these extra quotes in here to get mocha to run the tests nested down in test/lib/validation/form
jkuester
commented
Jul 1, 2022
| @@ -38,6 +38,7 @@ | |||
| "@hapi/joi": "^16.1.8", | |||
| "@medic/translation-checker": "^1.0.1", | |||
| "@parcel/watcher": "^2.0.5", | |||
| "@xmldom/xmldom": "^0.8.2", | |||
There was a problem hiding this comment.
FYI, @xmldom/xmldom is just the new version of xmldom.
|
🎉 This PR is included in version 3.13.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Adds support for validating simple XPath expressions in form XML files. Simple XPaths, (ones that only describe a full path (either absolute or relative) to a node) in forms should always refer to a node that actually exists in the form (otherwise they would never actually result in a value). XPaths that fail this check are almost certainly a bug.
More complex XPath's (that might have conditional logic that depends on the actual data in the form) are not evaluated.
Note that I have only been able to find one "false positive" case (where an error is flagged when it should not be). This case requires the XPath expression to include:
For example,
concat('/Users/joe/Desktop/myfile.txt', "Joe's File")will cause the validation to fail saying that/Users/joe/Desktop/myFile.txtis an invalid XPath expression because the quote in "Joe's" confuses the regex into thinking that'/Users/joe/Desktop/myfile.txt'is not actually in a string literal. This seems like a pretty extreme edge case and not one that I am terribly worried about hitting. However, if any forms do run into this, it is worth noting that it can easily be fixed by updating the string literal containing the simple XPath to just use the other type of quote:concat("/Users/joe/Desktop/myfile.txt", "Joe's File").Closes #479
Code review items
License
The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.