Skip to content

Commit

Permalink
refactor(core-kernel): rename enable/disableWhen to boot/disposeWhen
Browse files Browse the repository at this point in the history
  • Loading branch information
faustbrian authored Nov 13, 2019
1 parent 8ca9000 commit 83c56f1
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -179,11 +179,11 @@ export class DeferredServiceProvider extends ServiceProvider {
return "version";
}

public async enableWhen(): Promise<boolean> {
public async bootWhen(): Promise<boolean> {
return process.env.DEFFERED_ENABLE === "true";
}

public async disableWhen(): Promise<boolean> {
public async disposeWhen(): Promise<boolean> {
return process.env.DEFFERED_DISABLE === "true";
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ describe("BootServiceProviders", () => {
expect(serviceProviderRepository.deferred("stub")).toBeTrue();
});

describe("DeferredServiceProvider - enableWhen", () => {
describe("DeferredServiceProvider - bootWhen", () => {
it("should react to [StateEvent.BlockApplied]", async () => {
const serviceProvider: ServiceProvider = new DeferredServiceProvider();
const spyBoot = jest.spyOn(serviceProvider, "boot");
Expand Down Expand Up @@ -146,7 +146,7 @@ describe("BootServiceProviders", () => {
});
});

describe("DeferredServiceProvider - disableWhen", () => {
describe("DeferredServiceProvider - disposeWhen", () => {
it("should react to [StateEvent.BlockApplied]", async () => {
const serviceProvider: ServiceProvider = new DeferredServiceProvider();
const spyDispose = jest.spyOn(serviceProvider, "dispose");
Expand Down
8 changes: 4 additions & 4 deletions __tests__/unit/core-kernel/providers/service-provider.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -132,12 +132,12 @@ describe("ServiceProvider", () => {
expect(app.resolve(StubServiceProvider).dependencies()).toEqual([]);
});

it(".enableWhen", async () => {
await expect(app.resolve(StubServiceProvider).enableWhen()).resolves.toBeTrue();
it(".bootWhen", async () => {
await expect(app.resolve(StubServiceProvider).bootWhen()).resolves.toBeTrue();
});

it(".disableWhen", async () => {
await expect(app.resolve(StubServiceProvider).disableWhen()).resolves.toBeFalse();
it(".disposeWhen", async () => {
await expect(app.resolve(StubServiceProvider).disposeWhen()).resolves.toBeFalse();
});

it(".required", () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export class BootServiceProviders implements Bootstrapper {

assert.defined<string>(serviceProviderName);

if (await serviceProvider.enableWhen()) {
if (await serviceProvider.bootWhen()) {
try {
await serviceProviders.boot(name);
} catch (error) {
Expand All @@ -56,7 +56,7 @@ export class BootServiceProviders implements Bootstrapper {
serviceProviders.defer(name);
}

// Register the "enable/disableWhen" listeners to be triggered on every block. Use with care!
// Register the "enable/disposeWhen" listeners to be triggered on every block. Use with care!
this.app.events.listen(
StateEvent.BlockApplied,
async () => await this.changeState(name, serviceProvider, serviceProviders),
Expand All @@ -80,12 +80,12 @@ export class BootServiceProviders implements Bootstrapper {
return;
}

if (serviceProviders.loaded(name) && (await serviceProvider.disableWhen())) {
if (serviceProviders.loaded(name) && (await serviceProvider.disposeWhen())) {
await serviceProviders.dispose(name);
}

/* istanbul ignore else */
if (serviceProviders.deferred(name) && (await serviceProvider.enableWhen())) {
if (serviceProviders.deferred(name) && (await serviceProvider.bootWhen())) {
await serviceProviders.boot(name);
}
}
Expand Down
4 changes: 2 additions & 2 deletions packages/core-kernel/src/providers/service-provider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ export abstract class ServiceProvider {
* @returns {Promise<boolean>}
* @memberof ServiceProvider
*/
public async enableWhen(): Promise<boolean> {
public async bootWhen(): Promise<boolean> {
return true;
}

Expand All @@ -200,7 +200,7 @@ export abstract class ServiceProvider {
* @returns {Promise<boolean>}
* @memberof ServiceProvider
*/
public async disableWhen(): Promise<boolean> {
public async disposeWhen(): Promise<boolean> {
return false;
}

Expand Down

0 comments on commit 83c56f1

Please sign in to comment.