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.

Sign up for GitHub

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

Jump to bottom

Remove soft-deprecated APIs in 2.0 branch #1197

Closed
mikelee638 opened this issue Apr 20, 2023 · 2 comments
Closed

Remove soft-deprecated APIs in 2.0 branch #1197

mikelee638 opened this issue Apr 20, 2023 · 2 comments
Assignees
@lawrence-forooghian
Labels
breaking Backwards incompatible changes made to the public API.

Comments

@mikelee638
Copy link

Remove currently soft-deprecated features from the library. Examples include but are not necessarily limited to:
@mikelee638 mikelee638 added the breaking Backwards incompatible changes made to the public API. label Apr 20, 2023
@sync-by-unito
Copy link

sync-by-unito bot commented Apr 20, 2023

➤ Automation for Jira commented:

The link to the corresponding Jira issue is https://ably.atlassian.net/browse/SDK-3546

@lawrence-forooghian lawrence-forooghian self-assigned this Apr 26, 2023
lawrence-forooghian added a commit that referenced this issue Apr 26, 2023
@lawrence-forooghian
Remove DeprecatedClientOptions.timeouts property
19253ca 
The library never reads this property.

This work was scheduled as part of ably-js v2, but it appears safe to
do it in v1.

Part of #1197.
@lawrence-forooghian lawrence-forooghian mentioned this issue Apr 26, 2023
Merged
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove DeprecatedClientOptions.host
4480ce1 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove DeprecatedClientOptions.wsHost
c03b82e 
After removing the testing of wsHost’s effect, everything in the test
that this commit removes is tested in the subsequent test.

Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove DeprecatedClientOptions.queueEvents
0bf2cfd 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove DeprecatedClientOptions.headers
608691d 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Move remaining DeprecatedClientOptions into new type
7a45fff 
These are properties which have been removed from the public API of the
SDK, but which internal and test code still use for modifying the
behaviour of the SDK via its public constructors.

In the case where users were specifying these properties when using v1
of the library, we want these properties to cease to have any effect
upon upgrading to v2. Hence we move them into a new `internal:`
namespace. I hope that it’s safe to assume that users are not going to
pass a set of options that for some reason has a property named
`internal`.

Part of #1197.
@lawrence-forooghian lawrence-forooghian mentioned this issue Apr 27, 2023
Merged
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove DeprecatedClientOptions.headers
11f845b 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Move remaining DeprecatedClientOptions into new type
a5288d1 
These are properties which have been removed from the public API of the
SDK, but which internal and test code still use for modifying the
behaviour of the SDK via its public constructors.

In the case where users were specifying these properties when using v1
of the library, we want these properties to cease to have any effect
upon upgrading to v2. Hence we move them into a new `internal:`
namespace. I hope that it’s safe to assume that users are not going to
pass a set of options that for some reason has a property named
`internal`.

Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove DeprecatedClientOptions.headers
90d0370 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Move remaining DeprecatedClientOptions into new type
6778ff0 
These are properties which have been removed from the public API of the
SDK, but which internal and test code still use for modifying the
behaviour of the SDK via its public constructors.

In the case where users were specifying these properties when using v1
of the library, we want these properties to cease to have any effect
upon upgrading to v2. Hence we move them into a new `internal:`
namespace. I hope that it’s safe to assume that users are not going to
pass a set of options that for some reason has a property named
`internal`.

Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated fromEncoded* type declarations
440d890 
Part of #1197.
@lawrence-forooghian lawrence-forooghian mentioned this issue Apr 27, 2023
Merged
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated ClientOptions.fallbackHostsUseDefault
6b715a9 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated ability to pass ClientOptions.recover as a boolean
30ce44b 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated ability to pass "xhr" in ClientOptions.transports
3211b15 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated RealtimePresence.on/off methods
2549cf8 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated ability to pass AuthOptions.force property
b73b4d3 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated ability to pass flags to RealtimeChannel.attach
57a37c0 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated Auth.authorise method
742f3bc 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated forms of calling Crypto.getDefaultParams
bf52c1c 
Remove the ability to call it without a key, or to pass a key without
wrapping it in a CipherParamOptions object.

Resolves #1197.
@lawrence-forooghian lawrence-forooghian mentioned this issue Apr 27, 2023
Merged
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated fromEncoded* type declarations
b91665d 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated ClientOptions.fallbackHostsUseDefault
04676a8 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated ability to pass ClientOptions.recover as a boolean
b3c34b0 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated ability to pass "xhr" in ClientOptions.transports
ba830e7 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated RealtimePresence.on/off methods
486e958 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated ability to pass AuthOptions.force property
0d657ea 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated ability to pass flags to RealtimeChannel.attach
c385b2e 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated Auth.authorise method
74ef3b3 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated forms of calling Crypto.getDefaultParams
eee8d01 
Remove the ability to call it without a key, or to pass a key without
wrapping it in a CipherParamOptions object.

Resolves #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove DeprecatedClientOptions.host
5330f75 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove DeprecatedClientOptions.wsHost
616d2f2 
After removing the testing of wsHost’s effect, everything in the test
that this commit removes is tested in the subsequent test.

Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove DeprecatedClientOptions.queueEvents
757ecb5 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove DeprecatedClientOptions.headers
d7aaf34 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Move remaining DeprecatedClientOptions into new type
fe3c9ce 
These are properties which have been removed from the public API of the
SDK, but which internal and test code still use for modifying the
behaviour of the SDK via its public constructors.

In the case where users were specifying these properties when using v1
of the library, we want these properties to cease to have any effect
upon upgrading to v2. Hence we move them into a new `internal:`
namespace. I hope that it’s safe to assume that users are not going to
pass a set of options that for some reason has a property named
`internal`.

Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated ClientOptions.fallbackHostsUseDefault
adfe599 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated ability to pass ClientOptions.recover as a boolean
399c896 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated ability to pass "xhr" in ClientOptions.transports
b8ad229 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated RealtimePresence.on/off methods
742a981 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated ability to pass AuthOptions.force property
2402dc2 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated ability to pass flags to RealtimeChannel.attach
2b56a43 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated Auth.authorise method
5d3a18a 
Part of #1197.
lawrence-forooghian added a commit that referenced this issue Apr 27, 2023
@lawrence-forooghian
Remove deprecated forms of calling Crypto.getDefaultParams
0f2074e 
Remove the ability to call it without a key, or to pass a key without
wrapping it in a CipherParamOptions object.

Resolves #1197.
@lawrence-forooghian
Copy link
Collaborator

Closed in #1221, #1222, #1227.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lawrence-forooghian lawrence-forooghian

Labels
breaking Backwards incompatible changes made to the public API.
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mikelee638 @lawrence-forooghian