Update class hierarchy on tree-shaking branch
#1415
Assignees
Comments
|
➤ Automation for Jira commented: The link to the corresponding Jira issue is https://ably.atlassian.net/browse/SDK-3768 |
lawrence-forooghian
added a commit
that referenced
this issue
Aug 2, 2023
We add the prefix "Base" to the names of the Rest and Realtime classes, and we introduce new classes DefaultRest and DefaultRealtime. The Base* classes will be exported by the upcoming tree-shakable variant of the library. The Default* classes become the exports of the current (i.e. non tree-shakable) variant. As we make the library tree-shakable, we will extract functionality from the Base* classes and move them into modules exported by the tree-shakable variant of the library. Whatever functionality we remove from the Base* classes will be reintroduced in their Default* counterparts. Resolves #1415. Co-authored-by: Owen Pearson <owen.pearson@ably.com>
lawrence-forooghian
added a commit
that referenced
this issue
Aug 15, 2023
We rename the Rest class to BaseClient, introduce a new class BaseRest, and add the prefix "Base" to the name of the Realtime class. The BaseRest and BaseRealtime classes will be exported by the upcoming tree-shakable variant of the library. The Default* classes become the exports of the current (i.e. non tree-shakable) variant. As we make the library tree-shakable, we will extract functionality from the BaseClient and BaseRealtime classes and move them into modules exported by the tree-shakable variant of the library. Whatever functionality we remove from the Base* classes will be reintroduced in their Default* counterparts. The purpose of the BaseRest class is probably not immediately obvious, since it adds no functionality on top of BaseClient. However, upon introducing the tree-shakable version of the library, which will split the REST functionality into a separate module that Realtime can optionally use, we will use the BaseRest class to ensure that even in the tree-shakable version of the library, the BaseRest class always includes REST functionality. Resolves #1415. Co-authored-by: Owen Pearson <owen.pearson@ably.com>
lawrence-forooghian
added a commit
that referenced
this issue
Oct 26, 2023
We rename the Rest class to BaseClient, introduce a new class BaseRest, and add the prefix "Base" to the name of the Realtime class. The BaseRest and BaseRealtime classes will be exported by the upcoming tree-shakable variant of the library. The Default* classes become the exports of the current (i.e. non tree-shakable) variant. As we make the library tree-shakable, we will extract functionality from the BaseClient and BaseRealtime classes and move them into modules exported by the tree-shakable variant of the library. Whatever functionality we remove from the Base* classes will be reintroduced in their Default* counterparts. The purpose of the BaseRest class is probably not immediately obvious, since it adds no functionality on top of BaseClient. However, upon introducing the tree-shakable version of the library, which will split the REST functionality into a separate module that Realtime can optionally use, we will use the BaseRest class to ensure that even in the tree-shakable version of the library, the BaseRest class always includes REST functionality. Resolves #1415. Co-authored-by: Owen Pearson <owen.pearson@ably.com>
lawrence-forooghian
added a commit
that referenced
this issue
Nov 1, 2023
We rename the Rest class to BaseClient, introduce a new class BaseRest, and add the prefix "Base" to the name of the Realtime class. The BaseRest and BaseRealtime classes will be exported by the upcoming tree-shakable variant of the library. The Default* classes become the exports of the current (i.e. non tree-shakable) variant. As we make the library tree-shakable, we will extract functionality from the BaseClient and BaseRealtime classes and move them into modules exported by the tree-shakable variant of the library. Whatever functionality we remove from the Base* classes will be reintroduced in their Default* counterparts. The purpose of the BaseRest class is probably not immediately obvious, since it adds no functionality on top of BaseClient. However, upon introducing the tree-shakable version of the library, which will split the REST functionality into a separate module that Realtime can optionally use, we will use the BaseRest class to ensure that even in the tree-shakable version of the library, the BaseRest class always includes REST functionality. Resolves #1415. Co-authored-by: Owen Pearson <owen.pearson@ably.com>
lawrence-forooghian
added a commit
that referenced
this issue
Nov 6, 2023
We rename the Rest class to BaseClient, introduce a new class BaseRest, and add the prefix "Base" to the name of the Realtime class. The BaseRest and BaseRealtime classes will be exported by the upcoming tree-shakable variant of the library. The Default* classes become the exports of the current (i.e. non tree-shakable) variant. As we make the library tree-shakable, we will extract functionality from the BaseClient and BaseRealtime classes and move them into modules exported by the tree-shakable variant of the library. Whatever functionality we remove from the Base* classes will be reintroduced in their Default* counterparts. The purpose of the BaseRest class is probably not immediately obvious, since it adds no functionality on top of BaseClient. However, upon introducing the tree-shakable version of the library, which will split the REST functionality into a separate module that Realtime can optionally use, we will use the BaseRest class to ensure that even in the tree-shakable version of the library, the BaseRest class always includes REST functionality. Resolves #1415. Co-authored-by: Owen Pearson <owen.pearson@ably.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Introduce classes
BaseRest,BaseRealtime,DefaultRealtimeinto #1400, such that:DefaultRestextendsBaseRestDefaultRealtimeextendsBaseRealtimeextendsBaseRestThe aim of this (vs the single
BaseClientclass introduced in #1400) is to give us a place to put the functionality that’s common toBaseClientandDefaultRest.The text was updated successfully, but these errors were encountered: