feat(fcm): Add sendEach and sendEachForMulticast for FCM batch send
#2138
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
1. Deprecate sendAll and sendMulticast 2. Add dummy implementation for sendEach and sendEachForMulticast to avoid errors reported by api-extractor
`sendEach` vs `sendAll`
1. `sendEach` sends one HTTP request to V1 Send endpoint for each
message in the array.
`sendAll` sends only one HTTP request to V1 Batch Send endpoint
to send all messages in the array.
2. `sendEach` calls `Promise.allSettled` to wait for all
`httpClient.send` calls to complete and construct a `BatchResponse`.
An `httpClient.send` call to V1 Send endpoint either completes
with a success or throws an error. So if an error is thrown out,
the error will be caught in `sendEach` and turned into a
`SendResponse` with an error.
Therefore, unlike `sendAll`, `sendEach` does not always throw
an error for a total failure. It can also return a `BatchResponse`
with only errors in it.
`sendEachForMulticast` calls `sendEach` under the hood.
lahirumaramba
changed the title
sendEach and sendEachForMulticast for FCM batch sendsendEach and sendEachForMulticast for FCM batch send
|
Thank you @Doris-Ge . Let's get the docs reviewed by @egilmorez before we merge this. |
egilmorez
approved these changes
Apr 11, 2023
src/messaging/messaging.ts
Outdated
| * | ||
| * The responses list obtained from the return value corresponds to the order of `messages`. | ||
| * An error from this method or a `BatchResponse` with all failures indicates a total failure | ||
| * -- i.e. none of the messages in the list could be sent. Partial failures or no failures |
There was a problem hiding this comment.
We avoid i. e., so for this I'd suggest just "...indicates a total failure, meaning that none of the messages in the list could be sent.
|
Thanks Eric for reviewing the PR! @lahirumaramba I tried to push the fix to the fcm-batch-send branch but it got rejected because "Protected branch update failed for refs/heads/fcm-batch-send". Should I create another PR from dorisge/fcm-batch-send for the fix and merge it to fcm-batch-send? |
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.
sendAll()andsendMulticast()APIs.sendEach()andsendEachForMulticast()APIs.RELEASE NOTE:
sendAll()andsendMulticast()APIs are now deprecated. Please usesendEach()andsendEachForMulticast()APIs instead.