🚀 initial commit

Author: evanshortiss

.editorconfig

@@ -0,0 +1,14 @@
+# Tells the .editorconfg plugin to stop searching once it finds this file
+root = true
+
+[*]
+indent_size = 2
+indent_style = space
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+quote_type = single
+
+[*.py]
+indent_size = 4

.gitignore

@@ -0,0 +1,120 @@
+# Ignore generated JS and TypeScript files
+*.d.ts
+build/
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

.nvmrc

@@ -0,0 +1 @@
+v14.3.0

README.md

@@ -0,0 +1,27 @@
+# 2021-frontend-wss
+
+Simple WebSocket server that can be used for client development.
+
+## Requirements
+
+- Node.js v14.3
+- npm 6.14
+
+## Usage
+
+### Run in Dev Mode
+
+Making changes to the TypeScript source code after running `npm run dev` will
+cause the server to automatically restart with the new changes.
+
+```
+git clone https://github.com/rhdemo/2021-frontend-wss
+cd 2021-frontend-wss
+
+npm install
+npm run dev
+```
+
+### Run in Production Mode
+
+TODO

config.ts

@@ -0,0 +1,14 @@
+'use strict';
+
+const { get } = require('env-var');
+
+const config = {
+  HTTP_PORT: get('HTTP_PORT').default(3000).asPortNumber(),
+
+  // Reject web socket payloads greater than this many bytes (5KB by default)
+  WS_MAX_PAYLOAD: get('WS_MAX_PAYLOAD')
+    .default(1024 * 5)
+    .asIntPositive(),
+};
+
+export = config;

index.ts

@@ -0,0 +1,59 @@
+'use strict ';
+
+import fastify, { FastifyInstance } from 'fastify';
+import { Server } from 'http';
+import { ServerOptions } from 'ws';
+import { WebsocketPluginOptions } from 'fastify-websocket';
+import { WS_MAX_PAYLOAD, HTTP_PORT } from './config';
+import { getWsAddressFromServer } from './utils';
+
+const app = fastify({ logger: true });
+
+app.get('/', async (request, reply) => {
+  return { hello: 'world' };
+});
+
+// Register the WS plugin, apply a max payload limit, and optional authorisation
+app.register(require('fastify-websocket'), {
+  options: {
+    maxPayload: WS_MAX_PAYLOAD,
+    verifyClient: (info, next) => {
+      // Can add optional verification logic into this block
+      const addr =
+        info.req.headers['x-forwarded-for'] || info.req.socket.remoteAddress;
+      app.log.info(`accepted connection from ${addr}`);
+      next(true);
+    },
+  } as ServerOptions,
+} as WebsocketPluginOptions);
+
+// This is the WS endpoint, i.e ws://localhost:3000/game
+app.get('/game', { websocket: true }, (conn, req) => {
+  conn.on('error', (err: any) => {
+    app.log.error(
+      `error generated. client will be disconnected due to: ${err}`
+    );
+  });
+  conn.on('close', () => {
+    app.log.error(`client connection closed`);
+  });
+  conn.socket.on('message', (message) => {
+    app.log.info(`received message ${message}`);
+    // echo the incoming message back
+    conn.socket.send(message);
+  });
+});
+
+const start = async () => {
+  try {
+    await app.listen(HTTP_PORT);
+    app.log.info(
+      `Connect vai WebSocket to ws://${getWsAddressFromServer(app.server)}/game`
+    );
+  } catch (err) {
+    app.log.error(err);
+    process.exit(1);
+  }
+};
+
+start();