Merge branch 'feat/use-mutecore-id-as-principal-id' into 'master'

feat: use mutecoreid as principal id

See merge request coast-team/mute/mute-modules/mute-core!1

Author: BaptisteHubert

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@coast-team/mute-core",
   "description": "Core component of MUTE collaborative editor",
-  "version": "10.0.0-2.2",
+  "version": "11.0.0",
   "main": "./dist/mute-core.node.es5.cjs.js",
   "module": "./dist/mutecore.node.es5.esm.js",
   "browser": "./dist/mute-core.browser.es5.esm.js",
@@ -26,7 +26,8 @@
   "contributors": [
     "Philippe Kalitine <[email protected]> (https://philippe.kalitine.name/)",
     "Quentin Tardivon",
-    "Cedric Enclos"
+    "Cedric Enclos",
+    "Baptiste Hubert"
   ],
   "license": "GPL-3.0",
   "publishConfig": {

package.json

@@ -25,9 +25,10 @@ export class CollaboratorsService extends Service<proto.ICollaborator, proto.Col
     this.joinSubject = new Subject()
     this.leaveSubject = new Subject()
 
-    this.newSub = this.messageIn$.subscribe(({ senderId, msg }) => {
-      const updated = { id: senderId, ...msg }
-      const collab = this.collaborators.get(senderId)
+    this.newSub = this.messageIn$.subscribe(({ senderNetworkId, msg }) => {
+      const updated = { ...msg }
+      const collab = this.collaborators.get(senderNetworkId)
+
       if (collab) {
         collab.muteCoreId = updated.muteCoreId || collab.muteCoreId
         collab.displayName = updated.displayName || collab.displayName
@@ -37,7 +38,7 @@ export class CollaboratorsService extends Service<proto.ICollaborator, proto.Col
         collab.deviceID = updated.deviceID || collab.deviceID
         this.updateSubject.next(collab)
       } else {
-        this.collaborators.set(updated.id, updated)
+        this.collaborators.set(senderNetworkId, updated)
         this.joinSubject.next(updated)
       }
     })
@@ -65,18 +66,18 @@ export class CollaboratorsService extends Service<proto.ICollaborator, proto.Col
   }
 
   set memberJoin$(source: Observable<number>) {
-    this.newSub = source.subscribe((id: number) =>
-      this.emitUpdate(StreamsSubtype.COLLABORATORS_JOIN, id)
+    this.newSub = source.subscribe((networkId: number) =>
+      this.emitUpdate(StreamsSubtype.COLLABORATORS_JOIN, networkId)
     )
   }
 
   set memberLeave$(source: Observable<number>) {
-    this.newSub = source.subscribe((id: number) => {
-      const collab = this.collaborators.get(id)
+    this.newSub = source.subscribe((networkId: number) => {
+      const collab = this.collaborators.get(networkId)
       if (collab) {
         this.leaveSubject.next(collab)
       }
-      this.collaborators.delete(id)
+      this.collaborators.delete(networkId)
     })
   }
 
@@ -94,8 +95,8 @@ export class CollaboratorsService extends Service<proto.ICollaborator, proto.Col
     super.dispose()
   }
 
-  private emitUpdate(subtype: StreamsSubtype, recipientId?: number) {
-    const { id, ...rest } = this.me
-    super.send(rest, subtype, recipientId)
+  private emitUpdate(subtype: StreamsSubtype, recipientNetworkId?: number) {
+    const { ...rest } = this.me
+    super.send(rest, subtype, recipientNetworkId)
   }
 }

src/collaborators/CollaboratorsService.ts

@@ -1,5 +1,4 @@
 export interface ICollaborator {
-  id: number
   muteCoreId?: number
   displayName?: string
   login?: string

src/collaborators/ICollaborator.ts

@@ -22,13 +22,13 @@ export abstract class SyncMessage<Op> extends Service<proto.ISyncMsg, proto.Sync
     this.remoteReplySyncSubject = new Subject()
 
     // FIXME: should I save the subscription for later unsubscribe/subscribe?
-    this.newSub = this.messageIn$.subscribe(({ senderId, msg }) => {
+    this.newSub = this.messageIn$.subscribe(({ senderNetworkId, msg }) => {
       switch (msg.type) {
         case 'richOpMsg':
           this.handleRichOpMsg(msg.richOpMsg as proto.RichOperationMsg)
           break
         case 'querySync':
-          this.remoteQuerySyncIdSubject.next(senderId) // Register the id of the peer
+          this.remoteQuerySyncIdSubject.next(senderNetworkId) // Register the id of the peer
           this.handleQuerySyncMsg(msg.querySync as proto.QuerySyncMsg)
           break
         case 'replySync':

src/core/SyncMessage.ts

@@ -6,9 +6,9 @@ interface IMessage {
 }
 
 export interface IMessageIn extends IMessage {
-  senderId: number
+  senderNetworkId: number
 }
 
 export interface IMessageOut extends IMessage {
-  recipientId?: number // O value means send to a random peer
+  recipientNetworkId?: number // O value means send to a random peer
 }

src/misc/IMessage.ts

@@ -12,7 +12,7 @@ export interface IMessageFactory<OutMsg, InMsg extends OutMsg> {
 }
 
 export abstract class Service<OutMsg, InMsg extends OutMsg> extends Disposable {
-  protected messageIn$: Observable<{ senderId: number; msg: InMsg }>
+  protected messageIn$: Observable<{ senderNetworkId: number; msg: InMsg }>
 
   private messageOut$: Subject<IMessageOut>
   private streamId: Streams
@@ -31,16 +31,16 @@ export abstract class Service<OutMsg, InMsg extends OutMsg> extends Disposable {
     this.proto = proto
     this.messageIn$ = messageIn.pipe(
       filter(({ streamId }) => streamId.type === myStreamId),
-      map(({ senderId, content }) => ({ senderId, msg: proto.decode(content) }))
+      map(({ senderNetworkId, content }) => ({ senderNetworkId, msg: proto.decode(content) }))
     )
     this.messageOut$ = messageOut
     this.streamId = myStreamId
   }
 
-  protected send(msg: OutMsg, subtype: StreamsSubtype, recipientId?: number) {
+  protected send(msg: OutMsg, subtype: StreamsSubtype, recipientNetworkId?: number) {
     this.messageOut$.next({
       streamId: { type: this.streamId, subtype },
-      recipientId,
+      recipientNetworkId,
       content: this.proto.encode(this.proto.create(msg)).finish(),
     })
   }

src/misc/Service.ts

@@ -691,7 +691,7 @@ export namespace sync {
         public lowerPos?: (sync.ISimpleDotPos|null);
 
         /** DottedLogootSBlockMsg content. */
-        public content: string;
+        public content?: (string|null);
 
         /** DottedLogootSBlockMsg concatLength. */
         public concatLength?: (sync.IConcatLength|null);