feat: added Deployment data to ServerInfo (#797)

Author: fboucquez

package-lock.json

@@ -112,7 +112,7 @@
         "ripemd160": "^2.0.2",
         "rxjs": "^6.6.3",
         "rxjs-compat": "^6.6.3",
-        "symbol-openapi-typescript-fetch-client": "0.11.2",
+        "symbol-openapi-typescript-fetch-client": "1.0.1-SNAPSHOT.202106160954",
         "tweetnacl": "^1.0.3",
         "utf8": "^2.1.2",
         "ws": "^7.3.1"

package.json

@@ -19,6 +19,7 @@ import { NodeInfoDTO, NodeRoutesApi } from 'symbol-openapi-typescript-fetch-clie
 import { UInt64 } from '../model';
 import { StorageInfo } from '../model/blockchain';
 import { NodeHealth, NodeInfo, NodeTime, RoleType, ServerInfo } from '../model/node';
+import { Deployment } from '../model/node/Deployment';
 import { Http } from './Http';
 import { NodeRepository } from './NodeRepository';
 
@@ -95,7 +96,18 @@ export class NodeHttp extends Http implements NodeRepository {
     public getServerInfo(): Observable<ServerInfo> {
         return this.call(
             this.nodeRoutesApi.getServerInfo(),
-            (body) => new ServerInfo(body.serverInfo.restVersion, body.serverInfo.sdkVersion),
+            (body) =>
+                new ServerInfo(
+                    body.serverInfo.restVersion,
+                    body.serverInfo.sdkVersion,
+                    body.serverInfo?.deployment
+                        ? new Deployment(
+                              body.serverInfo.deployment.deploymentTool,
+                              body.serverInfo.deployment.deploymentToolVersion,
+                              body.serverInfo.deployment.lastUpdatedDate,
+                          )
+                        : undefined,
+                ),
         );
     }
 

src/infrastructure/NodeHttp.ts

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2019 NEM
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * The deployment information that helps tracking how the node was created.
+ */
+export class Deployment {
+    /**
+     * @param deploymentTool The tool used to create, maintain and deploy the node. Examples: symbol-bootstrap, manual.
+     * @param deploymentToolVersion The version of the tool used to create, maintain and deploy the node.
+     * @param lastUpdatedDate When was the node upgraded.
+     */
+    constructor(
+        /**
+         * deploymentTool The tool used to create, maintain and deploy the node. Examples: symbol-bootstrap, manual.
+         */
+        public readonly deploymentTool: string,
+        /**
+         * deploymentToolVersion The version of the tool used to create, maintain and deploy the node.
+         */
+        public readonly deploymentToolVersion: string,
+        /**
+         * lastUpdatedDate When was the node last upgraded.
+         */
+        public readonly lastUpdatedDate: string,
+    ) {}
+}

src/model/node/Deployment.ts

@@ -14,22 +14,29 @@
  * limitations under the License.
  */
 
+import { Deployment } from './Deployment';
+
 /**
  * The server information.
  */
 export class ServerInfo {
     /**
      * @param restVersion - The catapult-rest component version
      * @param sdkVersion - the catapult-sdk component version
+     * @param deployment - the deployment information.
      */
     constructor(
         /**
-         * The catapult-rest component version
+         * restVersion The catapult-rest component version
          */
         public readonly restVersion: string,
         /**
-         * the catapult-sdk component version
+         * sdkVersion the catapult-sdk component version
          */
         public readonly sdkVersion: string,
+        /**
+         * deployment The deployment information that helps tracking how the node was created.
+         */
+        public readonly deployment: Deployment | undefined,
     ) {}
 }

src/model/node/ServerInfo.ts

@@ -1,5 +1,6 @@
 // created from 'create-ts-index'
 
+export * from './Deployment';
 export * from './NodeHealth';
 export * from './NodeInfo';
 export * from './NodeTime';

src/model/node/index.ts

@@ -70,6 +70,27 @@ describe('NodeHttp', () => {
         expect(serverInfo).to.be.not.null;
         expect(serverInfo.restVersion).to.be.equals(body.serverInfo.restVersion);
         expect(serverInfo.sdkVersion).to.be.equals(body.serverInfo.sdkVersion);
+        expect(serverInfo.deployment).to.be.undefined;
+    });
+
+    it('getServerInfo with deployment', async () => {
+        const body: ServerInfoDTO = {
+            serverInfo: {
+                restVersion: 'Some Rest Version',
+                sdkVersion: 'Some SDK Version',
+                deployment: {
+                    deploymentTool: 'symbol-bootstrap',
+                    deploymentToolVersion: '1.0.6-alpha-202105280712',
+                    lastUpdatedDate: '2021-06-02',
+                },
+            },
+        };
+
+        when(nodeRoutesApi.getServerInfo()).thenReturn(Promise.resolve(body));
+        const serverInfo = await nodeRepository.getServerInfo().toPromise();
+        expect(serverInfo).to.be.not.null;
+        expect(serverInfo.restVersion).to.be.equals(body.serverInfo.restVersion);
+        expect(serverInfo.deployment).to.be.deep.equals(body.serverInfo.deployment);
     });
 
     it('getNodeInfo', async () => {

test/infrastructure/NodeHttp.spec.ts

@@ -324,7 +324,7 @@ describe('SerializeTransactionToJSON', () => {
         );
 
         const aggregateTransaction = AggregateTransaction.createBonded(
-            Deadline.create(epochAdjustment),
+            deadline,
             [transferTransaction.toAggregate(account.publicAccount)],
             NetworkType.PRIVATE_TEST,
             [],