Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Unified test suite #1813

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Conversation

lawrence-forooghian
Copy link
Collaborator

This is a starting point for the unified test suite (an attempt at reusing the ably-js test suite as a shared test suite for all of our client libraries). It gives @ttypic a starting point for trying to test the SDK adapters. It is unlikely to be merged into main.

@github-actions github-actions bot temporarily deployed to staging/pull/1813/bundle-report July 9, 2024 18:09 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1813/features July 9, 2024 18:09 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1813/typedoc July 9, 2024 18:09 Inactive
@lawrence-forooghian lawrence-forooghian force-pushed the ECO-4834-do-something-with-private-api-data branch 2 times, most recently from 16d8f79 to f770124 Compare July 24, 2024 11:37
Base automatically changed from ECO-4834-do-something-with-private-api-data to main July 25, 2024 08:23
@github-actions github-actions bot temporarily deployed to staging/pull/1813/bundle-report July 25, 2024 09:21 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1813/features July 25, 2024 09:21 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1813/typedoc July 25, 2024 09:21 Inactive
These are the same files I didn’t add private API usage annotations to
in 2dcf4ed.

I’m doing this now so that when I make further UTS-related changes I
don’t have to think about these files.
This is part of removing some common private API usage for the unified
test suite.

ably-js is the only client library that offers multiple transports, so
testing on multiple transports will probably not be part of the UTS.
This is part of removing some common private API usage for the unified
test suite.

As mentioned in e94a8ae, client libraries running in unified test suite
are expected to only use WebSocket transport.
This is part of removing some common private API usage for the unified
test suite.

It’s not clear to me why these private APIs were required. Even
`nextTick`, which had a comment saying that it is needed by
“channelattach_publish_invalid etc” — removing the `nextTick` does not
seem to affect those tests (although 4a90e75, which introduced the
`nextTick` usage, does describe it as a “race” so perhaps we need to see
if failures emerge over time).
These are APIs that for the purposes of the unified test suite we can
not consider as private for the time being (so as to not clutter up the
private API reporting data).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant