Release 0.0.2

.github/workflows/main.yml

@@ -0,0 +1,22 @@
+name: Run all checks before merge
+
+on:
+  pull_request:
+    branches:
+      - main
+      - develop
+
+jobs:
+  eslint:
+    uses: ./.github/workflows/node-env-command.yml
+    with:
+      node-version: '20'
+      commandDescription: 'Run ESLint'
+      command: 'npx eslint .'
+
+  unittests:
+    uses: ./.github/workflows/node-env-command.yml
+    with:
+      node-version: '20'
+      commandDescription: 'Run Jest tests'
+      command: 'npm test'

.github/workflows/node-env-command.yml

@@ -0,0 +1,38 @@
+name: Setup Node.js Environment and Run Command
+
+on:
+  workflow_call:
+    inputs:
+      node-version:
+        description: 'Node.js version'
+        type: string
+        default: '20'
+
+      commandDescription:
+        description: 'Description of the command to execute'
+        required: true
+        type: string
+
+      command:
+        description: 'Command to execute'
+        required: true
+        type: string
+
+jobs:
+  setup:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ inputs.node-version }}
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: ${{ inputs.commandDescription }}
+        run: ${{ inputs.command }}

.gitignore

@@ -1,6 +1,8 @@
 node_modules
 .env
+.env.local
 .DS_Store
 /.vs
 .vscode/
 /serviceAccountKey.json
+coverage/

Dockerfile

@@ -6,5 +6,5 @@ COPY package.json package-lock.json ./
 RUN npm install
 COPY . .
 
-EXPOSE 3000
+EXPOSE 8080
 CMD ["node", "server.js"]

Makefile

@@ -0,0 +1,91 @@
+include .env.local
+export
+
+# To make sure these targets are not confused with files of the same name
+.PHONY: help lint test clean deploy-dev deploy-prod stop-dev stop-prod \
+        connect-dev connect-prod create-migration apply-migrations rollback-migration
+
+WARN_COLOR := $(shell tput setaf 208)
+GREEN_COLOR := $(shell tput setaf 2)
+RESET_COLOR := $(shell tput sgr0)
+
+# Development
+lint:
+	npx eslint .
+
+test:
+	npm test
+
+# EC2 instances connection
+connect-dev:
+	@if [ -z "$(DEV_PRIVATE_KEY_LOCATION)" ] || [ -z "$(DEV_HOST)" ]; then \
+		echo "Error: DEV_PRIVATE_KEY_LOCATION and DEV_HOST environment variables must be set."; \
+		exit 1; \
+	fi
+	ssh -i $(DEV_PRIVATE_KEY_LOCATION) ec2-user@$(DEV_HOST)
+
+connect-prod:
+	@if [ -z "$(PROD_PRIVATE_KEY_LOCATION)" ] || [ -z "$(PROD_HOST)" ]; then \
+		echo "Error: PROD_PRIVATE_KEY_LOCATION and PROD_HOST environment variables must be set."; \
+		exit 1; \
+	fi
+	ssh -i $(PROD_PRIVATE_KEY_LOCATION) ec2-user@$(PROD_HOST)
+
+# Database migrations with knex
+create-migration:
+	knex migrate:make $(name)
+
+apply-migrations:
+	knex migrate:latest
+
+rollback-migration:
+	knex migrate:rollback
+
+
+# EC2 deployment
+stop-dev:
+	docker-compose -f docker-compose.dev.yml down
+
+stop-prod:
+	docker-compose -f docker-compose.prod.yml down	
+
+deploy-env:
+	@read -p "$(WARN_COLOR)You're about to deploy to the $(env) environment. Please make sure you pulled recent changes, \
+	installed new dependencies and verified the service starts using npm run as well as applied database migrations. \
+	Please refer to the /docs/how-tos/aws_ec2_deployment.md for the instructions. \
+	If you're sure, press Enter to continue.$(RESET_COLOR)" confirm; \
+
+	docker-compose -f docker-compose.$(env).yml build --no-cache
+	docker-compose -f docker-compose.$(env).yml up -d --force-recreate 
+
+deploy-dev:
+	@$(MAKE) deploy-env env=dev
+
+deploy-prod:
+	@$(MAKE) deploy-env env=prod
+
+help:
+	@echo ""
+	@echo "🛠  $(GREEN_COLOR)Makefile Help$(RESET_COLOR)"
+	@echo ""
+	@echo "🔧 Development:"
+	@echo "  $(GREEN_COLOR)lint$(RESET_COLOR)              Run eslint to check code quality"
+	@echo "  $(GREEN_COLOR)test$(RESET_COLOR)              Run unit tests with npm"
+
+	@echo ""
+	@echo "🌐 EC2 Instances:"
+	@echo "  $(GREEN_COLOR)connect-dev$(RESET_COLOR)       SSH into the dev EC2 instance"
+	@echo "  $(GREEN_COLOR)connect-prod$(RESET_COLOR)      SSH into the prod EC2 instance"
+
+	@echo ""
+	@echo "🛢  Database Migrations (Knex):"
+	@echo "  $(GREEN_COLOR)create-migration$(RESET_COLOR)  Create a new migration (usage: make create-migration name=xyz)"
+	@echo "  $(GREEN_COLOR)apply-migrations$(RESET_COLOR)  Apply the latest migrations"
+	@echo "  $(GREEN_COLOR)rollback-migration$(RESET_COLOR)Rollback the last migration"
+
+	@echo ""
+	@echo "🚀 Deployment:"
+	@echo "  $(GREEN_COLOR)deploy-dev$(RESET_COLOR)        Deploy the dev environment"
+	@echo "  $(GREEN_COLOR)deploy-prod$(RESET_COLOR)       Deploy the prod environment"
+	@echo "  $(GREEN_COLOR)stop-dev$(RESET_COLOR)          Stop the dev Docker Compose"
+	@echo "  $(GREEN_COLOR)stop-prod$(RESET_COLOR)         Stop the prod Docker Compose"

README.md

@@ -12,15 +12,48 @@ Located in the `/docs/how-tos` directory. All important information on local run
 
 ### How to run project locally
 
+> ⚠️ For simple local run (no breaking changes) you can connect to the remote (DEV) database. 
+
+To do that, you have to authenticate with AWS CLI first (ref. `/docs/how-tos/local_run_and_configs.md`)
+
+🚨 For proper development it is **strongly recommended** to use local database. Here's how to do that:
+
 1. Follow `/docs/how-tos/setup_local_postgresql`, step "Setting up Local PostgreSQL instance"
-2. Update your .env accordingly. Here is sample .env structure:
+2. Use `.env.local` file for environment variables (default `.env` is picked up by Docker so to avoid confusion we use explicit local file for local development). Update your `.env.local` accordingly. Here is sample structure or reach out for up-to-date .env to fellow devs:
+```
    DB_USER=marina_kim
    DB_HOST=localhost
    DB_NAME=mydatabase
    DB_PASS=password
    DB_PORT=5432
-   ENVIRONMENT=local
+   ENVIRONMENT=local # the IMPORTANT part!!! this tells the service to use local resources.
+```
+
+✅ Once you are authenticated with AWS CLI or you have the local PostgreSQL setup, you can successfully run 
+
+```bash
+npm start
+``` 
+or
+```bash
+nodemon server.js
+```
+
+to start the server.
+
+### Useful commands: Makefile
+
+Refer to the `Makefile` to see commands frequently used in development.
+Example usage:
 
-Note: ENVIRONMENT should be set to local for running the project locally, otherwise you have to authenticate with AWS CLI first (ref. `/docs/how-tos/aws_local_db_connection.md`)
+```bash
+make connect-dev
+```
+This will execute the `connect-dev` command and connect you to the dev EC2 instance.
+Make sure you have all required environment variables set.
 
-Once you are authenticated with AWS CLI or you have the local PostgreSQL setup, you should successfully run `npm start` to start the server
+Run 
+```bash
+make help
+```
+to list all available Makefile commands.

app.js

@@ -0,0 +1,37 @@
+const config = require('config');
+const express = require("express");
+const cookieParser = require('cookie-parser');
+const cors = require("cors");
+const { authenticate } = require("./middleware/authentication");
+const pinoHttp = require('pino-http');
+const { baseLogger } = require('./logger');
+
+require('dotenv').config({ path: '.env.local' });
+
+const app = express();
+
+// Middleware
+if (process.env.LOGGING_HTTP_REQUESTS === 'true') {
+  app.use(pinoHttp({ logger: baseLogger }));
+}
+
+app.use(express.json());
+app.use(cookieParser());
+const corsOptions = {
+  origin: (origin, callback) => {
+    if (!origin || config.cors.allowedOrigins.includes(origin)) {
+      callback(null, origin);
+    } else {
+      callback(new Error('Not allowed by CORS'));
+    }
+  },
+  credentials: true,
+  methods: ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS'],
+  allowedHeaders: ['Content-Type', 'Authorization', 'X-Firebase-Token', 'X-Discord-Code'], 
+};
+
+app.use(cors(corsOptions));
+app.options('*', cors(corsOptions));
+app.use(authenticate());
+
+module.exports = app;

appForTests.js

@@ -0,0 +1,16 @@
+const app = require('./app');
+const routes = require('./routes/routes');
+
+// Setting the app up for tests - so it has all the routes
+// (we don't need to wait for the database connection in unit-tests)
+
+// to simulate authentication in tests, we read userId from headers
+app.use((req, res, next) => {
+  if (!req.userId && req.headers['userid']) {
+    req.userId = Number(req.headers['userid']);
+  }
+  next();
+});
+app.use(routes);
+
+module.exports = app;

aws/s3_client.js

@@ -0,0 +1,79 @@
+const { S3Client, PutObjectCommand, GetObjectCommand, DeleteObjectCommand } = require("@aws-sdk/client-s3");
+const { getSignedUrl } = require("@aws-sdk/s3-request-presigner");
+const config = require("config");
+
+const awsConfig = config.aws;
+const s3 = new S3Client({ region: awsConfig.aws_region });
+
+const BUCKET_PREFIXES = {
+  applications: "videos/applications",
+  // images and-or other video categories will be added later
+};
+
+const MIME_EXTENSION_MAP = {
+  "video/mp4": "mp4",
+  "video/webm": "webm",
+  "video/ogg": "ogv",
+  "video/quicktime": "mov",
+};
+
+async function generateUploadUrl(bucketPrefix, filename, contentType) {
+  if (!Object.values(BUCKET_PREFIXES).includes(bucketPrefix)) {
+    throw new Error("Invalid bucket prefix");
+  }
+
+  filename = `${filename}.${MIME_EXTENSION_MAP[contentType]}`;
+  const fullKey = buildFullObjectKey(bucketPrefix, filename);
+
+  const command = new PutObjectCommand({
+    Bucket: awsConfig.s3_bucket,
+    Key: fullKey,
+    ContentType: contentType,
+    StorageClass: "INTELLIGENT_TIERING", // Cheapest option, auto-moves to colder storage based on access patterns
+  });
+
+  const url = await getSignedUrl(s3, command, { expiresIn: 3600 });
+  return {
+    url,
+    filename,
+  };
+}
+
+async function getDownloadUrl(bucketPrefix, filename) {
+  if (!Object.values(BUCKET_PREFIXES).includes(bucketPrefix)) {
+    throw new Error("Invalid bucket prefix");
+  }
+
+  const command = new GetObjectCommand({
+    Bucket: awsConfig.s3_bucket,
+    Key: buildFullObjectKey(bucketPrefix, filename)
+  });
+
+  const signedUrl = await getSignedUrl(s3, command, { expiresIn: 3600 });
+  return signedUrl;
+}
+
+async function deleteObject(bucketPrefix, filename) {
+  if (!Object.values(BUCKET_PREFIXES).includes(bucketPrefix)) {
+    throw new Error("Invalid bucket prefix");
+  }
+
+  const command = new DeleteObjectCommand({
+    Bucket: awsConfig.s3_bucket,
+    Key: buildFullObjectKey(bucketPrefix, filename)
+  });
+
+  await s3.send(command);
+}
+
+function buildFullObjectKey(bucketPrefix, filename) {
+  return `${bucketPrefix}/${filename}`;
+}
+
+module.exports = {
+  BUCKET_PREFIXES,
+  MIME_EXTENSION_MAP,
+  generateUploadUrl,
+  getDownloadUrl,
+  deleteObject,
+};