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

Merge main into integration/v2 #1480

Merged
merged 68 commits into from
Nov 6, 2023
Merged
Changes from 2 commits
Commits
Show all changes
68 commits
Select commit Hold shift + click to select a range
5baf94d
Support presence message extras
lmars Aug 2, 2023
99f7798
Add PresenceMessage.fromValues to ably.d.ts
lmars Aug 6, 2023
40f890b
Merge pull request #1418 from ably/presence-extras
lmars Aug 8, 2023
3695410
docs: update changelog for 1.2.43 release
owenpearson Aug 10, 2023
dac4aad
chore: bump version for 1.2.43 release
owenpearson Aug 10, 2023
cfdeda0
Merge pull request #1420 from ably/release/1.2.43
owenpearson Aug 10, 2023
d96c33d
Export the ErrorInfo class
lmars Aug 23, 2023
55182b8
Merge pull request #1430 from ably/export-errorinfo
lmars Aug 24, 2023
1b088b2
feat: move react-hooks into ably-js
owenpearson Aug 30, 2023
49173e7
docs: mark the react hooks as experimental
owenpearson Sep 4, 2023
dd8595f
Merge pull request #1433 from ably/react-hooks
owenpearson Sep 4, 2023
8dad7d9
docs: update CHANGELOG for 1.2.44 release
owenpearson Sep 4, 2023
10f445e
chore: bump version for 1.2.44 release
owenpearson Sep 4, 2023
9c90fe5
Merge pull request #1434 from ably/release/1.2.44
owenpearson Sep 4, 2023
183529c
cleanup: remove react-hooks license
owenpearson Sep 4, 2023
f4c2119
cleanup: merge react-hooks and root CONTRIBUTING guides
owenpearson Sep 4, 2023
76a5475
Merge pull request #1435 from ably/remove-react-hooks-license
owenpearson Sep 4, 2023
185e253
README: Fix React categorisation and WebWorkers bug
mattheworiordan Sep 15, 2023
2743ae0
Update React docs
mattheworiordan Sep 15, 2023
8f10637
fix: send ably agent as header in react-hooks time ping
owenpearson Sep 18, 2023
093307e
Merge pull request #1440 from ably/mattheworiordan-react-docs-patch
owenpearson Sep 18, 2023
7ba842c
Merge pull request #1441 from ably/react-hooks-ping-agent-fix
owenpearson Sep 18, 2023
723b40c
docs: add docs for preventing warnings when used with NextJS
owenpearson Sep 19, 2023
b5f11de
refactor!: remove `AblyProvider` options prop
owenpearson Sep 21, 2023
1d38537
docs: add array -> object hook return values to react migration guide
owenpearson Sep 21, 2023
6e52d0e
Merge pull request #1444 from ably/nextjs-warnings-advice
owenpearson Sep 22, 2023
d735e23
Merge pull request #1446 from ably/remove-provider-options-prop
owenpearson Sep 22, 2023
ec653f1
Merge pull request #1447 from ably/react-migration-guide-update
owenpearson Sep 25, 2023
9181064
fix: throw descriptive error when callbacks used with react
owenpearson Sep 25, 2023
fbcd191
Merge pull request #1450 from ably/react-callbacks-error-message
owenpearson Sep 25, 2023
e80b21b
docs: update changelog for 1.2.45 release
owenpearson Sep 25, 2023
be0085d
chore: bump version for 1.2.45 release
owenpearson Sep 25, 2023
76cc74f
Merge pull request #1451 from ably/release/1.2.45
owenpearson Sep 25, 2023
2c94dbf
fix: add missing id param for useStateErrors call to useChannelStateL…
owenpearson Sep 29, 2023
688fbef
test: fix browser test rest_host query param
owenpearson Oct 4, 2023
89589f1
Merge pull request #1457 from ably/fix-test-env-rest_host-param
owenpearson Oct 4, 2023
4879d50
fix: wrap usePresence channel options in ref
owenpearson Oct 4, 2023
695e5bb
refactor: send react-hooks agent as channel param
owenpearson Oct 4, 2023
7c59b7d
Publish to new CDN bucket only
surminus Oct 5, 2023
a298240
refactor: make arrEvery callback params non-optional
owenpearson Oct 5, 2023
65ff5d7
refactor: add `arrEquals` util
owenpearson Oct 5, 2023
83b4516
Merge pull request #1460 from ably/laura-delete-old-cdn-bucket
owenpearson Oct 5, 2023
1de1a64
fix: don't double url encode agent transport param
owenpearson Oct 12, 2023
311726e
fix: avoid directly exporting Ably.ErrorInfo from promises.js
owenpearson Oct 17, 2023
374252c
Merge pull request #1463 from ably/fix-errorinfo-promise-export
owenpearson Oct 19, 2023
0d7dd24
Merge pull request #1462 from ably/fix-double-encoded-agent
owenpearson Oct 19, 2023
f38c5a7
fix: improve channel options reattachment logic
owenpearson Oct 5, 2023
a35b65c
Merge pull request #1459 from ably/react-hooks-agent-channel-param
owenpearson Oct 19, 2023
dfe425c
Fix RealtimePresence#leave handling of PresenceMessage argument
lawrence-forooghian Oct 20, 2023
292c0f3
deps: bump ws to 8.14.2
owenpearson Oct 23, 2023
c3bac03
Merge pull request #1455 from ably/fix-use-state-errors-missing-id-param
owenpearson Oct 23, 2023
6855073
doc(README): remove typo
Chaitanya110703 Oct 23, 2023
73a86a3
Merge pull request #1466 from ably/1465-presence-leave-handle-presenc…
lawrence-forooghian Oct 23, 2023
0e99593
Merge pull request #1468 from Chaitanya110703/patch-1
owenpearson Oct 24, 2023
5725e73
Merge pull request #1467 from ably/upgrade-ws
owenpearson Oct 24, 2023
aaca8b6
chore: bump version for 1.2.46 release
owenpearson Oct 24, 2023
5dcdd97
chore: update changelog for 1.2.46 release
owenpearson Oct 24, 2023
e3e6781
Merge pull request #1471 from ably/release/1.2.46
owenpearson Oct 25, 2023
ddef9f7
Turn off continue-on-error for browser jobs
lawrence-forooghian Nov 1, 2023
16d620c
fix: don't compare `agent` channel param when determining whether cha…
Nov 1, 2023
2d839b4
fix(react): ensure channel options are passed to channel state listen…
Nov 1, 2023
d6978ca
Merge pull request #1479 from ably/browser-failure-email-notifications
lawrence-forooghian Nov 1, 2023
5857e59
Merge pull request #1478 from ably/react-channel-options-fix
owenpearson Nov 1, 2023
47fe269
chore: update changelog for 1.2.47 release
Nov 2, 2023
edd50b0
chore: bump version for 1.2.47 release
Nov 2, 2023
b87ac65
Merge pull request #1481 from ably/release/1.2.47
owenpearson Nov 2, 2023
54932b4
Upgrade Playwright to 1.39.0
lawrence-forooghian Nov 3, 2023
68bf030
Merge remote-tracking branch 'origin/main' into 2023-11-01-merge-main…
lawrence-forooghian Nov 1, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs/react.md
Original file line number Diff line number Diff line change
@@ -327,3 +327,42 @@ usePresence({ channelName: "your-channel-name", id: ablyContextId }, (presenceUp
...
})
```

## NextJS warnings

Currently, when using our react library with NextJS you may encounter some warnings which arise due to some static checks against subdependencies of the library.
While these warnings won't affect the performance of the library and are safe to ignore, we understand that they are an annoyance and offer the following advice to prevent them from displaying:

### Critical dependency: the request of a dependency is an expression

This warning comes from keyv which is a subdependency of our NodeJS http client.
You can read more about the reason this warning is displayed at [jaredwray/keyv#45](https://github.com/jaredwray/keyv/issues/45).

You can avoid this warning by overriding the version of keyv used by adding the following to your package.json:

```json
"overrides": {
"cacheable-request": {
"keyv": "npm:@keyvhq/core@~1.6.6"
}
}
```

### Module not found: Can't resolve 'bufferutil'/'utf-8-validate'

These warnings come from devDependencies which are conditionally loaded in the ws module (our NodeJS websocket client).
They aren't required for the websocket client to work, however NextJS will statically analyse imports and incorrectly assume that these are needed.

You can avoid this warning by adding the following to your next.config.js:

```javascript
module.exports = {
webpack: (config) => {
config.externals.push({
'utf-8-validate': 'commonjs utf-8-validate',
'bufferutil': 'commonjs bufferutil',
})
return config
},
}
```