added linting; added Docker test stuff; added initial support for frequency counters

Author: brenc

.eslintrc.js

@@ -0,0 +1,34 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: [
+      './tsconfig.json',
+    ],
+    tsconfigRootDir: __dirname,
+  },
+  plugins: [
+    '@typescript-eslint',
+  ],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:@typescript-eslint/recommended-requiring-type-checking',
+    // Sets up both the plugin and eslint-config-prettier in one go.
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    // '@typescript-eslint/interface-name-prefix': 'off',
+    // '@typescript-eslint/explicit-function-return-type': 'off',
+    // '@typescript-eslint/explicit-module-boundary-types': 'off',
+    // '@typescript-eslint/no-explicit-any': 'off',
+    'prefer-const': ['error', {
+      destructuring: 'all'
+    }],
+  },
+};

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "endOfLine": "auto"
+}

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "editor.formatOnSave": true
+}

Dockerfile

@@ -0,0 +1,151 @@
+# syntax=docker/dockerfile:experimental
+FROM node:16-alpine as builder_base
+
+ARG NPM_TOKEN
+
+RUN apk --no-cache add \
+  #autoconf \
+  #automake \
+  #python \
+  #make \
+  #g++ \
+  yarn
+
+WORKDIR /app
+
+COPY package.json yarn.lock ./
+
+
+FROM builder_base as builder_development
+
+ENV NODE_ENV development
+
+RUN \
+  # This is for the yarn cache. We have to use different caches otherwise both
+  # this and the production stage will use the same cache and clobber each
+  # other if they are run in parallel.
+  --mount=type=cache,id=builder_development_yarn,target=/usr/local/share/.cache/yarn \
+  # This is to keep the node_modules dir around between builds otherwise yarn
+  # has to do a fresh install + build whenever the lock file changes.
+  --mount=type=cache,id=builder_development_node_modules,target=/app/node_modules \
+  # Defaults to installing all (prod + dev) packages.
+  yarn --no-progress && \
+  # The node_modules dir ceases to exist after the build so unless it's copied
+  # off it can't be copied into the below stages.
+  cp -r /app/node_modules/ /app/node_modules.sav
+
+
+# This is used for both staging and production builds so we can't solely rely
+# on the NODE_ENV env var.
+FROM builder_base as builder_production
+
+ENV NODE_ENV production
+
+RUN \
+  --mount=type=cache,id=builder_production_yarn,target=/usr/local/share/.cache/yarn \
+  --mount=type=cache,id=builder_production_node_modules,target=/app/node_modules \
+  yarn --prod --no-progress && \
+  cp -r /app/node_modules/ /app/node_modules.sav
+
+
+FROM node:16-alpine as base
+
+ARG UID=2001
+
+ARG USER=ngapps
+
+RUN adduser --disabled-password --uid ${UID} --shell /bin/ash ${USER}
+
+ENV PATH /app/node_modules/.bin:$PATH
+
+
+FROM base as development
+
+RUN mkdir /app && \
+    chown ${USER}:${USER} /app
+
+WORKDIR /app
+
+ARG NPM_TOKEN
+
+ENV DEBUG manager:*
+
+ENV NODE_ENV development
+
+ENV NPM_TOKEN=${NPM_TOKEN}
+
+COPY --from=builder_development --chown=${USER}:${USER} \
+  /app/node_modules.sav node_modules
+
+USER ${USER}
+
+CMD ["nodemon", "-r", "source-map-support/register", "--delay", "1", "-e", "js", "dist/demo.js"]
+
+
+FROM base as tsc_watch
+
+ENV NODE_ENV development
+
+WORKDIR /app
+
+USER ${USER}
+
+# Not using tsc's actual watch command here because it clears the screen.
+# CMD ["nodemon", "--watch", "/app/src/server", "--watch", "/app/src/test", "-e", "ts,js", "--exec", "tsc -p tsconfig.development.json"]
+CMD ["tsc", "-w", "--preserveWatchOutput", "-p", "tsconfig.json"]
+
+
+# FROM base as testwatch
+# 
+# ENV NODE_ENV test
+# 
+# RUN mkdir /app && \
+#     chown ${USER}:${USER} /app
+# 
+# WORKDIR /app
+# 
+# COPY --from=builder_development --chown=${USER}:${USER} \
+#   /app/node_modules.sav node_modules
+# 
+# USER ${USER}
+# 
+# CMD ["nodemon", "--exec", "tap", "src/**/*.test.js"]
+# 
+# 
+# FROM base as test
+# 
+# ENV NODE_ENV test
+# 
+# RUN mkdir /app && \
+#     chown ${USER}:${USER} /app
+# 
+# WORKDIR /app
+# 
+# COPY --from=builder_development --chown=${USER}:${USER} \
+#   /app/node_modules.sav node_modules
+# 
+# USER ${USER}
+# 
+# RUN \
+#   --mount=type=bind,source=package.json,target=package.json \
+#   --mount=type=bind,source=src,target=src \
+#   npm test
+# 
+# 
+# FROM base as production
+# 
+# EXPOSE 3000
+# 
+# WORKDIR /app
+# 
+# COPY --from=builder_production /app/node_modules.sav node_modules
+# 
+# COPY src/ src/
+# 
+# ARG NODE_ENV=production
+# 
+# ENV NODE_ENV ${NODE_ENV}
+# 
+# USER ${USER}
+# 
+# CMD ["node", "src/server.js"]

docker-compose.yml

@@ -0,0 +1,63 @@
+version: "3.9"
+services:
+  proxy:
+    build:
+      args:
+        - USER
+      context: ./test-proxy
+    hostname: test-proxy
+    init: true
+    ports:
+      # Non-ssl port
+      - 8100:8100
+      - 8101:8101
+      - 8102:8102
+      - 8103:8103
+    volumes:
+      - /home/${USER}/.cache/yarn:/home/${USER}/.cache/yarn
+      - ${PWD}/../haproxy-2.5.0/haproxy:/usr/local/sbin/haproxy
+      - ${PWD}/test-proxy/etc:/usr/local/etc/haproxy
+      - ${PWD}/test-proxy/package.json:/app/package.json
+      - ${PWD}/test-proxy/yarn.lock:/app/yarn.lock
+
+  demo:
+    build:
+      args:
+        - NODE_ENV
+        - NPM_TOKEN
+        - UID
+        - USER
+      context: .
+      target: development
+    init: true
+    #ports:
+    #  - 8200:8200
+    volumes:
+      - ${PWD}/test-web/dot-npmrc:/app/.npmrc
+      # Use the host's yarn cache otherwise each time you run yarn inside a
+      # fresh container, it'll download all packages to the cache inside the
+      # container. $USER is set by the shell and exported explicitly so it'll
+      # just work here.
+      - /home/${USER}/.cache/yarn:/home/${USER}/.cache/yarn
+      - ${PWD}/dist:/app/dist
+      - ${PWD}/package.json:/app/package.json
+      - ${PWD}/yarn.lock:/app/yarn.lock
+
+  tsc_watch:
+    build:
+      args:
+        - UID
+        - USER
+      context: .
+      target: tsc_watch
+    init: true
+    volumes:
+      - ${PWD}:/app
+
+#  web:
+#    image: nginx
+#    ports:
+#      - 8300:80
+#    #init: true
+#    volumes:
+#      - ${PWD}/web:/usr/share/nginx/html:ro

package.json

@@ -8,11 +8,19 @@
   "license": "LGPL-3.0-or-later",
   "private": true,
   "devDependencies": {
-    "@types/debug": "^4.1.5",
-    "@types/node": "^12.12.53",
-    "typescript": "^4.0.5"
+    "@types/debug": "^4.1.7",
+    "@types/node": "^17.0.4",
+    "@typescript-eslint/eslint-plugin": "^5.8.0",
+    "@typescript-eslint/parser": "^5.8.0",
+    "eslint": "^8.5.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "nodemon": "^2.0.15",
+    "prettier": "^2.5.1",
+    "source-map-support": "^0.5.21",
+    "typescript": "^4.5.4"
   },
   "dependencies": {
-    "debug": "^4.3.1"
+    "debug": "^4.3.3"
   }
 }

src/demo.ts

@@ -17,46 +17,61 @@
  * SPDX-License-Identifier: LGPL-3.0-or-later
  */
 
-import net from "net";
+import net from 'net';
+import d from 'debug';
 import {
   PeerConnection,
   PeerDirection,
   TableDefinition,
   EntryUpdate,
   SynchronizationType,
-} from "./haproxy/peers";
-import { DataType } from "./haproxy/peers/wire-types";
+} from './haproxy/peers';
+import { DataType } from './haproxy/peers/wire-types';
+
+const debug = d('manager:demo');
 
 function reconnect() {
-  console.log("connecting");
-  const socket = net.connect(20000, "127.0.0.1");
+  debug('connecting');
+
+  const socket = net.connect(8102, 'test-proxy');
+
   const conn = new PeerConnection(socket, {
-    myName: "tracker",
-    peerName: "haproxy.example.com",
+    myName: 'tracker',
+    peerName: 'test-proxy',
     direction: PeerDirection.OUT,
   });
-  socket.on("close", () => setTimeout(reconnect, 1500));
-  socket.on("error", (e) => {
-    console.log(e);
+
+  socket.on('close', () => setTimeout(reconnect, 500));
+
+  socket.on('error', (e) => {
+    debug(e);
   });
 
-  conn.on("tableDefinition", (def: TableDefinition) => {
-    console.log(`Received table defition ${def.name}:`, def);
+  conn.on('tableDefinition', (def: TableDefinition) => {
+    debug(`Received table defition ${def.name}:`, def);
   });
-  conn.on("entryUpdate", (update: EntryUpdate, def: TableDefinition) => {
-    console.log(
-      `Received entry update in table ${def.name} for key '${update.key.key}':`,
-      new Map(Array.from(update.values.entries()).map(([k, v]) => {
-        return [DataType[k], v];
-      }))
+
+  conn.on('entryUpdate', (update: EntryUpdate, def: TableDefinition) => {
+    debug(
+      `Received entry update in table ${def.name} for key '${
+        update.key.key as string
+      }':`,
+      new Map(
+        Array.from(update.values.entries()).map(([k, v]) => {
+          return [DataType[k], v];
+        })
+      )
     );
   });
-  conn.on("synchronizationStarted", () => {
-    console.log(`Started sync`);
+
+  conn.on('synchronizationStarted', () => {
+    debug(`Started sync`);
   });
-  conn.on("synchronizationFinished", (type: SynchronizationType) => {
-    console.log(`Finished sync ${type}`);
+
+  conn.on('synchronizationFinished', (type: SynchronizationType) => {
+    debug(`Finished sync ${type}`);
   });
+
   conn.start(true);
 }
 reconnect();