Source: client/commanding-client.js

  1. /*
  2.  * Copyright 2023, TeamDev. All rights reserved.
  3.  *
  4.  * Licensed under the Apache License, Version 2.0 (the "License");
  5.  * you may not use this file except in compliance with the License.
  6.  * You may obtain a copy of the License at
  7.  *
  8.  * http://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  * Redistribution and use in source and/or binary forms, with or without
  11.  * modification, must retain the above copyright notice and the following
  12.  * disclaimer.
  13.  *
  14.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  15.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  16.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  17.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  18.  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  19.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  20.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24.  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25.  */
  27. import {Status} from "../proto/spine/core/response_pb";
  28. import {CommandRequest} from "./command-request";
  29. import {CommandHandlingError, CommandValidationError, SpineError} from "./errors";
  30. import ObjectToProto from "./object-to-proto";
  31. import {TypedMessage} from "./typed-message";
  33. const _statusType = Status.typeUrl();
  35. /**
  36.  * A client which posts commands.
  37.  *
  38.  * This class has a default implementation but is intended to be overridden as necessary if it's
  39.  * required to change the behavior.
  40.  */
  41. export class CommandingClient {
  43.   constructor(endpoint, requestFactory) {
  44.     this._requestFactory = requestFactory;
  45.     this._endpoint = endpoint;
  46.   }
  48.   /**
  49.    * Creates a new command request.
  50.    *
  51.    * @param {!Message} commandMessage the command to send to the server
  52.    * @param {!Client} client the client which initiated the request
  53.    * @return {CommandRequest} a new command request
  54.    */
  55.   command(commandMessage, client) {
  56.     return new CommandRequest(commandMessage, client, this._requestFactory);
  57.   }
  59.   /**
  60.    * Posts a given command to the Spine server.
  61.    *
  62.    * @param {!spine.core.Command} command a Command sent to Spine server
  63.    * @param {!AckCallback} onAck a command acknowledgement callback
  64.    */
  65.   post(command, onAck) {
  66.     const cmd = TypedMessage.of(command);
  67.     this._endpoint.command(cmd)
  68.         .then(ack => this._onAck(ack, onAck))
  69.         .catch(error => {
  70.           onAck.onError(new CommandHandlingError(error.message, error));
  71.         });
  72.   }
  74.   _onAck(ack, onAck) {
  75.     const responseStatus = ack.status;
  76.     const responseStatusProto = ObjectToProto.convert(responseStatus, _statusType);
  77.     const responseStatusCase = responseStatusProto.getStatusCase();
  79.     switch (responseStatusCase) {
  80.       case Status.StatusCase.OK:
  81.         onAck.onOk();
  82.         break;
  83.       case Status.StatusCase.ERROR:
  84.         const error = responseStatusProto.getError();
  85.         const message = error.getMessage();
  86.         onAck.onError(error.hasValidationError()
  87.             ? new CommandValidationError(message, error)
  88.             : new CommandHandlingError(message, error));
  89.         break;
  90.       case Status.StatusCase.REJECTION:
  91.         onAck.onImmediateRejection(responseStatusProto.getRejection());
  92.         break;
  93.       default:
  94.         onAck.onError(
  95.             new SpineError(`Unknown response status case ${responseStatusCase}`)
  96.         );
  97.     }
  98.   }
  99. }