fix: Various fixes for collaborative editing beta (#2561)

* fix: Remove Saving… message when collab enabled

* chore: Add tracing extension to collaboration server

* fix: Incorrect debounce behavior due to missing timestamps on events, fixes abundence of notifications when editing in realtime collab mode

* fix: Reload document prompt when collab editing

server/collaboration/logger.js

@@ -0,0 +1,22 @@
+// @flow
+import debug from "debug";
+
+const log = debug("server");
+
+export default class Logger {
+  async onCreateDocument(data: { documentName: string }) {
+    log(`Created document "${data.documentName}"`);
+  }
+
+  async onConnect(data: { documentName: string }) {
+    log(`New connection to "${data.documentName}"`);
+  }
+
+  async onDisconnect(data: { documentName: string }) {
+    log(`Connection to "${data.documentName}" closed`);
+  }
+
+  async onUpgrade() {
+    log("Upgrading connection");
+  }
+}

server/collaboration/tracing.js

@@ -0,0 +1,40 @@
+// @flow
+import * as metrics from "../utils/metrics";
+
+let count = 0;
+
+export default class Tracing {
+  async onCreateDocument({ documentName }: { documentName: string }) {
+    metrics.increment("collaboration.create_document", { documentName });
+
+    // TODO: Waiting for `instance` available in payload
+    // metrics.gaugePerInstance(
+    //   "collaboration.documents_count",
+    //   instance.documents.size()
+    // );
+  }
+
+  async onAuthenticationFailed({ documentName }: { documentName: string }) {
+    metrics.increment("collaboration.authentication_failed", { documentName });
+  }
+
+  async onConnect({ documentName }: { documentName: string }) {
+    metrics.increment("collaboration.connect", { documentName });
+    metrics.gaugePerInstance("collaboration.connections_count", ++count);
+  }
+
+  async onDisconnect({ documentName }: { documentName: string }) {
+    metrics.increment("collaboration.disconnect", { documentName });
+    metrics.gaugePerInstance("collaboration.connections_count", --count);
+
+    // TODO: Waiting for `instance` available in payload
+    // metrics.gaugePerInstance(
+    //   "collaboration.documents_count",
+    //   instance.documents.size()
+    // );
+  }
+
+  async onChange({ documentName }: { documentName: string }) {
+    metrics.increment("collaboration.change", { documentName });
+  }
+}

server/models/Event.js

@@ -45,13 +45,21 @@ Event.beforeCreate((event) => {
 });
 
 Event.afterCreate((event) => {
-  globalEventQueue.add(event, { removeOnComplete: true });
+  globalEventQueue.add(event);
 });
 
 // add can be used to send events into the event system without recording them
-// in the database / audit trail
+// in the database or audit trail
 Event.add = (event) => {
-  globalEventQueue.add(Event.build(event), { removeOnComplete: true });
+  const now = new Date();
+
+  globalEventQueue.add(
+    Event.build({
+      createdAt: now,
+      updatedAt: now,
+      ...event,
+    })
+  );
 };
 
 Event.ACTIVITY_EVENTS = [

server/services/collaboration.js

@@ -1,12 +1,13 @@
 // @flow
 import http from "http";
-import { Logger } from "@hocuspocus/extension-logger";
 import { Server } from "@hocuspocus/server";
 import Koa from "koa";
 import websocket from "koa-easy-ws";
 import Router from "koa-router";
 import AuthenticationExtension from "../collaboration/authentication";
+import LoggerExtension from "../collaboration/logger";
 import PersistenceExtension from "../collaboration/persistence";
+import TracingExtension from "../collaboration/tracing";
 
 export default function init(app: Koa, server: http.Server) {
   const router = new Router();
@@ -15,7 +16,8 @@ export default function init(app: Koa, server: http.Server) {
     extensions: [
       new AuthenticationExtension(),
       new PersistenceExtension(),
-      new Logger(),
+      new LoggerExtension(),
+      new TracingExtension(),
     ],
   });
 

server/services/worker.js

@@ -36,13 +36,10 @@ export default function init(app: Koa, server?: http.Server) {
   // this queue processes global events and hands them off to services
   globalEventQueue.process(function (job) {
     Object.keys(eventProcessors).forEach((name) => {
-      processorEventQueue.add(
-        { ...job.data, service: name },
-        { removeOnComplete: true }
-      );
+      processorEventQueue.add({ ...job.data, service: name });
     });
 
-    websocketsQueue.add(job.data, { removeOnComplete: true });
+    websocketsQueue.add(job.data);
   });
 
   processorEventQueue.process(function (job) {