Forms: make conflation of published/draft explicit #1527
Conversation
This file contains hidden or 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
Current `master` allows requests for forms through query functions to implicitly conflate form drafts and published versions. This leads to surprising behaviours in the API like: * getodk#1404 * TODO others? Affected functions: pretty much all form querying functions.
2 tasks
added 28 commits
June 17, 2025 15:45
alxndrsn
commented
Jun 20, 2025
| @@ -22,6 +24,12 @@ const Option = require('../../util/option'); | |||
| const Problem = require('../../util/problem'); | |||
| const { PURGE_DAY_RANGE } = require('../../util/constants'); | |||
|
|
|||
| const describe = m => (typeof m === 'object' ? JSON.stringify(m) : m); | |||
| const fatalError = (...message) => { | |||
alxndrsn
commented
Jun 20, 2025
lib/model/query/forms.js
Outdated
| @@@@@@ _getSql() @@@@@@ | ||
| ${require('node:util').inspect(query)} | ||
| @@@@@@@@@@@@@@@@@@@@@@@ | ||
| `); |
alxndrsn
commented
Jun 20, 2025
alxndrsn
commented
Jun 20, 2025
alxndrsn
commented
Jun 20, 2025
alxndrsn
commented
Jun 20, 2025
alxndrsn
commented
Jun 20, 2025
alxndrsn
commented
Jun 20, 2025
test/integration/api/forms/draft.js
Outdated
| @@ -3,6 +3,7 @@ const appRoot = require('app-root-path'); | |||
| const should = require('should'); | |||
| const { testService } = require('../../setup'); | |||
| const testData = require('../../../data/xml'); | |||
| const { getOrNotFound } = require(appRoot + '/lib/util/promise'); | |||
alxndrsn
commented
Jun 20, 2025
| @@ -2021,7 +2020,7 @@ describe('Entities API', () => { | |||
|
|
|||
| const logger = (action, actee, details) => log(containerTx1.context.auth.actor, action, actee, details); | |||
|
|
|||
| const entity = await getById(dataset.id, '12345678-1234-4123-8234-123456789abc', QueryOptions.forUpdate)(containerTx1).then(getOrNotFound); | |||
| const entity = await getById(dataset.id, '12345678-1234-4123-8234-123456789abc', QueryOptions.forUpdate)(containerTx1).then((o) => o.get()); | |||
There was a problem hiding this comment.
re-revert - leave this to the dedicated PR
alxndrsn
commented
Jun 20, 2025
| @@ -1224,7 +1225,7 @@ describe('api: /projects/:id/forms (create, read, update)', () => { | |||
| .set('Content-Type', 'application/xml') | |||
| .expect(200) | |||
| .then(() => service.login('chelsea', (asChelsea) => | |||
| asChelsea.get('/v1/projects/1/forms/withAttachments/attachments') | |||
| asChelsea.get('/v1/projects/1/forms/withAttachments/draft/attachments') | |||
alxndrsn
commented
Jun 20, 2025
alxndrsn
commented
Jun 20, 2025
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.
2FCD
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.
TODO
xml, versionargsNoDefRequiredtoWithoutDefWithoutDef)PublishedVersionin non-/draftforms APICurrent
masterallows requests for forms through query functions to implicitly conflate form drafts and published versions.This leads to surprising behaviours in the API like:
Affected functions: pretty much all form querying functions.
Closes #
What has been done to verify that this works as intended?
Why is this the best possible solution? Were any other approaches considered?
How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?
Does this change require updates to the API documentation? If so, please update docs/api.yaml as part of this PR.
Before submitting this PR, please make sure you have:
make testand confirmed all checks still pass OR confirm CircleCI build passes