fix: mark generateIdentifierFromStoredProcedure functions as VOLATILE#12391
Open
vera wants to merge 3 commits into
Open
fix: mark generateIdentifierFromStoredProcedure functions as VOLATILE#12391vera wants to merge 3 commits into
vera wants to merge 3 commits into
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
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.
What this PR does / why we need it:
This PR makes two changes:
generateIdentifierFromStoredProcedurefunctions shown in the docs to beVOLATILEinstead ofIMMUTABLE.generateIdentifierFromStoredProcedurefunctions to make themVOLATILE.The functions cannot be
IMMUTABLE, because they would need to be "guaranteed to return the same results given the same arguments forever" [1], which neither of them are.In the documented example functions,
now()andnextval('datasetidentifier_seq')return different values over time, so the function's output changes even though it takes no arguments. In general, we can assume that any implementation ofgenerateIdentifierFromStoredProcedureshould return a different result every time you call it, because it's supposed to generate unique identifiers.When the DB assumes the functions are
IMMUTABLE, it may cache the function result and occasionally just return the same cached identifier over and over. This would cause the loop in generateIdentifierFromStoredProcedureIndependent to get stuck.See also: my Zulip post, which has a bit more detail.
[1] https://www.postgresql.org/docs/current/xfunc-volatility.html
Which issue(s) this PR closes:
None
Special notes for your reviewer:
/
Suggestions on how to test this:
For confirming this bug, you could set up a Dataverse with a PID provider that uses "storedProcGenerated" and then create a number of datasets via API in quick succession.
Without the change in this PR, the "create dataset" API sometimes gets stuck and doesn't return a response.
With this change, it no longer gets stuck.
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
/
Is there a release notes update needed for this change?:
I added a short release note
Additional documentation:
/