fix: force setMetadata calls to use promise version, invoke callbacks manually #2000
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
product-auto-label
bot
added
size: m
ddelgrosso1
added
the
owlbot:run
gcf-owl-bot
bot
removed
the
owlbot:run
src/bucket.ts
Outdated
| this.setMetadata({lifecycle: {rule: newLifecycleRules}}, callback); | ||
| this.storage.retryOptions.autoRetry = this.instanceRetryValue; | ||
| this.setMetadata({lifecycle: {rule: newLifecycleRules}}) | ||
| .then(resp => callback!(null, resp)) |
There was a problem hiding this comment.
will callbacks always be provided? (guessing yes, but just wanted to double check this)
There was a problem hiding this comment.
In some situations there is no guarantee, in those places I have added a check and utilize util.noop as the callback.
| @@ -3654,22 +3654,6 @@ describe('File', () => { | |||
| }); | |||
| }); | |||
|
|
|||
| it('should execute callback with error & API response', done => { | |||
There was a problem hiding this comment.
For future reference, spoke with @ddelgrosso1 and determined that this case does not exist and that it would be safe to remove this test.
ddelgrosso1
added
the
do not merge
|
Marking do not merge until I fix this up and run a bunch of tests to make sure this doesn't break current behavior. |
ddelgrosso1
added
the
owlbot:run
gcf-owl-bot
bot
removed
the
owlbot:run
|
Been running some tests locally and from what I can tell things look the same as they were. @danielbankhead would you mind giving this PR a look as well? |
danielbankhead
approved these changes
Jul 11, 2022
shaffeeullah
approved these changes
Jul 12, 2022
ddelgrosso1
removed
do not merge
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.
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
Fixes #<issue_number_goes_here> 🦕
Rationale for this change:
setMetadatais a conditionally idempotent operation. Currently if no precondition is provided we flip a flag to turn off retries. However, sincesetMetadatais promisified we are seeing behavior where the flag is getting flipped back before the operation completes. This is causing incorrect behavior. I am changing the internal calls to wait for the promise to finish before flipping the flag back.