[SDK-3938] Remove the existing plugins mechanism #1512
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/1512/features
github-actions
bot
temporarily deployed
to
staging/pull/1512/bundle-report
github-actions
bot
temporarily deployed
to
staging/pull/1512/typedoc
lawrence-forooghian
force-pushed
the
1492-remove-plugins-mechanism
branch
from
9b11adb
to
07b84fa
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1512/features
github-actions
bot
temporarily deployed
to
staging/pull/1512/bundle-report
github-actions
bot
temporarily deployed
to
staging/pull/1512/typedoc
lawrence-forooghian
force-pushed
the
1492-remove-plugins-mechanism
branch
from
07b84fa
to
110ad34
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1512/features
github-actions
bot
temporarily deployed
to
staging/pull/1512/bundle-report
github-actions
bot
temporarily deployed
to
staging/pull/1512/typedoc
This was referenced Nov 22, 2023
lawrence-forooghian
force-pushed
the
1492-remove-plugins-mechanism
branch
from
110ad34
to
3abc42f
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1512/features
github-actions
bot
temporarily deployed
to
staging/pull/1512/typedoc
github-actions
bot
temporarily deployed
to
staging/pull/1512/bundle-report
lawrence-forooghian
force-pushed
the
1492-remove-plugins-mechanism
branch
from
3abc42f
to
273f133
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1512/features
github-actions
bot
temporarily deployed
to
staging/pull/1512/bundle-report
github-actions
bot
temporarily deployed
to
staging/pull/1512/typedoc
lawrence-forooghian
force-pushed
the
1492-remove-plugins-mechanism
branch
from
273f133
to
83fb365
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1512/features
github-actions
bot
temporarily deployed
to
staging/pull/1512/bundle-report
github-actions
bot
temporarily deployed
to
staging/pull/1512/typedoc
lawrence-forooghian
force-pushed
the
1492-remove-plugins-mechanism
branch
from
83fb365
to
b03aa9d
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1512/features
github-actions
bot
temporarily deployed
to
staging/pull/1512/bundle-report
github-actions
bot
temporarily deployed
to
staging/pull/1512/typedoc
lawrence-forooghian
changed the title
lawrence-forooghian
force-pushed
the
1492-remove-plugins-mechanism
branch
2 times, most recently
from
6fa63dc
to
b89b69a
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1512/features
github-actions
bot
temporarily deployed
to
staging/pull/1512/bundle-report
github-actions
bot
temporarily deployed
to
staging/pull/1512/typedoc
lawrence-forooghian
force-pushed
the
1492-remove-plugins-mechanism
branch
from
b89b69a
to
be9a73c
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1512/features
github-actions
bot
temporarily deployed
to
staging/pull/1512/bundle-report
github-actions
bot
temporarily deployed
to
staging/pull/1512/typedoc
I suspect this was a copy-and-paste error in a7d9a5e.
Make it match the signature of @ably/vcdiff-decoder’s `decode`.
Fix inverted code and statusCode, and use the "Required client library plugin not present" [1] error code (which we currently use when the vcdiff plugin is missing). [1] https://github.com/ably/ably-common/blob/main/protocol/errors.json
I’m going to use them inside `modules.test.js` as part of #1492 (removing the ClientOptions.plugins mechanism).
lawrence-forooghian
force-pushed
the
1492-remove-plugins-mechanism
branch
from
be9a73c
to
d1683af
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1512/features
github-actions
bot
temporarily deployed
to
staging/pull/1512/bundle-report
github-actions
bot
temporarily deployed
to
staging/pull/1512/typedoc
This gives these tests access to the same test helper APIs that the other ones use. And, it means that we can access test helpers inside the body of a `describe` block, which I’ll need in an upcoming commit in order to call the shared delta tests added in 09354d4.
A summary of the discussion on #1492: - the modular API should be the only way to pass optional functionality to the SDK - this means we need to replace the existing ClientOptions.plugins mechanism, which is currently used to pass a Vcdiff decoder - since the modular variant of the SDK only exists for web at the moment, we will bundle Vcdiff decoding into all other platforms (in which bundle size is not much of a concern) - on web, if you want deltas, you have to use the modular variant of the SDK So, we remove the ClientOptions.plugins mechanism and introduce a tree-shakable Vcdiff module, which bundles the vcdiff-decoder library (meaning that users no longer need to directly import this library). Note that this means that, currently, it is no longer possible to use deltas inside a Web Worker. We’ll address this in #1514. The README example of configuring a channel to use deltas is copied from the README of the vcdiff-decoder library. (Once ably-js v2 is released, we should update the instructions in the vcdiff-decoder library’s README to make it clear they only apply to v1. I’ve raised #1513 for this.) Resolves #1492.
lawrence-forooghian
force-pushed
the
1492-remove-plugins-mechanism
branch
from
d1683af
to
c1f70b0
Compare
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.
This removes the
ClientOptions.pluginsmechanism and moves the Vcdiff functionality to a new tree-shakableVcdiffmodule. See commit messages for more details.Resolves #1492.