[OGUI-1745] ECS GUI Migration to new api/deploy endpoint

Control/README.md

@@ -7,6 +7,7 @@
   - [Description](#description)
   - [Requirements](#requirements)
   - [Installation](#installation)
+  - [Business logic for Developers to know](#business-logic-for-developers-to-know)
   - [Configuration](#configuration)
     - [O2Control gRPC](#o2control-grpc)
     - [Apricot gRPC](#apricot-grpc)
@@ -53,6 +54,7 @@ It communicates with [Control agent](https://github.com/AliceO2Group/Control) ov
 6. Start web app: `npm start`
 7. Open browser and navigate to http://localhost:8080
 
+## [Business logic for Developers to know](./docs/BUSINESS_FOR_DEVELOPER_TO_KNOW.md)
 ## Configuration
 ### O2Control gRPC
 * `hostname` - gRPC hostname

Control/docs/BUSINESS_FOR_DEVELOPER_TO_KNOW.md

@@ -0,0 +1,28 @@
+# Business logic for developers to know
+
+ALICE's Experiment Control System ([ECS](https://github.com/AliceO2Group/Control)) uses entities named environments to enable users to take data in ALICE. These environments are a set of software and hardware configurations used for preparation and during data-taking operations.
+
+## Environment States and Transitions
+Environments can transition ([link](https://github.com/AliceO2Group/Control/blob/master/core/protos/o2control.proto#L228)) between multiple states. These states can be:
+- state machines - [link](https://github.com/AliceO2Group/Control/blob/master/core/environment/environment.go#L153-L160)
+- virtual states (states that are not real but used for software logic such as DESTROY or PENDING)
+
+Thus, for the GUI to provide a good user experience, the ECS GUI introduces a few logic items that are to be known when developing for ECS GUI:
+
+## Deployment and ECS GUI private attributes
+A deployment is a set of operations that prepares hardware and software for data taking operations. A deployment is a definition in ECS GUI that covers an environment first transition from:
+- `PENDING` (virtual state) -> `STANDBY` -> `DEPLOY` -> `CONFIGURED`
+
+For this sequence of actions, ECS GUI assigns a private attribute `isDeploying` and `deploymentError` to the environment so that it can display to the User all the information needed.
+- `isDeploying` set to:
+  - `true` - only by:
+    - the response of the `NewEnvironmentAsync`
+    - the first event from ECS via Kafka of state `PENDING`
+  - `false` - only if:
+    - an event with state `CONFIGURED` and message `'transition completed successfully'` is received
+    - an event with an error message is received during when `isDeploying` is `true` already (TBD)
+- `deploymentError` is updated every time there is an event with an error (TBD)
+
+These attributes allow the GUI to display all necessary deployment information to the user.
+
+If a deployment fails, the ECS will remove it from the active environments list. Thus, the GUI uses `deploymentError` to make sure the environment is kept in-memory until the user acknowledges the error. 

Control/lib/adapters/EnvironmentInfoAdapter.js

@@ -49,6 +49,8 @@ class EnvironmentInfoAdapter {
     const {
       id,
       currentRunNumber,
+      isDeploying,
+      deploymentError,
       createdWhen,
       firstTaskInError = null,
       state = '',
@@ -69,6 +71,8 @@ class EnvironmentInfoAdapter {
     const environmentInfo = {
       id,
       currentRunNumber,
+      isDeploying,
+      deploymentError,
       createdWhen,
       firstTaskInError,
       state,

Control/lib/api.js

@@ -61,7 +61,6 @@ const {NotificationService, ConsulService} = require('@aliceo2/web-ui');
 
 // AliECS Core
 const { AliEcsSynchronizer } = require('./kafka/AliEcsSynchronizer.js');
-const AliecsRequestHandler = require('./control-core/RequestHandler.js');
 const ApricotService = require('./control-core/ApricotService.js');
 const ControlService = require('./control-core/ControlService.js');
 const GrpcServiceClient = require('./control-core/GrpcServiceClient.js');
@@ -115,7 +114,7 @@ module.exports.setup = (http, ws) => {
     ctrlProxy, apricotService, cacheService, broadcastService, environmentCacheService
   );
   const workflowService = new WorkflowTemplateService(ctrlProxy, apricotService);
-  const deploymentService = new DeploymentService(environmentService, workflowService);
+  const deploymentService = new DeploymentService(environmentService, workflowService, environmentCacheService);
 
   /**
    * Controllers are initialized with the services they depend on.
@@ -124,10 +123,6 @@ module.exports.setup = (http, ws) => {
   const workflowController = new WorkflowTemplateController(workflowService);
   const deploymentController = new DeploymentController(deploymentService);
 
-  const aliecsReqHandler = new AliecsRequestHandler(ctrlService, apricotService);
-  aliecsReqHandler.setWs(ws);
-  aliecsReqHandler.workflowService = workflowService;
-
   const bkpService = new BookkeepingService(config.bookkeeping ?? {});
   const runService = new RunService(bkpService, apricotService, cacheService);
   runService.retrieveStaticConfigurations();
@@ -174,9 +169,6 @@ module.exports.setup = (http, ws) => {
   ctrlProxy.methods.forEach(
     (method) => http.post(`/${method}`, coreMiddleware, (req, res) => ctrlService.executeCommand(req, res)),
   );
-  http.post('/core/request', coreMiddleware, (req, res) => aliecsReqHandler.add(req, res));
-  http.get('/core/requests', coreMiddleware, (req, res) => aliecsReqHandler.getAll(req, res));
-  http.post('/core/removeRequest/:id', coreMiddleware, (req, res) => aliecsReqHandler.remove(req, res));
 
   http.get('/workflow/template/default/source', workflowController.getDefaultTemplateSource.bind(workflowController));
   http.get('/workflow/template/mappings', workflowController.getWorkflowMapping.bind(workflowController));
@@ -208,6 +200,11 @@ module.exports.setup = (http, ws) => {
     deploymentController.newAsyncDeploymentHandler.bind(deploymentController)
   );
 
+  http.delete('/deploy/:id',
+    minimumRoleMiddleware(Role.DETECTOR),
+    deploymentController.acknowledgeDeploymentFailureHandler.bind(deploymentController)
+  );
+
   http.post('/core/environments/configuration/save', (req, res) => apricotService.saveCoreEnvConfig(req, res));
   http.post('/core/environments/configuration/update', (req, res) => apricotService.updateCoreEnvConfig(req, res));
 

Control/lib/common/broadcastKeys.enum.js

@@ -20,7 +20,6 @@ const BroadcastKeys =  Object.freeze({
   NOTIFICATION: 'notification',
   RESOURCES_CLEANUP: 'resources-cleanup',
   O2_ROC_CONFIG: 'o2-roc-config',
-  REQUESTS: 'requests',
   COMPONENT_STATUS: 'component-STATUS',
   CALIBRATION_RUNS_BY_DETECTOR: 'CALIBRATION_RUNS_BY_DETECTOR',
   CALIBRATION_RUNS_REQUESTS: 'CALIBRATION_RUNS_REQUESTS',

Control/lib/common/environmentState.enum.js

@@ -0,0 +1,30 @@
+/**
+ * @license
+ * Copyright 2019-2020 CERN and copyright holders of ALICE O2.
+ * See http://alice-o2.web.cern.ch/copyright for details of the copyright holders.
+ * All rights not expressly granted are reserved.
+ *
+ * This software is distributed under the terms of the GNU General Public
+ * License v3 (GPL Version 3), copied verbatim in the file "COPYING".
+ *
+ * In applying this license CERN does not waive the privileges and immunities
+ * granted to it by virtue of its status as an Intergovernmental Organization
+ * or submit itself to any jurisdiction.
+*/
+
+/**
+ * Available environment transitions of ECS 
+ * @link https://github.com/AliceO2Group/Control/blob/master/core/environment/environment.go#L153-L160
+ */
+const EnvironmentState = Object.freeze({
+  STANDBY: 'STANDBY',
+  DEPLOYED: 'DEPLOYED',
+  DONE: 'DONE',
+  CONFIGURED: 'CONFIGURED',
+  RUNNING: 'RUNNING',
+  PENDING: 'PENDING',
+  ERROR: 'ERROR',
+  UNKNOWN: 'UNKNOWN'
+});
+
+exports.EnvironmentState = EnvironmentState;

Control/lib/common/environmentTransitionType.enum.js

@@ -13,7 +13,8 @@
 */
 
 /**
- * Available environment transitions as per: https://github.com/AliceO2Group/Control/blob/master/core/protos/o2control.proto#L228
+ * Available environment transitions as per: 
+ * @link https://github.com/AliceO2Group/Control/blob/master/core/protos/o2control.proto#L228
  */
 const EnvironmentTransitionType = Object.freeze({
   NOOP: 'NOOP',
@@ -23,6 +24,7 @@ const EnvironmentTransitionType = Object.freeze({
   RESET: 'RESET',
   GO_ERROR: 'GO_ERROR',
   DEPLOY: 'DEPLOY',
+  DESTROY: 'DESTROY',
 });
 
 exports.EnvironmentTransitionType = EnvironmentTransitionType;

Control/lib/control-core/GrpcServiceClient.js

@@ -15,10 +15,7 @@
 // Doc: https://grpc.io/docs/languages/node/
 const protoLoader = require('@grpc/proto-loader');
 const grpcLibrary = require('@grpc/grpc-js');
-const path = require('path');
-const {LogManager, grpcErrorToNativeError, ServiceUnavailableError, InvalidInputError} = require('@aliceo2/web-ui');
-const {Status} = require(path.join(__dirname, './../../protobuf/status_pb.js'));
-const {EnvironmentInfo} = require(path.join(__dirname, './../../protobuf/environmentinfo_pb.js'));
+const {LogManager, ServiceUnavailableError, InvalidInputError} = require('@aliceo2/web-ui');
 const RECONNECT_DELTA_TIME = 1000; // 1 second
 
 /**
@@ -102,23 +99,7 @@ class GrpcServiceClient {
       return new Promise((resolve, reject) => {
         this.client[methodName](args, options, (error, response) => {
           if (error) {
-            try {
-              if (methodName === 'NewEnvironment' && error.metadata?.internalRepr?.has('grpc-status-details-bin')) {
-                const buffer = error.metadata.get('grpc-status-details-bin')[0];
-                Status.deserializeBinary(buffer).getDetailsList().map((detail) => {
-                  if (detail.getTypeName() == 'o2control.EnvironmentInfo') {
-                    const deserialized = detail.unpack(EnvironmentInfo.deserializeBinary, detail.getTypeName());
-                    error.envId = deserialized.array[0];
-                  }
-                });
-              }
-              reject(error);
-            } catch (exception) {
-              this._logger.debugMessage('Failed new env details error' + exception);
-              reject(exception);
-            }
-            reject(grpcErrorToNativeError(error));
-            return;
+            reject(error);
           }
           resolve(response);
         });