migrate project to support postgres

Author: janishar

.dockerignore

@@ -0,0 +1,53 @@
+# Binaries
+/server
+/server.exe
+
+# Vendor directory (if not using Go modules)
+vendor/
+
+# OS-specific files
+*.exe
+*.dll
+*.so
+*.dylib
+
+# Test output
+*.out
+
+# Logs
+*.log
+
+# Coverage files
+*.cover
+*.coverage
+*.cov
+
+# Build directories
+bin/
+obj/
+build/
+dist/
+
+# IDE/editor directories and files
+.vscode/
+.idea/
+*.swp
+*~
+
+# Git
+.git/
+.gitignore
+
+# Docker
+.dockerignore
+Dockerfile
+
+# Dependency management files
+go.sum
+
+# Any other files you want to exclude
+.DS_Store 
+.github/
+.tools/
+logs/
+*.md

.editorconfig

@@ -0,0 +1,34 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# Go files
+[*.go]
+indent_style = tab
+indent_size = 2
+
+# JavaScript files
+[*.js]
+indent_style = space
+indent_size = 2
+
+# Markdown files
+[*.md]
+max_line_length = 80
+trim_trailing_whitespace = false
+
+# JSON files
+[*.json]
+indent_style = space
+indent_size = 2
+
+# YAML files
+[*.yml, *.yaml]
+indent_style = space
+indent_size = 2

.env.example

@@ -0,0 +1,28 @@
+# debug, release, test
+GO_MODE=debug
+
+SERVER_HOST=0.0.0.0
+SERVER_PORT=8080
+
+DB_HOST=postgres
+DB_PORT=5432
+DB_NAME=goserver_dev_db
+DB_USER=goserver_dev_db_user
+DB_USER_PWD=changeit
+DB_MIN_POOL_SIZE=2
+DB_MAX_POOL_SIZE=5
+DB_QUERY_TIMEOUT_SEC=60
+
+REDIS_HOST=redis
+REDIS_PORT=6379
+REDIS_PASSWORD=changeit
+
+# 2 DAYS: 172800 Sec
+ACCESS_TOKEN_VALIDITY_SEC=172800
+# 7 DAYS: 604800 Sec
+REFRESH_TOKEN_VALIDITY_SEC=604800
+TOKEN_ISSUER=api.goserve.afteracademy.com
+TOKEN_AUDIENCE=goserve.afteracademy.com
+
+RSA_PRIVATE_KEY_PATH="keys/private.pem"
+RSA_PUBLIC_KEY_PATH="keys/public.pem"

.extra/docs/goserve-banner.png

@@ -0,0 +1,160 @@
+-- Enable UUID
+CREATE EXTENSION IF NOT EXISTS pgcrypto;
+
+-- Create Tables
+-- ----------------
+
+-- Api Keys Table
+CREATE TABLE IF NOT EXISTS api_keys (
+    id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
+    key TEXT NOT NULL UNIQUE,
+    permissions TEXT[],
+    comments TEXT[],
+    version INTEGER,
+    status BOOLEAN DEFAULT TRUE,
+    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+    updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+);
+
+-- Api Keys Indexes
+CREATE INDEX IF NOT EXISTS api_keys_key_status_idx
+ON api_keys (key, status);
+
+-- Roles Table
+CREATE TABLE IF NOT EXISTS roles (
+    id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
+    code TEXT NOT NULL UNIQUE,
+    status BOOLEAN DEFAULT TRUE,
+    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+    updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+);
+
+-- Users Table
+CREATE TABLE IF NOT EXISTS users (
+    id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
+    name TEXT NOT NULL,
+    email TEXT NOT NULL UNIQUE,
+    password TEXT NOT NULL,
+		profile_pic_url TEXT,
+		verified BOOLEAN DEFAULT FALSE,
+    status BOOLEAN DEFAULT TRUE,
+    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+    updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+);
+
+-- Join Table for Users <-> Roles
+CREATE TABLE IF NOT EXISTS user_roles (
+    user_id UUID REFERENCES users(id) ON DELETE CASCADE,
+    role_id UUID REFERENCES roles(id) ON DELETE CASCADE,
+    PRIMARY KEY (user_id, role_id)
+);
+
+-- Keystore Table
+CREATE TABLE IF NOT EXISTS keystore (
+	id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
+	user_id UUID NOT NULL REFERENCES users(id) ON DELETE CASCADE,
+	p_key TEXT NOT NULL,
+	s_key TEXT NOT NULL,
+	status BOOLEAN DEFAULT TRUE,
+	created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+	updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+);
+
+-- Keystore Table Indexes
+CREATE INDEX IF NOT EXISTS keystore_user_status_idx
+ON keystore (user_id, status);
+
+CREATE INDEX IF NOT EXISTS keystore_user_pkey_status_idx
+ON keystore (user_id, p_key, status);
+
+CREATE INDEX IF NOT EXISTS keystore_user_pkey_skey_status_idx
+ON keystore (user_id, p_key, s_key, status);
+
+-- Messages Table
+CREATE TABLE messages (
+	id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
+	type TEXT NOT NULL,
+	msg TEXT NOT NULL,
+	status BOOLEAN DEFAULT TRUE,
+	created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+	updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+);
+
+-- Blogs Table
+CREATE TABLE IF NOT EXISTS blogs (
+	id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
+	title TEXT NOT NULL,
+	description TEXT NOT NULL,
+	text TEXT,
+	draft_text TEXT NOT NULL,
+	tags TEXT[],
+	author_id UUID NOT NULL REFERENCES users(id),
+	img_url TEXT,
+	slug TEXT NOT NULL UNIQUE,
+	score DOUBLE PRECISION DEFAULT 0.01,
+	submitted BOOLEAN DEFAULT FALSE,
+	drafted BOOLEAN DEFAULT TRUE,
+	published BOOLEAN DEFAULT FALSE,
+	status BOOLEAN DEFAULT TRUE,
+	published_at TIMESTAMP,
+	created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+	updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+);
+
+-- Blogs Table Indexes
+CREATE INDEX IF NOT EXISTS blogs_publish_idx
+ON blogs (published_at DESC, score DESC)
+WHERE published = TRUE AND status = TRUE;
+
+CREATE INDEX IF NOT EXISTS blogs_tags_gin_idx
+ON blogs
+USING GIN (tags);
+
+CREATE INDEX IF NOT EXISTS blogs_search_idx
+ON blogs
+USING GIN (to_tsvector('english', title));
+
+-- Insert Data
+-- --------------
+
+-- Insert API Key
+INSERT INTO api_keys (key, permissions, comments, version, status, created_at, updated_at)
+VALUES (
+    '1D3F2DD1A5DE725DD4DF1D82BBB37',
+    ARRAY['GENERAL'],
+    ARRAY['To be used by the xyz vendor'],
+    1,
+    true,
+    NOW(),
+    NOW()
+)
+ON CONFLICT (key) DO NOTHING;
+
+-- Insert Roles
+INSERT INTO roles (code, status, created_at, updated_at)
+VALUES 
+    ('LEARNER', true, NOW(), NOW()),
+    ('AUTHOR', true, NOW(), NOW()),
+    ('EDITOR', true, NOW(), NOW()),
+    ('ADMIN', true, NOW(), NOW())
+ON CONFLICT (code) DO NOTHING;
+
+-- Insert Admin User
+INSERT INTO users (name, email, password, status, created_at, updated_at)
+VALUES (
+    'Admin', 
+    'admin@afteracademy.com', 
+    '$2a$10$psWmSrmtyZYvtIt/FuJL1OLqsK3iR1fZz5.wUYFuSNkkt.EOX9mLa',
+    true, 
+    NOW(), 
+    NOW()
+)
+ON CONFLICT (email) DO NOTHING;
+
+-- Map Admin User to ALL Roles
+INSERT INTO user_roles (user_id, role_id)
+SELECT u.id, r.id
+FROM users u
+CROSS JOIN roles r
+WHERE u.email = 'admin@afteracademy.com'
+ON CONFLICT DO NOTHING;

.extra/docs/goserve-cover.png

@@ -0,0 +1,29 @@
+name: Docker Compose CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+    - name: Create .env
+      run: cp .env.example .env
+    - name: Create .test.env
+      run: cp .test.env.example .test.env
+    - name: Create pems
+      run: go run .tools/rsa/keygen.go
+    - name: Build docker images
+      run: docker compose build
+    - name: Run docker images
+      run: docker compose up -d
+    - name: Run tests
+      run: docker exec -t goserve_example_api_server_postgres go test -v ./...
+    - name: Clean up
+      if: success() || failure()
+      run: docker compose down --rmi all -v --remove-orphans

.extra/docs/request-flow.svg

@@ -0,0 +1,38 @@
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+.DS_Store
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+!Dockerfile.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work
+go.work.sum
+
+# Environment varibles
+*.env
+*.env.test
+
+#keys
+keys/*
+!keys/*.md
+!keys/*.txt
+*.pem
+
+__debug*
+
+build

.extra/setup/pgseed.sql

@@ -0,0 +1,29 @@
+# debug, release, test
+GO_MODE=debug
+
+SERVER_HOST=localhost
+SERVER_PORT=8081
+
+DB_HOST=postgres-test
+DB_PORT=5432
+DB_NAME=goserver_test_db
+DB_USER=goserver_test_db_user
+DB_USER_PWD=changeit
+DB_MIN_POOL_SIZE=2
+DB_MAX_POOL_SIZE=5
+DB_QUERY_TIMEOUT_SEC=60
+
+REDIS_HOST=redis-test
+REDIS_PORT=6379
+REDIS_PASSWORD=changeit
+
+# 2 DAYS: 172800 Sec
+ACCESS_TOKEN_VALIDITY_SEC=172800
+# 7 DAYS: 604800 Sec
+REFRESH_TOKEN_VALIDITY_SEC=604800
+TOKEN_ISSUER=api.goserve.afteracademy.com
+TOKEN_AUDIENCE=goserve.afteracademy.com
+
+# test run from the test directory one level below the src
+RSA_PRIVATE_KEY_PATH="../keys/private.pem"
+RSA_PUBLIC_KEY_PATH="../keys/public.pem"