Bring whenState in line with spec
#1640
Merged
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
github-actions
bot
temporarily deployed
to
staging/pull/1640/features
github-actions
bot
temporarily deployed
to
staging/pull/1640/bundle-report
github-actions
bot
temporarily deployed
to
staging/pull/1640/typedoc
lawrence-forooghian
force-pushed
the
1597-implement-whenState-spec
branch
from
88ee9f2
to
879533e
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1640/features
github-actions
bot
temporarily deployed
to
staging/pull/1640/bundle-report
github-actions
bot
temporarily deployed
to
staging/pull/1640/typedoc
lawrence-forooghian
changed the title
whenState in line with spec
VeskeR
requested changes
Mar 6, 2024
lawrence-forooghian
force-pushed
the
1597-implement-whenState-spec
branch
from
879533e
to
2d00596
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1640/bundle-report
lawrence-forooghian
force-pushed
the
1597-implement-whenState-spec
branch
from
2d00596
to
bec7527
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1640/bundle-report
VeskeR
approved these changes
Mar 6, 2024
I think that onceOrIfAfter was the original name for whenState, but 5d05530 forgot to update the test name accordingly.
Missed this in 7c465d6. I’ve had to remove the assertion from channelattachWhenState which checks that whenState calls its listener immediately, because there’s no easy way to check for this (because promise listeners are always invoked asynchronously and there’s no way to synchronously check whether a promise is pending).
Until spec commit d5e8fc6, these methods were exclusive to ably-js and were not tested. This commit brings the ably-js implementations in line with the aforementioned spec commit and tests that they conform to the spec. Documentation based on sdk-api-reference commit 4a06b46. Note the addition of the async/await adaptations of closeAndFinish and monitorConnection. These new tests are the first realtime tests that we’ve written on the v2 branch — i.e. since we dropped support for the callbacks API, and so I’ve written them using async/await properly instead of the whenPromiseSettles stopgap solution of 43a2d1d. Hence the new helper methods.
lawrence-forooghian
force-pushed
the
1597-implement-whenState-spec
branch
from
bec7527
to
b2b98eb
Compare
This was referenced May 24, 2024
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.
Updates the
whenStatemethods to conform to ably/specification#183. See commit messages for more details.Resolves #1597.
https://ably.atlassian.net/browse/ECO-4662