feat(core-kernel): required plugins to terminate on registration failure

ArkEcosystem · Aug 22, 2019 · d44e29c · d44e29c
1 parent 1de4f3f
commit d44e29c
Show file tree

Hide file tree

Showing 12 changed files with 85 additions and 10 deletions.
diff --git a/packages/core-blockchain/src/service-provider.ts b/packages/core-blockchain/src/service-provider.ts
@@ -36,4 +36,8 @@ export class ServiceProvider extends Support.AbstractServiceProvider {
     public provides(): string[] {
         return ["blockchain"];
     }
+
+    public async required(): Promise<boolean> {
+        return true;
+    }
 }
diff --git a/packages/core-database-postgres/src/service-provider.ts b/packages/core-database-postgres/src/service-provider.ts
@@ -33,4 +33,8 @@ export class ServiceProvider extends Support.AbstractServiceProvider {
     public provides(): string[] {
         return ["database"];
     }
+
+    public async required(): Promise<boolean> {
+        return true;
+    }
 }
diff --git a/packages/core-kernel/src/bootstrap/service-providers/boot-service-providers.ts b/packages/core-kernel/src/bootstrap/service-providers/boot-service-providers.ts
@@ -1,4 +1,5 @@
 import { State } from "../../enums/event";
+import { FailedServiceProviderBoot } from "../../errors";
 import { ServiceProviderRepository } from "../../repositories";
 import { AbstractBootstrapper } from "../bootstrapper";
 
@@ -18,7 +19,15 @@ export class BootServiceProviders extends AbstractBootstrapper {
 
         for (const [name, serviceProvider] of serviceProviders.all()) {
             if (await serviceProvider.enableWhen()) {
-                await serviceProviders.boot(name);
+                try {
+                    await serviceProviders.boot(name);
+                } catch (error) {
+                    if (await serviceProvider.required()) {
+                        throw new FailedServiceProviderBoot(serviceProvider.name(), error.message);
+                    }
+
+                    serviceProviders.fail(serviceProvider.name());
+                }
             } else {
                 serviceProviders.defer(name);
             }

diff --git a/packages/core-kernel/src/bootstrap/service-providers/register-service-providers.ts b/packages/core-kernel/src/bootstrap/service-providers/register-service-providers.ts
@@ -30,7 +30,11 @@ export class RegisterServiceProviders extends AbstractBootstrapper {
                 try {
                     await serviceProviders.register(name);
                 } catch (error) {
-                    throw new FailedServiceProviderRegistration(serviceProvider.name(), error.message);
+                    if (await serviceProvider.required()) {
+                        throw new FailedServiceProviderRegistration(serviceProvider.name(), error.message);
+                    }
+
+                    serviceProviders.fail(serviceProvider.name());
                 }
             }
         }
@@ -54,14 +58,10 @@ export class RegisterServiceProviders extends AbstractBootstrapper {
         );
 
         for (const dependency of dependencies) {
-            const { name, version, required, requiredWhen } = dependency;
+            const { name, version, required } = dependency;
 
             if (!serviceProviders.has(name)) {
-                let isRequired: boolean = !!required;
-
-                if (requiredWhen) {
-                    isRequired = await requiredWhen();
-                }
+                const isRequired: boolean = typeof required === "function" ? await required() : !!required;
 
                 const error: MissingDependency = new MissingDependency(serviceProvider.name(), name, isRequired);
 

diff --git a/packages/core-kernel/src/contracts/core-kernel/application.ts b/packages/core-kernel/src/contracts/core-kernel/application.ts
@@ -200,8 +200,20 @@ export interface IApplication extends IContainer {
  * @interface IServiceProviderDependency
  */
 export interface IServiceProviderDependency {
+    /**
+     * @type {string}
+     * @memberof IServiceProviderDependency
+     */
     name: string;
+
+    /**
+     * @type {string}
+     * @memberof IServiceProviderDependency
+     */
     version?: string;
-    required?: boolean;
-    requiredWhen?: () => Promise<boolean>;
+
+    /**
+     * @memberof IServiceProviderDependency
+     */
+    required?: boolean | (() => Promise<boolean>);
 }
diff --git a/packages/core-kernel/src/errors/kernel.ts b/packages/core-kernel/src/errors/kernel.ts
@@ -135,6 +135,22 @@ export class FailedServiceProviderRegistration extends KernelError {
     }
 }
 
+/**
+ * @export
+ * @class FailedServiceProviderBoot
+ * @extends {KernelError}
+ */
+export class FailedServiceProviderBoot extends KernelError {
+    /**
+     * @param {string} name
+     * @param {string} error
+     * @memberof FailedServiceProviderBoot
+     */
+    constructor(name: string, error: string) {
+        super(`Failed to boot "${name}": "${error}".`);
+    }
+}
+
 /**
  * @export
  * @class FailedDependencySatisfaction

diff --git a/packages/core-kernel/src/support/service-provider.ts b/packages/core-kernel/src/support/service-provider.ts
@@ -131,6 +131,16 @@ export abstract class AbstractServiceProvider {
         return false;
     }
 
+    /**
+     * Terminate the process if the package is required.
+     *
+     * @returns {Promise<boolean>}
+     * @memberof AbstractServiceProvider
+     */
+    public async required(): Promise<boolean> {
+        return true;
+    }
+
     /**
      * @protected
      * @param {ConfigObject} opts

diff --git a/packages/core-logger-pino/src/service-provider.ts b/packages/core-logger-pino/src/service-provider.ts
@@ -23,4 +23,8 @@ export class ServiceProvider extends Support.AbstractServiceProvider {
     public provides(): string[] {
         return ["log"];
     }
+
+    public async required(): Promise<boolean> {
+        return true;
+    }
 }
diff --git a/packages/core-logger-signale/src/service-provider.ts b/packages/core-logger-signale/src/service-provider.ts
@@ -23,4 +23,8 @@ export class ServiceProvider extends Support.AbstractServiceProvider {
     public provides(): string[] {
         return ["log"];
     }
+
+    public async required(): Promise<boolean> {
+        return true;
+    }
 }
diff --git a/packages/core-logger-winston/src/service-provider.ts b/packages/core-logger-winston/src/service-provider.ts
@@ -23,4 +23,8 @@ export class ServiceProvider extends Support.AbstractServiceProvider {
     public provides(): string[] {
         return ["log"];
     }
+
+    public async required(): Promise<boolean> {
+        return true;
+    }
 }
diff --git a/packages/core-p2p/src/service-provider.ts b/packages/core-p2p/src/service-provider.ts
@@ -48,6 +48,10 @@ export class ServiceProvider extends Support.AbstractServiceProvider {
         return ["p2p"];
     }
 
+    public async required(): Promise<boolean> {
+        return true;
+    }
+
     // @TODO: ioc
     private makePeerService(options): PeerService {
         const storage = new PeerStorage();

diff --git a/packages/core-transaction-pool/src/service-provider.ts b/packages/core-transaction-pool/src/service-provider.ts
@@ -44,4 +44,8 @@ export class ServiceProvider extends Support.AbstractServiceProvider {
     public provides(): string[] {
         return ["transactionPool"];
     }
+
+    public async required(): Promise<boolean> {
+        return true;
+    }
 }