Client tests

.github/workflows/test.yml

@@ -1,6 +1,8 @@
 name: Testing CI
 
-on: pull_request
+on:
+  - pull_request
+  - push # not for landing
 
 jobs:
   build:
@@ -9,24 +11,40 @@ jobs:
     strategy:
       matrix:
         node:
-          - 14
           - 16
           - 18
           - 19
+          - 20
         os:
           - ubuntu-latest
 
     steps:
       - uses: actions/checkout@v3
+
+      - name: Start db docker containers
+        run: |
+          docker-compose -f test-db-docker-compose.yml up  -d
+          sleep 10  # wait for database to be ready
+
       - name: Use Node.js ${{ matrix.node }}
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
+
       - uses: actions/cache@v3
         with:
           path: ~/.npm
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-node-
+
       - run: npm ci
+
       - run: npm test
+
+      - name: Client test
+        run: |
+          node server.js > /dev/null&
+          sleep 4  # wait for api to be ready
+          node test/system.js
+          node --test test/client.js

.prettierignore

@@ -1 +1,3 @@
 application/tasks/
+package-lock.json
+package.json

Dockerfile

@@ -1,4 +1,4 @@
-FROM mhart/alpine-node:14
+FROM node:20-alpine
 WORKDIR /usr/server
 COPY . .
 RUN npm ci --only=production

README.md

@@ -1,4 +1,4 @@
-# Metarhia Example Server for Node.js
+# Metarhia application example for Node.js
 
 [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/metarhia/Example/blob/master/LICENSE)
 
@@ -49,15 +49,16 @@ let's start with
 
 ## Usage
 
-- You need node.js v14 or later
+- You need node.js v16 or later
 - Fork and clone this repository (optionally subscribe to repo changes)
 - Run `npm i` to install dependencies and generate RSA certificate
 - Remove unneeded dependencies if your project doesn't require them
 - Add your license to `LICENSE` file but don't remove starter kit license
 - Start your project modifying this starter kit
+- If you have Docker and Docker Compose installed to run the project, use the command: `docker-compose up`
 - Before running server initialize the DB:
   - First of all, make sure you have PostgreSQL installed (prefer 12.x).
-  - Run database initialization script: `db/setup.sh`
+  - Run database initialization script: `database/setup.sh`
 - Run project: `node server.js` and stop with Ctrl+C
 - Ask questions in https://t.me/nodeua and post issues on
   [github](https://github.com/HowProgrammingWorks/NodejsStarterKit/issues)

application/api/.eslintrc.json

@@ -10,6 +10,7 @@
     "db": "readonly",
     "bus": "readonly",
     "domain": "readonly",
-    "metarhia": "readonly"
+    "metarhia": "readonly",
+    "DomainError": "readonly"
   }
 }

application/api/chat.1/send.js

@@ -1,4 +1,3 @@
 async ({ room, message }) => {
   domain.chat.send(room, message);
-  return 'ok';
 };

application/api/chat.1/subscribe.js

@@ -4,5 +4,4 @@ async ({ room }) => {
   context.client.on('close', () => {
     clients.delete(context.client);
   });
-  return 'ok';
 };

application/api/console.1/content.d.ts

@@ -0,0 +1,8 @@
+namespace api.console.content {
+  type Code = 'ENOTFOUND' | 'EPARSE';
+
+  class CustomError extends DomainError {
+    constructor(code?: Code);
+    toJSON(): object;
+  }
+}

application/api/console.1/content.js

@@ -1,9 +1,13 @@
 ({
   access: 'public',
+
   async method({ name }) {
+    // Try type: new api.console.content.CustomError('EPARSE');
     const filePath = `/content/${name}.md`;
-    const buffer = application.resources.get(filePath);
-    if (!buffer) return new Error('Content is not found');
-    return { text: buffer.toString() };
+    const file = application.resources.get(filePath);
+    if (!file) return new Error('Content is not found');
+    return { text: file.data.toString() };
   },
+
+  CustomError: class CustomError extends Error {},
 });

application/api/example.1/add.d.ts

@@ -0,0 +1,8 @@
+namespace api.example.add {
+  type Code = 'EARGA' | 'EARGB';
+
+  class CustomError extends DomainError {
+    constructor(code?: Code);
+    toJSON(): object;
+  }
+}

application/api/example.1/add.js

@@ -1,13 +1,24 @@
 ({
+  access: 'public',
+
   parameters: {
     a: 'number',
     b: 'number',
   },
 
   method: async ({ a, b }) => {
+    if (a < 0) return new DomainError('EARGA');
+    if (b > 500) return new DomainError('EARGB');
+    if (Number.isNaN(a)) throw Error('Not a number: a');
+    if (Number.isNaN(b)) throw Error('Not a number: b');
     const result = a + b;
     return result;
   },
 
   returns: 'number',
+
+  errors: {
+    EARGA: 'Invalid argument: "a" expected to be > 0',
+    EARGB: 'Invalid argument: "b" expected to be < 500',
+  },
 });

application/api/example.1/getClientInfo.js

@@ -3,7 +3,9 @@
   method: async () => {
     const { uuid, session, client } = context;
     const { ip } = client;
-    const { token, accountId } = session;
-    return { result: { ip, token, accountId, uuid } };
+    const { token } = session;
+    const accountId = session.state.accountId;
+    const result = { ip, token, accountId, uuid };
+    return { result };
   },
 });

application/api/example.1/hook.js

@@ -2,6 +2,6 @@
   router({ method, args, verb, headers }) {
     const ip = context.client.ip;
     console.log({ method, args, ip, verb, headers });
-    return {success:true, method, args, ip, verb, headers };
+    return { success: true, method, args, ip, verb, headers };
   },
 });

application/api/example.1/redisGet.js

@@ -1,7 +1,7 @@
 ({
   access: 'public',
   method: async ({ key }) => {
-    const result = await lib.redis.get(key);
+    const result = await db.redis.get(key);
     return { result };
   },
 });

application/api/example.1/redisSet.js

@@ -1,7 +1,7 @@
 ({
   access: 'public',
   method: async ({ key, value }) => {
-    const result = await lib.redis.set(key, value);
+    const result = await db.redis.set(key, value);
     return { result };
   },
 });

application/api/example.1/subscribe.js

@@ -1,7 +1,12 @@
-async () => {
-  setInterval(async () => {
-    const stats = await lib.resmon.getStatistics();
-    context.client.emit('example/resmon', stats);
-  }, config.resmon.interval);
-  return { subscribed: 'resmon' };
-};
+({
+  access: 'public',
+
+  method: async () => {
+    const { client } = context;
+    domain.resmon.subscribe(client);
+    context.client.on('close', () => {
+      domain.resmon.unsubscribe(client);
+    });
+    return { subscribed: 'resmon' };
+  },
+});

application/api/example.1/unsubscribe.js

@@ -0,0 +1,9 @@
+({
+  access: 'public',
+
+  method: async () => {
+    const { client } = context;
+    domain.resmon.unsubscribe(client);
+    return { unsubscribed: 'resmon' };
+  },
+});

application/api/example.1/uploadFile.js

@@ -5,5 +5,5 @@ async ({ name, data }) => {
   if (filePath.startsWith(tmpPath)) {
     await node.fsp.writeFile(filePath, buffer);
   }
-  return { uploaded: data.length };
+  return { uploaded: data.data.length };
 };

application/api/files.1/upload.js

@@ -1,5 +1,8 @@
 async ({ streamId, name }) => {
   const filePath = `./application/resources/${name}`;
+  const toBool = [() => true, () => false];
+  const exists = await node.fsp.access(filePath).then(...toBool);
+  if (exists) return { result: `File ${name} already exist on server` };
   // Get incoming stream by streamId sent from client
   const readable = context.client.getStream(streamId);
   // Create nodejs stream to write file on server

application/api/hook.1.js

@@ -2,6 +2,6 @@
   router({ method, args, verb, headers }) {
     const ip = context.client.ip;
     console.log({ method, args, ip, verb, headers });
-    return {};
+    return { success: true, args };
   },
 });

application/cert/default/README.md

@@ -0,0 +1,24 @@
+# Generate certificates
+
+## Certbot (for production)
+
+- Let's Encrypt is a free certificate authority: https://letsencrypt.org/
+- Use Certbot (free tool for automatically using Let’s Encrypt certificates on
+  manually-administrated websites to enable HTTPS): https://certbot.eff.org/
+
+```
+dnf -y install certbot
+certbot certonly --standalone -d www.domain.com -d domain.com -m [email protected] --agree-tos --no-eff-email
+yes | cp /etc/letsencrypt/live/domain.com/fullchain.pem ~/domain.com/application/cert/cert.pem
+yes | cp /etc/letsencrypt/live/domain.com/privkey.pem ~/domain.com/application/cert/key.pem
+```
+
+Or use impress web server for challenge exchange:
+
+```
+certbot certonly --webroot -w ~/domain.com/application/static -d www.domain.com -d domain.com -m [email protected] --agree-tos --no-eff-email
+```
+
+## Self-signed (for testing)
+
+- Run `./generate.sh` in this directory

application/cert/generate.ext → application/cert/default/generate.ext

@@ -5,5 +5,8 @@ subjectAltName = @alt_names
 
 [alt_names]
 DNS.1 = example.com
+DNS.2 = hello.example.com
+DNS.3 = hello1.example.com
+DNS.4 = hello2.example.com
 IP.1 = 127.0.0.1
 IP.2 = ::1

application/config/cache.js

@@ -1,4 +1,4 @@
 ({
-  size: '50mb',
-  maxFileSize: '10mb',
+  size: '50 mb',
+  maxFileSize: '10 mb',
 });

application/config/examples.js

@@ -0,0 +1,7 @@
+({
+  bus: false,
+  scheduler: false,
+  metacom: false,
+  invoke: false,
+  plugin: false,
+});

application/config/redis.js

@@ -0,0 +1,9 @@
+({
+  apiRedis: {
+    socket: {
+      host: process.env.REDIS_HOST ?? '127.0.0.1',
+      port: process.env.REDIS_PORT ?? 6379,
+    },
+    password: process.env.PASS,
+  },
+});

application/config/resmon.js

@@ -1,4 +1,4 @@
 ({
   interval: 30000,
-  active: true,
+  active: false,
 });

application/db/.eslintrc.json

@@ -10,7 +10,6 @@
     "npm": "readonly",
     "lib": "readonly",
     "db": "readonly",
-    "bus": "readonly",
     "domain": "readonly",
     "metarhia": "readonly"
   }

application/db/redis/get.js

@@ -1,7 +1 @@
-(key) =>
-  new Promise((resolve, reject) => {
-    lib.redis.client.get(key, (err, result) => {
-      if (err) reject(err);
-      else resolve(result);
-    });
-  });
+(key) => db.redis.client.get(key);

application/db/redis/set.js

@@ -1,7 +1 @@
-(key, value) =>
-  new Promise((resolve, reject) => {
-    lib.redis.client.set(key, value, (err, result) => {
-      if (err) reject(err);
-      else resolve(result);
-    });
-  });
+async (key, value) => db.redis.client.set(key, value);

application/db/redis/start.js

@@ -2,13 +2,13 @@ async () => {
   if (application.worker.id === 'W1') {
     console.debug('Connect to redis');
   }
-  const client = npm.redis.createClient();
+  const client = npm.redis.createClient(config.redis.apiRedis);
   db.redis.client = client;
   client.on('error', () => {
     if (application.worker.id === 'W1') {
       console.warn('No redis service detected, so quit client');
     }
     client.quit();
   });
-  //await client.connect();
+  await client.connect();
 };