Fix PATCH conflicts when meta.version is present
#87
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
At present all PATCH requests for resources that have a `meta.version`
attribute will fail with ErrConflict because the PatchService.Do()
method incorrectly mutates the current resource instead of its
replacement.
This error was not caught by existing unit tests because they do not set
a `meta.version` attribute and db.Memory().Replace() has the following
check:
version := ref.MetaVersionOrEmpty()
if len(version) > 0 && m.db[id].MetaVersionOrEmpty() != version {
return spec.ErrConflict
}
This has the effect of permitting replacements when there is no version
present -- which is the case for the existing unit tests **but not real
APIs**. Simply adding a `meta.version` attribute to unit tests (as in
this commit) yields failures like as the following:
=== RUN TestPatchService/TestDo/patch_to_make_a_difference
patch_test.go:99:
Error Trace: patch_test.go:99
patch_test.go:366
Error: Expected nil, but got: &spec.Error{Status:412, Type:"conflict"}
Test: TestPatchService/TestDo/patch_to_make_a_difference
An identical fix was originally proposed by @zakirhussain in imulab#80. This
commit expands on that work to include unit test changes to catch a
regression and (hopefully) a better explanation on the underlying cause
of the issue.
Co-authored-by: Zakir Hussain <[email protected]>
Signed-off-by: Aaron Jacobs <[email protected]>
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.
At present all PATCH requests for resources that have a
meta.versionattribute will fail withErrConflictbecause thePatchService.Do()method incorrectly mutates the current resource instead of its replacement.This error was not caught by existing unit tests because they do not set a
meta.versionattribute anddb.Memory().Replace()has the following check:go-scim/pkg/v2/db/memory.go
Lines 76 to 79 in fec7838
This has the effect of permitting replacements when there is no version present -- which is the case for the existing unit tests but not real APIs. Simply adding a
meta.versionattribute to unit tests (as in this PR) yields failures like as the following for all tests:An identical fix was originally proposed by @zakirhussain in #80. This PR expands on that work to include unit test changes to catch a regression and (hopefully) a better explanation of the underlying cause of the issue.