@eclipse-glsp/server 1.1.0-next.3d7585d.42 → 1.1.0-next.44bd1e0.43

package/lib/common/test/mock-util.js

@@ -14,9 +14,10 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
+/* eslint-disable @typescript-eslint/no-empty-function */
 // Stub-implementation classes used for unit testing
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StubClientSessionInitializer = exports.stubActionHandlerFactory = exports.TestContextEditValidator = exports.TestLabelEditValidator = exports.StubDiagramConfiguration = exports.StubGLSPServerListener = exports.StubGLSPClientProxy = exports.StubClientSessionListener = exports.StubLogger = exports.StubClientSessionManager = exports.StubClientSessionFactory = exports.StubActionDispatcher = exports.StubCreateEdgeOperationHandler = exports.StubCreateNodeOperationHandler = exports.StubActionHandler = exports.createClientSession = exports.delay = void 0;
+exports.StubCommand = exports.StubClientSessionInitializer = exports.stubActionHandlerFactory = exports.TestContextEditValidator = exports.TestLabelEditValidator = exports.StubDiagramConfiguration = exports.StubGLSPServerListener = exports.StubGLSPClientProxy = exports.StubClientSessionListener = exports.StubLogger = exports.StubClientSessionManager = exports.StubClientSessionFactory = exports.StubActionDispatcher = exports.StubCreateEdgeOperationHandler = exports.StubCreateNodeOperationHandler = exports.StubActionHandler = exports.createClientSession = exports.delay = void 0;
 const graph_1 = require("@eclipse-glsp/graph");
 const protocol_1 = require("@eclipse-glsp/protocol");
 const inversify_1 = require("inversify");
@@ -72,9 +73,7 @@ class StubCreateEdgeOperationHandler extends index_1.GModelCreateEdgeOperationHa
 }
 exports.StubCreateEdgeOperationHandler = StubCreateEdgeOperationHandler;
 class StubActionDispatcher {
-    dispatchAfterNextUpdate(...actions) {
-        // NO-OP
-    }
+    dispatchAfterNextUpdate(...actions) { }
     dispatch(action) {
         return Promise.resolve();
     }
@@ -121,45 +120,25 @@ class StubLogger extends logger_1.Logger {
         this.logLevel = logger_1.LogLevel.none;
         this.caller = undefined;
     }
-    info(message, ...params) {
-        // no-op
-    }
-    warn(message, ...params) {
-        // no-op
-    }
-    error(message, ...params) {
-        // no-op
-    }
-    debug(message, ...params) {
-        // no-op
-    }
+    info(message, ...params) { }
+    warn(message, ...params) { }
+    error(message, ...params) { }
+    debug(message, ...params) { }
 }
 exports.StubLogger = StubLogger;
 class StubClientSessionListener {
-    sessionCreated(clientSession) {
-        // no-op
-    }
-    sessionDisposed(clientSession) {
-        // no-op
-    }
+    sessionCreated(clientSession) { }
+    sessionDisposed(clientSession) { }
 }
 exports.StubClientSessionListener = StubClientSessionListener;
 class StubGLSPClientProxy {
-    connect(connection) {
-        // no-op
-    }
-    process(message) {
-        // no-op
-    }
+    connect(connection) { }
+    process(message) { }
 }
 exports.StubGLSPClientProxy = StubGLSPClientProxy;
 class StubGLSPServerListener {
-    serverInitialized(server) {
-        // no-op
-    }
-    serverShutDown(server) {
-        // no-op
-    }
+    serverInitialized(server) { }
+    serverShutDown(server) { }
 }
 exports.StubGLSPServerListener = StubGLSPServerListener;
 class StubDiagramConfiguration {
@@ -203,9 +182,13 @@ exports.TestContextEditValidator = TestContextEditValidator;
 const stubActionHandlerFactory = constructor => new constructor();
 exports.stubActionHandlerFactory = stubActionHandlerFactory;
 class StubClientSessionInitializer {
-    initialize(args) {
-        // no-op
-    }
+    initialize(args) { }
 }
 exports.StubClientSessionInitializer = StubClientSessionInitializer;
+class StubCommand {
+    execute() { }
+    undo() { }
+    redo() { }
+}
+exports.StubCommand = StubCommand;
 //# sourceMappingURL=mock-util.js.map

package/lib/common/test/mock-util.js.map

@@ -1 +1 @@
-{"version":3,"file":"mock-util.js","sourceRoot":"","sources":["../../../src/common/test/mock-util.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;kFAckF;AAClF,oDAAoD;;;AAEpD,+CAA4F;AAC5F,qDAYgC;AAChC,yCAAsC;AAItC,4EAA0F;AAE1F,yFAAoF;AACpF,2CAAqG;AASrG,4CAAmD;AAE5C,KAAK,UAAU,KAAK,CAAC,EAAU;IAClC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC;AAFD,sBAEC;AAED,SAAgB,mBAAmB,CAC/B,EAAU,EACV,WAAmB,EACnB,SAAS,GAAG,IAAI,qBAAS,EAAE,EAC3B,gBAAgB,GAAG,IAAI,oBAAoB,EAAE;IAE7C,OAAO;QACH,EAAE;QACF,WAAW;QACX,SAAS;QACT,gBAAgB;QAChB,OAAO,EAAE,GAAG,EAAE;YACV,EAAE;QACN,CAAC;KACJ,CAAC;AACN,CAAC;AAfD,kDAeC;AAED,MAAa,iBAAiB;IAC1B,YAAmB,WAAqB;QAArB,gBAAW,GAAX,WAAW,CAAU;IAAG,CAAC;IAE5C,OAAO,CAAC,MAAc;QAClB,OAAO,EAAE,CAAC;IACd,CAAC;CACJ;AAND,8CAMC;AAED,MAAa,8BAA+B,SAAQ,wCAAgC;IAGhF,YAAqB,KAAa;QAC9B,KAAK,EAAE,CAAC;QADS,UAAK,GAAL,KAAK,CAAQ;QAE9B,IAAI,CAAC,cAAc,GAAG,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,UAAU,CAAC,SAA8B,EAAE,gBAAwB;QAC/D,OAAO,IAAI,aAAK,EAAE,CAAC;IACvB,CAAC;CACJ;AAXD,wEAWC;AAED,MAAa,8BAA+B,SAAQ,wCAAgC;IAGhF,YAAqB,KAAa;QAC9B,KAAK,EAAE,CAAC;QADS,UAAK,GAAL,KAAK,CAAQ;QAE9B,IAAI,CAAC,cAAc,GAAG,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,UAAU,CAAC,MAAqB,EAAE,MAAqB;QACnD,OAAO,SAAS,CAAC;IACrB,CAAC;CACJ;AAXD,wEAWC;AAED,MAAa,oBAAoB;IAC7B,uBAAuB,CAAC,GAAG,OAA6B;QACpD,QAAQ;IACZ,CAAC;IAED,QAAQ,CAAC,MAAc;QACnB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IAED,WAAW,CAAC,GAAG,OAA6B;QACxC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;CACJ;AAZD,oDAYC;AAED,MAAa,wBAAwB;IACjC,MAAM,CAAC,MAAyC;QAC5C,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,mBAAmB,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;IAC7D,CAAC;CACJ;AALD,4DAKC;AAED,MAAa,wBAAwB;IACjC,wBAAwB,CAAC,MAAyC;QAC9D,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,mBAAmB,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;IAC7D,CAAC;IAED,UAAU,CAAC,eAAuB;QAC9B,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,iBAAiB,CAAC,WAAmB;QACjC,OAAO,EAAE,CAAC;IACd,CAAC;IAED,oBAAoB,CAAC,eAAuB;QACxC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,WAAW,CAAC,QAA+B,EAAE,GAAG,gBAA0B;QACtE,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,cAAc,CAAC,QAA+B;QAC1C,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,eAAe,CAAC,GAAG,gBAA0B;QACzC,OAAO,SAAS,CAAC;IACrB,CAAC;CACJ;AA7BD,4DA6BC;AAED,MAAa,UAAW,SAAQ,eAAM;IAAtC;;QACI,aAAQ,GAAG,iBAAQ,CAAC,IAAI,CAAC;QACzB,WAAM,GAAG,SAAS,CAAC;IAiBvB,CAAC;IAfG,IAAI,CAAC,OAAe,EAAE,GAAG,MAAa;QAClC,QAAQ;IACZ,CAAC;IAED,IAAI,CAAC,OAAe,EAAE,GAAG,MAAa;QAClC,QAAQ;IACZ,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,GAAG,MAAa;QACnC,QAAQ;IACZ,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,GAAG,MAAa;QACnC,QAAQ;IACZ,CAAC;CACJ;AAnBD,gCAmBC;AAED,MAAa,yBAAyB;IAClC,cAAc,CAAC,aAA4B;QACvC,QAAQ;IACZ,CAAC;IAED,eAAe,CAAC,aAA4B;QACxC,QAAQ;IACZ,CAAC;CACJ;AARD,8DAQC;AAED,MAAa,mBAAmB;IAC5B,OAAO,CAAC,UAA6B;QACjC,QAAQ;IACZ,CAAC;IAED,OAAO,CAAC,OAA8B;QAClC,QAAQ;IACZ,CAAC;CACJ;AARD,kDAQC;AAED,MAAa,sBAAsB;IAC/B,iBAAiB,CAAC,MAAkB;QAChC,QAAQ;IACZ,CAAC;IAED,cAAc,CAAC,MAAkB;QAC7B,QAAQ;IACZ,CAAC;CACJ;AARD,wDAQC;AAED,MAAa,wBAAwB;IAArC;QACI,gBAAW,GAAG,IAAI,GAAG,EAAoC,CAAC;QAE1D,mBAAc,GAAoB,EAAE,CAAC;QAErC,kBAAa,GAAmB,EAAE,CAAC;QAEnC,eAAU,GAAG,wCAAgB,CAAC,IAAI,CAAC;QAEnC,sBAAiB,GAAG,IAAI,CAAC;QAEzB,mBAAc,GAAG,IAAI,CAAC;IAC1B,CAAC;CAAA;AAZD,4DAYC;AAED,MAAa,sBAAuB,SAAQ,yCAAkB;IAC1D,QAAQ,CAAC,KAAa,EAAE,OAAsB;QAC1C,IAAI,KAAK,KAAK,OAAO,EAAE;YACnB,OAAO,EAAE,QAAQ,EAAE,2BAAgB,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;SAC1E;QACD,IAAI,KAAK,KAAK,SAAS,EAAE;YACrB,OAAO,EAAE,QAAQ,EAAE,2BAAgB,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;SAC9E;QACD,OAAO,EAAE,QAAQ,EAAE,2BAAgB,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACrE,CAAC;CACJ;AAVD,wDAUC;AAED,MAAa,wBAAwB;IACjC,IAAI,SAAS;QACT,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,QAAQ,CAAC,MAAmC;QACxC,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,EAAE;YACzB,OAAO,EAAE,QAAQ,EAAE,2BAAgB,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;SAC1E;QACD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE;YAC3B,OAAO,EAAE,QAAQ,EAAE,2BAAgB,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;SAC9E;QACD,OAAO,EAAE,QAAQ,EAAE,2BAAgB,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACrE,CAAC;CACJ;AAdD,4DAcC;AAEM,MAAM,wBAAwB,GAAyB,WAAW,CAAC,EAAE,CAAC,IAAI,WAAW,EAAE,CAAC;AAAlF,QAAA,wBAAwB,4BAA0D;AAE/F,MAAa,4BAA4B;IACrC,UAAU,CAAC,IAAW;QAClB,QAAQ;IACZ,CAAC;CACJ;AAJD,oEAIC"}
+{"version":3,"file":"mock-util.js","sourceRoot":"","sources":["../../../src/common/test/mock-util.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;kFAckF;AAClF,yDAAyD;AACzD,oDAAoD;;;AAEpD,+CAA4F;AAC5F,qDAYgC;AAChC,yCAAsC;AAKtC,4EAA0F;AAE1F,yFAAoF;AACpF,2CAAqG;AASrG,4CAAmD;AAE5C,KAAK,UAAU,KAAK,CAAC,EAAU;IAClC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC;AAFD,sBAEC;AAED,SAAgB,mBAAmB,CAC/B,EAAU,EACV,WAAmB,EACnB,SAAS,GAAG,IAAI,qBAAS,EAAE,EAC3B,gBAAgB,GAAG,IAAI,oBAAoB,EAAE;IAE7C,OAAO;QACH,EAAE;QACF,WAAW;QACX,SAAS;QACT,gBAAgB;QAChB,OAAO,EAAE,GAAG,EAAE;YACV,EAAE;QACN,CAAC;KACJ,CAAC;AACN,CAAC;AAfD,kDAeC;AAED,MAAa,iBAAiB;IAC1B,YAAmB,WAAqB;QAArB,gBAAW,GAAX,WAAW,CAAU;IAAG,CAAC;IAE5C,OAAO,CAAC,MAAc;QAClB,OAAO,EAAE,CAAC;IACd,CAAC;CACJ;AAND,8CAMC;AAED,MAAa,8BAA+B,SAAQ,wCAAgC;IAGhF,YAAqB,KAAa;QAC9B,KAAK,EAAE,CAAC;QADS,UAAK,GAAL,KAAK,CAAQ;QAE9B,IAAI,CAAC,cAAc,GAAG,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,UAAU,CAAC,SAA8B,EAAE,gBAAwB;QAC/D,OAAO,IAAI,aAAK,EAAE,CAAC;IACvB,CAAC;CACJ;AAXD,wEAWC;AAED,MAAa,8BAA+B,SAAQ,wCAAgC;IAGhF,YAAqB,KAAa;QAC9B,KAAK,EAAE,CAAC;QADS,UAAK,GAAL,KAAK,CAAQ;QAE9B,IAAI,CAAC,cAAc,GAAG,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,UAAU,CAAC,MAAqB,EAAE,MAAqB;QACnD,OAAO,SAAS,CAAC;IACrB,CAAC;CACJ;AAXD,wEAWC;AAED,MAAa,oBAAoB;IAC7B,uBAAuB,CAAC,GAAG,OAA6B,IAAS,CAAC;IAElE,QAAQ,CAAC,MAAc;QACnB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IAED,WAAW,CAAC,GAAG,OAA6B;QACxC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;CACJ;AAVD,oDAUC;AAED,MAAa,wBAAwB;IACjC,MAAM,CAAC,MAAyC;QAC5C,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,mBAAmB,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;IAC7D,CAAC;CACJ;AALD,4DAKC;AAED,MAAa,wBAAwB;IACjC,wBAAwB,CAAC,MAAyC;QAC9D,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,mBAAmB,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;IAC7D,CAAC;IAED,UAAU,CAAC,eAAuB;QAC9B,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,iBAAiB,CAAC,WAAmB;QACjC,OAAO,EAAE,CAAC;IACd,CAAC;IAED,oBAAoB,CAAC,eAAuB;QACxC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,WAAW,CAAC,QAA+B,EAAE,GAAG,gBAA0B;QACtE,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,cAAc,CAAC,QAA+B;QAC1C,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,eAAe,CAAC,GAAG,gBAA0B;QACzC,OAAO,SAAS,CAAC;IACrB,CAAC;CACJ;AA7BD,4DA6BC;AAED,MAAa,UAAW,SAAQ,eAAM;IAAtC;;QACI,aAAQ,GAAG,iBAAQ,CAAC,IAAI,CAAC;QACzB,WAAM,GAAG,SAAS,CAAC;IASvB,CAAC;IAPG,IAAI,CAAC,OAAe,EAAE,GAAG,MAAa,IAAS,CAAC;IAEhD,IAAI,CAAC,OAAe,EAAE,GAAG,MAAa,IAAS,CAAC;IAEhD,KAAK,CAAC,OAAe,EAAE,GAAG,MAAa,IAAS,CAAC;IAEjD,KAAK,CAAC,OAAe,EAAE,GAAG,MAAa,IAAS,CAAC;CACpD;AAXD,gCAWC;AAED,MAAa,yBAAyB;IAClC,cAAc,CAAC,aAA4B,IAAS,CAAC;IAErD,eAAe,CAAC,aAA4B,IAAS,CAAC;CACzD;AAJD,8DAIC;AAED,MAAa,mBAAmB;IAC5B,OAAO,CAAC,UAA6B,IAAS,CAAC;IAE/C,OAAO,CAAC,OAA8B,IAAS,CAAC;CACnD;AAJD,kDAIC;AAED,MAAa,sBAAsB;IAC/B,iBAAiB,CAAC,MAAkB,IAAS,CAAC;IAE9C,cAAc,CAAC,MAAkB,IAAS,CAAC;CAC9C;AAJD,wDAIC;AAED,MAAa,wBAAwB;IAArC;QACI,gBAAW,GAAG,IAAI,GAAG,EAAoC,CAAC;QAE1D,mBAAc,GAAoB,EAAE,CAAC;QAErC,kBAAa,GAAmB,EAAE,CAAC;QAEnC,eAAU,GAAG,wCAAgB,CAAC,IAAI,CAAC;QAEnC,sBAAiB,GAAG,IAAI,CAAC;QAEzB,mBAAc,GAAG,IAAI,CAAC;IAC1B,CAAC;CAAA;AAZD,4DAYC;AAED,MAAa,sBAAuB,SAAQ,yCAAkB;IAC1D,QAAQ,CAAC,KAAa,EAAE,OAAsB;QAC1C,IAAI,KAAK,KAAK,OAAO,EAAE;YACnB,OAAO,EAAE,QAAQ,EAAE,2BAAgB,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;SAC1E;QACD,IAAI,KAAK,KAAK,SAAS,EAAE;YACrB,OAAO,EAAE,QAAQ,EAAE,2BAAgB,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;SAC9E;QACD,OAAO,EAAE,QAAQ,EAAE,2BAAgB,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACrE,CAAC;CACJ;AAVD,wDAUC;AAED,MAAa,wBAAwB;IACjC,IAAI,SAAS;QACT,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,QAAQ,CAAC,MAAmC;QACxC,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,EAAE;YACzB,OAAO,EAAE,QAAQ,EAAE,2BAAgB,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;SAC1E;QACD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE;YAC3B,OAAO,EAAE,QAAQ,EAAE,2BAAgB,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;SAC9E;QACD,OAAO,EAAE,QAAQ,EAAE,2BAAgB,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACrE,CAAC;CACJ;AAdD,4DAcC;AAEM,MAAM,wBAAwB,GAAyB,WAAW,CAAC,EAAE,CAAC,IAAI,WAAW,EAAE,CAAC;AAAlF,QAAA,wBAAwB,4BAA0D;AAE/F,MAAa,4BAA4B;IACrC,UAAU,CAAC,IAAW,IAAS,CAAC;CACnC;AAFD,oEAEC;AAED,MAAa,WAAW;IACpB,OAAO,KAAU,CAAC;IAClB,IAAI,KAAU,CAAC;IACf,IAAI,KAAU,CAAC;CAElB;AALD,kCAKC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eclipse-glsp/server",
-  "version": "1.1.0-next.3d7585d.42+3d7585d",
+  "version": "1.1.0-next.44bd1e0.43+44bd1e0",
   "description": "A js server framework for Eclipse GLSP",
   "keywords": [
     "eclipse",
@@ -59,10 +59,11 @@
     "watch": "tsc -w"
   },
   "dependencies": {
-    "@eclipse-glsp/graph": "1.1.0-next.3d7585d.42+3d7585d",
+    "@eclipse-glsp/graph": "1.1.0-next.44bd1e0.43+44bd1e0",
     "@eclipse-glsp/protocol": "next",
     "@types/uuid": "8.3.1",
     "commander": "^8.3.0",
+    "fast-json-patch": "^3.1.0",
     "inversify": "^5.1.1",
     "winston": "^3.3.3"
   },
@@ -72,5 +73,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "3d7585df49f6df95ea707e55cfc8e435b578cea3"
+  "gitHead": "44bd1e05dcc86ad71386a5286eed7e3300afb51a"
 }

package/src/common/command/command-stack.spec.ts

@@ -0,0 +1,239 @@
+/********************************************************************************
+ * Copyright (c) 2023 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+import { expect } from 'chai';
+import { Container, ContainerModule } from 'inversify';
+import * as sinon from 'sinon';
+import { StubCommand, StubLogger } from '../test/mock-util';
+import { Logger } from '../utils/logger';
+import { DefaultCommandStack } from './command-stack';
+
+describe('test DefaultCommandStack', () => {
+    const sandbox = sinon.createSandbox();
+    const container = new Container();
+
+    const command1 = sandbox.stub(new StubCommand());
+    const command2 = sandbox.stub(new StubCommand());
+    let commandStack: DefaultCommandStack;
+
+    container.load(
+        new ContainerModule(bind => {
+            bind(Logger).toConstantValue(new StubLogger());
+        })
+    );
+    commandStack = container.resolve(DefaultCommandStack);
+
+    afterEach(() => {
+        sandbox.reset();
+        commandStack = container.resolve(DefaultCommandStack);
+    });
+
+    describe('execute', () => {
+        it('should execute the given command and become dirty', () => {
+            expect(commandStack.isDirty).to.be.false;
+            commandStack.execute(command1);
+            expect(command1.execute.calledOnce).to.be.true;
+            expect(commandStack.isDirty).to.be.true;
+        });
+
+        it('should execute the given commands in order and become dirty', () => {
+            expect(commandStack.isDirty).to.be.false;
+            commandStack.execute(command1);
+            commandStack.execute(command2);
+
+            expect(command1.execute.calledOnce).to.be.true;
+            expect(command2.execute.calledOnce).to.be.true;
+            expect(command2.execute.calledAfter(command1.execute)).to.be.true;
+            expect(commandStack.isDirty).to.be.true;
+        });
+
+        it('should be able to undo after execute', () => {
+            expect(commandStack.canUndo()).to.be.false;
+            commandStack.execute(command1);
+            expect(commandStack.canUndo()).to.be.true;
+        });
+
+        it('should clear the redo stack after execution', () => {
+            commandStack['commands'].push(command2);
+            commandStack['top'] = -1;
+            expect(commandStack.canRedo()).to.be.true;
+
+            commandStack.execute(command1);
+            expect(commandStack.canRedo()).to.be.false;
+        });
+
+        it('should flush the stack in case of an execution error', () => {
+            command2.execute.throwsException();
+            const flushSpy = sandbox.spy(commandStack, 'flush');
+
+            expect(() => commandStack.execute(command2)).to.throw();
+            expect(command2.execute.calledOnce).to.be.true;
+            expect(flushSpy.calledOnce).to.be.true;
+        });
+    });
+
+    describe('undo', () => {
+        it('should do nothing if the command stack is empty', () => {
+            expect(commandStack.isDirty).to.be.false;
+
+            commandStack.undo();
+            expect(commandStack.canUndo()).to.be.false;
+            expect(commandStack.canRedo()).to.be.false;
+            expect(commandStack.isDirty).to.be.false;
+        });
+
+        it('should undo the command and become non-dirty again', () => {
+            commandStack['commands'].push(command1);
+            commandStack['top'] = 0;
+            expect(commandStack.isDirty).to.be.true;
+            expect(commandStack.canUndo()).to.be.true;
+            expect(commandStack.canRedo()).to.be.false;
+
+            commandStack.undo();
+            expect(command1.undo.calledOnce).to.be.true;
+            expect(commandStack.isDirty).to.be.false;
+            expect(commandStack.canRedo()).to.be.true;
+            expect(commandStack.canUndo()).to.be.false;
+        });
+
+        it('should undo multiple command and become non-dirty again', () => {
+            commandStack['commands'].push(command1, command2);
+            commandStack['top'] = 1;
+            expect(commandStack.isDirty).to.be.true;
+            expect(commandStack.canUndo()).to.be.true;
+            expect(commandStack.canRedo()).to.be.false;
+
+            commandStack.undo();
+            expect(command2.undo.calledOnce).to.be.true;
+            expect(commandStack.canRedo()).to.be.true;
+            expect(commandStack.canUndo()).to.be.true;
+            expect(commandStack.isDirty).to.be.true;
+
+            commandStack.undo();
+            expect(command1.undo.calledOnce).to.be.true;
+            expect(command1.undo.calledAfter(command2.undo)).to.be.true;
+            expect(commandStack.isDirty).to.be.false;
+            expect(commandStack.canRedo()).to.be.true;
+            expect(commandStack.canUndo()).to.be.false;
+        });
+        it('should flush the stack in case of an execution error', () => {
+            command2.undo.throwsException();
+            const flushSpy = sandbox.spy(commandStack, 'flush');
+            commandStack['commands'].push(command2);
+            commandStack['top'] = 0;
+
+            expect(() => commandStack.undo()).to.throw();
+            expect(command2.undo.calledOnce).to.be.true;
+            expect(flushSpy.calledOnce).to.be.true;
+        });
+    });
+
+    describe('redo', () => {
+        it('should do nothing if the command stack is empty', () => {
+            expect(commandStack.isDirty).to.be.false;
+
+            commandStack.redo();
+            expect(commandStack.canUndo()).to.be.false;
+            expect(commandStack.canRedo()).to.be.false;
+            expect(commandStack.isDirty).to.be.false;
+        });
+
+        it('should redo the command and become dirty again', () => {
+            commandStack['commands'].push(command1);
+            commandStack['top'] = -1;
+            expect(commandStack.isDirty).to.be.false;
+            expect(commandStack.canUndo()).to.be.false;
+            expect(commandStack.canRedo()).to.be.true;
+
+            commandStack.redo();
+            expect(command1.redo.calledOnce).to.be.true;
+            expect(commandStack.isDirty).to.be.true;
+            expect(commandStack.canRedo()).to.be.false;
+            expect(commandStack.canUndo()).to.be.true;
+        });
+
+        it('should undo multiple command and become non-dirty again', () => {
+            commandStack['commands'].push(command2, command1);
+            commandStack['top'] = -1;
+            commandStack['saveIndex'] = -1;
+            expect(commandStack.isDirty).to.be.false;
+            expect(commandStack.canUndo()).to.be.false;
+            expect(commandStack.canRedo()).to.be.true;
+
+            commandStack.redo();
+            expect(command2.redo.calledOnce).to.be.true;
+            expect(commandStack.canRedo()).to.be.true;
+            expect(commandStack.canUndo()).to.be.true;
+            expect(commandStack.isDirty).to.be.true;
+
+            commandStack.redo();
+            expect(command1.redo.calledOnce).to.be.true;
+            expect(command1.redo.calledAfter(command2.redo)).to.be.true;
+            expect(commandStack.isDirty).to.be.true;
+            expect(commandStack.canRedo()).to.be.false;
+            expect(commandStack.canUndo()).to.be.true;
+        });
+        it('should flush the stack in case of an execution error', () => {
+            command2.redo.throwsException();
+            const flushSpy = sandbox.spy(commandStack, 'flush');
+            commandStack['commands'].push(command2);
+            commandStack['top'] = -1;
+
+            expect(() => commandStack.redo()).to.throw();
+            expect(command2.redo.calledOnce).to.be.true;
+            expect(flushSpy.calledOnce).to.be.true;
+        });
+        it('should be able to undo after redo', () => {
+            commandStack['commands'].push(command1);
+            commandStack['top'] = -1;
+            expect(commandStack.canUndo()).to.be.false;
+            commandStack.redo();
+            expect(commandStack.canUndo()).to.be.true;
+        });
+    });
+
+    describe('flush', () => {
+        it('should reset the internal state of the command stack', () => {
+            commandStack['commands'].push(command1, command1);
+            commandStack['top'] = 0;
+
+            commandStack.flush();
+            expect(commandStack.isDirty).to.be.false;
+            expect(commandStack.canUndo()).to.be.false;
+            expect(commandStack.canRedo()).to.be.false;
+        });
+    });
+
+    describe('isSaveDone', () => {
+        it('should become non-dirty after execution', () => {
+            commandStack['commands'].push(command1);
+            commandStack['top'] = 0;
+            expect(commandStack.isDirty).to.be.true;
+
+            commandStack.saveIsDone();
+            expect(commandStack.isDirty).to.be.false;
+        });
+        it('should maintain undo/redo history after execution', () => {
+            commandStack['commands'].push(command1, command2);
+            commandStack['top'] = 0;
+            expect(commandStack.canUndo()).to.be.true;
+            expect(commandStack.canRedo()).to.be.true;
+
+            commandStack.saveIsDone();
+            expect(commandStack.canUndo()).to.be.true;
+            expect(commandStack.canRedo()).to.be.true;
+        });
+    });
+});

package/src/common/command/command-stack.ts

@@ -13,62 +13,147 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { injectable } from 'inversify';
+import { inject, injectable } from 'inversify';
+import { Logger } from '../utils/logger';
 import { Command } from './command';
 
 export const CommandStack = Symbol('CommandStack');
 
 /**
- * A basic implementation of an undoable stack of commands.
- * See {@link Command} for more details about the command methods that this implementation uses.
+ * A command stack keeps track of {@link Command commands} that have been executed.
+ * Executed commands can be undone in the reverse order of their original execution.
+ * Unless a new command has been executed after an undo operation, commands can be
+ * redone in the original order of their execution.
+ *
  */
 export interface CommandStack {
     /**
-     * Clears any redoable commands not yet redone, adds the command, and then executes the command.
+     * Clears any redoable commands not yet redone, adds the command to the stack and then invokes {@link Command.execute}.
      * @param command the command to execute.
      */
     execute(command: Command): void;
 
     /**
-     * Moves the top of the stack down, undoing what was formerly the top command.
+     * Removes the topmost (i.e. last executed) command from the stack and invokes {@link Command.undo}.
      */
     undo(): void;
 
     /**
-     * Moves the top of the stack up, redoing the new top command.
+     * Returns `true` if the top command on the stack can be undone.
+     */
+    canUndo(): boolean;
+
+    /**
+     * Re-adds the last undo command on top of the stack and invokes {@link Command.redo}
      */
     redo(): void;
 
     /**
-     * The command stack has currently unsaved changes.
+     * Returns `true` if there are  redoable commands in the stack.
      */
-    isDirty(): boolean;
+    canRedo(): boolean;
 
     /**
      * Called after a save has been successfully performed.
      */
     saveIsDone(): void;
+
+    /**
+     * Indicates wether the command stack has unsaved changes.
+     */
+    readonly isDirty: boolean;
+
+    /**
+     * Disposes all the commands in the stack.
+     */
+    flush(): void;
 }
 
 @injectable()
 export class DefaultCommandStack implements CommandStack {
+    @inject(Logger)
+    protected logger: Logger;
+
+    protected commands: Command[] = [];
+
+    /**
+     * The current position within the command list from which the next execute, undo, or redo, will be performed.
+     */
+    protected top = -1;
+
+    /**
+     * The current position within the command list when {@link DefaultCommandStack.saveIsDone} is called.
+     */
+    protected saveIndex = -1;
+
     execute(command: Command): void {
-        // no-op
+        try {
+            command.execute();
+        } catch (error) {
+            this.handleError(error);
+        }
+        // Clear the command list past the top (i.e. the old redo list)
+        this.commands = this.commands.slice(0, this.top + 1);
+        this.commands.push(command);
+        ++this.top;
+
+        // if the saveIndex points to the old redo list we can never reach a state again
+        // where save is not necessary. => ensure that `isDirty` always returns true
+        if (this.saveIndex >= this.top) {
+            this.saveIndex = -2;
+        }
     }
 
     undo(): void {
-        // no-op
+        if (this.canUndo()) {
+            const command = this.commands[this.top--];
+            try {
+                command.undo();
+            } catch (error) {
+                this.handleError(error);
+            }
+        }
+    }
+
+    canUndo(): boolean {
+        return this.top !== -1 //
+            ? Command.canUndo(this.commands[this.top])
+            : false;
     }
 
     redo(): void {
-        // no-op
+        if (this.canRedo()) {
+            const command = this.commands[++this.top];
+            try {
+                command.redo();
+            } catch (error) {
+                this.handleError(error);
+            }
+        }
     }
 
-    isDirty(): boolean {
-        return false;
+    canRedo(): boolean {
+        return this.top < this.commands.length - 1;
+    }
+
+    get isDirty(): boolean {
+        return this.saveIndex !== this.top;
     }
 
     saveIsDone(): void {
-        // no-op
+        this.saveIndex = this.top;
+    }
+
+    flush(): void {
+        this.commands = [];
+        this.top = -1;
+        this.saveIndex = -1;
+    }
+
+    protected handleError(error: any): never {
+        // if an error occurred during the command execution the stack might be in an erroneous state => we have to flush the command stack
+        this.flush();
+        this.logger.error('An error occurred during command execution. CommandStack will be flushed!', error);
+        throw error;
     }
 }

package/src/common/command/command.spec.ts

@@ -0,0 +1,93 @@
+/********************************************************************************
+ * Copyright (c) 2023 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+import { expect } from 'chai';
+import * as sinon from 'sinon';
+import { StubCommand } from '../test/mock-util';
+import { CompoundCommand } from './command';
+
+describe('CompoundCommand', () => {
+    const sandbox = sinon.createSandbox();
+
+    const command1 = sandbox.stub(new StubCommand());
+    const command2 = sandbox.stub(new StubCommand());
+    const command3 = sandbox.stub(new StubCommand());
+
+    const compoundCommand = new CompoundCommand(command1, command2, command3);
+
+    afterEach(() => {
+        sandbox.reset();
+    });
+
+    describe('execute', () => {
+        it('Should execute the subcommands in order', () => {
+            compoundCommand.execute();
+            expect(command1.execute.calledOnce).to.be.true;
+            expect(command2.execute.calledOnce).to.be.true;
+            expect(command3.execute.calledOnce).to.be.true;
+            expect(command1.execute.calledBefore(command2.execute)).to.be.true;
+            expect(command2.execute.calledBefore(command3.execute)).to.be.true;
+        });
+        it('Should undo partially executed subcommands in  case of an error', () => {
+            command3.execute.throwsException();
+
+            expect(() => compoundCommand.execute()).to.throw();
+
+            expect(command1.execute.calledOnce).to.be.true;
+            expect(command2.execute.calledOnce).to.be.true;
+            expect(command3.execute.calledOnce).to.be.true;
+            expect(command1.undo.calledOnce).to.be.true;
+            expect(command2.undo.calledOnce).to.be.true;
+        });
+    });
+
+    describe('undo', () => {
+        it('Should undo the subcommands in reverse order', () => {
+            compoundCommand.undo();
+            expect(command1.undo.calledOnce).to.be.true;
+            expect(command2.undo.calledOnce).to.be.true;
+            expect(command3.undo.calledOnce).to.be.true;
+            expect(command1.undo.calledAfter(command2.undo)).to.be.true;
+            expect(command2.undo.calledAfter(command3.undo)).to.be.true;
+        });
+
+        it('Should redo partially undone subcommands in  case of an error', () => {
+            command1.undo.throwsException();
+
+            expect(() => compoundCommand.undo()).to.throw();
+
+            expect(command1.undo.calledOnce).to.be.true;
+            expect(command2.undo.calledOnce).to.be.true;
+            expect(command3.undo.calledOnce).to.be.true;
+            expect(command3.redo.calledOnce).to.be.true;
+            expect(command2.redo.calledOnce).to.be.true;
+        });
+    });
+
+    describe('canUndo', () => {
+        it('should return true if all subcommands can be undone', () => {
+            command1.canUndo?.returns(true);
+            command2.canUndo?.returns(true);
+            command3.canUndo?.returns(true);
+            expect(compoundCommand.canUndo()).to.be.true;
+        });
+        it('should return true if anyof the  subcommands cannot be undone', () => {
+            command1.canUndo?.returns(true);
+            command2.canUndo?.returns(false);
+            command3.canUndo?.returns(true);
+            expect(compoundCommand.canUndo()).to.be.true;
+        });
+    });
+});