feat(core-api): discontinue dedicated HTTP listeners for web service plugins

Fixes hyperledger-cacti#358

Signed-off-by: TonyRowntree [email protected]
Signed-off-by: Youngone Lee <[email protected]>

Author: Leeyoungone

examples/cactus-example-carbon-accounting-business-logic-plugin/src/main/typescript/business-logic-plugin/carbon-accounting-plugin.ts

@@ -1,7 +1,3 @@
-import { Server } from "http";
-import { Server as SecureServer } from "https";
-
-import { Optional } from "typescript-optional";
 import { Express } from "express";
 import { v4 as uuidv4 } from "uuid";
 
@@ -132,10 +128,6 @@ export class CarbonAccountingPlugin
     return theEndpoints;
   }
 
-  public getHttpServer(): Optional<Server | SecureServer> {
-    return Optional.empty();
-  }
-
   public async shutdown(): Promise<void> {
     this.log.info(`Shutting down ${this.className}...`);
   }

examples/cactus-example-supply-chain-business-logic-plugin/src/main/typescript/business-logic-plugin/supply-chain-cactus-plugin.ts

@@ -1,6 +1,3 @@
-import type { Server } from "http";
-import type { Server as SecureServer } from "https";
-import { Optional } from "typescript-optional";
 import { Express } from "express";
 import OAS from "../../json/openapi.json";
 import {
@@ -152,10 +149,6 @@ export class SupplyChainCactusPlugin
     return this.endpoints;
   }
 
-  public getHttpServer(): Optional<Server | SecureServer> {
-    return Optional.empty();
-  }
-
   public async shutdown(): Promise<void> {
     this.log.info(`Shutting down ${this.className}...`);
   }

extensions/cactus-plugin-object-store-ipfs/src/main/typescript/plugin-object-store-ipfs.ts

@@ -1,10 +1,7 @@
 import path from "path";
-import type { Server } from "http";
-import type { Server as SecureServer } from "https";
 import type { Express } from "express";
 import { create } from "ipfs-http-client";
 import type { Options } from "ipfs-http-client";
-import { Optional } from "typescript-optional";
 import { RuntimeError } from "run-time-error";
 import { Logger, Checks, LoggerProvider } from "@hyperledger/cactus-common";
 import type { LogLevelDesc } from "@hyperledger/cactus-common";
@@ -186,10 +183,6 @@ export class PluginObjectStoreIpfs implements IPluginObjectStore {
     };
   }
 
-  public getHttpServer(): Optional<Server | SecureServer> {
-    return Optional.empty();
-  }
-
   public async shutdown(): Promise<void> {
     this.log.info(`Shutting down ${this.className}...`);
   }

packages/cactus-cmd-api-server/src/test/typescript/fixtures/plugin-ledger-connector-stub/plugin-ledger-connector-stub.ts

@@ -1,8 +1,4 @@
-import { Server } from "http";
-import { Server as SecureServer } from "https";
-
 import { Express } from "express";
-import { Optional } from "typescript-optional";
 
 import {
   ConsensusAlgorithmFamily,
@@ -74,10 +70,6 @@ export class PluginLedgerConnectorStub
     return this.instanceId;
   }
 
-  public getHttpServer(): Optional<Server | SecureServer> {
-    return Optional.empty();
-  }
-
   public async onPluginInit(): Promise<unknown> {
     return;
   }

packages/cactus-core-api/src/main/typescript/plugin/web-service/i-plugin-web-service.ts

@@ -1,6 +1,3 @@
-import type { Server } from "http";
-import type { Server as SecureServer } from "https";
-import type { Optional } from "typescript-optional";
 import type { Application } from "express";
 import { IWebServiceEndpoint } from "./i-web-service-endpoint";
 import { ICactusPlugin } from "../i-cactus-plugin";
@@ -13,8 +10,6 @@ export interface IPluginWebService extends ICactusPlugin {
     expressApp: Application,
     wsApi: SocketIoServer,
   ): Promise<IWebServiceEndpoint[]>;
-
-  getHttpServer(): Optional<Server | SecureServer>;
   shutdown(): Promise<void>;
   getOpenApiSpec(): unknown;
 }
@@ -24,7 +19,6 @@ export function isIPluginWebService(x: unknown): x is IPluginWebService {
     !!x &&
     typeof (x as IPluginWebService).registerWebServices === "function" &&
     typeof (x as IPluginWebService).getOrCreateWebServices === "function" &&
-    typeof (x as IPluginWebService).getHttpServer === "function" &&
     typeof (x as IPluginWebService).getPackageName === "function" &&
     typeof (x as IPluginWebService).getInstanceId === "function" &&
     typeof (x as IPluginWebService).shutdown === "function" &&

packages/cactus-plugin-consortium-manual/src/main/typescript/plugin-consortium-manual.ts

@@ -1,9 +1,4 @@
-import { Server } from "http";
-import { Server as SecureServer } from "https";
-import { Optional } from "typescript-optional";
-import { promisify } from "util";
-import express, { Express } from "express";
-import bodyParser from "body-parser";
+import { Express } from "express";
 import { JWS, JWK } from "jose";
 import jsonStableStringify from "json-stable-stringify";
 import { v4 as uuidv4 } from "uuid";
@@ -53,7 +48,6 @@ export interface IPluginConsortiumManualOptions extends ICactusPluginOptions {
   prometheusExporter?: PrometheusExporter;
   pluginRegistry?: PluginRegistry;
   logLevel?: LogLevelDesc;
-  webAppOptions?: IWebAppOptions;
 }
 
 export class PluginConsortiumManual
@@ -64,7 +58,6 @@ export class PluginConsortiumManual
   private readonly instanceId: string;
   private readonly repo: ConsortiumRepository;
   private endpoints: IWebServiceEndpoint[] | undefined;
-  private httpServer: Server | SecureServer | null = null;
 
   public get className(): string {
     return PluginConsortiumManual.CLASS_NAME;
@@ -116,6 +109,10 @@ export class PluginConsortiumManual
     return this.prometheusExporter;
   }
 
+  public async shutdown(): Promise<void> {
+    return;
+  }
+
   public async getPrometheusExporterMetrics(): Promise<string> {
     const res: string = await this.prometheusExporter.getPrometheusMetrics();
     this.log.debug(`getPrometheusExporterMetrics() response: %o`, res);
@@ -137,47 +134,11 @@ export class PluginConsortiumManual
     this.prometheusExporter.setNodeCount(nodeCount);
   }
 
-  public async shutdown(): Promise<void> {
-    this.log.info(`Shutting down...`);
-    const serverMaybe = this.getHttpServer();
-    if (serverMaybe.isPresent()) {
-      this.log.info(`Awaiting server.close() ...`);
-      const server = serverMaybe.get();
-      await promisify(server.close.bind(server))();
-      this.log.info(`server.close() OK`);
-    } else {
-      this.log.info(`No HTTP server found, skipping...`);
-    }
-  }
-
   public async registerWebServices(
     app: Express,
   ): Promise<IWebServiceEndpoint[]> {
-    const webApp: Express = this.options.webAppOptions ? express() : app;
-
-    if (this.options.webAppOptions) {
-      this.log.info(`Creating dedicated HTTP server...`);
-      const { port, hostname } = this.options.webAppOptions;
-
-      webApp.use(bodyParser.json({ limit: "50mb" }));
-
-      const address = await new Promise((resolve, reject) => {
-        const httpServer = webApp.listen(port, hostname, (err?: any) => {
-          if (err) {
-            reject(err);
-            this.log.error(`Failed to create dedicated HTTP server`, err);
-          } else {
-            this.httpServer = httpServer;
-            const theAddress = this.httpServer.address();
-            resolve(theAddress);
-          }
-        });
-      });
-      this.log.info(`Creation of HTTP server OK`, { address });
-    }
-
     const webServices = await this.getOrCreateWebServices();
-    webServices.forEach((ws) => ws.registerExpress(webApp));
+    webServices.forEach((ws) => ws.registerExpress(app));
     return webServices;
   }
 
@@ -226,10 +187,6 @@ export class PluginConsortiumManual
     return endpoints;
   }
 
-  public getHttpServer(): Optional<Server | SecureServer> {
-    return Optional.ofNullable(this.httpServer);
-  }
-
   public getPackageName(): string {
     return `@hyperledger/cactus-plugin-consortium-manual`;
   }

packages/cactus-plugin-htlc-eth-besu-erc20/src/main/typescript/plugin-htlc-eth-besu-erc20.ts

@@ -1,8 +1,4 @@
-import { Server } from "http";
-import { Server as SecureServer } from "https";
-
 import { Express } from "express";
-import { Optional } from "typescript-optional";
 
 import OAS from "../json/openapi.json";
 
@@ -66,13 +62,6 @@ export class PluginHtlcEthBesuErc20
     return PluginHtlcEthBesuErc20.CLASS_NAME;
   }
 
-  /**
-   * Feature is deprecated, we won't need this method in the future.
-   */
-  public getHttpServer(): Optional<Server | SecureServer> {
-    return Optional.empty();
-  }
-
   /**
    * Feature is deprecated, we won't need this method in the future.
    */

packages/cactus-plugin-htlc-eth-besu/src/main/typescript/plugin-htlc-eth-besu.ts

@@ -1,8 +1,4 @@
-import { Server } from "http";
-import { Server as SecureServer } from "https";
-
 import { Express } from "express";
-import { Optional } from "typescript-optional";
 
 import OAS from "../json/openapi.json";
 
@@ -67,13 +63,6 @@ export class PluginHtlcEthBesu implements ICactusPlugin, IPluginWebService {
     return OAS;
   }
 
-  /**
-   * Feature is deprecated, we won't need this method in the future.
-   */
-  public getHttpServer(): Optional<Server | SecureServer> {
-    return Optional.empty();
-  }
-
   /**
    * Feature is deprecated, we won't need this method in the future.
    */

packages/cactus-plugin-keychain-aws-sm/src/main/typescript/plugin-keychain-aws-sm.ts

@@ -1,6 +1,3 @@
-import type { Server } from "http";
-import type { Server as SecureServer } from "https";
-
 import {
   SharedIniFileCredentials,
   config as awsConfig,
@@ -9,7 +6,6 @@ import {
 } from "aws-sdk";
 
 import type { Express } from "express";
-import { Optional } from "typescript-optional";
 
 import OAS from "../json/openapi.json";
 
@@ -172,10 +168,6 @@ export class PluginKeychainAwsSm
     return;
   }
 
-  public getHttpServer(): Optional<Server | SecureServer> {
-    return Optional.empty();
-  }
-
   public async shutdown(): Promise<void> {
     throw new Error("Method not implemented.");
   }

packages/cactus-plugin-keychain-azure-kv/src/main/typescript/plugin-keychain-azure-kv.ts

@@ -1,8 +1,4 @@
-import type { Server } from "http";
-import type { Server as SecureServer } from "https";
-
 import type { Express } from "express";
-import { Optional } from "typescript-optional";
 
 import OAS from "../json/openapi.json";
 
@@ -164,10 +160,6 @@ export class PluginKeychainAzureKv
     return endpoints;
   }
 
-  public getHttpServer(): Optional<Server | SecureServer> {
-    return Optional.empty();
-  }
-
   public async shutdown(): Promise<void> {
     throw new Error("Method not implemented.");
   }

packages/cactus-plugin-keychain-google-sm/src/main/typescript/plugin-keychain-google-sm.ts

@@ -1,8 +1,4 @@
-import type { Server } from "http";
-import type { Server as SecureServer } from "https";
-
 import type { Express } from "express";
-import { Optional } from "typescript-optional";
 
 import OAS from "../json/openapi.json";
 
@@ -99,10 +95,6 @@ export class PluginKeychainGoogleSm
     return endpoints;
   }
 
-  public getHttpServer(): Optional<Server | SecureServer> {
-    return Optional.empty();
-  }
-
   public async shutdown(): Promise<void> {
     throw new Error("Method not implemented.");
   }

packages/cactus-plugin-keychain-vault/src/main/typescript/plugin-keychain-vault-remote-adapter.ts

@@ -1,8 +1,4 @@
-import { Server } from "http";
-import { Server as SecureServer } from "https";
-
 import { Express } from "express";
-import { Optional } from "typescript-optional";
 
 import OAS from "../json/openapi.json";
 
@@ -94,10 +90,6 @@ export class PluginKeychainVaultRemoteAdapter
     return this.getOrCreateWebServices();
   }
 
-  public getHttpServer(): Optional<Server | SecureServer> {
-    return Optional.empty();
-  }
-
   public async shutdown(): Promise<void> {
     return;
   }

packages/cactus-plugin-keychain-vault/src/main/typescript/plugin-keychain-vault.ts

@@ -1,8 +1,4 @@
-import type { Server } from "http";
-import type { Server as SecureServer } from "https";
-
 import type { Express } from "express";
-import { Optional } from "typescript-optional";
 import Vault from "node-vault";
 import HttpStatus from "http-status-codes";
 
@@ -190,10 +186,6 @@ export class PluginKeychainVault implements IPluginWebService, IPluginKeychain {
     return endpoints;
   }
 
-  public getHttpServer(): Optional<Server | SecureServer> {
-    return Optional.empty();
-  }
-
   public async shutdown(): Promise<void> {
     throw new Error("Method not implemented.");
   }

packages/cactus-plugin-ledger-connector-besu/src/main/typescript/plugin-ledger-connector-besu.ts

@@ -4,7 +4,6 @@ import { Server as SecureServer } from "https";
 import type { Server as SocketIoServer } from "socket.io";
 import type { Socket as SocketIoSocket } from "socket.io";
 import type { Express } from "express";
-import { promisify } from "util";
 import { Optional } from "typescript-optional";
 
 import OAS from "../json/openapi.json";
@@ -187,17 +186,8 @@ export class PluginLedgerConnectorBesu
     this.web3EEA = EEAClient(this.web3, chainId);
   }
 
-  public getHttpServer(): Optional<Server | SecureServer> {
-    return Optional.ofNullable(this.httpServer);
-  }
-
   public async shutdown(): Promise<void> {
-    const serverMaybe = this.getHttpServer();
-    if (serverMaybe.isPresent()) {
-      const server = serverMaybe.get();
-      await promisify(server.close.bind(server))();
-    }
-    this.web3Provider.disconnect(1000, "Shutting down...");
+    this.log.info(`Shutting down ${this.className}...`);
   }
 
   async registerWebServices(

packages/cactus-plugin-ledger-connector-corda/src/main/typescript/plugin-ledger-connector-corda.ts

@@ -1,7 +1,5 @@
 import { Server } from "http";
 import { Server as SecureServer } from "https";
-
-import { Optional } from "typescript-optional";
 import { Config as SshConfig } from "node-ssh";
 import { Express } from "express";
 
@@ -175,10 +173,6 @@ export class PluginLedgerConnectorCorda
     return endpoints;
   }
 
-  public getHttpServer(): Optional<Server | SecureServer> {
-    return Optional.ofNullable(this.httpServer);
-  }
-
   public async shutdown(): Promise<void> {
     return;
   }