Allow arbitrary awareness fields in Collaboration plugin #4507

attnov · 2023-05-17T11:30:04Z

Summary

This change allows arbitrary data (for example 3rd party UUID) to be added to awareness. Right now user name and color is hard coded in Collaboration plugin. The new parameter awarenessData is optional.

Usage example

We can specify our arbitrary data like this:

const awarenessData = {
  uuid: 42,
  foo: 'bar',
);

With the new parameter, we can send down our arbitrary data:

<CollaborationPlugin
  id="id"
  providerFactory={providerFactory}
  shouldBootstrap={shouldBootstrap}
  awarenessData={awarenessData}
/>

vercel · 2023-05-17T11:30:09Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
lexical	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 19, 2023 3:02pm
lexical-playground	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 19, 2023 3:02pm

ivailop7

Thank you, Attila. @acywatson and @zurfyx . Could you give it a look as well.

fantactuka · 2023-05-18T13:11:06Z

I don't think this works since map is not json serializeable, should be plain object like remaining of awareness data. Personal opinion: naming looks a bit odd, as usage will be awareness.getLocalState().awarenessFields, maybe data or extraData would do better, no strong opinion tho.

Also can add a unit test (see Collaboration.test), as collab is quite sensitive for changes, so it's better to get it covered

fantactuka

~

attnov · 2023-05-18T16:48:37Z

I don't think this works since map is not json serializeable, should be plain object like remaining of awareness data. Personal opinion: naming looks a bit odd, as usage will be awareness.getLocalState().awarenessFields, maybe data or extraData would do better, no strong opinion tho.

Also can add a unit test (see Collaboration.test), as collab is quite sensitive for changes, so it's better to get it covered

@fantactuka Thanks for the review! I have changed the type from Map to object and added unit test.

fantactuka · 2023-05-18T17:53:01Z

packages/lexical-react/src/__tests__/unit/Collaboration.test.ts

+    expect(client1.awareness.getLocalState().awarenessFields).toEqual(
+      awarenessFields1,
+    );


Could you use awareness.getStates() instead, to ensure that client1 has proper awareness from client2 and vise versa?

It looks like here the mock for getStates() only inserts the current client's awareness state. That's why I opted for the getLocalState(). However, I have manually tested and between two collaborating users the awareness is sync correctly.

fantactuka · 2023-05-18T17:53:57Z

packages/lexical-react/src/shared/useYjsCollaboration.tsx

@@ -225,27 +229,41 @@ export function useYjsFocusTracking(
  provider: Provider,
  name: string,
  color: string,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  awarenessFields?: object,


I wonder if we can use { ... } here and remove eslint comment above

Actually, we don't need the eslint comments anymore - any is not used anymore. Removed all of them.

fantactuka · 2023-05-18T17:55:17Z

Thanks for updates!

@acywatson @zurfyx thoughts on naming?

acywatson · 2023-05-18T18:07:43Z

Thanks for updates!

@acywatson @zurfyx thoughts on naming?

I like having awareness in the name, but fields is probably wrong. "awarenessData" or "extraAwaresnessData" seems fine.

doc block on the interface would help people know what it's for.

attnov · 2023-05-19T11:38:27Z

Thanks for updates!
@acywatson @zurfyx thoughts on naming?

I like having awareness in the name, but fields is probably wrong. "awarenessData" or "extraAwaresnessData" seems fine.

doc block on the interface would help people know what it's for.

Renamed the parameter to awarenessData and added documentation on the inferface.

zurfyx · 2023-05-19T13:26:44Z

packages/lexical-react/src/__tests__/unit/utils.tsx

@@ -62,7 +63,8 @@ class Client {
  _listeners: Map<string, Set<(data: unknown) => void>>;
  _updates: Uint8Array[];
  awareness: {
-    getLocalState(): void;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    getLocalState(): any;


Can we make this better? Besides the object prop what other types we don't know?

I have added types for getLocalState(), getStates(), setLocalState(), etc.
Thanks for checking!

fantactuka · 2023-05-19T14:41:11Z

packages/lexical-yjs/src/index.ts

 ): void {
  provider.awareness.setLocalState({
    anchorPos: null,
+    awarenessData: awarenessData,


Suggested change

awarenessData: awarenessData,

awarenessData,

Similar one below

Added the change.

Co-authored-by: Attila Novak <anovak8@bloomberg.net>

Allow arbitrary awareness data in Collaboration plugin

22a08a5

attnov requested review from zurfyx, fantactuka, acywatson, tylerjbainbridge and thegreatercurve as code owners May 17, 2023 11:30

facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label May 17, 2023

vercel bot deployed to Preview – lexical May 17, 2023 11:31 View deployment

vercel bot deployed to Preview – lexical-playground May 17, 2023 11:32 View deployment

Attila Novak added 2 commits May 17, 2023 14:09

Rename arbitraryAwarenessData to awarenessFields

d6004d4

Change type of awarenessFields

4803905

attnov changed the title ~~Allow arbitrary awareness data in Collaboration plugin~~ Allow arbitrary awareness fields in Collaboration plugin May 17, 2023

vercel bot deployed to Preview – lexical May 17, 2023 13:23 View deployment

vercel bot deployed to Preview – lexical-playground May 17, 2023 13:24 View deployment

ivailop7 approved these changes May 17, 2023

View reviewed changes

fantactuka requested changes May 18, 2023

View reviewed changes

Attila Novak added 2 commits May 18, 2023 15:40

Change awarenessFields type from Map to object

b31e68c

Add unit test for awarenessFields

2f66e10

vercel bot deployed to Preview – lexical May 18, 2023 16:47 View deployment

vercel bot deployed to Preview – lexical-playground May 18, 2023 16:48 View deployment

fantactuka reviewed May 18, 2023

View reviewed changes

Attila Novak added 2 commits May 19, 2023 11:39

Rename awarenessFields to awarenessData. Remove eslint comments.

8770520

Fix unit test

856de4a

vercel bot deployed to Preview – lexical May 19, 2023 11:35 View deployment

vercel bot deployed to Preview – lexical-playground May 19, 2023 11:37 View deployment

zurfyx approved these changes May 19, 2023

View reviewed changes

Fix types in unit test

bd5531d

vercel bot deployed to Preview – lexical May 19, 2023 14:05 View deployment

vercel bot deployed to Preview – lexical-playground May 19, 2023 14:06 View deployment

fantactuka reviewed May 19, 2023

View reviewed changes

fantactuka approved these changes May 19, 2023

View reviewed changes

Review change

63f9bf2

vercel bot deployed to Preview – lexical May 19, 2023 15:01 View deployment

vercel bot deployed to Preview – lexical-playground May 19, 2023 15:02 View deployment

zurfyx merged commit 8ed0e0a into facebook:main May 19, 2023
34 of 45 checks passed

vuamitom pushed a commit to bitbriks/lexical that referenced this pull request May 19, 2023

Allow arbitrary awareness fields in Collaboration plugin (facebook#4507)

f27a984

Co-authored-by: Attila Novak <anovak8@bloomberg.net>

This was referenced May 23, 2023

v0.11.0 #4538

Closed

v0.11.0 #4539

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow arbitrary awareness fields in Collaboration plugin #4507

Allow arbitrary awareness fields in Collaboration plugin #4507

attnov commented May 17, 2023 •

edited

vercel bot commented May 17, 2023 •

edited

ivailop7 left a comment

fantactuka commented May 18, 2023 •

edited

fantactuka left a comment

attnov commented May 18, 2023

fantactuka May 18, 2023

attnov May 19, 2023 •

edited

fantactuka May 18, 2023

attnov May 19, 2023

fantactuka commented May 18, 2023

acywatson commented May 18, 2023

attnov commented May 19, 2023

zurfyx May 19, 2023

attnov May 19, 2023

fantactuka May 19, 2023

attnov May 19, 2023

Allow arbitrary awareness fields in Collaboration plugin #4507

Allow arbitrary awareness fields in Collaboration plugin #4507

Conversation

attnov commented May 17, 2023 • edited

Summary

Usage example

vercel bot commented May 17, 2023 • edited

ivailop7 left a comment

Choose a reason for hiding this comment

fantactuka commented May 18, 2023 • edited

fantactuka left a comment

Choose a reason for hiding this comment

attnov commented May 18, 2023

fantactuka May 18, 2023

Choose a reason for hiding this comment

attnov May 19, 2023 • edited

Choose a reason for hiding this comment

fantactuka May 18, 2023

Choose a reason for hiding this comment

attnov May 19, 2023

Choose a reason for hiding this comment

fantactuka commented May 18, 2023

acywatson commented May 18, 2023

attnov commented May 19, 2023

zurfyx May 19, 2023

Choose a reason for hiding this comment

attnov May 19, 2023

Choose a reason for hiding this comment

fantactuka May 19, 2023

Choose a reason for hiding this comment

attnov May 19, 2023

Choose a reason for hiding this comment

attnov commented May 17, 2023 •

edited

vercel bot commented May 17, 2023 •

edited

fantactuka commented May 18, 2023 •

edited

attnov May 19, 2023 •

edited