Merge pull request #16 from floriaaan/notification

Notification

.github/workflows/notifications.yml

@@ -0,0 +1,69 @@
+name: Notification Microservice CI/CD
+
+on:
+  push:
+    branches: [ notification ]
+  pull_request:
+    branches: [ dev, main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - uses: pnpm/action-setup@v2
+        with:
+          version: latest
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "18.x"
+          cache: "pnpm"
+          cache-dependency-path: services/notification/pnpm-lock.yaml
+      - name: Install dependencies
+        run: |
+          cd ./services/notification
+          pnpm install --frozen-lockfile
+      - name: Build
+        run: |
+          cd ./services/notification
+          pnpm build
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - uses: pnpm/action-setup@v2
+        with:
+          version: latest
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "18.x"
+          cache: "pnpm"
+          cache-dependency-path: services/notification/pnpm-lock.yaml
+      - name: Install dependencies
+        run: |
+          cd ./services/notification
+          pnpm install --frozen-lockfile
+      - name: Execute tests
+        run: |
+          cd ./services/notification
+          pnpm test
+
+  publish:
+    runs-on: ubuntu-latest
+    needs: [ build, test ]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@master
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Build and push
+        uses: docker/build-push-action@v4
+        with:
+          context: ./services/
+          file: ./services/notification/Dockerfile
+          push: true
+          tags: pierrelbg/goodfood-notification:latest

README.md

@@ -15,21 +15,22 @@ a high volume of concurrent users, up to several thousand.
 
 ## Microservices ports
 
-| Service     | Port  | Language    | Database   | Status | Assignee        |
-| ----------- | ----- | ----------- | ---------- | ------ | --------------- |
-| Gateway     | 50000 | Go          | ❌         | ❌     | @Anatole-Godard |
-| User (auth) | 50001 | Go          | PostgreSQL | ⚠️     | @Anatole-Godard |
-| Basket      | 50002 | NodeJS (ts) | Redis      | ⚠️     | @Anatole-Godard |
-| Payment     | 50003 | NodeJS (ts) | PostgreSQL | ✅     | @floriaaan      |
-| Product     | 50004 | NodeJS (ts) | PostgreSQL | ❌     | @PierreLbg      |
-| Restaurant  | 50005 | NodeJS (ts) | PostgreSQL | ❌     | @floriaaan      |
-| Promotion   | 50006 | NodeJS (ts) | PostgreSQL | ❌     | @PierreLbg      |
-| Order       | 50007 | NodeJS (ts) | PostgreSQL | ✅     | @floriaaan      |
-| Delivery    | 50008 | NodeJS (ts) | PostgreSQL | ✅     | @floriaaan      |
-| Stock       | 50009 | NodeJS (ts) | PostgreSQL | ⚠️     | @floriaaan      |
-| Reporting   | 50020 | C# (dotnet) | PostgreSQL | ⚠️     | @floriaaan      |
-| Log         | 50021 | Go          | PostgreSQL | ✅     | @floriaaan      |
-| (...)       | (...) | (...)       | (...)      | (...)  |
+| Service      | Port  | Language    | Database   | Status | Assignee        |
+| ------------ | ----- | ----------- | ---------- | ------ | --------------- |
+| Gateway      | 50000 | Go          | ❌         | ❌     | @Anatole-Godard |
+| User (auth)  | 50001 | Go          | PostgreSQL | ⚠️     | @Anatole-Godard |
+| Basket       | 50002 | NodeJS (ts) | Redis      | ⚠️     | @Anatole-Godard |
+| Payment      | 50003 | NodeJS (ts) | PostgreSQL | ✅     | @floriaaan      |
+| Product      | 50004 | NodeJS (ts) | PostgreSQL | ❌     | @PierreLbg      |
+| Restaurant   | 50005 | NodeJS (ts) | PostgreSQL | ❌     | @floriaaan      |
+| Promotion    | 50006 | NodeJS (ts) | PostgreSQL | ❌     | @PierreLbg      |
+| Order        | 50007 | NodeJS (ts) | PostgreSQL | ✅     | @floriaaan      |
+| Delivery     | 50008 | NodeJS (ts) | PostgreSQL | ✅     | @floriaaan      |
+| Stock        | 50009 | NodeJS (ts) | PostgreSQL | ⚠️     | @floriaaan      |
+| Reporting    | 50020 | C# (dotnet) | PostgreSQL | ⚠️     | @floriaaan      |
+| Log          | 50021 | Go          | PostgreSQL | ✅     | @floriaaan      |
+| Notification | 50022 | NodeJS (ts) | PostgreSQL | ✅     | @PierreLbg      |
+| (...)        | (...) | (...)       | (...)      | (...)  |
 
 ## File Hierarchy
 

services/notification/.dockerignore

@@ -0,0 +1,2 @@
+node_modules
+build

services/notification/.env.example

@@ -0,0 +1,6 @@
+DATABASE_URL=postgresql://postgres:postgres@localhost:5432/notifications
+AMQP_URL=amqp://guest:guest@localhost
+PLUNK_PUBLIC_KEY="exemple"
+PLUNk_PROJECT_NAME=goodfood
+
+PORT=50022

services/notification/.gitignore

@@ -0,0 +1,4 @@
+node_modules
+# Keep environment variables out of version control
+.env
+dist/

services/notification/Dockerfile

@@ -0,0 +1,38 @@
+FROM node:18-alpine3.17  as builder
+
+# Set working directory
+WORKDIR /app
+
+# Copy the application code
+COPY ./notification/ .
+
+# Install dependencies
+RUN npm install
+
+# Copy the proto files  
+COPY ./proto ./proto/
+
+# Generate Prisma client
+RUN npx prisma generate
+
+# Build the application
+RUN npm run build
+
+
+# Create a new image with the application
+FROM node:18-alpine3.17 as runner
+
+# Set working directory
+WORKDIR /app
+
+# Copy the application package
+COPY --from=builder /app/dist .
+COPY --from=builder /app/prisma/ .
+COPY --from=builder /app/proto/ /proto/
+COPY --from=builder /app/node_modules/.prisma /.prisma
+
+# Expose the gRPC port
+EXPOSE 50022
+
+# Start the server
+CMD [ "node", "index.js"]

services/notification/README.md

@@ -0,0 +1,83 @@
+# Notification Microservice
+
+| Informations                                                       |
+|--------------------------------------------------------------------|
+| **Port:** 50022                                                    |
+| **Developer:** @PierreLgb                                          |
+| **Status:** In progress                                            |
+| **Last update:** 2023-07-20                                       |
+| **Language:** NodeJS                                               |
+| **Dependencies:** TypeScript, Prisma, gRPC, Postgres               |
+| **Models:** (see [`prisma/schema.prisma`](./prisma/schema.prisma)) |
+
+## gRPC Methods
+
+- Notifications model:
+
+    - `CreateNotification`: Creates a new notification in the system.
+    - `GetNotification`: Retrieves a notification by its ID.
+    - `UpdateNotification`: Updates an existing notification.
+    - `DeleteNotification`: Deletes a notification by its ID.
+    - `GetNotifications`: Retrieves notifications for a given message type.
+
+## Requirements
+
+To run this microservice, you will need to have the following installed on your system:
+
+- NodeJS (v18.12.0 or higher) (dev. with v18.12.0)
+- Postgres (v15.2 or higher) (dev. with docker image `postgres:15.2`)
+
+You can use the following tools to help you with the setup:
+
+- You can use nvm to set your Node version using:
+    - `nvm use`.
+- You can use docker to run your Postgres database using:
+    - `docker run --name postgres -p 5432:5432 -e POSTGRES_PASSWORD=password -d postgres`
+
+## Getting started
+
+### 1. Clone the repository and install dependencies
+
+1. Clone the `goodfood` repository to your local machine.
+2. Navigate to the service directory (`services/notification`) in your terminal.
+3. Run `npm install` to install the necessary dependencies.
+4. Create a `.env` file at the root of the project directory and add the environment variables values (
+   see `.env.example`).
+5. Run `npm run start` to start the microservice.
+
+You can now access the microservice at `http://localhost:50022`.
+
+NB: If you want to run the microservice in development mode, you can run `npm run dev` instead.
+
+### 2. Create and seed the database
+
+Run the following command to create your Postgres database structure. This also creates the models tables that are
+defined in [`prisma/schema.prisma`](./prisma/schema.prisma):
+
+```
+npx prisma migrate dev --name init
+```
+
+When `npx prisma migrate dev` is executed against a newly created database, seeding is also triggered. The seed file
+in [`prisma/seed.ts`](./prisma/seed.ts) will be executed and your database will be populated with the sample data.
+
+## Build and Run with Docker
+
+### Build
+
+To build the image you need to be in the **parent folder** of the service you want to build. Then run the following
+command:
+
+```
+docker build -t goodfood-notification:1.0.0 -f ./notification/Dockerfile .
+docker tag goodfood-notification:1.0.0 pierrelbg/goodfood-notification:1.0.0
+docker push pierrelbg/goodfood-notification:1.0.0
+```
+
+### Run
+
+Create the .env base on the .env.example. Then run the following command:
+
+```
+docker run --env-file=.env goodfood-notification:1.0.0 
+```

services/notification/package.json

@@ -0,0 +1,30 @@
+{
+	"name": "@goodfood/notification",
+	"bin": "dist/index.js",
+	"scripts": {
+		"start": "node dist/index.js",
+		"dev": "nodemon --watch 'src/**/*.ts' --exec 'ts-node' src/server.ts",
+		"build": "esbuild src/server.ts --bundle --platform=node --target=node18 --outfile=dist/index.js --minify",
+		"test": "echo 'tests are disabled'",
+		"prisma:generate": "prisma generate",
+		"postinstall": "npm run prisma:generate"
+	},
+	"devDependencies": {
+		"prisma": "^5.1.1",
+		"typescript": "^5.1.6"
+	},
+	"dependencies": {
+		"@grpc/grpc-js": "^1.9.0",
+		"@grpc/proto-loader": "^0.7.8",
+		"@plunk/node": "^2.0.0",
+		"@prisma/client": "5.1.0",
+		"@types/amqplib": "^0.10.1",
+		"amqplib": "^0.10.3",
+		"dotenv": "^16.3.1",
+		"esbuild": "^0.19.2",
+		"nodemon": "^3.0.1",
+		"path": "^0.12.7",
+		"ts-node": "^10.9.1",
+		"tsconfig-paths": "^4.2.0"
+	}
+}