[BREAKING CHANGE] Support PATCH operations (partial updates) and bump @azure/cosmos to v3.17.3 #111
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
marc-vercel
changed the title
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
marc-vercel
commented
Jul 16, 2025
Comment on lines
+400
to
+407
| const patchOperations = [ | ||
| { op: "set", path: "/value", value: 200 }, | ||
| { op: "set", path: "/nested/property", value: "updated" }, | ||
| { op: "set", path: "/newProperty", value: "created" } | ||
| ]; | ||
|
|
||
| await item.patch(patchOperations); | ||
| const { resource: result } = await item.read(); |
There was a problem hiding this comment.
Testing is done using @azure/cosmos (v3.17.3) against the CosmosDB Server implementation. If the tests pass, it means the server implementation is compatible with the Cosmos SDK.
marc-vercel
commented
Jul 16, 2025
marc-vercel
commented
Jul 22, 2025
| # The executed tests are for Cosmos SDK 4.5.0, but we only have partial support for 3.17.x. | ||
| # That is why there are so many ignored test patterns. | ||
| cd test/azure-sdk-for-js/sdk/cosmosdb/cosmos | ||
| ACCOUNT_HOST="https://localhost:$port" npm run test:node:integration -- --testNamePattern='\^\(?!.*\(Authorization\|Change\ Feed\|Partition\|indexing\|Offer\ CRUD\|Permission\|Session\ Token\|sproc\|stored\ procedure\|Trigger\|TTL\|User\|Non\ Partitioned\|autoscale\|nonStreaming\|Iterator\|startFromBeginnin\|Full\ Text\ Search\|Full\ text\ search\ feature\|GROUP\ BY\|TOP\|DISTINCT\|ORDER\ BY\|LIMIT\|Conflicts\|readOffer\|validate\ trigger\ functionality\|SELECT\ VALUE\ AVG\ with\ ORDER\ BY\|changeFeedIterator\|test\ changefeed\|validate\ changefeed\ results\|New\ session\ token\|Validate\ SSL\ verification\|test\ batch\ operations\|test\ bulk\ operations\|test\ executeBulkOperations\|Id\ encoding\|Correlated\ Activity.*force\ query\ plan\|Correlated\ Activity.*GROUP\ BY\|aggregate\ query\ over\ null\ value\|Vector\ search\ feature\|Vector\ Search\ Query\|Bad\ partition\ key\ definition\|Reading\ items\ using\ container\|ClientSideEncryption\)\).*' |
There was a problem hiding this comment.
Because of yarn and other libraries bugs, I had to end up moving the test/azure-sdk-for-js repository forward 3 years. This means:
- Lots of new tests cases we added. Now, we are testing against CosmosDB SDK 4.5.0. Because of that, I had to filter lots of new tests. Notice that the "patch" tests are not filtered, as we are interested in these running (new code we are adding in this PR).
marc-vercel
changed the title
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.
Changes
We are testing with
@azure/cosmosv3.17.3 instead of v3.10.x. The reason for that is that we need v3.15.x to support Patch operations, and since we are already updating the library, I have bumped it to the latest 3.X version, which is maintenance mode (they are already in the version v4.5+).Bumping to version v4.X should be another PR as it is a breaking change and more risky. In this PR I am only interested in adding support for the Patch operations.
Another change is supporting Node 20 and 22 in the test matrix. We are also removing support for Node 14, 16 and 18, as they have reached their EOL and the new version from
@azure/cosmosdoes not support that. Removing this support means it is a BREAKING CHANGE.The default NodeJS version has been moved from Node 14 to Node 20.
What is Patch updates?
Patch (Partial) updates allow us to only modify the fields that have changed from a CosmosDB document. Otherwise, the default behavior is to delete and create the Document again, which means the RU consumption increases in proportion to the Document size and we introduce more latency.
Testing
I have added integration tests to support the all patch operations, even if in the end we will only use three operations:
set,remove,replace. The main reason is that the main tests from azure SDK try all patch operations, and we want to pass them.There is also an additional test to verify that the condition works, if used.
Also, I had to update the gitsubmodule used for testing to the latest one, due to errors and issues with all the previous versions.