🌅

Signed-off-by: Jari Kolehmainen <[email protected]>

.eslintrc.js

@@ -0,0 +1,115 @@
+module.exports = {
+  ignorePatterns: [
+    "**/node_modules/**/*",
+    "**/dist/**/*",
+  ],
+  overrides: [
+    {
+      files: [
+        "**/*.js"
+      ],
+      extends: [
+        "eslint:recommended",
+      ],
+      env: {
+        node: true
+      },
+      parserOptions: {
+        ecmaVersion: 2018,
+        sourceType: "module",
+      },
+      plugins: [
+        "unused-imports"
+      ],
+      rules: {
+        "indent": ["error", 2, {
+          "SwitchCase": 1,
+        }],
+        "no-unused-vars": "off",
+        "unused-imports/no-unused-imports": "error",
+        "unused-imports/no-unused-vars": [
+          "warn", {
+            "vars": "all",
+            "args": "after-used",
+            "ignoreRestSiblings": true,
+          }
+        ],
+        "quotes": ["error", "double", {
+          "avoidEscape": true,
+          "allowTemplateLiterals": true,
+        }],
+        "linebreak-style": ["error", "unix"],
+        "eol-last": ["error", "always"],
+        "semi": ["error", "always"],
+        "object-shorthand": "error",
+        "prefer-template": "error",
+        "template-curly-spacing": "error",
+        "padding-line-between-statements": [
+          "error",
+          { "blankLine": "always", "prev": "*", "next": "return" },
+          { "blankLine": "always", "prev": "*", "next": "block-like" },
+          { "blankLine": "always", "prev": "*", "next": "function" },
+          { "blankLine": "always", "prev": "*", "next": "class" },
+          { "blankLine": "always", "prev": ["const", "let", "var"], "next": "*" },
+          { "blankLine": "any", "prev": ["const", "let", "var"], "next": ["const", "let", "var"]},
+        ]
+      }
+    },
+    {
+      files: [
+        "**/*.ts",
+      ],
+      parser: "@typescript-eslint/parser",
+      extends: [
+        "plugin:@typescript-eslint/recommended",
+      ],
+      plugins: [
+        "unused-imports"
+      ],
+      parserOptions: {
+        ecmaVersion: 2018,
+        sourceType: "module",
+      },
+      rules: {
+        "@typescript-eslint/explicit-function-return-type": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        "@typescript-eslint/ban-types": "off",
+        "@typescript-eslint/ban-ts-comment": "off",
+        "@typescript-eslint/no-empty-interface": "off",
+        "@typescript-eslint/no-unused-vars": "off",
+        "unused-imports/no-unused-imports-ts": "error",
+        "unused-imports/no-unused-vars-ts": [
+          "warn", {
+            "vars": "all",
+            "args": "after-used",
+            "ignoreRestSiblings": true,
+          }
+        ],
+        "indent": ["error", 2, {
+          "SwitchCase": 1,
+        }],
+        "quotes": ["error", "double", {
+          "avoidEscape": true,
+          "allowTemplateLiterals": true,
+        }],
+        "semi": "off",
+        "@typescript-eslint/semi": ["error"],
+        "linebreak-style": ["error", "unix"],
+        "eol-last": ["error", "always"],
+        "object-shorthand": "error",
+        "prefer-template": "error",
+        "template-curly-spacing": "error",
+        "padding-line-between-statements": [
+          "error",
+          { "blankLine": "always", "prev": "*", "next": "return" },
+          { "blankLine": "always", "prev": "*", "next": "block-like" },
+          { "blankLine": "always", "prev": "*", "next": "function" },
+          { "blankLine": "always", "prev": "*", "next": "class" },
+          { "blankLine": "always", "prev": ["const", "let", "var"], "next": "*" },
+          { "blankLine": "any", "prev": ["const", "let", "var"], "next": ["const", "let", "var"]},
+        ]
+      },
+    },
+  ]
+};

.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+dist/
+example/

README.md

@@ -0,0 +1,6 @@
+# Heliograph
+
+A WebRTC signaling server designed for Lens.
+
+
+(c) Copyright 2021 Mirantis Inc, all rights reserved.

index.ts

@@ -0,0 +1,5 @@
+import { SignalingServer } from "./src/server";
+
+const server = new SignalingServer();
+
+server.start(8080);

package.json

@@ -0,0 +1,23 @@
+{
+  "name": "heliograph",
+  "version": "0.1.0",
+  "main": "dist/index.js",
+  "license": "UNLICENSED",
+  "scripts": {
+    "dev": "yarn ts-node index.ts",
+    "dist": "yarn tsc",
+    "lint": "yarn run eslint --ext js,ts --max-warnings=0 ."
+  },
+  "devDependencies": {
+    "@types/ws": "^7.4.0",
+    "@typescript-eslint/eslint-plugin": "^4.14.2",
+    "@typescript-eslint/parser": "^4.0.0",
+    "eslint": "^7.7.0",
+    "eslint-plugin-unused-imports": "^1.0.1",
+    "ts-node": "^9.1.1",
+    "typescript": "^4.1.5"
+  },
+  "dependencies": {
+    "ws": "^7.4.3"
+  }
+}

src/lens-agent.ts

@@ -0,0 +1,11 @@
+import WebSocket from "ws";
+import { LensClient } from "./lens-client";
+
+export class LensAgent {
+  public socket: WebSocket;
+  public clients: LensClient[] = [];
+
+  constructor(socket: WebSocket) {
+    this.socket = socket;
+  }
+}

src/lens-client.ts

@@ -0,0 +1,9 @@
+import WebSocket from "ws";
+
+export class LensClient {
+  public socket: WebSocket;
+
+  constructor(socket: WebSocket) {
+    this.socket = socket;
+  }
+}

src/server.ts

@@ -0,0 +1,84 @@
+import WebSocket, { Server } from "ws";
+import { IncomingMessage } from "http";
+import { LensClient } from "./lens-client";
+import { LensAgent } from "./lens-agent";
+import { URL } from "url";
+
+export class SignalingServer {
+  private ws?: Server;
+  private clients: LensClient[] = [];
+  private agents: LensAgent[] = [];
+
+  start(port = 8080) {
+    console.log("~~ Heliograph ~~");
+
+    this.ws = new Server({
+      port
+    });
+
+    this.ws.on("listening", () => {
+      console.log(`listening on port ${port}`);
+    });
+
+    this.ws.on("connection", (socket: WebSocket, request: IncomingMessage) => {
+      if (!request.url || !request.method) {
+        socket.close();
+
+        return;
+      }
+
+      const url = new URL(request.url, "http://localhost");
+
+      if (url.pathname === "/client") {
+        this.handleClientSocket(socket);
+      } else if (url.pathname === "/agent") {
+        this.handleAgentSocket(socket);
+      } else {
+        socket.close();
+      }
+    });
+  }
+
+  stop() {
+    this.ws?.close();
+  }
+
+  private handleClientSocket(socket: WebSocket) {
+    console.log("client connected", socket.extensions);
+    this.clients.push(new LensClient(socket));
+
+    socket.on("message", (data) => {
+      this.agents.forEach((agent) => {
+        agent.socket.send(data);
+      });
+    });
+
+    socket.on("close", () => {
+      const index = this.clients.findIndex((client) => client.socket === socket);
+
+      if (index !== -1) {
+        this.clients.splice(index, 1);
+      }
+    });
+  }
+
+  private handleAgentSocket(socket: WebSocket) {
+    console.log("agent connected");
+    this.agents.push(new LensAgent(socket));
+
+    socket.on("message", (data) => {
+      this.clients.forEach((client) => {
+        client.socket.send(data);
+      });
+    });
+
+    socket.on("close", () => {
+      console.log("agent closed");
+      const index = this.agents.findIndex((agent) => agent.socket === socket);
+
+      if (index !== -1) {
+        this.agents.splice(index, 1);
+      }
+    });
+  }
+}

tsconfig.json

@@ -0,0 +1,70 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "ES2019",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
+    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "outDir": "./dist",                        /* Redirect output structure to the directory. */
+    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+    // "noUncheckedIndexedAccess": true,      /* Include 'undefined' in index signature results */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
+    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
+  }
+}