Add logging service base (#68)

GTBitsOfGood · Mar 17, 2024 · 5b73d03 · 5b73d03
1 parent 75b5c3a
commit 5b73d03
Show file tree

Hide file tree

Showing 20 changed files with 425 additions and 1 deletion.
diff --git a/.github/workflows/e2e-tests.yml b/.github/workflows/e2e-tests.yml
@@ -41,3 +41,13 @@ jobs:
 
       - name: Test
         run: yarn test:e2e:db-service
+
+  logging-service:
+    name: Logging Service E2E Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Test
+        run: yarn test:e2e:logging-service
diff --git a/Dockerfile.dev b/Dockerfile.dev
@@ -80,6 +80,20 @@ COPY --from=deps /app/packages/proto/ ./packages/proto/
 
 WORKDIR /app/packages/email-service
 
+FROM base-service as logging-service-dev
+
+WORKDIR /app
+
+COPY --from=deps /app/node_modules ./node_modules/
+
+COPY --from=deps /app/packages/logging-service/node_modules ./packages/node_modules/
+
+COPY . .
+
+COPY --from=deps /app/packages/proto/ ./packages/proto/
+
+WORKDIR /app/packages/logging-service
+
 FROM base-service as db-service-dev
 
 WORKDIR /app

diff --git a/docker-compose-dev.yml b/docker-compose-dev.yml
@@ -11,6 +11,7 @@ services:
       DB_SERVICE_ADDR: db-service:5000
       AUTH_SERVICE_ADDR: auth-service:5000
       EMAIL_SERVICE_ADDR: email-service:5000
+      LOGGING_SERVICE_ADDR: logging-service:5000
     networks:
       - bog-api-net
     depends_on:
@@ -29,6 +30,7 @@ services:
       AUTH_SERVICE_ADDR: auth-service:5000
       DB_SERVICE_ADDR: db-service:5000
       EMAIL_SERVICE_ADDR: email-service:5000
+      LOGGING_SERVICE_ADDR: logging-service:5000
     networks:
       - bog-api-net
     depends_on:
@@ -52,6 +54,7 @@ services:
       AUTH_SERVICE_ADDR: auth-service:5000
       DB_SERVICE_ADDR: db-service:5000
       EMAIL_SERVICE_ADDR: email-service:5000
+      LOGGING_SERVICE_ADDR: logging-service:5000
     networks:
       - bog-api-net
     depends_on:
@@ -63,6 +66,28 @@ services:
       timeout: 10s
       retries: 10
 
+  logging-service:
+    build:
+      dockerfile: Dockerfile.dev
+      target: logging-service-dev
+      context: .
+    ports:
+      - 5000
+    entrypoint: yarn ${LOGGING_COMMAND-start:dev}
+    environment:
+      AUTH_SERVICE_ADDR: auth-service:5000
+      DB_SERVICE_ADDR: db-service:5000
+      EMAIL_SERVICE_ADDR: email-service:5000
+      LOGGING_SERVICE_ADDR: logging-service:5000
+      DATABASE_URL: postgresql://user:password@db
+    networks:
+      - bog-api-net
+    healthcheck:
+      test: ['CMD-SHELL', 'grpc_health_probe -addr=db-service:5000']
+      interval: 2s
+      timeout: 10s
+      retries: 10
+
   db-service:
     build:
       dockerfile: Dockerfile.dev

diff --git a/docker/docker-compose-live-packages.yml b/docker/docker-compose-live-packages.yml
@@ -47,6 +47,22 @@ services:
         - action: rebuild
           path: ./Dockerfile.dev
 
+  logging-service:
+    extends:
+      file: docker-compose-dev.yml
+      service: logging-service
+    volumes:
+      - ./packages/logging-service:/app/packages/logging-service
+      - /app/packages/logging-service/node_modules
+    develop:
+      watch:
+        - action: rebuild
+          path: ./package.json
+        - action: rebuild
+          path: ./packages/logging-service/package.json
+        - action: rebuild
+          path: ./Dockerfile.dev
+
   db-service:
     extends:
       file: docker-compose-dev.yml

diff --git a/docker/docker-compose-live-proto.yml b/docker/docker-compose-live-proto.yml
@@ -32,6 +32,17 @@ services:
         - action: rebuild
           path: ./packages/proto/package.json
 
+  logging-service:
+    extends:
+      file: docker-compose-dev.yml
+      service: logging-service
+    volumes:
+      - ./packages/proto/dist:/app/packages/node_modules/juno-proto/dist
+    develop:
+      watch:
+        - action: rebuild
+          path: ./packages/proto/package.json
+
   db-service:
     extends:
       file: docker-compose-dev.yml

diff --git a/package.json b/package.json
@@ -26,10 +26,12 @@
     "test:e2e:auth-service-live": "AUTH_COMMAND=test:e2e:watch RUN_MODE=test yarn start:dev:live-all --exit-code-from auth-service auth-service",
     "test:e2e:email-service-live": "EMAIL_COMMAND=test:e2e:watch RUN_MODE=test yarn start:dev:live-all --exit-code-from email-service email-service",
     "test:e2e:db-service-live": "DB_COMMAND=test:e2e:watch RUN_MODE=test yarn start:dev:live-all --exit-code-from db-service db-service",
+    "test:e2e:logging-service-live": "LOGGING_COMMAND=test:e2e:watch RUN_MODE=test yarn start:dev:live-all --exit-code-from logging-service logging-service",
     "test:e2e:api-gateway": "GATEWAY_COMMAND=test:e2e RUN_MODE=test yarn start:dev --exit-code-from api-gateway",
     "test:e2e:auth-service": "AUTH_COMMAND=test:e2e RUN_MODE=test yarn start:dev --exit-code-from auth-service auth-service",
     "test:e2e:email-service": "EMAIL_COMMAND=test:e2e RUN_MODE=test yarn start:dev --exit-code-from email-service email-service",
-    "test:e2e:db-service": "DB_COMMAND=test:e2e RUN_MODE=test yarn start:dev --exit-code-from db-service db-service"
+    "test:e2e:db-service": "DB_COMMAND=test:e2e RUN_MODE=test yarn start:dev --exit-code-from db-service db-service",
+    "test:e2e:logging-service": "LOGGING_COMMAND=test:e2e RUN_MODE=test yarn start:dev --exit-code-from logging-service logging-service"
   },
   "devDependencies": {
     "concurrently": "^8.2.2",

diff --git a/packages/logging-service/.eslintrc.js b/packages/logging-service/.eslintrc.js
@@ -0,0 +1,25 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir: __dirname,
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};
diff --git a/packages/logging-service/.gitignore b/packages/logging-service/.gitignore
@@ -0,0 +1,35 @@
+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
diff --git a/packages/logging-service/README.md b/packages/logging-service/README.md
@@ -0,0 +1,73 @@
+<p align="center">
+  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a>
+</p>
+
+[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
+[circleci-url]: https://circleci.com/gh/nestjs/nest
+
+  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
+    <p align="center">
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
+<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
+<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
+<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
+<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
+<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
+  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
+    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
+  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
+</p>
+  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
+  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
+
+## Description
+
+[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
+
+## Installation
+
+```bash
+$ yarn install
+```
+
+## Running the app
+
+```bash
+# development
+$ yarn run start
+
+# watch mode
+$ yarn run start:dev
+
+# production mode
+$ yarn run start:prod
+```
+
+## Test
+
+```bash
+# unit tests
+$ yarn run test
+
+# e2e tests
+$ yarn run test:e2e
+
+# test coverage
+$ yarn run test:cov
+```
+
+## Support
+
+Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
+
+## Stay in touch
+
+- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
+- Website - [https://nestjs.com](https://nestjs.com/)
+- Twitter - [@nestframework](https://twitter.com/nestframework)
+
+## License
+
+Nest is [MIT licensed](LICENSE).
diff --git a/packages/logging-service/nest-cli.json b/packages/logging-service/nest-cli.json
@@ -0,0 +1,10 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true,
+    "assets": ["../proto/logging-service/*.proto"],
+    "watchAssets": true
+  }
+}
diff --git a/packages/logging-service/package.json b/packages/logging-service/package.json
@@ -0,0 +1,78 @@
+{
+  "name": "logging-service",
+  "version": "0.0.1",
+  "description": "",
+  "author": "",
+  "private": true,
+  "license": "UNLICENSED",
+  "scripts": {
+    "build": "nest build",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "start": "nest start",
+    "start:dev": "yarn start --watch",
+    "start:debug": "yarn start --debug --watch",
+    "start:prod": "node dist/main",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json --runInBand",
+    "test:e2e:watch": "jest --config ./test/jest-e2e.json --runInBand --watchAll",
+    "tsc": "tsc"
+  },
+  "dependencies": {
+    "@grpc/grpc-js": "^1.9.7",
+    "@grpc/proto-loader": "^0.7.10",
+    "@nestjs/common": "^10.0.0",
+    "@nestjs/config": "^3.1.1",
+    "@nestjs/core": "^10.0.0",
+    "@nestjs/microservices": "^10.2.7",
+    "@nestjs/platform-express": "^10.0.0",
+    "juno-proto": "file:../proto",
+    "reflect-metadata": "^0.1.13",
+    "rxjs": "^7.8.1"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "^10.0.0",
+    "@nestjs/schematics": "^10.0.0",
+    "@nestjs/testing": "^10.0.0",
+    "@types/bcrypt": "^5.0.2",
+    "@types/express": "^4.17.17",
+    "@types/jest": "^29.5.2",
+    "@types/jsonwebtoken": "^9.0.5",
+    "@types/node": "^20.3.1",
+    "@types/supertest": "^2.0.12",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.42.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "jest": "^29.5.0",
+    "prettier": "^3.0.0",
+    "source-map-support": "^0.5.21",
+    "supertest": "^6.3.3",
+    "ts-jest": "^29.1.0",
+    "ts-loader": "^9.4.3",
+    "ts-node": "^10.9.1",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.1.3"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}
diff --git a/packages/logging-service/src/app.controller.spec.ts b/packages/logging-service/src/app.controller.spec.ts
@@ -0,0 +1,3 @@
+describe('AppController', () => {
+  beforeEach(async () => {});
+});
diff --git a/packages/logging-service/src/app.controller.ts b/packages/logging-service/src/app.controller.ts
@@ -0,0 +1,7 @@
+import { Controller } from '@nestjs/common';
+import { AppService } from './app.service';
+
+@Controller()
+export class AppController {
+  constructor(private readonly appService: AppService) {}
+}
diff --git a/packages/logging-service/src/app.module.ts b/packages/logging-service/src/app.module.ts
@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+
+@Module({
+  imports: [],
+  controllers: [AppController],
+  providers: [AppService],
+})
+export class AppModule {}
diff --git a/packages/logging-service/src/app.service.ts b/packages/logging-service/src/app.service.ts
@@ -0,0 +1,4 @@
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class AppService {}