refactor(Refactor/divide graphql config): Implement graphql config service (#40)

* Refactor: Refactor TypeORM configuration to use injectable for DI

* Refactor: Replace SettingModule with GraphqlConfigService for GraphQL configuration

* Refactor: Remove SettingModule and SettingService as part of code cleanup

* Refactor: Move UtilModule and UtilService to common/util directory

* Refactor: Remove commented uploads option from GraphqlConfigService

Author: Ho-s

generator/templates/resolver.spec.hbs

@@ -7,8 +7,8 @@ import {
 import { {{pascalCase tableName}}Service } from './{{tableName}}.service'
 import { GetManyInput, GetOneInput } from 'src/common/graphql/custom.input'
 import { {{pascalCase tableName}} } from './entities/{{tableName}}.entity'
-import { UtilModule } from 'src/common/shared/services/util.module';
-import { UtilService } from 'src/common/shared/services/util.service';
+import { UtilModule } from 'src/common/util/util.module';
+import { UtilService } from 'src/common/util/util.service';
 import { DataSource } from 'typeorm';
 
 import { Create{{pascalCase tableName}}Input, Update{{pascalCase tableName}}Input } from './inputs/{{tableName}}.input'

generator/templates/service.spec.hbs

@@ -11,8 +11,8 @@ import { {{pascalCase tableName}} } from './entities/{{tableName}}.entity'
 import { Create{{pascalCase tableName}}Input, Update{{pascalCase tableName}}Input } from './inputs/{{tableName}}.input'
 import { ExtendedRepository } from 'src/common/graphql/customExtended'
 import { OneRepoQuery, RepoQuery } from 'src/common/graphql/types'
-import { UtilModule } from 'src/common/shared/services/util.module';
-import { UtilService } from 'src/common/shared/services/util.service';
+import { UtilModule } from 'src/common/util/util.module';
+import { UtilService } from 'src/common/util/util.service';
 
 describe('{{pascalCase tableName}}Service', () => {
   let service: {{pascalCase tableName}}Service

src/app.module.ts

@@ -1,19 +1,15 @@
 import { ApolloDriver, ApolloDriverConfig } from '@nestjs/apollo';
 import { Module } from '@nestjs/common';
-import { ConfigModule, ConfigService } from '@nestjs/config';
+import { ConfigModule } from '@nestjs/config';
 import { GraphQLModule } from '@nestjs/graphql';
 import { TypeOrmModule } from '@nestjs/typeorm';
 
 import { AuthModule } from './auth/auth.module';
 import { CustomCacheModule } from './cache/custom-cache.module';
-import {
-  typeormConfigKey,
-  typeormConfigLoader,
-} from './common/config/ormconfig';
+import { GraphqlConfigService } from './common/config/graphql-config.service';
+import { TypeORMConfigService } from './common/config/ormconfig.service';
 import { getEnvPath } from './common/helper/env.helper';
 import { envValidation } from './common/helper/env.validation';
-import { SettingModule } from './common/shared/setting/setting.module';
-import { SettingService } from './common/shared/setting/setting.service';
 import { HealthModule } from './health/health.module';
 import { UploadModule } from './upload/upload.module';
 import { UserModule } from './user/user.module';
@@ -23,20 +19,15 @@ import { UserModule } from './user/user.module';
     ConfigModule.forRoot({
       envFilePath: getEnvPath(`${__dirname}/..`),
       validate: envValidation,
-      load: [typeormConfigLoader],
     }),
     GraphQLModule.forRootAsync<ApolloDriverConfig>({
       driver: ApolloDriver,
-      imports: [SettingModule],
-      inject: [SettingService],
-      useFactory: (settingService: SettingService) =>
-        settingService.graphqlUseFactory,
+      useClass: GraphqlConfigService,
+      imports: [ConfigModule],
     }),
     TypeOrmModule.forRootAsync({
+      useClass: TypeORMConfigService,
       imports: [ConfigModule],
-      inject: [ConfigService],
-      useFactory: (configService: ConfigService) =>
-        configService.get(typeormConfigKey),
     }),
     UserModule,
     AuthModule,

src/auth/auth.module.ts

@@ -4,7 +4,7 @@ import { JwtModule } from '@nestjs/jwt';
 import { PassportModule } from '@nestjs/passport';
 
 import { EnvironmentVariables } from 'src/common/helper/env.validation';
-import { UtilModule } from 'src/common/shared/services/util.module';
+import { UtilModule } from 'src/common/util/util.module';
 import { UserModule } from 'src/user/user.module';
 
 import { AuthResolver } from './auth.resolver';

src/auth/auth.service.ts

@@ -6,7 +6,7 @@ import * as bcrypt from 'bcrypt';
 
 import { SignInInput, SignUpInput } from 'src/auth/inputs/auth.input';
 import { EnvironmentVariables } from 'src/common/helper/env.validation';
-import { UtilService } from 'src/common/shared/services/util.service';
+import { UtilService } from 'src/common/util/util.service';
 import { User } from 'src/user/entities/user.entity';
 
 import { UserService } from '../user/user.service';

src/common/config/graphql-config.service.ts

@@ -0,0 +1,42 @@
+import { ApolloDriverConfig } from '@nestjs/apollo';
+import { Injectable } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { GqlOptionsFactory } from '@nestjs/graphql';
+
+import {
+  ApolloServerPluginLandingPageLocalDefault,
+  ApolloServerPluginLandingPageProductionDefault,
+} from '@apollo/server/plugin/landingPage/default';
+import GraphQLJSON from 'graphql-type-json';
+import { join } from 'path';
+import { cwd } from 'process';
+
+import { formatError } from '../format/graphql-error.format';
+
+@Injectable()
+export class GraphqlConfigService
+  implements GqlOptionsFactory<ApolloDriverConfig>
+{
+  constructor(private readonly configService: ConfigService) {}
+
+  createGqlOptions(): Promise<ApolloDriverConfig> | ApolloDriverConfig {
+    return {
+      resolvers: { JSON: GraphQLJSON },
+      autoSchemaFile: join(
+        cwd(),
+        `${this.configService.get('NODE_ENV') === 'test' ? 'test' : 'src'}/graphql-schema.gql`,
+      ),
+      sortSchema: true,
+      playground: false,
+      plugins: [
+        this.configService.get('NODE_ENV') === 'production'
+          ? ApolloServerPluginLandingPageProductionDefault()
+          : ApolloServerPluginLandingPageLocalDefault(),
+      ],
+
+      context: ({ req }) => ({ req }),
+      cache: 'bounded',
+      formatError,
+    };
+  }
+}

src/common/config/ormconfig.service.ts

@@ -0,0 +1,14 @@
+import { Injectable } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { TypeOrmModuleOptions, TypeOrmOptionsFactory } from '@nestjs/typeorm';
+
+import { setTypeormConfig } from './ormconfig';
+
+@Injectable()
+export class TypeORMConfigService implements TypeOrmOptionsFactory {
+  constructor(private readonly configService: ConfigService) {}
+
+  createTypeOrmOptions(): Promise<TypeOrmModuleOptions> | TypeOrmModuleOptions {
+    return setTypeormConfig(this.configService);
+  }
+}

src/common/config/ormconfig.ts

@@ -1,4 +1,4 @@
-import { registerAs } from '@nestjs/config';
+import { ConfigService } from '@nestjs/config';
 
 import { config } from 'dotenv';
 import { join } from 'path';
@@ -11,29 +11,33 @@ config({
   path: getEnvPath(cwd()),
 });
 
-const typeormConfig: DataSourceOptions = {
-  type: 'postgres',
-  host: env.DB_HOST,
-  port: Number(env.DB_PORT),
-  username: env.DB_USER,
-  password: env.DB_PASSWORD,
-  database: env.DB_NAME,
-  entities:
-    env.NODE_ENV === 'test'
-      ? [join(cwd(), 'src', '**', '*.entity.{ts,js}')]
-      : [join(cwd(), 'dist', '**', '*.entity.js')],
-  synchronize: env.NODE_ENV !== 'production',
-  dropSchema: env.NODE_ENV === 'test',
-  migrations: [
-    join(cwd(), 'dist', 'common', 'database', 'migrations', '*{.ts,.js}'),
-  ],
-  migrationsRun: false,
-  logging: false,
+export const setTypeormConfig = (
+  conf: NodeJS.ProcessEnv | ConfigService,
+): DataSourceOptions => {
+  const getConfigValue =
+    conf instanceof ConfigService
+      ? conf.get.bind(conf)
+      : (key: string) => conf[key];
+
+  return {
+    type: 'postgres',
+    host: getConfigValue('DB_HOST'),
+    port: Number(getConfigValue('DB_PORT')),
+    username: getConfigValue('DB_USER'),
+    password: getConfigValue('DB_PASSWORD'),
+    database: getConfigValue('DB_NAME'),
+    entities:
+      getConfigValue('NODE_ENV') === 'test'
+        ? [join(cwd(), 'src', '**', '*.entity.{ts,js}')]
+        : [join(cwd(), 'dist', '**', '*.entity.js')],
+    synchronize: getConfigValue('NODE_ENV') !== 'production',
+    dropSchema: getConfigValue('NODE_ENV') === 'test',
+    migrations: [
+      join(cwd(), 'dist', 'common', 'database', 'migrations', '*{.ts,.js}'),
+    ],
+    migrationsRun: false,
+    logging: false,
+  };
 };
 
-export const typeormConfigKey = 'typeorm';
-export const typeormConfigLoader = registerAs(
-  typeormConfigKey,
-  () => typeormConfig,
-);
-export default new DataSource(typeormConfig);
+export default new DataSource(setTypeormConfig(env));