@sourceloop/ctrl-plane-subscription-service/src/sequelize-component.ts

Subscription management microservice for SaaS control plane.

// Copyright (c) 2023 Sourcefuse Technologies
//
// This software is released under the MIT License.
// https://opensource.org/licenses/MIT

import {inject, Binding} from '@loopback/context';
import {
  Component,
  CoreBindings,
  ProviderMap,
  ServiceOrProviderClass,
  ControllerClass,
  createServiceBinding,
} from '@loopback/core';
import {Class, Repository, Model} from '@loopback/repository';
import {RestApplication} from '@loopback/rest';
import {
  CoreComponent,
  SECURITY_SCHEME_SPEC,
  ServiceSequence,
  BearerVerifierBindings,
  BearerVerifierType,
  BearerVerifierConfig,
  BearerVerifierComponent,
  BooterBasePathMixin,
  CoreModelBooter,
  CoreControllerBooter,
} from '@sourceloop/core';
import {
  FeatureToggleBindings,
  FeatureToggleServiceComponent,
} from '@sourceloop/feature-toggle-service';
import {BillingComponent} from 'loopback4-billing';
import {AuthenticationComponent} from 'loopback4-authentication';
import {
  AuthorizationBindings,
  AuthorizationComponent,
} from 'loopback4-authorization';
import {
  SubscriptionServiceBindings,
  SYSTEM_USER,
  WEBHOOK_VERIFIER,
} from './keys';
import {
  BillingCycle,
  Currency,
  Plan,
  Resource,
  BillingCustomer,
  Invoice,
  Service,
  Subscription,
  PlanSizes,
} from './models';
import {
  BillingCycleRepository,
  CurrencyRepository,
  PlanRepository,
  ResourceRepository,
  ServiceRepository,
  SubscriptionRepository,
  PlanSizesRepository,
  BillingCustomerRepository,
  InvoiceRepository,
} from './repositories/sequelize';
import {ISubscriptionServiceConfig} from './types';
import {WebhookVerifierProvider} from './interceptors/webhook-verifier.interceptor';
import {SystemUserProvider} from './providers';
import {
  BillingCustomerService,
  BillingInvoiceService,
  BillingPaymentSourceService,
  PlanFeaturesService,
  SubscriptionService,
} from './services';
import {Booter} from '@loopback/boot';

export class SubscriptionSequelizeServiceComponent implements Component {
  constructor(
    @inject(CoreBindings.APPLICATION_INSTANCE)
    private readonly application: RestApplication,
    @inject(SubscriptionServiceBindings.Config, {optional: true})
    private readonly subscriptionConfig?: ISubscriptionServiceConfig,
  ) {
    this.providers = {};

    // Mount core component
    this.application.component(CoreComponent);

    /**Bind the feature toggle service to main the list of features */
    this.application
      .bind(FeatureToggleBindings.Config)
      .to({bindControllers: true, useCustomSequence: true});
    this.application.component(FeatureToggleServiceComponent);
    this.application.component(BillingComponent);

    this.application.api({
      openapi: '3.0.0',
      info: {
        title: 'Subscription Service',
        version: '1.0.0',
      },
      paths: {},
      components: {
        securitySchemes: SECURITY_SCHEME_SPEC,
      },
      servers: [{url: '/'}],
    });

    if (!this.subscriptionConfig?.useCustomSequence) {
      // Mount default sequence if needed
      this.setupSequence();
    }

    this.booters = [
      BooterBasePathMixin(CoreModelBooter, __dirname, {
        interface: SubscriptionSequelizeServiceComponent.name,
      }),
      BooterBasePathMixin(CoreControllerBooter, __dirname, {
        dirs: ['controllers'],
        extensions: ['.controller.js'],
        nested: true,
        interface: SubscriptionSequelizeServiceComponent.name,
      }),
    ];

    this.repositories = [
      BillingCustomerRepository,
      BillingCycleRepository,
      PlanRepository,
      PlanSizesRepository,
      InvoiceRepository,
      ResourceRepository,
      SubscriptionRepository,
      ServiceRepository,
      CurrencyRepository,
    ];

    this.models = [
      BillingCycle,
      Currency,
      Plan,
      Resource,
      BillingCustomer,
      Invoice,
      Service,
      Subscription,
      PlanSizes,
    ];
    this.bindings = [
      Binding.bind(WEBHOOK_VERIFIER).toProvider(WebhookVerifierProvider),

      Binding.bind(SYSTEM_USER).toProvider(SystemUserProvider),
      createServiceBinding(BillingPaymentSourceService),
      createServiceBinding(BillingInvoiceService),
      createServiceBinding(SubscriptionService),
      createServiceBinding(PlanFeaturesService),
      createServiceBinding(BillingCustomerService),
    ];
  }

  providers?: ProviderMap = {};

  bindings?: Binding[] = [];

  services?: ServiceOrProviderClass[];

  booters?: Class<Booter>[];

  /**
   * An optional list of Repository classes to bind for dependency injection
   * via `app.repository()` API.
   */
  repositories?: Class<Repository<Model>>[];

  /**
   * An optional list of Model classes to bind for dependency injection
   * via `app.model()` API.
   */
  models?: Class<Model>[];

  /**
   * An array of controller classes
   */
  controllers?: ControllerClass[];

  /**
   * Setup ServiceSequence by default if no other sequnce provided
   *
   */
  setupSequence() {
    this.application.sequence(ServiceSequence);

    // Mount authentication component for default sequence
    this.application.component(AuthenticationComponent);
    // Mount bearer verifier component
    this.application.bind(BearerVerifierBindings.Config).to({
      authServiceUrl: '',
      type: BearerVerifierType.service,
    } as BearerVerifierConfig);
    this.application.component(BearerVerifierComponent);

    // Mount authorization component for default sequence
    this.application.bind(AuthorizationBindings.CONFIG).to({
      allowAlwaysPaths: ['/explorer'],
    });
    this.application.component(AuthorizationComponent);
  }
}