[ECO-4122] v2.0.0 changelog

[VeskeR]

Changelog is based on changes between e71ed5f...c02ec56 (latest main and integration/v2 diff as of March 21).

PRs that need to be added to the changelog when finished/reviewed and merged:

• Typings: update v2 typings to use createRecoveryKey() instead of recoveryKey #1613 - breaking API change
• [ECO-4121] Publicly document v2 platform compatibility and update CI accordingly #1633 - platform compatibility PR
• Bring whenState in line with spec #1640 - API change
• feat: no upgrade #1645 - breaking API change, removes xhr_streaming Transport
• Split usePresence hook into different hooks for entering presence and subscribing to presence events #1621 - breaking API change
• Decide on renaming id field in react-hooks for AblyProvider and channel options #1637 - breaking API change
• [ECO-4658] Restore ClientOptions.plugins mechanism and use it for modular variant #1663 - breaking API change
• [ECO-4666] feat: add publish to the useChannel hook #1658 - new API feature
• [ECO-4635] docs: add ChannelProvider documentation #1654 - ChannelProvider documentation
• [ECO-4675] Add documentation for skip parameter to React docs #1675 - falls under refactoring

Please note that this is not an exhaustive list of tasks that need to be completed before the v2 release. This list contains only the user-facing PRs/tasks that must be added to the changelog.

Pull requests not included in this changelog (I considered them as Miscellaneous / Extras, non-user facing):

• Use useLayoutEffect when calling .setOptions() in ChannelProvider #1706
• Remove some lingering any from stats() param type #1705
• Improve errors for incorrect constructor args #1702
• Fix stray second arg to modular constructor #1701
• Add migration guide for react hooks for ably-js v2 #1698
• Change PresenceEnterResult to PresenceResult in react hooks #1697
• Fix ably/modular can't be imported in node environment #1696
• Fix lint warnings #1694
• build: use esbuild for nodejs bundle #1691
• Add documentation for skip parameter for hooks to React docs #1675
• Add migration guide for v2 #1670
• Document fallback transport mechanism in the context of network conditions for v2 #1664
• Restore ClientOptions.plugins mechanism and use it for modular variant #1663
• ci: don't check formatting in react workflow #1653
• test: test ux improvements #1652
• Move React.createContext outside of components in react-hooks #1643
• Improve logs for react package test in test:package #1639
• Document our continued support for v1 #1634
• Refactor nodejs http util class #1627
• Fix missing ably/react export from ably package on v2 branch #1625
• Fix ably import in react hooks #1624
• Convert HTTP code to use promises #1603
• Add better error handling for incorrect PLAYWRIGHT_BROWSER in runPlaywrightTests script #1595
• Document that queryTime auth option requires Rest module #1593
• Make modulereport print gzipped size too #1586
• Add try/catch to _multiple_send to allow fast fail in case of errors #1585
• Fix mocha web server process keeps running after failed playwright tests #1584
• Fix multiple_send_binary_2_200 is failing intermittently in browser on v2 branch #1583
• Improve IPlatformConfig #1563
• build: use Ably as UMD lib name #1558
• Remove callbacks part 1 #1541
• Strip logging from modular variant of the SDK #1536
• Correct tsc module settings for test:package #1521
• Add stats to list of functionality gated off by Rest module #1517
• Remove the existing plugins mechanism #1512
• Add some regression testing for bundle size and included files #1507
• Exclude PresenceMessage from BaseRealtime bundle #1505
• Remove static stuff from *Message classes #1503
• Add documentation for modular variant of library #1502
• Add typings for the tree-shakable version of the library #1498
• Remove remaining REST code from BaseRealtime #1496
• Don’t populate DeviceDetails.toRequestBody by assignment #1494
• Do e013cc0’s typescript-eslint version bumps in package.json #1490
• Add a basic test of NPM package #1476
• Make MessageFilter subscription filtering tree-shakable#1473
• Make HTTP request implementations tree-shakable #1438
• Make realtime transports tree-shakable #1432
• Remove PresenceMessage-related static things in tree-shakable library #1429
• Make realtime presence functionality tree-shakable #1428
• Create tree-shakable MsgPack module #1425
• Create tree-shakable Crypto module #1419
• Add tree-shakable Base* and Rest exports #1417
• refactor: convert web comet transports to typescript #1379
• build: use esbuild for web bundles #1369
• Update the tests to use the Promise-based API #1349
• Make ErrorInfo.fromValues’s signature correspond to its expectations #1322
• Fix TypeScript 4.9.5 upgrade mistakes #1267
• Upgrade TypeScript to 4.9.5 #1258
• Update docstrings for Rest.request version param #1255
• Convert platform crypto.js files to TypeScript #1246
• Upgrade webpack to version 5 #1201

Resolves #1604

[owenpearson]

Looks good on the whole, I agree with the categorisation of PRs into non-user facing, breaking, etc.

I do think, if this is gonna be what ends up as the description in the github release we should be a bit more 'product marketing' about how we present the changes at first, and maybe even start off with a short paragraph rather than going straight into bullet points. It doesn't look too exciting if the first thing someone sees is that we've dropped support for platforms, whereas if we start by saying stuff like "We've added a new way to remove bloat from your ably-js client and we're adding first class support to promises" that sounds better IMO.

A couple of things that stood out to me below:

[VeskeR]

I do think, if this is gonna be what ends up as the description in the github release we should be a bit more 'product marketing' about how we present the changes at first, and maybe even start off with a short paragraph rather than going straight into bullet points. It doesn't look too exciting if the first thing someone sees is that we've dropped support for platforms, whereas if we start by saying stuff like "We've added a new way to remove bloat from your ably-js client and we're adding first class support to promises" that sounds better IMO.

Updated intro.

I placed the platform support deprecations first, thinking it might be useful to immediately see what would break if you switch to this new version.
Upon a second look, however, I do agree that it looks underwhelming, so it has been changed now.

[lawrence-forooghian]

I think this needs to be reviewed as a single thing alongside the migration guide, the writing of which is assigned to me. I’m going to branch from this and write the migration guide, then we can review the two together.

[lawrence-forooghian]

Started working on migration guide in #1670.

[ttypic]

Looks great!

[VeskeR]

Added changelog for new changes since last update in this PR: 2462e9b...85b54ea :

• [ECO-4644] Rename id field to ablyId in React Hooks #1676
• [ECO-4666] feat: add publish to the useChannel hook #1658
• [ECO-4635] docs: add ChannelProvider documentation #1654
• Remove Node 12 and es5 code that was supporting older platforms in v2 #1641
• Bring whenState in line with spec #1640
• [ECO-4121] Publicly document v2 platform compatibility and update CI accordingly #1633
• Typings: update v2 typings to use createRecoveryKey() instead of recoveryKey #1613

Non-user facing (were not added to changelog doc):

• Document fallback transport mechanism in the context of network conditions for v2 #1664
• [ECO-4658] Restore ClientOptions.plugins mechanism and use it for modular variant #1663
• [ECO-4645] Move React.createContext outside of components in react-hooks #1643
• [ECO-4120] Document our continued support for v1 #1634

Also moved [SDK-3938] Remove the existing plugins mechanism to non-user facing, since it got reverted by [ECO-4658 Restore ClientOptions.plugins mechanism and use it for modular variant](#1663)

[ttypic]

Looks good

[VeskeR]

Updated for latest changes 2e12459...c02ec56:

no user-facing changes