2.0.0-alpha.13

Be a bit more accurate in the online time stat name and call it for what
it is.  It counts time spend online on the server, not necessarily
time spent playing.

.eslintrc.js

@@ -1,12 +1,12 @@
 "use strict";
 module.exports = {
+	"plugins": [
+		"node",
+	],
 	"env": {
 		"node": true,
 		"commonjs": true,
-		"es6": true,
-	},
-	"parserOptions": {
-		"ecmaVersion": 11,
+		"es2022": true,
 	},
 
 	"overrides": [
@@ -18,10 +18,12 @@ module.exports = {
 			"rules": {
 				"prefer-arrow-callback": "off",
 				"no-invalid-this": "off",
+				"node/no-unpublished-import": "off",
+				"node/no-unpublished-require": "off",
 			},
 		},
 		{
-			"files": ["packages/web_ui/src/**/*.jsx", "plugins/*/web/**/*.jsx"],
+			"files": ["packages/web_ui/src/**/*.jsx", "packages/lib/browser.js", "plugins/*/web/**/*.jsx"],
 			"env": {
 				"browser": true,
 			},
@@ -31,6 +33,44 @@ module.exports = {
 					"jsx": true,
 				},
 			},
+			"rules": {
+				"node/callback-return": "off",
+				"node/exports-style": "off",
+				"node/file-extension-in-import": "off",
+				"node/global-require": "off",
+				"node/handle-callback-err": "off",
+				"node/no-callback-literal": "off",
+				"node/no-deprecated-api": "off",
+				"node/no-exports-assign": "off",
+				"node/no-extraneous-import": "off",
+				"node/no-extraneous-require": "off",
+				"node/no-missing-import": "off",
+				"node/no-missing-require": "off",
+				"node/no-mixed-requires": "off",
+				"node/no-new-require": "off",
+				"node/no-path-concat": "off",
+				"node/no-process-env": "off",
+				"node/no-process-exit": "off",
+				"node/no-restricted-require": "off",
+				"node/no-sync": "off",
+				"node/no-unpublished-bin": "off",
+				"node/no-unpublished-import": "off",
+				"node/no-unpublished-require": "off",
+				"node/no-unsupported-features/es-builtins": "off",
+				"node/no-unsupported-features/es-syntax": "off",
+				"node/no-unsupported-features/node-builtins": "off",
+				"node/prefer-global/buffer": "off",
+				"node/prefer-global/console": "off",
+				"node/prefer-global/process": "off",
+				"node/prefer-global/text-decoder": "off",
+				"node/prefer-global/text-encoder": "off",
+				"node/prefer-global/url-search-params": "off",
+				"node/prefer-global/url": "off",
+				"node/prefer-promises/dns": "off",
+				"node/prefer-promises/fs": "off",
+				"node/process-exit-as-throw": "off",
+				"node/shebang": "off",
+			},
 		},
 	],
 
@@ -46,7 +86,6 @@ module.exports = {
 		"block-scoped-var": "error",
 		"block-spacing": "error",
 		"brace-style": ["error", "1tbs", { "allowSingleLine": true }],
-		"callback-return": "off",
 		"camelcase": "off",
 		"capitalized-comments": "off",
 		"class-methods-use-this": "off",
@@ -81,10 +120,8 @@ module.exports = {
 		"function-call-argument-newline": "off",
 		"function-paren-newline": "off",
 		"generator-star-spacing": ["error", { "before": false, "after": true }],
-		"global-require": "error",
 		"grouped-accessor-pairs": "error",
 		"guard-for-in": "error",
-		"handle-callback-err": "error",
 		"id-blacklist": "error",
 		"id-length": "off",
 		"id-match": "error",
@@ -160,7 +197,6 @@ module.exports = {
 				],
 			},
 		],
-		"no-mixed-requires": "error",
 		"no-multi-assign": "error",
 		"no-multi-spaces": "error",
 		"no-multi-str": "error",
@@ -172,19 +208,14 @@ module.exports = {
 		"no-new": "error",
 		"no-new-func": "error",
 		"no-new-object": "error",
-		"no-new-require": "error",
 		"no-new-wrappers": "error",
 		"no-octal-escape": "error",
 		"no-param-reassign": "off",
-		"no-path-concat": "error",
 		"no-plusplus": ["error", { "allowForLoopAfterthoughts": true }],
-		"no-process-env": "error",
-		"no-process-exit": "error",
 		"no-proto": "error",
 		"no-restricted-exports": "error",
 		"no-restricted-globals": "error",
 		"no-restricted-imports": "error",
-		"no-restricted-modules": "error",
 		"no-restricted-properties": "error",
 		"no-restricted-syntax": "error",
 		"no-return-assign": "error",
@@ -194,7 +225,6 @@ module.exports = {
 		"no-sequences": "error",
 		"no-shadow": ["error", { "allow": ["yargs"] }],
 		"no-spaced-func": "error",
-		"no-sync": "error",
 		"no-tabs": ["error", { "allowIndentationTabs": true }],
 		"no-template-curly-in-string": "error",
 		"no-ternary": "off",
@@ -279,5 +309,45 @@ module.exports = {
 		"wrap-regex": "off",
 		"yield-star-spacing": "error",
 		"yoda": ["error", "never", { "exceptRange": true }],
+
+		"node/callback-return": "off",
+		"node/exports-style": "off",
+		"node/file-extension-in-import": "off",
+		"node/global-require": "error",
+		"node/handle-callback-err": "error",
+		"node/no-callback-literal": "error",
+		"node/no-deprecated-api": "error",
+		"node/no-exports-assign": "error",
+		"node/no-extraneous-import": "error",
+		"node/no-extraneous-require": "error",
+		"node/no-missing-import": "error",
+		"node/no-missing-require": "error",
+		"node/no-mixed-requires": "error",
+		"node/no-new-require": "error",
+		"node/no-path-concat": "error",
+		"node/no-process-env": "error",
+		"node/no-process-exit": "error",
+		"node/no-restricted-require": "off",
+		"node/no-sync": "error",
+		"node/no-unpublished-bin": "error",
+		"node/no-unpublished-import": "error",
+		"node/no-unpublished-require": [
+			"error",
+			{ "allowModules": ["webpack", "webpack-merge", "webpack-dev-middleware"] },
+		],
+		"node/no-unsupported-features/es-builtins": "error",
+		"node/no-unsupported-features/es-syntax": "error",
+		"node/no-unsupported-features/node-builtins": "error",
+		"node/prefer-global/buffer": "error",
+		"node/prefer-global/console": "error",
+		"node/prefer-global/process": "error",
+		"node/prefer-global/text-decoder": "error",
+		"node/prefer-global/text-encoder": "error",
+		"node/prefer-global/url-search-params": "error",
+		"node/prefer-global/url": "error",
+		"node/prefer-promises/dns": "off",
+		"node/prefer-promises/fs": "off",
+		"node/process-exit-as-throw": "error",
+		"node/shebang": "error",
 	},
 };

.github/workflows/docker-publish.yml

@@ -1,159 +0,0 @@
-name: Docker
-
-on:
-  push:
-    # Publish `master` as Docker `latest` image.
-    branches:
-      - '**'
-
-    # Publish `v1.2.3` tags as releases.
-    tags:
-      - v*
-
-  # Run tests for any PRs.
-  pull_request:
-
-  release:
-    types: [released, prereleased]
-
-env:
-  # TODO: Change variable to your image's name.
-  IMAGE_NAME: clusterio
-
-jobs:
-  # Build dependencies and clusterio image
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Build docker image
-        run: DOCKER_BUILDKIT=1 docker build . -t $IMAGE_NAME --target clusterio_final
-
-      - name: Export docker image
-        run: docker save -o clusterio_docker_image $IMAGE_NAME
-
-      - name: Upload docker image
-        uses: actions/upload-artifact@master
-        with:
-          name: clusterio_docker_image
-          path: clusterio_docker_image
-  # Build dependencies and clusterio image with test tooling
-  build_testing:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Build docker image
-        run: DOCKER_BUILDKIT=1 docker build . -t $IMAGE_NAME --target clusterio_testing
-
-      - name: Export docker image
-        run: docker save -o clusterio_docker_image_testing $IMAGE_NAME
-
-      - name: Upload docker image
-        uses: actions/upload-artifact@master
-        with:
-          name: clusterio_docker_image_testing
-          path: clusterio_docker_image_testing
-  # Upload clusterio_lib and subspace_storage versions
-  upload_mods:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - name: Download docker image
-        uses: actions/download-artifact@master
-        with:
-          name: clusterio_docker_image
-          path: .
-
-      - name: Load docker image
-        run: docker load -i clusterio_docker_image
-      
-      - name: Create container
-        run: docker create --name clusterio_container $IMAGE_NAME
-
-      - name: Move mods out of container
-        run: docker cp clusterio_container:/clusterio/sharedMods ./mods
-
-      - name: Remove container
-        run: docker rm clusterio_container
-
-      - name: List extracted mods
-        run: ls mods
-
-      - name: Upload mods
-        uses: actions/upload-artifact@master
-        with:
-          name: mods
-          path: mods
-  # Run tests.
-  # See also https://docs.docker.com/docker-hub/builds/automated-testing/
-  test:
-    needs: build_testing
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Download docker image
-        uses: actions/download-artifact@master
-        with:
-          name: clusterio_docker_image_testing
-          path: .
-      - name: ls
-        run: ls && ls clusterio_docker_image_testing && ls /home/runner/work/factorioClusterio && ls /home/runner/work/factorioClusterio/factorioClusterio
-      - name: Load docker image
-        run: docker load -i clusterio_docker_image_testing
-
-      - name: Run tests
-        run: |
-          if [ -f docker-compose.test.yml ]; then
-            docker-compose --file docker-compose.test.yml run unit_test
-          else
-            docker build . --file Dockerfile
-          fi
-  # Push image to GitHub Packages.
-  # See also https://docs.docker.com/docker-hub/builds/
-  push:
-    # Ensure test job passes before pushing image.
-    needs: [test, build]
-
-    runs-on: ubuntu-latest
-    if: github.event_name == 'push'
-
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Download artifact
-        uses: actions/download-artifact@master
-        with:
-          name: clusterio_docker_image
-          path: .
-
-      - name: Load docker image
-        run: docker load -i clusterio_docker_image
-
-      - name: Log into registry
-        run: echo "${{ secrets.CR_PAT }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
-
-      - name: Push image
-        run: |
-          IMAGE_ID=ghcr.io/${{ github.actor }}/$IMAGE_NAME
-
-          # Change all uppercase to lowercase
-          IMAGE_ID=$(echo $IMAGE_ID | tr '[A-Z]' '[a-z]')
-
-          # Strip git ref prefix from version
-          VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
-
-          # Strip "v" prefix from tag name
-          [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
-
-          # Use Docker `latest` tag convention
-          [ "$VERSION" == "master" ] && VERSION=latest
-
-          echo IMAGE_ID=$IMAGE_ID
-          echo VERSION=$VERSION
-
-          docker tag $IMAGE_NAME $IMAGE_ID:$VERSION
-          docker push $IMAGE_ID:$VERSION

.github/workflows/node.js.yml

@@ -0,0 +1,54 @@
+# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 16.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: pnpm/action-setup@v2.2.2
+      with:
+        version: 6
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: pnpm i --no-optional --no-frozen-lockfile
+    - run: wget -q -O factorio.tar.gz https://www.factorio.com/get-download/latest/headless/linux64 && tar -xf factorio.tar.gz && rm factorio.tar.gz
+    - run: node packages/lib/build_mod --source-dir packages/slave/lua/clusterio_lib --output-dir temp/test/sharedMods
+    - run: wget -q -O temp/test/sharedMods/subspace_storage_1.99.8.zip -L https://github.com/clusterio/subspace_storage/releases/download/1.99.6/subspace_storage_1.99.8.zip
+    - name: Run tests
+      if: ${{ matrix.node-version != '12.x' }}
+      run: pnpm test
+    - name: Run coverage
+      if: ${{ matrix.node-version == '12.x' }}
+      run: pnpm run ci-cover
+    - name : Upload coverage to Codecov
+      if: ${{ matrix.node-version == '12.x' }}
+      uses: codecov/codecov-action@v2
+      with:
+        files: ./coverage/lcov.info
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: pnpm/action-setup@v2.2.2
+      with:
+        version: 6
+    - uses: actions/setup-node@v2
+      with:
+        node-version: 16.x
+    - run: pnpm i --no-optional --no-frozen-lockfile
+    - run: pnpm run lint

.gitignore

@@ -1,7 +1,6 @@
 # Logs
 logs
-*.log
-npm-debug.log*
+*debug.log*
 
 # Runtime data
 pids
@@ -31,7 +30,6 @@ dist/
 node_modules
 
 Factorio*
-factorio*
 /factorio
 /instances
 /sharedMods
@@ -40,9 +38,9 @@ factorio*
 /config-master.json
 /config-control.json
 /config-slave.json
-package-lock.json
+pnpm-lock.yaml
 mod_cache.json
-static/export
+/static/
 saves
 /temp/
 

.travis.yml

@@ -1,15 +0,0 @@
-language: node_js
-node_js:
-  - 10
-before_install:
-  - curl -o factorio.tar.gz -L https://www.factorio.com/get-download/latest/headless/linux64
-  - tar -xf factorio.tar.gz
-  - npm install -g codecov
-script:
-  - npx lerna bootstrap --no-ci
-  - node packages/lib/build_mod --source-dir packages/slave/lua/clusterio_lib --output-dir temp/test/sharedMods
-  - curl -o temp/test/sharedMods/subspace_storage_1.99.8.zip -L https://github.com/clusterio/factorioClusterioMod/releases/download/1.99.6/subspace_storage_1.99.8.zip
-  - npx lerna run build
-  - npm run-script ci-cover
-  - codecov -f coverage/lcov.info
-  - npm run-script lint

CHANGELOG.md

@@ -19,6 +19,7 @@
 - Packaged and uploaded to npm again, greatly simplifying distribution and installation of both Clusterio and plugins.
 - Added centralized logging for the cluster.
   All logs from both Clusterio and Factorio is stored in a shared log which can be inspected and queried.
+- Added remote save management with the ability to list, create, rename, copy, upload, download, transfer, delete and load saves for instances.
 
 ### Features
 
@@ -43,6 +44,7 @@
 - Added an overview of the installed plugins to the web interface.
 - Added clusterioctl command to list plugins on the master server.
 - Added Player Auth plugin for logging in to the web interface by proving the ability to log in to a server as a given user.
+- Added Node.js based installer to simplify setting up a cluster.
 
 ### Changes
 
@@ -76,6 +78,7 @@
   UPS statistics is exported by the statistics exporter plugin.
 - Master server now defaults to hosting on https on port 8443.
 - Renamed client to slave.
+- Removed rotation of factorio-current.log files.
 
 ### Breaking Changes
 
@@ -83,7 +86,6 @@
   Breaks playerManager.
 - The masterIP and masterPort config entries has been merged into masterURL.
   Breaks discordChat, playerManager, serverSelect, trainTeleports and clusterioModel.
-- Instance names can no longer be invalid Windows file names.
 - Removed config management from the command line and the server manager.
 - Moved ejs templates into views folder and changed their extension to .ejs.
   Breaks playerManager.
@@ -140,6 +142,7 @@
 - Renamed clusterioMod plugin to subspace_storage.
 - Master no longer creates secret-api-token.txt.
 - Removed automatic creation of self-signed TLS certificate.
+- Node.js versions below 12 are no longer supported.
 
 
 ## Version 1.2.4
@@ -183,8 +186,8 @@
 - Fixed SIGINT being sent twice to Factorio server when interrupted by CTRL+C on Linux ([#217][#217]).
 - Fixed package.json incorrectly reporting the license as ISC.
 
-[#217]: https://github.com/clusterio/factorioClusterio/issues/217
-[#229]: https://github.com/clusterio/factorioClusterio/issues/229
+[#217]: https://github.com/clusterio/clusterio/issues/217
+[#229]: https://github.com/clusterio/clusterio/issues/229
 
 ### Breaking Changes
 

Dockerfile

@@ -1,10 +1,9 @@
 FROM node:12 as subspace_storage_builder
 RUN apt update && apt install -y git
 WORKDIR /
-RUN git clone https://github.com/clusterio/factorioClusterioMod.git
-WORKDIR /factorioClusterioMod
-RUN git checkout clusterio-2.0 \
-&& npm install \
+RUN git clone https://github.com/clusterio/subspace_storage.git
+WORKDIR /subspace_storage
+RUN npm install \
 && node build
 
 FROM node:12 as clusterio_builder
@@ -16,18 +15,15 @@ RUN wget -q -O factorio.tar.gz https://www.factorio.com/get-download/latest/head
 # Copy project files into the container
 COPY . .
 
-RUN npm install \
-&& npx lerna bootstrap --hoist
+RUN pnpm install
 
 # Install plugins. This is intended as a reasonable default, enabling plugins to make for fun gameplay.
 # If you want a different set of plugins, consider using this as the base image for your own.
-#RUN npm install @clusterio/plugin-subspace_storage
+#RUN pnpm install @clusterio/plugin-subspace_storage
 #RUN npx clusteriomaster plugin add @clusterio/plugin-subspace_storage
 
-COPY --from=subspace_storage_builder /factorioClusterioMod/dist/ /clusterio/sharedMods/
+COPY --from=subspace_storage_builder /subspace_storage/dist/ /clusterio/sharedMods/
 
-# Build submodules (web UI, libraries, plugins etc)
-RUN npx lerna run build
 # Build Lua library mod
 RUN node packages/lib/build_mod --build --source-dir packages/slave/lua/clusterio_lib \
 && mv dist/* sharedMods/ \
@@ -47,8 +43,7 @@ COPY --from=clusterio_builder /clusterio /clusterio
 WORKDIR /clusterio
 
 # Install runtime dependencies
-RUN npm install --production
-RUN npx lerna bootstrap -- --production --no-optional
+RUN pnpm install --production
 LABEL maintainer "danielv@danielv.no"
 
 FROM frolvlad/alpine-glibc AS clusterio_testing
@@ -59,6 +54,5 @@ COPY --from=clusterio_builder /clusterio /clusterio
 WORKDIR /clusterio
 
 # Install runtime dependencies
-RUN npm install
-RUN npx lerna bootstrap
-RUN npm install chalk semver
+RUN pnpm install
+RUN pnpm install chalk semver

README.md

@@ -4,20 +4,16 @@
 <br/>
 <br/>
 
-# factorioClusterio
+# Clusterio
 
 Discord for development/support/play: https://discord.gg/5XuDkje
 
 ## Important notice
 
-This is the development branch for factorioClusterio 2.0 which is currently undergoing heavy restructuring and refactoring.
-Expect plugins and existing installations to frequently break when using this branch.
-If you don't want to be an alpha tester for 2.0 please use the stable [1.2.x branch][1.2.x] or [latest stable release](https://github.com/clusterio/factorioClusterio/releases/latest).
+Clusterio 2.0 is still in alpha, however the previous stable has been abandoned and is no longer supported.
+Despite being alpha it's reasonably stable now and there's no major breakages expected before a stable release of 2.0.
+If you are starting a new cluster it's highly recommended to use the 2.0 alpha.
 
-Installation instructions below are for the unstable master branch.
-Go to the page for the [1.2.x branch][1.2.x] for instructions on how to install the stable version.
-
-[1.2.x]: https://github.com/clusterio/factorioClusterio/tree/1.2.x
 
 ### Ways to support me/the project:
 
@@ -32,17 +28,17 @@ Go to the page for the [1.2.x branch][1.2.x] for instructions on how to install
 * [Introduction](#introduction)
 * [Features](#features)
 * [Plugins](#plugins)
-* [Ubuntu setup](#ubuntu-setup)
-* [Windows setup](#windows-setup)
-* [MacOS setup](#macos-setup)
-* [Installing Plugins](#installing-plugins)
+* [Installation](#installation)
+  * [Ubuntu setup](#ubuntu-setup)
+  * [Windows setup](#windows-setup)
+  * [MacOS setup](#macos-setup)
+  * [Installing Plugins](#installing-plugins)
 * [Configure Master Server](#configure-master-server)
-  * [Hosting Behind Proxy](#hosting-behind-proxy)
-  * [Setting up an admin account](#setting-up-an-admin-account)
+* [Managing Factorio mods](#managing-factorio-mods)
+* [Setting up shared storage](#setting-up-shared-storage)
 * [Running Clusterio](#running-clusterio)
-  * [Master Server](#master-server)
-  * [Slaves](#slaves)
-  * [Instances](#instances)
+* [Setting up remote slaves](#setting-up-remote-slaves)
+* [Setting up clusterioctl](#setting-up-clusterioctl)
 * [Common problems](#Common-problems)
 
 
@@ -50,7 +46,7 @@ Go to the page for the [1.2.x branch][1.2.x] for instructions on how to install
 
 Clusterio is a clustered Factorio server manager that provides the tooling for implementing cross server interactions in Factorio.
 It was previously best known for implementing cross server transfer and cloud storage of items via teleporter chests.
-But this functionality has been pulled out of Clusterio into its own plugin for Clusterio named [Subspace Storage](https://github.com/clusterio/factorioClusterioMod).
+But this functionality has been pulled out of Clusterio into its own plugin for Clusterio named [Subspace Storage](https://github.com/clusterio/subspace_storage).
 
 By itself Clusterio doesn't change the gameplay in any way, you could even use Clusterio to manage completely vanilla Factorio servers.
 Plugins do the work of modding in the visible changes into the game, see the [Plugins section](#plugins) for ready made plugins you can install into a Clusterio cluster.
@@ -76,123 +72,102 @@ These are the plugins supported and maintained by the Clusterio developers:
 - [Global Chat](/plugins/global_chat/README.md): share the in-game chat between servers.
 - [Research Sync](/plugins/research_sync/README.md): synchronize research progress and technologies unlocked between servers.
 - [Statistics Exporter](/plugins/statistics_exporter/README.md): collect in-game statistics from all the servers and makes it available to the Prometheus endpoint on the master server.
-- [Subspace Storage](https://github.com/clusterio/factorioClusterioMod): Provide shared storage that can transport items between servers via teleport chests.
+- [Subspace Storage](https://github.com/clusterio/subspace_storage): Provide shared storage that can transport items between servers via teleport chests.
 - [Player Auth](/plugins/player_auth/README.md): Provides authentication to the cluster via logging into a Factorio server.
+- [Inventory Sync](/plugins/inventory_sync/README.md): Synchronizes your inventory between servers.
 
 There's also plugins developed and maintained by the community:
 
-- [Discord Bridge](https://github.com/Hornwitser/discord_bridge): Bridges chat between instances and Discord.
+- [Discord Bridge](https://github.com/Hornwitser/discord_bridge) (@hornwitser/discord_bridge): Bridges chat between instances and Discord.
   By Hornwitser.
-- [Server Select](https://github.com/Hornwitser/server_select): In-game GUI for connecting to other server in the cluster.
+- [Server Select](https://github.com/Hornwitser/server_select/tree/clusterio-2.0) (@hornwitser/server_select): In-game GUI for connecting to other server in the cluster.
   Originally by Godmave, ported to 2.0 by Hornwitser.
 
 Want to make your own plugin?
 Check out the documentation on [Writing Plugins](/docs/writing-plugins.md) for where to start.
 
 
-## Ubuntu setup
+## Installation
 
-**Warning**: These instructions are for the unstable master version and is not recommended for use, see [the 1.2.x branch][1.2.x] for how to install the stable version.
+Clusterio runs on Node.js v12 and up, it's distributed via npm and comes with a guided install script.
+If you alread have a recent Node.js installed you can set it up in a new directory with.
 
-Clusterio runs on Node.js v12 and up, and v10.16.0+.
-Node.js itself is not supported on EOL Ubuntu releases so make sure you're on a recent release of Ubuntu.
+    npm init "@clusterio"
 
-Master and all slaves:
+Otherwise see below for OS specific instructions.
 
-    wget -qO - https://deb.nodesource.com/setup_12.x | sudo -E bash -
-    sudo apt install -y nodejs
-    mkdir clusterio
-    cd clusterio
-    npm init -y
-    npm install @clusterio/master @clusterio/slave @clusterio/ctl
-    wget -O factorio.tar.gz https://www.factorio.com/get-download/latest/headless/linux64
-    tar -xf factorio.tar.gz
 
-downloads and installs nodejs, git and clusterio.
-To specify a version, change "latest" in the link to a version number like 0.14.21.
+### Ubuntu setup
+
+1.  Install Node.js v12 or higher.
+    For 20.04 LTS or below the version of Node.js provided by the Ubuntu repos are too old and you will have to use the nodesource PPA, otherwise you may skip the first line.
+
+        wget -qO - https://deb.nodesource.com/setup_14.x | sudo -E bash -
+        sudo apt install nodejs
+
+2.  Log in as the user you wish to install Clusterio as (do not use root), and then create a new directory and run the Clusterio installer:
+
+        mkdir clusterio
+        cd clusterio
+        npm init "@clusterio"
+
+    Make sure to note down the admin authentication token it provides at the end as you will need it later.
+
+3.  Optionally copy the generated systemd service files in `systemd` folder to `/etc/systemd/system/`.
+
 
 **Ubuntu with Docker**
 
-The Docker support for Clusterio is curently broken.
+The Docker support for Clusterio is currently broken.
 If you need it open an issue about it.
 
 <!--
 Clusterio has *very* limited support for using docker.
 
-    sudo docker build -t clusterio --no-cache --force-rm factorioClusterio
+    sudo docker build -t clusterio --no-cache --force-rm clusterio
 
 	sudo docker run --name master -e MODE=master -p 1234:8080 -d -it --restart=unless-stopped danielvestol/clusterio
 
-	sudo docker run --name slave -e MODE=slave -e INSTANCE=world1 -v /srv/clusterio/instances:/factorioClusterio/instances -p 1235:34167 -it --restart=unless-stopped danielvestol/clusterio
+	sudo docker run --name slave -e MODE=slave -e INSTANCE=world1 -v /srv/clusterio/instances:/clusterio/instances -p 1235:34167 -it --restart=unless-stopped danielvestol/clusterio
 
 The -v flag is used to specify the instance directory.
 Your instances (save files etc) will be stored there.
 -->
 
-## Windows setup
+### Windows setup
 
-**Warning**: These instructions are for the unstable master version and is not recommended for use, see [the 1.2.x branch][1.2.x] for how to install the stable version.
+1.  Download and install the latest LTS release from http://nodejs.org.
 
-**Requirements**
+2.  Create a new empty directory for the installation and navigate into it.
+    Open a PowerShell window in this new directory by Shift+Right clicking inside it and choosing "Open PowerShell window here" and then run the following command.
 
-download and install nodeJS 12 from http://nodejs.org.
-Clusterio runs on Node.js v12 and up, and v10.16.0+.
+        npm init "@clusterio"
 
-**Master**
+    Make sure to note down the admin authentication token it provides at the end as you will need it later.
 
-1. Open PowerShell or Command prompt in the directory you want to install to and run the following commands.
+3.  If you chose to use local factorio directory for the Factorio installation then download the Windows 64-bit zip package from https://www.factorio.com/download and extract it to the `factorio` folder in your clusterio installation folder.
+
+
+### MacOS Setup
+
+1.  Install the latest Node.js LTS release from http://nodejs.org or use brew (`brew install node`).
+
+2.  Open Terminal or Command prompt in the directory you want to install to and run the following commands.
 
         mkdir clusterio
         cd clusterio
-        npm init -y
-        npm install @clusterio/master @clusterio/slave @clusterio/ctl
+        npm init "@clusterio"
 
-2. Obtain Factorio by either of these two methods:
+    Make sure to note down the admin authentication token it provides at the end as you will need it later.
 
-    - Via the stand alone version on from their website
+3.  If you chose to use local factorio directory for the Factorio installation you will need to obtain and copy a mac version of Factorio and unpack it to to the `factorio` folder in your clusterio installation folder.
 
-        1.  Create a new folder named "factorio" in the the factorioClusterio folder.
 
-        2.  Download the MS Windows (64-bit zip package) from https://www.factorio.com/download .
+### Installing Plugins
 
-        3.  Open the zip file and drag the folder called "Factorio_x.y.z" into the factorio folder created in step 1.
-
-    - Via steam installation
-
-        1.  Create a new folder named "factorio" in the the factorioClusterio folder.
-
-        2.  Locate the game files by right clicking the game in steam, selecting properties, then Local Files, then Browse local files.
-
-        3.  Go to the parent folder of the folder that Steam opened and copy the Factorio folder into the factorio folder created in step 1.
-
-## MacOS Setup
-
-**Requirements**
-
-download and install nodeJS 12 from http://nodejs.org or brew (`brew install node`).  Clusterio runs on Node.js v12 and
-up, and v10.16.0+.
-
-1. Open Terminal or Command prompt in the directory you want to install to and run the following commands.
-
-    ```bash
-    mkdir clusterio
-    cd clusterio
-    npm init -y
-    npm install @clusterio/master @clusterio/slave @clusterio/ctl
-    ```
-
-2. Obtain Factorio:
-
-Install Factorio and copy the factorio.app/Contents in your clusterio install folder as factorio.
-If you installed factorio on your mac you can run
-```bash
-    cp -r /Applications/factorio.app/Contents/ factorio
-```
-
-## Installing Plugins
-
-Installing plugins to make them work with Clusterio consists of two steps.
-First install the package via npm, for example
+For well known plugins you can select them during installation and no further steps are necessary to make them work.
+Installing plugins that are not offered by the installer consists of two steps.
+First install the package the plugin is provided by via npm, for example
 
     npm install @clusterio/plugin-subspace_storage
 
@@ -202,7 +177,7 @@ Then tell clusterio that this plugin exists by adding it as a plugin.
 
 This adds it to the default `plugin-list.json` file which in the shared folder setup is loaded by master, slave and ctl.
 If you have slaves or ctl installed on separate computers (or directories) then you need to repeat the plugin install process for all of them.
-The clusteriomaster, clusterioslave and clusterioctl commands has the plugin sub-command so you do not need to install clusteriomaster to add plugins.
+The clusteriomaster, clusterioslave and clusterioctl commands has the plugin sub-command so you do not need to install clusteriomaster to add plugins, instead use the clusterio command you have available.
 
 For development purposes the `plugin add` command supports adding plugins by the absolute path to them, or a relative path that must start with either . or .. (which will then be resolved to an absolute path).
 
@@ -214,6 +189,11 @@ You can change the port used with the command
 
     npx clusteriomaster config set master.http_port 1234
 
+When changing the port you will also need to change the address slaves connect with.
+For the standalone installation mode you can use
+
+    npx clusterioslave config set slave.master_url http://localhost:1234/
+
 If you plan to make your cluster available externally set the address
 that it will be accessible under with, for example
 
@@ -226,67 +206,63 @@ You can list the config of the master server with the `npx clusteriomaster confi
 See the [readme for @clusterio/master](/packages/master/README.md) for more information.
 
 
-### Setting up an admin account
+## Managing Factorio mods
 
-Before you can manage the cluster you need to bootstrap an admin account for it.
-Replace `<username>` with your Factorio username (do not make up a new username here).
+Clusterio currently only provides a manual method for running mods on servers by copying them either to each instance's individual `mods` folder, or by copying them into a slave installation's `sharedMods` folder which will link/copy them to the `mods` folder of each instance on that slave if the file doesn't already exist in the `mods` folder for that instance.
+Mods are copied from `sharedMods` on Windows and symlinked on Linux, this means that when mods are removed from `sharedMods` the mods will also be removed from the instance's `mods` folder on Linux if it got there by being linked by Clusterio, but not on Windows.
 
-    npx clusteriomaster bootstrap create-admin <username>
-    npx clusteriomaster bootstrap create-ctl-config <username>
+For managing the mod settings the `mod-settings.dat` and `mod-list.json` files will also be linked/copied over if present in `sharedMods`, but since Factorio creates these files automatically it might be necessary to delete them from each instance's `mods` folder for changes to them in `sharedMods` to take effect.
 
-The first command creates a user account with the given name and promotes it to a cluster admin.
-The second one sets up a `config-control.json` config for clusterioctl to connect to the master server under the given user account.
+Better remote management of mods is a planned feature.
+
+
+## Setting up shared storage
+
+The chests teleporting items to and from the shared storage on the master server has been moved into the Subspace Storage mod and plugin.
+To get this to work you will need to install the Subspace Storage plugin and copy the [Subspace Storage mod](https://mods.factorio.com/mod/subspace_storage) and the [Clusterio Lib mod](https://mods.factorio.com/mod/clusterio_lib) into the `sharedMods` folder on each slave installation.
+
+Do not install the [Clusterio mod](https://mods.factorio.com/mod/clusterio), this was for the old 1.2.x version of Clusterio and is not compatible with Clusterio 2.0.
 
 
 ## Running Clusterio
 
-After following the installation and master configuration instructions you can use the following commands to run Clusterio.
+After completing the installation start up the master server and at least one slave separately.
+The installer provides the `run-master` and `run-slave` scripts to make this simple.
+Once the master process is running you can log into the web interface which is hosted by default on http://localhost:8080/ (adjust the port number if you changed it), use the admin authentication token provided from the installation to log in.
+
+The basics of setting up a Factorio server from the web interface is to create an instance, assign it to a slave and then click start.
+
+### Running via Systemd
+
+The install script creates systemd service scripts for clusteriomaster and clusterioslave (if applicable) to start up as the user than ran the installer.
+If you have copied these files over to `/etc/systemd/system/` then you can startup clusterio as a background service using:
+    
+#### To start as a service run:
+ 
+    sudo systemctl start clusteriomaster # for the master server
+    sudo systemctl start clusterioslave # for each server hosting a slave
+
+#### To automatically get it to start on boot:
+ 
+    sudo systemctl enable clusteriomaster # for the master server
+    sudo systemctl enable clusterioslave # for each server hosting a slave
 
 
-### Master Server
+## Setting up remote slaves
 
-It's necessary to run the master server in order for anything to work.
-Once you've completed the setup run the following command to start it up:
-
-    npx clusteriomaster run
+Run the installer as described in the installation section and choose "Slave only" as the operating mode to install, it'll ask for a master URL and an authentication token.
+The URL is the same as what is needed to connect to the web interface, and the athentication token can be generated on the Slaves page in the web interface.
+Once you start up the slave it should show up in the Slaves list and be available for assigning and running instances on.
 
 
-### Slaves
+## Setting up clusterioctl
 
-Slaves connect to the master server and are managed remotely from the master server.
-In order for slaves to connect to the master server they need a valid authentication token, you can create a slave config with a valid token with the following command.
+There's a command line interface available for Clusterio which is installed separately with the same installer as for the master and slave.
+Run the installer as described in the installation section and choose "Ctl only" as the operating mode to install, you can do this in the same directory as you have installed other clusterio component(s) to.
+The installer will ask for a master URL and an authentication token, these are the same as you would use to connect to the web interface.
+If you want to use a different user for the command line interface you can generate an authentication token for an existing user with
 
-    npx clusterioctl slave create-config --name Local --generate-token
-
-This will write a new `config-slave.json` file in the current directory (you can change the location with the `--output` option) with the name, token and url to connect to the master server with.
-If you are making the config for a remote slave you will need to have set the `master.external_address` option to the URL the master server can be reached on.
-
-You can list the config of a slave on the slave itself with the `npx clusterioslave config list` command.
-See the [readme for @clusterio/slave](/packages/slave/README.md) for more information.
-
-Once the config is set up run the slave with
-
-    npx clusterioslave run
-
-
-### Instances
-
-Instances are created, managed and started from the master server.
-For now the only interface available is the `clusterioctl` command line tool included in Clusterio.
-You can run this tool from any slave, or the master server without having to set up a config, if you want to manage the cluster from somewhere else you will need to set the `control.master_url` and `control.master_token` options with the  `node clusterioctl control-config set` command:
-
-The basic operations to start a new instance is the following
-
-    npx clusterioctl instance create "My instance"
-    npx clusterioctl instance assign "My instance" "Local"
-    npx clusterioctl instance start "My instance"
-
-The first line creates the instance configuration on the master server.
-The second assigns the instance to a slave which creates the instance directory and files needed to run the instance on the given slave.
-The third line starts the instance, which creates a new save if there are no save games present.
-
-There are many more commands available with clusterioctl.
-See the [Managing a Cluster](/docs/managing-a-cluster.md) document or `npx clusterioctl --help` for a full list of them.
+    npx clusteriomaster bootstrap generate-user-token <username>
 
 
 ## Common problems

docs/assets/WsClientConnector.svg

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="1000px" height="840px" viewBox="-0.5 -0.5 1000 840" style="background-color: rgb(238, 243, 250);"><defs/><g><rect x="40" y="550" width="320" height="250" fill="none" stroke="#000000" stroke-dasharray="3 3" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe flex-end; justify-content: unsafe flex-start; width: 318px; height: 1px; padding-top: 547px; margin-left: 42px;"><div style="box-sizing: border-box; font-size: 0; text-align: left; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">connected</div></div></div></foreignObject><text x="42" y="547" fill="#000000" font-family="Helvetica" font-size="12px">connected</text></switch></g><rect x="780" y="40" width="180" height="150" fill="#cedbee" stroke="none" pointer-events="all"/><path d="M 300 750 L 300 730 L 440 730 L 440 140 L 376.37 140" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 371.12 140 L 378.12 136.5 L 376.37 140 L 378.12 143.5 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 723px; margin-left: 346px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 11px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: nowrap; ">yes</div></div></div></foreignObject><text x="346" y="726" fill="#000000" font-family="Helvetica" font-size="11px" text-anchor="middle">yes</text></switch></g><rect x="520" y="490" width="440" height="310" fill="none" stroke="#000000" stroke-dasharray="3 3" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe flex-end; justify-content: unsafe flex-start; width: 438px; height: 1px; padding-top: 487px; margin-left: 522px;"><div style="box-sizing: border-box; font-size: 0; text-align: left; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">resuming</div></div></div></foreignObject><text x="522" y="487" fill="#000000" font-family="Helvetica" font-size="12px">resuming</text></switch></g><rect x="40" y="210" width="380" height="300" fill="none" stroke="#000000" stroke-dasharray="3 3" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe flex-end; justify-content: unsafe flex-start; width: 378px; height: 1px; padding-top: 207px; margin-left: 42px;"><div style="box-sizing: border-box; font-size: 0; text-align: left; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">connecting</div></div></div></foreignObject><text x="42" y="207" fill="#000000" font-family="Helvetica" font-size="12px">connecting</text></switch></g><path d="M 120 150 L 120 223.63" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 120 228.88 L 116.5 221.88 L 120 223.63 L 123.5 221.88 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 191px; margin-left: 151px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 11px; font-family: Helvetica; coLine truncated

docs/assets/WsServerConnector.svg

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="919px" height="620px" viewBox="-0.5 -0.5 919 620" style="background-color: rgb(238, 243, 250);"><defs/><g><rect x="40" y="260" width="320" height="300" fill="none" stroke="#000000" stroke-dasharray="3 3" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe flex-end; justify-content: unsafe flex-start; width: 318px; height: 1px; padding-top: 257px; margin-left: 42px;"><div style="box-sizing: border-box; font-size: 0; text-align: left; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">connected</div></div></div></foreignObject><text x="42" y="257" fill="#000000" font-family="Helvetica" font-size="12px">connected</text></switch></g><rect x="700" y="40" width="180" height="150" fill="#cedbee" stroke="none" pointer-events="all"/><path d="M 280 390 L 280 370 L 380 370 L 380 130 L 346.37 130" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 341.12 130 L 348.12 126.5 L 346.37 130 L 348.12 133.5 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 360px; margin-left: 291px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 11px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: nowrap; ">yes</div></div></div></foreignObject><text x="291" y="363" fill="#000000" font-family="Helvetica" font-size="11px" text-anchor="middle">yes</text></switch></g><rect x="420" y="190" width="160" height="160" fill="none" stroke="#000000" stroke-dasharray="3 3" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe flex-end; justify-content: unsafe flex-start; width: 158px; height: 1px; padding-top: 187px; margin-left: 422px;"><div style="box-sizing: border-box; font-size: 0; text-align: left; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">resuming</div></div></div></foreignObject><text x="422" y="187" fill="#000000" font-family="Helvetica" font-size="12px">resuming</text></switch></g><path d="M 120 140 L 120 273.63" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 120 278.88 L 116.5 271.88 L 120 273.63 L 123.5 271.88 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 194px; margin-left: 151px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 11px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: nowrap; ">ready()</div></div></div></foreignObject><text x="151" y="197" fill="#000000" font-family="Helvetica" font-size="11px" text-anchor="middle">ready()</text></switch></g><rect x="40" y="80" width="320" height="80" fill="none" stroke="#000000" stroke-dasharray="3 3" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe flex-end; justify-content: unsafe flex-start; width: 318px; height: 1px; padding-top: 77px; margin-left: 42px;"><div style="box-sizing: border-box; font-size: 0; text-align: left; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #00Line truncated

docs/assets/connection_flow.dot

@@ -1,20 +0,0 @@
-digraph "Client Connection Flow" {
-    node [shape=box];
-    graph [newrank=true];
-
-    start [label="Start"];
-    wait_hello [label="Wait for hello"];
-    new_session [label="New session"];
-    wait_ready [label="Wait for ready"];
-    connected [label="Connected"];
-    abort [label="Abort"];
-    lost_connection [label="Connection lost or\nunexpectedly closed\nwhile connecting" style="dotted"];
-
-
-    lost_connection -> start [label="Wait random delay"];
-    start -> wait_hello [label="Connect to /api/socket"];
-    wait_hello -> new_session [label="Receive hello"];
-    new_session -> wait_ready [label="Send register_*"];
-    wait_ready -> connected [label="Receive ready"];
-    wait_ready -> abort [label="Connection closed with 4003"];
-}

docs/assets/connection_flow.drawio

@@ -0,0 +1,321 @@
+<mxfile host="Electron" modified="2021-08-30T18:05:06.237Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/14.9.6 Chrome/89.0.4389.128 Electron/12.0.16 Safari/537.36" etag="uzcLt7Oh4qtDsMY9WSdT" compressed="false" version="14.9.6" type="device">
+  <diagram id="GSbHU_PhJe-l3NQpc0X3" name="Connection Flow">
+    <mxGraphModel dx="710" dy="734" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="760" pageHeight="630" background="#EEF3FA" math="0" shadow="0">
+      <root>
+        <mxCell id="GTJXd52-XhRZD3rAr2nm-0" />
+        <mxCell id="GTJXd52-XhRZD3rAr2nm-1" parent="GTJXd52-XhRZD3rAr2nm-0" />
+        <mxCell id="2r3fOvGVNr9_K5ZBoRis-18" value="Client" style="text;html=1;align=left;verticalAlign=middle;resizable=1;points=[];autosize=0;strokeColor=none;fontStyle=1" parent="GTJXd52-XhRZD3rAr2nm-1" vertex="1">
+          <mxGeometry x="440" y="80" width="145" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-1" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="2r3fOvGVNr9_K5ZBoRis-28" target="IKjVovVhkWe_WipwIJL3-0">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="260" y="320.02" />
+              <mxPoint x="260" y="320.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-5" value="receive&lt;br&gt;resume" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;spacingRight=4;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-1">
+          <mxGeometry x="0.086" relative="1" as="geometry">
+            <mxPoint x="-20" y="-6" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-3" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="2r3fOvGVNr9_K5ZBoRis-28" target="IKjVovVhkWe_WipwIJL3-2">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="180" y="320.02" />
+              <mxPoint x="180" y="320.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-26" value="receive&lt;br&gt;register" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;spacingRight=4;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-3">
+          <mxGeometry x="-0.2268" relative="1" as="geometry">
+            <mxPoint x="-20" y="2" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-14" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="2r3fOvGVNr9_K5ZBoRis-28" target="IKjVovVhkWe_WipwIJL3-13">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="40" y="285.02" />
+              <mxPoint x="40" y="580.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-27" value="bad handshake&lt;br&gt;timeout" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-14">
+          <mxGeometry x="-0.6341" y="-2" relative="1" as="geometry">
+            <mxPoint x="28" y="17" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="2r3fOvGVNr9_K5ZBoRis-28" value="Wait for handshake" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=2;" parent="GTJXd52-XhRZD3rAr2nm-1" vertex="1">
+          <mxGeometry x="160" y="270.02000000000004" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="HutjLCx0ygpoBEJLSh69-0" value="Server" style="text;html=1;align=left;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fontStyle=1" parent="GTJXd52-XhRZD3rAr2nm-1" vertex="1">
+          <mxGeometry x="40" y="80" width="50" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="_PUvpjEMIo1z1dIbIUzw-0" value="&lt;p&gt;&lt;span&gt;Connection Flow&lt;/span&gt;&lt;br&gt;&lt;/p&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=left;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=0;fontSize=20;" parent="GTJXd52-XhRZD3rAr2nm-1" vertex="1">
+          <mxGeometry x="40" y="30" width="230" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="fGsjKHM69yN9R0Hf5M05-1" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="fGsjKHM69yN9R0Hf5M05-0" target="IKjVovVhkWe_WipwIJL3-7">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="220" y="180" />
+              <mxPoint x="180" y="180" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="fGsjKHM69yN9R0Hf5M05-0" value="WebSocket Open" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="160" y="119.98" width="120" height="40" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-4" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-0" target="IKjVovVhkWe_WipwIJL3-9">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="300" y="300.02" />
+              <mxPoint x="300" y="300.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-6" value="bad session" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;spacingLeft=4;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-4">
+          <mxGeometry x="-0.429" y="-1" relative="1" as="geometry">
+            <mxPoint x="29" y="-4" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-20" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-0" target="IKjVovVhkWe_WipwIJL3-19">
+          <mxGeometry relative="1" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-29" value="valid" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-20">
+          <mxGeometry x="-0.1944" y="2" relative="1" as="geometry">
+            <mxPoint x="18" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-0" value="Validate resume" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="230" y="340.02" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-21" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-2" target="IKjVovVhkWe_WipwIJL3-18">
+          <mxGeometry relative="1" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-28" value="valid" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-21">
+          <mxGeometry x="-0.2778" relative="1" as="geometry">
+            <mxPoint x="20" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-24" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-2" target="IKjVovVhkWe_WipwIJL3-13">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="60" y="355.02" />
+              <mxPoint x="60" y="560.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-30" value="bad token" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-24">
+          <mxGeometry x="-0.8093" y="1" relative="1" as="geometry">
+            <mxPoint x="29" y="23" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-2" value="Validate register" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="90" y="340.02" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-8" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-7" target="2r3fOvGVNr9_K5ZBoRis-28">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="180" y="260.02" />
+              <mxPoint x="180" y="260.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-7" value="Send hello" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="90" y="199.96" width="120" height="30.02" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-10" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-9" target="2r3fOvGVNr9_K5ZBoRis-28">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="260" y="260.02" />
+              <mxPoint x="260" y="260.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-9" value="Send invalidate" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="230" y="199.96" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-13" value="Close connection" style="rounded=1;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="160" y="550.02" width="120" height="40" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-15" value="Connected" style="rounded=1;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="160" y="480.02" width="120" height="40" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-22" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-18" target="IKjVovVhkWe_WipwIJL3-15">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="180" y="470" />
+              <mxPoint x="180" y="470" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-18" value="Send ready" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="90" y="410.02" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-23" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-19" target="IKjVovVhkWe_WipwIJL3-15">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="260" y="470" />
+              <mxPoint x="260" y="470" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-19" value="Send continue" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="230" y="410.02" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-31" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-37" target="IKjVovVhkWe_WipwIJL3-44">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="630" y="240.02" />
+              <mxPoint x="630" y="240.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-32" value="previous&lt;br&gt;session" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;spacingRight=8;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-31">
+          <mxGeometry x="0.086" relative="1" as="geometry">
+            <mxPoint x="-20" y="-2" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-33" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-37" target="IKjVovVhkWe_WipwIJL3-49">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="550" y="250.02" />
+              <mxPoint x="550" y="250.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-34" value="no&lt;br&gt;session" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;spacingRight=8;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-33">
+          <mxGeometry x="-0.2268" relative="1" as="geometry">
+            <mxPoint x="-20" y="5" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-35" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-37" target="IKjVovVhkWe_WipwIJL3-54">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="440" y="215.02" />
+              <mxPoint x="440" y="570.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-36" value="bad handshake&lt;br&gt;timeout" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-35">
+          <mxGeometry x="-0.6341" y="-2" relative="1" as="geometry">
+            <mxPoint x="35" y="-23" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-37" value="Wait for hello" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=2;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="530" y="199.96000000000006" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-60" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-39" target="IKjVovVhkWe_WipwIJL3-37">
+          <mxGeometry relative="1" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-39" value="WebSocket Open" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="530" y="119.98" width="120" height="40" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-65" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-44" target="IKjVovVhkWe_WipwIJL3-61">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="660" y="360.02" />
+              <mxPoint x="660" y="360.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-44" value="Send resume" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="600" y="270.0199999999999" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-68" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-49" target="IKjVovVhkWe_WipwIJL3-67">
+          <mxGeometry relative="1" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-49" value="Send register" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="460" y="270.0199999999999" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-54" value="Close connection" style="rounded=1;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="530" y="550.02" width="120" height="40" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-55" value="Connected" style="rounded=1;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="530" y="480.0199999999999" width="120" height="40" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-64" value="" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-61" target="IKjVovVhkWe_WipwIJL3-62">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="630" y="390.02" />
+              <mxPoint x="630" y="390.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-73" value="receive&lt;br&gt;invalidate" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-64">
+          <mxGeometry x="0.2133" relative="1" as="geometry">
+            <mxPoint x="-30" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-70" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-61" target="IKjVovVhkWe_WipwIJL3-54">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="700" y="570.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-74" value="bad handshake&lt;br&gt;timeout" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;rotation=90;spacingTop=7;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-70">
+          <mxGeometry x="-0.7644" y="2" relative="1" as="geometry">
+            <mxPoint x="-12" y="29" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-71" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-61" target="IKjVovVhkWe_WipwIJL3-55">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="630" y="450.02" />
+              <mxPoint x="630" y="450.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-75" value="receive&lt;br&gt;continue" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];spacingRight=4;labelBackgroundColor=none;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-71">
+          <mxGeometry x="-0.3167" y="-1" relative="1" as="geometry">
+            <mxPoint x="-19" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-61" value="Wait for continue" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;strokeWidth=2;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="600" y="410.02" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-63" value="" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-62" target="IKjVovVhkWe_WipwIJL3-49">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="550" y="320.02" />
+              <mxPoint x="550" y="320.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-62" value="Invalidate session" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="530" y="340.02" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-69" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-67" target="IKjVovVhkWe_WipwIJL3-54">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="470" y="560.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-77" value="bad handshake&lt;br&gt;timeout" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];rotation=90;labelBackgroundColor=none;spacingBottom=4;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-69">
+          <mxGeometry x="-0.8148" y="1" relative="1" as="geometry">
+            <mxPoint x="12" y="33" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-72" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-67" target="IKjVovVhkWe_WipwIJL3-55">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="550" y="470.02" />
+              <mxPoint x="550" y="470.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-76" value="receive&lt;br&gt;ready" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-72">
+          <mxGeometry x="-0.2389" y="2" relative="1" as="geometry">
+            <mxPoint x="-22" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-67" value="Wait for ready" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;strokeWidth=2;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="460" y="410.02" width="120" height="30" as="geometry" />
+        </mxCell>
+      </root>
+    </mxGraphModel>
+  </diagram>
+</mxfile>

docs/assets/connection_flow.svg

@@ -1,99 +1,3 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
- "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<!-- Generated by graphviz version 2.42.3 (0)
- -->
-<!-- Title: Client Connection Flow Pages: 1 -->
-<svg width="371pt" height="496pt"
- viewBox="0.00 0.00 371.00 496.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
-<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 492)">
-<title>Client Connection Flow</title>
-<polygon fill="white" stroke="transparent" points="-4,4 -4,-492 367,-492 367,4 -4,4"/>
-<!-- start -->
-<g id="node1" class="node">
-<title>start</title>
-<polygon fill="none" stroke="black" points="135,-384 81,-384 81,-348 135,-348 135,-384"/>
-<text text-anchor="middle" x="108" y="-362.3" font-family="Times,serif" font-size="14.00">Start</text>
-</g>
-<!-- wait_hello -->
-<g id="node2" class="node">
-<title>wait_hello</title>
-<polygon fill="none" stroke="black" points="164.5,-297 51.5,-297 51.5,-261 164.5,-261 164.5,-297"/>
-<text text-anchor="middle" x="108" y="-275.3" font-family="Times,serif" font-size="14.00">Wait for hello</text>
-</g>
-<!-- start&#45;&gt;wait_hello -->
-<g id="edge2" class="edge">
-<title>start&#45;&gt;wait_hello</title>
-<path fill="none" stroke="black" d="M108,-347.8C108,-336.16 108,-320.55 108,-307.24"/>
-<polygon fill="black" stroke="black" points="111.5,-307.18 108,-297.18 104.5,-307.18 111.5,-307.18"/>
-<text text-anchor="middle" x="187.5" y="-318.8" font-family="Times,serif" font-size="14.00">Connect to /api/socket</text>
-</g>
-<!-- new_session -->
-<g id="node3" class="node">
-<title>new_session</title>
-<polygon fill="none" stroke="black" points="161,-210 55,-210 55,-174 161,-174 161,-210"/>
-<text text-anchor="middle" x="108" y="-188.3" font-family="Times,serif" font-size="14.00">New session</text>
-</g>
-<!-- wait_hello&#45;&gt;new_session -->
-<g id="edge3" class="edge">
-<title>wait_hello&#45;&gt;new_session</title>
-<path fill="none" stroke="black" d="M108,-260.8C108,-249.16 108,-233.55 108,-220.24"/>
-<polygon fill="black" stroke="black" points="111.5,-220.18 108,-210.18 104.5,-220.18 111.5,-220.18"/>
-<text text-anchor="middle" x="155.5" y="-231.8" font-family="Times,serif" font-size="14.00">Receive hello</text>
-</g>
-<!-- wait_ready -->
-<g id="node4" class="node">
-<title>wait_ready</title>
-<polygon fill="none" stroke="black" points="167.5,-123 48.5,-123 48.5,-87 167.5,-87 167.5,-123"/>
-<text text-anchor="middle" x="108" y="-101.3" font-family="Times,serif" font-size="14.00">Wait for ready</text>
-</g>
-<!-- new_session&#45;&gt;wait_ready -->
-<g id="edge4" class="edge">
-<title>new_session&#45;&gt;wait_ready</title>
-<path fill="none" stroke="black" d="M108,-173.8C108,-162.16 108,-146.55 108,-133.24"/>
-<polygon fill="black" stroke="black" points="111.5,-133.18 108,-123.18 104.5,-133.18 111.5,-133.18"/>
-<text text-anchor="middle" x="164" y="-144.8" font-family="Times,serif" font-size="14.00">Send register_*</text>
-</g>
-<!-- connected -->
-<g id="node5" class="node">
-<title>connected</title>
-<polygon fill="none" stroke="black" points="92,-36 0,-36 0,0 92,0 92,-36"/>
-<text text-anchor="middle" x="46" y="-14.3" font-family="Times,serif" font-size="14.00">Connected</text>
-</g>
-<!-- wait_ready&#45;&gt;connected -->
-<g id="edge5" class="edge">
-<title>wait_ready&#45;&gt;connected</title>
-<path fill="none" stroke="black" d="M64.78,-86.86C57.71,-82.13 51.29,-76.25 47,-69 43.04,-62.32 41.73,-54.22 41.69,-46.49"/>
-<polygon fill="black" stroke="black" points="45.19,-46.55 42.31,-36.36 38.21,-46.13 45.19,-46.55"/>
-<text text-anchor="middle" x="97.5" y="-57.8" font-family="Times,serif" font-size="14.00">Receive ready</text>
-</g>
-<!-- abort -->
-<g id="node6" class="node">
-<title>abort</title>
-<polygon fill="none" stroke="black" points="198,-36 142,-36 142,0 198,0 198,-36"/>
-<text text-anchor="middle" x="170" y="-14.3" font-family="Times,serif" font-size="14.00">Abort</text>
-</g>
-<!-- wait_ready&#45;&gt;abort -->
-<g id="edge6" class="edge">
-<title>wait_ready&#45;&gt;abort</title>
-<path fill="none" stroke="black" d="M131.28,-86.66C137.25,-81.45 143.3,-75.4 148,-69 153.19,-61.93 157.5,-53.45 160.88,-45.5"/>
-<polygon fill="black" stroke="black" points="164.14,-46.78 164.56,-36.19 157.63,-44.21 164.14,-46.78"/>
-<text text-anchor="middle" x="259.5" y="-57.8" font-family="Times,serif" font-size="14.00">Connection closed with 4003</text>
-</g>
-<!-- lost_connection -->
-<g id="node7" class="node">
-<title>lost_connection</title>
-<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="188.5,-488 27.5,-488 27.5,-435 188.5,-435 188.5,-488"/>
-<text text-anchor="middle" x="108" y="-472.8" font-family="Times,serif" font-size="14.00">Connection lost or</text>
-<text text-anchor="middle" x="108" y="-457.8" font-family="Times,serif" font-size="14.00">unexpectedly closed</text>
-<text text-anchor="middle" x="108" y="-442.8" font-family="Times,serif" font-size="14.00">while connecting</text>
-</g>
-<!-- lost_connection&#45;&gt;start -->
-<g id="edge1" class="edge">
-<title>lost_connection&#45;&gt;start</title>
-<path fill="none" stroke="black" d="M108,-434.95C108,-422.36 108,-407.17 108,-394.35"/>
-<polygon fill="black" stroke="black" points="111.5,-394.24 108,-384.24 104.5,-394.24 111.5,-394.24"/>
-<text text-anchor="middle" x="175.5" y="-405.8" font-family="Times,serif" font-size="14.00">Wait random delay</text>
-</g>
-</g>
-</svg>
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="760px" height="630px" viewBox="-0.5 -0.5 760 630" style="background-color: rgb(238, 243, 250);"><defs/><g><rect x="440" y="80" width="145" height="20" fill="none" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe flex-start; width: 1px; height: 1px; padding-top: 90px; margin-left: 442px;"><div style="box-sizing: border-box; font-size: 0; text-align: left; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; font-weight: bold; white-space: nowrap; ">Client</div></div></div></foreignObject><text x="442" y="94" fill="#000000" font-family="Helvetica" font-size="12px" font-weight="bold">Client</text></switch></g><path d="M 260 300.02 L 260 320 L 260 333.65" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 260 338.9 L 256.5 331.9 L 260 333.65 L 263.5 331.9 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 316px; margin-left: 238px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 11px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: nowrap; ">receive<br />resume</div></div></div></foreignObject><text x="238" y="319" fill="#000000" font-family="Helvetica" font-size="11px" text-anchor="middle">receive...</text></switch></g><path d="M 180 300.02 L 180 320 L 180 333.65" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 180 338.9 L 176.5 331.9 L 180 333.65 L 183.5 331.9 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 318px; margin-left: 158px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 11px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: nowrap; ">receive<br />register</div></div></div></foreignObject><text x="158" y="322" fill="#000000" font-family="Helvetica" font-size="11px" text-anchor="middle">receive...</text></switch></g><path d="M 160 285 L 40 285 L 40 580 L 153.63 580" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 158.88 580 L 151.88 583.5 L 153.63 580 L 151.88 576.5 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 300px; margin-left: 91px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 11px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: nowrap; ">bad handshake<br />timeout</div></div></div></foreignObject><text x="91" y="304" fill="#000000" font-family="Helvetica" font-size="11px" text-anchor="middle">bad handshake...</text></switch></g><rect x="160" y="270.02" width="120" height="30" fill="#ffffff" stroke="#000000" stroke-width="2" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 285px; margin-left: 161px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "Line truncated

docs/assets/connector_states.svg

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="800px" height="440px" viewBox="-0.5 -0.5 800 440" style="background-color: rgb(238, 243, 250);"><defs/><g><path d="M 170 365.02 L 170 385 L 290 385 L 290 371.39" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 290 366.14 L 293.5 373.14 L 290 371.39 L 286.5 373.14 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><path d="M 110 350 L 40 350 L 40 130 L 103.63 130" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 108.88 130 L 101.88 133.5 L 103.63 130 L 101.88 126.5 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><rect x="110" y="335.02" width="100" height="30" fill="#ffffff" stroke="#000000" stroke-width="2" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 98px; height: 1px; padding-top: 350px; margin-left: 111px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">connected</div></div></div></foreignObject><text x="160" y="354" fill="#000000" font-family="Helvetica" font-size="12px" text-anchor="middle">connected</text></switch></g><path d="M 290 335.02 L 290 315 L 180 315 L 180 328.65" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 180 333.9 L 176.5 326.9 L 180 328.65 L 183.5 326.9 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><path d="M 350 335.02 L 350 135 L 216.37 135" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 211.12 135 L 218.12 131.5 L 216.37 135 L 218.12 138.5 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><path d="M 320 335.02 L 320 235 L 216.37 235" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 211.12 235 L 218.12 231.5 L 216.37 235 L 218.12 238.5 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><rect x="270" y="335.02" width="100" height="30" fill="#ffffff" stroke="#000000" stroke-width="2" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 98px; height: 1px; padding-top: 350px; margin-left: 271px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">resuming</div></div></div></foreignObject><text x="320" y="354" fill="#000000" font-family="Helvetica" font-size="12px" text-anchor="middle">resuming</text></switch></g><path d="M 500 149.96 L 500 223.59" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 500 228.84 L 496.5 221.84 L 500 223.59 L 503.5 221.84 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><rect x="460" y="119.96" width="80" height="30" fill="#ffffff" stroke="#000000" stroke-width="2" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 78px; height: 1px; padding-top: 135px; margin-left: 461px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">closed</div></div></div></foreignObject><text x="500" y="139" fill="#000000" font-family="Helvetica" font-size="12px" text-anchor="middle">closed</text></switch></g><path d="M 520 259.96 L 520 280 L 630 280 L 630 266.33" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 630 261.08 L 633.5 268.08 L 630 266.33 L 626.5 268.08 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><path d="M 480 229.96 L 480 190 L 480 156.33" fill="noneLine truncated

docs/assets/generate.sh

@@ -1,4 +0,0 @@
-for x in $(dirname $0)/*.dot; do
-    echo $x
-    dot $x -Tsvg -o ${x/.dot/.svg}
-done

docs/assets/reconnection_flow.dot

@@ -1,23 +0,0 @@
-digraph "Client Reconnection Flow" {
-    node [shape=box];
-    graph [newrank=true];
-
-    reconnect [label="Reconnect"];
-    wait_hello [label="Wait for hello"];
-    resume_session [label="Resume session"];
-    new_session [label="New session" style="dashed"];
-    wait_continue [label="Wait for continue"];
-    connected [label="Connected"];
-    lost_connection [label="Connection lost or\nunexpectedly closed\nwhile reconnecting" style="dotted"];
-    abort [label="Abort"];
-
-    { rank="same"; wait_continue; new_session };
-
-    lost_connection -> reconnect [label="Wait random delay"];
-    reconnect -> wait_hello [label="Connect to /api/socket"];
-    wait_hello -> resume_session [label="Receive hello"];
-    resume_session -> wait_continue [label="Send resume"];
-    wait_continue -> abort [label="Connection closed with 4003"];
-    wait_continue -> new_session [label="Receive invalidate"];
-    wait_continue -> connected [label="Receive ready"];
-}

docs/assets/reconnection_flow.svg

@@ -1,112 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
- "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<!-- Generated by graphviz version 2.42.3 (0)
- -->
-<!-- Title: Client Reconnection Flow Pages: 1 -->
-<svg width="441pt" height="496pt"
- viewBox="0.00 0.00 441.00 496.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
-<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 492)">
-<title>Client Reconnection Flow</title>
-<polygon fill="white" stroke="transparent" points="-4,4 -4,-492 437,-492 437,4 -4,4"/>
-<!-- reconnect -->
-<g id="node1" class="node">
-<title>reconnect</title>
-<polygon fill="none" stroke="black" points="153.5,-384 62.5,-384 62.5,-348 153.5,-348 153.5,-384"/>
-<text text-anchor="middle" x="108" y="-362.3" font-family="Times,serif" font-size="14.00">Reconnect</text>
-</g>
-<!-- wait_hello -->
-<g id="node2" class="node">
-<title>wait_hello</title>
-<polygon fill="none" stroke="black" points="164.5,-297 51.5,-297 51.5,-261 164.5,-261 164.5,-297"/>
-<text text-anchor="middle" x="108" y="-275.3" font-family="Times,serif" font-size="14.00">Wait for hello</text>
-</g>
-<!-- reconnect&#45;&gt;wait_hello -->
-<g id="edge2" class="edge">
-<title>reconnect&#45;&gt;wait_hello</title>
-<path fill="none" stroke="black" d="M108,-347.8C108,-336.16 108,-320.55 108,-307.24"/>
-<polygon fill="black" stroke="black" points="111.5,-307.18 108,-297.18 104.5,-307.18 111.5,-307.18"/>
-<text text-anchor="middle" x="187.5" y="-318.8" font-family="Times,serif" font-size="14.00">Connect to /api/socket</text>
-</g>
-<!-- resume_session -->
-<g id="node3" class="node">
-<title>resume_session</title>
-<polygon fill="none" stroke="black" points="173.5,-210 42.5,-210 42.5,-174 173.5,-174 173.5,-210"/>
-<text text-anchor="middle" x="108" y="-188.3" font-family="Times,serif" font-size="14.00">Resume session</text>
-</g>
-<!-- wait_hello&#45;&gt;resume_session -->
-<g id="edge3" class="edge">
-<title>wait_hello&#45;&gt;resume_session</title>
-<path fill="none" stroke="black" d="M108,-260.8C108,-249.16 108,-233.55 108,-220.24"/>
-<polygon fill="black" stroke="black" points="111.5,-220.18 108,-210.18 104.5,-220.18 111.5,-220.18"/>
-<text text-anchor="middle" x="155.5" y="-231.8" font-family="Times,serif" font-size="14.00">Receive hello</text>
-</g>
-<!-- wait_continue -->
-<g id="node5" class="node">
-<title>wait_continue</title>
-<polygon fill="none" stroke="black" points="178,-123 38,-123 38,-87 178,-87 178,-123"/>
-<text text-anchor="middle" x="108" y="-101.3" font-family="Times,serif" font-size="14.00">Wait for continue</text>
-</g>
-<!-- resume_session&#45;&gt;wait_continue -->
-<g id="edge4" class="edge">
-<title>resume_session&#45;&gt;wait_continue</title>
-<path fill="none" stroke="black" d="M108,-173.8C108,-162.16 108,-146.55 108,-133.24"/>
-<polygon fill="black" stroke="black" points="111.5,-133.18 108,-123.18 104.5,-133.18 111.5,-133.18"/>
-<text text-anchor="middle" x="155" y="-144.8" font-family="Times,serif" font-size="14.00">Send resume</text>
-</g>
-<!-- new_session -->
-<g id="node4" class="node">
-<title>new_session</title>
-<polygon fill="none" stroke="black" stroke-dasharray="5,2" points="433,-123 327,-123 327,-87 433,-87 433,-123"/>
-<text text-anchor="middle" x="380" y="-101.3" font-family="Times,serif" font-size="14.00">New session</text>
-</g>
-<!-- wait_continue&#45;&gt;new_session -->
-<g id="edge6" class="edge">
-<title>wait_continue&#45;&gt;new_session</title>
-<path fill="none" stroke="black" d="M178.05,-105C220.94,-105 275.39,-105 316.94,-105"/>
-<polygon fill="black" stroke="black" points="316.94,-108.5 326.94,-105 316.94,-101.5 316.94,-108.5"/>
-<text text-anchor="middle" x="252.5" y="-111.8" font-family="Times,serif" font-size="14.00">Receive invalidate</text>
-</g>
-<!-- connected -->
-<g id="node6" class="node">
-<title>connected</title>
-<polygon fill="none" stroke="black" points="92,-36 0,-36 0,0 92,0 92,-36"/>
-<text text-anchor="middle" x="46" y="-14.3" font-family="Times,serif" font-size="14.00">Connected</text>
-</g>
-<!-- wait_continue&#45;&gt;connected -->
-<g id="edge7" class="edge">
-<title>wait_continue&#45;&gt;connected</title>
-<path fill="none" stroke="black" d="M61.23,-86.99C53.95,-82.28 47.4,-76.37 43,-69 39.01,-62.33 38.18,-54.22 38.78,-46.49"/>
-<polygon fill="black" stroke="black" points="42.27,-46.77 40.32,-36.36 35.35,-45.72 42.27,-46.77"/>
-<text text-anchor="middle" x="93.5" y="-57.8" font-family="Times,serif" font-size="14.00">Receive ready</text>
-</g>
-<!-- abort -->
-<g id="node8" class="node">
-<title>abort</title>
-<polygon fill="none" stroke="black" points="198,-36 142,-36 142,0 198,0 198,-36"/>
-<text text-anchor="middle" x="170" y="-14.3" font-family="Times,serif" font-size="14.00">Abort</text>
-</g>
-<!-- wait_continue&#45;&gt;abort -->
-<g id="edge5" class="edge">
-<title>wait_continue&#45;&gt;abort</title>
-<path fill="none" stroke="black" d="M131.28,-86.66C137.25,-81.45 143.3,-75.4 148,-69 153.19,-61.93 157.5,-53.45 160.88,-45.5"/>
-<polygon fill="black" stroke="black" points="164.14,-46.78 164.56,-36.19 157.63,-44.21 164.14,-46.78"/>
-<text text-anchor="middle" x="260.5" y="-57.8" font-family="Times,serif" font-size="14.00">Connection closed with 4003</text>
-</g>
-<!-- lost_connection -->
-<g id="node7" class="node">
-<title>lost_connection</title>
-<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="188.5,-488 27.5,-488 27.5,-435 188.5,-435 188.5,-488"/>
-<text text-anchor="middle" x="108" y="-472.8" font-family="Times,serif" font-size="14.00">Connection lost or</text>
-<text text-anchor="middle" x="108" y="-457.8" font-family="Times,serif" font-size="14.00">unexpectedly closed</text>
-<text text-anchor="middle" x="108" y="-442.8" font-family="Times,serif" font-size="14.00">while reconnecting</text>
-</g>
-<!-- lost_connection&#45;&gt;reconnect -->
-<g id="edge1" class="edge">
-<title>lost_connection&#45;&gt;reconnect</title>
-<path fill="none" stroke="black" d="M108,-434.95C108,-422.36 108,-407.17 108,-394.35"/>
-<polygon fill="black" stroke="black" points="111.5,-394.24 108,-384.24 104.5,-394.24 111.5,-394.24"/>
-<text text-anchor="middle" x="175.5" y="-405.8" font-family="Times,serif" font-size="14.00">Wait random delay</text>
-</g>
-</g>
-</svg>

docs/assets/server_flow.dot

@@ -1,21 +0,0 @@
-digraph "Server Connection Flow" {
-    node [shape=box];
-    graph [newrank=true];
-
-    new_connection [label="New connection"];
-    wait_handshake [label="Wait for handshake"];
-    validate_register [label="Validate register"];
-    validate_resume [label="Validate resume"];
-    connected [label="Connected"];
-    close [label="Close connection"];
-
-    new_connection -> wait_handshake [label="Send hello"];
-    wait_handshake -> validate_register [label="Receive register_*"];
-    wait_handshake -> validate_resume [label="Receive resume"];
-    wait_handshake -> close [label="Bad handshake\nTimeout"];
-    validate_register -> close [label="Bad token\nBad register"];
-    validate_register -> connected [label="Valid register:\nSend ready"];
-    validate_resume -> close [label="Bad token\nBad resume"];
-    validate_resume -> wait_handshake [label="Bad session:\nsend invalidate"];
-    validate_resume -> connected [label="Valid resume:\nSend continue"];
-}

docs/assets/server_flow.svg

@@ -1,118 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
- "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<!-- Generated by graphviz version 2.42.3 (0)
- -->
-<!-- Title: Server Connection Flow Pages: 1 -->
-<svg width="603pt" height="335pt"
- viewBox="0.00 0.00 603.00 335.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
-<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 331)">
-<title>Server Connection Flow</title>
-<polygon fill="white" stroke="transparent" points="-4,4 -4,-331 599,-331 599,4 -4,4"/>
-<!-- new_connection -->
-<g id="node1" class="node">
-<title>new_connection</title>
-<polygon fill="none" stroke="black" points="355.5,-327 224.5,-327 224.5,-291 355.5,-291 355.5,-327"/>
-<text text-anchor="middle" x="290" y="-305.3" font-family="Times,serif" font-size="14.00">New connection</text>
-</g>
-<!-- wait_handshake -->
-<g id="node2" class="node">
-<title>wait_handshake</title>
-<polygon fill="none" stroke="black" points="367.5,-240 212.5,-240 212.5,-204 367.5,-204 367.5,-240"/>
-<text text-anchor="middle" x="290" y="-218.3" font-family="Times,serif" font-size="14.00">Wait for handshake</text>
-</g>
-<!-- new_connection&#45;&gt;wait_handshake -->
-<g id="edge1" class="edge">
-<title>new_connection&#45;&gt;wait_handshake</title>
-<path fill="none" stroke="black" d="M290,-290.8C290,-279.16 290,-263.55 290,-250.24"/>
-<polygon fill="black" stroke="black" points="293.5,-250.18 290,-240.18 286.5,-250.18 293.5,-250.18"/>
-<text text-anchor="middle" x="328" y="-261.8" font-family="Times,serif" font-size="14.00">Send hello</text>
-</g>
-<!-- validate_register -->
-<g id="node3" class="node">
-<title>validate_register</title>
-<polygon fill="none" stroke="black" points="136,-138 0,-138 0,-102 136,-102 136,-138"/>
-<text text-anchor="middle" x="68" y="-116.3" font-family="Times,serif" font-size="14.00">Validate register</text>
-</g>
-<!-- wait_handshake&#45;&gt;validate_register -->
-<g id="edge2" class="edge">
-<title>wait_handshake&#45;&gt;validate_register</title>
-<path fill="none" stroke="black" d="M212.45,-216.73C161.73,-212.32 101.57,-203.5 83,-186 72.82,-176.41 68.91,-161.41 67.62,-148.23"/>
-<polygon fill="black" stroke="black" points="71.11,-147.99 67.07,-138.2 64.12,-148.37 71.11,-147.99"/>
-<text text-anchor="middle" x="148.5" y="-167.3" font-family="Times,serif" font-size="14.00">Receive register_*</text>
-</g>
-<!-- validate_resume -->
-<g id="node4" class="node">
-<title>validate_resume</title>
-<polygon fill="none" stroke="black" points="356,-138 224,-138 224,-102 356,-102 356,-138"/>
-<text text-anchor="middle" x="290" y="-116.3" font-family="Times,serif" font-size="14.00">Validate resume</text>
-</g>
-<!-- wait_handshake&#45;&gt;validate_resume -->
-<g id="edge3" class="edge">
-<title>wait_handshake&#45;&gt;validate_resume</title>
-<path fill="none" stroke="black" d="M241.15,-203.81C233.91,-199.14 227.42,-193.3 223,-186 216.09,-174.6 216.09,-167.4 223,-156 225.69,-151.55 229.16,-147.65 233.09,-144.22"/>
-<polygon fill="black" stroke="black" points="235.23,-146.98 241.15,-138.19 231.04,-141.38 235.23,-146.98"/>
-<text text-anchor="middle" x="280" y="-167.3" font-family="Times,serif" font-size="14.00">Receive resume</text>
-</g>
-<!-- close -->
-<g id="node6" class="node">
-<title>close</title>
-<polygon fill="none" stroke="black" points="450.5,-36 313.5,-36 313.5,0 450.5,0 450.5,-36"/>
-<text text-anchor="middle" x="382" y="-14.3" font-family="Times,serif" font-size="14.00">Close connection</text>
-</g>
-<!-- wait_handshake&#45;&gt;close -->
-<g id="edge4" class="edge">
-<title>wait_handshake&#45;&gt;close</title>
-<path fill="none" stroke="black" d="M367.54,-213.17C403.99,-207.82 442.06,-199.24 454,-186 493.43,-142.29 497.55,-103.05 465,-54 461.92,-49.36 458.09,-45.33 453.78,-41.84"/>
-<polygon fill="black" stroke="black" points="455.76,-38.95 445.55,-36.1 451.76,-44.69 455.76,-38.95"/>
-<text text-anchor="middle" x="540.5" y="-123.8" font-family="Times,serif" font-size="14.00">Bad handshake</text>
-<text text-anchor="middle" x="540.5" y="-108.8" font-family="Times,serif" font-size="14.00">Timeout</text>
-</g>
-<!-- connected -->
-<g id="node5" class="node">
-<title>connected</title>
-<polygon fill="none" stroke="black" points="127,-36 35,-36 35,0 127,0 127,-36"/>
-<text text-anchor="middle" x="81" y="-14.3" font-family="Times,serif" font-size="14.00">Connected</text>
-</g>
-<!-- validate_register&#45;&gt;connected -->
-<g id="edge6" class="edge">
-<title>validate_register&#45;&gt;connected</title>
-<path fill="none" stroke="black" d="M34.78,-101.9C28.43,-97.02 22.64,-91.06 19,-84 12.9,-72.14 12.28,-65.51 19,-54 21.52,-49.69 24.78,-45.87 28.5,-42.49"/>
-<polygon fill="black" stroke="black" points="30.9,-45.05 36.66,-36.16 26.61,-39.52 30.9,-45.05"/>
-<text text-anchor="middle" x="70" y="-72.8" font-family="Times,serif" font-size="14.00">Valid register:</text>
-<text text-anchor="middle" x="70" y="-57.8" font-family="Times,serif" font-size="14.00">Send ready</text>
-</g>
-<!-- validate_register&#45;&gt;close -->
-<g id="edge5" class="edge">
-<title>validate_register&#45;&gt;close</title>
-<path fill="none" stroke="black" d="M136,-111.34C178.72,-105.47 229.03,-96.29 247,-84 260.03,-75.09 253.43,-63.55 266,-54 277.12,-45.55 290.27,-39.13 303.66,-34.26"/>
-<polygon fill="black" stroke="black" points="305.06,-37.48 313.42,-30.97 302.83,-30.84 305.06,-37.48"/>
-<text text-anchor="middle" x="311" y="-72.8" font-family="Times,serif" font-size="14.00">Bad token</text>
-<text text-anchor="middle" x="311" y="-57.8" font-family="Times,serif" font-size="14.00">Bad register</text>
-</g>
-<!-- validate_resume&#45;&gt;wait_handshake -->
-<g id="edge8" class="edge">
-<title>validate_resume&#45;&gt;wait_handshake</title>
-<path fill="none" stroke="black" d="M321.89,-138.33C327.98,-143.2 333.53,-149.09 337,-156 342.98,-167.92 342.98,-174.08 337,-186 335.05,-189.89 332.44,-193.45 329.44,-196.69"/>
-<polygon fill="black" stroke="black" points="326.86,-194.32 321.89,-203.67 331.61,-199.46 326.86,-194.32"/>
-<text text-anchor="middle" x="395.5" y="-174.8" font-family="Times,serif" font-size="14.00">Bad session:</text>
-<text text-anchor="middle" x="395.5" y="-159.8" font-family="Times,serif" font-size="14.00">send invalidate</text>
-</g>
-<!-- validate_resume&#45;&gt;connected -->
-<g id="edge9" class="edge">
-<title>validate_resume&#45;&gt;connected</title>
-<path fill="none" stroke="black" d="M223.7,-112.81C197.28,-107.96 167.61,-99.33 144,-84 129.91,-74.85 132.49,-66.26 121,-54 117.46,-50.23 113.56,-46.43 109.61,-42.79"/>
-<polygon fill="black" stroke="black" points="111.86,-40.11 102.07,-36.06 107.2,-45.33 111.86,-40.11"/>
-<text text-anchor="middle" x="195.5" y="-72.8" font-family="Times,serif" font-size="14.00">Valid resume:</text>
-<text text-anchor="middle" x="195.5" y="-57.8" font-family="Times,serif" font-size="14.00">Send continue</text>
-</g>
-<!-- validate_resume&#45;&gt;close -->
-<g id="edge7" class="edge">
-<title>validate_resume&#45;&gt;close</title>
-<path fill="none" stroke="black" d="M336.9,-101.98C345.46,-97.2 353.66,-91.27 360,-84 369.17,-73.47 374.56,-58.96 377.7,-46.32"/>
-<polygon fill="black" stroke="black" points="381.18,-46.78 379.85,-36.27 374.33,-45.32 381.18,-46.78"/>
-<text text-anchor="middle" x="418" y="-72.8" font-family="Times,serif" font-size="14.00">Bad token</text>
-<text text-anchor="middle" x="418" y="-57.8" font-family="Times,serif" font-size="14.00">Bad resume</text>
-</g>
-</g>
-</svg>

docs/configuration.md

@@ -86,19 +86,20 @@ Defaults to null which means generate a secure secret on startup.
 ### master.heartbeat_interval
 
 Interval in seconds heartbeats are sent out at for WebSocket connections.
-If a connection hasn't received a heartbeat in 2 times the heartbeat interval it will be considered stale and closed.
+If a WebSocket connection hasn't received a heartbeat in 2 times the heartbeat interval it will be considered stale and closed.
 A lower value means less time between connections going stale and them being closed.
 
-Defaults to 45.
+Defaults to 15.
 
 
-### master.connector_shutdown_timeout
+### master.session_timeout
 
-Timeout in seconds to use while shutting down the master server for link sessions that currently don't have an active connection and haven't been closed down properly.
-This happens when the network between a slave and the master server goes down unexpectedly, or the slave goes down without closing the connection properly either do to crashing or the machine it's hosted on going down.
-If the timeout expires the session is terminated and data loss may occur, if the slave went down this is unavoidable.
+Time in seconds from the connection is closed following a heartbeat timeout until the session is invalidated and data loss occurs.
+A higher timeout gives more time for a client to recconect and resume an active session over a connection that was dropped, but also leads to stale connections taking longer to clear out.
+In the case of the master or client crashing the data loss is unavoidable.
 
-Defaults to 30.
+Value should not be less than the configured `max_reconnect_delay` of the clients and it should be greater than 2 times `master.heartbeat_interval`.
+Defaults to 60.
 
 
 ### master.metrics_timeout
@@ -109,6 +110,14 @@ This should be less than both the timeout and collection interval configured for
 Defaults to 8.
 
 
+### master.stream_timeout
+
+Timeout in seconds for proxy streams through the master that has been created but is not yet sending data to be automatically closed.
+Streams that have started sending data before this timeout is not affected.
+
+Defaults to 15.
+
+
 ### master.default_role_id
 
 Role to automatically grant to new users.
@@ -189,12 +198,12 @@ This is used by plugins like Server Select to give the correct address to switch
 Defaults to "localhost".
 
 
-### slave.reconnect_delay
+### slave.max_reconnect_delay
 
-Delay in seconds to wait after connection to the master server is dropped before attempting to reconnect to it.
-The actual delay on each reconnect will be a random number between 0 and this configured value to avoid all slaves trying to reconnect at the same time.
+Maximum delay in seconds to wait after connection to the master server is dropped before attempting to reconnect to it.
+The actual delay on each reconnect will be a random number between 0 and this configured value to avoid all clients trying to reconnect at the same time.
 
-Defaults to 5.
+Defaults to 60.
 
 
 ## Instance Configuration
@@ -262,6 +271,19 @@ If null a random secure password is generated and used each time the instance st
 Defaults to null.
 
 
+### player_online_autosave_slots
+
+Keeps a separate pool for autosaves where at least on player has been online since the previous autosave was done.
+This requires regular autosaving to be enabled and will rename autosaves to `_autosave_poN.zip` (where N is a slot number) whenever a player has been online for that save.
+The slot numbers start at 1, are incremented by 1 after each autosave that is renamed and reset back to 1 whenever this value is exceeded.
+Note that this value should be set to a higher value than the value of `autosave_slots` in `factorio.settings`.
+Useful for preventing the loss of all progress when nobody is around on always online servers with auto pause disabled.
+
+If 0 no autosave renaming takes place.
+
+Defaults to 5.
+
+
 ### factorio.enable_save_patching
 
 Whether to use save patching or not.
@@ -391,8 +413,9 @@ If you have a self signed certificate on the master server you will need to copy
 Defaults to null meaning use Node.js's default set of trusted certificate authorities.
 
 
-### control.reconnect_delay
+### control.max_reconnect_delay
 
-Duration in seconds to wait before attempting to reconnect with the master server after the connection is dropped.
+Max duration in seconds to wait before attempting to reconnect with the master server after the connection is dropped.
+The actual delay on each reconnect will be a random number between 0 and this configured value to avoid all clients trying to reconnect at the same time.
 
-Defaults to 2.
+Defaults to 60.

docs/contributing.md

@@ -41,7 +41,7 @@ If you already cloned the main GitHub repository you can change your clone to po
 
 To keep your local repository up to to date with the main repository add the main repository as a remote.
 
-    git remote add upstream https://github.com/clusterio/factorioClusterio
+    git remote add upstream https://github.com/clusterio/clusterio
 
 After this running `git fetch upstream` will get the updated branches from the main repository.
 Do not run `git pull upstream` it will mess thing up!
@@ -49,20 +49,51 @@ Do not run `git pull upstream` it will mess thing up!
 
 ### Setting up the Development Environment
 
-The project is organized into several packages that are all managed through Lerna.
-In order to get the development environment up and running you will need to run the following commands:
+The project is organized into several packages that are all tied together using pnpm's workspace feature.
+In order to get the development environment up and running you will need to run the following command:
 
-    npm install
-    npx lerna bootstrap
+    pnpm install
 
 This installs dependencies needed by tests and links the packages up so they work from the git work tree.
+To start a cluster from the repo you will first need to initialize it, this can be done using the installer:
+
+    node packages/create --dev
+
+To add plugins to use in the development environment use
+
+    node packages/ctl plugin add ./path/to/plugin
+
+It's important that the path starts with `./`.
+The `plugins/` directory contains the core plugins for the project and can be added using the above mentioned command.
+
+The documentation uses the binaries provided by the packages, but for the development environment you will need to call the packages directly:
+
+    npx clusteriomaster -> node packages/master
+    npx clusterioslave -> node packages/slave
+    npx clusterioctl -> node packages/ctl
+
+Note that to use `clusterioctl` you will have to create a control config first:
+
+    node packages/master bootstrap create-ctl-config [admin-user]
+
+Once you've set up the cluster you can use `node packages/master run` to run the master server and `node packages/slave run` to run the slave which connects to the master server.
+
+For web development on the master there are also the following flags:
+
+`--dev` - Recompile the `web_ui` package on the fly providing live reloading of it.
+
+`--dev-plugin [name]` - Recompile the web module for the given plugin on the fly proving live reloading of it.
+
+These options can be combined and multiple plugins can be actived for dev mode.
+Keep in mind if you're working on external plugins the `--dev-plugin` option is likely to only work if the plugin is placed inside the `external_plugins` directory and its dependencies are installed with pnpm as part of the clusterio repository workspace.
+Note that webpack is configured to delete the web interface build when using these options, so you will have to run `pnpm run -r --if-present prepare` before you start the master without these flags again.
 
 
 ### Starting a Feature Branch
 
 Development is done exclusively in feature branches.
-This means the first thing to do before starting any development at all is to make a new branch starting from the master or 1.2.x branch of the main repository.
-To do this check out that branch from the main repository (substitute master for 1.2.x if you're working on that branch).
+This means the first thing to do before starting any development at all is to make a new branch starting from the master branch of the main repository.
+To do this check out that branch from the main repository.
 
     git fetch upstream
     git checkout upstream/master
@@ -81,8 +112,8 @@ But it's nice to have its name be somewhat descriptive of what it implements.
 There's automated tests and linting setup for the project.
 Please do add tests for any code you add and run both:
 
-    npm run test
-    npm run lint
+    pnpm run test
+    pnpm run lint
 
 To check that your changes pass the integration tests as well as the ESLint rules set up for the project.
 
@@ -103,7 +134,7 @@ If there are more changes you want to have merged or mistakes you need to fix yo
 
 Until your feature branch is merged you can edit it as you see fit by using the rebase tool.
 If your feature branch has been merged however it's final and you will have to start a new feature branch and submit that in a new pull request.
-The base usage of rebase assuming you are checked out on your feature branch is the following command (substitute master with 1.2.x if your feature branch is based on that)
+The base usage of rebase assuming you are checked out on your feature branch is the following command
 
     git rebase -i upstream/master
 
@@ -122,7 +153,7 @@ If you have a pull request that has not yet been merged submitted for this featu
 ### Resolving Merge Conflicts
 
 The best way to resolve merge conflicts in feature braches is to rebase it on top of the updated upstream.
-Run the following commands (substitute master with 1.2.x if your feature branch is based on that)
+Run the following commands
 
     git fetch upstream
     git rebase upstream/master
@@ -150,12 +181,12 @@ The format of this log should be self explanatory, please follow it carefully.
 
 ## Supported Node.js and Factorio Versions
 
-Clusterio run on Node.js v12 and up, and v10 from v10.16.0, make sure to check that the Node builtin API's and npm packages you use are supported on these versions.
-The Travis CI tests are runned on whatever version of Node.js v10 is the default, which at the time of writing is v10.18.0.
+Clusterio run on Node.js v12 and up, make sure to check that the Node builtin API's and npm packages you use are supported on these versions.
+The GitHub Actions tests are run on whatever version of Node.js v12, v14, and v16 is the default.
 
 For Factorio Clusterio 2.0 aims to support version 0.17.69 and up, including the latest experimental release.
 It's recommended that you use the lua API reference for 0.17.69, as there's no information on what version Factorio API's were introduced in.
-The Travis CI tests are runned against latest experimental release.
+The GitHub Actions tests are run against the latest experimental release.
 
 
 ## Code Style
@@ -192,9 +223,9 @@ JavaScript template literals may also be used where appropriate.
 
 ### Indenting
 
-JavaScript code should be indented with tabs.
+JavaScript and Lua code should be indented with tabs.
 
-Lua code should be indented with 4 spaces.
+Other files types should prefer tabs for indents where reasonable with the exception of Markdown.
 
 
 ### Line Length
@@ -240,6 +271,8 @@ Headings use the `# heading` format.
 
 ## Pushing releases to npm
 
+***Warning: This workflow is outdated due to lerna having been removed from the project.****
+
 The releases are done by creating a new release tag with lerna and then uploading that with lerna.
 You will need commit access to the repository as well publish access to the @clusterio org on npm to do this.
 

docs/devs/protocol.md

@@ -0,0 +1,268 @@
+# Protocol
+
+Clusterio communicates using a simple homebrew message passing protocol based on JSON over WebSocket with limited support for reliable transport of messages.
+The protocol is implemented in [packages/lib/link](/packages/lib/link) and uses the `ws` library to handle the WebSocket connections on the Node.js side and the native WebSocket API on the browser side.
+
+Two general kinds of messages are supported: events and requests.
+Events are messages sent by one party and received by the other and offer no notification for the sender on whether it was actually received.
+Requests are pairs of request-response messages where one side sends the requests and the other side replies with a response.
+Apart from the handshake used to establish connections the protocol is directionless, and either party can send or receive both requests and events.
+
+Events and requests are defined as instances of the `Request` and `Event` classes, and specify a unique type string, who can send and receive the message, optional forwarding of the message and the format of the data payload as a JSON schema.
+All messages sent and received are validated with JSON schemas to catch potential errors in sending messages and avoid having to write lots of validation code in message handlers.
+
+Messages are sent by calling the `.send()` method of the message instance and passing a `Link` instance to send it over and the data to send.
+For the master server there's a `Link` instance for each slave and control connection stored in the `WsServer` class.
+For slaves the `Slave` instance is a link to the master server, and each `Instance` instance is an in-memory link to the `Slave` instance and has a corresponding `InstanceConnection` link stored on the `Slave` instance.
+For ctl and web_ui there's a `Control` instance that acts as the link to the master server.
+
+Messages received invokes message handlers that were registered when the link was brought up.
+These handlers are named after the name of the property the message is stored under with `EventHandler` appended for events and `RequestHandler` appended for requests.
+The handlers are defined on the link class itself for core messages, and on the plugin class in the case of plugin defined messages.
+
+
+## Connection flow
+
+Clients connect via WebSocket to the `/api/socket` endpoint and upon establishing connection to the server the connection is in the handshake phase and the server will send a `hello` message to the client.
+If the client has no previous session with the server it sends a `register_slave` or `register_control` message depending on what kind of client it is to the server.
+If the register is valid then the server will respond with a `ready` message with a session token and the connection has left the handshake phase, otherwise the server will close the connection with a WebSocket close code indicating the kind of failure.
+
+Upon leaving the handshake phase both parties should start sending heartbeat messages with the sequence number of the last received message.
+Messages sent over the link should be stored in a send buffer and only cleared from the send buffer when a heartbeat with a `last_seq` equal or or higher is received or the session is invalidated.
+
+If the connection goes stale or is unexpectedly closed the client can reastablish the same session by connecting to the server again and sending a `resume` message after received the `hello` from the server.
+If the session resume is successful then the server will respond with a `continue` message and the connection is active again.
+The client should then re-send all messages it has in its send buffer that is greater than the `last_seq` number in the `continue` message.
+Otherwise the server will respond with `invalidate` and the client is expected to drop its send buffer start a new session with `register_slave` or `register_control`.
+
+![Connection flow](../assets/connection_flow.svg)
+
+
+## Connector flow
+
+To manage the complexity of connecting, reconnecting, resuming or invalidating dropped sessions the WebSocket connection for a `Link` class is managed by a connector.
+There's three kinds of connectors defined: `WebSocketClientConnector`, `WebSocketServerConnector` and `VirtualConnector`.
+The virtual connector is for in-memory connections and doesn't have any connection state logic.
+
+For the WebSocket connectors there's four states they can exist in:
+- `closed` - The connector has just been created or has been explicitly closed.
+- `connecting` (client only) - The connector is in the process of trying to connect to the server.
+- `connected` - The connector is successfully connected.
+- `resuming` - The connection dropped and the connector is in the process of attempting to resume it.
+
+Along with the following events emitted when transition between states:
+- `connect` From `connecting` (client) or `closed` (server) to `connected`
+- `drop` - From `connected` to `resuming`
+- `resume` - From `resuming` to `connected`
+- `invalidate` - From `resuming` to `connecting` or `closed`
+- `close` - From any state to `closed`
+
+![Conector States](../assets/connector_states.svg)
+
+
+### WsClientConnector
+
+The client connector will keep trying to establish and mantain a connection after `.connect()` is called on it, stopping only in the case of authentication failure or `.close()`/`.setClosing()` being called.
+Other than that, the logic is pretty straight forward.
+
+![WsClientConnector](../assets/WsClientConnector.svg)
+
+
+### WsServerConnector
+
+The server connector doesn't do the work of connecting or validating the handshake.
+Instead it's handed over a WebSocket connection from `WsServer` once there's only the step of sending the final message left to do.
+Because of this there's no `connecting` state, and once a session times out from the `resuming` state it goes directly to closed.
+
+![WsServerConnector](../assets/WsServerConnector.svg)
+
+
+## Wire format
+
+All communication in the protocol is done via WebSocket text frames containing a JSON payload with the following properties:
+
+- `seq: integer | null` - The sequence number of the message, can only be null for handshake and heartbeats.
+- `type: string` - The type of message
+- `data: object` - Message data
+
+Before a connection is established it's in the handshake phase and the `seq` property is `null`.
+The `type` property is used to distinguish which of handshake, heartbeat, events or requests this message is and determines the expected format of the `data` property.
+
+
+### Handshake Messages
+
+The following messages are the only valid messages that can be sent during the handshake phase.
+
+
+#### `hello`
+
+Sent by the master server when the WebSocket connection has been opened.
+
+- `version: string` - The version of the master, e.g. "2.0.0".
+- `plugins: Object<string, string>` -
+    Object mapping plugin names to plugin version for plugins that are loaded on the master server.
+
+#### `register_slave`
+
+Slave handshake for establishing a new connection session.
+
+- `token: string` - Authentication token.
+- `agent: string` - Human readable string of the software connecting.
+- `version: string` - The protocol version of the slave, e.g. "2.0.0".
+- `name: string` - Name of the slave.
+- `id: integer` - ID of the slave.
+- `plugins: Object<string, string>` -
+    Object mapping plugin names to plugin version for plugins that are available on the slave.
+
+#### `register_control`
+
+Control handshake for enstablishing a new connection session.
+
+- `token: string` - Authentication token.
+- `agent: string` - Human readable string of the software connecting.
+- `version: string` - The protocol version of the control, e.g. "2.0.0".
+
+#### `resume`
+
+Handshake for resuming an existing connection session where the connection had dropped unexpectedly.
+
+- `session_token: string` - Session token to resume session with.
+- `last_seq: integer | null` - Last message seq received by the client.
+
+#### `invalidate`
+
+Sent by the master server in reply to a resume for a session that cannot be resumed.
+The client should start a new session with a register\_\* message in response.
+
+#### `continue`
+
+Sent by the master server to signal resuming the session was successful.
+
+- `last_seq: integer | null` - Last message seq received by the server.
+- `session_timeout: integer` - Session timeout in seconds.
+- `heartbeat_interval: number` - Rate client should send heartbeats at.
+
+#### `ready`
+
+Sent by the master server to signal the connection has been established with a new session.
+
+- `session_token: string` - Token to resume the session with.
+- `session_timeout: integer` - Session timeout in seconds.
+- `heartbeat_interval: number` - Rate client should send heartbeats at.
+
+
+### Heartbeat message
+
+Once connected as indicated by the `ready` and `continue` messages both sides of the connection starts sending heartbeats at the inverval given in the `ready` and `continue` messages.
+The heartbeat should contain the `seq` of the last received message, and receiving a heartbeat with a given sequence number means that the other party of the link has received all messages up to that seq number.
+
+
+#### `heartbeat`
+
+Sent by both the master server and clients at the interval given in the continue/ready messages.
+
+- `last_seq: integer` - Last message seq received over the link.
+
+### Events
+
+Events are messages send in one direction over the link, that the receiver is expected to act upon, but not make any replies (for that there's [Requests](#requests).
+By convention message types ending in `*_event` are events.
+The data payload of an event consists solely of event specific properties.
+
+See [packages/lib/link/messages.js](/packages/lib/link/messages.js) for the recognized core events and their contents.
+Plugins may defined their own events as well.
+
+#### `*_event`
+
+- any properties defined by the event type.
+
+
+### Requests
+
+Requests are messages which expects a response in return.
+They function a lot like HTTP requests except that both parties of a connection can inniate a request that is expected to be responded to.
+By convention message types ending in `*_request` are requests, and is expected to be replied to with a corresponding `*_response` message.
+If an error occured while processing the request an error response containing an error property in the data payload is sent instead.
+
+See [packages/lib/link/messages.js](/packages/lib/link/messages.js) for the recognized core requests and their contents.
+Plugins may define their own requests as well.
+
+#### `*_request`
+
+- any properties defined by the request type.
+
+#### `*_response` success
+
+- `seq: integer` - The seq number of the request message.
+- any additional properties defined by the request type.
+
+#### `*_response` error
+
+- `seq: integer` - The seq number of the request message.
+- `error: string` - Human readable text message describing the error.
+
+
+### Graceful Disconnect
+
+To ensure no data is lost when closing the link it's important to send a prepare disconnect request and wait for it to complete before closing the WebSocket.
+Either party of the link can send this request and the party sending the request should be the one that initates the close of the WebSocket.
+
+#### `prepare_disconnect_request`
+
+Request graceful disconnect of the connection.
+The receiving party should stop tasks that send events and requests over the link and wait for pending requests it has over the link to complete, but it should not stop responding to requests sent to it.
+Only after this process is done should the response be sent.
+
+#### `prepare_disconnect_response`
+
+Signals the preparation for disconnect is complete and that the connection can be closed.
+The party that initiatied the prepare disconnect request may still send other requests/events over the link to finish its part of the disconnection proceedure.
+
+If the error response variant is received it should be logged if possible and treated as a success.
+
+
+### Example handshake
+
+Server hello after opening the WebSocket.
+
+```json
+{
+    "seq": null,
+    "type": "hello",
+    "data": {
+        "version": "2.0.0"
+    }
+}
+```
+
+Slave registering a new connection session.
+
+```json
+{
+    "seq": null,
+    "type": "register_slave",
+    "data": {
+        "token": "xyzabc123",
+        "agent": "Clusterio Slave",
+        "version": "2.0.0",
+        "name": "Foo",
+        "id": 123
+    }
+}
+```
+
+Master server reply signaling the session is established and ready.
+
+```json
+{
+    "seq": null,
+    "type": "ready",
+    "data": {
+        "session_token": "xyz.azy.bzy",
+        "session_timeout": 60,
+        "heartbeat_interval": 15
+    }
+}
+```
+
+Slave and master can now send events and requests over the connection.

docs/jsdoc.json

@@ -1,23 +1,25 @@
 {
-    "plugins": [
-        "plugins/markdown"
-    ],
-    "tags": {
-        "allowUnknownTags": false
-    },
-    "opts": {
-        "destination": "docs/api",
-        "recurse": true
-    },
-    "source": {
-        "include": [
-            "packages/master/src/",
-            "packages/master/master.js",
-            "packages/slave/slave.js",
-            "packages/ctl/ctl.js",
-            "packages/lib/",
-            "plugins/"
-        ],
-        "excludePattern": "node_modules"
-    }
+	"plugins": [
+		"plugins/markdown"
+	],
+	"tags": {
+		"allowUnknownTags": false
+	},
+	"opts": {
+		"destination": "docs/api",
+		"recurse": true
+	},
+	"source": {
+		"include": [
+			"packages/master/src/",
+			"packages/master/master.js",
+			"packages/slave/src/",
+			"packages/slave/slave.js",
+			"packages/ctl/src/",
+			"packages/ctl/ctl.js",
+			"packages/lib/",
+			"plugins/"
+		],
+		"excludePattern": "node_modules"
+	}
 }

docs/managing-a-cluster.md

@@ -10,13 +10,86 @@ The easiest way to do this is to run `npx clusteriomaster bootstrap create-ctl-c
 
 ## Slaves
 
-To be written.
+### List slaves
 
+    ctl> slave list
+
+Lists all slaves.
+
+### Generate token
+
+    ctl> slave generate-token [--id <slave id>]
+
+Generate a token for a slave. `--id` is the slave id.
+
+### Create config
+
+    ctl> slave create-config [--id <slave id>] [--name <slave name>] [--generate-token <bool>] [--output <path to output>]
+
+Create a slave config. `--id` id the slave id. `--name` is the slave name. `--generate-token` decides whether to also generate a token, defaulting to `0`. `--output` is the filename for the output of the config; Default is "config-slave.json", "-" for stdout.
 
 ## Instances
 
+### List Instances
+
+    ctl> instance list
+
+List instances.
+
+### Create instance
+
+    ctl> instance create <name> [--id <instance id>]
+
+Create a new instance. `name` is the instance name. `--id` is the optional id.
+
+### Kill instance
+
+    ctl> instance kill <name>
+
+Terminates the running Factorio server without giving it a chance to save or cleanup after itself.
+
+Note: This may cause loss of data.
+
+### Extract players from instance
+
+    ctl> instance extract-players <name>
+
+Creates a user account in the cluster for each player that has been online on the currently running save of the instance and sets the online time of that account on this instance to the online time recorded in the save.
+
+Useful when importing a save to a cluster.
+Note that the online time in a save is recorded differntly from how Clusterio records online time.
+Most notably Clusterio records wall clock time while the save time is recorded in ticks and this extraction of player time assumes the game runs at 60 ticks a second.
+
+
+### Config management
+
+#### List Configuration
+
+    ctl> instance config list <instance>
+
+List config values for an instance. `instance` is the instance whose config values to list.
+
+#### Set config value
+
+    ctl> instance config set <instance> <field> [value] [--stdin]
+
+Set field in instance config. `instance` is instance to set. `field` is field to set. `value` is value to set in field. `--stdin` signals to read value from stdin.
+
+#### Set config property of field
+
 To be written.
 
+#### Edit instance config
+
+    ctl> instance config edit <instance> [editor]
+
+Edit instance config in a text editor. Once file is saved and editor has been exited, config values will be read back in. `instance` is the instance to edit, `editor` is the editor to use. If `editor` is not given, clusterioctl will read from the `EDITOR` or `VISUAL` enviroment variables.
+
+### Assign instance to slave
+
+    ctl> instace assign <instance> [slave]
+
+Assigns instance to slave. `instance` is instance to assign, `slave` is slave to assign to. If `slave` is not provided, instance will be unassigned.
 
 ## Users
 
@@ -74,6 +147,33 @@ Since ban status is a part of the account data the account must exist for this t
 
 Note: This bans the user from logging in to Factorio servers in the cluster, it does not revoke access to any cluster management they might have, see next section on setting roles for revoking tha.
 
+### Bulk importing admin, whitelist and ban lists
+
+Whitelists and admin lists can be bulk imported with the following commands:
+
+    ctl> user whitelist-bulk-import <file> [--create]
+    ctl> user admin-bulk-import <file> [--create]
+
+The file should simply be newline seperated names:
+
+    joe
+    bob
+    allan
+
+The `--create` option will create the user if they do not exist, and then set the relevent value.
+
+Banlists can be bulk imported with the following command:
+    
+    ctl> user banned-bulk-import <file> [--create]
+
+The file should be names, followed by a ban reason:
+
+    joe greifed copper mines
+    bob stole materials
+    allan rude language
+
+The first string on the line is used as the username, the others are used as the ban reason.
+The `--create` option will create the user if they do not exist, then ban them.
 
 ### Set Cluster Roles
 

docs/socket.md

@@ -1,225 +0,0 @@
-# WebSocket protocol
-
-<sub>This document describes the protocol used between the master and slaves, and unless you're developing Clusterio it's probably not going to be very useful for you.</sub>
-The protocol is built on WebSocket and uses JSON encoded text messages to communicate to and from the master server.
-These messages contain a JSON encoded object with the following three properties:
-
-- seq - integer|null - The sequence number of the message
-- type - string - The type of message
-- data - object - Message data
-
-For the handshake and heartbeats the seq property is null.
-
-
-## Handshake
-
-Upon connecting to the WebSocket endpoint the server will respond with a `hello` message containing the master server version as the data.
-The client is then expected to send either `register_*` or a `resume` message to set up the connection with the master.
-The exact flow is described below.
-
-
-### Client connection flow
-
-For a client making a new connecting to the master server the first course of action after obtaining a token is to connect with WebSocket to the /api/socket endpoint and wait for the server hello.
-After the hello, the client sends a register\_\* message corresponding to the type of the client.
-If successful the server will reply with a ready message and the connection has been established.
-See the flowchart below.
-
-![Client connection flowchart](assets/connection_flow.svg)
-
-If for any reason the connection is closed or lost during the connection attempt the process is started over after a random delay, with the exception of the connection being closed with a 4003 code which means authentication failed and the client should stop trying to connect.
-The wait for hello and wait for ready states should also have a timeout, after which the connection is closed if the hello/reply wasn't received
-in time.
-
-
-### Client reconnection flow
-
-If the connection is lost after the client has received the ready message from the server it should attempt a reconnect instead.
-This is very similar to a new connection, but instead of a register\_\* messsage the client sends a resume message and the server replies with a continue message if resuming the session was successful.
-This continue message has sequence number of the last message the master received and the client is expected to imediately send all messages from its send buffer that occured after the sequence number given.
-
-The server will respond with an invalidate message if resuming the session is not possible.
-In this case the client should continue from the new session state of the connection flow (see the previous section).
-
-![Client reconnection flowchart](assets/reconnection_flow.svg)
-
-Like the connection flow the process starts over after a delay if the connection is closed or lost.
-The same exception for connection closed with 4003 applies as with the connection flow.
-Additionally after an invalidate message has been received and the connection flow fails, it should start over from the connection flow.
-
-
-### Server connection flow
-
-From the master server side new connections and reconnection attempts start out the same, a new connection has been made and the server sends the hello messoge to the client.
-If a vaild register\_\* message is received a new connection is set up for the client and the ready message is sent in reply.
-If a valid resume message is received and the session that's attempted to be resumed is active it'll signal that the session is resumed with a continue message and the client upon receiving the continue message should send the messages from its send buffer from after the last\_seq given in the continue message.
-
-If the session token used to resume is not valid it'll send an invalidate message and expect the client to continue with a registr\_\* message.
-If an invalid or unexpected message is received during the handshake the connection is closed.
-See the flowchart below.
-
-![Client connection flowchart](assets/server_flow.svg)
-
-For authentication failure the connection is closed with code 4003, which the connection client should interpret as connecting will never succeed and stop trying to reconnect.
-
-
-### Connection tracking and heartbeats
-
-Once connected as indicated by the ready and continue messages from the master server the client must start sending heartbeats at the interval given in the ready/continue message, and storing messages sent over the link in a sending side buffer.
-The heartbeats sent must have the seq of the last received message on the link and acts as an ack for received messages.
-The master server also sends heartbeats in the same manner and the client should remove messages up to and including the sequence number received in the heartbeat from its send buffer.
-
-
-## Handshake messages
-
-### `hello`
-
-Sent by the master server when the WebSocket connection has been opened.
-
-- version - string - The version of the master, e.g. "2.0.0".
-- plugins - Object&lt;string, string&gt; -
-    Object mapping plugin names to plugin version for plugins that are loaded on the master server.
-
-### `register_slave`
-
-Slave handshake for establishing a new connection session.
-
-- token - string - Authentication token.
-- agent - string - Human readable string of the software connecting.
-- version - string - The protocol version of the slave, e.g. "2.0.0".
-- name - string - Name of the slave.
-- id - integer - ID of the slave.
-- plugins - Object&lt;string, string&gt; -
-    Object mapping plugin names to plugin version for plugins that are available on the slave.
-
-### `register_control`
-
-Control handshake for enstablishing a new connection session.
-
-- token - string - Authentication token.
-- agent - string - Human readable string of the software connecting.
-- version - string - The protocol version of the control, e.g. "2.0.0".
-
-### `resume`
-
-Handshake for resuming an existing connection session where the connection had dropped unexpectedly.
-
-- session_token - string - Session token to resume session with.
-- last_seq - integer|null - Last message seq received by the client.
-
-### `invalidate`
-
-Sent by the master server in reply to a resume for a session that cannot be resumed.
-The client should start a new session with a register\_\* message in response.
-
-### `continue`
-
-Sent by the master server to signal resuming the session was successful.
-
-- last_seq - integer|null - Last message seq received by the server.
-- heartbeat_interval - number - Rate client should send heartbeats at.
-
-### `ready`
-
-Sent by the master server to signal the connection has been established with a new session.
-
-- session_token - string - Token to resume the session with.
-- heartbeat_interval - number - Rate client should send heartbeats at.
-
-### `heartbeat`
-
-Sent by both the master server and clients at the interval given in the continue/ready messages.
-
-- last_seq - integer - Last message seq received over the link.
-
-
-## Example handshake
-
-Server hello after opening the WebSocket.
-
-```json
-{
-    "seq": null,
-    "type": "hello",
-    "data": {
-        "version": "2.0.0"
-    }
-}
-```
-
-Slave registering a new connection session.
-
-```json
-{
-    "seq": null,
-    "type": "register_slave",
-    "data": {
-        "token": "xyzabc123",
-        "agent": "Clusterio Slave",
-        "version": "2.0.0",
-        "name": "Foo",
-        "id": 123
-    }
-}
-```
-
-Master server reply signaling the session is established and ready.
-
-```json
-{
-    "seq": null,
-    "type": "ready",
-    "data": {
-        "session_token": "xyz.azy.bzy",
-        "heartbeat_interval": 45
-    }
-}
-```
-
-
-## Events
-
-Events are messages send in one direction over the link, that the receiver is expected to act upon, but not make any replies (for that there's [Requests](#requests).
-By convention message types ending in `*_event` are events.
-The data payload of an event consists solely of event specific properties.
-
-See [packages/lib/link/messages.js](/packages/lib/link/messages.js) for the recognized events and their contents.
-
-
-## Requests
-
-Requests are messages which expects a response in return.
-They function a lot like HTTP requests except that both parties of a connection can inniate a request that is expected to be responded to.
-By convention message types ending in `*_request` are requests, and is expected to be replied to with a corresponding `*_response` message.
-If an error occured while processing the request an error response containing an error property in the data payload is sent instead.
-
-See [packages/lib/link/messages.js](/packages/lib/link/messages.js) for the recognized requests and their contents.
-
-### `*_response`
-
-- seq - integer - The seq number of the request message.
-- additional properties may be present depending on the type of request.
-
-### `*_response` error
-
-- seq - integer - The seq number of the request message.
-- error - string - Human readable text message describing the error.
-
-
-## Graceful Disconnect
-
-To ensure no data is lost when closing the link it's important to send a prepare disconnect request and wait for it to complete before closing the WebSocket.
-Either party of the link can send this request and the party sending the request should be the one that initates the close of the WebSocket.
-
-### `prepare_disconnect_request`
-
-Request graceful disconnect of the connection.
-The receiving party should stop tasks that send events and requests over the link and wait for pending requests it has over the link to complete, but it should not stop responding to requests sent to it.
-Only after this process is done should the response be sent.
-
-### `prepare_disconnect_response`
-
-Signals the preparation for disconnect is complete and that the connection can be closed.
-The party that initiatied the prepare disconnect request may still send other requests/events over the link to finish its part of the disconnection proceedure.
-
-If the error response variant is received it should be logged if possible and treated as a success.

docs/writing-plugins.md

@@ -48,18 +48,20 @@ For a plugin the most important file is the `info.js` file.
 Without it the plugin will not recognized by Clusterio.
 Here's an example of it:
 
-    const libLink = require("@clusterio/lib/link"); // For messages
+```js
+const { libLink } = require("@clusterio/lib"); // For messages
 
-    module.exports = {
-        name: "foo_frobber",
-        title: "Foo Frobber",
-        description: "Does advanced frobnication",
-        instanceEntrypoint: "instance",
-        masterEntrypoint: "master",
-        messages: {
-            /* See below */
-        },
-    };
+module.exports = {
+    name: "foo_frobber",
+    title: "Foo Frobber",
+    description: "Does advanced frobnication",
+    instanceEntrypoint: "instance",
+    masterEntrypoint: "master",
+    messages: {
+        /* See below */
+    },
+};
+```
 
 The following properties are recognized:
 
@@ -117,20 +119,22 @@ For both instanceEntrypoint and masterEntrypoint the path should not end with .j
 The plugin class should derive from its respective base class defined in `lib/plugin`.
 For example, to define a MasterPlugin class the following code can be used:
 
-    const libPlugin = require("@clusterio/lib/plugin");
+```js
+const libPlugin = require("@clusterio/lib/plugin");
 
-    class MasterPlugin extends libPlugin.BaseMasterPlugin {
-        async init() {
-            this.foo = 42;
-            await this.startFrobnication();
-        }
-
-        // ...
+class MasterPlugin extends libPlugin.BaseMasterPlugin {
+    async init() {
+        this.foo = 42;
+        await this.startFrobnication();
     }
 
-    module.exports = {
-        MasterPlugin,
-    }
+    // ...
+}
+
+module.exports = {
+    MasterPlugin,
+}
+```
 
 For the instance plugin it's exactly the same except "Master" is replaced with "Instance", and for the clusterioctl plugin "Control" is used.
 The available hooks that you can override are documented in the base class [in lib/plugin.js](/packages/lib/plugin.js).
@@ -138,11 +142,13 @@ The available hooks that you can override are documented in the base class [in l
 It's best to avoid defining a constructor, but if you insist on defining one, forward all arguments to the base class.
 E.g.:
 
-        constructor(...args) {
-            super(...args);
+```js
+constructor(...args) {
+    super(...args);
 
-            // Code here
-        }
+    // Code here
+}
+```
 
 The arguments passed may change, and attempting to modify them will result in unpredicatable behaviour.
 The async init method is always called immediatly after the constructor, so there's little reason to do this.
@@ -154,9 +160,11 @@ The base plugin classes provide a winston logger for logging messages to the sha
 For instances a copy of the log is also stored on the slave the instance is on.
 To use it, pass a string to one of the log levels functions, for example:
 
-    async init() {
-        this.logger.info("Initializing frobbing");
-    }
+```js
+async init() {
+    this.logger.info("Initializing frobbing");
+}
+```
 
 Metadata covering which plugin and instance (for instance plugin classes) the log event happened on will automatically be attached to the log message.
 
@@ -180,11 +188,13 @@ These levels have roughly the following meanings:
 
 For guarding unexpected errors the best option is to log a short description along with the`stack` property of the Error:
 
-    try {
-        // Operation that should not throw but may end up throwing
-    } catch (err) {
-        this.logger.error(`Operation failed:\n${err.stack}`);
-    )
+```js
+try {
+    // Operation that should not throw but may end up throwing
+} catch (err) {
+    this.logger.error(`Operation failed:\n${err.stack}`);
+)
+```
 
 For plugin hooks expections thrown are automatically catched and logged, but for event handlers registered on EventEmitters it's critical that exceptions are catched and handled appropriately.
 
@@ -195,30 +205,34 @@ Clusterio provides a configuration system that handles storing, distributing, ed
 You can take advantage of it by subclassing `PluginConfigGroup`, setting `defaultAccess` to where config entries can be accessed from, setting the `groupName` to your plugin name, defining fields on it, finalizing it, and passing it as either `MasterConfigGroup` or `InstanceConfigGroup` in the `info.js` export.
 For example in info.js:
 
-    const libConfig = require("@clusterio/lib/config");
+```js
+const libConfig = require("@clusterio/lib/config");
 
-    class MasterConfigGroup extends libConfig.PluginConfigGroup { }
-    MasterConfigGroup.defaultAccess = ["master", "slave", "control"];
-    MasterConfigGroup.groupName = "foo_frobber";
-    MasterConfigGroup.define({
-        name: "level",
-        description: "Level of frobnication done",
-        type: "number",
-        initial_value: 2,
-    });
-    MasterConfigGroup.finalize();
+class MasterConfigGroup extends libConfig.PluginConfigGroup { }
+MasterConfigGroup.defaultAccess = ["master", "slave", "control"];
+MasterConfigGroup.groupName = "foo_frobber";
+MasterConfigGroup.define({
+    name: "level",
+    description: "Level of frobnication done",
+    type: "number",
+    initial_value: 2,
+});
+MasterConfigGroup.finalize();
 
-    module.exports = {
-        ...
-        MasterConfigGroup: MasterConfigGroup,
-    };
+module.exports = {
+    ...
+    MasterConfigGroup: MasterConfigGroup,
+};
+```
 
 Code inside the `MasterPlugin` class will then be able to access the level config field through the `Config` object at `this.master.config`, for example in the MasterPluginClass:
 
-    async init() {
-        let level = this.master.config.get("foo_frobber.level");
-        this.logger.info(`I got a frobnication level of ${level}`);
-    }
+```js
+async init() {
+    let level = this.master.config.get("foo_frobber.level");
+    this.logger.info(`I got a frobnication level of ${level}`);
+}
+```
 
 The same applies for instance configs, replace "master" with "instance" where appropriate.
 See [Configuration System](config-system.md) for more details on how this system works.
@@ -230,11 +244,13 @@ If the plugin requires a certain feature to be enabled to function it should thr
 The most common such feature is the save patching, which can be disabled to run vanilla or scenarios not compatible with Clusterio.
 For example:
 
-    async init() {
-        if (!this.instance.config.get("factorio.enable_save_patching")) {
-            throw new Error("foo_frobber plugin requires save patching.");
-        }
+```js
+async init() {
+    if (!this.instance.config.get("factorio.enable_save_patching")) {
+        throw new Error("foo_frobber plugin requires save patching.");
     }
+}
+```
 
 
 ## Communicating with Factorio
@@ -243,14 +259,15 @@ For pushing data into Factorio there's RCON, which lets you send arbitrary Lua c
 This is done by calling the `sendRcon` method on the plugin object.
 For example:
 
-    async onStart() {
-        let response = await this.sendRcon(
-            "/sc rcon.print('data')"
-        );
-
-        // Do stuff with response.
-    }
+```js
+async onStart() {
+    let response = await this.sendRcon(
+        "/sc rcon.print('data')"
+    );
 
+    // Do stuff with response.
+}
+```
 
 Because data into Factorio is streamed at a rate of 3-6 kB/s by default, it is recommended to avoid sending large commands as much as possible, and to strip down the data on the ones you send to only what's strictly necessary.
 You can have lua code injected into the game via the module system and call that from RCON to avoid having to send code through the commands.
@@ -261,24 +278,28 @@ The `send_json` API allows sending JSON payloads on channels that plugins can li
 From a plugin you listen for an event named `ipc-channel_name` in order to get data sent by `send_json`.
 For example in the plugin code:
 
-    async init() {
-        this.instance.server.on("ipc-my_plugin_foo", content =>
-            this.handleFoo(content).catch(err => this.logger.error(
-                `Error handling foo:\n${err.stack}`
-            ))
-        );
-    }
+```js
+async init() {
+    this.instance.server.on("ipc-my_plugin_foo", content =>
+        this.handleFoo(content).catch(err => this.logger.error(
+            `Error handling foo:\n${err.stack}`
+        ))
+    );
+}
 
-    async handleFoo(content) {
-        // Do stuff with content
-    }
+async handleFoo(content) {
+    // Do stuff with content
+}
+```
 
 And then in the module for the plugin:
 
-    local clusterio_api = require("modules/clusterio/api")
+```lua
+local clusterio_api = require("modules/clusterio/api")
 
-    -- inside some event handler
-    clusterio_api.send_json("my_plugin_foo", { data = 123 })
+-- inside some event handler
+clusterio_api.send_json("my_plugin_foo", { data = 123 })
+```
 
 It's recommended to either use the plugin name as the channel name or to prefix the channel name with the name of the plugin if you need multiple channels.
 It's also important to catch any errors that might occur as they will otherwise be propogated to the instance code and kill the server.
@@ -310,18 +331,20 @@ Events are defined as properties of the messages object exported by `info.js` th
 The name of the property correspond to the handler invoked on the plugin class.
 The Event constructor takes an object of properties that define the event, for example the following could be defined in `info.js`:
 
-    messages: {
-        startFrobnication: new libLink.Event({
-            type: "foo_frobber:start_frobnication",
-            links: ["master-slave", "slave-instance"],
-            forwardTo: "instance",
-            eventRequired: ["frobnication_type"],
-            eventProperties: {
-                "frobnication_type": { type: "string" },
-                "urgent": { type: "boolean" },
-            },
-        }),
-    },
+```js
+messages: {
+    startFrobnication: new libLink.Event({
+        type: "foo_frobber:start_frobnication",
+        links: ["master-slave", "slave-instance"],
+        forwardTo: "instance",
+        eventRequired: ["frobnication_type"],
+        eventProperties: {
+            "frobnication_type": { type: "string" },
+            "urgent": { type: "boolean" },
+        },
+    }),
+},
+```
 
 This specifies an event that can be sent from the master to a slave, and from a slave to an instance.
 It also specifies that the event must contain the property `frobnication_type`, with a string value in the data payload and that it may optionally contain a boolean `urgent` property.
@@ -383,24 +406,26 @@ The name of the property corresponds to the handler invoked on the plugin class.
 The Request constructor takes an object of properties that define the event.
 For example, the following could be defined in `info.js`:
 
-    messages: {
-        reportFrobnication: new libLink.Request({
-            type: "foo_frobber:report_frobnication",
-            links: ["master-slave", "slave-instance"],
-            forwardTo: "instance",
-            requestRequired: ["verbosity"],
-            requestProperties: {
-                "verbosity": { type: "integer" },
-                "special": { type: "boolean" },
+```js
+messages: {
+    reportFrobnication: new libLink.Request({
+        type: "foo_frobber:report_frobnication",
+        links: ["master-slave", "slave-instance"],
+        forwardTo: "instance",
+        requestRequired: ["verbosity"],
+        requestProperties: {
+            "verbosity": { type: "integer" },
+            "special": { type: "boolean" },
+        },
+        responseProperties: {
+            "report": {
+                type: "array",
+                items: { type: "string" },
             },
-            responseProperties: {
-                "report": {
-                    type: "array",
-                    items: { type: "string" },
-                },
-            },
-        }),
-    },
+        },
+    }),
+},
+```
 
 This specifies a request that can be sent from the master to a slave, and from a slave to an instance.
 The request data must contain the property `verbosity` with an integer number as the value, as well as the `instance_id` property (implied by `forwardTo: "instance"`) and it may also contain a boolean `special` property.
@@ -459,10 +484,12 @@ For `InstancePlugin` code the link to the slave is the `instance` itself, which
 The `.info` property of the plugin class exposes the data exported from the plugin's `info.js` module.
 In other words:
 
-    // In an InstancePlugin class
-    async frobnicate() {
-        this.info.messages.exampleEvent.send(this.instance, { foo: "bar" });
-    }
+```js
+// In an InstancePlugin class
+async frobnicate() {
+    this.info.messages.exampleEvent.send(this.instance, { foo: "bar" });
+}
+```
 
 For the Request class the send method is async and returns the response data received from the target it was sent to, or throws an error if the request failed.
 
@@ -475,12 +502,14 @@ This is signaled to `MasterPlugin` classes via the `onPrepareSlaveDisconnect` ho
 
 After the prepare disconnect the connection will be closed, which will result in pending requests and events being dropped.
 Plugins must respond to the prepare disconnect by stopping any processess it does that send events or requests over the link in question.
-This can be accomplished either through listening for the prepare disconnect hook, or by checking the `connected` or `closing` property of the connector for the master/slave connection.
-For example the sending of an event from an `InstancePlugin` class can be stopped while the connection is closing by using the following code:
+This can be accomplished either through listening for the prepare disconnect hook, or by checking the `connected` property of the `SlaveConnection` class and `Slave` class on the master and slave respectively.
+For example the sending of an event from an `InstancePlugin` class can be stopped while the connection is not connected, not in the dropped state, and not in the process of discunnecting by using the following code:
 
-    if (!this.slave.connector.closing) {
-        this.info.messages.frobnicate.send(this.instance, { foo: "bar" });
-    }
+```js
+if (this.slave.connected) {
+    this.info.messages.frobnicate.send(this.instance, { foo: "bar" });
+}
+```
 
 If the event or request needs to be sent to the master it can be put into a queue stored on the plugin instance and sent out when the connection is established again.
 The re-establishement of the connection is  notified to plugins via the `connect` event to the `onMasterConnectionEvent` and `onSlaveConnectionEvent` hooks.
@@ -488,8 +517,8 @@ The re-establishement of the connection is  notified to plugins via the `connect
 The second connection event which is of lesser importance to respond to is the `drop` connection event served through `onMasterConnectionEvent` for `InstancePlugin` classes and through `onSlaveConnectionEvent` for `MasterPlugin` classes.
 This is raised when the connection between the master and slave in question is lost, most likely due to networking issues.
 When in the dropped state the slave will keep trying to reconnect to the master server in order to re-establish it, and if successful no events or requests will be lost.
-However while in the dropped state any requests and events sent gets queued up in memory until the connection is re-established.
-This means that if your plugin sends a lot of events or requests, they can end up being queued up in a buffer for a long time and sent out all at once.
+However while in the dropped state any requests and events sent gets queued up in memory until the connection is either re-established or the session times out.
+This means that if your plugin sends a lot of events or requests, they can end up being queued up in a buffer and sent out all at once the connection is re-estabished.
 To avoid this you should be throtteling and/or stopping your requests/events after `drop` has been raised, and continue back as normal when `resume` is raised.
 
 
@@ -500,29 +529,33 @@ Clusterio comes with its own Prometheus client implementation, one part due to N
 In its simplest form collecting data from plugins consists of defining the metric and updating it somewhere in the plugin code.
 For example:
 
-    const { Counter } = require("@clusterio/lib/prometheus");
+```js
+const { Counter } = require("@clusterio/lib/prometheus");
 
-    const fooMetric = new Counter(
-        "clusterio_foo_frobber_foo_metric", "Measures the level of foo",
-    );
+const fooMetric = new Counter(
+    "clusterio_foo_frobber_foo_metric", "Measures the level of foo",
+);
 
-    // Somewhere in the master plugin code
-    fooMetric.inc();
+// Somewhere in the master plugin code
+fooMetric.inc();
+```
 
 This works for master plugins, and the metric will be automatically available through the /metric HTTP endpoint.
 It's recommended that plugin metrics follow `clusterio_<plugin_name>_<metric_name>` as the naming scheme.
 
 For metrics that are per-instance, you must define an `instance_id` label and set it accordingly, for example:
 
-    const { Counter } = require("@clusterio/lib/prometheus");
+```js
+const { Counter } = require("@clusterio/lib/prometheus");
 
-    const barMetric = new Gauge(
-        "clusterio_foo_frobber_bar_metric", "Bar instance level",
-        { labels: ["instance_id"] }
-    );
+const barMetric = new Gauge(
+    "clusterio_foo_frobber_bar_metric", "Bar instance level",
+    { labels: ["instance_id"] }
+);
 
-    // Somewhere in the instance plugin code
-    barMetric.labels(String(this.instance.id)).set(someValue);
+// Somewhere in the instance plugin code
+barMetric.labels(String(this.instance.id)).set(someValue);
+```
 
 Metrics are automatically registered to the default registry, and this default registry is automatically polled by the master server on slaves.
 This means that it's important that you place the definition of the metric at module level so that it's not created more than once over the lifetime of a slave.
@@ -536,28 +569,32 @@ For statistics you need to update on collection there's an `onMetrics` hook on b
 The control entrypoint for plugins allows you to extend clustectl with your own commands.
 The creation of custom commands typically starts with defining a command tree for the plugin:
 
-    const { Command, CommandTree } = require("@clusterio/lib/command");
-    const fooFrobberCommands = new CommandTree({
-        name: "foo-frobber", description: "Foo Frobber Plugin commands"
-    });
+```js
+const { Command, CommandTree } = require("@clusterio/lib/command");
+const fooFrobberCommands = new CommandTree({
+    name: "foo-frobber", description: "Foo Frobber Plugin commands"
+});
+```
 
 Then commands are added to the the plugin's command tree:
 
-    const info = require("./info");
+```js
+const info = require("./info");
 
-    fooFrobberCommands.add(new Command({
-        definition: ["frobnicate <type>", "Do frobnications", (yargs) => {
-            yargs.positional("level", {
-                describe: "type of frobnication", type: "string"
-            });
-        }],
-        handler: async function(args, control) {
-            await info.messages.frobnicate.send(control, {
-                instance_name: "Console",
-                content: args.message,
-            });
-        },
-    }));
+fooFrobberCommands.add(new Command({
+    definition: ["frobnicate <type>", "Do frobnications", (yargs) => {
+        yargs.positional("level", {
+            describe: "type of frobnication", type: "string"
+        });
+    }],
+    handler: async function(args, control) {
+        await info.messages.frobnicate.send(control, {
+            instance_name: "Console",
+            content: args.message,
+        });
+    },
+}));
+```
 
 For a command the `definition` is the arguments to pass to [yargs.command](http://yargs.js.org/docs/#api-reference-commandcmd-desc-builder-handler) (see also [yargs.positional](http://yargs.js.org/docs/#api-reference-positionalkey-opt) and [yargs.options](http://yargs.js.org/docs/#api-reference-optionskey-opt) for setting up positional and optional arguments to commands).
 The `handler` is an async function that's invoked when the command is executed and it's passed the parsed command line arguments and a reference to the `Control` class of clusterioctl.
@@ -567,14 +604,16 @@ Note that messages sent from clusterioctl needs to have `"control-master"` as a
 
 To have the command tree become part of clusterioctl it needs to be added to the rootCommand tree in `addCommands` callback of the Control plugin:
 
-    const libPlugin = require("@clusterio/lib/plugin");
+```js
+const libPlugin = require("@clusterio/lib/plugin");
 
-    class ControlPlugin extends libPlugin.BaseControlPlugin {
-        async addCommands(rootCommand) {
-            rootCommand.add(fooFrobberCommands);
-        }
+class ControlPlugin extends libPlugin.BaseControlPlugin {
+    async addCommands(rootCommand) {
+        rootCommand.add(fooFrobberCommands);
     }
+}
 
-    module.exports = {
-        ControlPlugin,
-    }
+module.exports = {
+    ControlPlugin,
+}
+```

external_plugins/.gitignore

@@ -0,0 +1,3 @@
+*
+!.gitignore
+!README.md

external_plugins/README.md

@@ -0,0 +1,4 @@
+# External plugins directory
+
+Plugins placed here will have their npm dependencies incorporated in the shared pnpm storage for this repository when `pnpm install` is invoked.
+Use this to enable `--dev-plugin` to work with plugins developed outside of the Clusterio repository.

lerna.json

@@ -1,7 +0,0 @@
-{
-  "packages": [
-    "packages/*",
-    "plugins/*"
-  ],
-  "version": "2.0.0-alpha.5"
-}

package.json

@@ -2,11 +2,11 @@
   "name": "root",
   "private": true,
   "scripts": {
-    "test": "mocha --check-leaks -R spec --recursive test plugins/global_chat/test plugins/research_sync/test plugins/statistics_exporter/test plugins/subspace_storage/test plugins/player_auth/test",
-    "fast-test": "FAST_TEST=y npm test",
-    "cover": "nyc npm test",
-    "fast-cover": "FAST_TEST=y nyc npm test",
-    "ci-cover": "nyc --reporter=lcovonly npm run-script test",
+    "test": "mocha --check-leaks -R spec --recursive test \"plugins/*/test/**\"",
+    "fast-test": "FAST_TEST=y pnpm test",
+    "cover": "nyc pnpm test",
+    "fast-cover": "FAST_TEST=y nyc pnpm test",
+    "ci-cover": "nyc --reporter=lcovonly pnpm run-script test",
     "lint": "eslint \"*.js\" packages plugins test",
     "docs": "jsdoc --configure docs/jsdoc.json",
     "bundle-dependencies": "bundle-dependencies"
@@ -18,25 +18,24 @@
     ]
   },
   "engines": {
-    "node": ">=10.16 <11 || >= 12"
+    "node": ">=12"
   },
   "devDependencies": {
-    "@clusterio/ctl": "file:./packages/ctl",
-    "@clusterio/lib": "file:./packages/lib",
-    "@clusterio/master": "file:packages/master",
-    "@clusterio/slave": "file:./packages/slave",
-    "body-parser": "^1.18.2",
-    "eslint": "^7.2.0",
+    "@clusterio/ctl": "workspace:*",
+    "@clusterio/lib": "workspace:*",
+    "@clusterio/master": "workspace:*",
+    "@clusterio/slave": "workspace:*",
+    "eslint": "^8.18.0",
+    "eslint-plugin-node": "^11.1.0",
     "express": "^4.16.2",
+    "form-data": "^4.0.0",
     "fs-extra": "^8.1.0",
-    "jsdoc": "^3.6.3",
+    "jsdoc": "^3.6.6",
     "jsonwebtoken": "^8.2.1",
     "jszip": "^3.2.2",
-    "lerna": "^3.22.1",
-    "mocha": "^6.2.0",
-    "node-forge": "^0.10.0",
-    "nyc": "^14.1.1",
-    "phin": "^3.4.1",
-    "webpack": "^5.0.0"
+    "mocha": "^9.2.2",
+    "node-forge": "^1.3.1",
+    "nyc": "^15.1.0",
+    "phin": "^3.5.1"
   }
 }

packages/create/README.md

@@ -0,0 +1,5 @@
+# Clusterio installer
+
+Installer for Clusterio.
+
+See [the Clusterio README.md](https://github.com/clusterio/clusterio#readme) the for installation guide.

packages/create/create.js

@@ -0,0 +1,662 @@
+#!/usr/bin/env node
+
+"use strict";
+const child_process = require("child_process");
+const fs = require("fs-extra");
+const inquirer = require("inquirer");
+const os = require("os");
+const path = require("path");
+const phin = require("phin");
+const stream = require("stream");
+const util = require("util");
+const yargs = require("yargs");
+
+const { levels, logger, setLogLevel } = require("./logging");
+let dev = false;
+const scriptExt = process.platform === "win32" ? ".cmd" : "";
+const finished = util.promisify(stream.finished);
+
+
+const availablePlugins = [
+	{ name: "Global Chat", value: "@clusterio/plugin-global_chat" },
+	{ name: "Inventory Sync", value: "@clusterio/plugin-inventory_sync" },
+	{ name: "Player Auth", value: "@clusterio/plugin-player_auth" },
+	{ name: "Research Sync", value: "@clusterio/plugin-research_sync" },
+	{ name: "Statistics Exporter", value: "@clusterio/plugin-statistics_exporter" },
+	{ name: "Subspace Storage", value: "@clusterio/plugin-subspace_storage" },
+
+	// Comunity plugins
+	{ name: "Discord Bridge", value: "@hornwitser/discord_bridge" },
+	{ name: "Server Select", value: "@hornwitser/server_select" },
+];
+
+const factorioLocations = {
+	win32: [
+		"C:\\Program Files\\Factorio",
+		"C:\\Program Files (x86)\\Steam\\steamapps\\common\\Factorio",
+	],
+	darwin: [
+		"/Applications/factorio.app/Contents",
+	],
+};
+
+
+class LineSplitter extends stream.Transform {
+	constructor(options) {
+		super(options);
+		this._partial = null;
+	}
+
+	_transform(chunk, encoding, callback) {
+		if (this._partial) {
+			chunk = Buffer.concat([this._partial, chunk]);
+			this._partial = null;
+		}
+
+		while (chunk.length) {
+			let end = chunk.indexOf("\n");
+			if (end === -1) {
+				this._partial = chunk;
+				break;
+			}
+
+			let next = end + 1;
+			// Eat carriage return as well if present
+			if (end >= 1 && chunk[end-1] === "\r".charCodeAt(0)) {
+				end -= 1;
+			}
+
+			let line = chunk.slice(0, end);
+			chunk = chunk.slice(next);
+			this.push(line);
+		}
+		callback();
+	}
+
+	_flush(callback) {
+		if (this._partial) {
+			this.push(this._partial);
+			this._partial = null;
+		}
+		callback();
+	}
+}
+
+class InstallError extends Error { }
+
+
+async function safeOutputFile(file, data, options={}) {
+	let temporary = `${file}.tmp`;
+	await fs.outputFile(temporary, data, options);
+	await fs.rename(temporary, file);
+}
+
+async function execFile(cmd, args) {
+	logger.verbose(`executing ${cmd} ${args.join(" ")}`);
+	return new Promise((resolve, reject) => {
+		let child = child_process.execFile(cmd, args, (err, stdout, stderr) => {
+			if (err) {
+				reject(err);
+			} else {
+				resolve({ stdout, stderr });
+			}
+		});
+		let stdout = new LineSplitter({ readableObjectMode: true });
+		stdout.on("data", line => { logger.verbose(line.toString()); });
+		child.stdout.pipe(stdout);
+		let stderr = new LineSplitter({ readableObjectMode: true });
+		stderr.on("data", line => { logger.verbose(`err: ${line.toString()}`); });
+		child.stderr.pipe(stderr);
+	});
+}
+
+async function execMaster(args) {
+	if (dev) {
+		return await execFile("node", [path.join("packages", "master"), ...args]);
+	}
+	return await execFile(path.join("node_modules", ".bin", `clusteriomaster${scriptExt}`), args);
+}
+
+async function execSlave(args) {
+	if (dev) {
+		return await execFile("node", [path.join("packages", "slave"), ...args]);
+	}
+	return await execFile(path.join("node_modules", ".bin", `clusterioslave${scriptExt}`), args);
+}
+
+async function execCtl(args) {
+	if (dev) {
+		return await execFile("node", [path.join("packages", "ctl"), ...args]);
+	}
+	return await execFile(path.join("node_modules", ".bin", `clusterioctl${scriptExt}`), args);
+}
+
+function validateSlaveToken(token) {
+	let parts = token.split(".");
+	if (parts.length !== 3) {
+		throw new InstallError("Invalid token");
+	}
+
+	let parsed;
+	try {
+		parsed = JSON.parse(Buffer.from(parts[1], "base64"));
+	} catch (err) {
+		throw new InstallError("Invalid token");
+	}
+
+	if (parsed.aud !== "slave" || !Number.isInteger(parsed.slave)) {
+		throw new InstallError("Invalid token");
+	}
+}
+
+async function validateInstallDir() {
+	let entries = new Set(await fs.readdir("."));
+	if (entries.size) {
+		if (!entries.has("package.json")) {
+			throw new InstallError("Refusing to install to non-empty directory");
+		}
+
+		let packageData;
+		try {
+			packageData = JSON.parse(await fs.readFile("package.json"));
+		} catch (err) {
+			throw new InstallError(`Failed to read package.json: ${err.message}`);
+		}
+		if (packageData.name !== "clusterio-install" || !packageData.private) {
+			throw new InstallError("Refusing to run on non-clusterio installation");
+		}
+	}
+}
+
+async function validateNotRoot(args) {
+	if (args.allowInstallAsRoot) {
+		return;
+	}
+
+	if (os.userInfo().uid === 0) {
+		throw new InstallError(
+			"Refusing to install as root. Create a separate user account for clusterio " +
+			"and then use su/sudo to switch to it before invoking the installer."
+		);
+	}
+}
+
+async function installClusterio(mode, plugins) {
+	try {
+		await safeOutputFile("package.json", JSON.stringify({
+			name: "clusterio-install",
+			private: true,
+		}, null, 2), { flag: "wx" });
+	} catch (err) {
+		if (err.code !== "EEXIST") {
+			throw new InstallError(`Failed to write package.json: ${err.message}`);
+		}
+	}
+
+	let components = [];
+	if (["standalone", "master"].includes(mode)) {
+		components.push("@clusterio/master");
+	}
+	if (["standalone", "slave"].includes(mode)) {
+		components.push("@clusterio/slave");
+	}
+	if (mode === "ctl") {
+		components.push("@clusterio/ctl");
+	}
+
+	logger.info(`Please wait, installing ${mode}`);
+	try {
+		await execFile(`npm${scriptExt}`, ["install", ...components, ...plugins]);
+	} catch (err) {
+		throw new InstallError(`Failed to install: ${err.message}`);
+	}
+
+	if (plugins.length) {
+		logger.info("Setting up plugins");
+		let pluginList;
+		try {
+			pluginList = new Map(JSON.parse(await fs.readFile("plugin-list.json")));
+		} catch (err) {
+			if (err.code === "ENOENT") {
+				pluginList = new Map();
+			} else {
+				throw new InstallError(`Error loading plugin-list.json: ${err.message}`);
+			}
+		}
+		for (let plugin of plugins) {
+			if (!pluginList.has(plugin)) {
+				// eslint-disable-next-line node/global-require
+				let pluginInfo = require(require.resolve(path.posix.join(plugin, "info"), { paths: [process.cwd()] }));
+				pluginList.set(pluginInfo.name, plugin);
+			}
+		}
+		try {
+			await safeOutputFile("plugin-list.json", JSON.stringify([...pluginList], null, 4));
+		} catch (err) {
+			throw new InstallError(`Error writing plugin-list.json: ${err.message}`);
+		}
+	}
+}
+
+async function groupIdToName(gid) {
+	try {
+		let exec = util.promisify(child_process.exec);
+		let { stdout } = await exec(`getent group ${gid}`);
+		return stdout.split(":")[0];
+	} catch (err) {
+		logger.warn(`getent group ${gid} failed: ${err.message}`);
+		return gid;
+	}
+}
+
+async function writeScripts(mode) {
+	if (["standalone", "master"].includes(mode)) {
+		if (process.platform === "win32") {
+			await safeOutputFile(
+				"run-master.cmd",
+				"@echo off\n.\\node_modules\\.bin\\clusteriomaster.cmd run\n"
+			);
+		} else {
+			await safeOutputFile(
+				"run-master.sh",
+				"#!/bin/sh\nexec ./node_modules/.bin/clusteriomaster run\n",
+				{ mode: 0o755 },
+			);
+			await safeOutputFile(
+				"systemd/clusteriomaster.service",
+				`[Unit]
+Description=Clusterio Master
+
+[Service]
+User=${os.userInfo().username}
+Group=${await groupIdToName(os.userInfo().gid)}
+WorkingDirectory=${process.cwd()}
+KillMode=mixed
+KillSignal=SIGINT
+ExecStart=${process.cwd()}/node_modules/.bin/clusteriomaster run --log-level=warn
+
+[Install]
+WantedBy=multi-user.target
+`);
+		}
+	}
+
+	if (["standalone", "slave"].includes(mode)) {
+		if (process.platform === "win32") {
+			await safeOutputFile(
+				"run-slave.cmd",
+				"@echo off\n.\\node_modules\\.bin\\clusterioslave.cmd run\n"
+			);
+		} else {
+			await safeOutputFile(
+				"run-slave.sh",
+				"#!/bin/sh\nexec ./node_modules/.bin/clusterioslave run\n",
+				{ mode: 0o755 },
+			);
+			await safeOutputFile(
+				"systemd/clusterioslave.service",
+				`[Unit]
+Description=Clusterio Slave
+
+[Service]
+User=${os.userInfo().username}
+Group=${await groupIdToName(os.userInfo().gid)}
+WorkingDirectory=${process.cwd()}
+KillMode=mixed
+KillSignal=SIGINT
+ExecStart=${process.cwd()}/node_modules/.bin/clusterioslave run --log-level=warn
+
+[Install]
+WantedBy=multi-user.target
+`);
+		}
+	}
+}
+
+// eslint-disable-next-line complexity
+async function inquirerMissingArgs(args) {
+	let answers = {};
+	if (args.mode) { answers.mode = args.mode; }
+	answers = await inquirer.prompt([
+		{
+			type: "list",
+			name: "mode",
+			message: "Operating mode to install",
+			default: "standalone",
+			choices: [
+				{ name: "Standalone (install both master and slave on this computer)", value: "standalone" },
+				{ name: "Master only", value: "master" },
+				{ name: "Slave only", value: "slave" },
+				{ name: "Ctl only", value: "ctl" },
+				{ name: "Plugins only", value: "plugins" },
+			],
+		},
+	], answers);
+
+	if (["standalone", "master"].includes(answers.mode)) {
+		if (args.admin) { answers.admin = args.admin; }
+		answers = await inquirer.prompt([
+			{
+				type: "input",
+				name: "admin",
+				message: "Admin account name",
+				validate: input => {
+					if (!input) {
+						return "May not be empty";
+					}
+					return true;
+				},
+			},
+		], answers);
+	}
+
+	if (answers.mode === "slave") {
+		if (args.slaveName) { answers.slaveName = args.slaveName; }
+		answers = await inquirer.prompt([
+			{
+				type: "input",
+				name: "slaveName",
+				message: "Name of slave",
+			},
+		], answers);
+	}
+
+	if (["slave", "ctl"].includes(answers.mode)) {
+		if (args.masterUrl) { answers.masterUrl = args.masterUrl; }
+		answers = await inquirer.prompt([
+			{
+				type: "input",
+				name: "masterUrl",
+				message: "Master server URL",
+			},
+		], answers);
+
+		if (args.masterToken) { answers.masterToken = args.masterToken; }
+		answers = await inquirer.prompt([
+			{
+				type: "input",
+				name: "masterToken",
+				message: "Master authentication Token",
+			},
+		], answers);
+	}
+
+	if (answers.mode === "slave") {
+		validateSlaveToken(answers.masterToken);
+	}
+
+	if (["standalone", "slave"].includes(answers.mode)) {
+		let myIp = "localhost";
+		if (args.publicAddress) {
+			answers.publicAddress = args.publicAddress;
+		} else {
+			try {
+				let result = await phin("https://api.ipify.org/");
+				myIp = result.body.toString();
+			} catch (err) { /* ignore */ }
+		}
+		answers = await inquirer.prompt([
+			{
+				type: "input",
+				name: "publicAddress",
+				message: "Public DNS/IP address of this server",
+				default: myIp,
+			},
+		], answers);
+
+		if (args.factorioDir) { answers.factorioDir = args.factorioDir; }
+		let locations = factorioLocations[process.platform] || [];
+		let foundLocations = [];
+		for (let location of locations) {
+			if (await fs.pathExists(path.join(location, "data", "changelog.txt"))) {
+				foundLocations.push(location);
+			}
+		}
+		if (process.platform === "linux") {
+			if (args.hasOwnProperty("downloadHeadless")) { answers.downloadHeadless = args.downloadHeadless; }
+
+			answers = await inquirer.prompt([
+				{
+					type: "confirm",
+					name: "downloadHeadless",
+					message: "(Linux only) Automatically download latest factorio release?",
+					default: true,
+				},
+			], answers);
+
+			if (answers.downloadHeadless) {
+				answers.factorioDir = "factorio";
+			}
+		}
+
+		answers = await inquirer.prompt([
+			{
+				type: "list",
+				name: "factorioDir",
+				message: "Path to Factorio installation",
+				choices: [
+					...foundLocations.map(location => ({ name: `${location} (auto detected)`, value: location })),
+					{ name: "Use local factorio directory, you must copy an installation to it", value: "factorio" },
+					{ name: "Provide path manually", value: null },
+				],
+			},
+		], answers);
+
+		if (answers.factorioDir === null) {
+			answers = await inquirer.prompt([
+				{
+					type: "input",
+					name: "factorioDir",
+					message: "Path to Factorio installation",
+					askAnswered: true,
+				},
+			], answers);
+		} else if (answers.factorioDir === "factorio") {
+			await fs.ensureDir("factorio");
+		}
+	}
+
+	if (dev) {
+		answers.plugins = [];
+	} else if (args.plugins) {
+		answers.plugins = args.plugins;
+	}
+	answers = await inquirer.prompt([
+		{
+			type: "checkbox",
+			name: "plugins",
+			message: "Plugins to install",
+			choices: availablePlugins,
+			pageSize: 20,
+		},
+	], answers);
+
+	return answers;
+}
+
+async function downloadLinuxServer() {
+	let res = await phin("https://factorio.com/get-download/stable/headless/linux64");
+
+	const url = new URL(res.headers.location);
+	// get the filename of the latest factorio archive from redirected url
+	const filename = path.posix.basename(url.pathname);
+	const version = filename.match(/(?<=factorio_headless_x64_).*(?=\.tar\.xz)/)[0];
+
+	const tmpDir = "temp/create-temp/";
+	const archivePath = tmpDir + filename;
+	const tmpArchivePath = `${archivePath}.tmp`;
+	const factorioDir = `factorio/${version}/`;
+	const tmpFactorioDir = tmpDir + version;
+
+	if (await fs.pathExists(factorioDir)) {
+		logger.warn(`setting downloadDir to ${factorioDir}, but not downloading because already existing`);
+	} else {
+		await fs.ensureDir(tmpDir);
+
+		// follow the redirect
+		res = await phin({
+			url: url.href,
+			stream: true,
+		});
+
+		logger.info("Downloading latest Factorio server release. This may take a while.");
+		const writeStream = fs.createWriteStream(tmpArchivePath);
+		res.pipe(writeStream);
+
+		await finished(writeStream);
+
+		await fs.rename(tmpArchivePath, archivePath);
+		try {
+			await fs.ensureDir(tmpFactorioDir);
+			await execFile("tar", [
+				"xf", archivePath, "-C", tmpFactorioDir, "--strip-components", "1",
+			]);
+		} catch (e) {
+			logger.error("error executing command- do you have 'xz-utils' installed?");
+			throw e;
+		}
+
+		await fs.unlink(archivePath);
+		await fs.rename(tmpFactorioDir, factorioDir);
+	}
+}
+
+async function main() {
+	let args = yargs
+		.option("log-level", {
+			nargs: 1, describe: "Log level to print to stdout", default: "info",
+			choices: ["none"].concat(Object.keys(levels)), type: "string",
+		})
+		.option("dev", {
+			nargs: 0, describe: "Initialize development repository", hidden: true, default: false, type: "boolean",
+		})
+		.option("mode", {
+			nargs: 1, describe: "Operating mode to install",
+			choices: ["standalone", "master", "slave", "ctl", "plugins"],
+		})
+		.option("admin", {
+			nargs: 1, describe: "Admin account name [standalone/master]", type: "string",
+		})
+		.option("slave-name", {
+			nargs: 1, describe: "Slave name [slave]", type: "string",
+		})
+		.option("master-url", {
+			nargs: 1, describe: "Master URL [slave/ctl]", type: "string",
+		})
+		.option("master-token", {
+			nargs: 1, describe: "Master authentication token [slave/ctl]", type: "string",
+		})
+		.option("public-address", {
+			nargs: 1, describe: "DNS/IP Address to connect to this server [standalone/slave]", type: "string",
+		})
+		.option("factorio-dir", {
+			nargs: 1, describe: "Path to Factorio installation [standalone/slave]", type: "string",
+		})
+		.option("plugins", {
+			array: true, describe: "Plugins to install", type: "string",
+		})
+		.strict()
+	;
+
+	if (process.platform === "linux") {
+		args = args
+			.option("allow-install-as-root", {
+				nargs: 0, describe: "(Linux only) Allow installing as root (not recommended)", type: "boolean",
+			})
+			.option("download-headless", {
+				nargs: 0,
+				describe: "(Linux only) Automatically download and unpack the latest factorio release. " +
+					"Can be set to false using --no-download-headless.",
+				type: "boolean",
+			})
+			.conflicts("factorio-dir", "download-headless");
+	}
+
+	args = args.argv;
+
+	setLogLevel(args.logLevel === "none" ? -1 : levels[args.logLevel]);
+	dev = args.dev;
+
+	if (!dev) {
+		await validateInstallDir();
+		await validateNotRoot(args);
+	}
+
+	let answers = await inquirerMissingArgs(args);
+	if (answers.downloadHeadless) {
+		await downloadLinuxServer();
+	}
+
+	logger.verbose(JSON.stringify(answers));
+
+	if (!dev) {
+		await installClusterio(answers.mode, answers.plugins);
+	}
+
+	let adminToken = null;
+	if (["standalone", "master"].includes(answers.mode)) {
+		logger.info("Setting up master");
+		await execMaster(["bootstrap", "create-admin", answers.admin]);
+		let result = await execMaster(["bootstrap", "generate-user-token", answers.admin]);
+		adminToken = result.stdout.split("\n").slice(-2)[0];
+	}
+
+	if (answers.mode === "standalone") {
+		logger.info("Setting up slave");
+		await execSlave(["config", "set", "slave.name", "local"]);
+
+		let result = await execSlave(["config", "show", "slave.id"]);
+		let slaveId = Number.parseInt(result.stdout.split("\n").slice(-2)[0], 10);
+
+		result = await execMaster(["bootstrap", "generate-slave-token", slaveId]);
+		let slaveToken = result.stdout.split("\n").slice(-2)[0];
+
+		await execSlave(["config", "set", "slave.master_token", slaveToken]);
+		await execSlave(["config", "set", "slave.public_address", answers.publicAddress]);
+		await execSlave(["config", "set", "slave.factorio_directory", answers.factorioDir]);
+	}
+
+	if (answers.mode === "slave") {
+		logger.info("Setting up slave");
+		let slaveId = JSON.parse(Buffer.from(answers.masterToken.split(".")[1], "base64")).slave;
+		await execSlave(["config", "set", "slave.id", slaveId]);
+		await execSlave(["config", "set", "slave.name", answers.slaveName]);
+		await execSlave(["config", "set", "slave.master_url", answers.masterUrl]);
+		await execSlave(["config", "set", "slave.master_token", answers.masterToken]);
+		await execSlave(["config", "set", "slave.public_address", answers.publicAddress]);
+		await execSlave(["config", "set", "slave.factorio_directory", answers.factorioDir]);
+	}
+
+	if (!dev && ["standalone", "master", "slave"].includes(answers.mode)) {
+		logger.info("Writing run scripts");
+		await writeScripts(answers.mode);
+	}
+
+	if (answers.mode === "ctl") {
+		await execCtl(["control-config", "set", "control.master_url", answers.masterUrl]);
+		await execCtl(["control-config", "set", "control.master_token", answers.masterToken]);
+	}
+
+	/* eslint-disable no-console */
+	console.log(`Successfully installed ${answers.mode}`);
+	if (adminToken) {
+		console.log(`Admin authentication token: ${adminToken}`);
+	}
+	/* eslint-enable no-console */
+}
+
+if (module === require.main) {
+	main().catch(err => {
+		if (err instanceof InstallError) {
+			logger.error(err.message);
+		} else {
+			logger.fatal(`
++------------------------------------------------------------+
+| Unexpected error occured installing clusterio, please      |
+| report it to https://github.com/clusterio/clusterio/issues |
++------------------------------------------------------------+
+${err.stack}`
+			);
+		}
+	});
+}

packages/create/logging.js

@@ -0,0 +1,51 @@
+/* eslint-disable no-console */
+"use strict";
+const chalk = require("chalk");
+
+const levels = Object.freeze({
+	fatal: 0,
+	error: 1,
+	warn: 2,
+	audit: 3,
+	info: 4,
+	verbose: 6,
+});
+
+const colors = {
+	fatal: "inverse red",
+	error: "bold redBright",
+	warn: "bold yellowBright",
+	audit: "bold greenBright",
+	info: "bold blueBright",
+	verbose: "bold grey",
+};
+
+let maxLogLevel = levels.info;
+const logger = {};
+for (let [name, level] of Object.entries(levels)) {
+	// eslint-disable-next-line no-loop-func
+	logger[name] = message => {
+		if (level > maxLogLevel) {
+			return;
+		}
+		let style = chalk;
+		for (let part of colors[name].split(" ")) {
+			style = style[part];
+		}
+		if (["fatal", "error"].includes(name)) {
+			console.error(`${style(name)} ${message}`);
+		} else if (["warn"].includes(name)) {
+			console.warn(`${style(name)} ${message}`);
+		} else {
+			console.log(`${style(name)} ${message}`);
+		}
+	};
+}
+
+module.exports = {
+	colors,
+	levels,
+	setLogLevel: (level) => { maxLogLevel = level; },
+	logger,
+};
+

packages/create/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@clusterio/create",
+  "description": "Installer for clusterio",
+  "author": "Hornwitser",
+  "license": "MIT",
+  "version": "2.0.0-alpha.13",
+  "main": "create.js",
+  "bin": {
+    "clusteriocreate": "./create.js"
+  },
+  "keywords": [
+    "factorio",
+    "clusterio"
+  ],
+  "engines": {
+    "node": ">=12"
+  },
+  "dependencies": {
+    "chalk": "^4.1.0",
+    "fs-extra": "^8.1.0",
+    "inquirer": "^8.1.0",
+    "phin": "^3.5.1",
+    "yargs": "^14.2.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

packages/ctl/README.md

@@ -88,4 +88,4 @@ Lists up all configuration entries with their currently configured values.
 
 [Managing a cluster](/docs/managing-a-cluster.md) for the available commands used for managing a cluster.
 
-[The Clusterio repository](https://github.com/clusterio/factorioClusterio) for instructions on how to set up a cluster.
+[The Clusterio repository](https://github.com/clusterio/clusterio) for instructions on how to set up a cluster.

packages/ctl/ctl.js

@@ -8,12 +8,7 @@
 const fs = require("fs-extra");
 const yargs = require("yargs");
 const version = require("./package").version;
-const asTable = require("as-table").configure({ delimiter: " | " });
-const events = require("events");
-const path = require("path");
-const winston = require("winston");
 const setBlocking = require("set-blocking");
-const phin = require("phin");
 
 const libLink = require("@clusterio/lib/link");
 const libErrors = require("@clusterio/lib/errors");
@@ -24,670 +19,8 @@ const libCommand = require("@clusterio/lib/command");
 const libSharedCommands = require("@clusterio/lib/shared_commands");
 const { ConsoleTransport, levels, logger } = require("@clusterio/lib/logging");
 const libLoggingUtils = require("@clusterio/lib/logging_utils");
-const libHelpers = require("@clusterio/lib/helpers");
 
-
-function print(...content) {
-	// eslint-disable-next-line no-console
-	console.log(...content);
-}
-
-
-const masterCommands = new libCommand.CommandTree({ name: "master", description: "Master management" });
-const masterConfigCommands = new libCommand.CommandTree({
-	name: "config", alias: ["c"], description: "master config management",
-});
-masterConfigCommands.add(new libCommand.Command({
-	definition: ["list", "List master configuration"],
-	handler: async function(args, control) {
-		let response = await libLink.messages.getMasterConfig.send(control);
-
-		for (let group of response.serialized_config.groups) {
-			for (let [name, value] of Object.entries(group.fields)) {
-				print(`${group.name}.${name} ${JSON.stringify(value)}`);
-			}
-		}
-	},
-}));
-
-masterConfigCommands.add(new libCommand.Command({
-	definition: ["set <field> [value]", "Set field in master config", (yargs) => {
-		yargs.positional("field", { describe: "Field to set", type: "string" });
-		yargs.positional("value", { describe: "Value to set", type: "string" });
-		yargs.options({
-			"stdin": { describe: "read value from stdin", nargs: 0, type: "boolean" },
-		});
-	}],
-	handler: async function(args, control) {
-		if (args.stdin) {
-			args.value = (await libHelpers.readStream(process.stdin)).toString().replace(/\r?\n$/, "");
-		} else if (args.value === undefined) {
-			args.value = "";
-		}
-		await libLink.messages.setMasterConfigField.send(control, {
-			field: args.field,
-			value: args.value,
-		});
-	},
-}));
-
-masterConfigCommands.add(new libCommand.Command({
-	definition: ["set-prop <field> <prop> [value]", "Set property of field in master config", (yargs) => {
-		yargs.positional("field", { describe: "Field to set", type: "string" });
-		yargs.positional("prop", { describe: "Property to set", type: "string" });
-		yargs.positional("value", { describe: "JSON parsed value to set", type: "string" });
-		yargs.options({
-			"stdin": { describe: "read value from stdin", nargs: 0, type: "boolean" },
-		});
-	}],
-	handler: async function(args, control) {
-		if (args.stdin) {
-			args.value = (await libHelpers.readStream(process.stdin)).toString().replace(/\r?\n$/, "");
-		}
-		let request = {
-			field: args.field,
-			prop: args.prop,
-		};
-		try {
-			if (args.value !== undefined) {
-				request.value = JSON.parse(args.value);
-			}
-		} catch (err) {
-			// See note for the instance version of set-prop
-			if (args.stdin || /^(\[.*]|{.*}|".*")$/.test(args.value)) {
-				throw new libErrors.CommandError(`In parsing value '${args.value}': ${err.message}`);
-			}
-			request.value = args.value;
-		}
-		await libLink.messages.setMasterConfigProp.send(control, request);
-	},
-}));
-masterCommands.add(masterConfigCommands);
-
-
-const masterPluginCommands = new libCommand.CommandTree({
-	name: "plugin", alias: ["p"], description: "master plugin inspection",
-});
-masterPluginCommands.add(new libCommand.Command({
-	definition: ["list", "List plugins on master"],
-	handler: async function(args, control) {
-		let url = new URL(control.config.get("control.master_url"));
-		url.pathname += "api/plugins";
-		let response = await phin({
-			url,
-			parse: "json",
-			core: { ca: control.tlsCa },
-		});
-		print(asTable(response.body));
-	},
-}));
-masterCommands.add(masterPluginCommands);
-
-
-const slaveCommands = new libCommand.CommandTree({ name: "slave", description: "Slave management" });
-slaveCommands.add(new libCommand.Command({
-	definition: [["list", "l"], "List slaves connected to the master"],
-	handler: async function(args, control) {
-		let response = await libLink.messages.listSlaves.send(control);
-		print(asTable(response.list));
-	},
-}));
-
-slaveCommands.add(new libCommand.Command({
-	definition: ["generate-token", "Generate token for a slave", (yargs) => {
-		yargs.option("id", { type: "number", nargs: 1, describe: "Slave id", demandOption: true });
-	}],
-	handler: async function(args, control) {
-		let response = await libLink.messages.generateSlaveToken.send(control, { slave_id: args.id });
-		print(response.token);
-	},
-}));
-
-slaveCommands.add(new libCommand.Command({
-	definition: ["create-config", "Create slave config", (yargs) => {
-		yargs.option("id", { type: "number", nargs: 1, describe: "Slave id", default: null });
-		yargs.option("name", { type: "string", nargs: 1, describe: "Slave name", default: null });
-		yargs.option("generate-token", {
-			type: "boolean", nargs: 0, describe: "Generate authentication token", default: false,
-		});
-		yargs.option("output", {
-			type: "string", nargs: 1, describe: "Path to output config (- for stdout)", default: "config-slave.json",
-		});
-	}],
-	handler: async function(args, control) {
-		let response = await libLink.messages.createSlaveConfig.send(control, {
-			id: args.id, name: args.name, generate_token: args.generateToken,
-		});
-
-		let content = JSON.stringify(response.serialized_config, null, 4);
-		if (args.output === "-") {
-			print(content);
-		} else {
-			logger.info(`Writing ${args.output}`);
-			try {
-				await fs.outputFile(args.output, content, { flag: "wx" });
-			} catch (err) {
-				if (err.code === "EEXIST") {
-					throw new libErrors.CommandError(`File ${args.output} already exists`);
-				}
-				throw err;
-			}
-		}
-	},
-}));
-
-
-const instanceCommands = new libCommand.CommandTree({
-	name: "instance", alias: ["i"], description: "Instance management",
-});
-instanceCommands.add(new libCommand.Command({
-	definition: [["list", "l"], "List instances known to the master"],
-	handler: async function(args, control) {
-		let response = await libLink.messages.listInstances.send(control);
-		print(asTable(response.list));
-	},
-}));
-
-instanceCommands.add(new libCommand.Command({
-	definition: ["create <name>", "Create an instance", (yargs) => {
-		// XXX TODO: set any specific options?
-		yargs.positional("name", { describe: "Instance name", type: "string" });
-		yargs.options({
-			"id": { type: "number", nargs: 1, describe: "Instance id" },
-		});
-	}],
-	handler: async function(args, control) {
-		let instanceConfig = new libConfig.InstanceConfig("control");
-		await instanceConfig.init();
-		if (args.id) {
-			instanceConfig.set("instance.id", args.id);
-		}
-		instanceConfig.set("instance.name", args.name);
-		let serialized_config = instanceConfig.serialize("master");
-		let response = await libLink.messages.createInstance.send(control, { serialized_config });
-	},
-}));
-
-const instanceConfigCommands = new libCommand.CommandTree({
-	name: "config", alias: ["c"], description: "Instance config management",
-});
-instanceConfigCommands.add(new libCommand.Command({
-	definition: ["list <instance>", "List configuration for an instance", (yargs) => {
-		yargs.positional("instance", { describe: "Instance to list config for", type: "string" });
-	}],
-	handler: async function(args, control) {
-		let instanceId = await libCommand.resolveInstance(control, args.instance);
-		let response = await libLink.messages.getInstanceConfig.send(control, { instance_id: instanceId });
-
-		for (let group of response.serialized_config.groups) {
-			for (let [name, value] of Object.entries(group.fields)) {
-				print(`${group.name}.${name} ${JSON.stringify(value)}`);
-			}
-		}
-	},
-}));
-
-instanceConfigCommands.add(new libCommand.Command({
-	definition: ["set <instance> <field> [value]", "Set field in instance config", (yargs) => {
-		yargs.positional("instance", { describe: "Instance to set config on", type: "string" });
-		yargs.positional("field", { describe: "Field to set", type: "string" });
-		yargs.positional("value", { describe: "Value to set", type: "string" });
-		yargs.options({
-			"stdin": { describe: "read value from stdin", nargs: 0, type: "boolean" },
-		});
-	}],
-	handler: async function(args, control) {
-		let instanceId = await libCommand.resolveInstance(control, args.instance);
-		if (args.stdin) {
-			args.value = (await libHelpers.readStream(process.stdin)).toString().replace(/\r?\n$/, "");
-		} else if (args.value === undefined) {
-			args.value = "";
-		}
-		await libLink.messages.setInstanceConfigField.send(control, {
-			instance_id: instanceId,
-			field: args.field,
-			value: args.value,
-		});
-	},
-}));
-
-instanceConfigCommands.add(new libCommand.Command({
-	definition: ["set-prop <instance> <field> <prop> [value]", "Set property of field in instance config", (yargs) => {
-		yargs.positional("instance", { describe: "Instance to set config on", type: "string" });
-		yargs.positional("field", { describe: "Field to set", type: "string" });
-		yargs.positional("prop", { describe: "Property to set", type: "string" });
-		yargs.positional("value", { describe: "JSON parsed value to set", type: "string" });
-		yargs.options({
-			"stdin": { describe: "read value from stdin", nargs: 0, type: "boolean" },
-		});
-	}],
-	handler: async function(args, control) {
-		let instanceId = await libCommand.resolveInstance(control, args.instance);
-		if (args.stdin) {
-			args.value = (await libHelpers.readStream(process.stdin)).toString().replace(/\r?\n$/, "");
-		}
-		let request = {
-			instance_id: instanceId,
-			field: args.field,
-			prop: args.prop,
-		};
-		try {
-			if (args.value !== undefined) {
-				request.value = JSON.parse(args.value);
-			}
-		} catch (err) {
-			// If this is from stdin or looks like an array, object or string
-			// literal throw the parse error, otherwise assume this is a string.
-			// The resoning behind this is that correctly quoting the string
-			// with the all the layers of quote removal at play is difficult.
-			// See the following table for how to pass "That's a \" quote" in
-			// different environments:
-			// cmd              : """""That's a \\"" quote"""""
-			// cmd + npx        : """""""""""That's a \\\\"""" quote"""""""""""
-			// PowerShell       : '"""""That''s a \\"" quote"""""'
-			// PowerShell + npx : '"""""""""""That''s a \\\\"""" quote"""""""""""'
-			// bash             : '""That'\''s a \" quote""'
-			// bash + npx       : '""That'\''s a \" quote""'
-			// bash + npx -s sh : "'\"\"That'\\''s a \\\" quote\"\"'"
-			if (args.stdin || /^(\[.*]|{.*}|".*")$/.test(args.value)) {
-				throw new libErrors.CommandError(`In parsing value '${args.value}': ${err.message}`);
-			}
-			request.value = args.value;
-		}
-		await libLink.messages.setInstanceConfigProp.send(control, request);
-	},
-}));
-instanceCommands.add(instanceConfigCommands);
-
-instanceCommands.add(new libCommand.Command({
-	definition: ["assign <instance> [slave]", "Assign instance to a slave", (yargs) => {
-		yargs.positional("instance", { describe: "Instance to assign", type: "string" });
-		yargs.positional("slave", { describe: "Slave to assign to or unassign if none", type: "string" });
-	}],
-	handler: async function(args, control) {
-		let instanceId = await libCommand.resolveInstance(control, args.instance);
-		let slaveId = args.slave ? await libCommand.resolveSlave(control, args.slave) : null;
-		await libLink.messages.assignInstanceCommand.send(control, {
-			instance_id: instanceId,
-			slave_id: slaveId,
-		});
-	},
-}));
-
-instanceCommands.add(new libCommand.Command({
-	definition: ["create-save <instance>", "Create a new save on an instance", (yargs) => {
-		yargs.positional("instance", { describe: "Instance to create on", type: "string" });
-	}],
-	handler: async function(args, control) {
-		let instanceId = await libCommand.resolveInstance(control, args.instance);
-		await control.setLogSubscriptions({ instance_ids: [instanceId] });
-		let response = await libLink.messages.createSave.send(control, {
-			instance_id: instanceId,
-		});
-	},
-}));
-
-instanceCommands.add(new libCommand.Command({
-	definition: ["export-data <instance>", "Export item icons and locale from instance", (yargs) => {
-		yargs.positional("instance", { describe: "Instance to export from", type: "string" });
-	}],
-	handler: async function(args, control) {
-		let instanceId = await libCommand.resolveInstance(control, args.instance);
-		await control.setLogSubscriptions({ instance_ids: [instanceId] });
-		let response = await libLink.messages.exportData.send(control, {
-			instance_id: instanceId,
-		});
-	},
-}));
-
-instanceCommands.add(new libCommand.Command({
-	definition: ["start <instance>", "Start instance", (yargs) => {
-		yargs.positional("instance", { describe: "Instance to start", type: "string" });
-		yargs.options({
-			"save": { describe: "Save load, defaults to latest", nargs: 1, type: "string" },
-			"keep-open": { describe: "Keep console open", nargs: 0, type: "boolean", default: false },
-		});
-	}],
-	handler: async function(args, control) {
-		let instanceId = await libCommand.resolveInstance(control, args.instance);
-		await control.setLogSubscriptions({ instance_ids: [instanceId] });
-		let response = await libLink.messages.startInstance.send(control, {
-			instance_id: instanceId,
-			save: args.save || null,
-		});
-		control.keepOpen = args.keepOpen;
-	},
-}));
-
-instanceCommands.add(new libCommand.Command({
-	definition: ["load-scenario <instance> <scenario>", "Start instance by loading a scenario", (yargs) => {
-		yargs.positional("instance", { describe: "Instance to start", type: "string" });
-		yargs.positional("scenario", { describe: "Scenario to load", type: "string" });
-		yargs.options({
-			"keep-open": { describe: "Keep console open", nargs: 0, type: "boolean", default: false },
-		});
-	}],
-	handler: async function(args, control) {
-		let instanceId = await libCommand.resolveInstance(control, args.instance);
-		await control.setLogSubscriptions({ instance_ids: [instanceId] });
-		let response = await libLink.messages.loadScenario.send(control, {
-			instance_id: instanceId,
-			scenario: args.scenario || null,
-		});
-		control.keepOpen = args.keepOpen;
-	},
-}));
-
-instanceCommands.add(new libCommand.Command({
-	definition: ["stop <instance>", "Stop instance", (yargs) => {
-		yargs.positional("instance", { describe: "Instance to stop", type: "string" });
-	}],
-	handler: async function(args, control) {
-		let instanceId = await libCommand.resolveInstance(control, args.instance);
-		await control.setLogSubscriptions({ instance_ids: [instanceId] });
-		let response = await libLink.messages.stopInstance.send(control, {
-			instance_id: instanceId,
-		});
-	},
-}));
-
-instanceCommands.add(new libCommand.Command({
-	definition: ["delete <instance>", "Delete instance", (yargs) => {
-		yargs.positional("instance", { describe: "Instance to delete", type: "string" });
-	}],
-	handler: async function(args, control) {
-		let response = await libLink.messages.deleteInstance.send(control, {
-			instance_id: await libCommand.resolveInstance(control, args.instance),
-		});
-	},
-}));
-
-instanceCommands.add(new libCommand.Command({
-	definition: ["send-rcon <instance> <command>", "Send RCON command", (yargs) => {
-		yargs.positional("instance", { describe: "Instance to send to", type: "string" });
-		yargs.positional("command", { describe: "command to send", type: "string" });
-	}],
-	handler: async function(args, control) {
-		let response = await libLink.messages.sendRcon.send(control, {
-			instance_id: await libCommand.resolveInstance(control, args.instance),
-			command: args.command,
-		});
-
-		// Factorio includes a newline in it's response output.
-		process.stdout.write(response.result);
-	},
-}));
-
-const permissionCommands = new libCommand.CommandTree({ name: "permission", description: "Permission inspection" });
-permissionCommands.add(new libCommand.Command({
-	definition: [["list", "l"], "List permissions in the cluster"],
-	handler: async function(args, control) {
-		let response = await libLink.messages.listPermissions.send(control);
-		print(asTable(response.list));
-	},
-}));
-
-
-const roleCommands = new libCommand.CommandTree({ name: "role", description: "Role management" });
-roleCommands.add(new libCommand.Command({
-	definition: [["list", "l"], "List roles in the cluster"],
-	handler: async function(args, control) {
-		let response = await libLink.messages.listRoles.send(control);
-		print(asTable(response.list));
-	},
-}));
-
-roleCommands.add(new libCommand.Command({
-	definition: ["create <name>", "Create a new role", (yargs) => {
-		yargs.positional("name", { describe: "Name of role to create", type: "string" });
-		yargs.options({
-			"description": { describe: "Description for role", nargs: 1, type: "string", default: "" },
-			"permissions": { describe: "Permissions role grants", nargs: 1, array: true, type: "string", default: [] },
-		});
-	}],
-	handler: async function(args, control) {
-		let response = await libLink.messages.createRole.send(control, {
-			name: args.name,
-			description: args.description,
-			permissions: args.permissions,
-		});
-		logger.info(`Created role ID ${response.id}`);
-	},
-}));
-
-roleCommands.add(new libCommand.Command({
-	definition: ["edit <role>", "Edit existing role", (yargs) => {
-		yargs.positional("role", { describe: "Role to edit", type: "string" });
-		yargs.options({
-			"name": { describe: "New name for role", nargs: 1, type: "string" },
-			"description": { describe: "New description for role", nargs: 1, type: "string" },
-			"set-perms": { describe: "Set permissions for role", array: true, type: "string" },
-			"add-perms": { describe: "Add permissions to role", array: true, type: "string", conflicts: "set-perms" },
-			"remove-perms": {
-				describe: "Remove permissions from role", array: true, type: "string", conflicts: "set-perms",
-			},
-			"grant-default": { describe: "Add default permissions to role", nargs: 0, type: "boolean" },
-		});
-	}],
-	handler: async function(args, control) {
-		let role = await libCommand.retrieveRole(control, args.role);
-
-		if (args.name !== undefined) {
-			role.name = args.name;
-		}
-		if (args.description !== undefined) {
-			role.description = args.description;
-		}
-		if (args.addPerms) {
-			role.permissions = role.permissions.concat(args.addPerms);
-		}
-		if (args.removePerms) {
-			let perms = new Set(role.permissions);
-			for (let perm of args.removePerms) {
-				perms.delete(perm);
-			}
-			role.permissions = [...perms];
-		}
-		if (args.setPerms !== undefined) {
-			role.permissions = args.setPerms;
-		}
-		await libLink.messages.updateRole.send(control, role);
-
-		if (args.grantDefault) {
-			await libLink.messages.grantDefaultRolePermissions.send(control, { id: role.id });
-		}
-	},
-}));
-
-roleCommands.add(new libCommand.Command({
-	definition: ["delete <role>", "Delete role", (yargs) => {
-		yargs.positional("role", { describe: "Role to delete", type: "string" });
-	}],
-	handler: async function(args, control) {
-		let role = await libCommand.retrieveRole(control, args.role);
-		await libLink.messages.deleteRole.send(control, { id: role.id });
-	},
-}));
-
-
-const userCommands = new libCommand.CommandTree({ name: "user", alias: ["u"], description: "User management" });
-userCommands.add(new libCommand.Command({
-	definition: [["list", "l"], "List user in the cluster"],
-	handler: async function(args, control) {
-		let response = await libLink.messages.listUsers.send(control);
-		print(asTable(response.list));
-	},
-}));
-
-userCommands.add(new libCommand.Command({
-	definition: ["create <name>", "Create a user", (yargs) => {
-		yargs.positional("name", { describe: "Name of user to create", type: "string" });
-	}],
-	handler: async function(args, control) {
-		await libLink.messages.createUser.send(control, { name: args.name });
-	},
-}));
-
-userCommands.add(new libCommand.Command({
-	definition: ["set-admin <user>", "Promote or demote a user to admin", (yargs) => {
-		yargs.positional("user", { describe: "Name of user set admin status for", type: "string" });
-		yargs.options({
-			"revoke": { describe: "Revoke admin status", nargs: 0, type: "boolean", default: false },
-			"create": { describe: "Create user if it does not exist", nargs: 0, type: "boolean", default: false },
-		});
-	}],
-	handler: async function(args, control) {
-		await libLink.messages.setUserAdmin.send(control, {
-			name: args.user, create: args.create, admin: !args.revoke,
-		});
-	},
-}));
-
-userCommands.add(new libCommand.Command({
-	definition: ["set-whitelisted <user>", "Add or remove user from the whitelist", (yargs) => {
-		yargs.positional("user", { describe: "Name of user to set whitelist status for", type: "string" });
-		yargs.options({
-			"remove": { describe: "Remove from whitelist", nargs: 0, type: "boolean", default: false },
-			"create": { describe: "Create user if it does not exist", nargs: 0, type: "boolean", default: false },
-		});
-	}],
-	handler: async function(args, control) {
-		await libLink.messages.setUserWhitelisted.send(control, {
-			name: args.user, create: args.create, whitelisted: !args.remove,
-		});
-	},
-}));
-
-userCommands.add(new libCommand.Command({
-	definition: ["set-banned <user>", "Ban or pardon user from banlist", (yargs) => {
-		yargs.positional("user", { describe: "Name of user to set ban status for", type: "string" });
-		yargs.options({
-			"pardon": { describe: "Remove from banlist", nargs: 0, type: "boolean", default: false },
-			"reason": { describe: "Ban reason", nargs: 1, type: "string", default: "" },
-			"create": { describe: "Create user if it does not exist", nargs: 0, type: "boolean", default: false },
-		});
-	}],
-	handler: async function(args, control) {
-		await libLink.messages.setUserBanned.send(control, {
-			name: args.user, create: args.create, banned: !args.pardon, reason: args.reason,
-		});
-	},
-}));
-
-userCommands.add(new libCommand.Command({
-	definition: ["set-roles <user> [roles...]", "Replace user roles", (yargs) => {
-		yargs.positional("user", { describe: "Name of user to change roles for", type: "string" });
-		yargs.positional("roles", { describe: "roles to assign", type: "string" });
-	}],
-	handler: async function(args, control) {
-		let response = await libLink.messages.listRoles.send(control);
-
-		let resolvedRoles = [];
-		for (let roleName of args.roles) {
-			if (/^-?\d+$/.test(roleName)) {
-				let roleId = parseInt(roleName, 10);
-				resolvedRoles.push(roleId);
-
-			} else {
-				let found = false;
-				for (let role of response.list) {
-					if (role.name === roleName) {
-						resolvedRoles.push(role.id);
-						found = true;
-						break;
-					}
-				}
-
-				if (!found) {
-					throw new libErrors.CommandError(`No role named ${roleName}`);
-				}
-			}
-		}
-
-		await libLink.messages.updateUserRoles.send(control, { name: args.user, roles: resolvedRoles });
-	},
-}));
-
-userCommands.add(new libCommand.Command({
-	definition: ["delete <user>", "Delete user", (yargs) => {
-		yargs.positional("user", { describe: "Name of user to delete", type: "string" });
-	}],
-	handler: async function(args, control) {
-		await libLink.messages.deleteUser.send(control, { name: args.user });
-	},
-}));
-
-const logCommands = new libCommand.CommandTree({ name: "log", description: "Log inspection" });
-logCommands.add(new libCommand.Command({
-	definition: ["follow", "follow cluster log", (yargs) => {
-		yargs.options({
-			"all": { describe: "Follow the whole cluster log", nargs: 0, type: "boolean", default: false },
-			"master": { describe: "Follow log of the master server", nargs: 0, type: "boolean", default: false },
-			"slave": { describe: "Follow log of given slave", nargs: 1, type: "string", default: null },
-			"instance": { describe: "Follow log of given instance", nargs: 1, type: "string", default: null },
-		});
-	}],
-	handler: async function(args, control) {
-		if (!args.all && !args.master && !args.slave && !args.instance) {
-			logger.error("At least one of --all, --master, --slave and --instance must be passed");
-			process.exitCode = 1;
-			return;
-		}
-		let instance_ids = args.instance ? [await libCommand.resolveInstance(control, args.instance)] : [];
-		let slave_ids = args.slave ? [await libCommand.resolveSlave(control, args.slave)] : [];
-		await control.setLogSubscriptions({ all: args.all, master: args.master, slave_ids, instance_ids });
-		control.keepOpen = true;
-	},
-}));
-
-logCommands.add(new libCommand.Command({
-	definition: ["query", "Query cluster log", (yargs) => {
-		yargs.options({
-			"all": { describe: "Query the whole cluster log", nargs: 0, type: "boolean", default: false },
-			"master": { describe: "Query log of the master server", nargs: 0, type: "boolean", default: false },
-			"slave": { describe: "Query log of given slave", nargs: 1, type: "string", default: null },
-			"instance": { describe: "Query log of given instance", nargs: 1, type: "string", default: null },
-			"max-level": { describe: "Maximum log level to return", nargs: 1, type: "string", default: null },
-		});
-	}],
-	handler: async function(args, control) {
-		if (!args.all && !args.master && !args.slave && !args.instance) {
-			logger.error("At least one of --all, --master, --slave and --instance must be passed");
-			process.exitCode = 1;
-			return;
-		}
-		let instance_ids = args.instance ? [await libCommand.resolveInstance(control, args.instance)] : [];
-		let slave_ids = args.slave ? [await libCommand.resolveSlave(control, args.slave)] : [];
-		let result = await libLink.messages.queryLog.send(control, {
-			all: args.all,
-			master: args.master,
-			slave_ids,
-			instance_ids,
-			max_level: args.maxLevel,
-		});
-
-		let stdoutLogger = winston.createLogger({
-			level: "verbose",
-			levels,
-			format: new libLoggingUtils.TerminalFormat({ showTimestamp: true }),
-			transports: [
-				new ConsoleTransport({ errorLevels: [], warnLevels: [] }),
-			],
-		});
-		for (let info of result.log) {
-			stdoutLogger.log(info);
-		}
-	},
-}));
-
-const debugCommands = new libCommand.CommandTree({ name: "debug", description: "Debugging utilities" });
-debugCommands.add(new libCommand.Command({
-	definition: ["dump-ws", "Dump WebSocket messages sent and received by master", (yargs) => { }],
-	handler: async function(args, control) {
-		await libLink.messages.debugDumpWs.send(control);
-		control.keepOpen = true;
-	},
-}));
+const commands = require("./src/commands");
 
 
 /**
@@ -695,13 +28,13 @@ debugCommands.add(new libCommand.Command({
  * @private
  */
 class ControlConnector extends libLink.WebSocketClientConnector {
-	constructor(url, reconnectDelay, tlsCa, token) {
-		super(url, reconnectDelay, tlsCa);
+	constructor(url, maxReconnectDelay, tlsCa, token) {
+		super(url, maxReconnectDelay, tlsCa);
 		this._token = token;
 	}
 
 	register() {
-		logger.verbose("SOCKET | registering control");
+		logger.verbose("Connector | registering control");
 		this.sendHandshake("register_control", {
 			token: this._token,
 			agent: "clusterioctl",
@@ -748,6 +81,16 @@ class Control extends libLink.Link {
 		this.keepOpen = false;
 	}
 
+	async accountUpdateEventHandler() { }
+
+	async slaveUpdateEventHandler() { }
+
+	async instanceUpdateEventHandler() { }
+
+	async saveListUpdateEventHandler() { }
+
+	async userUpdateEventHandler() { }
+
 	async setLogSubscriptions({
 		all = false,
 		master = false,
@@ -769,8 +112,6 @@ class Control extends libLink.Link {
 	}
 
 	async shutdown() {
-		this.connector.setTimeout(30);
-
 		try {
 			await libLink.messages.prepareDisconnect.send(this);
 		} catch (err) {
@@ -779,7 +120,7 @@ class Control extends libLink.Link {
 			}
 		}
 
-		await this.connector.close(1001, "Control Quit");
+		await this.connector.close(1000, "Control Quit");
 	}
 }
 
@@ -802,30 +143,6 @@ async function loadPlugins(pluginList) {
 	return controlPlugins;
 }
 
-async function registerCommands(controlPlugins, yargs) {
-	const rootCommands = new libCommand.CommandTree({ name: "clusterioctl", description: "Manage cluster" });
-	rootCommands.add(masterCommands);
-	rootCommands.add(slaveCommands);
-	rootCommands.add(instanceCommands);
-	rootCommands.add(permissionCommands);
-	rootCommands.add(roleCommands);
-	rootCommands.add(userCommands);
-	rootCommands.add(logCommands);
-	rootCommands.add(debugCommands);
-
-	for (let controlPlugin of controlPlugins.values()) {
-		await controlPlugin.addCommands(rootCommands);
-	}
-
-	for (let [name, command] of rootCommands.subCommands) {
-		if (name === command.name) {
-			command.register(yargs);
-		}
-	}
-
-	return rootCommands;
-}
-
 async function startControl() {
 	yargs
 		.scriptName("clusterioctl")
@@ -886,7 +203,7 @@ async function startControl() {
 	let controlPlugins = await loadPlugins(pluginList);
 
 	// Add all cluster management commands including ones from plugins
-	let rootCommands = await registerCommands(controlPlugins, yargs);
+	let rootCommands = await commands.registerCommands(controlPlugins, yargs);
 
 	// Reparse after commands have been added with help and strict checking.
 	args = yargs
@@ -906,7 +223,7 @@ async function startControl() {
 			await controlConfig.init();
 
 		} else {
-			throw err;
+			throw new libErrors.StartupError(`Failed to load ${args.config}: ${err.message}`);
 		}
 	}
 
@@ -943,7 +260,7 @@ async function startControl() {
 
 	let controlConnector = new ControlConnector(
 		controlConfig.get("control.master_url"),
-		controlConfig.get("control.reconnect_delay"),
+		controlConfig.get("control.max_reconnect_delay"),
 		tlsCa,
 		controlConfig.get("control.master_token")
 	);
@@ -962,7 +279,7 @@ async function startControl() {
 		control.shutdown().catch(err => {
 			setBlocking(true);
 			logger.error(err.stack);
-			// eslint-disable-next-line no-process-exit
+			// eslint-disable-next-line node/no-process-exit
 			process.exit(1);
 		});
 	});
@@ -1008,10 +325,10 @@ I           version of clusterio.  Expect things to break. I
 	startControl().catch(err => {
 		if (!(err instanceof libErrors.StartupError)) {
 			logger.fatal(`
-+----------------------------------------------------------------+
-| Unexpected error occured while starting control, please report |
-| it to https://github.com/clusterio/factorioClusterio/issues    |
-+----------------------------------------------------------------+
++------------------------------------------------------------+
+| Unexpected error occured while starting control, please    |
+| report it to https://github.com/clusterio/clusterio/issues |
++------------------------------------------------------------+
 ${err.stack}`
 			);
 		} else {

packages/ctl/package.json

@@ -3,7 +3,7 @@
   "description": "Clusterio command line management tool",
   "author": "Hornwitser",
   "license": "MIT",
-  "version": "2.0.0-alpha.5",
+  "version": "2.0.0-alpha.13",
   "main": "ctl.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -15,14 +15,14 @@
     "factorio"
   ],
   "engines": {
-    "node": ">=10.16 <11 || >= 12"
+    "node": ">=12"
   },
   "dependencies": {
-    "@clusterio/lib": "^2.0.0-alpha.5",
+    "@clusterio/lib": "^2.0.0-alpha.13",
     "as-table": "^1.0.31",
-    "chalk": "^3.0.0",
     "fs-extra": "^8.1.0",
     "phin": "^3.5.1",
+    "set-blocking": "^2.0.0",
     "winston": "^3.3.3",
     "yargs": "^14.2.0"
   },

packages/lib/ExponentialBackoff.js

@@ -0,0 +1,85 @@
+"use strict";
+
+
+/**
+ * Helper class for implementing the exponential backoff algorithm
+ *
+ * Provides a convenient interface for implementing an exponential backoff
+ * when reconnecting or resending in a distributed network.
+ *
+ * Once instantiated the delay method will return the next interval to wait
+ * for in milliseconds before making another attempt.  For each attempt the
+ * delay chosen is a random value between 0 and the current maximum delay
+ * wwhich starts at a value of 2 * `base` and doubles for ever attempt up to
+ * the passed value of `max`.  The value for the delay will reset back to
+ * `base` if more time than the value for `reset` has passed between two
+ * invocations of delay.
+ *
+ * @alias module:lib/ExponentialBackoff
+ */
+class ExponentialBackoff {
+	/**
+	 * Construct ExponentialBackoff helper
+	 *
+	 * The options passed may also be modified on the instance at runtime.
+	 *
+	 * @param {object=} options -
+	 *     Options for this exponential backoff helper
+	 * @param {number=} [options.base=1] -
+	 *     Base delay in seconds.  The first delay will on average be this
+	 *     long, but can be anywhere between 0 and 2 times this value.
+	 * @param {number=} [options.max=60] -
+	 *     Maximum delay in seconds.  A delay will not take more than this
+	 *     value.
+	 * @param {number=} [options.reset=2*max] -
+	 *     Time in seconds between two invocations of delay which will cause
+	 *     it to start over with `base` instead of doubling.
+	 */
+	constructor(options = {}) {
+		/**
+		 * Base delay in seconds.  The first delay will on average be this
+		 * long, but can be anywhere between 0 and 2 times this value.
+		 * @type {number}
+		 */
+		this.base = options.base || 1;
+		/**
+		 * Maximum delay in seconds.  A delay will not take more than this
+		 * value.
+		 * @type {number}
+		 */
+		this.max = options.max || 60;
+		/**
+		 * Time in seconds between two invocations of delay which will cause
+		 * it to start over with `base` instead of doubling.
+		 * @type {number}
+		 */
+		this.reset = options.reset || 2 * this.max;
+
+		this._exp = 0;
+		this._lastInvocationTime = Date.now();
+	}
+
+	/**
+	 * Compute the next delay to wait
+	 *
+	 * Returns the next delay to wait according to the exponential backoff
+	 * algorithm.  This is a value between 0 and min(2 * options.base *
+	 * 2<sup>retries</sup>, optinos.max).
+	 *
+	 * @returns {number} time in milliseconds to wait.
+	 */
+	delay() {
+		let invocationTime = Date.now();
+		let interval = (invocationTime - this._lastInvocationTime) / 1000;
+		this._lastInvocationTime = invocationTime;
+
+		if (interval > this.reset) {
+			this._exp = 0;
+		}
+
+		this._exp = Math.min(this._exp + 1, Math.log2(this.max));
+		return Math.random() * this.base * 2 ** this._exp * 1000;
+	}
+}
+
+module.exports = ExponentialBackoff;

packages/lib/PlayerStats.js

@@ -0,0 +1,84 @@
+"use strict";
+
+/**
+ * Stastics collected about a player.
+ * @alias module:lib/PlayerStats
+ */
+class PlayerStats {
+	/**
+	 * Count of the number of times this player has been seen joining this server.
+	 * @type {number}
+	 */
+	joinCount = 0;
+
+	/**
+	 * Time in ms this player has been seen online on this instance.
+	 * @type {number}
+	 */
+	onlineTimeMs = 0;
+
+	/**
+	 * Timestamp the player was last seen joining.
+	 * @type {Date=}
+	 */
+	lastJoinAt;
+
+	/**
+	 * Timestamp the player was last seen leaving.
+	 * @type {Date=}
+	 */
+	lastLeaveAt;
+
+	/**
+	 * Reason the player was last seen leaving with.
+	 * @type {string=}
+	 */
+	lastLeaveReason;
+
+	static jsonSchema = {
+		type: "object",
+		properties: {
+			"join_count": { type: "integer" },
+			"online_time_ms": { type: "number" },
+			"last_join_at": { type: "number" },
+			"last_leave_at": { type: "number" },
+			"last_leave_reason": { type: "string" },
+		},
+	};
+
+	constructor(json = {}) {
+		if (json["join_count"]) {
+			this.joinCount = json["join_count"];
+		}
+		if (json["online_time_ms"]) {
+			this.onlineTimeMs = json["online_time_ms"];
+		}
+		if (json["last_join_at"]) {
+			this.lastJoinAt = new Date(json["last_join_at"]);
+		}
+		if (json["last_leave_at"]) {
+			this.lastLeaveAt = new Date(json["last_leave_at"]);
+			this.lastLeaveReason = json["last_leave_reason"] || "quit";
+		}
+	}
+
+	toJSON() {
+		let json = {};
+		if (this.joinCount) {
+			json["join_count"] = this.joinCount;
+		}
+		if (this.onlineTimeMs) {
+			json["online_time_ms"] = this.onlineTimeMs;
+		}
+		if (this.lastJoinAt) {
+			json["last_join_at"] = this.lastJoinAt.getTime();
+		}
+		if (this.lastLeaveAt) {
+			json["last_leave_at"] = this.lastLeaveAt.getTime();
+			json["last_leave_reason"] = this.lastLeaveReason;
+		}
+		return json;
+	}
+}
+
+module.exports = PlayerStats;

packages/lib/README.md

@@ -2,4 +2,4 @@
 
 This package contains functionality shared between master, slave, ctl and/or plugins of Clusterio.
 
-See [the Clusterio repository](https://github.com/clusterio/factorioClusterio) for more information on Clusterio.
+See [the Clusterio repository](https://github.com/clusterio/clusterio) for more information on Clusterio.

packages/lib/browser.js

@@ -0,0 +1,12 @@
+export { default as libConfig } from "./config";
+export { default as libErrors } from "./errors";
+export { default as libFactorio } from "./factorio/exchange_string";
+export { default as libHelpers } from "./helpers";
+export { default as libLink } from "./link";
+export { default as libLogging } from "./logging";
+export { default as libPlugin } from "./plugin";
+export { default as libSchema } from "./schema";
+export { default as libUsers } from "./users";
+
+export { default as ExponentialBackoff } from "./ExponentialBackoff";
+export { default as RateLimiter } from "./RateLimiter";

packages/lib/build_mod.js

@@ -5,8 +5,12 @@ const fs = require("fs-extra");
 const JSZip = require("jszip");
 const klaw = require("klaw");
 const path = require("path");
+const stream = require("stream");
+const util = require("util");
 const yargs = require("yargs");
 
+const finished = util.promisify(stream.finished);
+
 
 async function buildMod(args, info) {
 	if (args.build) {
@@ -42,7 +46,7 @@ async function buildMod(args, info) {
 			let modPath = path.join(args.outputDir, `${modName}.zip`);
 			console.log(`Writing ${modPath}`);
 			let writeStream = zip.generateNodeStream().pipe(fs.createWriteStream(modPath));
-			await events.once(writeStream, "finish");
+			await finished(writeStream);
 
 		} else {
 			let modDir = path.join(args.outputDir, modName);
@@ -79,7 +83,7 @@ async function build(args) {
 		for (let entry of await fs.readdir(args.outputDir)) {
 			let match = splitter.exec(entry);
 			if (match) {
-				let [, name, version] = match;
+				let name = match[1];
 				if (name === info.name) {
 					let modPath = path.join(args.outputDir, entry);
 					console.log(`Removing ${modPath}`);
@@ -90,7 +94,7 @@ async function build(args) {
 	}
 
 	if (info.variants) {
-		for (let [variant, variantOverrides] of Object.entries(info.variants)) {
+		for (let variantOverrides of info.variants) {
 			let variantInfo = {
 				...info,
 				...variantOverrides,

packages/lib/config/definitions.js

@@ -15,7 +15,7 @@ MasterGroup.groupName = "master";
 MasterGroup.define({
 	name: "name",
 	title: "Name",
-	description: "Name of the cluster",
+	description: "Name of the cluster.",
 	type: "string",
 	initial_value: "Your Cluster",
 });
@@ -83,28 +83,35 @@ MasterGroup.define({
 MasterGroup.define({
 	name: "heartbeat_interval",
 	title: "Heartbeat Interval",
-	description: "Interval heartbeats are sent out on WebSocket connections",
+	description: "Interval heartbeats are sent out on WebSocket connections.",
 	type: "number",
-	initial_value: 45,
+	initial_value: 15,
 });
 MasterGroup.define({
-	name: "connector_shutdown_timeout",
-	title: "Connector Shutdown Timeout",
-	description: "Timeout in seconds for connectors to properly disconnect on shutdown",
+	name: "session_timeout",
+	title: "Session Timeout",
+	description: "Time in seconds before giving up resuming a dropped WebSocket session.",
 	type: "number",
-	initial_value: 30,
+	initial_value: 60,
 });
 MasterGroup.define({
 	name: "metrics_timeout",
 	title: "Metrics Timeout",
-	description: "Timeout in seconds for metrics gathering from slaves",
+	description: "Timeout in seconds for metrics gathering from slaves.",
 	type: "number",
 	initial_value: 8,
 });
+MasterGroup.define({
+	name: "proxy_stream_timeout",
+	title: "Proxy Stream Timeout",
+	description: "Timeout in seconds for proxy streams to start flowing.",
+	type: "number",
+	initial_value: 15,
+});
 MasterGroup.define({
 	name: "default_role_id",
 	title: "Default role",
-	description: "ID of role assigned by default to new users",
+	description: "ID of role assigned by default to new users.",
 	type: "number",
 	optional: true,
 	initial_value: 1,
@@ -177,11 +184,11 @@ SlaveGroup.define({
 	initial_value: "localhost",
 });
 SlaveGroup.define({
-	name: "reconnect_delay",
-	title: "Reconnect Delay",
+	name: "max_reconnect_delay",
+	title: "Max Reconnect Delay",
 	description: "Maximum delay to wait before attempting to reconnect WebSocket",
 	type: "number",
-	initial_value: 5,
+	initial_value: 60,
 });
 SlaveGroup.finalize();
 
@@ -258,6 +265,14 @@ FactorioGroup.define({
 	type: "string",
 	optional: true,
 });
+FactorioGroup.define({
+	name: "player_online_autosave_slots",
+	description:
+		"Rename autosaves where players have been online since the previous autosave into a separate autosave " +
+		"pool with this many slots. Requires autosaves to be enabled to work. Set to 0 to disable.",
+	type: "number",
+	initial_value: 5,
+});
 FactorioGroup.define({
 	name: "enable_save_patching",
 	description: "Patch saves with Lua code. Required for Clusterio integrations, lua modules, and most plugins.",
@@ -270,6 +285,12 @@ FactorioGroup.define({
 	type: "boolean",
 	initial_value: false,
 });
+FactorioGroup.define({
+	name: "enable_authserver_bans",
+	description: "Turn on Factorio.com based multiplayer bans.",
+	type: "boolean",
+	initial_value: false,
+});
 FactorioGroup.define({
 	name: "settings",
 	description: "Settings overridden in server-settings.json",
@@ -351,11 +372,11 @@ ControlGroup.define({
 	optional: true,
 });
 ControlGroup.define({
-	name: "reconnect_delay",
-	title: "Reconnect Delay",
+	name: "max_reconnect_delay",
+	title: "Max Reconnect Delay",
 	description: "Maximum delay to wait before attempting to reconnect WebSocket",
 	type: "number",
-	initial_value: 2,
+	initial_value: 60,
 });
 ControlGroup.finalize();
 
@@ -369,9 +390,9 @@ ControlConfig.registerGroup(ControlGroup);
 
 
 function validateGroup(pluginInfo, groupName) {
-	if (!pluginInfo[groupName] instanceof classes.PluginConfigGroup) {
+	if (!(pluginInfo[groupName].prototype instanceof classes.PluginConfigGroup)) {
 		throw new Error(
-			`Expected ${groupName} for ${pluginInfo.name} to be an instance of PluginConfigGroup`
+			`Expected ${groupName} for ${pluginInfo.name} to be a subclass of PluginConfigGroup`
 		);
 	}
 

packages/lib/config/index.js

@@ -1,11 +1,13 @@
-/* eslint-disable global-require */
 /**
  * Configuration System
  * @author Hornwitser
  * @module lib/config
  */
 "use strict";
+const classes = require("./classes");
+const definitions = require("./definitions");
+
 module.exports = {
-	...require("./classes"),
-	...require("./definitions"),
+	...classes,
+	...definitions,
 };

packages/lib/database.js

@@ -8,6 +8,7 @@
 "use strict";
 const fs = require("fs-extra");
 
+const libFileOps = require("./file_ops");
 const { basicType } = require("./helpers");
 
 
@@ -78,7 +79,7 @@ async function loadJsonAsMap(filePath) {
  */
 async function saveMapAsJson(filePath, map) {
 	let obj = mapToObject(map);
-	await fs.outputFile(filePath, JSON.stringify(obj, null, 4));
+	await libFileOps.safeOutputFile(filePath, JSON.stringify(obj, null, 4));
 }
 
 /**
@@ -138,7 +139,7 @@ async function loadJsonArrayAsMap(filePath) {
  * @throws {Error} if an error occured writing to the file.
  */
 async function saveMapAsJsonArray(filePath, map) {
-	await fs.outputFile(filePath, JSON.stringify([...map.values()], null, 4));
+	await libFileOps.safeOutputFile(filePath, JSON.stringify([...map.values()], null, 4));
 }
 
 

packages/lib/factorio/exchange_string.js

@@ -0,0 +1,393 @@
+"use strict";
+const zlib = require("zlib");
+
+
+class MapReaderState {
+	constructor(buf) {
+		this.pos = 0;
+		this.buf = buf;
+		this.last_position = { x: 0, y: 0 };
+	}
+}
+
+function readUInt8(state) {
+	let value = state.buf.readUInt8(state.pos);
+	state.pos += 1;
+	return value;
+}
+
+function readBool(state) {
+	let value = readUInt8(state) !== 0;
+	return value;
+}
+
+function readInt16(state) {
+	let value = state.buf.readInt16LE(state.pos);
+	state.pos += 2;
+	return value;
+}
+
+function readUInt16(state) {
+	let value = state.buf.readUInt16LE(state.pos);
+	state.pos += 2;
+	return value;
+}
+
+function readInt32(state) {
+	let value = state.buf.readInt32LE(state.pos);
+	state.pos += 4;
+	return value;
+}
+
+function readUInt32(state) {
+	let value = state.buf.readUInt32LE(state.pos);
+	state.pos += 4;
+	return value;
+}
+
+function readUInt32so(state) {
+	let value = readUInt8(state);
+	if (value === 0xff) {
+		return readUInt32(state);
+	}
+
+	return value;
+}
+
+function readFloat(state) {
+	let value = state.buf.readFloatLE(state.pos);
+	state.pos += 4;
+	return value;
+}
+
+function readDouble(state) {
+	let value = state.buf.readDoubleLE(state.pos);
+	state.pos += 8;
+	return value;
+}
+
+function readString(state) {
+	let size = readUInt32so(state);
+	let data = state.buf.slice(state.pos, state.pos + size).toString("utf-8");
+	state.pos += size;
+	return data;
+}
+
+function readOptional(state, readValue) {
+	let load = readUInt8(state) !== 0;
+	if (!load) {
+		return null;
+	}
+	return readValue(state);
+}
+
+function readArray(state, readItem) {
+	let size = readUInt32so(state);
+
+	let array = [];
+	for (let i = 0; i < size; i++) {
+		let item = readItem(state);
+		array.push(item);
+	}
+
+	return array;
+}
+
+function readDict(state, readKey, readValue) {
+	let size = readUInt32so(state);
+
+	let mapping = new Map();
+	for (let i = 0; i < size; i++) {
+		let key = readKey(state);
+		let value = readValue(state);
+		mapping.set(key, value);
+	}
+
+	return mapping;
+}
+
+function readVersion(state) {
+	let major = readUInt16(state);
+	let minor = readUInt16(state);
+	let patch = readUInt16(state);
+	let developer = readUInt16(state);
+	return [major, minor, patch, developer];
+}
+
+function readFrequencySizeRichness(state) {
+	return {
+		frequency: readFloat(state),
+		size: readFloat(state),
+		richness: readFloat(state),
+	};
+}
+
+function readAutoplaceSetting(state) {
+	return {
+		treat_missing_as_default: readBool(state),
+		settings: Object.fromEntries(readDict(state, readString, readFrequencySizeRichness)),
+	};
+}
+
+function readMapPosition(state) {
+	let x, y;
+	let x_diff = readInt16(state) / 256;
+	if (x_diff === 0x7fff / 256) {
+		x = readInt32(state) / 256;
+		y = readInt32(state) / 256;
+	} else {
+		let y_diff = readInt16(state) / 256;
+		x = state.last_position.x + x_diff;
+		y = state.last_position.y + y_diff;
+	}
+	state.last_position.x = x;
+	state.last_position.x = y;
+	return { x, y };
+}
+
+function readBoundingBox(state) {
+	return {
+		left_top: readMapPosition(state),
+		right_bottom: readMapPosition(state),
+		orientation: {
+			x: readInt16(state),
+			y: readInt16(state),
+		},
+	};
+}
+
+function readCliffSettings(state) {
+	return {
+		name: readString(state),
+		elevation_0: readFloat(state),
+		elevation_interval: readFloat(state),
+		richness: readFloat(state),
+	};
+}
+
+function readMapGenSettings(state) {
+	return {
+		terrain_segmentation: readFloat(state),
+		water: readFloat(state),
+		autoplace_controls: Object.fromEntries(readDict(state, readString, readFrequencySizeRichness)),
+		autoplace_settings: Object.fromEntries(readDict(state, readString, readAutoplaceSetting)),
+		default_enable_all_autoplace_controls: readBool(state),
+		seed: readUInt32(state),
+		width: readUInt32(state),
+		height: readUInt32(state),
+		area_to_generate_at_start: readBoundingBox(state),
+		starting_area: readFloat(state),
+		peaceful_mode: readBool(state),
+		starting_points: readArray(state, readMapPosition),
+		property_expression_names: Object.fromEntries(readDict(state, readString, readString)),
+		cliff_settings: readCliffSettings(state),
+	};
+}
+
+function readPollution(state) {
+	return {
+		enabled: readOptional(state, readBool),
+		diffusion_ratio: readOptional(state, readDouble),
+		min_to_diffuse: readOptional(state, readDouble),
+		ageing: readOptional(state, readDouble),
+		expected_max_per_chunk: readOptional(state, readDouble),
+		min_to_show_per_chunk: readOptional(state, readDouble),
+		min_pollution_to_damage_trees: readOptional(state, readDouble),
+		pollution_with_max_forest_damage: readOptional(state, readDouble),
+		pollution_per_tree_damage: readOptional(state, readDouble),
+		pollution_restored_per_tree_damage: readOptional(state, readDouble),
+		max_pollution_to_restore_trees: readOptional(state, readDouble),
+		enemy_attack_pollution_consumption_modifier: readOptional(state, readDouble),
+	};
+}
+
+function readSteeringValue(state) {
+	return {
+		radius: readOptional(state, readDouble),
+		separation_factor: readOptional(state, readDouble),
+		separation_force: readOptional(state, readDouble),
+		force_unit_fuzzy_goto_behavior: readOptional(state, readBool),
+	};
+
+}
+
+function readSteering(state) {
+	return {
+		default: readSteeringValue(state),
+		moving: readSteeringValue(state),
+	};
+}
+
+function readEnemyEvolution(state) {
+	return {
+		enabled: readOptional(state, readBool),
+		time_factor: readOptional(state, readDouble),
+		destroy_factor: readOptional(state, readDouble),
+		pollution_factor: readOptional(state, readDouble),
+	};
+}
+
+function readEnemyExpansion(state) {
+	return {
+		enabled: readOptional(state, readBool),
+		max_expansion_distance: readOptional(state, readUInt32),
+		friendly_base_influence_radius: readOptional(state, readUInt32),
+		enemy_building_influence_radius: readOptional(state, readUInt32),
+		building_coefficient: readOptional(state, readDouble),
+		other_base_coefficient: readOptional(state, readDouble),
+		neighbouring_chunk_coefficient: readOptional(state, readDouble),
+		neighbouring_base_chunk_coefficient: readOptional(state, readDouble),
+		max_colliding_tiles_coefficient: readOptional(state, readDouble),
+		settler_group_min_size: readOptional(state, readUInt32),
+		settler_group_max_size: readOptional(state, readUInt32),
+		min_expansion_cooldown: readOptional(state, readUInt32),
+		max_expansion_cooldown: readOptional(state, readUInt32),
+	};
+}
+
+function readUnitGroup(state) {
+	return {
+		min_group_gathering_time: readOptional(state, readUInt32),
+		max_group_gathering_time: readOptional(state, readUInt32),
+		max_wait_time_for_late_members: readOptional(state, readUInt32),
+		max_group_radius: readOptional(state, readDouble),
+		min_group_radius: readOptional(state, readDouble),
+		max_member_speedup_when_behind: readOptional(state, readDouble),
+		max_member_slowdown_when_ahead: readOptional(state, readDouble),
+		max_group_slowdown_factor: readOptional(state, readDouble),
+		max_group_member_fallback_factor: readOptional(state, readDouble),
+		member_disown_distance: readOptional(state, readDouble),
+		tick_tolerance_when_member_arrives: readOptional(state, readUInt32),
+		max_gathering_unit_groups: readOptional(state, readUInt32),
+		max_unit_group_size: readOptional(state, readUInt32),
+	};
+}
+
+function readPathFinder(state) {
+	return {
+		fwd2bwd_ratio: readOptional(state, readInt32),
+		goal_pressure_ratio: readOptional(state, readDouble),
+		use_path_cache: readOptional(state, readBool),
+		max_steps_worked_per_tick: readOptional(state, readDouble),
+		max_work_done_per_tick: readOptional(state, readUInt32),
+		short_cache_size: readOptional(state, readUInt32),
+		long_cache_size: readOptional(state, readUInt32),
+		short_cache_min_cacheable_distance: readOptional(state, readDouble),
+		short_cache_min_algo_steps_to_cache: readOptional(state, readUInt32),
+		long_cache_min_cacheable_distance: readOptional(state, readDouble),
+		cache_max_connect_to_cache_steps_multiplier: readOptional(state, readUInt32),
+		cache_accept_path_start_distance_ratio: readOptional(state, readDouble),
+		cache_accept_path_end_distance_ratio: readOptional(state, readDouble),
+		negative_cache_accept_path_start_distance_ratio: readOptional(state, readDouble),
+		negative_cache_accept_path_end_distance_ratio: readOptional(state, readDouble),
+		cache_path_start_distance_rating_multiplier: readOptional(state, readDouble),
+		cache_path_end_distance_rating_multiplier: readOptional(state, readDouble),
+		stale_enemy_with_same_destination_collision_penalty: readOptional(state, readDouble),
+		ignore_moving_enemy_collision_distance: readOptional(state, readDouble),
+		enemy_with_different_destination_collision_penalty: readOptional(state, readDouble),
+		general_entity_collision_penalty: readOptional(state, readDouble),
+		general_entity_subsequent_collision_penalty: readOptional(state, readDouble),
+		extended_collision_penalty: readOptional(state, readDouble),
+		max_clients_to_accept_any_new_request: readOptional(state, readUInt32),
+		max_clients_to_accept_short_new_request: readOptional(state, readUInt32),
+		direct_distance_to_consider_short_request: readOptional(state, readUInt32),
+		short_request_max_steps: readOptional(state, readUInt32),
+		short_request_ratio: readOptional(state, readDouble),
+		min_steps_to_check_path_find_termination: readOptional(state, readUInt32),
+		start_to_goal_cost_multiplier_to_terminate_path_find: readOptional(state, readDouble),
+		overload_levels: readOptional(state, (p) => readArray(p, readUInt32)),
+		overload_multipliers: readOptional(state, (p) => readArray(p, readDouble)),
+		negative_path_cache_delay_interval: readOptional(state, readUInt32),
+	};
+}
+
+function readDifficultySettings(state) {
+	return {
+		recipe_difficulty: readUInt8(state),
+		technology_difficulty: readUInt8(state),
+		technology_price_multiplier: readDouble(state),
+		research_queue_setting: ["always", "after-victory", "never"][readUInt8(state)],
+	};
+}
+
+function readMapSettings(state) {
+	return {
+		pollution: readPollution(state),
+		steering: readSteering(state),
+		enemy_evolution: readEnemyEvolution(state),
+		enemy_expansion: readEnemyExpansion(state),
+		unit_group: readUnitGroup(state),
+		path_finder: readPathFinder(state),
+		max_failed_behavior_count: readUInt32(state),
+		difficulty_settings: readDifficultySettings(state),
+	};
+}
+
+/**
+ * @typedef {object} module:lib/factorio.MapExchangeResult
+ * @property {array} version -
+ *     Version of Factorio the string was created with.
+ * @property {object} map_gen_settings -
+ *     Decoded map generator settings in the format the --map-gen-settings
+ *     command line option to Factorio expect.
+ * @property {object} map_settings -
+ *     Decoded map settings in the format the --map-settings command line option
+ *     to Factorio expects.
+ * @property {number} checksum - checksum for the exchange string.
+ */
+
+/**
+ * Parse a Map Exchange String
+ *
+ * Reads and decodes the data in the given map exchange string and returns
+ * data structures that can be fed into the Factorio server when creating a
+ * save to set the map gen settings and the map settings for the save.
+ *
+ * @param {string} exchangeString - Max Exchange String to parse.
+ * @returns {module:lib/factorio.MapExchangeResult} Parsed result.
+ * @memberof module:lib/factorio
+ */
+function readMapExchangeString(exchangeString) {
+	exchangeString = exchangeString.replace(/[ \t\n\r]+/g, "");
+	if (!/>>>[0-9a-zA-Z\/+]+={0,3}<<</.test(exchangeString)) {
+		throw new Error("Not a map exchange string");
+	}
+
+	let buf = Buffer.from(exchangeString.slice(3, -3), "base64");
+	try {
+		// eslint-disable-next-line node/no-sync
+		buf = zlib.inflateSync(buf);
+	} catch (err) {
+		if (err.code.startsWith("Z_")) {
+			throw new Error("Malformed map exchange string: zlib inflate failed");
+		}
+	}
+
+	let state = new MapReaderState(buf);
+	let data;
+
+	try {
+		data = {
+			version: readVersion(state),
+			unknown: readUInt8(state),
+			map_gen_settings: readMapGenSettings(state),
+			map_settings: readMapSettings(state),
+			checksum: readUInt32(state),
+		};
+	} catch (err) {
+		if (err.code === "ERR_OUT_OF_RANGE") {
+			throw new Error("Malformed map exchange string: reached end before finishing parsing");
+		}
+		throw err;
+	}
+
+	if (state.pos !== buf.length) {
+		throw new Error("Malformed map exchange string: data after end");
+	}
+
+	return data;
+}
+
+module.exports = {
+	readMapExchangeString,
+};

packages/lib/factorio/export.js

@@ -2,10 +2,10 @@
 "use strict";
 const fs = require("fs-extra");
 const path = require("path");
-const ini = require("ini");
 const Jimp = require("jimp");
 const JSZip = require("jszip");
 
+const libIni = require("../ini");
 const libBuildMod = require("../build_mod");
 
 /**
@@ -90,7 +90,16 @@ async function loadFile(server, modVersions, modPath) {
 		}
 	}
 
-	let zip = await loadZip(server, modVersions, mod);
+	let zip;
+	try {
+		zip = await loadZip(server, modVersions, mod);
+	} catch (err) {
+		if (err.code === "ENOENT") {
+			return null;
+		}
+		throw err;
+	}
+
 	let file = zip.file(filePath);
 	if (!file) {
 		return null;
@@ -303,17 +312,25 @@ async function exportLocale(server, modVersions, modOrder, languageCode) {
 	}
 
 	let baseLocaleFilePath = server.dataPath("base", "locale", languageCode, "base.cfg");
-	mergeLocale(ini.parse(await fs.readFile(baseLocaleFilePath, "utf8")));
+	mergeLocale(libIni.parse(await fs.readFile(baseLocaleFilePath, "utf8")));
 
 	for (let mod of modOrder) {
 		if (["core", "base", "export"].includes(mod)) {
 			continue;
 		}
 
-		let zip = await loadZip(server, modVersions, mod);
+		let zip;
+		try {
+			zip = await loadZip(server, modVersions, mod);
+		} catch (err) {
+			if (err.code === "ENOENT") {
+				continue;
+			}
+			throw err;
+		}
 		for (let file of zip.file(new RegExp(`locale\\/${languageCode}\\/.*\\.cfg`))) {
 			let content = await file.async("nodebuffer");
-			mergeLocale(ini.parse(content.toString("utf8")));
+			mergeLocale(libIni.parse(content.toString("utf8")));
 		}
 	}
 
@@ -357,6 +374,28 @@ async function exportData(server) {
 		throw new Error("No items got exported");
 	}
 
+	// Some mod authors put leading zeros into the versions of their zip files.
+	let splitter = /^(.*)_(\d+)\.(\d+)\.(\d+)\.zip?$/;
+	for (let entry of await fs.readdir(server.writePath("mods"))) {
+		let match = splitter.exec(entry);
+		if (!match) {
+			continue;
+		}
+
+		let modVersion = `${match[2]}.${match[3]}.${match[4]}`;
+		let normalizedVersion =
+			`${Number.parseInt(match[2], 10)}.${Number.parseInt(match[3], 10)}.${Number.parseInt(match[4], 10)}`
+		;
+
+		if (modVersion === normalizedVersion) {
+			continue;
+		}
+
+		if (modVersions.get(match[1]) === normalizedVersion) {
+			modVersions.set(match[1], modVersion);
+		}
+	}
+
 	let { iconSheet, itemData } = await exportItems(server, modVersions, items);
 	let locale = await exportLocale(server, modVersions, modOrder, "en");
 

packages/lib/factorio/index.js

@@ -1,12 +1,17 @@
-/* eslint-disable global-require */
 /**
  * Library for interfacing with Factorio Servers and saves.
  * @module lib/factorio
  * @author Hornwitser
  */
 "use strict";
+const exchange_string = require("./exchange_string");
+const export_ = require("./export");
+const patch = require("./patch");
+const server = require("./server");
+
 module.exports = {
-	...require("./export"),
-	...require("./patch"),
-	...require("./server"),
+	...exchange_string,
+	...export_,
+	...patch,
+	...server,
 };

packages/lib/factorio/patch.js

@@ -284,9 +284,11 @@ async function patch(savePath, modules) {
 	root.file("clusterio.json", JSON.stringify(patchInfo, null, 4));
 
 	// Write back the save
+	let tempSavePath = `${savePath}.tmp`;
 	let stream = zip.generateNodeStream({ compression: "DEFLATE" });
-	let pipe = stream.pipe(fs.createWriteStream(savePath));
+	let pipe = stream.pipe(fs.createWriteStream(tempSavePath));
 	await events.once(pipe, "finish");
+	await fs.rename(tempSavePath, savePath);
 }
 
 module.exports = {

packages/lib/factorio/server.js

@@ -6,12 +6,14 @@ const path = require("path");
 const events = require("events");
 const util = require("util");
 const crypto = require("crypto");
-
-const ini = require("ini");
 const rconClient = require("rcon-client");
+
 const libErrors = require("../errors");
+const libFileOps = require("../file_ops");
+const libIni = require("../ini");
 const { logger } = require("../logging");
 const { escapeRegExp } = require("../helpers");
+const { LineSplitter } = require("../stream");
 
 
 /**
@@ -193,82 +195,6 @@ async function generatePassword(length) {
 	}
 }
 
-/**
- * Line splitter for chunked data
- *
- * Splits a stream of bytes into lines terminated by either line feed or
- * carriage return followed by linefeed.  Each line sepparated is passed
- * to the callback one at a time without the line terminator included.
- *
- * Data is streamed via the data method, and once the stream ends the
- * end method should be called.  This ensures an unterminated line at
- * the end of the stream is passed to the callback.
- *
- * @memberof module:lib/factorio
- * @private
- * @inner
- */
-class LineSplitter {
-
-	/**
-	 * Create a line splitter
-	 *
-	 * @param {function(Buffer)} callback - Function called for every line.
-	 */
-	constructor(callback) {
-		this._callback = callback;
-		this._partial = null;
-	}
-
-	/**
-	 * Stream in bytes
-	 *
-	 * Input bytes to split lines over.  Will invoke the callback for every
-	 * line found in buf and keep any potential partial line at the end of
-	 * buf for the next invocation.
-	 *
-	 * @param {Buffer} buf - Data to stream in.
-	 */
-	data(buf) {
-		if (this._partial) {
-			buf = Buffer.concat([this._partial, buf]);
-			this._partial = null;
-		}
-
-		while (buf.length) {
-			let end = buf.indexOf("\n");
-			if (end === -1) {
-				this._partial = buf;
-				break;
-			}
-
-			let next = end + 1;
-			// Eat carriage return as well if present
-			if (end >= 1 && buf[end-1] === "\r".charCodeAt(0)) {
-				end -= 1;
-			}
-
-			let line = buf.slice(0, end);
-			buf = buf.slice(next);
-			this._callback(line);
-		}
-	}
-
-	/**
-	 * Mark end of stream
-	 *
-	 * Signal the end of the bytestream.  If the previous invocation of the
-	 * data method ended with a partial line this will invoke the callback
-	 * with this line.
-	 */
-	end() {
-		if (this._partial) {
-			this._callback(this._partial);
-			this._partial = null;
-		}
-	}
-}
-
 /**
  * Interpret lines of output from Factorio
  *
@@ -375,7 +301,7 @@ const outputHeuristics = [
 
 	// Message indicating the server is done starting up
 	{
-		filter: { type: "log", message: /^updateTick\(\d+\) changing state from\(CreatingGame\) to\(InGame\)$/ },
+		filter: { type: "log", message: /^(update|map)Tick\(\d+\) changing state from\(CreatingGame\) to\(InGame\)$/ },
 		action: function() {
 			this._notifyGameReady().catch((err) => { this.emit("error", err); });
 		},
@@ -483,6 +409,7 @@ const outputHeuristics = [
  * - game-ready - invoked when the server is finished starting up
  * - autosave-start - invoked when the server starts an autosave
  * - autosave-fnished - invoked when the autosave finished
+ * - save-finished - invoked when the server has finished a manual save
  * - exit - invoked when the sterver has exited
  * @extends events.EventEmitter
  * @memberof module:lib/factorio
@@ -502,6 +429,8 @@ class FactorioServer extends events.EventEmitter {
 	 * @param {number} options.rconPort - TCP port to use for RCON.
 	 * @param {string} options.rconPassword - Password use for RCON.
 	 * @param {boolean} options.enableWhitelist - Turn on whitelisting.
+	 * @param {boolean} options.enableAuthserverBans -
+	 *     Enable Factorio.com based multiplayer bans.
 	 * @param {boolean} options.verboseLogging - Enable verbose logging.
 	 * @param {boolean} options.stripPaths - Strip paths in the console.
 	 * @param {number} options.maxConcurrentCommands -
@@ -530,6 +459,8 @@ class FactorioServer extends events.EventEmitter {
 		this.rconPassword = options.rconPassword;
 		/** Enable player whitelist */
 		this.enableWhitelist = options.enableWhitelist;
+		/** Enable Factorio.com based multiplayer bans **/
+		this.enableAuthserverBans = options.enableAuthserverBans;
 		/** Enable verbose logging */
 		this.verboseLogging = options.verboseLogging;
 		/** Maximum number of RCON commands transmitted in parallel on the RCON connection  */
@@ -561,9 +492,7 @@ class FactorioServer extends events.EventEmitter {
 
 		// Array of possible causes for an unexpected shutdown
 		this._unexpected = [];
-
-		this._stdout = new LineSplitter((line) => { this._handleOutput(line, "stdout"); });
-		this._stderr = new LineSplitter((line) => { this._handleOutput(line, "stderr"); });
+		this._killed = false;
 
 		// Track autosaving
 		this._runningAutosave = null;
@@ -576,6 +505,8 @@ class FactorioServer extends events.EventEmitter {
 			if (this._runningAutosave) {
 				this.emit("autosave-finished", this._runningAutosave);
 				this._runningAutosave = null;
+			} else {
+				this.emit("save-finished");
 			}
 		});
 	}
@@ -605,7 +536,11 @@ class FactorioServer extends events.EventEmitter {
 		let type = line.slice(channelEnd + 1, channelEnd + 2).toString("utf-8");
 		let content;
 		if (type === "j") {
-			content = JSON.parse(line.slice(channelEnd + 2).toString("utf-8"));
+			try {
+				content = JSON.parse(line.slice(channelEnd + 2).toString("utf-8"));
+			} catch (err) {
+				throw new Error(`Malformed JSON to ${channel}: ${line.slice(channelEnd + 2).toString("utf-8")}`);
+			}
 
 		} else if (type === "f") {
 			let fileName = line.slice(channelEnd + 2).toString("utf-8");
@@ -685,7 +620,7 @@ class FactorioServer extends events.EventEmitter {
 		}
 
 		let config = {
-			host: "localhost",
+			host: "127.0.0.1", // localhost may resolve to ::1 while Factorio listen to only IPv4 by default.
 			port: this.rconPort,
 			password: this.rconPassword,
 			timeout: 200000, // 200s, should allow for commands up to 1250kB in length
@@ -756,37 +691,41 @@ class FactorioServer extends events.EventEmitter {
 	}
 
 	_attachStdio() {
-		this._server.stdout.on("data", chunk => { this._stdout.data(chunk); });
-		this._server.stdout.on("close", () => { this._stdout.end(); });
-		this._server.stderr.on("data", chunk => { this._stderr.data(chunk); });
-		this._server.stderr.on("close", () => { this._stderr.end(); });
+		let stdout = new LineSplitter({ readableObjectMode: true });
+		stdout.on("data", line => { this._handleOutput(line, "stdout"); });
+		this._server.stdout.pipe(stdout);
+		let stderr = new LineSplitter({ readableObjectMode: true });
+		stderr.on("data", line => { this._handleOutput(line, "stderr"); });
+		this._server.stderr.pipe(stderr);
 	}
 
 	_watchExit() {
 		this._server.on("exit", (code, signal) => {
 			if (this._state !== "stopping") {
-				if (this._unexpected.length === 0) {
-					if (signal === "SIGKILL") {
+				if (signal === "SIGKILL") {
+					if (this._killed) {
+						this.emit("error", new libErrors.EnvironmentError("Factorio server was killed"));
+					} else {
 						this.emit("error", new libErrors.EnvironmentError(
 							"Factorio server was unexpectedly killed, is the system low on memory?"
 						));
-
-					} else {
-						let msg;
-						if (code !== null) {
-							msg = `Factorio server unexpectedly shut down with code ${code}`;
-						} else {
-							msg = `Factorio server was unexpectedly shut by down by signal ${signal}`;
-						}
-
-						this.emit("error", new Error(msg));
 					}
 
+				} else if (this._unexpected.length === 0) {
+					let msg;
+					if (code !== null) {
+						msg = `Factorio server unexpectedly shut down with code ${code}`;
+					} else {
+						msg = `Factorio server was unexpectedly shut by down by signal ${signal}`;
+					}
+
+					this.emit("error", new libErrors.EnvironmentError(msg));
+
 				} else if (this._unexpected.length === 1) {
-					this.emit("error", new Error(this._unexpected[0]));
+					this.emit("error", new libErrors.EnvironmentError(this._unexpected[0]));
 
 				} else {
-					this.emit("error", new Error(
+					this.emit("error", new libErrors.EnvironmentError(
 						"Factorio server unexpectedly shut down. Possible causes:"+
 						`\n- ${this._unexpected.join("\n- ")}`
 					));
@@ -829,17 +768,26 @@ class FactorioServer extends events.EventEmitter {
 	 *
 	 * @param {string} name -
 	 *     Name of the save to create.  Should end with ".zip".
+	 * @param {?number=} seed - Seed to pass via --map-gen-seed
+	 * @param {?object=} mapGenSettings -
+	 *     Map get settings to pass via --map-gen-settings.
+	 * @param {?object=} mapSettings -
+	 *     Map setting to pass via --map-settings.
 	 */
-	async create(name) {
+	async create(name, seed = null, mapGenSettings = null, mapSettings = null) {
 		this._check(["init"]);
 		this._state = "create";
 
 		await this._writeConfigIni();
+		await this._writeMapSettings(mapGenSettings, mapSettings);
 		this._server = child_process.spawn(
 			this.binaryPath(),
 			[
 				"--config", this.writePath("config.ini"),
 				"--create", this.writePath("saves", name),
+				...(seed !== null ? ["--map-gen-seed", seed] : []),
+				...(mapGenSettings !== null ? ["--map-gen-settings", this.writePath("map-gen-settings.json")] : []),
+				...(mapSettings !== null ? ["--map-settings", this.writePath("map-settings.json")] : []),
 				...(this.verboseLogging ? ["--verbose"] : []),
 			],
 			{
@@ -853,6 +801,7 @@ class FactorioServer extends events.EventEmitter {
 
 		try {
 			let [code, signal] = await events.once(this._server, "exit");
+			void signal;
 			if (code !== 0) {
 				throw new Error(`Factorio exited with status ${code}`);
 			}
@@ -883,6 +832,7 @@ class FactorioServer extends events.EventEmitter {
 				"--rcon-port", this.rconPort,
 				"--rcon-password", this.rconPassword,
 				...(this.enableWhitelist ? ["--use-server-whitelist"] : []),
+				...(this.enableAuthserverBans ? ["--use-authserver-bans"] : []),
 				...(this.verboseLogging ? ["--verbose"] : []),
 			],
 			{
@@ -903,21 +853,31 @@ class FactorioServer extends events.EventEmitter {
 	 * argument to start the given scenario.
 	 *
 	 * @param {string} scenario - Name of the scenario to run.
+	 * @param {?number=} seed - Seed to pass via --map-gen-seed
+	 * @param {?object=} mapGenSettings -
+	 *     Map get settings to pass via --map-gen-settings.
+	 * @param {?object=} mapSettings -
+	 *     Map setting to pass via --map-settings.
 	 */
-	async startScenario(scenario) {
+	async startScenario(scenario, seed = null, mapGenSettings = null, mapSettings = null) {
 		this._check(["init"]);
 		this._state = "running";
 
 		await this._writeConfigIni();
+		await this._writeMapSettings(mapGenSettings, mapSettings);
 		this._server = child_process.spawn(
 			this.binaryPath(),
 			[
 				"--config", this.writePath("config.ini"),
 				"--start-server-load-scenario", scenario,
+				...(seed !== null ? ["--map-gen-seed", seed] : []),
+				...(mapGenSettings !== null ? ["--map-gen-settings", this.writePath("map-gen-settings.json")] : []),
+				...(mapSettings !== null ? ["--map-settings", this.writePath("map-settings.json")] : []),
 				"--port", this.gamePort,
 				"--rcon-port", this.rconPort,
 				"--rcon-password", this.rconPassword,
 				...(this.enableWhitelist ? ["--use-server-whitelist"] : []),
+				...(this.enableAuthserverBans ? ["--use-authserver-bans"] : []),
 				...(this.verboseLogging ? ["--verbose"] : []),
 			],
 			{
@@ -1056,12 +1016,18 @@ class FactorioServer extends events.EventEmitter {
 	 * Kill the server
 	 *
 	 * Terminates the server without any cleanup or saving.
+	 * @param {boolean} [unexpected=false] -
+	 *     If true raise an error event as a result of killing the Factorio
+	 *     process.
 	 */
-	async kill() {
+	async kill(unexpected = false) {
 		this._check(["running", "stopping"]);
-		this._state = "stopping";
+		this._killed = true;
+		if (!unexpected) {
+			this._state = "stopping";
+		}
 		this._server.kill("SIGKILL");
-		await events.once(this._server, "exit");
+		await new Promise(resolve => this._server.once("exit", resolve));
 	}
 
 	/**
@@ -1145,13 +1111,26 @@ class FactorioServer extends events.EventEmitter {
 	}
 
 	async _writeConfigIni() {
-		let content = ini.encode({
+		let content = libIni.stringify({
 			path: {
 				"read-data": this.dataPath(),
 				"write-data": this.writePath(),
 			},
 		});
-		await fs.outputFile(this.writePath("config.ini"), content);
+		await libFileOps.safeOutputFile(this.writePath("config.ini"), content);
+	}
+
+	async _writeMapSettings(mapGenSettings, mapSettings) {
+		if (mapGenSettings) {
+			await libFileOps.safeOutputFile(
+				this.writePath("map-gen-settings.json"), JSON.stringify(mapGenSettings, null, 4)
+			);
+		}
+		if (mapSettings) {
+			await libFileOps.safeOutputFile(
+				this.writePath("map-settings.json"), JSON.stringify(mapSettings, null, 4)
+			);
+		}
 	}
 }
 
@@ -1165,6 +1144,5 @@ module.exports = {
 	_findVersion: findVersion,
 	_randomDynamicPort: randomDynamicPort,
 	_generatePassword: generatePassword,
-	_LineSplitter: LineSplitter,
 	_parseOutput: parseOutput,
 };

packages/lib/file_ops.js

@@ -4,7 +4,7 @@
 "use strict";
 const fs = require("fs-extra");
 const path = require("path");
-
+const crypto = require("crypto"); // needed for getTempFile
 /**
  * Returns the newest file in a directory
  *
@@ -32,6 +32,85 @@ async function getNewestFile(directory, filter = (name) => true) {
 	return newestFile;
 }
 
+/**
+ * Modifies name in case it already exisist at the given directory
+ *
+ * Checks the directory passed if it already contains a file or folder with
+ * the given name, if it does not returns name unmodified, otherwise it
+ * returns a modified name that does not exist in the directory.
+ *
+ * Warning: this function should not be relied upon to be accurate for
+ * security sensitive applications.  The selection process is inherently
+ * racy and a file or folder may have been created in the folder by the time
+ * this function returns.
+ *
+ * @param {string} directory - directory to check in.
+ * @param {string} name - file name to check for, may have extension.
+ * @param {string} extension - dot extension used for the file name.
+ * @returns {string} modified name with extension that likely does not exist
+ *     in the folder
+ */
+async function findUnusedName(directory, name, extension = "") {
+	if (extension && name.endsWith(extension)) {
+		name = name.slice(0, -extension.length);
+	}
+
+	while (true) {
+		if (!await fs.pathExists(path.join(directory, `${name}${extension}`))) {
+			return `${name}${extension}`;
+		}
+
+		let match = /^(.*?)(-(\d+))?$/.exec(name);
+		if (!match[2]) {
+			name = `${match[1]}-2`;
+		} else {
+			name = `${match[1]}-${Number.parseInt(match[3], 10) + 1}`;
+		}
+	}
+}
+/**
+ * Warning: this function should not be relied upon to be accurate for
+ * security sensitive applications.  The selection process is inherently
+ * racy and a file or folder may have been created in the folder by the time
+ * this function returns.
+ *
+ * @param {string} prefix - Prefix for file
+ * @param {string} suffix - Suffix for file
+ * @param {string} tmpdir - Directory for temp file
+ */
+async function getTempFile(prefix, suffix, tmpdir) {
+	prefix = (typeof prefix !== "undefined") ? prefix : "tmp.";
+	suffix = (typeof suffix !== "undefined") ? suffix : "";
+	tmpdir = (typeof tmpdir !== "undefined") ? tmpdir : "./";
+	let fileName = path.join(prefix + crypto.randomBytes(16).toString("hex") + suffix);
+	let freeFile = await findUnusedName(tmpdir, fileName);
+	let fullPath = path.join(tmpdir, freeFile);
+	return fullPath;
+}
+/**
+ * Safely write data to a file
+ *
+ * Same as fs-extra.outputFile except the data is written to a temporary
+ * file that's renamed over the target file.  The name of the temporary file
+ * is the same as the target file with the suffix `.tmp` added.
+ *
+ * If the operation fails it may leave behind the temporary file.  This
+ * should not be too much of an issue as the next time the same file is
+ * written the temporary will be overwritten and renamed to the target file.
+ *
+ * @param {string} file - Path to file to write.
+ * @param {string|Buffer} data - Content to write.
+ * @param {object|string} options - see fs.writeFile, `flag` must not be set.
+ */
+async function safeOutputFile(file, data, options={}) {
+	let temporary = `${file}.tmp`;
+	await fs.outputFile(temporary, data, options);
+	await fs.rename(temporary, file);
+}
+
 module.exports = {
 	getNewestFile,
+	findUnusedName,
+	getTempFile,
+	safeOutputFile,
 };

packages/lib/index.js

@@ -0,0 +1,49 @@
+"use strict";
+const libBuildMod = require("./build_mod");
+const libCommand = require("./command");
+const libConfig = require("./config");
+const libDatabase = require("./database");
+const libErrors = require("./errors");
+const libFactorio = require("./factorio");
+const libFileOps = require("./file_ops");
+const libHash = require("./hash");
+const libHelpers = require("./helpers");
+const libLink = require("./link");
+const libLogging = require("./logging");
+const libLoggingUtils = require("./logging_utils");
+const libLuaTools = require("./lua_tools");
+const libPlugin = require("./plugin");
+const libPluginLoader = require("./plugin_loader");
+const libPrometheus = require("./prometheus");
+const libSchema = require("./schema");
+const libSharedCommands = require("./shared_commands");
+const libUsers = require("./users");
+
+const ExponentialBackoff = require("./ExponentialBackoff");
+const RateLimiter = require("./RateLimiter");
+
+
+module.exports = {
+	libBuildMod,
+	libCommand,
+	libConfig,
+	libDatabase,
+	libErrors,
+	libFactorio,
+	libFileOps,
+	libHash,
+	libHelpers,
+	libLink,
+	libLogging,
+	libLoggingUtils,
+	libLuaTools,
+	libPlugin,
+	libPluginLoader,
+	libPrometheus,
+	libSchema,
+	libSharedCommands,
+	libUsers,
+
+	ExponentialBackoff,
+	RateLimiter,
+};

packages/lib/ini.js

@@ -0,0 +1,94 @@
+/**
+ * Factorio Compatible INI parser
+ *
+ * @module lib/ini
+ * @author Hornwitser
+ */
+
+"use strict";
+
+/**
+ * Parse INI file into object of sections
+ * @param {string} input - content of INI file to parse.
+ * @returns {object<string, object<string, string>>}
+ *     sections parsed from the ini file.
+ */
+function parse(input) {
+	const sections = {};
+	let currentSection = sections;
+	const lines = input.split(/\r\n|\n/);
+	for (let number = 1; number <= lines.length; number++) {
+		let line = lines[number - 1].replace(/^[\t ]+/, "");
+		if (!line || line[0] === "#" || line[0] === ";") {
+			continue;
+		}
+
+		// Read section header
+		if (line[0] === "[") {
+			line = line.replace(/[\t ]+$/, "");
+			if (line.slice(-1) !== "]") {
+				throw new Error(`Unterminated section header on line ${number}`);
+			}
+			const name = line.slice(1, -1);
+			if (Object.prototype.hasOwnProperty.call(sections, name)) {
+				throw new Error(`Duplicated section [${name}] on line ${number}`);
+			}
+			currentSection = {};
+			sections[name] = currentSection;
+			continue;
+		}
+
+		// Read key value
+		const equalIndex = line.indexOf("=");
+		if (equalIndex === -1) {
+			throw new Error(`Missing value for key ${line} on line ${number}`);
+		}
+		const key = line.slice(0, equalIndex);
+		if (Object.prototype.hasOwnProperty.call(currentSection, key)) {
+			throw new Error(`Duplicated key ${key} on line ${number}`);
+		}
+		const value = line.slice(equalIndex + 1);
+		currentSection[key] = value;
+	}
+
+	return sections;
+}
+
+/**
+ * Serialize an object of section definitions into an INI file
+ * @param {object<string, object<string, string>>} sections -
+ *     Sections to encode into ini format
+ * @returns {string} sections serialized into INI format
+ */
+function stringify(sections) {
+	let serialized = [];
+	let first = true;
+
+	for (let [key, value] of Object.entries(sections)) {
+		if (typeof value === "string") {
+			serialized.push(`${key}=${value}`);
+			first = false;
+		}
+	}
+
+	for (let [section, content] of Object.entries(sections)) {
+		if (typeof content === "object") {
+			if (!first) {
+				serialized.push("");
+			}
+			first = false;
+			serialized.push(`[${section}]`);
+			for (let [key, value] of Object.entries(content)) {
+				serialized.push(`${key}=${value}`);
+			}
+		}
+	}
+
+	if (serialized.length) { serialized.push(""); }
+	return serialized.join("\n");
+}
+
+module.exports = {
+	parse,
+	stringify,
+};

packages/lib/is_deep_strict_equal.js

@@ -1,7 +1,8 @@
-/* eslint-disable global-require */
+/* eslint-disable node/global-require */
 "use strict";
-// eslint-disable-next-line no-process-env
+// eslint-disable-next-line node/no-process-env
 if (process.env.APP_ENV === "browser") {
+	// eslint-disable-next-line node/no-extraneous-require
 	module.exports = require("fast-deep-equal/es6");
 } else {
 	module.exports = require("util").isDeepStrictEqual;

packages/lib/link/connectors.js

@@ -6,6 +6,7 @@ const WebSocket = require("isomorphic-ws");
 const libSchema = require("../schema");
 const libErrors = require("../errors");
 const { logger } = require("../logging");
+const ExponentialBackoff = require("../ExponentialBackoff");
 
 
 /**
@@ -15,9 +16,14 @@ const { logger } = require("../logging");
  * @memberof module:lib/link
  */
 class WebSocketBaseConnector extends events.EventEmitter {
-	constructor() {
+	constructor(sessionTimeout) {
 		super();
 
+		this._sessionTimeout = sessionTimeout;
+
+		// One of closed, connecting (client only), connected and resuming.
+		this._state = "closed";
+		this._closing = false;
 		this._socket = null;
 		this._seq = 1;
 		this._lastHeartbeat = null;
@@ -27,6 +33,26 @@ class WebSocketBaseConnector extends events.EventEmitter {
 		this._sendBuffer = [];
 	}
 
+	_reset() {
+		this._state = "closed";
+		this._closing = false;
+		this._socket = null;
+		this._seq = 1;
+		this._lastHeartbeat = null;
+		this._heartbeatId = null;
+		this._heartbeatInterval = null;
+		this._lastReceivedSeq = null;
+		this._sendBuffer.length = 0;
+	}
+
+	_check(...expectedStates) {
+		if (!expectedStates.includes(this._state)) {
+			throw new Error(
+				`Expected state ${expectedStates} but state is ${this._state}`
+			);
+		}
+	}
+
 	_dropSendBufferSeq(seq) {
 		if (seq === null) {
 			return;
@@ -44,12 +70,15 @@ class WebSocketBaseConnector extends events.EventEmitter {
 	}
 
 	_doHeartbeat() {
-		this._check(["connected", "closing"]);
+		this._check("connected");
 		if (Date.now() - this._lastHeartbeat > 2000 * this._heartbeatInterval) {
-			logger.verbose("SOCKET | closing after heartbeat timed out");
-			this._socket.close(1008, "Heartbeat timeout");
-			clearInterval(this._heartbeatId);
-			this._heartbeatId = null;
+			logger.verbose("Connector | closing after heartbeat timed out");
+			// eslint-disable-next-line node/no-process-env
+			if (process.env.APP_ENV === "browser") {
+				this._socket.close(4008, "Heartbeat timeout");
+			} else {
+				this._socket.terminate();
+			}
 
 		} else {
 			this._socket.send(JSON.stringify({
@@ -62,7 +91,7 @@ class WebSocketBaseConnector extends events.EventEmitter {
 
 	_processHeartbeat(message) {
 		if (!libSchema.heartbeat(message)) {
-			logger.warn("SOCKET | closing after received invalid heartbeat");
+			logger.warn("Connector | closing after received invalid heartbeat");
 			this._socket.close(1002, "Invalid heartbeat");
 			return;
 		}
@@ -91,6 +120,7 @@ class WebSocketBaseConnector extends events.EventEmitter {
 		if (this._heartbeatId) {
 			clearInterval(this._heartbeatId);
 			this._heartbeatId = null;
+			this._lastHeartbeat = null;
 		}
 	}
 
@@ -102,14 +132,14 @@ class WebSocketBaseConnector extends events.EventEmitter {
 	 * @returns {number} the sequence number of the message sent
 	 */
 	send(type, data) {
-		if (!["handshake", "connected", "closing"].includes(this._state)) {
+		if (!["connected", "resuming"].includes(this._state)) {
 			throw new libErrors.SessionLost("No session");
 		}
 		let seq = this._seq;
 		this._seq += 1;
 		let message = { seq, type, data };
 		this._sendBuffer.push(message);
-		if (["connected", "closing"].includes(this._state)) {
+		if (this._state === "connected") {
 			this._socket.send(JSON.stringify(message));
 		}
 		return seq;
@@ -118,11 +148,11 @@ class WebSocketBaseConnector extends events.EventEmitter {
 	/**
 	 * Set connection state to closing
 	 *
-	 * Signal the connection is about tho close and that once the close
+	 * Signal the connection is about to close and that once the close
 	 * frame is received it should be considered finished.
 	 */
 	setClosing() {
-		this._state = "closing";
+		throw new Error("Abstract function");
 	}
 
 	/**
@@ -136,7 +166,15 @@ class WebSocketBaseConnector extends events.EventEmitter {
 	 * True if the connection is closing down or closed
 	 */
 	get closing() {
-		return ["closing", "closed"].includes(this._state);
+		return this._closing || this._state === "closed";
+	}
+
+	/**
+	 * True if the connector currently has a valid session that is either
+	 * connected or in the process of resuming.
+	 */
+	get hasSession() {
+		return ["connected", "resuming"].includes(this._state);
 	}
 }
 
@@ -147,41 +185,32 @@ class WebSocketBaseConnector extends events.EventEmitter {
  * @memberof module:lib/link
  */
 class WebSocketClientConnector extends WebSocketBaseConnector {
-	constructor(url, reconnectDelay, tlsCa = null) {
-		super();
+	constructor(url, maxReconnectDelay, tlsCa = null) {
+		super(null);
 
 		this._url = url;
+		this._backoff = new ExponentialBackoff({ max: maxReconnectDelay });
 		this._tlsCa = tlsCa;
 
 		// The following states are used in the client connector
-		// new: Not connected
-		// handshake: Attempting to (re)connect to server.
+		// closed: Not connected
+		// connecting: Attempting to connect to server.
+		// resuming: Attempting to resume an existing connection to the server.
 		// connected: Connection is online
-		// closing: Connection is in the process of being closed.
-		this._state = "new";
 		this._reconnectId = null;
 		this._sessionToken = null;
-		this._connected = false;
-		this._reconnectDelay = reconnectDelay;
-		this._timeout = 15 * 60;
-		this._startedReconnect = null;
+		this._startedResuming = null;
 	}
 
-	_check(expectedStates) {
-		if (!expectedStates.includes(this._state)) {
-			throw new Error(
-				`Expected state ${expectedStates} but state is ${this._state}`
-			);
-		}
-	}
-
-	setTimeout(timeout) {
-		this._timeout = timeout;
-
-		if (this._reconnectId && this._timeout < this._reconnectDelay / 2) {
-			clearTimeout(this._reconnectId);
-			this.reconnect();
-		}
+	_reset() {
+		clearTimeout(this._reconnectId);
+		this._reconnectId = null;
+		this._lastReceivedSeq = null;
+		this._sessionToken = null;
+		this._sessionTimeout = null;
+		this._sendBuffer.length = 0;
+		this._startedResuming = null;
+		super._reset();
 	}
 
 	/**
@@ -194,7 +223,7 @@ class WebSocketClientConnector extends WebSocketBaseConnector {
 	 * @param {Object} data - Data to send with message.
 	 */
 	sendHandshake(type, data) {
-		this._check(["handshake"]);
+		this._check("connecting", "resuming");
 		this._socket.send(JSON.stringify({ seq: null, type, data }));
 	}
 
@@ -207,34 +236,53 @@ class WebSocketClientConnector extends WebSocketBaseConnector {
 	 * @param {string} reason - WebSocket close reason.
 	 */
 	async close(code, reason) {
-		if (this._state === "new") {
+		if (this._state === "closed") {
 			return;
 		}
 
-		if (this._reconnectId) {
-			clearTimeout(this._reconnectId);
-			this._reconnectId = null;
-			this._lastReceivedSeq = null;
-			this._sessionToken = null;
-			this._sendBuffer.length = 0;
-			this._state = "new";
-			this._connected = false;
+		this._closing = true;
+		if (this._state === "connected" || this._socket) {
+			this._socket.close(code, reason);
+			await events.once(this, "close");
+
+		} else {
+			this._reset();
 			this.emit("close");
+		}
+	}
+
+	/**
+	 * Notify the connection is expected to close
+	 *
+	 * Sets the internal flag to signal not to attempt to resume the
+	 * connection if the server closes it.  This will close the connection
+	 * if it's currently attempting to connect or resume.
+	 */
+	setClosing() {
+		if (this._state === "closed") {
 			return;
 		}
 
-		this.stopHeartbeat();
-		this._state = "closing";
-		this._socket.close(code, reason);
-		await events.once(this, "close");
+		this._closing = true;
+		if (this._state === "connected") {
+			return;
+		}
+
+		if (this._socket) {
+			this._socket.close(1000, "Connector closing");
+
+		} else {
+			this._reset();
+			this.emit("close");
+		}
 	}
 
 	/**
 	 * Connect to the master server
 	 */
 	async connect() {
-		this._check(["new"]);
-		this._state = "handshake";
+		this._check("closed");
+		this._state = "connecting";
 
 		this._doConnect();
 
@@ -242,14 +290,14 @@ class WebSocketClientConnector extends WebSocketBaseConnector {
 		await events.once(this, "connect");
 	}
 
-	async _doConnect() {
+	_doConnect() {
 		let url = new URL(this._url);
 		url.pathname += "api/socket";
 
 		// Open WebSocket to master
-		logger.verbose(`SOCKET | connecting to ${url}`);
+		logger.verbose(`Connector | connecting to ${url}`);
 
-		// eslint-disable-next-line no-process-env
+		// eslint-disable-next-line node/no-process-env
 		if (process.env.APP_ENV === "browser") {
 			this._socket = new WebSocket(url);
 
@@ -266,69 +314,89 @@ class WebSocketClientConnector extends WebSocketBaseConnector {
 	 * Attempt re-establishing the connecting again
 	 */
 	reconnect() {
+		if (this._socket) {
+			throw new Error("Cannot reconnect while socket is open");
+		}
+
 		if (this._reconnectId !== null) {
-			return;
+			logger.error("Unexpected double call to reconnect");
 		}
 
-		if (this._startedReconnect === null) {
-			this._startedReconnect = Date.now();
+		let delay = this._backoff.delay();
+		if (
+			this._state === "resuming"
+			&& this._startedResuming + this._sessionTimeout * 1000 < Date.now() + delay
+		) {
+			logger.error("Connector | Session timed out trying to resume");
+			this._reset();
+			this._state = "connecting";
+			this.emit("invalidate");
 		}
-
-		if (this._startedReconnect + this._timeout * 1000 < Date.now()) {
-			logger.error("SOCKET | Timed out trying to reconnect");
-			this._heartbeatInterval = null;
-			this._lastReceivedSeq = null;
-			this._sessionToken = null;
-			this._sendBuffer.length = 0;
-			this._state = "new";
-			this._connected = false;
-			this.emit("close");
-			return;
-		}
-
-		let delay = Math.random() * this._reconnectDelay;
 		logger.verbose(
-			`SOCKET | waiting ${delay.toLocaleString("en", { maximumFractionDigits: 2 })} seconds for reconnect`
+			`Connector | waiting ${(Math.round(delay / 10) / 100)} seconds for reconnect`
 		);
 		this._reconnectId = setTimeout(() => {
 			this._reconnectId = null;
 			this._doConnect();
-		}, delay * 1000);
+		}, delay);
+		this._reconnectTime = Date.now() + delay;
 	}
 
 	_attachSocketHandlers() {
 		this._socket.onclose = event => {
-			logger.verbose(`SOCKET | Close (code: ${event.code}, reason: ${event.reason})`);
+			const previousState = this._state;
+
 			// Authentication failed
 			if (event.code === 4003) {
 				this.emit("error", new libErrors.AuthenticationFailed(event.reason));
-				this._state = "closing";
+				this._closing = true;
 			}
 
-			if (this._state === "closing") {
-				this._lastReceivedSeq = null;
-				this._sessionToken = null;
-				this._sendBuffer.length = 0;
-				this._state = "new";
-				this._connected = false;
-				this.emit("close");
+			this._socket = null;
+			if (this._state === "connected") {
+				this.stopHeartbeat();
+				if (this._closing) {
+					this._reset();
+					this.emit("close");
+
+				} else {
+					this._state = "resuming";
+					this._startedResuming = Date.now();
+					this.reconnect();
+					this.emit("drop");
+				}
 
 			} else {
-				this._state = "handshake";
-				this.reconnect();
-				if (this._connected) {
-					this._connected = false;
-					this.emit("drop");
+				// eslint-disable-next-line no-lonely-if
+				if (this._closing) {
+					this._reset();
+					this.emit("close");
+
+				} else {
+					this.reconnect();
 				}
 			}
 
-			this.stopHeartbeat();
+			// Log must be sent after state change is complete
+			let message = `Connector | Close (code: ${event.code}, reason: ${event.reason})`;
+			if (previousState === "connected" && event.code !== 1000) {
+				logger.info(message);
+			} else {
+				logger.verbose(message);
+			}
 		};
 
 		this._socket.onerror = event => {
 			// It's assumed that close is always called by ws
 			let code = !event.error ? "" : `, code: ${event.error.code}`;
-			logger.error(`SOCKET | Error: ${event.message || "unknown error"}${code}`);
+			let message = `Connector | Socket error: ${event.message || "unknown error"}${code}`;
+			if (this._state === "connected") {
+				logger.error(message);
+			} else {
+				// Don't log as error if not actually connected, prevents
+				// log spam during reconnecting attempts.
+				logger.verbose(message);
+			}
 			if (event.error) {
 				// Abort connection if certificate validation failed
 				if ([
@@ -337,22 +405,22 @@ class WebSocketClientConnector extends WebSocketBaseConnector {
 					"ERR_TLS_CERT_ALTNAME_INVALID",
 				].includes(event.error.code)) {
 					this.emit("error", new libErrors.AuthenticationFailed(event.error.message));
-					this._state = "closing";
+					this._closing = true;
 				}
 			}
 		};
 
 		this._socket.onopen = () => {
-			logger.verbose("SOCKET | Open");
+			logger.verbose("Connector | Open");
 		};
 
 		// Handle messages
 		this._socket.onmessage = event => {
 			let message = JSON.parse(event.data);
-			if (this._state === "handshake") {
+			if (["connecting", "resuming"].includes(this._state)) {
 				this._processHandshake(message);
 
-			} else if (["connected", "closing"].includes(this._state)) {
+			} else if (this._state === "connected") {
 				if (message.seq !== null) {
 					this._lastReceivedSeq = message.seq;
 				}
@@ -372,17 +440,17 @@ class WebSocketClientConnector extends WebSocketBaseConnector {
 
 	_processHandshake(message) {
 		if (!libSchema.serverHandshake(message)) {
-			logger.verbose("SOCKET | closing after received invalid handshake");
+			logger.warn("Connector | closing after received invalid handshake");
 			this._socket.close(1002, "Invalid handshake");
 			return;
 		}
 
-		let { seq, type, data } = message;
+		let { type, data } = message;
 		if (type === "hello") {
-			logger.verbose(`SOCKET | received hello from master version ${data.version}`);
+			logger.verbose(`Connector | received hello from master version ${data.version}`);
 			this.emit("hello", data);
 			if (this._sessionToken) {
-				logger.verbose("SOCKET | Attempting resume");
+				logger.verbose("Connector | Attempting resume");
 				this.sendHandshake("resume", {
 					session_token: this._sessionToken,
 					last_seq: this._lastReceivedSeq,
@@ -392,36 +460,39 @@ class WebSocketClientConnector extends WebSocketBaseConnector {
 			}
 
 		} else if (type === "ready") {
-			logger.verbose("SOCKET | received ready from master");
+			logger.verbose("Connector | received ready from master");
 			this._state = "connected";
 			this._sessionToken = data.session_token;
+			this._sessionTimeout = data.session_timeout;
 			this._heartbeatInterval = data.heartbeat_interval;
 			this.startHeartbeat();
 			for (let bufferedMessage of this._sendBuffer) {
 				this._socket.send(JSON.stringify(bufferedMessage));
 			}
-			this._startedReconnect = null;
-			this._connected = true;
 			this.emit("connect", data);
 
 		} else if (type === "continue") {
-			logger.verbose("SOCKET | resuming existing session");
+			logger.info("Connector | resuming existing session");
 			this._state = "connected";
 			this._heartbeatInterval = data.heartbeat_interval;
+			this._sessionTimeout = data.session_timeout;
 			this.startHeartbeat();
 			this._dropSendBufferSeq(data.last_seq);
 			for (let bufferedMessage of this._sendBuffer) {
 				this._socket.send(JSON.stringify(bufferedMessage));
 			}
-			this._startedReconnect = null;
-			this._connected = true;
+			this._startedResuming = null;
 			this.emit("resume");
 
 		} else if (type === "invalidate") {
-			this._heartbeatInterval = null;
+			logger.warn("Connector | session invalidated by master");
+			this._state = "connecting";
+			this._seq = 1;
 			this._lastReceivedSeq = null;
 			this._sessionToken = null;
+			this._sessionTimeout = null;
 			this._sendBuffer.length = 0;
+			this._startedResuming = null;
 			this.emit("invalidate");
 			this.register();
 		}

packages/lib/link/index.js

@@ -1,12 +1,15 @@
-/* eslint-disable global-require */
 /**
  * Library for message based communication between nodes
  * @module lib/link
  * @author Hornwitser
  */
 "use strict";
+const link = require("./link");
+const messages = require("./messages");
+const connectors = require("./connectors");
+
 module.exports = {
-	...require("./link"),
-	...require("./messages"),
-	...require("./connectors"),
+	...link,
+	...messages,
+	...connectors,
 };

packages/lib/link/link.js

@@ -4,7 +4,6 @@
 const libSchema = require("../schema");
 const libErrors = require("../errors");
 const { logger } = require("../logging");
-const messages = require("./messages");
 
 // Some definitions for the terminology used here:
 // link: Either side of a master - client connection
@@ -135,7 +134,7 @@ class Link {
 	 * @returns {Boolean} true if a waiter was triggered.
 	 */
 	_processWaiters(message) {
-		let { seq, type, data } = message;
+		let { type, data } = message;
 		let waiters = this._waiters.get(type);
 		if (!waiters || !waiters.length) {
 			return false;

packages/lib/link/messages.js

@@ -3,6 +3,7 @@
 const libSchema = require("../schema");
 const libErrors = require("../errors");
 const { logger } = require("../logging");
+const PlayerStats = require("../PlayerStats");
 
 class MissingLinkHandlerError extends Error {
 	constructor(type, source, target) {
@@ -331,6 +332,15 @@ messages.setMasterConfigProp = new Request({
 	},
 });
 
+let slaveProperties = {
+	"agent": { type: "string" },
+	"version": { type: "string" },
+	"name": { type: "string" },
+	"id": { type: "integer" },
+	"connected": { type: "boolean" },
+	"public_address": { type: ["null", "string"] },
+};
+
 messages.listSlaves = new Request({
 	type: "list_slaves",
 	links: ["control-master"],
@@ -341,18 +351,46 @@ messages.listSlaves = new Request({
 			items: {
 				additionalProperties: false,
 				required: ["agent", "version", "name", "id", "connected"],
-				properties: {
-					"agent": { type: "string" },
-					"version": { type: "string" },
-					"name": { type: "string" },
-					"id": { type: "integer" },
-					"connected": { type: "boolean" },
-				},
+				properties: slaveProperties,
 			},
 		},
 	},
 });
 
+messages.setSlaveSubscriptions = new Request({
+	type: "set_slave_subscriptions",
+	links: ["control-master"],
+	permission: "core.slave.subscribe",
+	requestProperties: {
+		"all": { type: "boolean" },
+		"slave_ids": {
+			type: "array",
+			items: { type: "integer" },
+		},
+	},
+});
+
+let instanceProperties = {
+	"name": { type: "string" },
+	"id": { type: "integer" },
+	"assigned_slave": { type: ["null", "integer"] },
+	"game_port": { type: ["null", "integer"] },
+	"status": { enum: [
+		"unknown", "unassigned", "stopped", "starting", "running", "stopping",
+		"creating_save", "exporting_data", "deleted",
+	]},
+};
+
+messages.getInstance = new Request({
+	type: "get_instance",
+	links: ["control-master"],
+	permission: "core.instance.get",
+	requestProperties: {
+		"id": { type: "integer" },
+	},
+	responseProperties: instanceProperties,
+});
+
 messages.listInstances = new Request({
 	type: "list_instances",
 	links: ["control-master"],
@@ -363,25 +401,31 @@ messages.listInstances = new Request({
 			items: {
 				additionalProperties: false,
 				required: ["name", "id", "assigned_slave", "status"],
-				properties: {
-					"name": { type: "string" },
-					"id": { type: "integer" },
-					"assigned_slave": { type: ["null", "integer"] },
-					"status": { enum: [
-						"unknown", "unassigned", "stopped", "starting", "running", "creating_save", "exporting_data",
-					]},
-				},
+				properties: instanceProperties,
 			},
 		},
 	},
 });
 
+messages.setInstanceSubscriptions = new Request({
+	type: "set_instance_subscriptions",
+	links: ["control-master"],
+	permission: "core.instance.subscribe",
+	requestProperties: {
+		"all": { type: "boolean" },
+		"instance_ids": {
+			type: "array",
+			items: { type: "integer" },
+		},
+	},
+});
+
 messages.generateSlaveToken = new Request({
 	type: "generate_slave_token",
 	links: ["control-master"],
 	permission: "core.slave.generate_token",
 	requestProperties: {
-		"slave_id": { type: "integer" },
+		"slave_id": { type: ["integer", "null"] },
 	},
 	responseProperties: {
 		"token": { type: "string" },
@@ -467,11 +511,141 @@ messages.startInstance = new Request({
 	forwardTo: "instance",
 });
 
+let saveList = {
+	type: "array",
+	items: {
+		type: "object",
+		additionalProperties: false,
+		required: ["type", "name", "size", "mtime_ms", "loaded"],
+		properties: {
+			"type": { enum: ["file", "directory", "special"] },
+			"name": { type: "string" },
+			"size": { type: "integer" },
+			"mtime_ms": { type: "number" },
+			"loaded": { type: "boolean" },
+			"default": { type: "boolean" },
+		},
+	},
+};
+
+messages.listSaves = new Request({
+	type: "list_saves",
+	links: ["control-master", "master-slave", "slave-instance"],
+	permission: "core.instance.save.list",
+	forwardTo: "instance",
+	responseProperties: {
+		"list": saveList,
+	},
+});
+
 messages.createSave = new Request({
 	type: "create_save",
 	links: ["control-master", "master-slave", "slave-instance"],
-	permission: "core.instance.create_save",
+	permission: "core.instance.save.create",
 	forwardTo: "instance",
+	requestProperties: {
+		"name": { type: "string" },
+		"seed": { type: ["integer", "null"] },
+		"map_gen_settings": { type: ["object", "null"] },
+		"map_settings": { type: ["object", "null"] },
+	},
+});
+
+messages.renameSave = new Request({
+	type: "rename_save",
+	links: ["control-master", "master-slave"],
+	permission: "core.instance.save.rename",
+	forwardTo: "instance",
+	requestProperties: {
+		"old_name": { type: "string" },
+		"new_name": { type: "string" },
+	},
+});
+
+messages.copySave = new Request({
+	type: "copy_save",
+	links: ["control-master", "master-slave"],
+	permission: "core.instance.save.copy",
+	forwardTo: "instance",
+	requestProperties: {
+		"source": { type: "string" },
+		"destination": { type: "string" },
+	},
+});
+
+messages.deleteSave = new Request({
+	type: "delete_save",
+	links: ["control-master", "master-slave"],
+	permission: "core.instance.save.delete",
+	forwardTo: "instance",
+	requestProperties: {
+		"save": { type: "string" },
+	},
+});
+
+messages.downloadSave = new Request({
+	type: "download_save",
+	links: ["control-master"],
+	permission: "core.instance.save.download",
+	requestProperties: {
+		"instance_id": { type: "integer" },
+		"save": { type: "string" },
+	},
+	responseProperties: {
+		"stream_id": { type: "string" },
+	},
+});
+
+messages.transferSave = new Request({
+	type: "transfer_save",
+	links: ["control-master", "master-slave"],
+	permission: "core.instance.save.transfer",
+	requestProperties: {
+		"instance_id": { type: "integer" },
+		"source_save": { type: "string" },
+		"target_instance_id": { type: "integer" },
+		"target_save": { type: "string" },
+		"copy": { type: "boolean" },
+	},
+	responseProperties: {
+		"save": { type: "string" },
+	},
+});
+
+messages.pullSave = new Request({
+	type: "pull_save",
+	links: ["master-slave"],
+	requestProperties: {
+		"instance_id": { type: "integer" },
+		"stream_id": { type: "string" },
+		"filename": { type: "string" },
+	},
+	responseProperties: {
+		"save": { type: "string" },
+	},
+});
+
+messages.pushSave = new Request({
+	type: "push_save",
+	links: ["master-slave"],
+	requestProperties: {
+		"instance_id": { type: "integer" },
+		"stream_id": { type: "string" },
+		"save": { type: "string" },
+	},
+});
+
+messages.setSaveListSubscriptions = new Request({
+	type: "set_save_list_subscriptions",
+	links: ["control-master"],
+	permission: "core.instance.save.list_subscribe",
+	requestProperties: {
+		"all": { type: "boolean" },
+		"instance_ids": {
+			type: "array",
+			items: { type: "integer" },
+		},
+	},
 });
 
 messages.loadScenario = new Request({
@@ -481,6 +655,9 @@ messages.loadScenario = new Request({
 	forwardTo: "instance",
 	requestProperties: {
 		"scenario": { type: "string" },
+		"seed": { type: ["integer", "null"] },
+		"map_gen_settings": { type: ["object", "null"] },
+		"map_settings": { type: ["object", "null"] },
 	},
 });
 
@@ -491,6 +668,13 @@ messages.exportData = new Request({
 	forwardTo: "instance",
 });
 
+messages.extractPlayers = new Request({
+	type: "extract_players",
+	links: ["control-master", "master-slave", "slave-instance"],
+	permission: "core.instance.extract_players",
+	forwardTo: "instance",
+});
+
 messages.stopInstance = new Request({
 	type: "stop_instance",
 	links: ["control-master", "master-slave", "slave-instance"],
@@ -498,6 +682,13 @@ messages.stopInstance = new Request({
 	forwardTo: "instance",
 });
 
+messages.killInstance = new Request({
+	type: "kill_instance",
+	links: ["control-master", "master-slave", "slave-instance"],
+	permission: "core.instance.kill",
+	forwardTo: "instance",
+});
+
 messages.deleteInstance = new Request({
 	type: "delete_instance",
 	links: ["control-master", "master-slave"],
@@ -603,6 +794,37 @@ messages.deleteRole = new Request({
 	},
 });
 
+const userRequired = ["name", "roles", "instances"];
+const userProperties = {
+	"name": { type: "string" },
+	"roles": { type: "array", items: { type: "integer" }},
+	"is_admin": { type: "boolean" },
+	"is_banned": { type: "boolean" },
+	"is_whitelisted": { type: "boolean" },
+	"ban_reason": { type: "string" },
+	"instances": { type: "array", items: { type: "integer" }},
+	"is_deleted": { type: "boolean" },
+	"player_stats": PlayerStats.jsonSchema,
+	"instance_stats": {
+		type: "array",
+		items: {
+			type: "array",
+			items: [{ type: "integer" }, PlayerStats.jsonSchema],
+		},
+	},
+};
+
+messages.getUser = new Request({
+	type: "get_user",
+	links: ["control-master"],
+	permission: "core.user.get",
+	requestProperties: {
+		"name": { type: "string" },
+	},
+	responseRequired: userRequired,
+	responseProperties: userProperties,
+});
+
 messages.listUsers = new Request({
 	type: "list_users",
 	links: ["control-master"],
@@ -612,20 +834,26 @@ messages.listUsers = new Request({
 			type: "array",
 			items: {
 				additionalProperties: false,
-				required: ["name", "roles", "instances"],
-				properties: {
-					"name": { type: "string" },
-					"roles": { type: "array", items: { type: "integer" }},
-					"is_admin": { type: "boolean" },
-					"is_banned": { type: "boolean" },
-					"is_whitelisted": { type: "boolean" },
-					"instances": { type: "array", items: { type: "integer" }},
-				},
+				required: userRequired,
+				properties: userProperties,
 			},
 		},
 	},
 });
 
+messages.setUserSubscriptions = new Request({
+	type: "set_user_subscriptions",
+	links: ["control-master"],
+	permission: "core.user.subscribe",
+	requestProperties: {
+		"all": { type: "boolean" },
+		"names": {
+			type: "array",
+			items: { type: "string" },
+		},
+	},
+});
+
 messages.createUser = new Request({
 	type: "create_user",
 	links: ["control-master"],
@@ -723,6 +951,8 @@ messages.queryLog = new Request({
 			items: { type: "integer" },
 		},
 		"max_level": { type: ["string", "null"] },
+		"limit": { type: "integer" },
+		"order": { enum: ["asc", "desc"] },
 	},
 	responseProperties: {
 		"log": {
@@ -747,7 +977,7 @@ messages.updateInstances = new Request({
 				properties: {
 					"serialized_config": { type: "object" },
 					"status": { enum: [
-						"stopped", "starting", "running", "creating_save", "exporting_data",
+						"stopped", "starting", "running", "stopping", "creating_save", "exporting_data",
 					]},
 				},
 			},
@@ -947,6 +1177,30 @@ messages.debugWsMessage = new Event({
 	},
 });
 
+messages.accountUpdate = new Event({
+	type: "account_update",
+	links: ["master-control"],
+	eventRequired: [],
+	eventProperties: {
+		"roles": {
+			type: "array",
+			items: {
+				additionalProperties: false,
+				type: "object",
+				required: ["name", "id", "permissions"],
+				properties: {
+					"name": { type: "string" },
+					"id": { type: "integer" },
+					"permissions": {
+						type: "array",
+						items: { type: "string" },
+					},
+				},
+			},
+		},
+	},
+});
+
 messages.logMessage = new Event({
 	type: "log_message",
 	links: ["slave-master", "master-control"],
@@ -962,6 +1216,13 @@ messages.logMessage = new Event({
 	},
 });
 
+messages.slaveUpdate = new Event({
+	type: "slave_update",
+	links: ["master-control"],
+	eventProperties: slaveProperties,
+});
+
+
 messages.instanceInitialized = new Event({
 	type: "instance_initialized",
 	links: ["instance-slave"],
@@ -976,14 +1237,39 @@ messages.instanceInitialized = new Event({
 messages.instanceStatusChanged = new Event({
 	type: "instance_status_changed",
 	links: ["instance-slave", "slave-master"],
+	eventRequired: ["instance_id", "status"],
 	eventProperties: {
 		"instance_id": { type: "integer" },
 		"status": { enum: [
-			"stopped", "starting", "running", "creating_save", "exporting_data",
+			"stopped", "starting", "running", "stopping", "creating_save", "exporting_data",
 		]},
+		"game_port": { type: ["null", "integer"] },
 	},
 });
 
+messages.instanceUpdate = new Event({
+	type: "instance_update",
+	links: ["master-control"],
+	eventProperties: instanceProperties,
+});
+
+messages.saveListUpdate = new Event({
+	type: "save_list_update",
+	links: ["instance-slave", "slave-master", "master-control"],
+	forwardTo: "master",
+	eventProperties: {
+		"instance_id": { type: "integer" },
+		"list": saveList,
+	},
+});
+
+messages.userUpdate = new Event({
+	type: "user_update",
+	links: ["master-control"],
+	eventRequired: userRequired,
+	eventProperties: userProperties,
+});
+
 messages.masterConnectionEvent = new Event({
 	type: "master_connection_event",
 	links: ["slave-instance"],
@@ -1050,10 +1336,13 @@ messages.playerEvent = new Event({
 	type: "player_event",
 	links: ["instance-slave", "slave-master"],
 	forwardTo: "master",
+	eventRequired: ["instance_id", "type", "name"],
 	eventProperties: {
 		"instance_id": { type: "integer" },
-		"type": { type: "string", enum: ["join", "leave"] },
+		"type": { type: "string", enum: ["join", "leave", "import"] },
 		"name": { type: "string" },
+		"reason": { type: "string" },
+		"stats": PlayerStats.jsonSchema,
 	},
 });
 

packages/lib/logging_utils.js

@@ -1,4 +1,15 @@
+/**
+ * Utilities for logging on the Node.js side
+ *
+ * @author Hornwitser
+ * @module lib/logging_utils
+ */
 "use strict";
+const events = require("events");
+const fs = require("fs-extra");
+const path = require("path");
+const stream = require("stream");
+const util = require("util");
 const winston = require("winston");
 const Transport = require("winston-transport");
 const { LEVEL, MESSAGE } = require("triple-beam");
@@ -6,6 +17,11 @@ const chalk = require("chalk");
 
 const libLink = require("./link");
 const libErrors = require("./errors");
+const libFileOps = require("./file_ops");
+const { levels, logger } = require("./logging");
+const libStream = require("./stream");
+
+const finished = util.promisify(stream.finished);
 
 
 /**
@@ -55,6 +71,7 @@ function formatServerOutput(parsed) {
 
 /**
  * Formats winston log messages for a character terminal.
+ * @static
  */
 class TerminalFormat {
 	constructor(options = {}) {
@@ -95,6 +112,7 @@ class TerminalFormat {
 
 /**
  * Sends logs over a lib/link connection.
+ * @static
  */
 class LinkTransport extends Transport {
 	constructor(options) {
@@ -121,10 +139,385 @@ class LinkTransport extends Transport {
 	}
 }
 
+const logFileGlob = /^[a-z]+-(\d{4}-\d{2}-\d{2})\.log$/;
+/**
+ * Filter object for logs
+ * @typedef {Object} module:lib/logging_utils~LogFilter
+ * @property {string} [max_level] -
+ *     Maximum log level to include. Higher levels are more verbose.
+ * @property {boolean} [all] -
+ *     Include log entries from master, all slaves and all instances.
+ * @property {boolean} [master] -
+ *     Include log entries from the master server.
+ * @property {Array<number>} [slave_ids] -
+ *     Include log entries for the given slaves and instances of those
+ *     slaves by id.
+ * @property {Array<number>} [instance_ids] -
+ *     Include log entries for the given instances by id.
+ */
+
+/**
+ * Keeps an index over a log directory to speed up queries to it
+ * @static
+ */
+class LogIndex {
+	constructor(logDirectory, serialized) {
+		this.logDirectory = logDirectory;
+		this.index = new Map();
+
+		if (serialized.version !== 0) {
+			return;
+		}
+
+		for (let [file, serializedEntry] of Object.entries(serialized.files)) {
+			this.index.set(file, {
+				levels: new Set(serializedEntry.levels),
+				master: serializedEntry.master,
+				slave_ids: new Set(serializedEntry.slave_ids),
+				instance_ids: new Set(serializedEntry.instance_ids),
+			});
+		}
+	}
+
+	serialize() {
+		let serialized = {
+			version: 0,
+			files: {},
+		};
+
+		for (let [file, entry] of this.index) {
+			serialized.files[file] = {
+				levels: [...entry.levels],
+				master: entry.master,
+				slave_ids: [...entry.slave_ids],
+				instance_ids: [...entry.instance_ids],
+			};
+		}
+
+		return serialized;
+	}
+
+	/**
+	 * Load or create an empty index for the given directory
+	 *
+	 * Loads index.json from the given log directy expecting it to contain
+	 * data about previously indexed files saved with {@link
+	 * module:lib/logging_utils.LogIndex#save}.
+	 *
+	 * @param {string} logDirectory - Path to directory to load from.
+	 * @returns {module:lib/logging_utils.LogIndex} loaded or created log index.
+	 */
+	static async load(logDirectory) {
+		try {
+			let content = await fs.readFile(path.join(logDirectory, "index.json"));
+			return new LogIndex(logDirectory, JSON.parse(content));
+		} catch (err) {
+			if (err.code !== "ENOENT") {
+				logger.warn(`Failed to load ${path.join(logDirectory, "index.json")}: ${err}`);
+			}
+			return new LogIndex(logDirectory, {});
+		}
+	}
+
+	/**
+	 * Save index
+	 *
+	 * Saves corrently held index into index.json in the log directory it
+	 * was loaded/created from.
+	 */
+	async save() {
+		await libFileOps.safeOutputFile(
+			path.join(this.logDirectory, "index.json"),
+			JSON.stringify(this.serialize(), null, 4)
+		);
+	}
+
+	async indexFile(file) {
+		let filePath = path.join(this.logDirectory, file);
+		let lineStream = new libStream.LineSplitter({ readableObjectMode: true });
+		let fileStream = fs.createReadStream(filePath);
+		fileStream.pipe(lineStream);
+		let entry = {
+			levels: new Set(),
+			master: false,
+			slave_ids: new Set(),
+			instance_ids: new Set(),
+		};
+		for await (let line of lineStream) {
+			let info;
+			try {
+				info = JSON.parse(line);
+			} catch (err) {
+				entry.levels.add("info");
+				entry.master = true;
+				continue;
+			}
+			if (info.level) {
+				entry.levels.add(info.level);
+			}
+			if (info.slave_id === undefined) {
+				entry.master = true;
+			} else if (info.instance_id === undefined) {
+				entry.slave_ids.add(info.slave_id);
+			}
+			if (info.instance_id !== undefined) {
+				entry.instance_ids.add(info.instance_id);
+			}
+		}
+		return entry;
+	}
+
+	/**
+	 * Build index for files currently present in the log directory
+	 */
+	async buildIndex() {
+		let today = new Date(Date.now() - 300e3).toISOString().slice(0, 10);
+
+		for (let file of await fs.readdir(this.logDirectory)) {
+			let match = logFileGlob.exec(file);
+			if (!match || match[1] >= today || this.index.has(file)) {
+				continue;
+			}
+
+			let entry = await this.indexFile(file);
+			this.index.set(file, entry);
+		}
+	}
+
+	/**
+	 * Check if a file includes entries for the given filter
+	 *
+	 * @param {string} file -
+	 *     Name of file in the log directory to check for.
+	 * @param {module:lib/logging_utils~LogFilter} filter -
+	 *     Filter to check index if file contains entries for.
+	 * @returns {boolean}
+	 *     true if the file may contain entries included by the filter.
+	 */
+	filterIncludesFile(file, { max_level, all, master, instance_ids, slave_ids }) {
+		let entry = this.index.get(file);
+		if (!entry) {
+			return true;
+		}
+
+		const hasOwnProperty = Object.prototype.hasOwnProperty;
+		if (max_level && hasOwnProperty.call(levels, max_level)) {
+			let fileLevels = [...entry.levels].map(
+				fileLevel => (hasOwnProperty.call(levels, fileLevel) ? levels[fileLevel] : levels.verbose)
+			);
+			if (fileLevels.every(level => level > levels[max_level])) {
+				return false;
+			}
+		}
+
+		if (all) {
+			return true;
+		}
+		if (master && entry.master) {
+			return true;
+		}
+		if (slave_ids && slave_ids.some(id => entry.slave_ids.has(id))) {
+			return true;
+		}
+		if (instance_ids && instance_ids.some(id => entry.instance_ids.has(id))) {
+			return true;
+		}
+		return false;
+	}
+}
+
+/**
+ * Create log filter by level and source.
+ *
+ * @param {module:lib/logging_utils~LogFilter} filter -
+ *     Filter to filter log entries by.
+ * @returns {function(object): boolean}
+ *     filter returning true for log entries that match it.
+ * @static
+ */
+function logFilter({ all, master, slave_ids, instance_ids, max_level }) {
+	return info => {
+		// Note: reversed to filter out undefined levels
+		if (max_level && !(levels[info.level] <= levels[max_level])) {
+			return false;
+		}
+
+		if (all) {
+			return true;
+		}
+		if (master && info.slave_id === undefined) {
+			return true;
+		}
+		if (
+			slave_ids
+			&& info.slave_id !== undefined
+			&& info.instance_id === undefined
+			&& slave_ids.includes(info.slave_id)
+		) {
+			return true;
+		}
+		if (instance_ids && info.instance_id !== undefined && instance_ids.includes(info.instance_id)) {
+			return true;
+		}
+		return false;
+	};
+}
+
+/**
+ * Filter object for querying logs
+ * @typedef {Object} module:lib/logging_utils~QueryLogFilter
+ * @property {number} [limit=100] - Maximum number of entries to return.
+ * @property {string} [order="asc"] -
+ *     Return entries in ascending ("asc") date order or desceding ("desc")
+ *     date order.
+ * @property {string} [max_level] -
+ *     Maximum log level to include. Higher levels are more verbose.
+ * @property {boolean} [all] -
+ *     Include log entries from master, all slaves and all instances.
+ * @property {boolean} [master] -
+ *     Include log entries from the master server.
+ * @property {Array<number>} [slave_ids] -
+ *     Include log entries for the given slaves and instances of those
+ *     slaves by id.
+ * @property {Array<number>} [instance_ids] -
+ *     Include log entries for the given instances by id.
+ */
+
+/**
+ * Query log directory
+ *
+ * @param {string} logDirectory - path to directory with logs.
+ * @param {module:lib/logging_utils~QueryLogFilter} filter -
+ *     Filter to limit logs by.
+ * @param {module:lib/logging_utils.LogIndex=} index -
+ *     Index to speed up query with.
+ * @returns {Array<Object>} log entries matching the filter
+ */
+async function queryLog(logDirectory, filter, index) {
+	let files = (await fs.readdir(logDirectory)).filter(entry => logFileGlob.test(entry));
+
+	filter = {
+		limit: 100,
+		order: "asc",
+		...filter,
+	};
+
+	files.sort();
+	if (filter.order === "desc") {
+		files.reverse();
+	}
+
+	const includeEntry = logFilter(filter);
+	let log = [];
+	for (let file of files) {
+		if (index && !index.filterIncludesFile(file, filter)) {
+			continue;
+		}
+		let filePath = path.join(logDirectory, file);
+		let fileStream;
+		let lineStream;
+		if (filter.order === "asc") {
+			lineStream = new libStream.LineSplitter({ readableObjectMode: true });
+			fileStream = fs.createReadStream(filePath);
+		} else {
+			lineStream = new libStream.ReverseLineSplitter({ readableObjectMode: true });
+			fileStream = await libStream.createReverseReadStream(filePath);
+		}
+		lineStream.on("data", line => {
+			let info;
+			try {
+				info = JSON.parse(line);
+			} catch (err) {
+				info = { level: "info", message: line.toString("utf8") };
+			}
+			if (includeEntry(info)) {
+				log.push(info);
+				if (log.length >= filter.limit) {
+					lineStream.destroy();
+					fileStream.destroy();
+				}
+			}
+		});
+		fileStream.pipe(lineStream);
+		try {
+			await finished(lineStream);
+		} catch (err) {
+			if (log.length < filter.limit || err.code !== "ERR_STREAM_PREMATURE_CLOSE") {
+				throw err;
+			}
+		}
+
+		if (log.length >= filter.limit) {
+			break;
+		}
+	}
+	return log;
+}
+
+async function migrateLogs(log, directory, pattern) {
+	const dateRegExp = /^\d{4}-\d{2}-\d{2}/;
+	let lineStream = new libStream.LineSplitter({ readableObjectMode: true });
+	let fileStream = fs.createReadStream(log);
+	fileStream.pipe(lineStream);
+
+	let currentDate = null;
+	let output = null;
+
+	async function switchOutput(newOutputPath) {
+		if (output) {
+			output.end();
+			await finished(output);
+		}
+
+		output = fs.createWriteStream(newOutputPath, { flags: "ax" });
+		try {
+			await events.once(output, "open");
+			// eslint-disable-next-line no-console
+			console.log(`writing ${newOutputPath}`);
+		} catch (err) {
+			if (err.code === "EEXIST") {
+				// eslint-disable-next-line no-console
+				console.warn(`Discarding logs for ${newDate} due to target logfile already existing`);
+				output = null;
+			} else {
+				throw err;
+			}
+		}
+	}
+
+	for await (let line of lineStream) {
+		let info = {};
+		try {
+			info = JSON.parse(line);
+		} catch (err) {
+			// Ignore
+		}
+
+		if (typeof info.timestamp === "string" && dateRegExp.test(info.timestamp)) {
+			let newDate = info.timestamp.slice(0, 10);
+			// Only update date forward in time.
+			if (newDate !== currentDate && (!currentDate || newDate > currentDate)) {
+				await switchOutput(path.join(directory, pattern.replace("%DATE%", newDate)));
+				currentDate = newDate;
+			}
+		}
+
+		if (output) {
+			if (!output.write(Buffer.concat([line, Buffer.from("\n")]))) {
+				await events.once(output, "drain");
+			}
+		}
+	}
+}
+
 
 module.exports = {
 	TerminalFormat,
 	LinkTransport,
+	LogIndex,
+	logFilter,
+	queryLog,
+	migrateLogs,
 
 	// for testing only
 	_formatServerOutput: formatServerOutput,

packages/lib/package.json

@@ -1,19 +1,21 @@
 {
   "name": "@clusterio/lib",
   "description": "Shared library for Clusterio",
-  "version": "2.0.0-alpha.5",
-  "repository": "https://github.com/clusterio/factorioClusterio",
+  "version": "2.0.0-alpha.13",
+  "repository": "https://github.com/clusterio/clusterio",
   "license": "MIT",
+  "browser": "browser.js",
   "keywords": [
     "factorio"
   ],
   "engines": {
-    "node": ">=10.16 <11 || >= 12"
+    "node": ">=12"
   },
   "dependencies": {
     "ajv": "^6.12.6",
+    "chalk": "^4.1.0",
+    "fast-deep-equal": "^3.1.3",
     "fs-extra": "^8.1.0",
-    "ini": "^1.3.5",
     "isomorphic-ws": "^4.0.1",
     "jimp": "^0.12.1",
     "jsonwebtoken": "^8.2.1",

packages/lib/plugin.js

@@ -4,6 +4,7 @@
  */
 "use strict";
 
+const helpers = require("./helpers");
 
 /**
  * Conceptual base for master and instance plugins.
@@ -38,7 +39,7 @@ class BaseInstancePlugin {
 
 		/**
 		 * Instance the plugin started for
-		 * @type {module:slave/slave~Instance}
+		 * @type {module:slave/src/Instance}
 		 */
 		this.instance = instance;
 
@@ -48,7 +49,7 @@ class BaseInstancePlugin {
 		 * With the exepction of accessing the slave's config you should
 		 * avoid ineracting with the slave object directly.
 		 *
-		 * @type {module:slave/slave~Slave}
+		 * @type {module:slave/src/Slave}
 		 */
 		this.slave = slave;
 
@@ -60,6 +61,9 @@ class BaseInstancePlugin {
 		 * `error`, `warn`, `audit`, `info` and `verbose`.
 		 */
 		this.logger = instance.logger.child({ plugin: this.info.name });
+
+		this._pendingRconMessages = [];
+		this._sendingRconMessages = false;
 	}
 
 	/**
@@ -74,7 +78,7 @@ class BaseInstancePlugin {
 	 * changed.
 	 *
 	 * @param {module:lib/config.ConfigGroup} group -
-	 *     The group who's field got changed on.
+	 *     The group who's field got changed.
 	 * @param {string} field - Name of the field that changed.
 	 * @param {*} prev - The previous value of the field.
 	 */
@@ -191,7 +195,7 @@ class BaseInstancePlugin {
 	 * Plugins must stop sending messages to the master, or are forwarded
 	 * via the master server after the prepare disconnect has been handled.
 	 *
-	 * @param {module:master/master~SlaveConnection} connection -
+	 * @param {module:master/src/SlaveConnection} connection -
 	 *     The connection to the slave preparing to disconnect.
 	 */
 	async onPrepareMasterDisconnect(connection) { }
@@ -202,14 +206,81 @@ class BaseInstancePlugin {
 	 * Invoked when a player either joins or leaves the instance.
 	 *
 	 * @param {Object} event - Information about the event.
-	 * @param {string} event.type - Either "join" or "leave".
+	 * @param {string} event.type - Either "join", "leave" or "import".
 	 * @param {string} event.name - Name of the player that joined/left.
+	 * @param {string=} event.reason -
+	 *     Only present for type "leave". Reason for player leaving the
+	 *     game, one of the possible reasons in defines.disconnect_reason
+	 *     or "server_quit" if the server exits while the player is online.
 	 */
 	async onPlayerEvent(event) { }
 
-	async sendRcon(message, expectEmpty) {
+	/**
+	 * Send RCON message to instance
+	 *
+	 * Send a message or command to the server which can potentially be
+	 * executed out of order in relation to other RCON commands.
+	 *
+	 * This should not be called before onStart or after onStop.  A simple
+	 * way to achieve this is to check that the instance status is running
+	 * before sending commands. Note that the instance status is set to
+	 * running some time after `onStart` and some time before `onStop` is
+	 * invoked.
+	 *
+	 * @param {string} message - message to send to server over RCON.
+	 * @param {boolean=} [expectEmpty=false] -
+	 *     if true throw if the response is not empty.  Useful for detecting
+	 *     errors that might have been sent in response.
+	 * @returns {Promise<string>} response from server.
+	 */
+	async sendRcon(message, expectEmpty=false) {
 		return await this.instance.sendRcon(message, expectEmpty, this.info.name);
 	}
+
+	/**
+	 * Send serially ordered RCON message to instance
+	 *
+	 * Send a message or command to the server which will not be executed
+	 * out of order in relation to other RCON commands sent with this
+	 * method. The ordering applies per plugin, and two plugins sending
+	 * commands with this method may execute out of order in relation to
+	 * each other.
+	 *
+	 * This should not be called before onStart or after onStop.  A simple
+	 * way to achieve this is to check that the instance status is running
+	 * before sending commands. Note that the instance status is set to
+	 * running some time after `onStart` and some time before `onStop` is
+	 * invoked.
+	 *
+	 * @param {string} message - message to send to server over RCON.
+	 * @param {boolean=} [expectEmpty=false] -
+	 *     if true throw if the response is not empty.  Useful for detecting
+	 *     errors that might have been sent in response.
+	 * @returns {Promise<string>} response from server.
+	 */
+	async sendOrderedRcon(message, expectEmpty=false) {
+		let promise = new Promise((resolve, reject) => {
+			this._pendingRconMessages.push({resolve, reject, message, expectEmpty});
+		});
+		if (!this._sendingRconMessages) {
+			this._sendPendingRconMessages();
+		}
+		return await promise;
+	}
+
+	async _sendPendingRconMessages() {
+		this._sendingRconMessages = true;
+		while (this._pendingRconMessages.length) {
+			let task = this._pendingRconMessages.shift();
+			try {
+				let result = await this.sendRcon(task.message, task.expectEmpty);
+				task.resolve(result);
+			} catch (err) {
+				task.reject(err);
+			}
+		}
+		this._sendingRconMessages = false;
+	}
 }
 
 /**
@@ -226,6 +297,11 @@ class BaseInstancePlugin {
 class BaseMasterPlugin {
 	constructor(info, master, metrics, logger) {
 		this.info = info;
+
+		/**
+		 * Master server
+		 * @type {module:master/src/Master}
+		 */
 		this.master = master;
 		this.metrics = metrics;
 
@@ -247,31 +323,69 @@ class BaseMasterPlugin {
 	/**
 	 * Called when the status of an instance changes
 	 *
-	 * Invoked when the master server has received notice from a slave that
-	 * the running status of an instance has changed.  The possible statuses
-	 * that can be notified about are:
-	 * - `stopped`: Instance is no longer running.
+	 * Invoked when the master server has changed the status of an instance
+	 * or received notice from a slave that the status of an instance has
+	 * changed.  The possible statuses that can be notified about are:
+	 * - `unassigned:`: Instance is no longer asssigned to a slave.
+	 * - `unknown`: Slave assigned to instance is offline.
+	 * - `stopped`: Instance is no longer running or was just assigned to a
+	 *   slave.
 	 * - `starting`: Instance is in the process of starting up.
 	 * - `running`: Instance startup completed and is now running.
+	 * - `stopping`: Instance is in the processing stopping.
 	 * - `creating_save`: Instance is in the process of creating a save.
 	 * - `exporting_data`: Instance is in the process of exporting item
 	 *   icons and locale data.
+	 * - `deleted`: Instance was deleted.
 	 *
 	 * On master startup all known instances gets the status `unknown` if
 	 * they are assigned to a slave, when the slave then connects to the
 	 * master and informs of the current status of its instances this hook
 	 * is invoked for all those instances.  You can detect this situation by
-	 * checking if prev equals `unknown`.
+	 * checking if prev equals `unknown`.  If the slave disconnects the
+	 * instances will again get the `unknown` status.
+	 *
+	 * When instances are created on the master they will notify of a status
+	 * change with prev set to null.  While the status of new instances is
+	 * in most cases `unassigned` it's possible for the created instance to
+	 * start with any state in some slave connection corner cases.
 	 *
 	 * Note that it's possible for status change notification to get lost in
 	 * the case of network outages if reconnect fails to re-establish the
 	 * session between the master server and the slave.
 	 *
 	 * @param {Object} instance - the instance that changed.
-	 * @param {string} prev - the previous status of the instance.
+	 * @param {?string} prev - the previous status of the instance.
 	 */
 	async onInstanceStatusChanged(instance, prev) { }
 
+	/**
+	 * Called when the value of a master config field changed.
+	 *
+	 * Invoked after the value of the config field given by `field` has
+	 * changed on the master.
+	 *
+	 * @param {module:lib/config.ConfigGroup} group -
+	 *     The group who's field got changed.
+	 * @param {string} field - Name of the field that changed.
+	 * @param {*} prev - The previous value of the field.
+	 */
+	async onMasterConfigFieldChanged(group, field, prev) { }
+
+	/**
+	 * Called when the value of an instance config field changed.
+	 *
+	 * Invoked after the value of the config field given by `field` has
+	 * changed on an instance.
+	 *
+	 * @param {Object} instance - The instance the config changed on.
+	 * @param {module:lib/config.ConfigGroup} group -
+	 *     The group who's field got changed.
+	 * @param {string} field - Name of the field that changed.
+	 * @param {*} prev - The previous value of the field.
+	 */
+	async onInstanceConfigFieldChanged(instance, group, field, prev) { }
+
 	/**
 	 * Called before collecting Prometheus metrics
 	 *
@@ -323,7 +437,7 @@ class BaseMasterPlugin {
 	 *
 	 * Invoked when the connection to the slave has been closed.
 	 *
-	 * @param {module:master/master~SlaveConnection} connection -
+	 * @param {module:master/src/SlaveConnection} connection -
 	 *     The connection the event occured on.
 	 * @param {string} event - one of connect, drop, resume and close
 	 */
@@ -359,7 +473,7 @@ class BaseMasterPlugin {
 	 *
 	 * Invoked when the connection to the control has been closed.
 	 *
-	 * @param {module:master/master~ControlConnection} connection -
+	 * @param {module:master/src/ControlConnection} connection -
 	 *     The connection the event occured on.
 	 * @param {string} event - one of connect, drop, resume, and close.
 	 */
@@ -375,7 +489,7 @@ class BaseMasterPlugin {
 	 * Plugins must stop sending messages to the slave in question after the
 	 * prepare disconnect has been handled.
 	 *
-	 * @param {module:master/master~SlaveConnection} connection -
+	 * @param {module:master/src/SlaveConnection} connection -
 	 *     The connection to the slave preparing to disconnect.
 	 */
 	async onPrepareSlaveDisconnect(connection) { }
@@ -388,8 +502,12 @@ class BaseMasterPlugin {
 	 *
 	 * @param {Object} instance - the instance it occured on.
 	 * @param {Object} event - Information about the event.
-	 * @param {string} event.type - Either "join" or "leave".
+	 * @param {string} event.type - Either "join", "leave" or "import".
 	 * @param {string} event.name - Name of the player that joined/left.
+	 * @param {string=} event.reason -
+	 *     Only present for type "leave". Reason for player leaving the
+	 *     game, one of the possible reasons in defines.disconnect_reason
+	 *     or "server_quit" if the server exits while the player is online.
 	 */
 	async onPlayerEvent(instance, event) { }
 
@@ -404,7 +522,7 @@ class BaseMasterPlugin {
 	 * @param {Object} data - Data ta pass with the event.
 	 */
 	broadcastEventToSlaves(event, data={}) {
-		for (let slaveConnection of this.master.slaveConnections.values()) {
+		for (let slaveConnection of this.master.wsServer.slaveConnections.values()) {
 			if (
 				!slaveConnection.connector.closing
 				&& (!event.plugin || slaveConnection.plugins.has(event.plugin))
@@ -478,11 +596,14 @@ class BaseControlPlugin {
 
 /**
  * Plugin supplied pages
- * @typedef {Object} module:Lib/plugin~Page
+ * @typedef {Object} module:lib/plugin~Page
  * @property {string} path - URL path to this page.
  * @property {string=} sidebarPath -
  *     If present and this path matches one of the pages in the sidebar it
  *     will cause that sidebar entry to be highlighted as active.
+ * @property {string=} sidebarGroup -
+ *     If present group this entry under a group of the given name in the
+ *     sidebar.
  * @property {string=} sidebarName -
  *     If present creates an entry in the sidebar for this page with the
  *     given text.
@@ -543,6 +664,42 @@ class BaseWebPlugin {
 		 * @type {Array<module:lib/plugin~Page>}
 		 */
 		this.pages = [];
+
+		/**
+		 * Extra react component to add to core components
+		 *
+		 * Interface to augment core components of the web UI.  Setting a
+		 * component as one of the supported properties of this object will
+		 * cause the web UI to render it when displaying that component,
+		 * usually at the end.  Each component will receive a `plugin` param
+		 * which is the instance of the web plugin that contained the
+		 * component extra.
+		 *
+		 * @type {object}
+		 * @property {React.ComponentType} MasterPage -
+		 *     Placed at the end of the master page.
+		 * @property {React.ComponentType} SlavesPage -
+		 *     Placed at the end of the slaves list page.
+		 * @property {React.ComponentType} SlaveViewPage -
+		 *     Placed at the end of each slave page.  Takes a `slave` param
+		 *     which is the slave the page is displayed for.
+		 * @property {React.ComponentType} InstancesPage -
+		 *     Placed at the end of the instance list page.
+		 * @property {React.ComponentType} InstanceViewPage -
+		 *     Placed at the end of each instance page.  Takes an `instance`
+		 *     param which is the instance the page is displayed for.
+		 * @property {React.ComponentType} UsersPage -
+		 *     Placed at the end of the users list page.
+		 * @property {React.ComponentType} UserViewPage -
+		 *     Placed at the end of each user page.  Takes a `user` param
+		 *     which is the user object the page is displayed for.
+		 * @property {React.ComponentType} RolesPage -
+		 *     Placed at the end of the roles list page.
+		 * @property {React.ComponentType} RoleViewPage -
+		 *     Placed at the end of each role page.  Takes a `role` param
+		 *     which is the role object the page is displayed for.
+		 */
+		this.componentExtra = {};
 	}
 
 	/**
@@ -637,8 +794,16 @@ async function invokeHook(plugins, hook, ...args) {
 	let results = [];
 	for (let [name, plugin] of plugins) {
 		try {
-			let result = await plugin[hook](...args);
-			if (result !== undefined) {
+			// Use an object to detect if the hook failed on timeout or tried to return a value looking like an error
+			const timeout = {};
+			let result = await helpers.timeout(
+				plugin[hook](...args),
+				15000,
+				timeout
+			);
+			if (result === timeout) {
+				throw new Error(`Invoking hook ${hook} timed out for plugin ${name}`);
+			} else if (result !== undefined) {
 				results.push(result);
 			}
 		} catch (err) {

packages/lib/plugin_loader.js

@@ -1,4 +1,4 @@
-/* eslint-disable global-require */
+/* eslint-disable node/global-require */
 /**
  * Helpers for loading plugins in Node.js
  * @module lib/plugin_loader

packages/lib/schema.js

@@ -98,15 +98,33 @@ const serverHandshake = ajv.compile({
 				"type": { const: "ready" },
 				"data": {
 					additionalProperties: false,
-					required: ["session_token", "heartbeat_interval"],
+					required: ["session_token", "session_timeout", "heartbeat_interval"],
 					properties: {
 						"session_token": { type: "string" },
+						"session_timeout": { type: "number" },
 						"heartbeat_interval": { type: "number" },
 						"account": {
+							type: "object",
 							additionalProperties: false,
-							required: ["name"],
+							required: ["name", "roles"],
 							properties: {
 								"name": { type: "string" },
+								"roles": {
+									type: "array",
+									items: {
+										additionalProperties: false,
+										type: "object",
+										required: ["name", "id", "permissions"],
+										properties: {
+											"name": { type: "string" },
+											"id": { type: "integer" },
+											"permissions": {
+												type: "array",
+												items: { type: "string" },
+											},
+										},
+									},
+								},
 							},
 						},
 					},
@@ -118,9 +136,10 @@ const serverHandshake = ajv.compile({
 				"type": { const: "continue" },
 				"data": {
 					additionalProperties: false,
-					required: ["last_seq", "heartbeat_interval"],
+					required: ["last_seq", "session_timeout", "heartbeat_interval"],
 					properties: {
 						"last_seq": { type: ["integer", "null"] },
+						"session_timeout": { type: "number" },
 						"heartbeat_interval": { type: "number" },
 					},
 				},
@@ -159,6 +178,7 @@ const clientHandshake = ajv.compile({
 						"version": { type: "string" },
 						"name": { type: "string" },
 						"id": { type: "integer" },
+						"public_address": { type: "string" },
 						"plugins": {
 							type: "object",
 							additionalProperties: { type: "string" },

packages/lib/shared_commands.js

@@ -3,10 +3,10 @@
  * @module lib/shared_commands
  */
 "use strict";
-const fs = require("fs-extra");
 const path = require("path");
 
 const libConfig = require("./config");
+const libFileOps = require("./file_ops");
 const { logger } = require("./logging");
 const libHelpers = require("./helpers");
 
@@ -55,7 +55,7 @@ async function handlePluginCommand(args, pluginList, pluginListPath) {
 
 		let pluginInfo;
 		try {
-			// eslint-disable-next-line global-require
+			// eslint-disable-next-line node/global-require
 			pluginInfo = require(path.posix.join(pluginPath, "info"));
 		} catch (err) {
 			logger.error(`Unable to import plugin info from ${args.path}:\n${err.stack}`);
@@ -70,7 +70,7 @@ async function handlePluginCommand(args, pluginList, pluginListPath) {
 		}
 
 		pluginList.set(pluginInfo.name, pluginPath);
-		await fs.outputFile(pluginListPath, JSON.stringify([...pluginList], null, 4));
+		await libFileOps.safeOutputFile(pluginListPath, JSON.stringify([...pluginList], null, 4));
 		print(`Added ${pluginInfo.name}`);
 
 	} else if (command === "remove") {
@@ -80,7 +80,7 @@ async function handlePluginCommand(args, pluginList, pluginListPath) {
 			return;
 		}
 
-		await fs.outputFile(pluginListPath, JSON.stringify([...pluginList], null, 4));
+		await libFileOps.safeOutputFile(pluginListPath, JSON.stringify([...pluginList], null, 4));
 		print(`Removed ${args.name}`);
 
 	} else if (command === "list") {
@@ -155,7 +155,7 @@ async function handleConfigCommand(args, instance, configPath) {
 
 		try {
 			instance.set(args.field, args.value);
-			await fs.outputFile(configPath, JSON.stringify(instance.serialize(), null, 4));
+			await libFileOps.safeOutputFile(configPath, JSON.stringify(instance.serialize(), null, 4));
 		} catch (err) {
 			if (err instanceof libConfig.InvalidField || err instanceof libConfig.InvalidValue) {
 				logger.error(err.message);

packages/lib/stream.js

@@ -0,0 +1,168 @@
+"use strict";
+const assert = require("assert");
+const fs = require("fs-extra");
+const stream = require("stream");
+
+
+/**
+ * Transform splitting a stream into lines
+ *
+ * Splits up a stream of chunks by newlines and passes on the lines one by
+ * one removing the line feed and optional carriage return from the lines.
+ *
+ * @example
+ * let lineStream = new libStream.LineSplitter({ readableObjectMode: true });
+ * lineStream.on("data", line => { console.log(line.toString("utf8")); });
+ * let fileStream = fs.createReadStream(path);
+ * fileStream.pipe(lineStream);
+ *
+ * @memberof module:lib/stream
+ */
+class LineSplitter extends stream.Transform {
+	constructor(options) {
+		super(options);
+		this._partial = null;
+	}
+
+	_transform(chunk, encoding, callback) {
+		if (this._partial) {
+			chunk = Buffer.concat([this._partial, chunk]);
+			this._partial = null;
+		}
+
+		while (chunk.length) {
+			let end = chunk.indexOf("\n");
+			if (end === -1) {
+				this._partial = chunk;
+				break;
+			}
+
+			let next = end + 1;
+			// Eat carriage return as well if present
+			if (end >= 1 && chunk[end-1] === "\r".charCodeAt(0)) {
+				end -= 1;
+			}
+
+			let line = chunk.slice(0, end);
+			chunk = chunk.slice(next);
+			this.push(line);
+		}
+		callback();
+	}
+
+	_flush(callback) {
+		if (this._partial) {
+			this.push(this._partial);
+			this._partial = null;
+		}
+		callback();
+	}
+}
+
+/**
+ * Transform splitting a reverse stream into lines
+ *
+ * Splits up a reverse stream of chunks created by {@link
+ * module:lib/stream.createReverseReadStream} by newlines and passes on the
+ * lines one by one in reverse order removing the line feed and optional
+ * carriage return from the lines.
+ *
+ * @example
+ * let revLineStream = new libStream.ReverseLineSplitter({ readableObjectMode: true });
+ * revLineStream.on("data", line => { console.log(line.toString("utf8")); });
+ * let revFileStream = await libStream.createReverseReadStream(path);
+ * revFileStream.pipe(revLineStream);
+ *
+ * @memberof module:lib/stream
+ */
+class ReverseLineSplitter extends stream.Transform {
+	constructor(options) {
+		super(options);
+		this._partial = null;
+	}
+
+	_transform(chunk, encoding, callback) {
+		if (this._partial) {
+			chunk = Buffer.concat([chunk, this._partial]);
+			this._partial = null;
+		}
+
+		while (chunk.length) {
+			let next = chunk.lastIndexOf("\n", -2);
+			if (next === -1) {
+				this._partial = chunk;
+				break;
+			}
+
+			let end = chunk.length - 1;
+			if (chunk[end] === "\n".charCodeAt(0)) {
+				end -= 1;
+				// Eat carriage return as well if present
+				if (end - next > 0 && chunk[end] === "\r".charCodeAt(0)) {
+					end -= 1;
+				}
+			}
+
+			let line = chunk.slice(next + 1, end + 1);
+			chunk = chunk.slice(0, next + 1);
+			this.push(line);
+		}
+		callback();
+	}
+
+	_flush(callback) {
+		if (this._partial) {
+			let end = this._partial.length - 1;
+			if (this._partial[end] === "\n".charCodeAt(0)) {
+				end -= 1;
+				// Eat carriage return as well if present
+				if (end > 0 && this._partial[end] === "\r".charCodeAt(0)) {
+					end -= 1;
+				}
+			}
+			this.push(this._partial.slice(0, end + 1));
+			this._partial = null;
+		}
+		callback();
+	}
+}
+
+
+/**
+ * Create a file read stream running in reverse
+ *
+ * Like fs.createReadStream but provides data chunks starting from the end
+ * of the file and progressing towards the start of the file.  The chunks
+ * are not reversed, thus the file content can be recreated by concatenating
+ * the chunks together in the reverse order they are read.
+ *
+ * @param {string} path -
+ *     Path to file to open. May be anything accepted by fs.open.
+ * @param {object} options -
+ *     Options to pass to fs.createReadStream.  Values passed for `fd` and
+ *     `fs` will be ignored.
+ * @memberof module:lib/stream
+ */
+async function createReverseReadStream(path, options) {
+	const fileFd = await fs.open(path, "r");
+	const fileSize = (await fs.fstat(fileFd)).size;
+	let filePosition = fileSize;
+	const reverseFs = {
+		read(fd, buffer, offset, length, position, callback) {
+			assert(fd === fileFd);
+			assert(position === undefined);
+			length = Math.min(length, filePosition);
+			filePosition -= length;
+			return fs.read(fd, buffer, offset, length, filePosition, callback);
+		},
+		open() { assert(false); },
+		close(fd, callback) { return fs.close(fd, callback); },
+	};
+	return fs.createReadStream("", { ...options, fd: fileFd, fs: reverseFs });
+}
+
+module.exports = {
+	LineSplitter,
+	ReverseLineSplitter,
+	createReverseReadStream,
+};

packages/lib/users.js

@@ -11,6 +11,8 @@ const jwt = require("jsonwebtoken");
 
 const libErrors = require("./errors");
 
+const PlayerStats = require("./PlayerStats");
+
 
 /**
  * Represents a permission that can be granted
@@ -195,6 +197,28 @@ class User {
 				}
 			}
 		}
+
+		/**
+		 * Per instance statistics for the player this user account is tied to.
+		 * @type {Map<number, module:lib/PlayerStats>}
+		 */
+		this.instanceStats = new Map(
+			(serializedUser.instance_stats ? serializedUser.instance_stats : []).map(
+				([id, stats]) => [id, new PlayerStats(stats)]
+			)
+		);
+
+		/**
+		 * Combined statistics for the player this user account is tied to.
+		 * @type {module:lib/PlayerStats}
+		 */
+		this.playerStats = this._calculatePlayerStats();
+
+		/**
+		 * True if this user object has been removed from the cluster.
+		 * @type {boolean}
+		 */
+		this.isDeleted = false;
 	}
 
 	serialize() {
@@ -226,6 +250,10 @@ class User {
 			serialized.ban_reason = this.banReason;
 		}
 
+		if (this.instanceStats.size) {
+			serialized.instance_stats = [...this.instanceStats].map(([id, stats]) => [id, stats.toJSON()]);
+		}
+
 		return serialized;
 	}
 
@@ -236,7 +264,7 @@ class User {
 	 * @returns {string} JWT access token for the user.
 	 */
 	createToken(secret) {
-		return jwt.sign({ aud: "user", user: this.name }, secret);
+		return jwt.sign({ aud: "user", user: this.name }, Buffer.from(secret, "base64"));
 	}
 
 	/**
@@ -285,6 +313,26 @@ class User {
 			User.onlineUsers.delete(this);
 		}
 	}
+
+	recalculatePlayerStats() {
+		this.playerStats = this._calculatePlayerStats();
+	}
+
+	_calculatePlayerStats() {
+		let playerStats = new PlayerStats();
+		for (let instanceStats of this.instanceStats.values()) {
+			if (!playerStats.lastJoinAt || instanceStats.lastJoinAt > playerStats.lastJoinAt) {
+				playerStats.lastJoinAt = instanceStats.lastJoinAt;
+			}
+			if (!playerStats.lastLeaveAt || instanceStats.lastLeaveAt > playerStats.lastLeaveAt) {
+				playerStats.lastLeaveAt = instanceStats.lastLeaveAt;
+				playerStats.lastLeaveReason = instanceStats.lastLeaveReason;
+			}
+			playerStats.joinCount += instanceStats.joinCount;
+			playerStats.onlineTimeMs += instanceStats.onlineTimeMs;
+		}
+		return playerStats;
+	}
 }
 /**
  * Set of users currently online in the cluster.
@@ -322,6 +370,12 @@ definePermission({
 	description: "Get the full list of slaves in the cluster.",
 	grantByDefault: true,
 });
+definePermission({
+	name: "core.slave.subscribe",
+	title: "Subscribe to slave updates",
+	description: "Subscribe to be notified on updates on the details of slaves.",
+	grantByDefault: true,
+});
 definePermission({
 	name: "core.slave.generate_token",
 	title: "Generate slave token",
@@ -333,12 +387,24 @@ definePermission({
 	description: "Create slave configs via the master server.",
 });
 
+definePermission({
+	name: "core.instance.get",
+	title: "Get instance",
+	description: "Get the details of an instance in the cluster.",
+	grantByDefault: true,
+});
 definePermission({
 	name: "core.instance.list",
 	title: "List instances",
 	description: "Get the full list of instances in the cluster.",
 	grantByDefault: true,
 });
+definePermission({
+	name: "core.instance.subscribe",
+	title: "Subscribe to instance updates",
+	description: "Subscribe to be notified on updates on the details and status of instances.",
+	grantByDefault: true,
+});
 definePermission({
 	name: "core.instance.create",
 	title: "Create instance",
@@ -360,15 +426,60 @@ definePermission({
 	description: "Assign or reassign instances to a slave.",
 });
 definePermission({
-	name: "core.instance.create_save",
-	title: "Create new instance save",
+	name: "core.instance.save.list",
+	title: "List saves",
+	description: "List the saves currently on the instance.",
+});
+definePermission({
+	name: "core.instance.save.list_subscribe",
+	title: "Subscribe to save list updatess",
+	description: "Subscribe to be notifed on updates to the list of saves of instances.",
+});
+definePermission({
+	name: "core.instance.save.create",
+	title: "Create new save",
 	description: "Create new savegames on instances.",
 });
+definePermission({
+	name: "core.instance.save.rename",
+	title: "Rename save",
+	description: "Rename savegames on instances.",
+});
+definePermission({
+	name: "core.instance.save.copy",
+	title: "Copy save",
+	description: "Create copies of savegames on instances.",
+});
+definePermission({
+	name: "core.instance.save.delete",
+	title: "Delete save",
+	description: "Delete savegames on instances.",
+});
+definePermission({
+	name: "core.instance.save.upload",
+	title: "Upload save",
+	description: "Upload savegames to instances.",
+});
+definePermission({
+	name: "core.instance.save.transfer",
+	title: "Transfer save",
+	description: "Transfer savegames between instances.",
+});
+definePermission({
+	name: "core.instance.save.download",
+	title: "Download save",
+	description: "Download savegames from instances.",
+});
 definePermission({
 	name: "core.instance.export_data",
 	title: "Export locale and icons",
 	description: "Export the the locale and icons from an instance and upload it to the master.",
 });
+definePermission({
+	name: "core.instance.extract_players",
+	title: "Extract player stats from running save",
+	description: "Run extraction to create a user for each player in the save and set the online time from the save.",
+});
 definePermission({
 	name: "core.instance.start",
 	title: "Start instance",
@@ -384,6 +495,11 @@ definePermission({
 	title: "Stop instance",
 	description: "Stop instances.",
 });
+definePermission({
+	name: "core.instance.kill",
+	title: "Kill instance",
+	description: "Terminate running instances without saving or cleanup.",
+});
 definePermission({
 	name: "core.instance.delete",
 	title: "Delete instance",
@@ -424,11 +540,21 @@ definePermission({
 	description: "Permanently delete roles.",
 });
 
+definePermission({
+	name: "core.user.get",
+	title: "Get user",
+	description: "Get the details of a user in the cluster.",
+});
 definePermission({
 	name: "core.user.list",
 	title: "List users",
 	description: "Get the full list of users in the cluster.",
 });
+definePermission({
+	name: "core.user.subscribe",
+	title: "Subscribe to user updates",
+	description: "Subscribe to be notified on updates on the details and status of users.",
+});
 definePermission({
 	name: "core.user.create",
 	title: "Create users",

packages/master/.npmignore

@@ -0,0 +1 @@
+webpack.config.js

packages/master/README.md

@@ -111,4 +111,4 @@ Runs the master server.
 
 ## See Also
 
-[The Clusterio repository](https://github.com/clusterio/factorioClusterio) for instructions on how to set up a cluster.
+[The Clusterio repository](https://github.com/clusterio/clusterio) for instructions on how to set up a cluster.

packages/master/package.json

@@ -3,10 +3,10 @@
   "description": "Implementation of Clusterio master server",
   "author": "Hornwitser",
   "license": "MIT",
-  "version": "2.0.0-alpha.5",
+  "version": "2.0.0-alpha.13",
   "main": "master.js",
   "scripts": {
-    "build": "webpack-cli --env.production",
+    "prepare": "webpack-cli --env production",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "bin": {
@@ -16,32 +16,30 @@
     "factorio"
   ],
   "engines": {
-    "node": ">=10.16 <11 || >= 12"
+    "node": ">=12"
   },
   "dependencies": {
-    "@clusterio/lib": "^2.0.0-alpha.5",
-    "body-parser": "^1.18.2",
+    "@clusterio/lib": "^2.0.0-alpha.13",
+    "busboy": "^0.3.1",
     "compression": "^1.7.2",
-    "cookie-parser": "^1.4.3",
     "express": "^4.16.2",
-    "express-fileupload": "1.2.0",
     "fs-extra": "^8.1.0",
     "jsonwebtoken": "^8.2.1",
     "jszip": "^3.2.2",
-    "node-factorio-api": "^0.3.8",
     "set-blocking": "^2.0.0",
+    "webpack-cli": "^4.9.2",
     "winston": "^3.3.3",
+    "winston-daily-rotate-file": "^4.5.5",
     "ws": "^7.2.3",
     "yargs": "^14.2.0"
   },
   "devDependencies": {
-    "@clusterio/web_ui": "^2.0.0-alpha.5",
-    "fast-deep-equal": "^3.1.3",
+    "@clusterio/web_ui": "^2.0.0-alpha.13",
     "react": "^16.13.1",
     "react-dom": "^16.13.1",
     "react-router-dom": "^5.2.0",
-    "webpack-cli": "^3.3.12",
-    "webpack-dev-middleware": "^4.1.0",
+    "webpack": "^5.73.0",
+    "webpack-dev-middleware": "^5.3.1",
     "webpack-merge": "^5.2.0"
   },
   "publishConfig": {

packages/master/src/BaseConnection.js

@@ -0,0 +1,89 @@
+"use strict";
+const libErrors = require("@clusterio/lib/errors");
+const libLink = require("@clusterio/lib/link");
+const { logger } = require("@clusterio/lib/logging");
+const libPlugin = require("@clusterio/lib/plugin");
+
+
+/**
+ * Base class for master server connections
+ *
+ * @extends module:lib/link.Link
+ * @alias module:master/src/BaseConnection
+ */
+class BaseConnection extends libLink.Link {
+	constructor(target, connector, master) {
+		/** @member {module:master/src/WsServerConnector} module:master/src/BaseConnection#connector */
+		super("master", target, connector);
+		this._master = master;
+		this._disconnecting = false;
+		libLink.attachAllMessages(this);
+		for (let masterPlugin of this._master.plugins.values()) {
+			libPlugin.attachPluginMessages(this, masterPlugin);
+		}
+	}
+
+	async forwardRequestToInstance(message, request) {
+		return await this._master.forwardRequestToInstance(request, message.data);
+	}
+
+	async forwardEventToInstance(message, event) {
+		let instance = this._master.instances.get(message.data.instance_id);
+		if (!instance) { return; }
+
+		let slaveId = instance.config.get("instance.assigned_slave");
+		if (slaveId === null) { return; }
+
+		let connection = this._master.wsServer.slaveConnections.get(slaveId);
+		if (!connection || connection.closing) { return; }
+		if (event.plugin && !connection.plugins.has(event.plugin)) { return; }
+
+		event.send(connection, message.data);
+	}
+
+	async broadcastEventToSlaves(message, event) {
+		for (let slaveConnection of this._master.wsServer.slaveConnections.values()) {
+			// Do not broadcast back to the source
+			if (slaveConnection === this) { continue; }
+			if (slaveConnection.connector.closing) { continue; }
+			if (event.plugin && !slaveConnection.plugins.has(event.plugin)) { continue; }
+
+			event.send(slaveConnection, message.data);
+		}
+	}
+
+	async broadcastEventToInstance(message, event) {
+		await this.broadcastEventToSlaves(message, event);
+	}
+
+	async prepareDisconnectRequestHandler(message, request) {
+		await libPlugin.invokeHook(this._master.plugins, "onPrepareSlaveDisconnect", this);
+		this._disconnecting = true;
+		this.connector.setClosing();
+		return await super.prepareDisconnectRequestHandler(message, request);
+	}
+
+	async disconnect(code, reason) {
+		this.connector.setClosing();
+		try {
+			await libLink.messages.prepareDisconnect.send(this);
+		} catch (err) {
+			if (!(err instanceof libErrors.SessionLost)) {
+				logger.error(`"Unexpected error preparing disconnect:\n${err.stack}`);
+			}
+		}
+
+		await this.connector.close(code, reason);
+	}
+
+	/**
+	 * True if the link is connected, not in the dropped state and not in
+	 * the process of disconnecting.
+	 * @type {boolean}
+	 */
+	get connected() {
+		return !this._disconnecting && this.connector.connected;
+	}
+}
+
+module.exports = BaseConnection;

packages/master/src/ControlConnection.js

@@ -0,0 +1,737 @@
+"use strict";
+const jwt = require("jsonwebtoken");
+const events = require("events");
+
+const libConfig = require("@clusterio/lib/config");
+const libErrors = require("@clusterio/lib/errors");
+const libLink = require("@clusterio/lib/link");
+const { logger } = require("@clusterio/lib/logging");
+const libLoggingUtils = require("@clusterio/lib/logging_utils");
+const libPlugin = require("@clusterio/lib/plugin");
+const libPrometheus = require("@clusterio/lib/prometheus");
+const libUsers = require("@clusterio/lib/users");
+
+const BaseConnection = require("./BaseConnection");
+const routes = require("./routes");
+
+const lastQueryLogTime = new libPrometheus.Gauge(
+	"clusterio_master_last_query_log_duration_seconds",
+	"Time in seconds the last log query took to execute."
+);
+
+/**
+ * Represents the connection to a control link
+ *
+ * @extends module:master/src/BaseConnection
+ * @alias module:master/src/ControlConnection
+ */
+class ControlConnection extends BaseConnection {
+	constructor(registerData, connector, master, user) {
+		super("control", connector, master);
+
+		this._agent = registerData.agent;
+		this._version = registerData.version;
+
+		/**
+		 * The user making this connection.
+		 * @type {module:lib/users.User}
+		 */
+		this.user = user;
+
+		this.slaveSubscriptions = {
+			all: false,
+			slave_ids: [],
+		};
+
+		this.instanceSubscriptions = {
+			all: false,
+			instance_ids: [],
+		};
+
+		this.saveListSubscriptions = {
+			all: false,
+			instance_ids: [],
+		};
+
+		this.userSubscriptions = {
+			all: false,
+			names: [],
+		};
+
+		this.logTransport = null;
+		this.logSubscriptions = {
+			all: false,
+			master: false,
+			slave_ids: [],
+			instance_ids: [],
+		};
+
+		this.ws_dumper = null;
+		this.connector.on("connect", () => {
+			this.connector._socket.clusterio_ignore_dump = Boolean(this.ws_dumper);
+		});
+		this.connector.on("close", () => {
+			if (this.logTransport) {
+				this.logTransport = null;
+				logger.remove(this.logTransport);
+			}
+			if (this.ws_dumper) {
+				this._master.debugEvents.off("message", this.ws_dumper);
+			}
+		});
+
+		for (let event of ["connect", "drop", "resume", "close"]) {
+			this.connector.on(event, () => {
+				for (let masterPlugin of this._master.plugins.values()) {
+					masterPlugin.onControlConnectionEvent(this, event);
+				}
+			});
+		}
+	}
+
+	async getMasterConfigRequestHandler() {
+		return { serialized_config: this._master.config.serialize("control") };
+	}
+
+	async setMasterConfigFieldRequestHandler(message) {
+		this._master.config.set(message.data.field, message.data.value, "control");
+	}
+
+	async setMasterConfigPropRequestHandler(message) {
+		let { field, prop, value } = message.data;
+		this._master.config.setProp(field, prop, value, "control");
+	}
+
+	async listSlavesRequestHandler(message) {
+		let list = [];
+		for (let slave of this._master.slaves.values()) {
+			list.push({
+				agent: slave.agent,
+				version: slave.version,
+				id: slave.id,
+				name: slave.name,
+				public_address: slave.public_address || null,
+				connected: this._master.wsServer.slaveConnections.has(slave.id),
+			});
+		}
+		return { list };
+	}
+
+	async setSlaveSubscriptionsRequestHandler(message) {
+		this.slaveSubscriptions = message.data;
+	}
+
+	slaveUpdated(slave, update) {
+		if (
+			this.slaveSubscriptions.all
+			|| this.slaveSubscriptions.slave_ids.includes(slave.id)
+		) {
+			libLink.messages.slaveUpdate.send(this, update);
+		}
+	}
+
+	generateSlaveToken(slaveId) {
+		return jwt.sign(
+			{ aud: "slave", slave: slaveId },
+			Buffer.from(this._master.config.get("master.auth_secret"), "base64")
+		);
+	}
+
+	async generateSlaveTokenRequestHandler(message) {
+		let slaveId = message.data.slave_id;
+		if (slaveId === null) {
+			slaveId = Math.random() * 2**31 | 0;
+		}
+		return { token: this.generateSlaveToken(slaveId) };
+	}
+
+	async createSlaveConfigRequestHandler(message) {
+		let slaveConfig = new libConfig.SlaveConfig("control");
+		await slaveConfig.init();
+
+		slaveConfig.set("slave.master_url", this._master.getMasterUrl());
+		if (message.data.id !== null) {
+			slaveConfig.set("slave.id", message.data.id);
+		}
+		if (message.data.name !== null) {
+			slaveConfig.set("slave.name", message.data.name);
+		}
+		if (message.data.generate_token) {
+			this.user.checkPermission("core.slave.generate_token");
+			slaveConfig.set("slave.master_token", this.generateSlaveToken(slaveConfig.get("slave.id")));
+		}
+		return { serialized_config: slaveConfig.serialize() };
+	}
+
+	async getInstanceRequestHandler(message) {
+		let id = message.data.id;
+		let instance = this._master.getRequestInstance(id);
+
+		return {
+			id,
+			name: instance.config.get("instance.name"),
+			assigned_slave: instance.config.get("instance.assigned_slave"),
+			game_port: instance.game_port || null,
+			status: instance.status,
+		};
+	}
+
+	async listInstancesRequestHandler(message) {
+		let list = [];
+		for (let instance of this._master.instances.values()) {
+			list.push({
+				id: instance.config.get("instance.id"),
+				name: instance.config.get("instance.name"),
+				assigned_slave: instance.config.get("instance.assigned_slave"),
+				game_port: instance.game_port || null,
+				status: instance.status,
+			});
+		}
+		return { list };
+	}
+
+	async setInstanceSubscriptionsRequestHandler(message) {
+		this.instanceSubscriptions = message.data;
+	}
+
+	instanceUpdated(instance) {
+		if (
+			this.instanceSubscriptions.all
+			|| this.instanceSubscriptions.instance_ids.includes(instance.config.get("instance.id"))
+		) {
+			libLink.messages.instanceUpdate.send(this, {
+				id: instance.config.get("instance.id"),
+				name: instance.config.get("instance.name"),
+				assigned_slave: instance.config.get("instance.assigned_slave"),
+				game_port: instance.game_port || null,
+				status: instance.status,
+			});
+		}
+	}
+
+	// XXX should probably add a hook for slave reuqests?
+	async createInstanceRequestHandler(message) {
+		let instanceConfig = new libConfig.InstanceConfig("master");
+		await instanceConfig.load(message.data.serialized_config);
+
+		let instanceId = instanceConfig.get("instance.id");
+		if (this._master.instances.has(instanceId)) {
+			throw new libErrors.RequestError(`Instance with ID ${instanceId} already exists`);
+		}
+
+		// Add common settings for the Factorio server
+		let settings = {
+			"name": `${this._master.config.get("master.name")} - ${instanceConfig.get("instance.name")}`,
+			"description": `Clusterio instance for ${this._master.config.get("master.name")}`,
+			"tags": ["clusterio"],
+			"max_players": 0,
+			"visibility": { "public": true, "lan": true },
+			"username": "",
+			"token": "",
+			"game_password": "",
+			"require_user_verification": true,
+			"max_upload_in_kilobytes_per_second": 0,
+			"max_upload_slots": 5,
+			"ignore_player_limit_for_returning_players": false,
+			"allow_commands": "admins-only",
+			"autosave_interval": 10,
+			"autosave_slots": 5,
+			"afk_autokick_interval": 0,
+			"auto_pause": false,
+			"only_admins_can_pause_the_game": true,
+			"autosave_only_on_server": true,
+
+			...instanceConfig.get("factorio.settings"),
+		};
+		instanceConfig.set("factorio.settings", settings);
+
+		let instance = { config: instanceConfig, status: "unassigned" };
+		this._master.instances.set(instanceId, instance);
+		await libPlugin.invokeHook(this._master.plugins, "onInstanceStatusChanged", instance, null);
+		this._master.addInstanceHooks(instance);
+	}
+
+	async deleteInstanceRequestHandler(message, request) {
+		let instance = this._master.getRequestInstance(message.data.instance_id);
+		if (instance.config.get("instance.assigned_slave") !== null) {
+			await this.forwardRequestToInstance(message, request);
+		}
+		this._master.instances.delete(message.data.instance_id);
+
+		let prev = instance.status;
+		instance.status = "deleted";
+		this._master.instanceUpdated(instance);
+		await libPlugin.invokeHook(this._master.plugins, "onInstanceStatusChanged", instance, prev);
+	}
+
+	async getInstanceConfigRequestHandler(message) {
+		let instance = this._master.getRequestInstance(message.data.instance_id);
+		return {
+			serialized_config: instance.config.serialize("control"),
+		};
+	}
+
+	async updateInstanceConfig(instance) {
+		let slaveId = instance.config.get("instance.assigned_slave");
+		if (slaveId) {
+			let connection = this._master.wsServer.slaveConnections.get(slaveId);
+			if (connection) {
+				await libLink.messages.assignInstance.send(connection, {
+					instance_id: instance.config.get("instance.id"),
+					serialized_config: instance.config.serialize("slave"),
+				});
+			}
+		}
+	}
+
+	async setInstanceConfigFieldRequestHandler(message) {
+		let instance = this._master.getRequestInstance(message.data.instance_id);
+		if (message.data.field === "instance.assigned_slave") {
+			throw new libErrors.RequestError("instance.assigned_slave must be set through the assign-slave interface");
+		}
+
+		if (message.data.field === "instance.id") {
+			// XXX is this worth implementing?  It's race condition galore.
+			throw new libErrors.RequestError("Setting instance.id is not supported");
+		}
+
+		instance.config.set(message.data.field, message.data.value, "control");
+		await this.updateInstanceConfig(instance);
+	}
+
+	async setInstanceConfigPropRequestHandler(message) {
+		let instance = this._master.getRequestInstance(message.data.instance_id);
+		let { field, prop, value } = message.data;
+		instance.config.setProp(field, prop, value, "control");
+		await this.updateInstanceConfig(instance);
+	}
+
+	async assignInstanceCommandRequestHandler(message, request) {
+		let { slave_id, instance_id } = message.data;
+		let instance = this._master.getRequestInstance(instance_id);
+
+		// Check if target slave is connected
+		let newSlaveConnection;
+		if (slave_id !== null) {
+			newSlaveConnection = this._master.wsServer.slaveConnections.get(slave_id);
+			if (!newSlaveConnection) {
+				// The case of the slave not getting the assign instance message
+				// still have to be handled, so it's not a requirement that the
+				// target slave be connected to the master while doing the
+				// assignment, but it is IMHO a better user experience if this
+				// is the case.
+				throw new libErrors.RequestError("Target slave is not connected to the master server");
+			}
+		}
+
+		// Unassign from currently assigned slave if it is connected.
+		let currentAssignedSlave = instance.config.get("instance.assigned_slave");
+		if (currentAssignedSlave !== null && slave_id !== currentAssignedSlave) {
+			let oldSlaveConnection = this._master.wsServer.slaveConnections.get(currentAssignedSlave);
+			if (oldSlaveConnection && !oldSlaveConnection.connector.closing) {
+				await libLink.messages.unassignInstance.send(oldSlaveConnection, { instance_id });
+			}
+		}
+
+		// Assign to target
+		instance.config.set("instance.assigned_slave", slave_id);
+		if (slave_id !== null) {
+			await libLink.messages.assignInstance.send(newSlaveConnection, {
+				instance_id,
+				serialized_config: instance.config.serialize("slave"),
+			});
+		}
+	}
+
+	async setSaveListSubscriptionsRequestHandler(message) {
+		this.saveListSubscriptions = message.data;
+	}
+
+	saveListUpdate(data) {
+		if (
+			this.saveListSubscriptions.all
+			|| this.saveListSubscriptions.instance_ids.includes(data.instance_id)
+		) {
+			libLink.messages.saveListUpdate.send(this, data);
+		}
+	}
+
+	async downloadSaveRequestHandler(message) {
+		let { instance_id, save } = message.data;
+		let stream = await routes.createProxyStream(this._master.app);
+		stream.filename = save;
+
+		let ready = new Promise((resolve, reject) => {
+			stream.events.on("source", resolve);
+			stream.events.on("timeout", () => reject(
+				new libErrors.RequestError("Timed out establishing stream from slave")
+			));
+		});
+		ready.catch(() => {});
+
+		await this._master.forwardRequestToInstance(libLink.messages.pushSave, {
+			instance_id,
+			stream_id: stream.id,
+			save,
+		});
+
+		await ready;
+		return { stream_id: stream.id };
+	}
+
+	async transferSaveRequestHandler(message, request) {
+		let { source_save, target_save, copy, instance_id, target_instance_id } = message.data;
+		if (copy) {
+			this.user.checkPermission("core.instance.save.copy");
+		} else if (source_save !== target_save) {
+			this.user.checkPermission("core.instance.save.rename");
+		}
+
+		if (instance_id === target_instance_id) {
+			throw new libErrors.RequestError("Source and target instance may not be the same");
+		}
+		let sourceInstance = this._master.getRequestInstance(instance_id);
+		let targetInstance = this._master.getRequestInstance(target_instance_id);
+		let sourceSlaveId = sourceInstance.config.get("instance.assigned_slave");
+		let targetSlaveId = targetInstance.config.get("instance.assigned_slave");
+		if (sourceSlaveId === null) {
+			throw new libErrors.RequestError("Source instance is not assigned a slave");
+		}
+		if (targetSlaveId === null) {
+			throw new libErrors.RequestError("Target instance is not assigned a slave");
+		}
+
+		// Let slave handle request if source and target is on the same slave.
+		if (sourceSlaveId === targetSlaveId) {
+			return await this.forwardRequestToInstance(message, request);
+		}
+
+		// Check connectivity
+		let sourceSlaveConnection = this._master.wsServer.slaveConnections.get(sourceSlaveId);
+		if (!sourceSlaveConnection || sourceSlaveConnection.closing) {
+			throw new libErrors.RequestError("Source slave is not connected to the master server");
+		}
+
+		let targetSlaveConnection = this._master.wsServer.slaveConnections.get(targetSlaveId);
+		if (!targetSlaveConnection || targetSlaveConnection.closing) {
+			throw new libErrors.RequestError("Target slave is not connected to the master server");
+		}
+
+		// Create stream to proxy from target to source
+		let stream = await routes.createProxyStream(this._master.app);
+		stream.events.on("timeout", () => {
+			if (stream.source) {
+				stream.source.destroy();
+			}
+			stream.events.emit("error", new libErrors.RequestError("Timed out establishing transfer stream"));
+		});
+
+		// Ignore errors if not listening for them to avoid crash.
+		stream.events.on("error", () => { /* ignore */ });
+
+		// Establish push from source slave to stream, this is done first to
+		// ensure the file size is known prior to the target slave pull.
+		await Promise.all([
+			this._master.forwardRequestToInstance(libLink.messages.pushSave, {
+				instance_id,
+				stream_id: stream.id,
+				save: source_save,
+			}),
+			events.once(stream.events, "source"),
+		]);
+
+		// Establish pull from target slave to stream and wait for completion.
+		let result = await this._master.forwardRequestToInstance(libLink.messages.pullSave, {
+			instance_id: target_instance_id,
+			stream_id: stream.id,
+			filename: target_save,
+		});
+
+		// Delete source save if this is not a copy
+		if (!copy) {
+			await this._master.forwardRequestToInstance(libLink.messages.deleteSave, {
+				instance_id,
+				save: source_save,
+			});
+		}
+
+		return { save: result.save };
+	}
+
+	async setLogSubscriptionsRequestHandler(message) {
+		this.logSubscriptions = message.data;
+		this.updateLogSubscriptions();
+	}
+
+	updateLogSubscriptions() {
+		let { all, master, slave_ids, instance_ids } = this.logSubscriptions;
+		if (all || master || slave_ids.length || instance_ids.length) {
+			if (!this.logTransport) {
+				this.logTransport = new libLoggingUtils.LinkTransport({ link: this });
+				this._master.clusterLogger.add(this.logTransport);
+			}
+			this.logTransport.filter = libLoggingUtils.logFilter(this.logSubscriptions);
+
+		} else if (this.logTransport) {
+			this._master.clusterLogger.remove(this.logTransport);
+			this.logTransport = null;
+		}
+	}
+
+	async queryLogRequestHandler(message) {
+		let setDuration = lastQueryLogTime.startTimer();
+		let { all, master, slave_ids, instance_ids } = message.data;
+
+		let log;
+		if (!all && master && !slave_ids.length && !instance_ids.length) {
+			log = await this._master.queryMasterLog(message.data);
+		} else {
+			log = await this._master.queryClusterLog(message.data);
+		}
+
+		setDuration();
+		return { log };
+	}
+
+	async listPermissionsRequestHandler(message) {
+		let list = [];
+		for (let permission of libUsers.permissions.values()) {
+			list.push({
+				name: permission.name,
+				title: permission.title,
+				description: permission.description,
+			});
+		}
+		return { list };
+	}
+
+	async listRolesRequestHandler(message) {
+		let list = [];
+		for (let role of this._master.userManager.roles.values()) {
+			list.push({
+				id: role.id,
+				name: role.name,
+				description: role.description,
+				permissions: [...role.permissions],
+			});
+		}
+		return { list };
+	}
+
+	async createRoleRequestHandler(message) {
+		let lastId = Math.max.apply(null, [...this._master.userManager.roles.keys()]);
+
+		// Start at 5 to leave space for future default roles
+		let id = Math.max(5, lastId+1);
+		this._master.userManager.roles.set(id, new libUsers.Role({ id, ...message.data }));
+		return { id };
+	}
+
+	async updateRoleRequestHandler(message) {
+		let { id, name, description, permissions } = message.data;
+		let role = this._master.userManager.roles.get(id);
+		if (!role) {
+			throw new libErrors.RequestError(`Role with ID ${id} does not exist`);
+		}
+
+		role.name = name;
+		role.description = description;
+		role.permissions = new Set(permissions);
+		this._master.rolePermissionsUpdated(role);
+	}
+
+	async grantDefaultRolePermissionsRequestHandler(message) {
+		let role = this._master.userManager.roles.get(message.data.id);
+		if (!role) {
+			throw new libErrors.RequestError(`Role with ID ${message.data.id} does not exist`);
+		}
+
+		role.grantDefaultPermissions();
+		this._master.rolePermissionsUpdated(role);
+	}
+
+	async deleteRoleRequestHandler(message) {
+		let id = message.data.id;
+		let role = this._master.userManager.roles.get(id);
+		if (!role) {
+			throw new libErrors.RequestError(`Role with ID ${id} does not exist`);
+		}
+
+		this._master.userManager.roles.delete(id);
+		for (let user of this._master.userManager.users.values()) {
+			user.roles.delete(role);
+			this._master.userPermissionsUpdated(user);
+		}
+	}
+
+	async getUserRequestHandler(message) {
+		let name = message.data.name;
+		let user = this._master.userManager.users.get(name);
+		if (!user) {
+			throw new libErrors.RequestError(`User ${name} does not exist`);
+		}
+
+		return {
+			name: user.name,
+			roles: [...user.roles].map(role => role.id),
+			is_admin: user.isAdmin,
+			is_banned: user.isBanned,
+			is_whitelisted: user.isWhitelisted,
+			ban_reason: user.banReason,
+			instances: [...user.instances],
+			player_stats: user.playerStats,
+			instance_stats: [...user.instanceStats],
+		};
+	}
+
+	async listUsersRequestHandler(message) {
+		let list = [];
+		for (let user of this._master.userManager.users.values()) {
+			list.push({
+				name: user.name,
+				roles: [...user.roles].map(role => role.id),
+				is_admin: user.isAdmin,
+				is_banned: user.isBanned,
+				is_whitelisted: user.isWhitelisted,
+				instances: [...user.instances],
+				player_stats: user.playerStats,
+			});
+		}
+		return { list };
+	}
+
+	async setUserSubscriptionsRequestHandler(message) {
+		this.userSubscriptions = message.data;
+	}
+
+	userUpdated(user) {
+		if (
+			this.userSubscriptions.all
+			|| this.userSubscriptions.names.includes(user.name)
+		) {
+			libLink.messages.userUpdate.send(this, {
+				name: user.name,
+				roles: [...user.roles].map(role => role.id),
+				is_admin: user.isAdmin,
+				is_banned: user.isBanned,
+				is_whitelisted: user.isWhitelisted,
+				ban_reason: user.banReason,
+				instances: [...user.instances],
+				player_stats: user.playerStats,
+				instance_stats: [...user.instanceStats],
+				is_deleted: user.isDeleted,
+			});
+		}
+	}
+
+	async createUserRequestHandler(message) {
+		let user = this._master.userManager.createUser(message.data.name);
+		this._master.userUpdated(user);
+	}
+
+	async updateUserRolesRequestHandler(message) {
+		let user = this._master.userManager.users.get(message.data.name);
+		if (!user) {
+			throw new libErrors.RequestError(`User '${message.data.name}' does not exist`);
+		}
+
+		let resolvedRoles = new Set();
+		for (let roleId of message.data.roles) {
+			let role = this._master.userManager.roles.get(roleId);
+			if (!role) {
+				throw new libErrors.RequestError(`Role with ID ${roleId} does not exist`);
+			}
+
+			resolvedRoles.add(role);
+		}
+
+		user.roles = resolvedRoles;
+		this._master.userPermissionsUpdated(user);
+		this._master.userUpdated(user);
+	}
+
+	async setUserAdminRequestHandler(message) {
+		let { name, create, admin } = message.data;
+		let user = this._master.userManager.users.get(name);
+		if (!user) {
+			if (create) {
+				this.user.checkPermission("core.user.create");
+				user = this._master.userManager.createUser(name);
+			} else {
+				throw new libErrors.RequestError(`User '${name}' does not exist`);
+			}
+		}
+
+		user.isAdmin = admin;
+		this._master.userUpdated(user);
+		this.broadcastEventToSlaves({ data: { name, admin }}, libLink.messages.adminlistUpdate);
+	}
+
+	async setUserBannedRequestHandler(message) {
+		let { name, create, banned, reason } = message.data;
+		let user = this._master.userManager.users.get(name);
+		if (!user) {
+			if (create) {
+				this.user.checkPermission("core.user.create");
+				user = this._master.userManager.createUser(name);
+			} else {
+				throw new libErrors.RequestError(`User '${name}' does not exist`);
+			}
+		}
+
+		user.isBanned = banned;
+		user.banReason = reason;
+		this._master.userUpdated(user);
+		this.broadcastEventToSlaves({ data: { name, banned, reason }}, libLink.messages.banlistUpdate);
+	}
+
+	async setUserWhitelistedRequestHandler(message) {
+		let { name, create, whitelisted } = message.data;
+		let user = this._master.userManager.users.get(name);
+		if (!user) {
+			if (create) {
+				this.user.checkPermission("core.user.create");
+				user = this._master.userManager.createUser(name);
+			} else {
+				throw new libErrors.RequestError(`User '${name}' does not exist`);
+			}
+		}
+
+		user.isWhitelisted = whitelisted;
+		this._master.userUpdated(user);
+		this.broadcastEventToSlaves({ data: { name, whitelisted }}, libLink.messages.whitelistUpdate);
+	}
+
+	async deleteUserRequestHandler(message) {
+		let user = this._master.userManager.users.get(message.data.name);
+		if (!user) {
+			throw new libErrors.RequestError(`User '${message.data.name}' does not exist`);
+		}
+
+		user.isDeleted = true;
+		this._master.userManager.users.delete(message.data.name);
+		this._master.userUpdated(user);
+
+		if (user.is_admin) {
+			this.broadcastEventToSlaves({ data: { name, admin: false }}, libLink.messages.adminlistUpdate);
+		}
+		if (user.is_whitelisted) {
+			this.broadcastEventToSlaves({ data: { name, whitelisted: false }}, libLink.messages.whitelistUpdate);
+		}
+		if (user.is_banned) {
+			this.broadcastEventToSlaves({ data: { name, banned: false, reason: "" }}, libLink.messages.banlistUpdate);
+		}
+	}
+
+	async debugDumpWsRequestHandler(message) {
+		this.ws_dumper = data => {
+			if (this.connector.connected) {
+				libLink.messages.debugWsMessage.send(this, data);
+			}
+		};
+		this.connector._socket.clusterio_ignore_dump = true;
+		this._master.debugEvents.on("message", this.ws_dumper);
+	}
+}
+
+module.exports = ControlConnection;

packages/master/src/HttpCloser.js

@@ -1,7 +1,6 @@
 "use strict";
 const http = require("http");
 const https = require("https");
-const util = require("util");
 
 /**
  * Gracefully close a Node.js HTTP(S) server

packages/master/src/Master.js

@@ -0,0 +1,706 @@
+"use strict";
+const compression = require("compression");
+const events = require("events");
+const express = require("express");
+const fs = require("fs-extra");
+const http = require("http");
+const https = require("https");
+const path = require("path");
+
+
+const libConfig = require("@clusterio/lib/config");
+const libErrors = require("@clusterio/lib/errors");
+const libFileOps = require("@clusterio/lib/file_ops");
+const libLink = require("@clusterio/lib/link");
+const libLoggingUtils = require("@clusterio/lib/logging_utils");
+const libPlugin = require("@clusterio/lib/plugin");
+const libPluginLoader = require("@clusterio/lib/plugin_loader");
+const libPrometheus = require("@clusterio/lib/prometheus");
+const { logger } = require("@clusterio/lib/logging");
+
+const HttpCloser = require("./HttpCloser");
+const metrics = require("./metrics");
+const routes = require("./routes");
+const UserManager = require("./UserManager");
+const WsServer = require("./WsServer");
+
+
+const hitCounter = new libPrometheus.Counter(
+	"clusterio_master_http_hits_total",
+	"How many HTTP requests in total have been received"
+);
+
+/**
+ * Manages all master related operations
+ * @alias module:master/src/Master
+ */
+class Master {
+	constructor(clusterLogger, pluginInfos, configPath, config) {
+		this.clusterLogger = clusterLogger;
+		/**
+		 * Mapping of plugin name to info objects for known plugins
+		 * @type {Map<string, Object>}
+		 */
+		this.pluginInfos = pluginInfos;
+		this.configPath = configPath;
+		/**
+		 * Master config.
+		 * @type {module:lib/config.MasterConfig}
+		 */
+		this.config = config;
+
+		this.app = express();
+		this.app.locals.master = this;
+		this.app.locals.streams = new Map();
+
+		/**
+		 * Mapping of slave id to slave info
+		 * @type {Map<number, Object>}
+		 */
+		this.slaves = null;
+
+		/**
+		 * Mapping of instance id to instance info
+		 * @type {Map<number, Object>}
+		 */
+		this.instances = null;
+
+		/**
+		 * User and roles manager for the cluster
+		 * @type {module:master/src/UserManager}
+		 */
+		this.userManager = null;
+		this.httpServer = null;
+		this.httpServerCloser = null;
+		this.httpsServer = null;
+		this.httpsServerCloser = null;
+
+		/**
+		 * Mapping of plugin name to loaded plugin
+		 * @type {Map<string, module:lib/plugin.BaseMasterPlugin>}
+		 */
+		this.plugins = new Map();
+
+		/**
+		 * WebSocket server
+		 * @type {module:master/src/WsServer}
+		 */
+		this.wsServer = new WsServer(this);
+
+		this.debugEvents = new events.EventEmitter();
+		this._events = new events.EventEmitter();
+		// Possible states are new, starting, running, stopping, stopped
+		this._state = "new";
+		this._shouldStop = false;
+
+		this.devMiddleware = null;
+	}
+
+	async start(args) {
+		if (this._state !== "new") {
+			throw new Error(`Cannot start in state ${this._state}`);
+		}
+
+		this._state = "starting";
+		try {
+			await this._startInternal(args);
+
+		} catch (err) {
+			await this._stopInternal();
+			this._state = "stopped";
+			this._events.emit("stop");
+			throw err;
+		}
+
+		if (this._shouldStop) {
+			this.stop();
+		}
+	}
+
+	async _startInternal(args) {
+		this.logDirectory = args.logDirectory;
+		this.clusterLogIndex = await libLoggingUtils.LogIndex.load(path.join(this.logDirectory, "cluster"));
+		this.clusterLogBuildInterval = setInterval(() => {
+			this.clusterLogIndex.buildIndex().catch(
+				err => logger.error(`Error building cluster log index:\n${err.stack}`)
+			);
+		}, 600e3);
+
+		// Start webpack development server if enabled
+		if (args.dev || args.devPlugin) {
+			logger.warn("Webpack development mode enabled");
+			/* eslint-disable node/global-require, node/no-unpublished-require */
+			const webpack = require("webpack");
+			const webpackDevMiddleware = require("webpack-dev-middleware");
+			const webpackConfigs = [];
+			if (args.dev) {
+				webpackConfigs.push(require("../webpack.config")({}));
+			}
+			if (args.devPlugin) {
+				let devPlugins = new Map();
+				for (let name of args.devPlugin) {
+					let info = this.pluginInfos.find(i => i.name === name);
+					if (!info) {
+						throw new libErrors.StartupError(`No plugin named ${name}`);
+					}
+					let config = require(path.posix.join(info.requirePath, "webpack.config"))({});
+					devPlugins.set(name, webpackConfigs.length);
+					webpackConfigs.push(config);
+				}
+				this.app.locals.devPlugins = devPlugins;
+			}
+			/* eslint-enable node/global-require, node/no-unpublished-require */
+
+			const compiler = webpack(webpackConfigs);
+			this.devMiddleware = webpackDevMiddleware(compiler, { serverSideRender: true });
+			this.app.use(this.devMiddleware);
+		}
+
+		let databaseDirectory = this.config.get("master.database_directory");
+		await fs.ensureDir(databaseDirectory);
+
+		this.slaves = await Master.loadSlaves(path.join(databaseDirectory, "slaves.json"));
+		this.instances = await Master.loadInstances(path.join(databaseDirectory, "instances.json"));
+		this.userManager = new UserManager(this.config);
+		await this.userManager.load(path.join(databaseDirectory, "users.json"));
+		this.exportManifest = await Master.loadJsonObject(path.join(databaseDirectory, "export_manifest.json"));
+
+		this.config.on("fieldChanged", (group, field, prev) => {
+			libPlugin.invokeHook(this.plugins, "onMasterConfigFieldChanged", group, field, prev);
+		});
+		for (let instance of this.instances.values()) {
+			this.addInstanceHooks(instance);
+		}
+
+		// Make sure we're actually going to listen on a port
+		let httpPort = this.config.get("master.http_port");
+		let httpsPort = this.config.get("master.https_port");
+		let bindAddress = this.config.get("master.bind_address") || "";
+		if (!httpPort && !httpsPort) {
+			logger.fatal("Error: at least one of http_port and https_port must be configured");
+			process.exitCode = 1;
+			return;
+		}
+
+		let tls_cert = this.config.get("master.tls_certificate");
+		let tls_key = this.config.get("master.tls_private_key");
+
+		if (httpsPort && (!tls_cert || !tls_key)) {
+			throw new libErrors.StartupError(
+				"tls_certificate and tls_private_key must be configure in order to use https_port"
+			);
+		}
+
+		Master.addAppRoutes(this.app, this.pluginInfos);
+
+		if (!args.dev) {
+			let manifest = await Master.loadJsonObject(path.join(__dirname, "..", "dist", "web", "manifest.json"));
+			if (!manifest["main.js"]) {
+				logger.error("Missing main.js entry in dist/web/manifest.json");
+			}
+			this.app.locals.mainBundle = manifest["main.js"] || "no_web_build";
+		}
+
+		// Load plugins
+		await this.loadPlugins();
+
+		this.wsServer = new WsServer(this);
+
+		// Only start listening for connections after all plugins have loaded
+		if (httpPort) {
+			this.httpServer = http.createServer(this.app);
+			this.httpServerCloser = new HttpCloser(this.httpServer);
+			await this.listen(this.httpServer, httpPort, bindAddress);
+			logger.info(`Listening for HTTP on port ${this.httpServer.address().port}`);
+		}
+
+		if (httpsPort) {
+			let certificate, privateKey;
+			try {
+				certificate = await fs.readFile(tls_cert);
+				privateKey = await fs.readFile(tls_key);
+
+			} catch (err) {
+				throw new libErrors.StartupError(
+					`Error loading ssl certificate: ${err.message}`
+				);
+			}
+
+			this.httpsServer = https.createServer({
+				key: privateKey,
+				cert: certificate,
+			}, this.app);
+			this.httpsServerCloser = new HttpCloser(this.httpsServer);
+			await this.listen(this.httpsServer, httpsPort, bindAddress);
+			logger.info(`Listening for HTTPS on port ${this.httpsServer.address().port}`);
+		}
+
+		logger.info("Started master");
+		this._state = "running";
+	}
+
+	/**
+	 * Stops the master server.
+	 *
+	 * Save data and bring down the active connections.  This is the reverse
+	 * of start and is valid at any point in time.
+	 */
+	async stop() {
+		if (this._state === "starting") {
+			this._shouldStop = true;
+			await events.once(this._events, "stop");
+			return;
+
+		} else if (this._state === "running") {
+			await this._stopInternal();
+		}
+
+		this._state = "stopped";
+		this._events.emit("stop");
+	}
+
+	async _stopInternal() {
+		// This function should never throw.
+		this._state = "stopping";
+		logger.info("Stopping master");
+		clearInterval(this.clusterLogBuildInterval);
+		if (this.clusterLogIndex) {
+			await this.clusterLogIndex.save();
+		}
+
+		logger.info("Saving config");
+		await libFileOps.safeOutputFile(this.configPath, JSON.stringify(this.config.serialize(), null, 4));
+
+		if (this.devMiddleware) {
+			await new Promise((resolve, reject) => { this.devMiddleware.close(resolve); });
+		}
+
+		let databaseDirectory = this.config.get("master.database_directory");
+		if (this.slaves) {
+			await Master.saveSlaves(path.join(databaseDirectory, "slaves.json"), this.slaves);
+		}
+
+		if (this.instances) {
+			await Master.saveInstances(path.join(databaseDirectory, "instances.json"), this.instances);
+		}
+
+		if (this.userManager) {
+			await this.userManager.save(path.join(databaseDirectory, "users.json"));
+		}
+
+		await libPlugin.invokeHook(this.plugins, "onShutdown");
+
+		if (this.wsServer) {
+			await this.wsServer.stop();
+		}
+
+		let stopTasks = [];
+		logger.info("Stopping HTTP(S) server");
+		if (this.httpServer && this.httpServer.listening) { stopTasks.push(this.httpServerCloser.close()); }
+		if (this.httpsServer && this.httpsServer.listening) { stopTasks.push(this.httpsServerCloser.close()); }
+		await Promise.all(stopTasks);
+
+		logger.info("Goodbye");
+	}
+
+	static async loadSlaves(filePath) {
+		let serialized;
+		try {
+			serialized = JSON.parse(await fs.readFile(filePath));
+
+		} catch (err) {
+			if (err.code !== "ENOENT") {
+				throw err;
+			}
+
+			return new Map();
+		}
+
+		// TODO: Remove after release.
+		if (serialized.length && !(serialized[0] instanceof Array)) {
+			return new Map(); // Discard old format.
+		}
+
+		return new Map(serialized);
+	}
+
+	static async saveSlaves(filePath, slaves) {
+		await libFileOps.safeOutputFile(filePath, JSON.stringify([...slaves.entries()], null, 4));
+	}
+
+	static async loadInstances(filePath) {
+		logger.info(`Loading ${filePath}`);
+
+		let instances = new Map();
+		try {
+			let serialized = JSON.parse(await fs.readFile(filePath));
+			for (let serializedConfig of serialized) {
+				let instanceConfig = new libConfig.InstanceConfig("master");
+				await instanceConfig.load(serializedConfig);
+				let status = instanceConfig.get("instance.assigned_slave") === null ? "unassigned" : "unknown";
+				let instance = { config: instanceConfig, status };
+				instances.set(instanceConfig.get("instance.id"), instance);
+			}
+
+		} catch (err) {
+			if (err.code !== "ENOENT") {
+				throw err;
+			}
+		}
+
+		return instances;
+	}
+
+	static async saveInstances(filePath, instances) {
+		let serialized = [];
+		for (let instance of instances.values()) {
+			serialized.push(instance.config.serialize());
+		}
+
+		await libFileOps.safeOutputFile(filePath, JSON.stringify(serialized, null, 4));
+	}
+
+	static async loadJsonObject(filePath, throwOnMissing = false) {
+		let manifest = {};
+		try {
+			manifest = JSON.parse(await fs.readFile(filePath));
+		} catch (err) {
+			if (!throwOnMissing && err.code !== "ENOENT") {
+				throw err;
+			}
+		}
+		return manifest;
+	}
+
+	async updateExportManifest(newManifest) {
+		let databaseDirectory = this.config.get("master.database_directory");
+		await libFileOps.safeOutputFile(
+			path.join(databaseDirectory, "export_manifest.json"), JSON.stringify(newManifest, null, 4)
+		);
+		this.exportManifest = newManifest;
+	}
+
+	/**
+	 * Query master log
+	 *
+	 * @param {module:lib/logging_utils~QueryLogFilter} filter -
+	 *     Filter to limit entries with. Note that only the master log can
+	 *     be queried from this function.
+	 * @returns {Array<Object>} log entries matching the filter
+	 */
+	async queryMasterLog(filter) {
+		return await libLoggingUtils.queryLog(
+			path.join(this.logDirectory, "master"), filter,
+		);
+	}
+
+	/**
+	 * Query cluster log
+	 *
+	 * @param {module:lib/logging_utils~QueryLogFilter} filter -
+	 *     Filter to limit entries with.
+	 * @returns {Array<Object>} log entries matching the filter
+	 */
+	async queryClusterLog(filter) {
+		return await libLoggingUtils.queryLog(
+			path.join(this.logDirectory, "cluster"), filter, this.clusterLogIndex,
+		);
+	}
+
+	static addAppRoutes(app, pluginInfos) {
+		app.use((req, res, next) => {
+			hitCounter.inc();
+			next();
+		});
+		app.use(compression());
+
+		// Set folder to serve static content from (the website)
+		const staticOptions = { immutable: true, maxAge: 1000 * 86400 * 365 };
+		app.use("/static", express.static(path.join(__dirname, "..", "dist", "web", "static"), staticOptions));
+		app.use("/static", express.static("static", staticOptions)); // Used for data export files
+
+		// Add API routes
+		routes.addRouteHandlers(app);
+
+		// Add routes for the web interface
+		for (let route of routes.webRoutes) {
+			app.get(route, Master.serveWeb(route));
+		}
+		for (let pluginInfo of pluginInfos) {
+			for (let route of pluginInfo.routes || []) {
+				app.get(route, Master.serveWeb(route));
+			}
+
+			let pluginPackagePath = require.resolve(path.posix.join(pluginInfo.requirePath, "package.json"));
+			let webPath = path.join(path.dirname(pluginPackagePath), "dist", "web", "static");
+			app.use("/static", express.static(webPath, staticOptions));
+		}
+	}
+
+	slaveUpdated(slave) {
+		let update = {
+			agent: slave.agent,
+			version: slave.version,
+			id: slave.id,
+			name: slave.name,
+			public_address: slave.public_address || null,
+			connected: this.wsServer.slaveConnections.has(slave.id),
+		};
+
+		for (let controlConnection of this.wsServer.controlConnections) {
+			if (controlConnection.connector.closing) {
+				continue;
+			}
+
+			controlConnection.slaveUpdated(slave, update);
+		}
+	}
+
+	/**
+	 * Get instance by ID for a request
+	 *
+	 * @param {number} instanceId - ID of instance to get.
+	 * @returns {object} instance
+	 * @throws {module:lib/errors.RequestError} if the instance does not exist.
+	 */
+	getRequestInstance(instanceId) {
+		let instance = this.instances.get(instanceId);
+		if (!instance) {
+			throw new libErrors.RequestError(`Instance with ID ${instanceId} does not exist`);
+		}
+		return instance;
+	}
+
+	addInstanceHooks(instance) {
+		instance.config.on("fieldChanged", (group, field, prev) => {
+			if (group.name === "instance" && field === "name") {
+				this.instanceUpdated(instance);
+			}
+
+			libPlugin.invokeHook(this.plugins, "onInstanceConfigFieldChanged", instance, group, field, prev);
+		});
+
+		this.instanceUpdated(instance);
+	}
+
+	instanceUpdated(instance) {
+		for (let controlConnection of this.wsServer.controlConnections) {
+			if (controlConnection.connector.closing) {
+				continue;
+			}
+
+			controlConnection.instanceUpdated(instance);
+		}
+	}
+
+	saveListUpdate(data) {
+		for (let controlConnection of this.wsServer.controlConnections) {
+			if (controlConnection.connector.closing) {
+				continue;
+			}
+
+			controlConnection.saveListUpdate(data);
+		}
+	}
+
+	userUpdated(user) {
+		for (let controlConnection of this.wsServer.controlConnections) {
+			if (controlConnection.connector.closing) {
+				continue;
+			}
+
+			controlConnection.userUpdated(user);
+		}
+	}
+
+	/**
+	 * Notify connected control clients under the given user that the
+	 * permissions for this user may have changed.
+	 * @param {module:lib/users.User} user - User permisions updated for.
+	 */
+	userPermissionsUpdated(user) {
+		for (let controlConnection of this.wsServer.controlConnections) {
+			if (controlConnection.user === user) {
+				libLink.messages.accountUpdate.send(controlConnection, {
+					"roles": [...user.roles].map(r => ({
+						name: r.name,
+						id: r.id,
+						permissions: [...r.permissions],
+					})),
+				});
+			}
+		}
+	}
+
+	/**
+	 * Notify connected control clients with the given role that the
+	 * permissions may have changed.
+	 * @param {module:lib/users.Role} role - Role permisions updated for.
+	 */
+	rolePermissionsUpdated(role) {
+		for (let controlConnection of this.wsServer.controlConnections) {
+			if (controlConnection.user.roles.has(role)) {
+				libLink.messages.accountUpdate.send(controlConnection, {
+					"roles": [...controlConnection.user.roles].map(r => ({
+						name: r.name,
+						id: r.id,
+						permissions: [...r.permissions],
+					})),
+				});
+			}
+		}
+	}
+
+	async loadPlugins() {
+		for (let pluginInfo of this.pluginInfos) {
+			try {
+				let manifestPath = path.posix.join(pluginInfo.requirePath, "dist", "web", "manifest.json");
+				pluginInfo.manifest = await Master.loadJsonObject(require.resolve(manifestPath), true);
+			} catch (err) {
+				logger.warn(`Unable to load dist/web/manifest.json for plugin ${pluginInfo.name}`);
+			}
+
+			if (!this.config.group(pluginInfo.name).get("load_plugin")) {
+				continue;
+			}
+
+			let MasterPluginClass = libPlugin.BaseMasterPlugin;
+			try {
+				if (pluginInfo.masterEntrypoint) {
+					MasterPluginClass = await libPluginLoader.loadMasterPluginClass(pluginInfo);
+				}
+
+				let masterPlugin = new MasterPluginClass(pluginInfo, this, metrics, logger);
+				await masterPlugin.init();
+				this.plugins.set(pluginInfo.name, masterPlugin);
+
+			} catch (err) {
+				throw new libErrors.PluginError(pluginInfo.name, err);
+			}
+
+			logger.info(`Loaded plugin ${pluginInfo.name}`);
+		}
+	}
+
+	/**
+	 * Calls listen on server capturing any errors that occurs
+	 * binding to the port.  Also adds handler for WebSocket
+	 * upgrade event.
+	 *
+	 * @param {module:net.Server} server - Server to start the listening on.
+	 * @param {*} args - Arguments to the .listen() call on the server.
+	 * @returns {Promise} promise that resolves the server is listening.
+	 */
+	listen(server, ...args) {
+		return new Promise((resolve, reject) => {
+			server.on("upgrade", (req, socket, head) => {
+				logger.verbose("handling WebSocket upgrade");
+				this.wsServer.handleUpgrade(req, socket, head);
+			});
+
+			function wrapError(err) {
+				reject(new libErrors.StartupError(
+					`Server listening failed: ${err.message}`
+				));
+			}
+
+			server.once("error", wrapError);
+			server.listen(...args, () => {
+				server.off("error", wrapError);
+				resolve();
+			});
+		});
+	}
+
+
+	/**
+	 * Returns the URL needed to connect to the master server.
+	 *
+	 * @returns {string} master URL.
+	 */
+	getMasterUrl() {
+		return Master.calculateMasterUrl(this.config);
+	}
+
+	static calculateMasterUrl(config) {
+		let url = config.get("master.external_address");
+		if (!url) {
+			if (config.get("master.https_port")) {
+				url = `https://localhost:${config.get("master.https_port")}/`;
+			} else {
+				url = `http://localhost:${config.get("master.http_port")}/`;
+			}
+		}
+		return url;
+	}
+
+	/**
+	 * Servers the web interface with the root path set apropriately
+	 *
+	 * @param {string} route - route the interface is served under.
+	 * @returns {function} Experess.js route handler.
+	 */
+	static serveWeb(route) {
+		// The depth is is the number of slashes in the route minus one, but due
+		// to lenient matching on trailing slashes in the route we need to
+		// compensate if the request path contains a slash but not the route,
+		// and vice versa.
+		let routeDepth = (route.match(/\//g) || []).length - 1 - (route.slice(-1) === "/");
+		return function(req, res, next) {
+			let depth = routeDepth + (req.path.slice(-1) === "/");
+			let webRoot = "../".repeat(depth) || "./";
+			let staticRoot = webRoot;
+			let mainBundle;
+			if (res.app.locals.mainBundle) {
+				mainBundle = res.app.locals.mainBundle;
+			} else {
+				let stats = res.locals.webpack.devMiddleware.stats.stats[0];
+				mainBundle = stats.toJson().assetsByChunkName["main"];
+			}
+			fs.readFile(path.join(__dirname, "..", "web", "index.html"), "utf8").then((content) => {
+				res.type("text/html");
+				res.send(content
+					.replace(/__CLUSTER_NAME__/g, res.app.locals.master.config.get("master.name"))
+					.replace(/__WEB_ROOT__/g, webRoot)
+					.replace(/__STATIC_ROOT__/g, staticRoot)
+					.replace(/__MAIN_BUNDLE__/g, mainBundle)
+				);
+			}).catch(err => {
+				next(err);
+			});
+		};
+	}
+
+	/**
+	 * Forward the given request to the slave contaning the instance
+	 *
+	 * Finds the slave which the instance with the given instance ID is
+	 * currently assigned to and forwards the request to that instance.
+	 * The request data must have an instance_id parameter.
+	 *
+	 * @param {module:lib/link.Request} request - The request to send.
+	 * @param {object} data - Data to pass with the request.
+	 * @param {number} data.instance_id -
+	 *     ID of instance to send this request towards
+	 * @returns {object} data returned from the request.
+	 */
+	async forwardRequestToInstance(request, data) {
+		let instance = this.getRequestInstance(data.instance_id);
+		let slaveId = instance.config.get("instance.assigned_slave");
+		if (slaveId === null) {
+			throw new libErrors.RequestError("Instance is not assigned to a slave");
+		}
+
+		let connection = this.wsServer.slaveConnections.get(slaveId);
+		if (!connection) {
+			throw new libErrors.RequestError("Slave containing instance is not connected");
+		}
+		if (request.plugin && !connection.plugins.has(request.plugin)) {
+			throw new libErrors.RequestError(`Slave containing instance does not have ${request.plugin} plugin`);
+		}
+
+		return await request.send(connection, data);
+	}
+}
+
+module.exports = Master;

packages/master/src/SlaveConnection.js

@@ -0,0 +1,200 @@
+"use strict";
+const libConfig = require("@clusterio/lib/config");
+const libLink = require("@clusterio/lib/link");
+const { logger } = require("@clusterio/lib/logging");
+const libPlugin = require("@clusterio/lib/plugin");
+const PlayerStats = require("@clusterio/lib/PlayerStats");
+
+const BaseConnection = require("./BaseConnection");
+
+
+/**
+ * Represents the connection to a slave
+ *
+ * @extends module:master/src/BaseConnection
+ * @alias module:master/src/SlaveConnection
+ */
+class SlaveConnection extends BaseConnection {
+	constructor(registerData, connector, master) {
+		super("slave", connector, master);
+
+		this._agent = registerData.agent;
+		this._id = registerData.id;
+		this._name = registerData.name;
+		this._version = registerData.version;
+		this.plugins = new Map(Object.entries(registerData.plugins));
+
+		this._master.slaves.set(this._id, {
+			agent: this._agent,
+			id: this._id,
+			name: this._name,
+			version: this._version,
+			public_address: registerData.public_address,
+			plugins: registerData.plugins,
+		});
+
+		for (let event of ["connect", "drop", "resume", "close"]) {
+			// eslint-disable-next-line no-loop-func
+			this.connector.on(event, () => {
+				for (let plugin of this._master.plugins.values()) {
+					plugin.onSlaveConnectionEvent(this, event);
+				}
+			});
+		}
+
+		this.connector.on("close", () => {
+			// Update status to unknown for instances on this slave.
+			for (let instance of this._master.instances.values()) {
+				if (instance.config.get("instance.assigned_slave") !== this._id) {
+					continue;
+				}
+
+				let prev = instance.status;
+				instance.status = "unknown";
+				this._master.instanceUpdated(instance);
+				libPlugin.invokeHook(this._master.plugins, "onInstanceStatusChanged", instance, prev);
+			}
+		});
+	}
+
+	/**
+	 * ID of the slave this connection is connected to
+	 *
+	 * @returns {number} slave ID.
+	 */
+	get id() {
+		return this._id;
+	}
+
+	async instanceStatusChangedEventHandler(message, event) {
+		let instance = this._master.instances.get(message.data.instance_id);
+
+		// It's possible to get updates from an instance that does not exist
+		// or is not assigned to the slave it originated from if it was
+		// reassigned or deleted while the connection to the slave it was
+		// originally on was down at the time.
+		if (!instance || instance.config.get("instance.assigned_slave") !== this._id) {
+			logger.warn(`Got bogus update for instance id ${message.data.instance_id}`);
+			return;
+		}
+
+		// We may receive status changed where the status hasn't changed
+		// from our perspective if the connection was down at the time it
+		// changed.  Slaves also send status updates on assignInstance which
+		// for hacky reason is also used to push config changes and
+		// restablish status after a connection loss.
+		if (instance.status === message.data.status) {
+			return;
+		}
+
+		let prev = instance.status;
+		instance.status = message.data.status;
+		instance.game_port = message.data.game_port;
+		logger.verbose(`Instance ${instance.config.get("instance.name")} State: ${instance.status}`);
+		this._master.instanceUpdated(instance);
+		await libPlugin.invokeHook(this._master.plugins, "onInstanceStatusChanged", instance, prev);
+	}
+
+	async updateInstancesRequestHandler(message) {
+		// Push updated instance configs
+		for (let instance of this._master.instances.values()) {
+			if (instance.config.get("instance.assigned_slave") === this._id) {
+				await libLink.messages.assignInstance.send(this, {
+					instance_id: instance.config.get("instance.id"),
+					serialized_config: instance.config.serialize("slave"),
+				});
+			}
+		}
+
+		// Assign instances the slave has but master does not
+		for (let instanceData of message.data.instances) {
+			let instanceConfig = new libConfig.InstanceConfig("master");
+			await instanceConfig.load(instanceData.serialized_config, "slave");
+
+			let masterInstance = this._master.instances.get(instanceConfig.get("instance.id"));
+			if (masterInstance) {
+				// Check if this instance is assigned somewhere else.
+				if (masterInstance.config.get("instance.assigned_slave") !== this._id) {
+					await libLink.messages.unassignInstance.send(this, {
+						instance_id: masterInstance.config.get("instance.id"),
+					});
+					continue;
+				}
+
+				// Already have this instance, update state instead
+				if (masterInstance.status !== instanceData.status) {
+					let prev = masterInstance.status;
+					masterInstance.status = instanceData.status;
+					logger.verbose(`Instance ${instanceConfig.get("instance.name")} State: ${instanceData.status}`);
+					this._master.instanceUpdated(instance);
+					await libPlugin.invokeHook(this._master.plugins, "onInstanceStatusChanged", masterInstance, prev);
+				}
+				continue;
+			}
+
+			instanceConfig.set("instance.assigned_slave", this._id);
+			let newInstance = { config: instanceConfig, status: instanceData.status };
+			this._master.instances.set(instanceConfig.get("instance.id"), newInstance);
+			this._master.addInstanceHooks(newInstance);
+			await libLink.messages.assignInstance.send(this, {
+				instance_id: instanceConfig.get("instance.id"),
+				serialized_config: instanceConfig.serialize("slave"),
+			});
+			await libPlugin.invokeHook(this._master.plugins, "onInstanceStatusChanged", newInstance, null);
+		}
+
+		// Push lists to make sure they are in sync.
+		let adminlist = [];
+		let banlist = [];
+		let whitelist = [];
+
+		for (let user of this._master.userManager.users.values()) {
+			if (user.isAdmin) {
+				adminlist.push(user.name);
+			}
+			if (user.isBanned) {
+				banlist.push([user.name, user.banReason]);
+			}
+			if (user.isWhitelisted) {
+				whitelist.push(user.name);
+			}
+		}
+
+		libLink.messages.syncUserLists.send(this, { adminlist, banlist, whitelist });
+	}
+
+	async saveListUpdateEventHandler(message) {
+		this._master.saveListUpdate(message.data);
+	}
+
+	async logMessageEventHandler(message) {
+		this._master.clusterLogger.log({
+			...message.data.info,
+			slave_id: this._id,
+			slave_name: this._name,
+		});
+	}
+
+	async playerEventEventHandler(message) {
+		let { instance_id, name, type, stats } = message.data;
+		let user = this._master.userManager.users.get(name);
+		if (!user) {
+			user = this._master.userManager.createUser(name);
+		}
+
+		if (type === "join") {
+			user.notifyJoin(instance_id);
+		} else if (type === "leave") {
+			user.notifyLeave(instance_id);
+		}
+		user.instanceStats.set(instance_id, new PlayerStats(stats));
+		user.recalculatePlayerStats();
+		this._master.userUpdated(user);
+
+		delete message.data.stats;
+		let instance = this._master.instances.get(instance_id);
+		await libPlugin.invokeHook(this._master.plugins, "onPlayerEvent", instance, message.data);
+	}
+}
+
+module.exports = SlaveConnection;

packages/master/src/UserManager.js

@@ -0,0 +1,89 @@
+"use strict";
+const fs = require("fs-extra");
+
+const libFileOps = require("@clusterio/lib/file_ops");
+const libUsers = require("@clusterio/lib/users");
+
+/**
+ * Manages users and roles
+ * @alias module:master/src/UserManager
+ */
+class UserManager {
+	constructor(config) {
+		this._config = config;
+		this.roles = null;
+		this.users = null;
+	}
+
+	async load(filePath) {
+		let loadedRoles = new Map();
+		let loadedUsers = new Map();
+		try {
+			let content = JSON.parse(await fs.readFile(filePath));
+			for (let serializedRole of content.roles) {
+				let role = new libUsers.Role(serializedRole);
+				loadedRoles.set(role.id, role);
+			}
+
+			for (let serializedUser of content.users) {
+				let user = new libUsers.User(serializedUser, loadedRoles);
+				loadedUsers.set(user.name, user);
+			}
+
+		} catch (err) {
+			if (err.code !== "ENOENT") {
+				throw err;
+			}
+
+			// Create default roles if loading failed
+			libUsers.ensureDefaultAdminRole(loadedRoles);
+			libUsers.ensureDefaultPlayerRole(loadedRoles);
+		}
+
+		this.roles = loadedRoles;
+		this.users = loadedUsers;
+	}
+
+	async save(filePath) {
+		if (!this.roles || !this.users) {
+			return;
+		}
+
+		let serializedRoles = [];
+		for (let role of this.roles.values()) {
+			serializedRoles.push(role.serialize());
+		}
+
+		let serializedUsers = [];
+		for (let user of this.users.values()) {
+			serializedUsers.push(user.serialize());
+		}
+
+		let serialized = {
+			users: serializedUsers,
+			roles: serializedRoles,
+		};
+		await libFileOps.safeOutputFile(filePath, JSON.stringify(serialized, null, 4));
+	}
+
+	/**
+	 * Create a new user
+	 *
+	 * Creates a new user and add it to the user database.
+	 *
+	 * @param {string} name - Name of the user to create.
+	 * @returns {module:lib/users.User} newly created user.
+	 */
+	createUser(name) {
+		if (this.users.has(name)) {
+			throw new Error(`User '${name}' already exists`);
+		}
+
+		let defaultRoleId = this._config.get("master.default_role_id");
+		let user = new libUsers.User({ name, roles: [defaultRoleId] }, this.roles);
+		this.users.set(name, user);
+		return user;
+	}
+}
+
+module.exports = UserManager;

packages/master/src/WsServer.js

@@ -0,0 +1,313 @@
+"use strict";
+const jwt = require("jsonwebtoken");
+const WebSocket = require("ws");
+
+const libErrors = require("@clusterio/lib/errors");
+const { logger } = require("@clusterio/lib/logging");
+const libPrometheus = require("@clusterio/lib/prometheus");
+const libSchema = require("@clusterio/lib/schema");
+
+const ControlConnection = require("./ControlConnection");
+const packageVersion = require("../package").version;
+const SlaveConnection = require("./SlaveConnection");
+const WsServerConnector = require("./WsServerConnector");
+
+
+const wsMessageCounter = new libPrometheus.Counter(
+	"clusterio_master_websocket_message_total",
+	"How many messages have been received over WebSocket on the master server",
+	{ labels: ["direction"] }
+);
+
+const wsConnectionsCounter = new libPrometheus.Counter(
+	"clusterio_master_websocket_connections_total",
+	"How many WebSocket connections have been initiated on the master server"
+);
+
+const wsRejectedConnectionsCounter = new libPrometheus.Counter(
+	"clusterio_master_websocket_rejected_connections_total",
+	"How many WebSocket connections have been rejected during the handshake on the master server"
+);
+
+/**
+ * WebSocket server
+ * @alias module:master/src/WsServer
+ */
+class WsServer {
+	constructor(master) {
+		this.master = master;
+
+		this.stopAcceptingNewSessions = false;
+
+		/** @type {Array<module:master/src/ControlConnection>} */
+		this.controlConnections = [];
+		/** @type {Map<number, module:master/src/SlaveConnection>} */
+		this.slaveConnections = new Map();
+		/** @type {Map<number, module:master/src/WsServerConnector>} */
+		this.activeConnectors = new Map();
+		/** @type {Set<module:ws>} */
+		this.pendingSockets = new Set();
+
+		// Unique string for the session token audience
+		this.sessionAud = `session-${Date.now()}`;
+		this.nextSessionId = 1;
+
+		/** @type {module:ws.Server} */
+		this.wss = new WebSocket.Server({
+			noServer: true,
+			path: "/api/socket",
+		});
+		this.wss.on("connection", (socket, req) => this.handleConnection(socket, req));
+	}
+
+	async stop() {
+		this.stopAcceptingNewSessions = true;
+
+		let disconnectTasks = [];
+		for (let controlConnection of this.controlConnections) {
+			disconnectTasks.push(controlConnection.disconnect(1001, "Server Quit"));
+		}
+
+		for (let slaveConnection of this.slaveConnections.values()) {
+			disconnectTasks.push(slaveConnection.disconnect(1001, "Server Quit"));
+		}
+
+		logger.info(`WsServer | Waiting for ${disconnectTasks.length} connectors to close`);
+		for (let task of disconnectTasks) {
+			try {
+				await task;
+			} catch (err) {
+				if (!(err instanceof libErrors.SessionLost)) {
+					logger.warn(`Unexpected error disconnecting connector:\n${err.stack}`);
+				}
+			}
+		}
+
+		for (let socket of this.pendingSockets) {
+			socket.close(1001, "Server Quit");
+		}
+	}
+
+	handleUpgrade(req, socket, head) {
+		// For reasons that defy common sense, the connection event has
+		// to be emitted explictly when using noServer.
+		this.wss.handleUpgrade(req, socket, head, (ws) => {
+			this.wss.emit("connection", ws, req);
+		});
+	}
+
+	handleConnection(socket, req) {
+		logger.verbose(`WsServer | new connection from ${req.socket.remoteAddress}`);
+
+		// Track statistics
+		wsConnectionsCounter.inc();
+		socket.on("message", (message) => {
+			wsMessageCounter.labels("in").inc();
+			if (!socket.clusterio_ignore_dump) {
+				this.master.debugEvents.emit("message", { direction: "in", content: message });
+			}
+		});
+		let originalSend = socket.send;
+		socket.send = (...args) => {
+			wsMessageCounter.labels("out").inc();
+			if (typeof args[0] === "string" && !socket.clusterio_ignore_dump) {
+				this.master.debugEvents.emit("message", { direction: "out", content: args[0] });
+			}
+			return originalSend.call(socket, ...args);
+		};
+
+		// Start connection handshake.
+		let loadedPlugins = {};
+		for (let [name, plugin] of this.master.plugins) {
+			loadedPlugins[name] = plugin.info.version;
+		}
+
+		socket.send(JSON.stringify({ seq: null, type: "hello", data: {
+			version: packageVersion,
+			plugins: loadedPlugins,
+		}}));
+
+		this.attachHandler(socket, req);
+	}
+
+	attachHandler(socket, req) {
+		this.pendingSockets.add(socket);
+
+		let timeoutId = setTimeout(() => {
+			logger.verbose(`WsServer | closing ${req.socket.remoteAddress} after timing out on handshake`);
+			wsRejectedConnectionsCounter.inc();
+			socket.terminate();
+			this.pendingSockets.delete(socket);
+		}, 30*1000);
+
+		socket.once("message", (message) => {
+			clearTimeout(timeoutId);
+			this.pendingSockets.delete(socket);
+			this.handleHandshake(
+				message, socket, req
+			).catch(err => {
+				logger.error(`
++------------------------------------------------------------+
+| Unexpected error occured in WebSocket handshake, please    |
+| report it to https://github.com/clusterio/clusterio/issues |
++------------------------------------------------------------+
+${err.stack}`
+				);
+				wsRejectedConnectionsCounter.inc();
+				socket.close(1011, "Unexpected error");
+			});
+		});
+	}
+
+	async handleHandshake(message, socket, req) {
+		try {
+			message = JSON.parse(message);
+		} catch (err) {
+			logger.verbose(`WsServer | closing ${req.socket.remoteAddress} after receiving invalid JSON`);
+			wsRejectedConnectionsCounter.inc();
+			socket.close(1002, "Invalid JSON");
+			return;
+		}
+
+		if (!libSchema.clientHandshake(message)) {
+			logger.verbose(`WsServer | closing ${req.socket.remoteAddress} after receiving invalid handshake`);
+			wsRejectedConnectionsCounter.inc();
+			socket.close(1002, "Bad handshake");
+			return;
+		}
+
+		let { type, data } = message;
+
+		if (type === "resume") {
+			let connector;
+			try {
+				let payload = jwt.verify(
+					data.session_token,
+					Buffer.from(this.master.config.get("master.auth_secret"), "base64"),
+					{ audience: this.sessionAud }
+				);
+
+				connector = this.activeConnectors.get(payload.sid);
+				if (!connector) {
+					throw new Error();
+				}
+
+			} catch (err) {
+				socket.send(JSON.stringify({ seq: null, type: "invalidate", data: {}}));
+				this.attachHandler(socket, req);
+				return;
+			}
+
+			connector.continue(socket, data.last_seq);
+			return;
+		}
+
+		if (this.stopAcceptingNewSessions) {
+			logger.verbose(`WsServer | closing ${req.socket.remoteAddress}, server is shutting down`);
+			wsRejectedConnectionsCounter.inc();
+			socket.close(1001, "Shutting down");
+			return;
+		}
+
+		// Validate token
+		let user;
+		try {
+			if (type === "register_slave") {
+				let tokenPayload = jwt.verify(
+					data.token,
+					Buffer.from(this.master.config.get("master.auth_secret"), "base64"),
+					{ audience: "slave" }
+				);
+
+				if (tokenPayload.slave !== data.id) {
+					throw new Error("missmatched slave id");
+				}
+
+			} else if (type === "register_control") {
+				let tokenPayload = jwt.verify(
+					data.token,
+					Buffer.from(this.master.config.get("master.auth_secret"), "base64"),
+					{ audience: "user" }
+				);
+
+				user = this.master.userManager.users.get(tokenPayload.user);
+				if (!user) {
+					throw new Error("invalid user");
+				}
+				if (tokenPayload.iat < user.tokenValidAfter) {
+					throw new Error("invalid token");
+				}
+				user.checkPermission("core.control.connect");
+			}
+
+		} catch (err) {
+			logger.verbose(`WsServer | authentication failed for ${req.socket.remoteAddress}`);
+			wsRejectedConnectionsCounter.inc();
+			socket.close(4003, `Authentication failed: ${err.message}`);
+			return;
+		}
+
+		let sessionId = this.nextSessionId;
+		this.nextSessionId += 1;
+		let sessionToken = jwt.sign(
+			{ aud: this.sessionAud, sid: sessionId },
+			Buffer.from(this.master.config.get("master.auth_secret"), "base64"),
+		);
+		let sessionTimeout = this.master.config.get("master.session_timeout");
+		let heartbeatInterval = this.master.config.get("master.heartbeat_interval");
+		let connector = new WsServerConnector(sessionId, sessionTimeout, heartbeatInterval);
+		this.activeConnectors.set(sessionId, connector);
+		connector.on("close", () => {
+			this.activeConnectors.delete(sessionId);
+		});
+
+		let additionalReadyData = {};
+		if (type === "register_slave") {
+			let connection = this.slaveConnections.get(data.id);
+			if (connection) {
+				logger.verbose(`WsServer | disconnecting existing connection for slave ${data.id}`);
+				await connection.disconnect(1008, "Registered from another connection");
+			}
+
+			logger.verbose(`WsServer | registered slave ${data.id} version ${data.version}`);
+			connection = new SlaveConnection(data, connector, this.master);
+			connector.on("close", () => {
+				if (this.slaveConnections.get(data.id) === connection) {
+					this.slaveConnections.delete(data.id);
+					this.master.slaveUpdated(this.master.slaves.get(data.id));
+				} else {
+					logger.warn("Unlisted SlaveConnection closed");
+				}
+			});
+			this.slaveConnections.set(data.id, connection);
+			this.master.slaveUpdated(this.master.slaves.get(data.id));
+
+
+		} else if (type === "register_control") {
+			logger.verbose(`WsServer | registered control from ${req.socket.remoteAddress}`);
+			let connection = new ControlConnection(data, connector, this.master, user);
+			connector.on("close", () => {
+				let index = this.controlConnections.indexOf(connection);
+				if (index !== -1) {
+					this.controlConnections.splice(index, 1);
+				} else {
+					logger.warn("Unlisted ControlConnection closed");
+				}
+			});
+			this.controlConnections.push(connection);
+			additionalReadyData["account"] = {
+				name: user.name,
+				roles: [...user.roles].map(r => ({
+					name: r.name,
+					id: r.id,
+					permissions: [...r.permissions],
+				})),
+			};
+		}
+
+		connector.ready(socket, sessionToken, additionalReadyData);
+	}
+
+}
+
+module.exports = WsServer;

packages/master/src/WsServerConnector.js

@@ -0,0 +1,213 @@
+"use strict";
+const events = require("events");
+
+const libLink = require("@clusterio/lib/link");
+const { logger } = require("@clusterio/lib/logging");
+
+
+/**
+ * Connector for master server connections
+ *
+ * @extends module:lib/link.WebSocketBaseConnector
+ * @alias module:master/src/WsServerConnector
+ */
+class WsServerConnector extends libLink.WebSocketBaseConnector {
+	constructor(sessionId, sessionTimeout, heartbeatInterval) {
+		super(sessionTimeout);
+
+		this._socket = null;
+		this._sessionId = sessionId;
+		this._heartbeatInterval = heartbeatInterval;
+		this._timeoutId = null;
+
+		// The following states are used in the server connector
+		// closed: Connection is closed
+		// connected: Connection is online
+		// resuming: Waiting for client to resume.
+	}
+
+	_reset() {
+		clearTimeout(this._timeoutId);
+		this._timeoutId = null;
+		super._reset();
+	}
+
+	/**
+	 * Send ready over the socket
+	 *
+	 * Sends the ready message over the socket to initiate the session.
+	 *
+	 * @param {Object} socket - WebSocket connection to client.
+	 * @param {string} sessionToken -
+	 *     the session token to send to the client.
+	 * @param {Object=} additionalData -
+	 *     extra properties to send along the ready message.
+	 */
+	ready(socket, sessionToken, additionalData) {
+		this._socket = socket;
+		this._socket.send(JSON.stringify({
+			seq: null,
+			type: "ready",
+			data: {
+				session_token: sessionToken,
+				session_timeout: this._sessionTimeout,
+				heartbeat_interval: this._heartbeatInterval,
+				...additionalData,
+			},
+		}));
+
+		this._state = "connected";
+		this._attachSocketHandlers();
+		this.emit("connect");
+	}
+
+	/**
+	 * Continue connection with the given socket
+	 *
+	 * Terminates the current socket and contiunes the session over the
+	 * socket given from the message sequence given.
+	 *
+	 * @param {module:net.Socket} socket - New socket to continue on.
+	 * @param {number} lastSeq - The last message the client received.
+	 */
+	continue(socket, lastSeq) {
+
+		// It's possible the previous connection hasn't closed yet due to a
+		// stale connection.  Terminate it if so.
+		if (this._state === "connected") {
+			this._socket.terminate();
+			this._socket.once("close", () => this.continue(socket, lastSeq));
+			return;
+		}
+
+		this._socket = socket;
+
+		if (this._timeoutId) {
+			clearTimeout(this._timeoutId);
+			this._timeoutId = null;
+		}
+
+		this._socket.send(JSON.stringify({
+			seq: null,
+			type: "continue",
+			data: {
+				last_seq: this._lastReceivedSeq,
+				session_timeout: this._sessionTimeout,
+				heartbeat_interval: this._heartbeatInterval,
+			},
+		}));
+
+		this._state = "connected";
+		this._attachSocketHandlers();
+		this._dropSendBufferSeq(lastSeq);
+		for (let message of this._sendBuffer) {
+			this._socket.send(JSON.stringify(message));
+		}
+		this.emit("resume");
+	}
+
+	_timedOut() {
+		logger.verbose("Connector | Connection timed out");
+		this._reset();
+		this.emit("close");
+	}
+
+	_attachSocketHandlers() {
+		this.startHeartbeat();
+
+		this._socket.on("close", (code, reason) => {
+			logger.verbose(`Connector | Close (code: ${code}, reason: ${reason})`);
+			this.stopHeartbeat();
+
+			if (this._closing) {
+				this._reset();
+				this.emit("close");
+
+			} else {
+				this._state = "resuming";
+				this.emit("drop");
+				this._timeoutId = setTimeout(() => { this._timedOut(); }, this._sessionTimeout * 1000);
+			}
+
+		});
+
+		this._socket.on("error", err => {
+			// It's assumed that close is always called by ws
+			logger.verbose("Connector | Error:", err);
+		});
+
+		this._socket.on("open", () => {
+			logger.verbose("Connector | Open");
+		});
+		this._socket.on("ping", data => {
+			logger.verbose(`Connector | Ping (data: ${data}`);
+		});
+		this._socket.on("pong", data => {
+			logger.verbose(`Connector | Pong (data: ${data}`);
+		});
+
+		// Handle messages
+		this._socket.on("message", data => {
+			let message = JSON.parse(data);
+			if (["connected", "closing"].includes(this._state)) {
+				if (message.seq !== null) {
+					this._lastReceivedSeq = message.seq;
+				}
+
+				if (message.type === "heartbeat") {
+					this._processHeartbeat(message);
+
+				} else {
+					this.emit("message", message);
+				}
+
+			} else {
+				throw new Error(`Received message in unexpected state ${this._state}`);
+			}
+		});
+	}
+
+	/**
+	 * Close the connection with the given reason.
+	 *
+	 * Sends a close frame and disconnects the connector.
+	 *
+	 * @param {number} code - WebSocket close code.
+	 * @param {string} reason - WebSocket close reason.
+	 */
+	async close(code, reason) {
+		if (this._state === "closed") {
+			return;
+		}
+
+		if (this._state === "resuming") {
+			this._reset();
+			this.emit("close");
+			return;
+		}
+
+		this._closing = true;
+		this._socket.close(code, reason);
+		await events.once(this, "close");
+	}
+
+	/**
+	 * Notify the connection is expected to close
+	 *
+	 * Sets the internal flag to signal not to wait for the client to
+	 * reconnect and resume the connection if the client closes it.  This
+	 * will close the connection if it's currently waiting for the client to
+	 * resume it.
+	 */
+	setClosing() {
+		if (this._state === "resuming") {
+			this._reset();
+			this.emit("close");
+			return;
+		}
+
+		this._closing = true;
+	}
+}
+
+module.exports = WsServerConnector;

packages/master/src/metrics.js

@@ -0,0 +1,9 @@
+// Shared metrics
+"use strict";
+const libPrometheus = require("@clusterio/lib/prometheus");
+
+exports.endpointHitCounter = new libPrometheus.Counter(
+	"clusterio_master_http_endpoint_hits_total",
+	"How many requests a particular HTTP endpoint has gotten",
+	{ labels: ["route"] }
+);

packages/master/src/routes.js

@@ -1,6 +1,459 @@
 "use strict";
+const Busboy = require("busboy");
+const crypto = require("crypto");
+const events = require("events");
+const JSZip = require("jszip");
+const jwt = require("jsonwebtoken");
+const path = require("path");
+const util = require("util");
+
+const libErrors = require("@clusterio/lib/errors");
+const libFileOps = require("@clusterio/lib/file_ops");
+const libHash = require("@clusterio/lib/hash");
+const libHelpers = require("@clusterio/lib/helpers");
+const libLink = require("@clusterio/lib/link");
+const libPlugin = require("@clusterio/lib/plugin");
+const libPrometheus = require("@clusterio/lib/prometheus");
+const { logger } = require("@clusterio/lib/logging");
+
+const { endpointHitCounter } = require("./metrics");
+
+
+// Merges samples from sourceResult to destinationResult
+function mergeSamples(destinationResult, sourceResult) {
+	let receivedSamples = new Map(sourceResult.samples);
+	for (let [suffix, suffixSamples] of destinationResult.samples) {
+		if (receivedSamples.has(suffix)) {
+			suffixSamples.push(...receivedSamples.get(suffix));
+			receivedSamples.delete(suffix);
+		}
+	}
+
+	for (let entry of receivedSamples) {
+		sourceResult.samples.push(entry);
+	}
+}
+
+// Prometheus polling endpoint
+async function getMetrics(req, res, next) {
+	endpointHitCounter.labels(req.route.path).inc();
+
+	let results = [];
+	let pluginResults = await libPlugin.invokeHook(req.app.locals.master.plugins, "onMetrics");
+	for (let metricIterator of pluginResults) {
+		for await (let metric of metricIterator) {
+			results.push(metric);
+		}
+	}
+
+	let requests = [];
+	let timeout = req.app.locals.master.config.get("master.metrics_timeout") * 1000;
+	for (let slaveConnection of req.app.locals.master.wsServer.slaveConnections.values()) {
+		if (!slaveConnection.connected) {
+			continue;
+		}
+		requests.push(libHelpers.timeout(
+			libLink.messages.getMetrics.send(slaveConnection).catch(err => {
+				if (!(err instanceof libErrors.SessionLost)) {
+					logger.error(`Unexpected error gathering metrics from slave:\n${err.stack}`);
+				}
+				return null;
+			}),
+			timeout, null
+		));
+	}
+
+	for await (let result of await libPrometheus.defaultRegistry.collect()) {
+		results.push(result);
+	}
+
+	let resultMap = new Map();
+	for (let response of await Promise.all(requests)) {
+		if (!response) {
+			// TODO: Log timeout occured?
+			continue;
+		}
+
+		for (let result of response.results) {
+			if (!resultMap.has(result.metric.name)) {
+				resultMap.set(result.metric.name, result);
+
+			} else {
+				// Merge metrics received by multiple slaves
+				mergeSamples(resultMap.get(result.metric.name), result);
+			}
+		}
+	}
+
+	for (let result of resultMap.values()) {
+		results.push(libPrometheus.deserializeResult(result));
+	}
+
+
+	let text = await libPrometheus.exposition(results);
+	res.set("Content-Type", libPrometheus.exposition.contentType);
+	res.send(text);
+}
+
+function getPlugins(req, res) {
+	let plugins = [];
+	for (let pluginInfo of req.app.locals.master.pluginInfos) {
+		let name = pluginInfo.name;
+		let loaded = req.app.locals.master.plugins.has(name);
+		let enabled = loaded && req.app.locals.master.config.group(pluginInfo.name).get("load_plugin");
+		let web = {};
+		let devPlugins = req.app.locals.devPlugins;
+		if (devPlugins && devPlugins.has(name)) {
+			let stats = res.locals.webpack.devMiddleware.stats.stats[devPlugins.get(name)];
+			web.main = stats.toJson().assetsByChunkName[name];
+		} else if (pluginInfo.manifest) {
+			web.main = pluginInfo.manifest[`${pluginInfo.name}.js`];
+			if (!web.main) {
+				web.error = `Missing ${pluginInfo.name}.js entry in manifest.json`;
+			}
+		} else {
+			web.error = "Missing dist/web/manifest.json";
+		}
+		if (web.main === "remoteEntry.js") {
+			web.error = "Incompatible old remoteEntry.js entrypoint.";
+		}
+		plugins.push({ name, version: pluginInfo.version, enabled, loaded, web, requirePath: pluginInfo.requirePath });
+	}
+	res.send(plugins);
+}
+
+function validateSlaveToken(req, res, next) {
+	let token = req.header("x-access-token");
+	if (!token) {
+		res.sendStatus(401);
+		return;
+	}
+
+	try {
+		jwt.verify(
+			token,
+			Buffer.from(req.app.locals.master.config.get("master.auth_secret"), "base64"),
+			{ audience: "slave" }
+		);
+
+	} catch (err) {
+		res.sendStatus(401);
+		return;
+	}
+
+	next();
+}
+
+function validateUserToken(req, res, next) {
+	let token = req.header("x-access-token");
+	if (!token) {
+		res.sendStatus(401);
+		return;
+	}
+
+	try {
+		let tokenPayload = jwt.verify(
+			token,
+			Buffer.from(req.app.locals.master.config.get("master.auth_secret"), "base64"),
+			{ audience: "user" }
+		);
+		let user = req.app.locals.master.userManager.users.get(tokenPayload.user);
+		if (!user) {
+			throw new Error("invalid user");
+		}
+		if (tokenPayload.iat < user.tokenValidAfter) {
+			throw new Error("invalid token");
+		}
+		res.locals.user = user;
+
+	} catch (err) {
+		res.sendStatus(401);
+		return;
+	}
+
+	next();
+}
+
+// Handle an uploaded export package.
+async function uploadExport(req, res) {
+	endpointHitCounter.labels(req.route.path).inc();
+	if (req.get("Content-Type") !== "application/zip") {
+		res.sendStatus(415);
+		return;
+	}
+
+	let data = [];
+	for await (let chunk of req) {
+		data.push(chunk);
+	}
+	data = Buffer.concat(data);
+	let zip = await JSZip.loadAsync(data);
+	data = null;
+
+	// This is hardcoded to prevent path expansion attacks
+	let exportFiles = [
+		"export/item-spritesheet.png",
+		"export/item-metadata.json",
+		"export/locale.json",
+	];
+
+	let manifest = {};
+	for (let filePath of exportFiles) {
+		let file = zip.file(filePath);
+		if (!file) {
+			continue;
+		}
+
+		let { name, ext } = path.posix.parse(filePath);
+		let hash = await libHash.hashStream(file.nodeStream());
+		manifest[name] = `static/${name}.${hash}${ext}`;
+		await libFileOps.safeOutputFile(path.join("static", `${name}.${hash}${ext}`), await file.async("nodebuffer"));
+	}
+	await res.app.locals.master.updateExportManifest(manifest);
+
+	res.sendStatus(200);
+}
+
+async function getExportManifest(req, res) {
+	endpointHitCounter.labels(req.route.path).inc();
+	res.json(res.app.locals.master.exportManifest);
+}
+
+async function createProxyStream(app) {
+	let asyncRandomBytes = util.promisify(crypto.randomBytes);
+	let id = (await asyncRandomBytes(8)).toString("hex");
+	let stream = {
+		id,
+		flowing: false,
+		size: null,
+		mime: null,
+		filename: null,
+		events: new events.EventEmitter(),
+		timeout: setTimeout(() => {
+			stream.events.emit("timeout");
+		}, app.locals.master.config.get("master.proxy_stream_timeout") * 1000),
+	};
+	stream.events.on("close", () => {
+		clearTimeout(stream.timeout);
+		app.locals.streams.delete(id);
+	});
+	stream.events.on("timeout", () => {
+		stream.events.emit("close");
+	});
+	app.locals.streams.set(id, stream);
+	return stream;
+}
+
+async function putStream(req, res) {
+	let stream = req.app.locals.streams.get(req.params.id);
+	if (!stream || stream.source) {
+		res.sendStatus(404);
+		return;
+	}
+	stream.source = req;
+	stream.mime = req.get("Content-Type");
+	stream.size = req.get("Content-Length");
+
+	stream.events.emit("source");
+	stream.events.on("close", () => {
+		if (!stream.flowing) {
+			req.resume();
+			res.sendStatus(500);
+		} else {
+			res.sendStatus(200);
+		}
+	});
+}
+
+async function getStream(req, res) {
+	let stream = req.app.locals.streams.get(req.params.id);
+	if (!stream || stream.flowing) {
+		res.sendStatus(404);
+		return;
+	}
+
+	function startStream() {
+		res.append("Content-Type", stream.mime);
+		if (stream.size) {
+			res.append("Content-Length", stream.size);
+		}
+		if (stream.filename) {
+			res.append("Content-Disposition", `attachment; filename="${stream.filename}"`);
+		} else {
+			res.append("Content-Disposition", "attachment");
+		}
+		stream.source.pipe(res);
+		stream.flowing = true;
+		res.on("finish", () => {
+			stream.events.emit("close");
+		});
+		clearTimeout(stream.timeout);
+	}
+
+	if (stream.source) {
+		startStream();
+	} else {
+		stream.events.on("source", startStream);
+		stream.events.on("timeout", () => {
+			res.sendStatus(500);
+		});
+	}
+}
+
+
+const zipMimes = [
+	"application/zip",
+	"application/x-zip-compressed",
+];
+
+async function uploadSave(req, res) {
+	try {
+		res.locals.user.checkPermission("core.instance.save.upload");
+	} catch (err) {
+		res.status(403).json({ request_errors: [err.message] });
+		return;
+	}
+
+	let contentType = req.get("Content-Type");
+	let match = /^([!#$%&'*+\-.^_`|~0-9A-Za-z]+\/[!#$%&'*+\-.^_`|~0-9A-Za-z]+)/.exec(contentType);
+	if (!match) {
+		res.status(415).json({ request_errors: ["invalid Content-Type"] });
+		return;
+	}
+	let mimeType = match[1].toLowerCase();
+
+	let tasks = [];
+	let errors = [];
+	let requestErrors = [];
+	let saves = [];
+
+	async function handleFile(instanceId, stream, filename, streamMime) {
+		let proxyStream = await createProxyStream(req.app);
+		proxyStream.source = stream;
+		proxyStream.mime = streamMime;
+		let timeout = new Promise((_, reject) => {
+			proxyStream.events.on("timeout", () => {
+				stream.resume();
+				reject(new Error("Timed out establishing stream to slave"));
+			});
+		});
+
+		try {
+			let result = await Promise.race([
+				req.app.locals.master.forwardRequestToInstance(libLink.messages.pullSave, {
+					instance_id: instanceId,
+					stream_id: proxyStream.id,
+					filename,
+				}),
+				timeout,
+			]);
+			saves.push(result.save);
+
+		} catch (err) {
+			proxyStream.events.emit("close");
+			logger.error(`Error uploading save: ${err.message}`);
+			errors.push(err.message);
+			stream.resume();
+		}
+	}
+
+	if (mimeType === "multipart/form-data") {
+		await new Promise(resolve => {
+			let fields = {};
+			let busboy = new Busboy({ headers: req.headers });
+			busboy.on("file", (fieldname, stream, filename, transferEncoding, fileMime) => {
+				if (fields.instanceId === undefined) {
+					requestErrors.push("instance_id must come before files uploaded");
+				}
+
+				if (!zipMimes.includes(fileMime)) {
+					requestErrors.push("invalid file Content-Type");
+				}
+
+				if (!filename.endsWith(".zip")) {
+					requestErrors.push("filename must end with .zip");
+				}
+
+				if (errors.length || requestErrors.length) {
+					stream.resume();
+					return;
+				}
+
+				tasks.push(handleFile(fields.instanceId, stream, filename, fileMime));
+			});
+			busboy.on("field", (fieldname, value, fieldnameTruncated, valueTruncated, transferEncoding, valueMime) => {
+				if (fieldname === "instance_id") {
+					fields.instanceId = Number.parseInt(value, 10);
+					if (Number.isNaN(fields.instanceId)) {
+						requestErrors.push("invalid instance_id");
+					}
+				}
+			});
+			busboy.on("finish", resolve);
+			busboy.on("error", (err) => {
+				logger.error(`Error parsing multipart request in upload-save:\n${err.stack}`);
+				errors.push(err.message);
+			});
+			req.pipe(busboy);
+		});
+
+	} else if (zipMimes.includes(mimeType)) {
+		let filename = req.query.filename;
+		if (typeof filename !== "string") {
+			requestErrors.push("Missing or invalid filename parameter");
+		} else if (!filename.endsWith(".zip")) {
+			requestErrors.push("filename must end with .zip");
+		}
+		let instanceId = Number.parseInt(req.query.instance_id, 10);
+		if (Number.isNaN(instanceId)) {
+			requestErrors.push("Missing or invalid instance_id parameter");
+		}
+
+		if (errors.length || requestErrors.length) {
+			req.resume();
+		} else {
+			tasks.push(handleFile(instanceId, req, filename, mimeType));
+		}
+
+	} else {
+		res.status(415).json({ request_errors: ["invalid Content-Type"] });
+		return;
+	}
+
+	await Promise.all(tasks);
+
+	if (errors.length) {
+		res.status(500);
+		res.json({ errors, request_errors: requestErrors });
+		return;
+	}
+	if (requestErrors.length) {
+		res.status(400);
+		res.json({ request_errors: requestErrors });
+		return;
+	}
+
+	res.json({ saves });
+}
+
+function addRouteHandlers(app) {
+	app.get("/metrics", (req, res, next) => getMetrics(req, res, next).catch(next));
+	app.get("/api/plugins", getPlugins);
+	app.put("/api/upload-export",
+		validateSlaveToken,
+		(req, res, next) => uploadExport(req, res).catch(next)
+	);
+	app.get("/api/export-manifest", (req, res, next) => getExportManifest(req, res, next).catch(next));
+	app.put("/api/stream/:id", (req, res, next) => putStream(req, res).catch(next));
+	app.get("/api/stream/:id", (req, res, next) => getStream(req, res).catch(next));
+	app.post("/api/upload-save",
+		validateUserToken,
+		(req, res, next) => uploadSave(req, res).catch(next)
+	);
+}
+
 // Routes used in the web interface and served by the master server
-module.exports = [
+const webRoutes = [
 	"/",
 	"/master",
 	"/slaves",
@@ -14,3 +467,9 @@ module.exports = [
 	"/plugins",
 	"/plugins/:name/view",
 ];
+
+module.exports = {
+	addRouteHandlers,
+	webRoutes,
+	createProxyStream,
+};

packages/master/web/index.html

@@ -1,17 +1,38 @@
 <!DOCTYPE html>
 <html lang="en">
-  <head>
-    <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1" />
-    <meta name="theme-color" content="#2a2a2a" />
-    <title>Clusterio</title>
-    <script>
-        window.webRoot = new URL("__WEB_ROOT__", document.location).pathname;
-    </script>
-  </head>
-  <body>
-    <noscript>You need to enable JavaScript to run this app.</noscript>
-    <div id="root"></div>
-    <script src="__WEB_ROOT__bundle.js"></script>
-  </body>
+	<head>
+		<meta charset="utf-8" />
+		<meta name="viewport" content="width=device-width, initial-scale=1" />
+		<meta name="theme-color" content="#2a2a2a" />
+		<title>__CLUSTER_NAME__</title>
+		<style>
+			html {
+				color: #fff;
+				background-color: #000;
+			}
+
+			#bootstrap-msg {
+				font: 20px serif;
+				color: #aaa;
+				margin: auto;
+				margin-top: 1em;
+				width: fit-content;
+			}
+		</style>
+		<script>
+			window.webRoot = new URL("__WEB_ROOT__", document.location).pathname;
+			window.staticRoot = new URL("__STATIC_ROOT__", document.location).pathname;
+			function scriptError() {
+				let bootstrapMsg = document.getElementById("bootstrap-msg");
+				bootstrapMsg.textContent = "Error loading main bundle, see web console for details.";
+			}
+		</script>
+	</head>
+	<body>
+		<noscript>You need to enable JavaScript to run this app.</noscript>
+		<div id="root">
+			<div id="bootstrap-msg">Loading web interface...</div>
+		</div>
+		<script src="__STATIC_ROOT____MAIN_BUNDLE__" defer onerror="scriptError()"></script>
+	</body>
 </html>

packages/master/webpack.config.js

@@ -12,26 +12,19 @@ module.exports = (env = {}) => merge(common(env), {
 		contentBase: "./dist/web",
 	},
 	output: {
-		publicPath: "auto",
-		filename: "bundle.js",
 		path: path.resolve(__dirname, "dist", "web"),
 	},
 	plugins: [
 		new webpack.container.ModuleFederationPlugin({
 			name: "master",
 			shared: {
-				"@clusterio/lib/config": { singleton: true },
-				"@clusterio/lib/errors": { singleton: true },
-				"@clusterio/lib/helpers": { singleton: true },
-				"@clusterio/lib/link": { singleton: true },
-				"@clusterio/lib/logging": { singleton: true },
-				"@clusterio/lib/plugin": { singleton: true },
-				"@clusterio/lib/schema": { singleton: true },
-				"@clusterio/lib/users": { singleton: true },
+				"@clusterio/lib": { singleton: true },
 				"@clusterio/web_ui": { singleton: true },
 				"antd": { singleton: true },
 				"react": { singleton: true },
 				"react-dom": { singleton: true },
+				"react-router": { singleton: true },
+				"react-router-dom": { singleton: true },
 			},
 		}),
 	],

packages/slave/README.md

@@ -90,4 +90,4 @@ Runs the slave.
 
 ## See Also
 
-[The Clusterio repository](https://github.com/clusterio/factorioClusterio) for instructions on how to set up a cluster.
+[The Clusterio repository](https://github.com/clusterio/clusterio) for instructions on how to set up a cluster.

packages/slave/lua/clusterio_lib/api.lua

@@ -4,63 +4,63 @@ local api = {}
 
 local initialized = false
 function api.init()
-    if initialized then
-        return
-    end
-    initialized = true
+	if initialized then
+		return
+	end
+	initialized = true
 
-    if remote.interfaces.clusterio_api then
-        api.events = remote.call("clusterio_api", "get_events")
-    else
-        local null_event = script.generate_event_name()
-        api.events = {
-            on_instance_updated = null_event,
-            on_server_startup = null_event,
-        }
-    end
+	if remote.interfaces.clusterio_api then
+		api.events = remote.call("clusterio_api", "get_events")
+	else
+		local null_event = script.generate_event_name()
+		api.events = {
+			on_instance_updated = null_event,
+			on_server_startup = null_event,
+		}
+	end
 end
 
 local function call_api(fn, ...)
-    if remote.interfaces.clusterio_api and remote.interfaces.clusterio_api[fn] then
-        return remote.call("clusterio_api", fn, ...)
-    else
-        return nil
-    end
+	if remote.interfaces.clusterio_api and remote.interfaces.clusterio_api[fn] then
+		return remote.call("clusterio_api", fn, ...)
+	else
+		return nil
+	end
 end
 
 function api.get_instance_name()
-    return call_api("get_instance_name")
+	return call_api("get_instance_name")
 end
 
 function api.get_instance_id()
-    return call_api("get_instance_id")
+	return call_api("get_instance_id")
 end
 
 
 function api.send_json(channel, data)
-    if not remote.interfaces.clusterio_api then
-        return
-    end
+	if not remote.interfaces.clusterio_api then
+		return
+	end
 
-    -- Escape bad characters.  The question mark is used for separating the
-    -- channel name from the payload.
-    channel = channel:gsub("([\x00-\x1f?\\])", function(match)
-        return "\\x" .. string.format("%02x", match:byte())
-    end)
+	-- Escape bad characters.  The question mark is used for separating the
+	-- channel name from the payload.
+	channel = channel:gsub("([\x00-\x1f?\\])", function(match)
+		return "\\x" .. string.format("%02x", match:byte())
+	end)
 
-    data = game.table_to_json(data)
+	data = game.table_to_json(data)
 
-    -- If there's more than about 4kB of data users running with the Windows
-    -- console open will start to experience stuttering, otherwise we could
-    -- output about 1 MB of data at a time through stdout.
-    if #data < 4000 then
-        print("\f$ipc:" .. channel .. "?j" .. data)
-    else
-        local file_no = remote.call("clusterio_api", "get_file_no")
-        local file_name = "clst_" .. file_no .. ".json"
-        game.write_file(file_name, data, false, 0)
-        print("\f$ipc:" .. channel .. "?f" .. file_name)
-    end
+	-- If there's more than about 4kB of data users running with the Windows
+	-- console open will start to experience stuttering, otherwise we could
+	-- output about 1 MB of data at a time through stdout.
+	if #data < 4000 then
+		print("\f$ipc:" .. channel .. "?j" .. data)
+	else
+		local file_no = remote.call("clusterio_api", "get_file_no")
+		local file_name = "clst_" .. file_no .. ".json"
+		game.write_file(file_name, data, false, 0)
+		print("\f$ipc:" .. channel .. "?f" .. file_name)
+	end
 end
 
 

packages/slave/lua/clusterio_lib/info.json

@@ -1,24 +1,24 @@
 {
-    "name": "clusterio_lib",
-    "variants": [
-        {
-            "version": "0.1.0",
-            "factorio_version": "0.17"
-        },
-        {
-            "version": "0.1.1",
-            "factorio_version": "0.18"
-        },
-        {
-            "version": "0.1.2",
-            "factorio_version": "1.1"
-        }
-    ],
-    "title": "Clusterio Library (Alpha)",
-    "author": "Clusterio Team",
-    "homepage": "https://github.com/clusterio/factorioClusterio",
-    "description": "Library for interfacing with Clusterio.  Warning: work in progress alpha.",
-    "additional_files": {
-        "serialize.lua": ["..", "..", "modules", "clusterio", "serialize.lua"]
-    }
+	"name": "clusterio_lib",
+	"variants": [
+		{
+			"version": "0.1.0",
+			"factorio_version": "0.17"
+		},
+		{
+			"version": "0.1.1",
+			"factorio_version": "0.18"
+		},
+		{
+			"version": "0.1.2",
+			"factorio_version": "1.1"
+		}
+	],
+	"title": "Clusterio Library (Alpha)",
+	"author": "Clusterio Team",
+	"homepage": "https://github.com/clusterio/clusterio",
+	"description": "Library for interfacing with Clusterio.  Warning: work in progress alpha.",
+	"additional_files": {
+		"serialize.lua": ["..", "..", "modules", "clusterio", "serialize.lua"]
+	}
 }

packages/slave/lua/export/control.lua

@@ -1,8 +1,8 @@
 local function send_json(channel, data)
-    data = game.table_to_json(data)
-    print("\f$ipc:" .. channel .. "?j" .. data)
+	data = game.table_to_json(data)
+	print("\f$ipc:" .. channel .. "?j" .. data)
 end
 
 script.on_init(function()
-    send_json("mod_list", game.active_mods)
+	send_json("mod_list", game.active_mods)
 end)

packages/slave/lua/export/data-final-fixes.lua

@@ -1,101 +1,104 @@
 local item_types = {
-    -- Item categories
-    "item",
-    "ammo",
-    "capsule",
-    "gun",
-    "item-with-entity-data",
-    "item-with-label",
-    "item-with-inventory",
-    "blueprint-book",
-    "item-with-tags",
-    "selection-tool",
-    "blueprint",
-    "deconstruction-item",
-    "copy-paste-tool",
-    "upgrade-item",
-    "module",
-    "rail-planner",
-    "tool",
-    "armor",
-    "mining-tool",
-    "repair-tool",
+	-- Item categories
+	"item",
+	"ammo",
+	"capsule",
+	"gun",
+	"item-with-entity-data",
+	"item-with-label",
+	"item-with-inventory",
+	"blueprint-book",
+	"item-with-tags",
+	"selection-tool",
+	"blueprint",
+	"deconstruction-item",
+	"copy-paste-tool",
+	"upgrade-item",
+	"module",
+	"rail-planner",
+	"tool",
+	"armor",
+	"mining-tool",
+	"repair-tool",
 
-    -- Fluids
-    "fluid",
+	-- Fluids
+	"fluid",
 }
 
 local function is_array(t)
-    local count = 0
-    for k in pairs(t) do
-        if type(k) ~= "number" then
-            return false
-        end
-        count = count + 1
-    end
+	local count = 0
+	for k in pairs(t) do
+		if type(k) ~= "number" then
+			return false
+		end
+		count = count + 1
+	end
 
-    for i = 1, count do
-        if not t[i] then
-            return false
-        end
-    end
+	for i = 1, count do
+		if not t[i] then
+			return false
+		end
+	end
 
-    return count ~= 0
+	return count ~= 0
 end
 
 -- no game.table_to_json here :(
 local function table_to_json(data)
-    if type(data) == "number" then
-        return string.format("%.17g", data)
+	if type(data) == "number" then
+		if data == math.huge then return "1e500" end -- Inf is not representable in JSON, but 1e500 will overflow to it.
+		if data == -math.huge then return "-1e500" end
+		if data ~= data then return "0" end -- NaN is not representable in JSON, treat as 0 instead.
+		return string.format("%.17g", data)
 
-    elseif type(data) == "string" then
-        data = data:gsub('([\x00-\x1f\\"])', function(match)
-            return "\\x" .. string.format("%02x", match:byte())
-        end)
-        return '"' .. data .. '"'
+	elseif type(data) == "string" then
+		data = data:gsub('([\x00-\x1f\\"])', function(match)
+			return "\\u00" .. string.format("%02x", match:byte())
+		end)
+		return '"' .. data .. '"'
 
-    elseif data == nil then
-        return "null"
+	elseif data == nil then
+		return "null"
 
-    elseif data == true then
-        return "true"
-    elseif data == false then
-        return "false"
+	elseif data == true then
+		return "true"
+	elseif data == false then
+		return "false"
 
-    elseif type(data) == "table" then
-        local r
-        if is_array(data) then
-            r = {"["}
-            for i=1, #data do
-                r[#r+1] = table_to_json(data[i])
-                r[#r+1] = ","
-            end
+	elseif type(data) == "table" then
+		local r
+		if is_array(data) then
+			r = {"["}
+			for i=1, #data do
+				r[#r+1] = table_to_json(data[i])
+				r[#r+1] = ","
+			end
 
-            -- overwrite last comma, empty table is an object
-            r[#r] = "]"
+			-- overwrite last comma, empty table is an object
+			r[#r] = "]"
 
-        else
-            r = {"{"}
-            for k, v in pairs(data) do
-                r[#r+1] = table_to_json(tostring(k))
-                r[#r+1] = ":"
-                r[#r+1] = table_to_json(v)
-                r[#r+1] = ","
-            end
-            r[#r + (r[#r] == "," and 0 or 1)] = "}"
-        end
+		else
+			r = {"{"}
+			for k, v in pairs(data) do
+				r[#r+1] = table_to_json(tostring(k))
+				r[#r+1] = ":"
+				r[#r+1] = table_to_json(v)
+				r[#r+1] = ","
+			end
+			r[#r + (r[#r] == "," and 0 or 1)] = "}"
+		end
 
-        return table.concat(r)
-    end
+		return table.concat(r)
+	end
 end
 
 local function send_json(channel, data)
-    data = table_to_json(data)
-    print("\f$ipc:" .. channel .. "?j" .. data)
+	data = table_to_json(data)
+	print("\f$ipc:" .. channel .. "?j" .. data)
 end
 
 for _, group in ipairs(item_types) do
-    for _, item in pairs(data.raw[group]) do
-        send_json("item_export", item)
-    end
+	for _, item in pairs(data.raw[group]) do
+		send_json("item_export", item)
+	end
 end

packages/slave/lua/export/info.json

@@ -1,8 +1,8 @@
 {
-    "name": "export",
-    "version": "0.0.0",
-    "title": "Icon exporter",
-    "author": "Clusterio Team",
-    "homepage": "https://github.com/clusterio/factorioClusterio",
-    "description": "Exports item prototypes on stdout during the data stage."
+	"name": "export",
+	"version": "0.0.0",
+	"title": "Icon exporter",
+	"author": "Clusterio Team",
+	"homepage": "https://github.com/clusterio/clusterio",
+	"description": "Exports item prototypes on stdout during the data stage."
 }

packages/slave/modules/clusterio/api.lua

@@ -3,39 +3,39 @@ local api = {}
 
 
 api.events = {
-    on_instance_updated = script.generate_event_name(),
-    on_server_startup = script.generate_event_name(),
+	on_instance_updated = script.generate_event_name(),
+	on_server_startup = script.generate_event_name(),
 }
 
 function api.get_instance_name()
-    return global.clusterio.instance_name
+	return global.clusterio.instance_name
 end
 
 function api.get_instance_id()
-    return global.clusterio.instance_id
+	return global.clusterio.instance_id
 end
 
 function api.send_json(channel, data)
 
-    -- Escape bad characters.  The question mark is used for separating the
-    -- channel name from the payload.
-    channel = channel:gsub("([\x00-\x1f?\\])", function(match)
-        return "\\x" .. string.format("%02x", match:byte())
-    end)
+	-- Escape bad characters.  The question mark is used for separating the
+	-- channel name from the payload.
+	channel = channel:gsub("([\x00-\x1f?\\])", function(match)
+		return "\\x" .. string.format("%02x", match:byte())
+	end)
 
-    data = game.table_to_json(data)
+	data = game.table_to_json(data)
 
-    -- If there's more than about 4kB of data users running with the Windows
-    -- console open will start to experience stuttering, otherwise we could
-    -- output about 1 MB of data at a time through stdout.
-    if #data < 4000 then
-        print("\f$ipc:" .. channel .. "?j" .. data)
-    else
-        global.clusterio_file_no = (global.clusterio_file_no or 0) + 1
-        local file_name = "clst_" .. global.clusterio_file_no .. ".json"
-        game.write_file(file_name, data, false, 0)
-        print("\f$ipc:" .. channel .. "?f" .. file_name)
-    end
+	-- If there's more than about 4kB of data users running with the Windows
+	-- console open will start to experience stuttering, otherwise we could
+	-- output about 1 MB of data at a time through stdout.
+	if #data < 4000 then
+		print("\f$ipc:" .. channel .. "?j" .. data)
+	else
+		global.clusterio_file_no = (global.clusterio_file_no or 0) + 1
+		local file_name = "clst_" .. global.clusterio_file_no .. ".json"
+		game.write_file(file_name, data, false, 0)
+		print("\f$ipc:" .. channel .. "?f" .. file_name)
+	end
 end
 
 

packages/slave/modules/clusterio/impl.lua

@@ -5,43 +5,54 @@ local impl = {}
 
 impl.events = {}
 impl.events[defines.events.on_tick] = function()
-    if global.clusterio_patch_number ~= clusterio_patch_number then
-        global.clusterio_patch_number = clusterio_patch_number
-        script.raise_event(api.events.on_server_startup, {})
-    end
+	if global.clusterio_patch_number ~= clusterio_patch_number then
+		global.clusterio_patch_number = clusterio_patch_number
+		script.raise_event(api.events.on_server_startup, {})
+	end
 end
 
 impl.events[api.events.on_server_startup] = function()
-    if not global.clusterio then
-        global.clusterio = {
-            instance_id = nil,
-            instance_name = nil,
-        }
-    end
+	if not global.clusterio then
+		global.clusterio = {
+			instance_id = nil,
+			instance_name = nil,
+		}
+	end
 
-    -- Replay will just desync after the save is patched
-    game.disable_replay()
+	-- Replay will just desync after the save is patched
+	game.disable_replay()
 end
 
 impl.events[defines.events.on_player_joined_game] = function(event)
-    local player = game.players[event.player_index]
-    api.send_json("player_event", { type = "join", name = player.name })
+	local player = game.players[event.player_index]
+	api.send_json("player_event", { type = "join", name = player.name })
+end
+
+local disconnect_reason_name = {}
+if defines.disconnect_reason then
+	for name, i in pairs(defines.disconnect_reason) do
+		disconnect_reason_name[i] = name
+	end
 end
 
 impl.events[defines.events.on_player_left_game] = function(event)
-    local player = game.players[event.player_index]
-    api.send_json("player_event", { type = "leave", name = player.name })
+	local player = game.players[event.player_index]
+	api.send_json("player_event", {
+		type = "leave",
+		name = player.name,
+		reason = disconnect_reason_name[event.reason] or "quit",
+	})
 end
 
 -- Internal API
 clusterio_private = {}
 function clusterio_private.update_instance(new_id, new_name)
-    global.clusterio.instance_id = new_id
-    global.clusterio.instance_name = new_name
-    script.raise_event(api.events.on_instance_updated, {
-        instance_id = new_id,
-        instance_name = new_name,
-    })
+	global.clusterio.instance_id = new_id
+	global.clusterio.instance_name = new_name
+	script.raise_event(api.events.on_instance_updated, {
+		instance_id = new_id,
+		instance_name = new_name,
+	})
 end
 
 
@@ -52,22 +63,22 @@ end
 -- on_load.  See https://forums.factorio.com/viewtopic.php?f=25&t=81552 for
 -- more details.
 remote.add_interface('clusterio_api', {
-    get_events = function()
-        return api.events
-    end,
+	get_events = function()
+		return api.events
+	end,
 
-    get_instance_id = function()
-        return global.clusterio.instance_id
-    end,
+	get_instance_id = function()
+		return global.clusterio.instance_id
+	end,
 
-    get_instance_name = function()
-        return global.clusterio.instance_name
-    end,
+	get_instance_name = function()
+		return global.clusterio.instance_name
+	end,
 
-    get_file_no = function()
-        global.clusterio_file_no = (global.clusterio_file_no or 0) + 1
-        return global.clusterio_file_no
-    end,
+	get_file_no = function()
+		global.clusterio_file_no = (global.clusterio_file_no or 0) + 1
+		return global.clusterio_file_no
+	end,
 })
 
 

packages/slave/modules/clusterio/module.json

@@ -1,6 +1,6 @@
 {
-    "name": "clusterio",
-    "version": "0.0.0",
-    "dependencies": {},
-    "load": ["impl.lua"]
+	"name": "clusterio",
+	"version": "0.0.0",
+	"dependencies": {},
+	"load": ["impl.lua"]
 }

packages/slave/modules/clusterio/serialize.lua

@@ -2,272 +2,307 @@
 -- Based on code from playerManager and trainTeleports
 local serialize = {}
 
--- 0.17 compatibility
-local supports_bar, get_bar, has_bar
-if (pcall(function() local mods = script.active_mods end)) then
-    supports_bar = "supports_bar"
-    get_bar = "get_bar"
-    set_bar = "set_bar"
-else
-    supports_bar = "hasbar"
-    get_bar = "getbar"
-    set_bar = "setbar"
+local function version_to_table(version)
+	local t = {}
+	for p in string.gmatch(version, "%d+") do
+		t[#t + 1] = tonumber(p)
+	end
+	return t
 end
 
+-- 0.17 compatibility
+local supports_bar, get_bar, set_bar, version
+if (pcall(function() local mods = script.active_mods end)) then
+	supports_bar = "supports_bar"
+	get_bar = "get_bar"
+	set_bar = "set_bar"
+	version = version_to_table(script.active_mods.base)
+else
+	supports_bar = "hasbar"
+	get_bar = "getbar"
+	set_bar = "setbar"
+	version = version_to_table("0.17.69")
+end
+
+-- returns true if the game version is greater than or equal to the given version
+local function version_ge(comp)
+	comp = version_to_table(comp)
+	for i=1, 3 do
+		if comp[i] > version[i] then
+			return false
+		elseif comp[i] < version[i] then
+			return true
+		end
+	end
+	return true
+end
+
+local has_create_grid = version_ge("1.1.7")
+
+
 -- Equipment Grids are serialized into an array of equipment entries
 -- where ench entry is a table with the following fields:
---   n: name
---   p: position (array of 2 numbers corresponding to x and y)
---   s: shield (optional)
---   e: energy (optional)
+--	 n: name
+--	 p: position (array of 2 numbers corresponding to x and y)
+--	 s: shield (optional)
+--	 e: energy (optional)
 -- If the equipment is a burner the following is also present:
---   i: burner inventory
---   r: result inventory
---   b: curently burning (optional)
---   f: remaining_burning_fuel (optional)
+--	 i: burner inventory
+--	 r: result inventory
+--	 b: currently burning (optional)
+--	 f: remaining_burning_fuel (optional)
 function serialize.serialize_equipment_grid(grid)
-    local serialized = {}
-    local processed = {}
-    for y = 0, grid.height - 1 do
-        for x = 0, grid.width - 1 do
-            local equipment = grid.get({x, y})
-            if equipment ~= nil then
-                local pos = equipment.position
-                local combined_pos = pos.x + pos.y * grid.width + 1
-                if not processed[combined_pos] then
-                    processed[combined_pos] = true
-                    local entry = {
-                        n = equipment.name,
-                        p = {pos.x, pos.y},
-                    }
-                    if equipment.shield > 0 then entry.s = equipment.shield end
-                    if equipment.energy > 0 then entry.e = equipment.energy end
-                    -- TODO: Test with Industrial Revolution
-                    if equipment.burner then
-                        local burner = equipment.burner
-                        entry.i = serialize.serialize_inventory(burner.inventory)
-                        entry.r = serialize.serialize_inventory(burner.burnt_result_inventory)
-                        if burner.curently_burning then
-                            entry.b = {}
-                            serialize.serialize_item_stack(burner.curently_burning, entry.b)
-                            entry.f = burner.remaining_burning_fuel
-                        end
-                    end
-                    table.insert(serialized, entry)
-                end
-            end
-        end
-    end
-    return serialized
+	local serialized = {}
+	local processed = {}
+	for y = 0, grid.height - 1 do
+		for x = 0, grid.width - 1 do
+			local equipment = grid.get({x, y})
+			if equipment ~= nil then
+				local pos = equipment.position
+				local combined_pos = pos.x + pos.y * grid.width + 1
+				if not processed[combined_pos] then
+					processed[combined_pos] = true
+					local entry = {
+						n = equipment.name,
+						p = {pos.x, pos.y},
+					}
+					if equipment.shield > 0 then entry.s = equipment.shield end
+					if equipment.energy > 0 then entry.e = equipment.energy end
+					if equipment.burner then
+						local burner = equipment.burner
+						entry.i = serialize.serialize_inventory(burner.inventory)
+						entry.r = serialize.serialize_inventory(burner.burnt_result_inventory)
+						if burner.currently_burning then
+							entry.b = burner.currently_burning.name
+							entry.f = burner.remaining_burning_fuel
+						end
+					end
+					table.insert(serialized, entry)
+				end
+			end
+		end
+	end
+	return serialized
 end
 
 function serialize.deserialize_equipment_grid(grid, serialized)
-    grid.clear()
-    for _, entry in ipairs(serialized) do
-        local equipment = grid.put({
-            name = entry.n,
-            position = entry.p,
-        })
-        if equipment then
-            if entry.s then equipment.shield = entry.s end
-            if entry.e then equipment.energy = entry.e end
-            if entry.i then
-                if entry.b then serialize.deserialize_item_stack(burner.currently_burning, entry.b) end
-                if entry.f then burner.remaining_burning_fuel = entry.f end
-                serialize.deserialize_inventory(burner.burnt_result_inventory, entry.r)
-                serialize.deserialize_inventory(burner.inventory, entry.i)
-            end
-        end
-    end
+	grid.clear()
+	for _, entry in ipairs(serialized) do
+		local equipment = grid.put({
+			name = entry.n,
+			position = entry.p,
+		})
+		if equipment then
+			if entry.s then equipment.shield = entry.s end
+			if entry.e then equipment.energy = entry.e end
+			if entry.i then
+				local burner = equipment.burner
+				if entry.b then burner.currently_burning = entry.b end
+				if entry.f then burner.remaining_burning_fuel = entry.f end
+				serialize.deserialize_inventory(burner.burnt_result_inventory, entry.r)
+				serialize.deserialize_inventory(burner.inventory, entry.i)
+			end
+		end
+	end
 end
 
 -- Item stacks are serialized into a table with the following fields:
---   n: name
---   c: count
---   h: health (optional)
---   d: durability (optional)
---   a: ammo count (optional)
---   l: label (optional)
---   g: equipment grid (optional)
---   i: item inventory (optional)
+--	 n: name
+--	 c: count
+--	 h: health (optional)
+--	 d: durability (optional)
+--	 a: ammo count (optional)
+--	 l: label (optional)
+--	 g: equipment grid (optional)
+--	 i: item inventory (optional)
 -- If the item stack is exportable it has the following property instead
---   e: export string
+--	 e: export string
 -- Label is a table with the following fields:
---   t: label text (optional)
---   c: color (optional)
---   a: allow manual label change
+--	 t: label text (optional)
+--	 c: color (optional)
+--	 a: allow manual label change
 function serialize.serialize_item_stack(slot, entry)
-    if
-        slot.is_blueprint
-        or slot.is_blueprint_book
-        or slot.is_upgrade_item
-        or slot.is_deconstruction_item
-        or slot.is_item_with_tags
-    then
-        local call_success, call_return = pcall(slot.export_stack)
-        if not call_success then
-            print("Error: '" .. call_return .. "' thrown exporting '" .. slot.name .. "'")
-        else
-            entry.e = call_return
-        end
+	if
+		slot.is_blueprint
+		or slot.is_blueprint_book
+		or slot.is_upgrade_item
+		or slot.is_deconstruction_item
+		or slot.is_item_with_tags
+	then
+		local call_success, call_return = pcall(slot.export_stack)
+		if not call_success then
+			print("Error: '" .. call_return .. "' thrown exporting '" .. slot.name .. "'")
+		else
+			entry.e = call_return
+		end
 
-        return
-    end
+		return
+	end
 
-    entry.n = slot.name
-    entry.c = slot.count
-    if slot.health < 1 then entry.h = slot.health end
-    if slot.durability then entry.d = slot.durability end
-    if slot.type == "ammo" then entry.a = slot.ammo end
-    if slot.is_item_with_label then
-        local label = {}
-        if slot.label then label.t = slot.label end
-        if slot.label_color then label.c = slot.label_color end
-        label.a = slot.allow_manual_label_change
-        entry.l = label
-    end
+	entry.n = slot.name
+	entry.c = slot.count
+	if slot.health < 1 then entry.h = slot.health end
+	if slot.durability then entry.d = slot.durability end
+	if slot.type == "ammo" then entry.a = slot.ammo end
+	if slot.is_item_with_label then
+		local label = {}
+		if slot.label then label.t = slot.label end
+		if slot.label_color then label.c = slot.label_color end
+		label.a = slot.allow_manual_label_change
+		entry.l = label
+	end
 
-    if slot.grid then
-        entry.g = serialize.serialize_equipment_grid(slot.grid)
-    end
+	if slot.grid then
+		entry.g = serialize.serialize_equipment_grid(slot.grid)
+	end
 
-    if slot.is_item_with_inventory then
-        local sub_inventory = slot.get_inventory(defines.inventory.item_main)
-        entry.i = serialize.serialize_inventory(sub_inventory)
-    end
+	if slot.is_item_with_inventory then
+		local sub_inventory = slot.get_inventory(defines.inventory.item_main)
+		entry.i = serialize.serialize_inventory(sub_inventory)
+	end
 end
 
 function serialize.deserialize_item_stack(slot, entry)
-    if entry.e then
-        local success = slot.import_stack(entry.e)
-        if success == 1 then
-            print("Error: import of '" .. entry.e .. "' succeeded with errors")
-        elseif success == -1 then
-            print("Error: import of '" .. entry.e .. "' failed")
-        end
+	if entry.e then
+		local success = slot.import_stack(entry.e)
+		if success == 1 then
+			print("Error: import of '" .. entry.e .. "' succeeded with errors")
+		elseif success == -1 then
+			print("Error: import of '" .. entry.e .. "' failed")
+		end
 
-        return
-    end
+		return
+	end
 
-    local item_stack = {
-        name = entry.n,
-        count = entry.c,
-    }
-    if entry.h then item_stack.health = entry.h end
-    if entry.d then item_stack.durability = entry.d end
-    if entry.a then item_stack.ammo = entry.a end
+	local item_stack = {
+		name = entry.n,
+		count = entry.c,
+	}
+	if entry.h then item_stack.health = entry.h end
+	if entry.d then item_stack.durability = entry.d end
+	if entry.a then item_stack.ammo = entry.a end
 
-    local call_success, call_return = pcall(slot.set_stack, item_stack)
-    if not call_success then
-        print("Error: '" .. call_return .. "' thrown setting stack ".. serpent.line(entry))
+	local call_success, call_return = pcall(slot.set_stack, item_stack)
+	if not call_success then
+		print("Error: '" .. call_return .. "' thrown setting stack ".. serpent.line(entry))
 
-    elseif not call_return then
-        print("Error: Failed to set stack " .. serpent.line(entry))
+	elseif not call_return then
+		print("Error: Failed to set stack " .. serpent.line(entry))
 
-    else
-        if entry.l then
-            -- TODO test this with AAI's unit-remote-control
-            local label = entry.l
-            if label.t then slot.label = label.t end
-            if label.c then slot.label_color = label.c end
-            slot.allow_manual_label_change = label.a
-        end
-        if entry.g then
-            serialize.deserialize_equipment_grid(slot.grid, entry.g)
-        end
-        if entry.i then
-            local sub_inventory = slot.get_inventory(defines.inventory.item_main)
-            serialize.deserialize_inventory(sub_inventory, entry.i)
-        end
-    end
+	else
+		if entry.l then
+			-- TODO test this with AAI's unit-remote-control
+			local label = entry.l
+			if label.t then slot.label = label.t end
+			if label.c then slot.label_color = label.c end
+			slot.allow_manual_label_change = label.a
+		end
+		if entry.g then
+			if slot.grid then
+				serialize.deserialize_equipment_grid(slot.grid, entry.g)
+			elseif slot.type == "item-with-entity-data" and has_create_grid then
+				slot.create_grid()
+				serialize.deserialize_equipment_grid(slot.grid, entry.g)
+			else
+				print("Error: Attempt to deserialize equipment grid on an unsupported entity")
+			end
+		end
+		if entry.i then
+			local sub_inventory = slot.get_inventory(defines.inventory.item_main)
+			serialize.deserialize_inventory(sub_inventory, entry.i)
+		end
+	end
 end
 
 -- Inventories are serialized into a table with the following fields:
---   i: array of item stack or exportable item entries
---   b: bar position (optional)
+--	 i: array of item stack or exportable item entries
+--	 b: bar position (optional)
 -- Each item entry has the following fields
---   s: index (optional, equals to previous plus one if not present)
---   r: repeat count (optional)
---   f: slot filter (optional)
+--	 s: index (optional, equals to previous plus one if not present)
+--	 r: repeat count (optional)
+--	 f: slot filter (optional)
 -- Pluss all the fields for item stacks (see deserialize_item_stack)
 -- It's also possible that the slot is empty but has a slot filter.
 function serialize.serialize_inventory(inventory)
-    local serialized = {}
-    if inventory[supports_bar]() and inventory[get_bar]() <= #inventory then
-        serialized.b = inventory[get_bar]()
-    end
+	local serialized = {}
+	if inventory[supports_bar]() and inventory[get_bar]() <= #inventory then
+		serialized.b = inventory[get_bar]()
+	end
 
-    serialized.i = {}
-    local previous_index = 0
-    local previous_serialized = nil
-    for i = 1, #inventory do
-        local item = {}
-        local slot = inventory[i]
-        if inventory.supports_filters() then
-            item.f = inventory.get_filter(i)
-        end
+	serialized.i = {}
+	local previous_index = 0
+	local previous_serialized = nil
+	for i = 1, #inventory do
+		local item = {}
+		local slot = inventory[i]
+		if inventory.supports_filters() then
+			item.f = inventory.get_filter(i)
+		end
 
-        if slot.valid_for_read then
-            serialize.serialize_item_stack(slot, item)
-        end
+		if slot.valid_for_read then
+			serialize.serialize_item_stack(slot, item)
+		end
 
-        if item.n or item.f or item.e then
-            local item_serialized = game.table_to_json(item)
-            if item_serialized == previous_serialized then
-                local previous_item = serialized.i[#serialized.i]
-                previous_item.r = (previous_item.r or 0) + 1
-                previous_index = i
+		if item.n or item.f or item.e then
+			local item_serialized = game.table_to_json(item)
+			if item_serialized == previous_serialized then
+				local previous_item = serialized.i[#serialized.i]
+				previous_item.r = (previous_item.r or 0) + 1
+				previous_index = i
 
-            else
-                if i ~= previous_index + 1 then
-                    item.s = i
-                end
+			else
+				if i ~= previous_index + 1 then
+					item.s = i
+				end
 
-                previous_index = i
-                previous_serialized = item_serialized
-                table.insert(serialized.i, item)
-            end
+				previous_index = i
+				previous_serialized = item_serialized
+				table.insert(serialized.i, item)
+			end
 
-        else
-            -- Either an empty slot or serilization failed
-            previous_index = 0
-            previous_serialized = nil
-        end
-    end
+		else
+			-- Either an empty slot or serilization failed
+			previous_index = 0
+			previous_serialized = nil
+		end
+	end
 
-    return serialized
+	return serialized
 end
 
 function serialize.deserialize_inventory(inventory, serialized)
-    if serialized.b and inventory[supports_bar]() then
-        inventory[set_bar](serialized.b)
-    end
+	if serialized.b and inventory[supports_bar]() then
+		inventory[set_bar](serialized.b)
+	end
 
-    local last_slot_index = 0
-    for _, entry in ipairs(serialized.i) do
-        local base_index = entry.s or last_slot_index + 1
+	local last_slot_index = 0
+	for _, entry in ipairs(serialized.i) do
+		local base_index = entry.s or last_slot_index + 1
 
-        local repeat_count = entry.r or 0
-        for offset = 0, repeat_count do
-            -- XXX what if the inventory is smaller on this instance?
-            local index = base_index + offset
-            local slot = inventory[index]
-            if entry.f then
-                local call_success, call_return = pcall(inventory.set_filter, index, entry.f)
-                if not call_success then
-                    print("Error: '" .. call_return .. "' thrown setting filter " .. entry.f)
+		local repeat_count = entry.r or 0
+		for offset = 0, repeat_count do
+			local index = base_index + offset
+			if index > #inventory then
+				print("Error: Inventory index out of bounds deserializing inventory, voiding excess slots")
+				break
+			end
+			local slot = inventory[index]
+			if entry.f then
+				local call_success, call_return = pcall(inventory.set_filter, index, entry.f)
+				if not call_success then
+					print("Error: '" .. call_return .. "' thrown setting filter " .. entry.f)
 
-                elseif not call_return then
-                    print("Error: Failed to set filter " .. entry.f)
-                end
-            end
+				elseif not call_return then
+					print("Error: Failed to set filter " .. entry.f)
+				end
+			end
 
-            if entry.n or entry.e then
-                serialize.deserialize_item_stack(slot, entry)
-            end
-        end
-        last_slot_index = base_index + repeat_count
-    end
+			if entry.n or entry.e then
+				serialize.deserialize_item_stack(slot, entry)
+			end
+		end
+		last_slot_index = base_index + repeat_count
+	end
 end
 
 

packages/slave/package.json

@@ -3,7 +3,7 @@
   "description": "Implementation of Clusterio slave server",
   "author": "Hornwitser",
   "license": "MIT",
-  "version": "2.0.0-alpha.5",
+  "version": "2.0.0-alpha.13",
   "main": "slave.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -15,15 +15,16 @@
     "factorio"
   ],
   "engines": {
-    "node": ">=10.16 <11 || >= 12"
+    "node": ">=12"
   },
   "dependencies": {
-    "@clusterio/lib": "^2.0.0-alpha.5",
+    "@clusterio/lib": "^2.0.0-alpha.13",
     "fs-extra": "^8.1.0",
-    "phin": "^3.4.1",
+    "phin": "^3.5.1",
     "pidusage": "^2.0.18",
     "set-blocking": "^2.0.0",
     "winston": "^3.3.3",
+    "winston-daily-rotate-file": "^4.5.5",
     "yargs": "^14.2.0"
   },
   "publishConfig": {

packages/slave/src/InstanceConnection.js

@@ -0,0 +1,85 @@
+"use strict";
+const libLink = require("@clusterio/lib/link");
+const libPlugin = require("@clusterio/lib/plugin");
+const libErrors = require("@clusterio/lib/errors");
+
+
+class InstanceConnection extends libLink.Link {
+	constructor(connector, slave, instanceId) {
+		super("slave", "instance", connector);
+		this.slave = slave;
+		this.instanceId = instanceId;
+		this.plugins = new Map();
+		this.status = "stopped";
+		libLink.attachAllMessages(this);
+
+		for (let pluginInfo of slave.pluginInfos) {
+			libPlugin.attachPluginMessages(this, { info: pluginInfo });
+		}
+	}
+
+	async forwardRequestToMaster(message, request) {
+		return await request.send(this.slave, message.data);
+	}
+
+	async forwardRequestToInstance(message, request) {
+		let instanceId = message.data.instance_id;
+		let instanceConnection = this.slave.instanceConnections.get(instanceId);
+		if (!instanceConnection) {
+			// Instance is probably on another slave
+			return await this.forwardRequestToMaster(message, request);
+		}
+
+		if (request.plugin && !instanceConnection.plugins.has(request.plugin)) {
+			throw new libErrors.RequestError(`Instance ID ${instanceId} does not have ${request.plugin} plugin loaded`);
+		}
+
+		return await request.send(instanceConnection, message.data);
+	}
+
+
+	async forwardEventToInstance(message, event) {
+		let instanceId = message.data.instance_id;
+		let instanceConnection = this.slave.instanceConnections.get(instanceId);
+		if (!instanceConnection) {
+			// Instance is probably on another slave
+			await this.forwardEventToMaster(message, event);
+			return;
+		}
+		if (event.plugin && !instanceConnection.plugins.has(event.plugin)) { return; }
+
+		event.send(instanceConnection, message.data);
+	}
+
+	async forwardEventToMaster(message, event) {
+		if (!this.slave.connector.hasSession) {
+			return;
+		}
+
+		event.send(this.slave, message.data);
+	}
+
+	async broadcastEventToInstance(message, event) {
+		for (let instanceConnection of this.slave.instanceConnections.values()) {
+			// Do not broadcast back to the source
+			if (instanceConnection === this) { continue; }
+			if (event.plugin && !instanceConnection.plugins.has(event.plugin)) { continue; }
+
+			event.send(instanceConnection, message.data);
+		}
+	}
+
+	async instanceInitializedEventHandler(message, event) {
+		this.plugins = new Map(Object.entries(message.data.plugins));
+	}
+
+	async instanceStatusChangedEventHandler(message, event) {
+		this.status = message.data.status;
+		if (this.status === "stopped") {
+			this.slave.instanceConnections.delete(this.instanceId);
+		}
+		this.forwardEventToMaster(message, event);
+	}
+}
+
+module.exports = InstanceConnection;

packages/slave/src/Slave.js

@@ -0,0 +1,844 @@
+"use strict";
+const fs = require("fs-extra");
+const path = require("path");
+const yargs = require("yargs");
+const events = require("events");
+const pidusage = require("pidusage");
+const setBlocking = require("set-blocking");
+const phin = require("phin");
+const stream = require("stream");
+const util = require("util");
+
+// internal libraries
+const libFileOps = require("@clusterio/lib/file_ops");
+const libLink = require("@clusterio/lib/link");
+const libPlugin = require("@clusterio/lib/plugin");
+const libErrors = require("@clusterio/lib/errors");
+const libPrometheus = require("@clusterio/lib/prometheus");
+const libConfig = require("@clusterio/lib/config");
+const { logger } = require("@clusterio/lib/logging");
+const libHelpers = require("@clusterio/lib/helpers");
+
+const Instance = require("./Instance");
+const InstanceConnection = require("./InstanceConnection");
+
+const finished = util.promisify(stream.finished);
+
+
+function checkFilename(name) {
+	// All of these are bad in Windows only, except for /, . and ..
+	// See: https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
+	const badChars = /[<>:"\/\\|?*\x00-\x1f]/g;
+	const badEnd = /[. ]$/;
+
+	const oneToNine = [1, 2, 3, 4, 5, 6, 7, 8, 9];
+	const badNames = [
+		// Relative path components
+		".", "..",
+
+		// Reserved filenames in Windows
+		"CON", "PRN", "AUX", "NUL",
+		...oneToNine.map(n => `COM${n}`),
+		...oneToNine.map(n => `LPT${n}`),
+	];
+
+	if (typeof name !== "string") {
+		throw new Error("must be a string");
+	}
+
+	if (name === "") {
+		throw new Error("cannot be empty");
+	}
+
+	if (badChars.test(name)) {
+		throw new Error('cannot contain <>:"\\/|=* or control characters');
+	}
+
+	if (badNames.includes(name.toUpperCase())) {
+		throw new Error(
+			"cannot be named any of . .. CON PRN AUX NUL COM1-9 and LPT1-9"
+		);
+	}
+
+	if (badEnd.test(name)) {
+		throw new Error("cannot end with . or space");
+	}
+}
+
+/**
+ * Clean up string to be suitable for use as filename
+ *
+ * @param {string} name - Arbitrary name string
+ * @returns {string} Filename suitable to use in the filesystem
+ * @private
+ */
+function cleanFilename(name) {
+	// copied from checkFilename
+	const badChars = /[<>:"\/\\|?*\x00-\x1f]/g;
+	const badEnd = /[. ]$/;
+
+	const oneToNine = [1, 2, 3, 4, 5, 6, 7, 8, 9];
+	const badNames = [
+		// Relative path components
+		".", "..",
+
+		// Reserved filenames in Windows
+		"CON", "PRN", "AUX", "NUL",
+		...oneToNine.map(n => `COM${n}`),
+		...oneToNine.map(n => `LPT${n}`),
+	];
+
+	if (typeof name !== "string") {
+		throw new Error("name must be a string");
+	}
+
+	if (name === "" || badNames.includes(name.toUpperCase())) {
+		name += "_";
+	}
+
+	name = name.replace(badChars, "_");
+	name = name.replace(badEnd, "_");
+
+	return name;
+}
+
+function checkRequestSaveName(name) {
+	try {
+		checkFilename(name);
+	} catch (err) {
+		throw new libErrors.RequestError(`Save name ${err.message}`);
+	}
+}
+
+/**
+ * Searches for instances in the provided directory
+ *
+ * Looks through all sub-dirs of the provided directory for valid
+ * instance definitions and return a mapping of instance id to
+ * instanceInfo objects.
+ *
+ * @param {string} instancesDir - Directory containing instances
+ * @returns {Map<integer, Object>}
+ *     mapping between instance id and information about this instance.
+ * @private
+ */
+async function discoverInstances(instancesDir) {
+	let instanceInfos = new Map();
+	for (let entry of await fs.readdir(instancesDir, { withFileTypes: true })) {
+		if (entry.isDirectory()) {
+			let instanceConfig = new libConfig.InstanceConfig("slave");
+			let configPath = path.join(instancesDir, entry.name, "instance.json");
+
+			try {
+				await instanceConfig.load(JSON.parse(await fs.readFile(configPath)));
+
+			} catch (err) {
+				if (err.code === "ENOENT") {
+					continue; // Ignore folders without config.json
+				}
+
+				logger.error(`Error occured while parsing ${configPath}: ${err.message}`);
+				continue;
+			}
+
+			if (instanceInfos.has(instanceConfig.get("instance.id"))) {
+				logger.warn(`Ignoring instance with duplicate id in folder ${entry.name}`);
+				continue;
+			}
+
+			let instancePath = path.join(instancesDir, entry.name);
+			logger.verbose(`found instance ${instanceConfig.get("instance.name")} in ${instancePath}`);
+			instanceInfos.set(instanceConfig.get("instance.id"), {
+				path: instancePath,
+				config: instanceConfig,
+			});
+		}
+	}
+	return instanceInfos;
+}
+
+/**
+ * Handles running the slave
+ *
+ * Connects to the master server over the WebSocket and manages intsances.
+ * @alias module:slave/src/Slave
+ */
+class Slave extends libLink.Link {
+	// I don't like God classes, but the alternative of putting all this state
+	// into global variables is not much better.
+	constructor(connector, slaveConfig, tlsCa, pluginInfos) {
+		super("slave", "master", connector);
+		libLink.attachAllMessages(this);
+
+		this.pluginInfos = pluginInfos;
+		for (let pluginInfo of pluginInfos) {
+			libPlugin.attachPluginMessages(this, { info: pluginInfo });
+		}
+
+		this.config = slaveConfig;
+
+		/**
+		 * Certificate authority used to validate TLS connections to the master.
+		 * @type {?string}
+		 */
+		this.tlsCa = tlsCa;
+
+		this.instanceConnections = new Map();
+		this.discoveredInstanceInfos = new Map();
+		this.instanceInfos = new Map();
+
+		this.adminlist = new Set();
+		this.banlist = new Map();
+		this.whitelist = new Set();
+
+		this.connector.on("hello", data => {
+			this.serverVersion = data.version;
+			this.serverPlugins = new Map(Object.entries(data.plugins));
+		});
+
+		this._startup = true;
+		this._disconnecting = false;
+		this._shuttingDown = false;
+
+		this.connector.on("connect", () => {
+			if (this._shuttingDown) {
+				return;
+			}
+
+			this.updateInstances().catch((err) => {
+				if (err instanceof libErrors.SessionLost) {
+					return undefined;
+				}
+
+				logger.fatal(`Unexpected error updating instances:\n${err.stack}`);
+				return this.shutdown();
+			});
+		});
+
+		this.connector.on("close", () => {
+			if (this._shuttingDown) {
+				return;
+			}
+
+			if (this._disconnecting) {
+				this._disconnecting = false;
+				this.connector.connect().catch((err) => {
+					logger.fatal(`Unexpected error reconnecting to master:\n${err.stack}`);
+					return this.shutdown();
+				});
+
+			} else {
+				logger.fatal("Master connection was unexpectedly closed");
+				this.shutdown();
+			}
+		});
+
+		for (let event of ["connect", "drop", "resume", "close"]) {
+			this.connector.on(event, () => {
+				for (let instanceConnection of this.instanceConnections.values()) {
+					libLink.messages.masterConnectionEvent.send(instanceConnection, { event });
+				}
+			});
+		}
+	}
+
+	async _createNewInstanceDir(name) {
+		name = cleanFilename(name);
+		try {
+			checkFilename(name);
+		} catch (err) {
+			throw new Error(`Instance folder was unepectedly invalid: name ${err.message}`);
+		}
+
+		let instancesDir = this.config.get("slave.instances_directory");
+		for (let i = 0; i < 10; i++) { // Limit attempts in case this is somehow an infinite loop
+			let candidateDir = path.join(instancesDir, await libFileOps.findUnusedName(instancesDir, name));
+			try {
+				await fs.mkdir(candidateDir);
+			} catch (err) {
+				if (err.code === "EEXIST") {
+					continue;
+				}
+				throw err;
+			}
+			return candidateDir;
+		}
+		throw Error("Unable to create instance dir, retry threshold reached");
+	}
+
+	async forwardRequestToInstance(message, request) {
+		let instanceId = message.data.instance_id;
+		if (!this.instanceInfos.has(instanceId)) {
+			throw new libErrors.RequestError(`Instance with ID ${instanceId} does not exist`);
+		}
+
+		let instanceConnection = this.instanceConnections.get(instanceId);
+		if (!instanceConnection) {
+			throw new libErrors.RequestError(`Instance ID ${instanceId} is not running`);
+		}
+
+		if (request.plugin && !instanceConnection.plugins.has(request.plugin)) {
+			throw new libErrors.RequestError(`Instance ID ${instanceId} does not have ${request.plugin} plugin loaded`);
+		}
+
+		return await request.send(instanceConnection, message.data);
+	}
+
+	async forwardEventToInstance(message, event) {
+		let instanceId = message.data.instance_id;
+		if (!this.instanceInfos.has(instanceId)) { return; }
+
+		let instanceConnection = this.instanceConnections.get(instanceId);
+		if (!instanceConnection) { return; }
+		if (event.plugin && !instanceConnection.plugins.has(event.plugin)) { return; }
+
+		event.send(instanceConnection, message.data);
+	}
+
+	async broadcastEventToInstance(message, event) {
+		for (let instanceConnection of this.instanceConnections.values()) {
+			if (event.plugin && !instanceConnection.plugins.has(event.plugin)) { continue; }
+
+			event.send(instanceConnection, message.data);
+		}
+	}
+
+	async syncUserListsEventHandler(message) {
+		let updateList = (list, updatedList, prop, event) => {
+			let added = new Set(updatedList);
+			let removed = new Set(list);
+			list.forEach(el => added.delete(el));
+			updatedList.forEach(el => removed.delete(el));
+
+			for (let name of added) {
+				list.add(name);
+				this.broadcastEventToInstance(
+					{ data: { name, [prop]: true }}, event
+				);
+			}
+
+			for (let name of removed) {
+				list.delete(name);
+				this.broadcastEventToInstance(
+					{ data: { name, [prop]: false }}, event
+				);
+			}
+		};
+
+		updateList(this.adminlist, message.data.adminlist, "admin", libLink.messages.adminlistUpdate);
+		updateList(this.whitelist, message.data.whitelist, "whitelisted", libLink.messages.whitelistUpdate);
+
+		let addedOrChanged = new Map(message.data.banlist);
+		let removed = new Set(this.banlist.keys());
+		addedOrChanged.forEach((_, name) => removed.delete(name));
+		this.banlist.forEach((reason, name) => {
+			if (addedOrChanged.get(name) === reason) {
+				addedOrChanged.delete(name);
+			}
+		});
+
+		for (let [name, reason] of addedOrChanged) {
+			this.banlist.set(name, reason);
+			this.broadcastEventToInstance(
+				{ data: { name, banned: true, reason }}, libLink.messages.banlistUpdate
+			);
+		}
+
+		for (let name of removed) {
+			this.banlist.delete(name);
+			this.broadcastEventToInstance(
+				{ data: { name, banned: false, reason: "" }}, libLink.messages.banlistUpdate
+			);
+		}
+	}
+
+	async adminlistUpdateEventHandler(message) {
+		let { name, admin } = message.data;
+		if (admin) {
+			this.adminlist.add(name);
+		} else {
+			this.adminlist.delete(name);
+		}
+	}
+
+	async banlistUpdateEventHandler(message) {
+		let { name, banned, reason } = message.data;
+		if (banned) {
+			this.banlist.set(name, reason);
+		} else {
+			this.banlist.delete(name);
+		}
+	}
+
+	async whitelistUpdateEventHandler(message) {
+		let { name, whitelisted } = message.data;
+		if (whitelisted) {
+			this.whitelist.add(name);
+		} else {
+			this.whitelist.delete(name);
+		}
+	}
+
+	async assignInstanceRequestHandler(message) {
+		let { instance_id, serialized_config } = message.data;
+		let instanceInfo = this.instanceInfos.get(instance_id);
+		if (instanceInfo) {
+			instanceInfo.config.update(serialized_config, true, "master");
+			logger.verbose(`Updated config for ${instanceInfo.path}`);
+
+		} else {
+			instanceInfo = this.discoveredInstanceInfos.get(instance_id);
+			if (instanceInfo) {
+				instanceInfo.config.update(serialized_config, true, "master");
+
+			} else {
+				let instanceConfig = new libConfig.InstanceConfig("slave");
+				await instanceConfig.load(serialized_config, "master");
+
+				let instanceDir = await this._createNewInstanceDir(instanceConfig.get("instance.name"));
+
+				await Instance.create(instanceDir, this.config.get("slave.factorio_directory"));
+				instanceInfo = {
+					path: instanceDir,
+					config: instanceConfig,
+				};
+
+				this.discoveredInstanceInfos.set(instance_id, instanceInfo);
+			}
+
+			this.instanceInfos.set(instance_id, instanceInfo);
+			logger.verbose(`assigned instance ${instanceInfo.config.get("instance.name")}`);
+		}
+
+		// Somewhat hacky, but in the event of a lost session the status is
+		// resent on assigment since the master server sends an assigment
+		// request for all the instances it knows should be on this slave.
+		let instanceConnection = this.instanceConnections.get(instance_id);
+		libLink.messages.instanceStatusChanged.send(this, {
+			instance_id,
+			status: instanceConnection ? instanceConnection.status : "stopped",
+		});
+
+		// save a copy of the instance config
+		let warnedOutput = {
+			_warning: "Changes to this file will be overwritten by the master server's copy.",
+			...instanceInfo.config.serialize(),
+		};
+		await libFileOps.safeOutputFile(
+			path.join(instanceInfo.path, "instance.json"),
+			JSON.stringify(warnedOutput, null, 4)
+		);
+	}
+
+	async unassignInstanceRequestHandler(message) {
+		let instanceId = message.data.instance_id;
+		let instanceInfo = this.instanceInfos.get(instanceId);
+		if (instanceInfo) {
+			let instanceConnection = this.instanceConnections.get(instanceId);
+			if (instanceConnection && ["starting", "running"].includes(instanceConnection.status)) {
+				await libLink.messages.stopInstance.send(instanceConnection, { instance_id: instanceId });
+			}
+
+			this.instanceInfos.delete(instanceId);
+			logger.verbose(`unassigned instance ${instanceInfo.config.get("instance.name")}`);
+		}
+	}
+
+	getRequestInstanceInfo(instanceId) {
+		let instanceInfo = this.instanceInfos.get(instanceId);
+		if (!instanceInfo) {
+			throw new libErrors.RequestError(`Instance with ID ${instanceId} does not exist`);
+		}
+		return instanceInfo;
+	}
+
+	/**
+	 * Initialize and connect an unloaded instance
+	 *
+	 * @param {number} instanceId - ID of instance to initialize.
+	 * @returns {module:slave/slave~InstanceConnection} connection to instance.
+	 */
+	async _connectInstance(instanceId) {
+		let instanceInfo = this.getRequestInstanceInfo(instanceId);
+		if (this.instanceConnections.has(instanceId)) {
+			throw new libErrors.RequestError(`Instance with ID ${instanceId} is running`);
+		}
+
+		let [connectionClient, connectionServer] = libLink.VirtualConnector.makePair();
+		let instanceConnection = new InstanceConnection(connectionServer, this, instanceId);
+		let instance = new Instance(
+			this, connectionClient, instanceInfo.path, this.config.get("slave.factorio_directory"), instanceInfo.config
+		);
+
+		this.instanceConnections.set(instanceId, instanceConnection);
+		await instance.init(this.pluginInfos);
+
+		return instanceConnection;
+	}
+
+	async getMetricsRequestHandler() {
+		let requests = [];
+		for (let instanceConnection of this.instanceConnections.values()) {
+			requests.push(libLink.messages.getMetrics.send(instanceConnection));
+		}
+
+		let results = [];
+		for (let response of await Promise.all(requests)) {
+			results.push(...response.results);
+		}
+
+		for await (let result of libPrometheus.defaultRegistry.collect()) {
+			if (result.metric.name.startsWith("process_")) {
+				results.push(libPrometheus.serializeResult(result, {
+					addLabels: { "slave_id": String(this.config.get("slave.id")) },
+					metricName: result.metric.name.replace("process_", "clusterio_slave_"),
+				}));
+
+			} else {
+				results.push(libPrometheus.serializeResult(result));
+			}
+		}
+
+		return { results };
+	}
+
+	async startInstanceRequestHandler(message, request) {
+		let instanceId = message.data.instance_id;
+		let instanceConnection = await this._connectInstance(instanceId);
+		return await request.send(instanceConnection, message.data);
+	}
+
+	async loadScenarioRequestHandler(message, request) {
+		let instanceId = message.data.instance_id;
+		let instanceConnection = await this._connectInstance(instanceId);
+		return await request.send(instanceConnection, message.data);
+	}
+
+	async listSavesRequestHandler(message, request) {
+		let instanceId = message.data.instance_id;
+		let instanceConnection = this.instanceConnections.get(instanceId);
+		if (instanceConnection) {
+			return await request.send(instanceConnection, message.data);
+		}
+
+		let instanceInfo = this.getRequestInstanceInfo(instanceId);
+		return {
+			list: await Instance.listSaves(path.join(instanceInfo.path, "saves"), null),
+		};
+	}
+
+	async createSaveRequestHandler(message, request) {
+		let instanceId = message.data.instance_id;
+		let instanceConnection = await this._connectInstance(instanceId);
+		await request.send(instanceConnection, message.data);
+	}
+
+	async renameSaveRequestHandler(message) {
+		let { instance_id, old_name, new_name } = message.data;
+		checkRequestSaveName(old_name);
+		checkRequestSaveName(new_name);
+		let instanceInfo = this.getRequestInstanceInfo(instance_id);
+		try {
+			await fs.move(
+				path.join(instanceInfo.path, "saves", old_name),
+				path.join(instanceInfo.path, "saves", new_name),
+				{ overwrite: false },
+			);
+		} catch (err) {
+			if (err.code === "ENOENT") {
+				throw new libErrors.RequestError(`${old_name} does not exist`);
+			}
+			throw err;
+		}
+		await this.sendSaveListUpdate(instance_id, path.join(instanceInfo.path, "saves"));
+	}
+
+	async copySaveRequestHandler(message) {
+		let { instance_id, source, destination } = message.data;
+		checkRequestSaveName(source);
+		checkRequestSaveName(destination);
+		let instanceInfo = this.getRequestInstanceInfo(instance_id);
+		try {
+			await fs.copy(
+				path.join(instanceInfo.path, "saves", source),
+				path.join(instanceInfo.path, "saves", destination),
+				{ overwrite: false, errorOnExist: true },
+			);
+		} catch (err) {
+			if (err.code === "ENOENT") {
+				throw new libErrors.RequestError(`${old_name} does not exist`);
+			}
+			throw err;
+		}
+		await this.sendSaveListUpdate(instance_id, path.join(instanceInfo.path, "saves"));
+	}
+
+	async transferSaveRequestHandler(message) {
+		let { source_save, target_save, copy, instance_id, target_instance_id } = message.data;
+		checkRequestSaveName(source_save);
+		checkRequestSaveName(target_save);
+		let sourceInstanceInfo = this.getRequestInstanceInfo(instance_id);
+		let targetInstanceInfo = this.getRequestInstanceInfo(target_instance_id);
+
+		// For consistency with remote transfer initiated through pullSave the
+		// target is renamed if it already exists.
+		target_save = await libFileOps.findUnusedName(
+			path.join(targetInstanceInfo.path, "saves"), target_save, ".zip"
+		);
+
+		try {
+			if (copy) {
+				await fs.copy(
+					path.join(sourceInstanceInfo.path, "saves", source_save),
+					path.join(targetInstanceInfo.path, "saves", target_save),
+					{ overwrite: true },
+				);
+			} else {
+				await fs.move(
+					path.join(sourceInstanceInfo.path, "saves", source_save),
+					path.join(targetInstanceInfo.path, "saves", target_save),
+					{ overwrite: true },
+				);
+			}
+		} catch (err) {
+			if (err.code === "ENOENT") {
+				throw new libErrors.RequestError(`${source_save} does not exist`);
+			}
+			throw err;
+		}
+		await this.sendSaveListUpdate(instance_id, path.join(sourceInstanceInfo.path, "saves"));
+		await this.sendSaveListUpdate(target_instance_id, path.join(targetInstanceInfo.path, "saves"));
+
+		return { save: target_save };
+	}
+
+	async sendSaveListUpdate(instance_id, savesDir) {
+		let instanceConnection = this.instanceConnections.get(instance_id);
+		let saveList;
+		if (instanceConnection) {
+			saveList = (await libLink.messages.listSaves.send(instanceConnection, { instance_id })).list;
+		} else {
+			saveList = await Instance.listSaves(savesDir, null);
+		}
+
+		libLink.messages.saveListUpdate.send(this, { instance_id, list: saveList });
+	}
+
+	async deleteSaveRequestHandler(message) {
+		let { instance_id, save } = message.data;
+		checkRequestSaveName(save);
+		let instanceInfo = this.getRequestInstanceInfo(instance_id);
+
+		try {
+			await fs.unlink(path.join(instanceInfo.path, "saves", save));
+		} catch (err) {
+			if (err.code === "ENOENT") {
+				throw new libErrors.RequestError(`${save} does not exist`);
+			}
+			throw err;
+		}
+		await this.sendSaveListUpdate(instance_id, path.join(instanceInfo.path, "saves"));
+	}
+
+	async pullSaveRequestHandler(message) {
+		let { instance_id, stream_id, filename } = message.data;
+		checkRequestSaveName(filename);
+		let instanceInfo = this.getRequestInstanceInfo(instance_id);
+
+		let url = new URL(this.config.get("slave.master_url"));
+		url.pathname += `api/stream/${stream_id}`;
+		let response = await phin({
+			url, method: "GET",
+			core: { ca: this.tlsCa },
+			stream: true,
+		});
+
+		if (response.statusCode !== 200) {
+			let content = await libHelpers.readStream(response);
+			throw new libErrors.RequestError(`Stream returned ${response.statusCode}: ${content.toString()}`);
+		}
+
+		let savesDir = path.join(instanceInfo.path, "saves");
+		let tempFilename = filename.replace(/(\.zip)?$/, ".tmp.zip");
+		let writeStream;
+		while (true) {
+			try {
+				writeStream = fs.createWriteStream(path.join(savesDir, tempFilename), { flags: "wx" });
+				await events.once(writeStream, "open");
+				break;
+			} catch (err) {
+				if (err.code === "EEXIST") {
+					tempFilename = await libFileOps.findUnusedName(savesDir, tempFilename, ".tmp.zip");
+				} else {
+					throw err;
+				}
+			}
+		}
+		response.pipe(writeStream);
+		await finished(writeStream);
+
+		filename = await libFileOps.findUnusedName(savesDir, filename, ".zip");
+		await fs.rename(path.join(savesDir, tempFilename), path.join(savesDir, filename));
+
+		await this.sendSaveListUpdate(instance_id, savesDir);
+		return { save: filename };
+	}
+
+	async pushSaveRequestHandler(message) {
+		let { instance_id, stream_id, save } = message.data;
+		checkRequestSaveName(save);
+		let instanceInfo = this.getRequestInstanceInfo(instance_id);
+
+		let content;
+		try {
+			// phin doesn't support streaming requests :(
+			content = await fs.readFile(path.join(instanceInfo.path, "saves", save));
+		} catch (err) {
+			if (err.code === "ENOENT") {
+				throw new libErrors.RequestError(`${save} does not exist`);
+			}
+			throw err;
+		}
+
+		let url = new URL(this.config.get("slave.master_url"));
+		url.pathname += `api/stream/${stream_id}`;
+		phin({
+			url, method: "PUT",
+			core: { ca: this.tlsCa },
+			data: content,
+		}).catch(err => logger.error(`Error pushing save to master:\n${err.stack}`));
+	}
+
+	async exportDataRequestHandler(message, request) {
+		let instanceId = message.data.instance_id;
+		let instanceConnection = await this._connectInstance(instanceId);
+		await request.send(instanceConnection, message.data);
+	}
+
+	async stopInstance(instanceId) {
+		let instanceConnection = this.instanceConnections.get(instanceId);
+		await libLink.messages.stopInstance.send(instanceConnection, { instance_id: instanceId });
+	}
+
+	async deleteInstanceRequestHandler(message) {
+		let instanceId = message.data.instance_id;
+		if (this.instanceConnections.has(instanceId)) {
+			throw new libErrors.RequestError(`Instance with ID ${instanceId} is running`);
+		}
+
+		let instanceInfo = this.discoveredInstanceInfos.get(instanceId);
+		if (!instanceInfo) {
+			throw new libErrors.RequestError(`Instance with ID ${instanceId} does not exist`);
+		}
+
+		this.discoveredInstanceInfos.delete(instanceId);
+		this.instanceInfos.delete(instanceId);
+		await fs.remove(instanceInfo.path);
+	}
+
+	/**
+	 * Discover available instances
+	 *
+	 * Looks through the instances directory for instances and updates
+	 * the slave and master server with the new list of instances.
+	 */
+	async updateInstances() {
+		this.discoveredInstanceInfos = await discoverInstances(this.config.get("slave.instances_directory"));
+		let list = [];
+		for (let [instanceId, instanceInfo] of this.discoveredInstanceInfos) {
+			let instanceConnection = this.instanceConnections.get(instanceId);
+			list.push({
+				serialized_config: instanceInfo.config.serialize("master"),
+				status: instanceConnection ? instanceConnection.status : "stopped",
+			});
+		}
+		await libLink.messages.updateInstances.send(this, { instances: list });
+
+		// Handle configured auto startup instances
+		if (this._startup) {
+			this._startup = false;
+
+			for (let [instanceId, instanceInfo] of this.instanceInfos) {
+				if (instanceInfo.config.get("instance.auto_start")) {
+					try {
+						let instanceConnection = await this._connectInstance(instanceId);
+						await libLink.messages.startInstance.send(instanceConnection, {
+							instance_id: instanceId,
+							save: null,
+						});
+					} catch (err) {
+						logger.error(
+							`Error during auto startup for ${instanceInfo.config.get("instance.name")}:\n${err.stack}`
+						);
+					}
+				}
+			}
+		}
+	}
+
+	async prepareDisconnectRequestHandler(message, request) {
+		for (let instanceConnection of this.instanceConnections.values()) {
+			await libLink.messages.prepareMasterDisconnect.send(instanceConnection);
+		}
+		this._disconnecting = true;
+		this.connector.setClosing();
+		return await super.prepareDisconnectRequestHandler(message, request);
+	}
+
+	/**
+	 * Stops all instances and closes the connection
+	 */
+	async shutdown() {
+		if (this._shuttingDown) {
+			return;
+		}
+		this._shuttingDown = true;
+
+		try {
+			await libLink.messages.prepareDisconnect.send(this);
+		} catch (err) {
+			if (!(err instanceof libErrors.SessionLost)) {
+				logger.error(`Unexpected error preparing disconnect:\n${err.stack}`);
+			}
+		}
+
+		try {
+			for (let instanceId of this.instanceConnections.keys()) {
+				await this.stopInstance(instanceId);
+			}
+			await this.connector.close(1000, "Slave Shutdown");
+
+			// Clear silly interval in pidfile library.
+			pidusage.clear();
+		} catch (err) {
+			setBlocking(true);
+			logger.error(`
++------------------------------------------------------------+
+| Unexpected error occured while shutting down slave, please |
+| report it to https://github.com/clusterio/clusterio/issues |
++------------------------------------------------------------+
+${err.stack}`
+			);
+			// eslint-disable-next-line node/no-process-exit
+			process.exit(1);
+		}
+	}
+
+	/**
+	 * True if the connection to the master is connected, not in the dropped
+	 * state,and not in the process of disconnecting.
+	 * @type {boolean}
+	 */
+	get connected() {
+		return !this._disconnecting && this.connector.connected;
+	}
+}
+
+module.exports = Slave;
+
+// For testing only
+module.exports._checkFilename = checkFilename;
+module.exports._cleanFilename = cleanFilename;
+module.exports._discoverInstances = discoverInstances;
+module.exports._Slave = Slave;
+

packages/web_ui/package.json

@@ -3,7 +3,7 @@
   "description": "Clusterio web interface implementation",
   "author": "Hornwitser",
   "license": "MIT",
-  "version": "2.0.0-alpha.5",
+  "version": "2.0.0-alpha.13",
   "browser": "src/index.jsx",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -12,15 +12,17 @@
     "clusterio"
   ],
   "engines": {
-    "node": ">=10.16 <11 || >= 12"
+    "node": ">=12"
   },
   "dependencies": {
     "@ant-design/icons": "^4.2.2",
     "@babel/core": "^7.13.8",
     "@babel/preset-react": "^7.12.13",
-    "@clusterio/lib": "^2.0.0-alpha.5",
-    "antd": "^4.6.5",
+    "@clusterio/lib": "^2.0.0-alpha.13",
+    "antd": "^4.16.0",
+    "assert": "^2.0.0",
     "babel-loader": "^8.2.2",
+    "browserify-zlib": "^0.2.0",
     "buffer": "^6.0.2",
     "clean-webpack-plugin": "^3.0.0",
     "css-loader": "^5.1.0",
@@ -33,8 +35,12 @@
     "react": "^16.13.1",
     "react-dom": "^16.13.1",
     "react-router-dom": "^5.2.0",
+    "stream-browserify": "^3.0.0",
     "style-loader": "^2.0.0",
-    "util": "^0.12.3"
+    "util": "^0.12.3",
+    "webpack": "^5.73.0",
+    "webpack-cli": "^4.9.2",
+    "webpack-manifest-plugin": "^5.0.0"
   },
   "publishConfig": {
     "access": "public"