server: add github workflows and pre-commit hooks

DonVietnam · DonVietnam · commit 9c601e14a84a · 2022-09-16T17:38:50.000+03:00
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -3,7 +3,7 @@
   "tabWidth": 2,
   "semi": true,
   "singleQuote": true,
-  "quoteProps": "as-needed",
+  "quoteProps": "preserve",
   "trailingComma": "none",
   "bracketSpacing": true,
   "arrowParens": "always",
diff --git a/lib/server.js b/lib/server.js
@@ -7,9 +7,20 @@ const information = {
   projectUrl: 'Url for project repository',
   authorName: 'Author name',
   authorEmail: 'Author email',
-  keywords: 'Key words devided by comma'
+  keywords: 'Key words devided by comma',
+  preCommit: 'Add pre-commit hooks?(Need git repository before install packages.)(y/n)',
+  ciAction: 'Add github ci workflow?(Enter pull_request target branch or nothing for cancel)'
 };
 
+const preCommit = `"pre-commit": "^1.2.2"
+},
+
+"pre-commit": [
+  "prettier",
+  "lint",
+  "test"
+]`;
+
 const files = {
   'package.json': [
     'projectName',
@@ -20,11 +31,20 @@ const files = {
     {
       name: 'keywords',
       convert: (value) => `${value.split(',').join('",\n\t\t"')}`
+    },
+    {
+      name: 'preCommit',
+      convert: (value) => {
+        if(value === 'y' || value === 'yes' ) {
+          return preCommit;
+        } else {
+          return `}`
+        }
+      }
     }
   ],
   'README.md': ['projectName', 'projectDescription'],
   'nodemon.json': [],
-  LICENSE: [],
   'docker-compose.yml': [],
   '.prettierrc.json': [],
   '.prettierignore': [],
@@ -34,11 +54,18 @@ const files = {
   '.editorconfig': [],
   'src/index.js': [],
   'src/modules/index.js': [],
-  'db/structure.sql': []
+  'db/structure.sql': [],
+  'test/unit/.gitkeep': [],
+  'test/integration/.gitkeep': []
 };
 
 const createServer = async (directory) => {
   const values = await askInformation(information);
+
+  if (values['ciAction']) {
+    files['.github/workflows/ci.yml'] = ['ciAction'];
+  }
+
   createFiles(path.resolve(directory, values.projectName), path.resolve(__dirname, 'server'), files, values);
 };
 
diff --git a/lib/server/.eslintignore b/lib/server/.eslintignore
@@ -1,6 +1,6 @@
 node_modules
 db
-pgdata
+test
 .editorconfig
 .prettierignore
 .eslintrc
diff --git a/lib/server/.eslintrc b/lib/server/.eslintrc
@@ -128,7 +128,7 @@
       }
     ],
     "arrow-parens": ["error", "always"],
-    "arrow-body-style": ["error", "as-needed"],
+    "arrow-body-style": ["off"],
     "arrow-spacing": ["error"],
     "no-useless-rename": ["error"],
     "no-var": ["error"],
diff --git a/lib/server/.github/workflows/ci.yml b/lib/server/.github/workflows/ci.yml
@@ -0,0 +1,42 @@
+name: CI
+on:
+  pull_request:
+    types:
+      - opened
+      - edited
+      - reopened
+      - closed
+      - synchronize
+      - converted_to_draft
+      - ready_for_review
+      - locked
+      - unlocked
+      - review_requested
+      - review_request
+    branches: [$ciAction$]
+  workflow_dispatch:
+jobs:
+  test-and-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js 16
+        uses: actions/setup-node@v1
+        with:
+          node-version: '16'
+      - name: Install dependencies
+        run: npm i
+      - name: Linter
+        run: npm run lint
+      - name: Unit tests
+        run: npm run test
+      - name: Start database container
+        run: npm run docker
+      - name: Install forever for starting server
+        run: npm install -g forever
+      - name: Start server
+        run: PGHOST=localhost PGUSER=test_user PGDATABASE=test_db PGPASSWORD=test_password PGPORT=5432 forever start ./src/index.js
+      - name: Integration tests
+        run: npm run integration
+      - name: Stop server
+        run: forever stopall
diff --git a/lib/server/.gitignore b/lib/server/.gitignore
@@ -1,2 +1 @@
 node_modules
-pgdata
diff --git a/lib/server/.prettierignore b/lib/server/.prettierignore
@@ -1,6 +1,6 @@
+.github
 node_modules
 db
-pgdata
 .editorconfig
 .eslintignore
 .eslintrc
diff --git a/lib/server/.prettierrc.json b/lib/server/.prettierrc.json
@@ -3,7 +3,7 @@
   "tabWidth": 2,
   "semi": true,
   "singleQuote": true,
-  "quoteProps": "as-needed",
+  "quoteProps": "preserve",
   "trailingComma": "none",
   "bracketSpacing": true,
   "arrowParens": "always",
diff --git a/lib/server/LICENSE b/lib/server/LICENSE
diff --git a/lib/server/db/structure.sql b/lib/server/db/structure.sql
@@ -10,19 +10,29 @@ CREATE OR REPLACE FUNCTION CURRENT_SYSTEM_TIME() RETURNS timestamp without time
 SELECT CURRENT_TIMESTAMP AT TIME ZONE ( SELECT "timezone" FROM "SystemSettings" );
 $$;
 
+CREATE TABLE "Role"(
+  "name" text NOT NULL
+);
+
+ALTER TABLE "Role" ADD CONSTRAINT "pkRole" PRIMARY KEY ( "name" );
+INSERT INTO "Role"(name) VALUES ('user');
+
 CREATE TABLE "SystemUser"(
-  "username"  varchar( 128 ) NOT NULL,
-  "password" varchar( 255 ) NOT NULL,
-  "role" varchar( 32 ) NOT NULL,
-  "createdTime" timestamp(2) DEFAULT CURRENT_SYSTEM_TIME()
+  "username"  char( 11 ) NOT NULL,
+  "password" text NOT NULL,
+  "role" text NOT NULL,
+  "createdTime" timestamp(3) DEFAULT CURRENT_SYSTEM_TIME()
 );
+
 ALTER TABLE "SystemUser" ADD CONSTRAINT "pkSystemUser" PRIMARY KEY ( "username" );
+ALTER TABLE "SystemUser" ADD CONSTRAINT "fkSystemUserRoleName" FOREIGN KEY ( "role" ) REFERENCES "Role"( "name" ) ON DELETE CASCADE;
 
 CREATE TABLE "Session"(
-  "username"  varchar( 128 ) NOT NULL,
-  "token" varchar( 64 ) NOT NULL,
-  "createdTime" timestamp(2) DEFAULT CURRENT_SYSTEM_TIME()
+  "username"  char( 11 ) NOT NULL,
+  "token" uuid NOT NULL,
+  "createdTime" timestamp(3) DEFAULT CURRENT_SYSTEM_TIME()
 );
+
 ALTER TABLE "Session" ADD CONSTRAINT "pkSession" PRIMARY KEY ( "token" );
 ALTER TABLE "Session" ADD CONSTRAINT "fkSessionUserUsername" FOREIGN KEY ( "username" ) REFERENCES  "SystemUser"( "username" ) ON DELETE CASCADE;
 
diff --git a/lib/server/docker-compose.yml b/lib/server/docker-compose.yml
@@ -9,6 +9,9 @@ services:
       PGDATA: '/var/lib/postgresql/data/pgdata'
     volumes:
       - ./db:/docker-entrypoint-initdb.d
-      - .:/var/lib/postgresql/data
+      - pgdata:/var/lib/postgresql/data
     ports:
       - '5432:5432'
+volumes:
+  pgdata:
+    external: true
diff --git a/lib/server/package.json b/lib/server/package.json
@@ -6,7 +6,6 @@
   },
   "version": "1.0.0",
   "description": "$projectDescription$",
-  "license": "MIT",
   "keywords": [
     "$keywords$"
   ],
@@ -23,23 +22,27 @@
   "scripts": {
     "start": "node src/index.js",
     "dev": "nodemon --signal SIGTERM --exec \"node src/index.js\"",
-    "docker-dev": "docker compose up -d && npm run dev",
-    "lint": "eslint --ignore-path .gitignore .",
-    "fix": "eslint --fix --ignore-path .gitignore .",
-    "test": "npm run lint && jest test",
-    "prettier": "npx prettier --write ."
+    "docker": "docker volume create pgdata && docker compose up -d",
+    "docker-dev": "npm run docker && npm run dev",
+    "lint": "eslint --ignore-path .eslintignore .",
+    "fix": "eslint --fix --ignore-path .eslintignore .",
+    "unit": "jest test/unit -i --passWithNoTests",
+    "integration": "cross-env PGHOST=localhost PGUSER=test_user PGDATABASE=test_db PGPASSWORD=test_password PGPORT=5432 HOST=localhost PORT=8000 jest test/integration -i --passWithNoTests",
+    "test": "npm run unit && npm run integration",
+    "prettier": "prettier --write -ignore-path .prettierignore ."
   },
   "engines": {
     "node": ">=16"
   },
   "dependencies": {
-    "web-soft-server": "^1.0.1"
+    "web-soft-server": "^2.0.2"
   },
   "devDependencies": {
+    "cross-env": "^7.0.3",
     "eslint": "^7.8.1",
     "eslint-config-prettier": "^8.3.0",
     "jest": "^27.3.1",
     "nodemon": "^2.0.4",
-    "prettier": "2.5.1"
-  }
+    "prettier": "2.5.1",
+    $preCommit$
 }
diff --git a/lib/server/src/index.js b/lib/server/src/index.js
@@ -1,23 +1,39 @@
+const fs = require('fs');
 const { Server, AuthModule, logger } = require('web-soft-server');
 const modules = require('./modules');
 
 let server = {};
+
+const secureStart = async () => {
+  try {
+    const key = fs.readFileSync('/certs/private.key');
+    const cert = fs.readFileSync('/certs/cert.crt');
+    server = new Server({ host: '0.0.0.0', port: 443, cors: false, key, cert, secure: true });
+    server.start({ ...modules, auth: AuthModule });
+  } catch (error) {
+    logger.fatal(error);
+  }
+};
+
 const start = async () => {
   try {
-    server = new Server({ ...modules, auth: AuthModule }, { host: 'localhost', port: 80, cors: false });
+    server = new Server({ host: '0.0.0.0', port: 8000, cors: false });
+    server.start({ ...modules, auth: AuthModule });
   } catch (error) {
     logger.fatal(error);
   }
 };
 
 process.on('uncaughtException', async (error) => {
+  error.message = `Uncaught Exception. ${error.message}`;
   logger.fatal(error);
   await server.close();
   process.exit(1);
 });
 
-process.on('unhandledRejection', async (reason, p) => {
-  logger.fatal(new Error(`Reason: ${reason}. Unhandled Rejection at Promise. Promise: ${p}`));
+process.on('unhandledRejection', async (reason) => {
+  reason.message = `Unhandled Rejection at Promise. ${reason.message}`;
+  logger.fatal(reason);
   await server.close();
   process.exit(1);
 });
@@ -28,4 +44,8 @@ process.on('SIGTERM', async () => {
   process.exit(1);
 });
 
-start();
+if (process.env.KEY_PATH && process.env.CERT_PATH) {
+  secureStart();
+} else {
+  start();
+}
diff --git a/lib/server/test/integration/.gitkeep b/lib/server/test/integration/.gitkeep
diff --git a/lib/server/test/unit/.gitkeep b/lib/server/test/unit/.gitkeep
diff --git a/package.json b/package.json
@@ -4,7 +4,7 @@
     "name": "DonVietnam",
     "email": "don.vietnam.js@gmail.com"
   },
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Cli tool for generating projects templates.",
   "license": "MIT",
   "keywords": [

Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,7 @@`
`128`	`128`	`}`
`129`	`129`	`],`
`130`	`130`	`"arrow-parens": ["error", "always"],`
`131`		`- "arrow-body-style": ["error", "as-needed"],`
	`131`	`+ "arrow-body-style": ["off"],`
`132`	`132`	`"arrow-spacing": ["error"],`
`133`	`133`	`"no-useless-rename": ["error"],`
`134`	`134`	`"no-var": ["error"],`