@modusoperandi/licit 1.4.3 → 1.4.7

package/client/EditorConnection.js.flow

@@ -1,324 +1,324 @@
-// @flow
-
-import {
-  collab,
-  getVersion,
-  receiveTransaction,
-  sendableSteps,
-} from 'prosemirror-collab';
-import { Plugin, EditorState } from 'prosemirror-state';
-import { Step } from 'prosemirror-transform';
-import { EditorView } from 'prosemirror-view';
-import uuid from '../uuid.js';
-import { GET, POST, PUT } from './http.js';
-// [FS] IRAD-1040 2020-09-02
-import { Schema } from 'prosemirror-model';
-import { stringify } from 'flatted';
-
-function badVersion(err: Object) {
-  return err.status == 400 && /invalid version/i.test(String(err));
-}
-
-class State {
-  edit: EditorState;
-  comm: ?string;
-
-  constructor(edit: ?EditorState, comm: ?string) {
-    this.edit = edit;
-    this.comm = comm;
-  }
-}
-class EditorConnection {
-  backOff: number;
-  onReady: Function;
-  ready: boolean;
-  report: any;
-  request: any;
-  state: State;
-  url: string;
-  view: ?EditorView;
-  schema: Schema;
-  plugins: Array<Plugin>;
-  defaultSchema: Schema;
-
-  constructor(
-    onReady: Function,
-    report: any,
-    url: string,
-    plugins: Array<Plugin>,
-    defaultSchema: Schema
-  ) {
-    this.schema = null;
-    this.report = report;
-    this.url = url;
-    this.state = new State(null, 'start');
-    this.request = null;
-    this.backOff = 0;
-    this.view = null;
-    this.dispatch = this.dispatch.bind(this);
-    this.ready = false;
-    this.onReady = onReady;
-    this.plugins = plugins;
-    this.defaultSchema = defaultSchema;
-  }
-
-  // [FS] IRAD-1040 2020-09-08
-  getEffectiveSchema(): Schema {
-    return null != this.schema ? this.schema : this.defaultSchema;
-  }
-
-  // All state changes go through this
-  dispatch = (action: Object): void => {
-    let newEditState = null;
-    if (action.type == 'loaded') {
-      const editState = EditorState.create({
-        doc: action.doc,
-        plugins: this.plugins.concat([
-          collab({
-            clientID: uuid(),
-            version: action.version,
-          }),
-        ]),
-      });
-      this.state = new State(editState, 'poll');
-      this.ready = true;
-      this.onReady(editState);
-      this.poll();
-    } else if (action.type == 'restart') {
-      this.state = new State(null, 'start');
-      this.start();
-    } else if (action.type == 'poll') {
-      this.state = new State(this.state.edit, 'poll');
-      this.poll();
-    } else if (action.type == 'recover') {
-      if (action.error.status && action.error.status < 500) {
-        this.report.failure(action.error);
-        this.state = new State(null, null);
-      } else {
-        this.state = new State(this.state.edit, 'recover');
-        this.recover(action.error);
-      }
-    } else if (action.type == 'transaction') {
-      newEditState = this.state.edit
-        ? this.state.edit.apply(action.transaction)
-        : null;
-    }
-
-    if (newEditState) {
-      let sendable;
-      if (newEditState.doc.content.size > 4000000000000) {
-        if (this.state.comm !== 'detached') {
-          this.report.failure('Document too big. Detached.');
-        }
-        this.state = new State(newEditState, 'detached');
-      } else if (
-        (this.state.comm == 'poll' || action.requestDone) &&
-        (sendable = this.sendable(newEditState))
-      ) {
-        this.closeRequest();
-        this.state = new State(newEditState, 'send');
-        this.send(newEditState, sendable);
-      } else if (action.requestDone) {
-        this.state = new State(newEditState, 'poll');
-        this.poll();
-      } else {
-        this.state = new State(newEditState, this.state.comm);
-      }
-    }
-
-    // Sync the editor with this.state.edit
-    if (this.state.edit && this.view) {
-      this.view.updateState(this.state.edit);
-    }
-  };
-
-  dispatchData(data: any) {
-    this.report.success();
-    this.backOff = 0;
-    this.dispatch({
-      type: 'loaded',
-      doc: this.getEffectiveSchema().nodeFromJSON(data),
-      version: data.version,
-      users: data.users,
-    });
-  }
-
-  // Load the document from the server and start up
-  start(input: any, dataDefined: boolean): void {
-    const query = '?dataDefined=' + dataDefined;
-    this.run(
-      input
-        ? PUT(this.url + query, JSON.stringify(input), 'application/json')
-        : GET(this.url, 'application/json')
-    ).then(
-      (data) => {
-        data = JSON.parse(data);
-        this.report.success();
-        this.backOff = 0;
-        this.dispatch({
-          type: 'loaded',
-          doc: this.getEffectiveSchema().nodeFromJSON(data.doc_json),
-          version: data.version,
-          users: data.users,
-        });
-      },
-      (err) => {
-        this.report.failure(err);
-      }
-    );
-  }
-
-  // Send a request for events that have happened since the version
-  // of the document that the client knows about. This request waits
-  // for a new version of the document to be created if the client
-  // is already up-to-date.
-  poll(): void {
-    const query = 'version=' + getVersion(this.state.edit);
-    this.run(GET(this.url + '/events?' + query)).then(
-      (data) => {
-        this.report.success();
-        data = JSON.parse(data);
-        this.backOff = 0;
-        if (data.steps?.length) {
-          const tr = receiveTransaction(
-            this.state.edit,
-            data.steps.map((j) => Step.fromJSON(this.getEffectiveSchema(), j)),
-            data.clientIDs
-          );
-          this.dispatch({
-            type: 'transaction',
-            transaction: tr,
-            requestDone: true,
-          });
-        } else {
-          this.poll();
-        }
-      },
-      (err) => {
-        if (err.status == 410 || badVersion(err)) {
-          // Too far behind. Revert to server state
-          this.report.failure(err);
-          this.dispatch({ type: 'restart' });
-        } else if (err) {
-          this.dispatch({ type: 'recover', error: err });
-        }
-      }
-    );
-  }
-
-  sendable(editState: EditorState): ?{ steps: Array<Step> } {
-    const steps = sendableSteps(editState);
-    if (steps) {
-      return { steps };
-    }
-    return null;
-  }
-
-  // Send the given steps to the server
-  send(editState: EditorState, sendable: Object) {
-    const { steps } = sendable;
-    const json = JSON.stringify({
-      version: getVersion(editState),
-      steps: steps ? steps.steps.map((s) => s.toJSON()) : [],
-      clientID: steps ? steps.clientID : 0,
-    });
-    this.run(POST(this.url + '/events', json, 'application/json')).then(
-      (data) => {
-        this.report.success();
-        this.backOff = 0;
-        const tr = steps
-          ? receiveTransaction(
-              this.state.edit,
-              steps.steps,
-              repeat(steps.clientID, steps.steps.length)
-            )
-          : this.state.edit.tr;
-
-        this.dispatch({
-          type: 'transaction',
-          transaction: tr,
-          requestDone: true,
-        });
-      },
-      (err) => {
-        if (err.status == 409) {
-          // The client's document conflicts with the server's version.
-          // Poll for changes and then try again.
-          this.backOff = 0;
-          this.dispatch({ type: 'poll' });
-        } else if (badVersion(err)) {
-          this.report.failure(err);
-          this.dispatch({ type: 'restart' });
-        } else {
-          this.dispatch({ type: 'recover', error: err });
-        }
-      }
-    );
-  }
-
-  // [FS] IRAD-1040 2020-09-02
-  // Send the modified schema to server
-  updateSchema(schema: Schema, input: any, dataDefined: boolean) {
-    // to avoid cyclic reference error, use flatted string.
-    const schemaFlatted = stringify(schema);
-    this.run(POST(this.url + '/schema/', schemaFlatted, 'text/plain')).then(
-      (data) => {
-        console.log("collab server's schema updated");
-        // [FS] IRAD-1040 2020-09-08
-        this.schema = schema;
-        this.start(input, dataDefined);
-      },
-      (err) => {
-        this.report.failure(err);
-      }
-    );
-  }
-
-  // Try to recover from an error
-  recover(err: Error): void {
-    const newBackOff = this.backOff ? Math.min(this.backOff * 2, 6e4) : 200;
-    if (newBackOff > 1000 && this.backOff < 1000) {
-      this.report.delay(err);
-    }
-    this.backOff = newBackOff;
-    setTimeout(() => {
-      if (this.state.comm == 'recover') {
-        this.dispatch({ type: 'poll' });
-      }
-    }, this.backOff);
-  }
-
-  closeRequest(): void {
-    if (this.request) {
-      this.request.abort();
-      this.request = null;
-    }
-  }
-
-  run(request: any): Promise<any> {
-    this.request = request;
-    return this.request;
-  }
-
-  close(): void {
-    this.closeRequest();
-    this.setView(null);
-  }
-
-  setView(view: EditorView): void {
-    if (this.view) {
-      this.view.destroy();
-    }
-    this.view = window.view = view;
-  }
-}
-
-function repeat(val: any, n: number): Array<any> {
-  const result = [];
-  for (let i = 0; i < n; i++) {
-    result.push(val);
-  }
-  return result;
-}
-
-export default EditorConnection;
+// @flow
+
+import {
+  collab,
+  getVersion,
+  receiveTransaction,
+  sendableSteps,
+} from 'prosemirror-collab';
+import { Plugin, EditorState } from 'prosemirror-state';
+import { Step } from 'prosemirror-transform';
+import { EditorView } from 'prosemirror-view';
+import uuid from '../uuid.js';
+import { GET, POST, PUT } from './http.js';
+// [FS] IRAD-1040 2020-09-02
+import { Schema } from 'prosemirror-model';
+import { stringify } from 'flatted';
+
+function badVersion(err: Object) {
+  return err.status == 400 && /invalid version/i.test(String(err));
+}
+
+class State {
+  edit: EditorState;
+  comm: ?string;
+
+  constructor(edit: ?EditorState, comm: ?string) {
+    this.edit = edit;
+    this.comm = comm;
+  }
+}
+class EditorConnection {
+  backOff: number;
+  onReady: Function;
+  ready: boolean;
+  report: any;
+  request: any;
+  state: State;
+  url: string;
+  view: ?EditorView;
+  schema: Schema;
+  plugins: Array<Plugin>;
+  defaultSchema: Schema;
+
+  constructor(
+    onReady: Function,
+    report: any,
+    url: string,
+    plugins: Array<Plugin>,
+    defaultSchema: Schema
+  ) {
+    this.schema = null;
+    this.report = report;
+    this.url = url;
+    this.state = new State(null, 'start');
+    this.request = null;
+    this.backOff = 0;
+    this.view = null;
+    this.dispatch = this.dispatch.bind(this);
+    this.ready = false;
+    this.onReady = onReady;
+    this.plugins = plugins;
+    this.defaultSchema = defaultSchema;
+  }
+
+  // [FS] IRAD-1040 2020-09-08
+  getEffectiveSchema(): Schema {
+    return null != this.schema ? this.schema : this.defaultSchema;
+  }
+
+  // All state changes go through this
+  dispatch = (action: Object): void => {
+    let newEditState = null;
+    if (action.type == 'loaded') {
+      const editState = EditorState.create({
+        doc: action.doc,
+        plugins: this.plugins.concat([
+          collab({
+            clientID: uuid(),
+            version: action.version,
+          }),
+        ]),
+      });
+      this.state = new State(editState, 'poll');
+      this.ready = true;
+      this.onReady(editState);
+      this.poll();
+    } else if (action.type == 'restart') {
+      this.state = new State(null, 'start');
+      this.start();
+    } else if (action.type == 'poll') {
+      this.state = new State(this.state.edit, 'poll');
+      this.poll();
+    } else if (action.type == 'recover') {
+      if (action.error.status && action.error.status < 500) {
+        this.report.failure(action.error);
+        this.state = new State(null, null);
+      } else {
+        this.state = new State(this.state.edit, 'recover');
+        this.recover(action.error);
+      }
+    } else if (action.type == 'transaction') {
+      newEditState = this.state.edit
+        ? this.state.edit.apply(action.transaction)
+        : null;
+    }
+
+    if (newEditState) {
+      let sendable;
+      if (newEditState.doc.content.size > 4000000000000) {
+        if (this.state.comm !== 'detached') {
+          this.report.failure('Document too big. Detached.');
+        }
+        this.state = new State(newEditState, 'detached');
+      } else if (
+        (this.state.comm == 'poll' || action.requestDone) &&
+        (sendable = this.sendable(newEditState))
+      ) {
+        this.closeRequest();
+        this.state = new State(newEditState, 'send');
+        this.send(newEditState, sendable);
+      } else if (action.requestDone) {
+        this.state = new State(newEditState, 'poll');
+        this.poll();
+      } else {
+        this.state = new State(newEditState, this.state.comm);
+      }
+    }
+
+    // Sync the editor with this.state.edit
+    if (this.state.edit && this.view) {
+      this.view.updateState(this.state.edit);
+    }
+  };
+
+  dispatchData(data: any) {
+    this.report.success();
+    this.backOff = 0;
+    this.dispatch({
+      type: 'loaded',
+      doc: this.getEffectiveSchema().nodeFromJSON(data),
+      version: data.version,
+      users: data.users,
+    });
+  }
+
+  // Load the document from the server and start up
+  start(input: any, dataDefined: boolean): void {
+    const query = '?dataDefined=' + dataDefined;
+    this.run(
+      input
+        ? PUT(this.url + query, JSON.stringify(input), 'application/json')
+        : GET(this.url, 'application/json')
+    ).then(
+      (data) => {
+        data = JSON.parse(data);
+        this.report.success();
+        this.backOff = 0;
+        this.dispatch({
+          type: 'loaded',
+          doc: this.getEffectiveSchema().nodeFromJSON(data.doc_json),
+          version: data.version,
+          users: data.users,
+        });
+      },
+      (err) => {
+        this.report.failure(err);
+      }
+    );
+  }
+
+  // Send a request for events that have happened since the version
+  // of the document that the client knows about. This request waits
+  // for a new version of the document to be created if the client
+  // is already up-to-date.
+  poll(): void {
+    const query = 'version=' + getVersion(this.state.edit);
+    this.run(GET(this.url + '/events?' + query)).then(
+      (data) => {
+        this.report.success();
+        data = JSON.parse(data);
+        this.backOff = 0;
+        if (data.steps?.length) {
+          const tr = receiveTransaction(
+            this.state.edit,
+            data.steps.map((j) => Step.fromJSON(this.getEffectiveSchema(), j)),
+            data.clientIDs
+          );
+          this.dispatch({
+            type: 'transaction',
+            transaction: tr,
+            requestDone: true,
+          });
+        } else {
+          this.poll();
+        }
+      },
+      (err) => {
+        if (err.status == 410 || badVersion(err)) {
+          // Too far behind. Revert to server state
+          this.report.failure(err);
+          this.dispatch({ type: 'restart' });
+        } else if (err) {
+          this.dispatch({ type: 'recover', error: err });
+        }
+      }
+    );
+  }
+
+  sendable(editState: EditorState): ?{ steps: Array<Step> } {
+    const steps = sendableSteps(editState);
+    if (steps) {
+      return { steps };
+    }
+    return null;
+  }
+
+  // Send the given steps to the server
+  send(editState: EditorState, sendable: Object) {
+    const { steps } = sendable;
+    const json = JSON.stringify({
+      version: getVersion(editState),
+      steps: steps ? steps.steps.map((s) => s.toJSON()) : [],
+      clientID: steps ? steps.clientID : 0,
+    });
+    this.run(POST(this.url + '/events', json, 'application/json')).then(
+      (data) => {
+        this.report.success();
+        this.backOff = 0;
+        const tr = steps
+          ? receiveTransaction(
+              this.state.edit,
+              steps.steps,
+              repeat(steps.clientID, steps.steps.length)
+            )
+          : this.state.edit.tr;
+
+        this.dispatch({
+          type: 'transaction',
+          transaction: tr,
+          requestDone: true,
+        });
+      },
+      (err) => {
+        if (err.status == 409) {
+          // The client's document conflicts with the server's version.
+          // Poll for changes and then try again.
+          this.backOff = 0;
+          this.dispatch({ type: 'poll' });
+        } else if (badVersion(err)) {
+          this.report.failure(err);
+          this.dispatch({ type: 'restart' });
+        } else {
+          this.dispatch({ type: 'recover', error: err });
+        }
+      }
+    );
+  }
+
+  // [FS] IRAD-1040 2020-09-02
+  // Send the modified schema to server
+  updateSchema(schema: Schema, input: any, dataDefined: boolean) {
+    // to avoid cyclic reference error, use flatted string.
+    const schemaFlatted = stringify(schema);
+    this.run(POST(this.url + '/schema/', schemaFlatted, 'text/plain')).then(
+      (data) => {
+        console.log("collab server's schema updated");
+        // [FS] IRAD-1040 2020-09-08
+        this.schema = schema;
+        this.start(input, dataDefined);
+      },
+      (err) => {
+        this.report.failure(err);
+      }
+    );
+  }
+
+  // Try to recover from an error
+  recover(err: Error): void {
+    const newBackOff = this.backOff ? Math.min(this.backOff * 2, 6e4) : 200;
+    if (newBackOff > 1000 && this.backOff < 1000) {
+      this.report.delay(err);
+    }
+    this.backOff = newBackOff;
+    setTimeout(() => {
+      if (this.state.comm == 'recover') {
+        this.dispatch({ type: 'poll' });
+      }
+    }, this.backOff);
+  }
+
+  closeRequest(): void {
+    if (this.request) {
+      this.request.abort();
+      this.request = null;
+    }
+  }
+
+  run(request: any): Promise<any> {
+    this.request = request;
+    return this.request;
+  }
+
+  close(): void {
+    this.closeRequest();
+    this.setView(null);
+  }
+
+  setView(view: EditorView): void {
+    if (this.view) {
+      this.view.destroy();
+    }
+    this.view = window.view = view;
+  }
+}
+
+function repeat(val: any, n: number): Array<any> {
+  const result = [];
+  for (let i = 0; i < n; i++) {
+    result.push(val);
+  }
+  return result;
+}
+
+export default EditorConnection;