fix(subscription-service): refactor the code (#80)

## Description

Restored the keys to their previous state

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] Intermediate change (work in progress)

## How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration

- [ ] Test A
- [ ] Test B

## Checklist:

- [ ] Performed a self-review of my own code
- [ ] npm test passes on your machine
- [ ] New tests added or existing tests modified to cover all changes
- [ ] Code conforms with the style guide
- [ ] API Documentation in code was updated
- [ ] Any dependent changes have been merged and published in downstream
modules

Author: vaibhavbhalla2505

services/subscription-service/src/component.ts

@@ -45,7 +45,11 @@ import {
   PlanSizesController,
   PlanFeaturesController,
 } from './controllers';
-import {SubscriptionServiceBindings} from './keys';
+import {
+  SubscriptionServiceBindings,
+  SYSTEM_USER,
+  WEBHOOK_VERIFIER,
+} from './keys';
 import {
   BillingCycle,
   Currency,
@@ -68,7 +72,7 @@ import {
   BillingCustomerRepository,
   InvoiceRepository,
 } from './repositories';
-import {SubscriptionServiceConfig} from './types';
+import {ISubscriptionServiceConfig} from './types';
 import {WebhookVerifierProvider} from './interceptors/webhook-verifier.interceptor';
 import {SystemUserProvider} from './providers';
 import {BillingCustomerController} from './controllers/billing-customer.controller';
@@ -81,7 +85,7 @@ export class SubscriptionServiceComponent implements Component {
     @inject(CoreBindings.APPLICATION_INSTANCE)
     private readonly application: RestApplication,
     @inject(SubscriptionServiceBindings.Config, {optional: true})
-    private readonly subscriptionConfig?: SubscriptionServiceConfig,
+    private readonly subscriptionConfig?: ISubscriptionServiceConfig,
   ) {
     this.providers = {};
 
@@ -136,13 +140,9 @@ export class SubscriptionServiceComponent implements Component {
       PlanSizes,
     ];
     this.bindings = [
-      Binding.bind(SubscriptionServiceBindings.WEBHOOK_VERIFIER).toProvider(
-        WebhookVerifierProvider,
-      ),
+      Binding.bind(WEBHOOK_VERIFIER).toProvider(WebhookVerifierProvider),
 
-      Binding.bind(SubscriptionServiceBindings.SYSTEM_USER).toProvider(
-        SystemUserProvider,
-      ),
+      Binding.bind(SYSTEM_USER).toProvider(SystemUserProvider),
     ];
 
     this.controllers = [

services/subscription-service/src/controllers/webhook.controller.ts

@@ -2,7 +2,7 @@ import {intercept} from '@loopback/core';
 import {repository} from '@loopback/repository';
 import {post, requestBody} from '@loopback/rest';
 import {authorize} from 'loopback4-authorization';
-import {SubscriptionServiceBindings} from '../keys';
+import {WEBHOOK_VERIFIER} from '../keys';
 import {InvoiceRepository} from '../repositories';
 import {BillingCustomerRepository} from '../repositories/billing-customer.repository';
 import {IContent, IPayload} from '../types';
@@ -18,7 +18,7 @@ export class WebhookController {
   @authorize({
     permissions: ['*'],
   })
-  @intercept(SubscriptionServiceBindings.WEBHOOK_VERIFIER)
+  @intercept(WEBHOOK_VERIFIER)
   @post('/webhooks/billing-payment')
   async handleWebhook(@requestBody() payload: IPayload): Promise<void> {
     const content = payload.content;

services/subscription-service/src/interceptors/webhook-verifier.interceptor.ts

@@ -9,15 +9,15 @@ import {
 import {HttpErrors, RequestContext} from '@loopback/rest';
 import {ILogger, LOGGER} from '@sourceloop/core';
 import {AuthenticationBindings, IAuthUser} from 'loopback4-authentication';
-import {SubscriptionServiceBindings} from '../keys';
+import {SYSTEM_USER} from '../keys';
 
 export class WebhookVerifierProvider implements Provider<Interceptor> {
   constructor(
     @inject(LOGGER.LOGGER_INJECT)
     private readonly logger: ILogger,
     @inject.setter(AuthenticationBindings.CURRENT_USER)
     private readonly setCurrentUser: Setter<IAuthUser>,
-    @inject(SubscriptionServiceBindings.SYSTEM_USER)
+    @inject(SYSTEM_USER)
     private readonly systemUser: IAuthUser,
   ) {}
 

services/subscription-service/src/keys.ts

@@ -1,29 +1,30 @@
 import {BindingKey, Interceptor} from '@loopback/core';
-import {SubscriptionServiceConfig} from './types';
+import {ISubscriptionServiceConfig} from './types';
 import {BINDING_PREFIX} from '@sourceloop/core';
 import {VerifyFunction} from 'loopback4-authentication';
 import {AnyObject} from '@loopback/repository';
 import {IAuthUser} from 'loopback4-authorization';
 
 export namespace SubscriptionServiceBindings {
-  export const WEBHOOK_VERIFIER = BindingKey.create<Interceptor>(
-    'sf.webhook.verifier',
-  );
-
-  /**
-   * Binding key for the lead token verifier.
-   */
-  export const LEAD_TOKEN_VERIFIER = BindingKey.create<
-    VerifyFunction.BearerFn<AnyObject>
-  >('sf.user.lead.verifier');
-
-  /**
-   * Binding key for the system user.
-   */
-  export const SYSTEM_USER = BindingKey.create<IAuthUser & AnyObject>(
-    'sf.user.system',
-  );
-  export const Config = BindingKey.create<SubscriptionServiceConfig>(
+  export const Config = BindingKey.create<ISubscriptionServiceConfig>(
     `${BINDING_PREFIX}.task.config`,
   );
 }
+
+export const WEBHOOK_VERIFIER = BindingKey.create<Interceptor>(
+  'sf.webhook.verifier',
+);
+
+/**
+ * Binding key for the lead token verifier.
+ */
+export const LEAD_TOKEN_VERIFIER = BindingKey.create<
+  VerifyFunction.BearerFn<AnyObject>
+>('sf.user.lead.verifier');
+
+/**
+ * Binding key for the system user.
+ */
+export const SYSTEM_USER = BindingKey.create<IAuthUser & AnyObject>(
+  'sf.user.system',
+);

services/subscription-service/src/sequelize-component.ts

@@ -45,7 +45,11 @@ import {
   PlanSizesController,
   PlanFeaturesController,
 } from './controllers';
-import {SubscriptionServiceBindings} from './keys';
+import {
+  SubscriptionServiceBindings,
+  SYSTEM_USER,
+  WEBHOOK_VERIFIER,
+} from './keys';
 import {
   BillingCycle,
   Currency,
@@ -68,7 +72,7 @@ import {
   BillingCustomerRepository,
   InvoiceRepository,
 } from './repositories/sequelize';
-import {SubscriptionServiceConfig} from './types';
+import {ISubscriptionServiceConfig} from './types';
 import {WebhookVerifierProvider} from './interceptors/webhook-verifier.interceptor';
 import {SystemUserProvider} from './providers';
 import {BillingCustomerController} from './controllers/billing-customer.controller';
@@ -81,7 +85,7 @@ export class SubscriptionSequelizeServiceComponent implements Component {
     @inject(CoreBindings.APPLICATION_INSTANCE)
     private readonly application: RestApplication,
     @inject(SubscriptionServiceBindings.Config, {optional: true})
-    private readonly subscriptionConfig?: SubscriptionServiceConfig,
+    private readonly subscriptionConfig?: ISubscriptionServiceConfig,
   ) {
     this.providers = {};
 
@@ -136,13 +140,9 @@ export class SubscriptionSequelizeServiceComponent implements Component {
       PlanSizes,
     ];
     this.bindings = [
-      Binding.bind(SubscriptionServiceBindings.WEBHOOK_VERIFIER).toProvider(
-        WebhookVerifierProvider,
-      ),
+      Binding.bind(WEBHOOK_VERIFIER).toProvider(WebhookVerifierProvider),
 
-      Binding.bind(SubscriptionServiceBindings.SYSTEM_USER).toProvider(
-        SystemUserProvider,
-      ),
+      Binding.bind(SYSTEM_USER).toProvider(SystemUserProvider),
     ];
 
     this.controllers = [

services/subscription-service/src/types.ts

@@ -41,7 +41,7 @@ export interface IPayload {
 export interface IContent {
   invoice: TInvoice;
 }
-export interface SubscriptionServiceConfig extends IServiceConfig {
+export interface ISubscriptionServiceConfig extends IServiceConfig {
   useCustomSequence: boolean;
   useSequelize?: boolean;
 }

services/tenant-management-service/src/__tests__/acceptance/test-helper.ts

@@ -19,6 +19,7 @@ import {
 } from 'loopback4-authentication';
 import {RateLimitSecurityBindings} from 'loopback4-ratelimiter';
 import {
+  EventConnectorBinding,
   TenantManagementServiceBindings,
   TenantManagementServiceComponent,
   WebhookTenantManagementServiceComponent,
@@ -135,9 +136,7 @@ function setupEventConnector(app: RestApplication) {
     }
   }
 
-  app
-    .bind(TenantManagementServiceBindings.EventConnectorBinding)
-    .toClass(EventConnector);
+  app.bind(EventConnectorBinding).toClass(EventConnector);
 }
 
 export interface AppWithClient {
@@ -175,7 +174,7 @@ export class TestTenantMgmtServiceApplication extends BootMixin(
   constructor(options: ApplicationConfig = {}) {
     super(options);
     this.static('/', path.join(__dirname, '../public'));
-    this.bind(TenantManagementServiceBindings.config).to({
+    this.bind(TenantManagementServiceBindings.Config).to({
       useCustomSequence: true,
     });
     this.component(TenantManagementServiceComponent);

services/tenant-management-service/src/__tests__/acceptance/webhook.controller.acceptance.ts

@@ -4,8 +4,7 @@ import {ILogger, LOGGER, STATUS_CODE} from '@sourceloop/core';
 import {createHmac, randomBytes} from 'crypto';
 import {TenantMgmtServiceApplication} from '../../application';
 import {TenantStatus} from '../../enums';
-// import {PostWebhookHandlerServiceKey, WEBHOOK_CONFIG} from '../../keys';
-import {TenantManagementServiceBindings} from '../../keys';
+import {PostWebhookHandlerServiceKey, WEBHOOK_CONFIG} from '../../keys';
 import {
   ContactRepository,
   ResourceRepository,
@@ -31,7 +30,7 @@ describe('WebhookController', () => {
 
   before('setupApplication', async () => {
     ({app, client} = await setupApplication(notifStub));
-    webhookConfig = app.getSync(TenantManagementServiceBindings.WEBHOOK_CONFIG);
+    webhookConfig = app.getSync(WEBHOOK_CONFIG);
     const logger = app.getSync<ILogger>(LOGGER.LOGGER_INJECT);
     loggerSpy = sinon.spy(logger);
     app.bind(LOGGER.LOGGER_INJECT).to(logger).inScope(BindingScope.SINGLETON);
@@ -53,7 +52,7 @@ describe('WebhookController', () => {
     });
 
     postWebhookHandlerServiceStub = sinon.stub();
-    app.bind(TenantManagementServiceBindings.PostWebhookHandlerServiceKey).to({
+    app.bind(PostWebhookHandlerServiceKey).to({
       postWebhookHandler: postWebhookHandlerServiceStub,
     });
   });

services/tenant-management-service/src/__tests__/unit/sequelize.application.ts

@@ -19,7 +19,7 @@ export class TenantMgmtServiceApplication extends BootMixin(
   constructor(options: ApplicationConfig = {}) {
     super(options);
     this.static('/', path.join(__dirname, '../public'));
-    this.bind(TenantManagementServiceBindings.config).to({
+    this.bind(TenantManagementServiceBindings.Config).to({
       useCustomSequence: false,
       useSequelize: true,
     });

services/tenant-management-service/src/component.ts

@@ -41,7 +41,12 @@ import {
   TenantController,
 } from './controllers';
 import {InvoiceController} from './controllers/invoice.controller';
-import {TenantManagementServiceBindings} from './keys';
+import {
+  TenantManagementServiceBindings,
+  LEAD_TOKEN_VERIFIER,
+  SYSTEM_USER,
+  EventConnectorBinding,
+} from './keys';
 import {
   Address,
   Contact,
@@ -79,14 +84,14 @@ import {
   OnboardingService,
   ProvisioningService,
 } from './services';
-import {TenantManagementServiceConfig} from './types';
+import {ITenantManagementServiceConfig} from './types';
 
 export class TenantManagementServiceComponent implements Component {
   constructor(
     @inject(CoreBindings.APPLICATION_INSTANCE)
     private readonly application: RestApplication,
-    @inject(TenantManagementServiceBindings.config, {optional: true})
-    private readonly tenantMgmtConfig?: TenantManagementServiceConfig,
+    @inject(TenantManagementServiceBindings.Config, {optional: true})
+    private readonly tenantMgmtConfig?: ITenantManagementServiceConfig,
   ) {
     this.providers = {};
 
@@ -152,12 +157,8 @@ export class TenantManagementServiceComponent implements Component {
     ];
 
     this.bindings = [
-      Binding.bind(
-        TenantManagementServiceBindings.LEAD_TOKEN_VERIFIER,
-      ).toProvider(LeadTokenVerifierProvider),
-      Binding.bind(TenantManagementServiceBindings.SYSTEM_USER).toProvider(
-        SystemUserProvider,
-      ),
+      Binding.bind(LEAD_TOKEN_VERIFIER).toProvider(LeadTokenVerifierProvider),
+      Binding.bind(SYSTEM_USER).toProvider(SystemUserProvider),
       createServiceBinding(ProvisioningService),
       createServiceBinding(OnboardingService),
       createServiceBinding(LeadAuthenticator),
@@ -166,10 +167,7 @@ export class TenantManagementServiceComponent implements Component {
       createServiceBinding(InvoicePDFGenerator),
     ];
 
-    this.addClassBindingIfNotPresent(
-      TenantManagementServiceBindings.EventConnectorBinding.key,
-      EventConnector,
-    );
+    this.addClassBindingIfNotPresent(EventConnectorBinding.key, EventConnector);
   }
 
   providers?: ProviderMap = {};