Create an internal lib for configuration (#443)

* feat: use external config as library * deps: update nx deps * revert * fix: volume * fix: some syntax * fix: remove args from docker compose --------- Co-authored-by: orig <[email protected]> Co-authored-by: orig <[email protected]>
origranot · Sep 15, 2023 · 136eeb6 · 136eeb6
1 parent 6951e82
commit 136eeb6
Show file tree

Hide file tree

Showing 47 changed files with 8,760 additions and 9,303 deletions.
diff --git a/.example.env b/.example.env
@@ -0,0 +1,35 @@
+# General
+BACKEND_APP_PORT=3000
+FRONTEND_APP_PORT=5000
+NODE_ENV=development
+
+# RATE LIMIT
+RATE_LIMIT_TTL=60
+RATE_LIMIT_COUNT=10
+
+# LOGGER
+LOGGER_CONSOLE_THRESHOLD=INFO # DEBUG, INFO, WARN, ERROR, FATAL
+
+# FRONTEND
+DOMAIN=localhost
+CLIENTSIDE_API_DOMAIN=http://localhost:3000 # Use this verible, while making client side API calls
+API_DOMAIN=http://localhost:3000 # If you are running with docker compose change this to http://backend:3000
+
+# DATABASE
+# If you are running with docker compose change host to postgres
+DATABASE_URL="postgresql://postgres:postgres@localhost:5432/reduced_to_db?schema=public"
+
+# REDIS
+REDIS_ENABLE=false
+REDIS_HOST=localhost
+REDIS_PORT=6379
+REDIS_PASSWORD=password
+REDIS_TTL=604800000 # 1 week in milliseconds
+
+# AUTH
+JWT_ACCESS_SECRET=abc1234
+JWT_REFRESH_SECRET=abc1234
+
+# NOVU - You don't need this when running locally (just verify your email from the database)
+NOVU_API_KEY=Get it from https://novu.co/
+
diff --git a/apps/backend/.dockerignore b/apps/backend/.dockerignore
@@ -1,5 +1,8 @@
-Dockerfile
-.dockerignore
 node_modules
+dist
 npm-debug.log
-dist
+CONTRIBUTE.MD
+README.md
+.gitignore
+LICENSE
+.DS_Store
diff --git a/apps/backend/.env.example b/apps/backend/.env.example
diff --git a/apps/backend/Dockerfile b/apps/backend/Dockerfile
@@ -2,9 +2,9 @@
 # Dependencies Stage
 # --------------------------------------------
 FROM node:19.2-alpine3.15 as dependencies
-
 WORKDIR /app
-COPY package.json package-lock.json ./
+
+COPY package*.json ./
 
 RUN apk add --update python3 make g++\
    && rm -rf /var/cache/apk/*
@@ -24,20 +24,24 @@ COPY --from=dependencies /app/node_modules ./node_modules
 # Run prisma generate & build the bundle in production mode
 RUN npx nx build backend --prod --skip-nx-cache
 
-
 # --------------------------------------------
 # Production Stage
 # --------------------------------------------
 FROM node:19.2-alpine3.15 as production
 WORKDIR /app
 
 COPY --from=build /app/dist/apps/backend ./backend
-COPY --from=build /app/dist/libs/prisma ./prisma
 COPY --from=build /app/node_modules ./node_modules
-COPY ./libs/ ./libs/
-COPY ./nx.json ./nx.json
+COPY --from=build /app/libs/ ./libs
 
 EXPOSE 3000
 
 # Start the application
 CMD sh -c "npx nx migrate-deploy prisma && node backend/main.js"
+
+
+
+
+
+
+
diff --git a/apps/backend/src/app.module.ts b/apps/backend/src/app.module.ts
@@ -3,8 +3,7 @@ import { APP_GUARD } from '@nestjs/core';
 import { ThrottlerModule } from '@nestjs/throttler';
 import { AuthModule } from './auth/auth.module';
 import { AppCacheModule } from './cache/cache.module';
-import { AppConfigModule } from './config/config.module';
-import { AppConfigService } from './config/config.service';
+import { AppConfigModule, AppConfigService } from '@reduced.to/config';
 import { AppLoggerModule } from './logger/logger.module';
 import { NovuModule } from './novu/novu.module';
 import { PrismaService } from '@reduced.to/prisma';

diff --git a/apps/backend/src/auth/auth.controller.spec.ts b/apps/backend/src/auth/auth.controller.spec.ts
@@ -5,7 +5,7 @@ import { AuthController } from './auth.controller';
 import { AuthService } from './auth.service';
 import { NovuService } from '../novu/novu.service';
 import { PrismaService } from '@reduced.to/prisma';
-import { AppConfigService } from '../config/config.service';
+import { AppConfigService, Configuration } from '@reduced.to/config';
 import { SignupDto } from './dto/signup.dto';
 import { UserContext } from './interfaces/user-context';
 import { LocalAuthGuard } from './guards/local.guard';
@@ -36,9 +36,9 @@ describe('AuthController', () => {
   };
 
   const MOCK_TOKENS = { accessToken: 'access_token', refreshToken: 'refresh_token' };
-  const MOCK_CONFIG = {
-    front: { domain: 'example.com' },
-    app: { env: 'production' },
+  const MOCK_CONFIG: Partial<Configuration> = {
+    front: { domain: 'example.com', apiDomain: 'http://localhost:3000', clientSideApiDomain: 'http://localhost:3000' },
+    general: { env: 'production', backendPort: 3000, frontendPort: 5000 },
     jwt: {
       accessSecret: 'secret',
       refreshSecret: 'secret',

diff --git a/apps/backend/src/auth/auth.controller.ts b/apps/backend/src/auth/auth.controller.ts
@@ -1,6 +1,6 @@
 import { Body, Controller, Get, Post, Req, Res, UnauthorizedException, UseGuards } from '@nestjs/common';
 import { Request, Response } from 'express';
-import { AppConfigService } from '../config/config.service';
+import { AppConfigService } from '@reduced.to/config';
 import { NovuService } from '../novu/novu.service';
 import { PrismaService } from '@reduced.to/prisma';
 import { AuthService } from './auth.service';
@@ -44,7 +44,7 @@ export class AuthController {
     const user = await this.authService.signup(signupDto);
 
     // Send verification email to user if in production
-    if (this.appConfigService.getConfig().app.env === 'production') {
+    if (this.appConfigService.getConfig().general.env === 'production') {
       await this.novuService.sendVerificationEmail(user);
     }
 

diff --git a/apps/backend/src/auth/auth.module.ts b/apps/backend/src/auth/auth.module.ts
@@ -1,7 +1,7 @@
 import { Module } from '@nestjs/common';
 import { JwtModule } from '@nestjs/jwt';
 import { PassportModule } from '@nestjs/passport';
-import { AppConfigService } from '../config/config.service';
+import { AppConfigService } from '@reduced.to/config';
 import { NovuModule } from '../novu/novu.module';
 import { NovuService } from '../novu/novu.service';
 import { PrismaModule } from '@reduced.to/prisma';

diff --git a/apps/backend/src/auth/auth.service.spec.ts b/apps/backend/src/auth/auth.service.spec.ts
@@ -3,7 +3,7 @@ import { JwtService } from '@nestjs/jwt';
 import { Test, TestingModule } from '@nestjs/testing';
 import { Role, User } from '@reduced.to/prisma';
 import * as bcrypt from 'bcryptjs';
-import { AppConfigModule } from '../config/config.module';
+import { AppConfigModule } from '@reduced.to/config';
 import { PrismaService } from '@reduced.to/prisma';
 import { AuthService } from './auth.service';
 

diff --git a/apps/backend/src/auth/auth.service.ts b/apps/backend/src/auth/auth.service.ts
@@ -2,7 +2,7 @@ import { Injectable, UnauthorizedException } from '@nestjs/common';
 import { JwtService } from '@nestjs/jwt';
 import { Role } from '@reduced.to/prisma';
 import * as bcrypt from 'bcryptjs';
-import { AppConfigService } from '../config/config.service';
+import { AppConfigService } from '@reduced.to/config';
 import { PrismaService } from '@reduced.to/prisma';
 import { SignupDto } from './dto/signup.dto';
 import { UserContext } from './interfaces/user-context';

diff --git a/apps/backend/src/auth/strategies/jwt-refresh.strategy.ts b/apps/backend/src/auth/strategies/jwt-refresh.strategy.ts
@@ -2,7 +2,7 @@ import { Injectable, UnauthorizedException } from '@nestjs/common';
 import { PassportStrategy } from '@nestjs/passport';
 import { Request } from 'express';
 import { ExtractJwt, Strategy } from 'passport-jwt';
-import { AppConfigService } from '../../config/config.service';
+import { AppConfigService } from '@reduced.to/config';
 import { AuthService } from '../auth.service';
 
 @Injectable()

diff --git a/apps/backend/src/auth/strategies/jwt.strategy.ts b/apps/backend/src/auth/strategies/jwt.strategy.ts
@@ -1,7 +1,7 @@
 import { Injectable, UnauthorizedException } from '@nestjs/common';
 import { PassportStrategy } from '@nestjs/passport';
 import { ExtractJwt, Strategy } from 'passport-jwt';
-import { AppConfigService } from '../../config/config.service';
+import { AppConfigService } from '@reduced.to/config';
 
 @Injectable()
 export class JwtStrategy extends PassportStrategy(Strategy) {

diff --git a/apps/backend/src/auth/strategies/verify.strategy.ts b/apps/backend/src/auth/strategies/verify.strategy.ts
@@ -1,7 +1,7 @@
 import { Injectable, UnauthorizedException } from '@nestjs/common';
 import { PassportStrategy } from '@nestjs/passport';
 import { ExtractJwt, Strategy } from 'passport-jwt';
-import { AppConfigService } from '../../config/config.service';
+import { AppConfigService } from '@reduced.to/config';
 
 @Injectable()
 export class VerifyStrategy extends PassportStrategy(Strategy, 'verify') {

diff --git a/apps/backend/src/auth/utils/cookies.ts b/apps/backend/src/auth/utils/cookies.ts
@@ -15,13 +15,7 @@ export const setAuthCookies = (
     refreshToken: string;
   }
 ) => {
-  // get the host from the domain (remove port if present)
-  // for example: localhost:5155 -> localhost
-  // for example: reduced.to -> reduced.to
-  const strippedDomain = rawDomain
-    .replace(/http(s)?(:)?(\/\/)?|(\/\/)?(www\.)?/g, '') // strip prefix
-    .replace(/:\d+$/g, ''); // strip port
-  const domain = process.env.NODE_ENV === 'production' ? `.${strippedDomain}` : strippedDomain;
+  const domain = process.env.NODE_ENV === 'production' ? `.${rawDomain}` : rawDomain;
 
   res
     .cookie(AUTH_COOKIE_NAME, tokens.accessToken, {

diff --git a/apps/backend/src/cache/cache.module.ts b/apps/backend/src/cache/cache.module.ts
@@ -1,8 +1,7 @@
 import { CacheModule, CacheStore } from '@nestjs/cache-manager';
 import { Global, Module } from '@nestjs/common';
 import { RedisStore, redisStore } from 'cache-manager-redis-store';
-import { AppConfigModule } from '../config/config.module';
-import { AppConfigService } from '../config/config.service';
+import { AppConfigService, AppConfigModule } from '@reduced.to/config';
 import { AppCacheService } from './cache.service';
 
 @Global()

diff --git a/apps/backend/src/logger/logger.service.spec.ts b/apps/backend/src/logger/logger.service.spec.ts
@@ -1,5 +1,5 @@
 import { Test, TestingModule } from '@nestjs/testing';
-import { AppConfigModule } from '../config/config.module';
+import { AppConfigModule } from '@reduced.to/config';
 import { AppLoggerSerivce } from './logger.service';
 
 describe('LoggerService', () => {

diff --git a/apps/backend/src/logger/logger.service.ts b/apps/backend/src/logger/logger.service.ts
@@ -1,6 +1,6 @@
 import { Injectable, LoggerService, LogLevel } from '@nestjs/common';
 import { ConsoleTransport, Logger } from '@origranot/ts-logger';
-import { AppConfigService } from '../config/config.service';
+import { AppConfigService } from '@reduced.to/config';
 
 @Injectable()
 export class AppLoggerSerivce implements LoggerService {

diff --git a/apps/backend/src/main.ts b/apps/backend/src/main.ts
@@ -4,7 +4,7 @@ import { NestExpressApplication } from '@nestjs/platform-express';
 import { useContainer } from 'class-validator';
 import cookieParser from 'cookie-parser';
 import { AppModule } from './app.module';
-import { AppConfigService } from './config/config.service';
+import { AppConfigService } from '@reduced.to/config';
 
 async function bootstrap() {
   const app = await NestFactory.create<NestExpressApplication>(AppModule);
@@ -22,7 +22,7 @@ async function bootstrap() {
   // Enable DI in class-validator
   useContainer(app.select(AppModule), { fallbackOnErrors: true });
 
-  const port = app.get(AppConfigService).getConfig().app.port;
+  const port = app.get(AppConfigService).getConfig().general.backendPort;
 
   await app.listen(port);
 }

diff --git a/apps/backend/src/novu/novu.module.ts b/apps/backend/src/novu/novu.module.ts
@@ -1,5 +1,5 @@
 import { Module } from '@nestjs/common';
-import { AppConfigService } from '../config/config.service';
+import { AppConfigService } from '@reduced.to/config';
 import { Novu } from '@novu/node';
 
 export const NOVU_INJECTION_TOKEN = 'NOVU';

diff --git a/apps/backend/src/novu/novu.service.ts b/apps/backend/src/novu/novu.service.ts
@@ -1,14 +1,22 @@
 import { Inject, Injectable } from '@nestjs/common';
 import { Novu } from '@novu/node';
 import { UserContext } from '../auth/interfaces/user-context';
-import { AppConfigService } from '../config/config.service';
+import { AppConfigService } from '@reduced.to/config';
 import { NOVU_INJECTION_TOKEN } from './novu.module';
+import { Configuration } from '@reduced.to/config';
 
 @Injectable()
 export class NovuService {
-  constructor(@Inject(NOVU_INJECTION_TOKEN) private readonly novu: Novu, private readonly appConfigService: AppConfigService) {}
+  private config: Configuration;
+  constructor(@Inject(NOVU_INJECTION_TOKEN) private readonly novu: Novu, private readonly appConfigService: AppConfigService) {
+    this.config = this.appConfigService.getConfig();
+  }
 
   async sendVerificationEmail(user: UserContext) {
+    const domain =
+      process.env.NODE_ENV === 'production'
+        ? `https://${this.config.front.domain}`
+        : `http://${this.config.front.domain}:${this.config.general.frontendPort}`;
     const verificationUrl = `${this.appConfigService.getConfig().front.domain}/register/verify/${user.verificationToken}`;
 
     await this.novu.trigger('new-user', {

diff --git a/apps/backend/src/shortener/shortener.controller.spec.ts b/apps/backend/src/shortener/shortener.controller.spec.ts
@@ -1,4 +1,4 @@
-import { AppConfigModule } from '../config/config.module';
+import { AppConfigModule } from '@reduced.to/config';
 import { AppCacheModule } from '../cache/cache.module';
 import { ShortenerService } from './shortener.service';
 import { ShortenerController } from './shortener.controller';

diff --git a/apps/backend/src/shortener/shortener.service.spec.ts b/apps/backend/src/shortener/shortener.service.spec.ts
@@ -1,9 +1,9 @@
-import { AppConfigService } from '../config/config.service';
+import { AppConfigService } from '@reduced.to/config';
 import { ShortenerService } from './shortener.service';
 import { Test, TestingModule } from '@nestjs/testing';
 import { AppCacheModule } from '../cache/cache.module';
 import { AppCacheService } from '../cache/cache.service';
-import { AppConfigModule } from '../config/config.module';
+import { AppConfigModule } from '@reduced.to/config';
 import { PrismaService } from '@reduced.to/prisma';
 import { ShortenerDto } from './dto';
 import { BadRequestException } from '@nestjs/common';

diff --git a/apps/backend/src/shortener/shortener.service.ts b/apps/backend/src/shortener/shortener.service.ts
@@ -1,6 +1,6 @@
 import { AppCacheService } from '../cache/cache.service';
 import { BadRequestException, Injectable } from '@nestjs/common';
-import { AppConfigService } from '../config/config.service';
+import { AppConfigService } from '@reduced.to/config';
 import { PrismaService } from '@reduced.to/prisma';
 import { ShortenerDto } from './dto';
 import { UserContext } from '../auth/interfaces/user-context';

diff --git a/apps/backend/src/users/users.controller.spec.ts b/apps/backend/src/users/users.controller.spec.ts
@@ -5,7 +5,7 @@ import { UsersController } from './users.controller';
 import { IFindAllOptions, UsersService } from './users.service';
 import { User } from '@reduced.to/prisma';
 import { JwtAuthGuard } from '../auth/guards/jwt.guard';
-import { AppConfigModule } from '../config/config.module';
+import { AppConfigModule } from '@reduced.to/config';
 import { RolesGuard } from '../auth/guards/roles.guard';
 import { IPaginationResult } from '../shared/utils';
 import { SortOrder } from '../shared/enums/sort-order.enum';

diff --git a/apps/frontend/.example.env b/apps/frontend/.example.env
diff --git a/apps/frontend/Dockerfile b/apps/frontend/Dockerfile
@@ -2,16 +2,15 @@
 # Dependencies Stage
 # --------------------------------------------
 FROM node:19.2-alpine3.15 as dependencies
-
 WORKDIR /app
-COPY package.json package-lock.json ./
+
+COPY package*.json ./
 
 RUN apk add --update python3 make g++\
    && rm -rf /var/cache/apk/*
 
 RUN npm ci
 
-
 # --------------------------------------------
 # Build Stage
 # --------------------------------------------
@@ -31,7 +30,6 @@ COPY --from=dependencies /app/node_modules ./node_modules
 # Run prisma generate & build the bundle in production mode
 RUN npx nx build frontend --prod --skip-nx-cache
 
-
 # --------------------------------------------
 # Production Stage
 # --------------------------------------------