init nestjs-pubsub

Author: Yasai-T

.eslintignore

@@ -0,0 +1,3 @@
+lib/
+.cache/
+node_modules/

.eslintrc

@@ -0,0 +1,7 @@
+{
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier"
+  ]
+}

.gitignore

@@ -102,3 +102,5 @@ dist
 
 # TernJS port file
 .tern-port
+
+lib/

.prettierignore

@@ -0,0 +1,2 @@
+lib/
+coverage/

package.json

@@ -0,0 +1,62 @@
+{
+  "name": "nestjs-pubsub",
+  "version": "1.0.0",
+  "main": "lib/index.js",
+  "scripts": {
+    "build": "npm run clean && tsc -p .",
+    "clean": "rimraf lib",
+    "test": "jest"
+  },
+  "peerDependencies": {
+    "@google-cloud/pubsub": "^2.0.0",
+    "@nestjs/common": "^8.0.0"
+  },
+  "devDependencies": {
+    "@google-cloud/pubsub": "2.19.4",
+    "@nestjs/common": "8.4.5",
+    "@nestjs/core": "8.4.5",
+    "@nestjs/testing": "8.4.5",
+    "@types/jest": "27.5.1",
+    "@typescript-eslint/eslint-plugin": "5.25.0",
+    "@typescript-eslint/parser": "5.25.0",
+    "eslint": "8.5.0",
+    "eslint-config-prettier": "8.5.0",
+    "jest": "28.1.0",
+    "lint-staged": "12.4.1",
+    "prettier": "2.5.1",
+    "prettier-plugin-organize-imports": "2.3.4",
+    "prettier-plugin-package": "1.3.0",
+    "reflect-metadata": "0.1.13",
+    "rimraf": "3.0.2",
+    "rxjs": "7.5.5",
+    "simple-git-hooks": "2.7.0",
+    "ts-jest": "28.0.2",
+    "typescript": "4.6.4"
+  },
+  "types": "lib/index.d.ts",
+  "jest": {
+    "preset": "ts-jest",
+    "collectCoverage": true,
+    "coverageReporters": [
+      [
+        "lcov"
+      ],
+      "text-summary"
+    ]
+  },
+  "lint-staged": {
+    "*.{ts,tsx}": [
+      "prettier --write",
+      "eslint --fix"
+    ],
+    "*.{js,jsx,json,yml,toml,md}": [
+      "prettier --write"
+    ]
+  },
+  "prettier": {
+    "singleQuote": true
+  },
+  "simple-git-hooks": {
+    "pre-commit": "npx lint-staged"
+  }
+}

src/index.ts

@@ -0,0 +1,4 @@
+export * from './pubsub.constants';
+export * from './pubsub.inject';
+export * from './pubsub.interface';
+export * from './pubsub.module';

src/pubsub.constants.ts

@@ -0,0 +1,2 @@
+export const PUBSUB_TOKEN = 'PUBSUB_TOKEN';
+export const PUBSUB_MODULE = 'PUBSUB_MODULE';

src/pubsub.inject.spec.ts

@@ -0,0 +1,3 @@
+import { InjectPubsub } from './pubsub.inject';
+
+it('InjectPubsub', () => expect(InjectPubsub()).toBeDefined());

src/pubsub.inject.ts

@@ -0,0 +1,6 @@
+import { Inject } from '@nestjs/common';
+import { PUBSUB_TOKEN } from './pubsub.constants';
+
+export function InjectPubsub() {
+  return Inject(PUBSUB_TOKEN);
+}

src/pubsub.interface.ts

@@ -0,0 +1,13 @@
+import { ClientConfig } from '@google-cloud/pubsub';
+import { ModuleMetadata, Type } from '@nestjs/common';
+
+export interface PubsubOptionsFactory {
+  createOptions(): Promise<ClientConfig> | ClientConfig;
+}
+
+export interface PubsubAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
+  inject?: any[];
+  useClass?: Type<PubsubOptionsFactory>;
+  useExisting?: Type<PubsubOptionsFactory>;
+  useFactory?: (...arg: any[]) => Promise<ClientConfig> | ClientConfig;
+}

src/pubsub.module.spec.ts

@@ -0,0 +1,70 @@
+import { ClientConfig } from '@google-cloud/pubsub';
+import { Test } from '@nestjs/testing';
+import { PubsubModule } from './pubsub.module';
+
+describe('PubsubModule', () => {
+  let module: PubsubModule;
+  const options: ClientConfig = {
+    projectId: 'test-project-id',
+  };
+
+  beforeAll(async () => {
+    const moduleFixture = await Test.createTestingModule({
+      imports: [PubsubModule],
+    }).compile();
+
+    module = moduleFixture.get(PubsubModule);
+  });
+
+  it('is defined', () => expect(module).toBeDefined());
+
+  it('implements forRoot', () => {
+    const res = PubsubModule.forRoot(options);
+
+    expect(res.exports).toHaveLength(1);
+    expect(res.imports).toBeUndefined();
+    expect(res.module).toBeDefined();
+    expect(res.providers).toHaveLength(1);
+  });
+
+  it('implements forRootAsync', () => {
+    const res = PubsubModule.forRootAsync({});
+
+    expect(res.exports).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "inject": Array [
+            "PUBSUB_MODULE",
+          ],
+          "provide": "PUBSUB_TOKEN",
+          "useFactory": [Function],
+        },
+      ]
+    `);
+    expect(res.imports).toBeUndefined();
+    expect(res.providers).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "inject": Array [],
+          "provide": "PUBSUB_MODULE",
+          "useFactory": [Function],
+        },
+        Object {
+          "inject": Array [
+            Array [],
+          ],
+          "provide": undefined,
+          "useClass": undefined,
+        },
+        Object {
+          "inject": Array [
+            "PUBSUB_MODULE",
+          ],
+          "provide": "PUBSUB_TOKEN",
+          "useFactory": [Function],
+        },
+      ]
+    `);
+    expect(res.module).toBeDefined();
+  });
+});

src/pubsub.module.ts

@@ -0,0 +1,84 @@
+import { ClientConfig, PubSub } from '@google-cloud/pubsub';
+import {
+  ClassProvider,
+  DynamicModule,
+  Global,
+  Module,
+  Provider,
+} from '@nestjs/common';
+import { PUBSUB_MODULE, PUBSUB_TOKEN } from './pubsub.constants';
+import { PubsubAsyncOptions, PubsubOptionsFactory } from './pubsub.interface';
+
+function getClient(options: ClientConfig) {
+  return new PubSub(options);
+}
+
+function createProvider(options: ClientConfig): Provider<PubSub> {
+  return {
+    provide: PUBSUB_TOKEN,
+    useValue: getClient(options),
+  };
+}
+
+function createAsyncOptionsProvider({
+  inject,
+  useFactory,
+  useClass,
+  useExisting,
+}: PubsubAsyncOptions): Provider {
+  if (useFactory) {
+    return {
+      provide: PUBSUB_MODULE,
+      useFactory,
+      inject,
+    };
+  }
+
+  return {
+    provide: PUBSUB_MODULE,
+    inject: useExisting ? [useExisting] : useClass ? [useClass] : [],
+    useFactory: (f: PubsubOptionsFactory) => f.createOptions(),
+  };
+}
+
+function createAsyncProviders(options: PubsubAsyncOptions): Provider[] {
+  if (options.useExisting || options.useFactory) {
+    return [createAsyncOptionsProvider(options)];
+  }
+  return [
+    createAsyncOptionsProvider(options),
+    {
+      provide: options.useClass,
+      useClass: options.useClass,
+      inject: [options.inject ?? []],
+    } as ClassProvider,
+  ];
+}
+
+@Global()
+@Module({})
+export class PubsubModule {
+  static forRoot(options: ClientConfig): DynamicModule {
+    const provider = createProvider(options);
+    return {
+      module: PubsubModule,
+      exports: [provider],
+      providers: [provider],
+    };
+  }
+
+  static forRootAsync(options: PubsubAsyncOptions): DynamicModule {
+    const provider: Provider<PubSub> = {
+      inject: [PUBSUB_MODULE],
+      provide: PUBSUB_TOKEN,
+      useFactory: (options: ClientConfig) => getClient(options),
+    };
+
+    return {
+      exports: [provider],
+      imports: options.imports,
+      module: PubsubModule,
+      providers: [...createAsyncProviders(options), provider],
+    };
+  }
+}

tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "target": "es2020",
+    "lib": ["ES2020"],
+    "declaration": true,
+    "outDir": "./lib",
+    "rootDir": "./src",
+    "noEmit": false,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "**/*spec.ts"]
+}