Compare commits

...
Author SHA1 Message Date
Hornwitser 93fa12200f Fix installer asking for remoteNpm even when given 2025-10-18 18:43:55 +02:00
Hornwitser 35f769ad25 Release hotfix of installer 2025-10-18 18:27:41 +02:00
Cooldude2606 681e78967f Webpack Build Improvements (#791)
* Bump @swc/core to 1.13.3

* Switch to using --mode production rather than --env

Closes #792

* Add cache
2025-08-17 15:54:37 +01:00
Daniel d2bd1382ba Filtered subscriptions (#788)
* Add filtered subscriptions

* Add tests for subscription filters

* Stricter assertions

* Un-nest if statements
2025-08-13 11:55:49 +01:00
Daniel c0ec9a3890 Send inventory on interval instead of event to ensure time gets updated (#790)
This means inventory updates in low-volume clusters might be delayed up to 1 second more, but ensures we always have the unix time signal available, even in clusters that don't have anything in the inventory yet. Resolves #610
2025-08-10 22:25:32 +01:00
Daniel 4221b96431 Fix rendered more hooks error when refreshing hosts page (#789)
* Fix rendered more hooks error when refreshing hosts page

* Fix conditional render on controllerPage

Doesn't cause any issues that I know off right now, but changes to antd internal code could change that so it feels better to be sure.
2025-08-10 22:17:14 +01:00
Daniel 3ddbe2ddb3 Merge pull request #787 from Cooldude2606/fix/plugin-template
Plugin templates no longer depend on a dev install of Clusterio
2025-08-10 21:20:24 +02:00
Cooldude2606 7ceb786143 Add onExit to instance template 2025-08-08 21:41:49 +01:00
Cooldude2606 174d9d5b07 Bug Fixes 2025-08-07 19:14:23 +01:00
Cooldude2606 a1118d08dd Add ^ to clusterio version 2025-08-07 17:44:55 +01:00
Cooldude2606 379d2575a0 Improve comments 2025-08-07 17:42:52 +01:00
Cooldude2606 e30dcc6fff Fix tsconfigs 2025-08-07 17:32:54 +01:00
Cooldude2606 281a5ed97e Update common files 2025-08-07 13:17:41 +01:00
Daniel 6004f861fe Merge pull request #783 from clusterio/cursor/configure-master-listen-address-53c7
Exclude instance from "start all" function
2025-08-04 20:50:47 +02:00
Danielv123 174c798d4b Run integration test instead of unit test 2025-08-04 18:46:13 +00:00
Danielv123 14b8b5ac61 ctl instance stop-all test 2025-08-04 18:28:25 +00:00
Danielv123 89dec572bb Add test for ctl instance start-all 2025-08-04 18:10:48 +00:00
Danielv123 f662880c8d Fix zlib update breaking our types 2025-08-04 17:36:18 +00:00
Danielv123 90cd2770b3 Add start-all command to cli 2025-08-04 17:36:18 +00:00
Cursor Agentanddanielv 69240e7917 Add option to exclude instances from bulk start operation
Co-authored-by: danielv <danielv@danielv.no>
2025-08-04 17:36:18 +00:00
Daniel e1d9c1e414 Merge pull request #785 from clusterio/dependency-updates
Update dependencies
2025-08-04 19:03:49 +02:00
Danielv123 376eaeba52 Revert save writing delay during tests 2025-08-04 16:28:35 +00:00
Danielv123 80983662aa Wait for promise to resolve before returning 2025-08-04 16:14:07 +00:00
Danielv123 9840f22688 Wait for savefile to be moved 2025-08-04 15:36:27 +00:00
Danielv123 b9e2acaaa5 eslint needs to be ecmascript module 2025-08-01 23:29:41 +00:00
Danielv123 7ac8cd3781 Fix mocha arguments leaking into yargs parser 2025-08-01 23:26:47 +00:00
Danielv123 7e2f10e842 Fix linting issues with new rules 2025-08-01 22:26:25 +00:00
Danielv123 256407b9fd Update eslint config file for eslint 9 2025-08-01 22:26:07 +00:00
Danielv123 7979dfaa16 Fix missing import 2025-08-01 21:25:13 +00:00
Danielv123 10a87d47da Convert ArrayBufferLike to Buffer 2025-08-01 21:19:58 +00:00
Danielv123 59709280da Update dependencies in package.json 2025-08-01 21:12:46 +00:00
Daniel 81b656f0ab Merge pull request #782 from clusterio/cursor/implement-factorio-1-1-support-a0fd
Online player list on instance page
2025-08-01 21:59:34 +02:00
Daniel f966c5b965 Merge pull request #780 from Cooldude2606/feature/instance-restart
Add instance restart
2025-07-31 00:18:41 +02:00
Danielv123 56a26848e6 Paginate users on instance page, better search ux 2025-07-31 00:13:02 +02:00
Cooldude2606 28f21bfb70 Fix mutating actions prop 2025-07-30 16:16:29 +01:00
Danielv123 7b4724845f Fix linter error 2025-07-24 22:36:24 +02:00
Danielv123 2053423864 Add proper filters 2025-07-23 15:00:51 +02:00
Danielv123 e7519975ec Use same component for all user tables 2025-07-23 14:21:33 +02:00
Cursor Agentanddanielv 7b7389526b Add online players list component to instance view page
Co-authored-by: danielv <danielv@danielv.no>
2025-07-21 17:41:13 +00:00
Cooldude2606 a464b61d39 Remove redundant status check 2025-07-16 01:41:23 +01:00
Cooldude2606 88ca4563a8 Add tests 2025-07-16 01:25:27 +01:00
Cooldude2606 449bd68fab Add instance restart to ctl 2025-07-16 00:06:44 +01:00
Cooldude2606 59256e77d1 Make the control buttons consistent 2025-07-15 00:49:33 +01:00
Cooldude2606 f11d91bd6b Add missing space to instances and users list 2025-07-14 22:38:06 +01:00
Cooldude2606 e0278d0331 Add instance restart button 2025-07-14 22:34:41 +01:00
Cooldude2606 2baa2e50ac Add InstanceRestartRequest 2025-07-14 21:48:12 +01:00
Daniel 02d14bd98d Merge pull request #778 from Cooldude2606/refactor/test-exec-ctl
Refactor execCtl and Ctl to speed up unit testing
2025-07-10 13:09:27 +02:00
Daniel 952ae21958 Merge pull request #777 from Cooldude2606/refactor/user-datastore
Refactor roles to use datastore and subscriptions
2025-07-10 13:02:38 +02:00
Cooldude2606 50d7d28054 Fix expected error messages for assert rejects 2025-07-06 23:17:52 +01:00
Cooldude2606 2896ec1c15 Add initializeCtl and control reuse in tests 2025-07-06 22:58:39 +01:00
Cooldude2606 6b81e6383d Fix usage of assert.rejects 2025-07-06 22:53:39 +01:00
Cooldude2606 5ed7163ed8 Add missing await statement
Fixes #774
2025-06-14 23:05:14 +01:00
Cooldude2606 df1edec623 Add role subscriptions and data model 2025-06-14 00:28:03 +01:00
Cooldude2606 a5bf8d92d9 Separate roles to their own file 2025-06-13 22:24:56 +01:00
Cooldude2606 af95ca587b Fix datastore types 2025-06-13 22:24:44 +01:00
Cooldude2606 331fc7d947 Add types to event emitters and clean up connections (#772)
* Event types for controller

* Clean up ctl event emitters

* Event types for server

* Event types for lib

* Remove TypedEventEmitter

* Event types for webui

* Fix compile issues

* Small cleanup of connectors
2025-06-13 22:20:50 +01:00
129 changed files with 2566 additions and 3019 deletions

No files matched your search

-1
View File
@@ -1 +0,0 @@
dist/
+4 -1
View File
@@ -47,6 +47,9 @@ async function removeBuildArtifacts() {
tasks.push( tasks.push(
tryRemove(path.join(basePath, packageName, "dist")) tryRemove(path.join(basePath, packageName, "dist"))
); );
tasks.push(
tryRemove(path.join(basePath, packageName, "node_modules", ".cache"))
);
} }
} }
@@ -81,7 +84,7 @@ async function removeExecutionArtifacts() {
* Main function for this script * Main function for this script
*/ */
async function main() { async function main() {
await yargs await yargs(process.argv.slice(2))
.scriptName("clean") .scriptName("clean")
.usage("$0 <command> [options]") .usage("$0 <command> [options]")
.option("dry", { .option("dry", {
+8
View File
@@ -239,6 +239,14 @@ Does not affect start or stop of the instance while the host is running.
Defaults to false. Defaults to false.
### instance.exclude_from_start_all
If enabled this instance will be excluded from the "Start all" button operation in the web interface.
This allows you to prevent certain instances from being started when using the bulk start operation.
Defaults to false.
### factorio.version ### factorio.version
Version of Factorio to use for this instance. Version of Factorio to use for this instance.
+275 -186
View File
@@ -1,118 +1,47 @@
"use strict"; import {
module.exports = { defineConfig,
"plugins": [ globalIgnores,
"@typescript-eslint", } from "eslint/config";
"node",
], import typescriptEslint from "@typescript-eslint/eslint-plugin";
"root": true, import node from "eslint-plugin-node";
"env": { import globals from "globals";
"node": true, import tsParser from "@typescript-eslint/parser";
"commonjs": true, import js from "@eslint/js";
"es2022": true, import stylistic from "@stylistic/eslint-plugin";
import {
FlatCompat,
} from "@eslint/eslintrc";
const compat = new FlatCompat({
baseDirectory: import.meta.dirname,
recommendedConfig: js.configs.recommended,
allConfig: js.configs.all,
});
export default defineConfig([{
plugins: {
"@typescript-eslint": typescriptEslint,
"@stylistic": stylistic,
node,
}, },
"overrides": [ languageOptions: {
{ globals: {
"files": ["{packages,plugins}/**/*.ts?(x)"], ...globals.node,
"parser": "@typescript-eslint/parser", ...globals.commonjs,
"extends": [
"plugin:@typescript-eslint/recommended",
],
"rules": {
"@typescript-eslint/no-explicit-any": "off",
"@typescript-eslint/no-useless-constructor": "error",
"@typescript-eslint/no-unused-vars": "off",
"@typescript-eslint/triple-slash-reference": "off",
"@typescript-eslint/no-shadow": ["error", { "allow": ["Event", "Request", "yargs"] }],
"prefer-const": "off",
"no-shadow": "off",
},
}, },
{ },
"files": ["test/**/*.js", "plugins/*/test/**/*.js"],
"env": {
"mocha": "true",
},
"parserOptions": { sourceType: "commonjs" },
"rules": {
"prefer-arrow-callback": "off",
"no-invalid-this": "off",
"valid-jsdoc": "off",
"node/no-unpublished-import": "off",
"node/no-unpublished-require": "off",
},
},
{
"files": [
"packages/web_ui/src/**/*.ts?(x)",
"packages/lib/browser.ts",
"packages/create/templates/*/web/**/*.{t,j}s?(x)",
"{packages,plugins}/*/web/**/*.ts?(x)",
],
"env": {
"browser": true,
},
"parserOptions": {
"sourceType": "module",
"ecmaFeatures": {
"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",
},
},
{
"files": [
"packages/create/templates/**/*.{t,j}s?(x)",
],
"rules": {
"node/no-missing-require": "off",
"node/no-missing-import": "off",
"spaced-comment": "off",
"comma-spacing": "off",
"max-len": "off",
"indent": "off",
},
},
],
"rules": { "rules": {
"@stylistic/indent": ["error", "tab", {
"ignoredNodes": [
"JSXFragment", // TODO: Linter crashes if this is removed
],
"ignoreComments": true,
"SwitchCase": 1, // Indent case statements one level from switch
}],
"accessor-pairs": "error", "accessor-pairs": "error",
"array-bracket-newline": "off", "array-bracket-newline": "off",
"array-bracket-spacing": ["error", "never"], "array-bracket-spacing": ["error", "never"],
@@ -120,26 +49,34 @@ module.exports = {
"array-element-newline": "off", "array-element-newline": "off",
"arrow-body-style": "error", "arrow-body-style": "error",
"arrow-parens": "off", "arrow-parens": "off",
"arrow-spacing": ["error", { "after": true, "before": true }],
"arrow-spacing": ["error", {
"after": true,
"before": true,
}],
"block-scoped-var": "error", "block-scoped-var": "error",
"block-spacing": "error", "block-spacing": "error",
"brace-style": ["error", "1tbs", { "allowSingleLine": true }],
"brace-style": ["error", "1tbs", {
"allowSingleLine": true,
}],
"camelcase": "off", "camelcase": "off",
"capitalized-comments": "off", "capitalized-comments": "off",
"class-methods-use-this": "off", "class-methods-use-this": "off",
"comma-dangle": [
"error", "comma-dangle": ["error", {
{ "arrays": "always-multiline",
"arrays": "always-multiline", "objects": "always-multiline",
"objects": "always-multiline", "imports": "always-multiline",
"imports": "always-multiline", "exports": "always-multiline",
"exports": "always-multiline", "functions": "only-multiline",
"functions": "only-multiline", }],
},
],
"comma-spacing": "error", "comma-spacing": "error",
"comma-style": ["error", "last"], "comma-style": ["error", "last"],
"complexity": "error", "complexity": ["error", { "max": 25 }],
"computed-property-spacing": ["error", "never"], "computed-property-spacing": ["error", "never"],
"consistent-return": "error", "consistent-return": "error",
"consistent-this": "error", "consistent-this": "error",
@@ -148,27 +85,36 @@ module.exports = {
"default-case-last": "error", "default-case-last": "error",
"default-param-last": "off", "default-param-last": "off",
"dot-location": ["error", "property"], "dot-location": ["error", "property"],
"dot-notation": ["error", { "allowPattern": "^[a-z]+(_[a-z]+)*$" }],
"dot-notation": ["error", {
"allowPattern": "^[a-z]+(_[a-z]+)*$",
}],
"eol-last": "error", "eol-last": "error",
"eqeqeq": "error", "eqeqeq": "error",
"func-call-spacing": "error", "func-call-spacing": "error",
"func-name-matching": "error", "func-name-matching": "error",
"func-names": "off", "func-names": "off",
"func-style": ["error", "declaration", { "func-style": ["error", "declaration", {
// Allow arrow functions as it better expresses referencing this
// of the containing scope, which is unweilding in plain functions.
"allowArrowFunctions": true, "allowArrowFunctions": true,
}], }],
"function-call-argument-newline": "off", "function-call-argument-newline": "off",
"function-paren-newline": "off", "function-paren-newline": "off",
"generator-star-spacing": ["error", { "before": false, "after": true }],
"generator-star-spacing": ["error", {
"before": false,
"after": true,
}],
"grouped-accessor-pairs": "error", "grouped-accessor-pairs": "error",
"guard-for-in": "error", "guard-for-in": "error",
"id-blacklist": "error", "id-blacklist": "error",
"id-length": "off", "id-length": "off",
"id-match": "error", "id-match": "error",
"implicit-arrow-linebreak": "error", "implicit-arrow-linebreak": "error",
"indent": ["error", "tab", { "SwitchCase": 1 }],
"indent-legacy": "off", "indent-legacy": "off",
"init-declarations": "off", "init-declarations": "off",
"jsx-quotes": "error", "jsx-quotes": "error",
@@ -178,10 +124,18 @@ module.exports = {
"linebreak-style": ["error", "unix"], "linebreak-style": ["error", "unix"],
"lines-around-comment": "off", "lines-around-comment": "off",
"lines-around-directive": "off", "lines-around-directive": "off",
"lines-between-class-members": ["error", "always", { "exceptAfterSingleLine": true }],
"lines-between-class-members": ["error", "always", {
"exceptAfterSingleLine": true,
}],
"max-classes-per-file": "off", "max-classes-per-file": "off",
"max-depth": "error", "max-depth": "error",
"max-len": ["error", { "code": 120 }],
"max-len": ["error", {
"code": 120,
}],
"max-lines": "off", "max-lines": "off",
"max-lines-per-function": "off", "max-lines-per-function": "off",
"max-nested-callbacks": "error", "max-nested-callbacks": "error",
@@ -190,10 +144,12 @@ module.exports = {
"max-statements-per-line": "off", "max-statements-per-line": "off",
"multiline-comment-style": ["error", "separate-lines"], "multiline-comment-style": ["error", "separate-lines"],
"multiline-ternary": "off", "multiline-ternary": "off",
"new-cap": ["error", { "new-cap": ["error", {
"capIsNewExceptions": ["StringEnum", "StringKey"], "capIsNewExceptions": ["StringEnum", "StringKey"],
"capIsNewExceptionPattern": "^Type\\.", "capIsNewExceptionPattern": "^Type\\.",
}], }],
"new-parens": "error", "new-parens": "error",
"newline-after-var": "off", "newline-after-var": "off",
"newline-before-return": "off", "newline-before-return": "off",
@@ -207,7 +163,11 @@ module.exports = {
"no-catch-shadow": "off", "no-catch-shadow": "off",
"no-confusing-arrow": "error", "no-confusing-arrow": "error",
"no-console": "error", "no-console": "error",
"no-constant-condition": ["error", { "checkLoops": false }],
"no-constant-condition": ["error", {
"checkLoops": false,
}],
"no-constructor-return": "error", "no-constructor-return": "error",
"no-continue": "off", "no-continue": "off",
"no-div-regex": "error", "no-div-regex": "error",
@@ -232,16 +192,15 @@ module.exports = {
"no-lonely-if": "error", "no-lonely-if": "error",
"no-loop-func": "error", "no-loop-func": "error",
"no-magic-numbers": "off", "no-magic-numbers": "off",
"no-mixed-operators": [
"error", "no-mixed-operators": ["error", {
{ "groups": [
"groups": [ ["&", "|", "^", "~", "<<", ">>", ">>>"],
["&", "|", "^", "~", "<<", ">>", ">>>"], ["==", "!=", "===", "!==", ">", ">=", "<", "<="],
["==", "!=", "===", "!==", ">", ">=", "<", "<="], ["in", "instanceof"],
["in", "instanceof"], ],
], }],
},
],
"no-multi-assign": "error", "no-multi-assign": "error",
"no-multi-spaces": "error", "no-multi-spaces": "error",
"no-multi-str": "error", "no-multi-str": "error",
@@ -256,7 +215,11 @@ module.exports = {
"no-new-wrappers": "error", "no-new-wrappers": "error",
"no-octal-escape": "error", "no-octal-escape": "error",
"no-param-reassign": "off", "no-param-reassign": "off",
"no-plusplus": ["error", { "allowForLoopAfterthoughts": true }],
"no-plusplus": ["error", {
"allowForLoopAfterthoughts": true,
}],
"no-proto": "error", "no-proto": "error",
"no-restricted-exports": "error", "no-restricted-exports": "error",
"no-restricted-globals": "error", "no-restricted-globals": "error",
@@ -268,9 +231,15 @@ module.exports = {
"no-script-url": "error", "no-script-url": "error",
"no-self-compare": "error", "no-self-compare": "error",
"no-sequences": "error", "no-sequences": "error",
"no-shadow": ["error", { "allow": ["Event", "Request", "yargs"] }],
"no-shadow": ["error", {
"allow": ["Event", "Request", "yargs"],
}],
"no-spaced-func": "error", "no-spaced-func": "error",
"no-tabs": ["error", { "allowIndentationTabs": true }],
"no-tabs": "off",
"no-template-curly-in-string": "error", "no-template-curly-in-string": "error",
"no-ternary": "off", "no-ternary": "off",
"no-throw-literal": "error", "no-throw-literal": "error",
@@ -289,7 +258,11 @@ module.exports = {
"no-useless-rename": "error", "no-useless-rename": "error",
"no-useless-return": "error", "no-useless-return": "error",
"no-var": "error", "no-var": "error",
"no-void": ["error", { "allowAsStatement": true }],
"no-void": ["error", {
"allowAsStatement": true,
}],
"no-warning-comments": "off", "no-warning-comments": "off",
"no-whitespace-before-property": "error", "no-whitespace-before-property": "error",
"nonblock-statement-body-position": "error", "nonblock-statement-body-position": "error",
@@ -299,6 +272,7 @@ module.exports = {
"one-var": "off", "one-var": "off",
"one-var-declaration-per-line": "error", "one-var-declaration-per-line": "error",
"operator-assignment": "off", "operator-assignment": "off",
"operator-linebreak": ["error", "after", { "operator-linebreak": ["error", "after", {
"overrides": { "overrides": {
"?": "before", "?": "before",
@@ -308,6 +282,7 @@ module.exports = {
"??": "before", "??": "before",
}, },
}], }],
"padded-blocks": "off", "padded-blocks": "off",
"padding-line-between-statements": "error", "padding-line-between-statements": "error",
"prefer-arrow-callback": "error", "prefer-arrow-callback": "error",
@@ -324,9 +299,13 @@ module.exports = {
"prefer-spread": "error", "prefer-spread": "error",
"prefer-template": "error", "prefer-template": "error",
"quote-props": "off", "quote-props": "off",
"quotes": ["error", "double", { "avoidEscape": true }],
"quotes": ["error", "double", {
"avoidEscape": true,
}],
"radix": ["error", "always"], "radix": ["error", "always"],
"require-atomic-updates": "off", // XXX Not sure why this triggers on process.title = ... "require-atomic-updates": "off",
"require-await": "off", "require-await": "off",
"require-jsdoc": "off", "require-jsdoc": "off",
"require-unicode-regexp": "off", "require-unicode-regexp": "off",
@@ -342,73 +321,183 @@ module.exports = {
"space-in-parens": ["error", "never"], "space-in-parens": ["error", "never"],
"space-infix-ops": "off", "space-infix-ops": "off",
"space-unary-ops": "error", "space-unary-ops": "error",
"spaced-comment": ["error", "always", { "spaced-comment": ["error", "always", {
"line": { "line": {
"markers": ["/"], "markers": ["/"],
}, },
}], }],
"strict": "error",
"switch-colon-spacing": "error", "switch-colon-spacing": "error",
"symbol-description": "error", "symbol-description": "error",
"template-curly-spacing": ["error", "never"], "template-curly-spacing": ["error", "never"],
"template-tag-spacing": "error", "template-tag-spacing": "error",
"unicode-bom": ["error", "never"], "unicode-bom": ["error", "never"],
"valid-jsdoc": ["error", {
"requireReturn": false,
"requireReturnType": false,
"requireParamType": false,
}],
"vars-on-top": "error", "vars-on-top": "error",
"wrap-iife": "error", "wrap-iife": "error",
"wrap-regex": "off", "wrap-regex": "off",
"yield-star-spacing": "error", "yield-star-spacing": "error",
"yoda": ["error", "never", { "exceptRange": true }],
"yoda": ["error", "never", {
"exceptRange": true,
}],
"node/callback-return": "off", "node/callback-return": "off",
"node/exports-style": "off", "node/exports-style": "off",
"node/file-extension-in-import": "off", "node/file-extension-in-import": "off",
"node/global-require": "off", "node/global-require": "off",
// Node.js callback passing style of (err, value) is not used in this project
"node/handle-callback-err": "off", "node/handle-callback-err": "off",
"node/no-callback-literal": "off", "node/no-callback-literal": "off",
"node/no-deprecated-api": "error", "node/no-deprecated-api": "off",
"node/no-exports-assign": "error", "node/no-exports-assign": "off",
"node/no-extraneous-import": "off", "node/no-extraneous-import": "off",
"node/no-extraneous-require": "off", "node/no-extraneous-require": "off",
"node/no-missing-import": ["error", {
"tryExtensions": [".js", ".ts"], "node/no-missing-import": "off",
}],
"node/no-missing-require": "error", "node/no-missing-require": "off",
"node/no-mixed-requires": "error", "node/no-mixed-requires": "off",
"node/no-new-require": "error", "node/no-new-require": "off",
"node/no-path-concat": "error", "node/no-path-concat": "off",
"node/no-process-env": "error", "node/no-process-env": "off",
"node/no-process-exit": "error", "node/no-process-exit": "off",
"node/no-restricted-require": "off", "node/no-restricted-require": "off",
"node/no-sync": "error", "node/no-sync": "error",
"node/no-unpublished-bin": "error", "node/no-unpublished-bin": "off",
"node/no-unpublished-import": "error", "node/no-unpublished-import": "off",
"node/no-unpublished-require": [
"error", "node/no-unpublished-require": "off",
{ "allowModules": ["webpack", "webpack-merge", "webpack-dev-middleware"] },
],
"node/no-unsupported-features/es-builtins": "off", "node/no-unsupported-features/es-builtins": "off",
"node/no-unsupported-features/es-syntax": "off", "node/no-unsupported-features/es-syntax": "off",
"node/no-unsupported-features/node-builtins": "off", "node/no-unsupported-features/node-builtins": "off",
"node/prefer-global/buffer": "error", "node/prefer-global/buffer": "off",
"node/prefer-global/console": "error", "node/prefer-global/console": "off",
"node/prefer-global/process": "error", "node/prefer-global/process": "off",
"node/prefer-global/text-decoder": "error", "node/prefer-global/text-decoder": "off",
"node/prefer-global/text-encoder": "error", "node/prefer-global/text-encoder": "off",
"node/prefer-global/url-search-params": "error", "node/prefer-global/url-search-params": "off",
"node/prefer-global/url": "error", "node/prefer-global/url": "off",
"node/prefer-promises/dns": "off", "node/prefer-promises/dns": "off",
"node/prefer-promises/fs": "off", "node/prefer-promises/fs": "off",
"node/process-exit-as-throw": "error", "node/process-exit-as-throw": "off",
"node/shebang": ["error", {
"convertPath": { "node/shebang": "off",
"*.ts": ["^(.+)\\.ts$", "dist/node/$1.js"],
},
}],
}, },
}; }, {
files: ["{packages,plugins}/**/*.ts?(x)"],
languageOptions: {
parser: tsParser,
},
extends: compat.extends("plugin:@typescript-eslint/recommended"),
"rules": {
"@typescript-eslint/no-explicit-any": "off",
"@typescript-eslint/no-useless-constructor": "error",
"@typescript-eslint/no-unused-vars": "off",
"@typescript-eslint/triple-slash-reference": "off",
"@typescript-eslint/no-shadow": ["error", {
"allow": ["Event", "Request", "yargs"],
}],
// Allow require imports where necessary (dynamic loading, webpack configs, etc.)
"@typescript-eslint/no-require-imports": "off",
"prefer-const": "off",
"no-shadow": "off",
},
}, {
files: ["test/**/*.js", "plugins/*/test/**/*.js"],
languageOptions: {
globals: {
...globals.mocha,
},
sourceType: "commonjs",
parserOptions: {},
},
"rules": {
"prefer-arrow-callback": "off",
"no-invalid-this": "off",
"node/no-unpublished-import": "off",
"node/no-unpublished-require": "off",
},
}, {
files: [
"packages/web_ui/src/**/*.ts?(x)",
"packages/lib/browser.ts",
"packages/create/templates/*/web/**/*.{t,j}s?(x)",
"{packages,plugins}/*/web/**/*.ts?(x)",
],
languageOptions: {
globals: {
...globals.browser,
},
"sourceType": "module",
parserOptions: {
"ecmaFeatures": {
"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": "error",
"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",
},
}, {
files: ["packages/create/templates/**/*.{t,j}s?(x)"],
"rules": {
"node/no-missing-require": "off",
"node/no-missing-import": "off",
"@stylistic/indent": "off",
"spaced-comment": "off",
"comma-spacing": "off",
"max-len": "off",
"indent": "off",
},
}, globalIgnores(["**/dist/", "dist/"])]);
+18 -14
View File
@@ -41,21 +41,25 @@
"@clusterio/host": "workspace:*", "@clusterio/host": "workspace:*",
"@clusterio/lib": "workspace:*", "@clusterio/lib": "workspace:*",
"@clusterio/web_ui": "workspace:*", "@clusterio/web_ui": "workspace:*",
"@swc/core": "^1.11.1", "@eslint/eslintrc": "^3.3.1",
"@typescript-eslint/eslint-plugin": "^6.4.1", "@eslint/js": "^9.32.0",
"@typescript-eslint/parser": "^6.4.1", "@stylistic/eslint-plugin": "^5.2.2",
"eslint": "^8.57.1", "@swc/core": "^1.13.3",
"@typescript-eslint/eslint-plugin": "^8.38.0",
"@typescript-eslint/parser": "^8.38.0",
"eslint": "^9.32.0",
"eslint-plugin-node": "^11.1.0", "eslint-plugin-node": "^11.1.0",
"express": "^4.21.2", "express": "^5.1.0",
"form-data": "^4.0.2", "form-data": "^4.0.4",
"fs-extra": "^11.3.0", "fs-extra": "^11.3.0",
"jsonwebtoken": "^9.0.1", "globals": "^16.3.0",
"jszip": "^3.10.0", "jsonwebtoken": "^9.0.2",
"mocha": "^10.8.2", "jszip": "^3.10.1",
"nyc": "^15.1.0", "mocha": "^11.7.1",
"phin": "^3.7.0", "nyc": "^17.1.0",
"typedoc": "^0.26.11", "phin": "^3.7.1",
"typescript": "^5.7.3", "typedoc": "^0.28.9",
"yargs": "^17.7.2" "typescript": "^5.9.2",
"yargs": "^18.0.0"
} }
} }
+13 -5
View File
@@ -130,8 +130,16 @@ async function handleBootstrapCommand(
controllerConfig: lib.ControllerConfig controllerConfig: lib.ControllerConfig
): Promise<void> { ): Promise<void> {
let subCommand = args._[1]; let subCommand = args._[1];
let userManager = new UserManager(controllerConfig);
await userManager.load(path.join(controllerConfig.get("controller.database_directory"), "users.json")); const databaseDirectory = controllerConfig.get("controller.database_directory");
const roles = new lib.SubscribableDatastore(...await new lib.JsonIdDatastoreProvider(
path.join(databaseDirectory, "roles.json"),
lib.Role.fromJSON.bind(lib.Role),
).bootstrap());
const userManager = new UserManager(controllerConfig, roles);
await userManager.load(path.join(databaseDirectory, "users.json"));
if (subCommand === "create-admin") { if (subCommand === "create-admin") {
if (!args.name) { if (!args.name) {
logger.error("name cannot be blank"); logger.error("name cannot be blank");
@@ -144,7 +152,7 @@ async function handleBootstrapCommand(
admin = userManager.createUser(args.name); admin = userManager.createUser(args.name);
} }
let adminRole = lib.ensureDefaultAdminRole(userManager.roles); let adminRole = lib.ensureDefaultAdminRole(roles);
admin.roleIds.add(adminRole.id); admin.roleIds.add(adminRole.id);
admin.isAdmin = true; admin.isAdmin = true;
await userManager.save(path.join(controllerConfig.get("controller.database_directory"), "users.json")); await userManager.save(path.join(controllerConfig.get("controller.database_directory"), "users.json"));
@@ -414,7 +422,7 @@ async function startup() {
if (secondSigint) { if (secondSigint) {
setBlocking(true); setBlocking(true);
logger.fatal("Caught second interrupt, terminating immediately"); logger.fatal("Caught second interrupt, terminating immediately");
// eslint-disable-next-line node/no-process-exit
process.exit(1); process.exit(1);
} }
@@ -427,7 +435,7 @@ async function startup() {
if (secondSigterm) { if (secondSigterm) {
setBlocking(true); setBlocking(true);
logger.fatal("Caught second termination, terminating immediately"); logger.fatal("Caught second termination, terminating immediately");
// eslint-disable-next-line node/no-process-exit
process.exit(1); process.exit(1);
} }
+2 -2
View File
@@ -6,7 +6,7 @@
"version": "2.0.0-alpha.21", "version": "2.0.0-alpha.21",
"main": "dist/node/index.js", "main": "dist/node/index.js",
"scripts": { "scripts": {
"prepare": "tsc --build && webpack-cli --env production", "prepare": "tsc --build && webpack-cli --mode production",
"test": "echo \"Error: no test specified\" && exit 1" "test": "echo \"Error: no test specified\" && exit 1"
}, },
"bin": { "bin": {
@@ -37,7 +37,7 @@
}, },
"devDependencies": { "devDependencies": {
"@clusterio/web_ui": "workspace:*", "@clusterio/web_ui": "workspace:*",
"@swc/core": "^1.11.1", "@swc/core": "^1.13.3",
"@types/busboy": "^1.5.0", "@types/busboy": "^1.5.0",
"@types/compression": "^1.7.2", "@types/compression": "^1.7.2",
"@types/express": "^4.17.17", "@types/express": "^4.17.17",
+1 -1
View File
@@ -16,7 +16,7 @@ import * as routes from "./routes";
* @alias module:controller/src/BaseConnection * @alias module:controller/src/BaseConnection
*/ */
export default class BaseConnection extends lib.Link { export default class BaseConnection extends lib.Link {
declare ["connector"]: WsServerConnector; declare "connector": WsServerConnector;
constructor( constructor(
connector: lib.WebSocketBaseConnector, connector: lib.WebSocketBaseConnector,
+14 -13
View File
@@ -313,7 +313,7 @@ export default class ControlConnection extends BaseConnection {
let stream = await routes.createProxyStream(this._controller.app); let stream = await routes.createProxyStream(this._controller.app);
stream.filename = name; stream.filename = name;
let ready = new Promise((resolve, reject) => { let ready = new Promise<void>((resolve, reject) => {
stream.events.on("source", resolve); stream.events.on("source", resolve);
stream.events.on("timeout", () => reject( stream.events.on("timeout", () => reject(
new lib.RequestError("Timed out establishing stream from host") new lib.RequestError("Timed out establishing stream from host")
@@ -671,22 +671,21 @@ export default class ControlConnection extends BaseConnection {
} }
async handleRoleListRequest() { async handleRoleListRequest() {
return [...this._controller.userManager.roles.values()]; return [...this._controller.roles.values()];
} }
async handleRoleCreateRequest(request: lib.RoleCreateRequest) { async handleRoleCreateRequest(request: lib.RoleCreateRequest) {
let lastId = Math.max.apply(null, [...this._controller.userManager.roles.keys()]); let lastId = Math.max.apply(null, [...this._controller.roles.keys()]);
// Start at 5 to leave space for future default roles // Start at 5 to leave space for future default roles
let id = Math.max(5, lastId+1); let id = Math.max(5, lastId+1);
this._controller.userManager.roles.set(id, lib.Role.fromJSON({ id, ...request })); this._controller.roles.set(lib.Role.fromJSON({ id, ...request }));
this._controller.userManager.dirty = true;
return id; return id;
} }
async handleRoleUpdateRequest(request: lib.RoleUpdateRequest) { async handleRoleUpdateRequest(request: lib.RoleUpdateRequest) {
let { id, name, description, permissions } = request; let { id, name, description, permissions } = request;
let role = this._controller.userManager.roles.get(id); let role = this._controller.roles.getMutable(id);
if (!role) { if (!role) {
throw new lib.RequestError(`Role with ID ${id} does not exist`); throw new lib.RequestError(`Role with ID ${id} does not exist`);
} }
@@ -694,27 +693,29 @@ export default class ControlConnection extends BaseConnection {
role.name = name; role.name = name;
role.description = description; role.description = description;
role.permissions = new Set(permissions); role.permissions = new Set(permissions);
this._controller.rolePermissionsUpdated(role); this._controller.roles.set(role);
} }
async handleRoleGrantDefaultPermissionsRequest(request: lib.RoleGrantDefaultPermissionsRequest) { async handleRoleGrantDefaultPermissionsRequest(request: lib.RoleGrantDefaultPermissionsRequest) {
let role = this._controller.userManager.roles.get(request.id); let role = this._controller.roles.get(request.id);
if (!role) { if (!role) {
throw new lib.RequestError(`Role with ID ${request.id} does not exist`); throw new lib.RequestError(`Role with ID ${request.id} does not exist`);
} }
role.grantDefaultPermissions(); role.grantDefaultPermissions();
this._controller.rolePermissionsUpdated(role); this._controller.roles.set(role);
} }
async handleRoleDeleteRequest(request: lib.RoleDeleteRequest) { async handleRoleDeleteRequest(request: lib.RoleDeleteRequest) {
let id = request.id; let id = request.id;
if (!this._controller.userManager.roles.delete(id)) { const role = this._controller.roles.get(id);
if (!role) {
throw new lib.RequestError(`Role with ID ${id} does not exist`); throw new lib.RequestError(`Role with ID ${id} does not exist`);
} }
this._controller.userManager.dirty = true; this._controller.roles.delete(role);
this._controller.userManager.dirty = true;
for (let user of this._controller.userManager.users.values()) { for (let user of this._controller.userManager.users.values()) {
if (user.roleIds.delete(id)) { if (user.roleIds.delete(id)) {
this._controller.userPermissionsUpdated(user); this._controller.userPermissionsUpdated(user);
@@ -766,7 +767,7 @@ export default class ControlConnection extends BaseConnection {
} }
for (let roleId of request.roles) { for (let roleId of request.roles) {
if (!this._controller.userManager.roles.has(roleId)) { if (!this._controller.roles.has(roleId)) {
throw new lib.RequestError(`Role with ID ${roleId} does not exist`); throw new lib.RequestError(`Role with ID ${roleId} does not exist`);
} }
} }
@@ -900,7 +901,7 @@ export default class ControlConnection extends BaseConnection {
} }
// A large number of small if statements are unavoidable when reducing the number of updates sent // A large number of small if statements are unavoidable when reducing the number of updates sent
// eslint-disable-next-line complexity
async handleUserBulkImportRequest(request: lib.UserBulkImportRequest) { async handleUserBulkImportRequest(request: lib.UserBulkImportRequest) {
let backup: undefined | Awaited<ReturnType<ControlConnection["handleUserBulkExportRequest"]>>; let backup: undefined | Awaited<ReturnType<ControlConnection["handleUserBulkExportRequest"]>>;
const updated = new Map<ControllerUser["id"], ControllerUser>(); const updated = new Map<ControllerUser["id"], ControllerUser>();
+73 -28
View File
@@ -6,7 +6,7 @@ import type { Static } from "@sinclair/typebox";
import finalhandler from "finalhandler"; import finalhandler from "finalhandler";
import compression from "compression"; import compression from "compression";
import events, { EventEmitter } from "events"; import events from "events";
import fs from "fs-extra"; import fs from "fs-extra";
import http from "http"; import http from "http";
import https from "https"; import https from "https";
@@ -42,6 +42,14 @@ const logSizeGauge = new Gauge(
type InstanceId = { instanceId: number }; type InstanceId = { instanceId: number };
type ControllerDebugEvents = {
"message": [ { direction: "in" | "out", content: string } ],
};
type ControllerEvents = {
"stop": [],
}
/** /**
* Manages all controller related operations * Manages all controller related operations
* @alias module:controller/src/Controller * @alias module:controller/src/Controller
@@ -66,8 +74,8 @@ export default class Controller {
wsServer: WsServer; wsServer: WsServer;
router = new ControllerRouter(this); router = new ControllerRouter(this);
trustedProxies: BlockList; trustedProxies: BlockList;
debugEvents: events.EventEmitter = new events.EventEmitter(); debugEvents = new events.EventEmitter<ControllerDebugEvents>();
private _events: events.EventEmitter = new events.EventEmitter(); private _events = new events.EventEmitter<ControllerEvents>();
/** Event subscription controller */ /** Event subscription controller */
subscriptions = new lib.SubscriptionController(); subscriptions = new lib.SubscriptionController();
@@ -130,17 +138,28 @@ export default class Controller {
lib.ModPack.fromJSON.bind(lib.ModPack) lib.ModPack.fromJSON.bind(lib.ModPack)
).bootstrap()); ).bootstrap());
if (modPacks.size === 0) { const roles = new lib.SubscribableDatastore(...await new lib.JsonIdDatastoreProvider(
modPacks.setMany(lib.ModPack.defaultModPacks); path.join(databaseDirectory, "roles.json"),
} lib.Role.fromJSON.bind(lib.Role),
this.migrateRoles,
).bootstrap());
const userManager = new UserManager(config); const userManager = new UserManager(config, roles);
await userManager.load(path.join(databaseDirectory, "users.json")); await userManager.load(path.join(databaseDirectory, "users.json"));
let modsDirectory = config.get("controller.mods_directory"); let modsDirectory = config.get("controller.mods_directory");
await fs.ensureDir(modsDirectory); await fs.ensureDir(modsDirectory);
const modStore = await lib.ModStore.fromDirectory(modsDirectory); const modStore = await lib.ModStore.fromDirectory(modsDirectory);
// Add default mod packs
if (modPacks.size === 0) {
modPacks.setMany(lib.ModPack.defaultModPacks);
}
// Add default roles
lib.ensureDefaultAdminRole(roles);
lib.ensureDefaultPlayerRole(roles);
return [ return [
systems, systems,
hosts, hosts,
@@ -148,6 +167,7 @@ export default class Controller {
saves, saves,
modPacks, modPacks,
modStore, modStore,
roles,
userManager, userManager,
] as const; ] as const;
} }
@@ -178,8 +198,10 @@ export default class Controller {
public modPacks = new lib.SubscribableDatastore<lib.ModPack>(), public modPacks = new lib.SubscribableDatastore<lib.ModPack>(),
/** Mods stored on the controller */ /** Mods stored on the controller */
public modStore = new lib.ModStore(config.get("controller.mods_directory"), new Map()), public modStore = new lib.ModStore(config.get("controller.mods_directory"), new Map()),
/** Mapping of mod pack id to mod pack */
public roles = new lib.SubscribableDatastore<lib.Role>(),
/** User and roles manager for the cluster */ /** User and roles manager for the cluster */
public userManager = new UserManager(config), public userManager = new UserManager(config, roles),
) { ) {
this.clusterLogger = clusterLogger; this.clusterLogger = clusterLogger;
this.pluginInfos = pluginInfos; this.pluginInfos = pluginInfos;
@@ -206,6 +228,7 @@ export default class Controller {
this.subscriptions.handle(lib.ModPackUpdatesEvent, this.handleModPackSubscription.bind(this)); this.subscriptions.handle(lib.ModPackUpdatesEvent, this.handleModPackSubscription.bind(this));
this.subscriptions.handle(lib.ModUpdatesEvent, this.handleModSubscription.bind(this)); this.subscriptions.handle(lib.ModUpdatesEvent, this.handleModSubscription.bind(this));
this.subscriptions.handle(lib.UserUpdatesEvent, this.handleUserSubscription.bind(this)); this.subscriptions.handle(lib.UserUpdatesEvent, this.handleUserSubscription.bind(this));
this.subscriptions.handle(lib.RoleUpdatesEvent, this.handleRoleSubscription.bind(this));
// Handle updates for datastores // Handle updates for datastores
this.systems.on("update", this.systemsUpdated.bind(this)); this.systems.on("update", this.systemsUpdated.bind(this));
@@ -213,6 +236,7 @@ export default class Controller {
this.instances.on("update", this.instanceDetailsUpdated.bind(this)); this.instances.on("update", this.instanceDetailsUpdated.bind(this));
this.saves.on("update", this.savesUpdated.bind(this)); this.saves.on("update", this.savesUpdated.bind(this));
this.modPacks.on("update", this.modPacksUpdated.bind(this)); this.modPacks.on("update", this.modPacksUpdated.bind(this));
this.roles.on("update", this.rolesUpdated.bind(this));
} }
async start(args: ControllerArgs) { async start(args: ControllerArgs) {
@@ -375,13 +399,12 @@ export default class Controller {
async _startDevServer(args: ControllerArgs) { async _startDevServer(args: ControllerArgs) {
logger.warn("Webpack development mode enabled"); logger.warn("Webpack development mode enabled");
/* eslint-disable @typescript-eslint/no-var-requires, node/no-unpublished-require */
const webpack = require("webpack"); const webpack = require("webpack");
const webpackDevMiddleware = require("webpack-dev-middleware"); const webpackDevMiddleware = require("webpack-dev-middleware");
const webpackConfigs = []; const webpackConfigs = [];
if (args.dev) { if (args.dev) {
// eslint-disable-next-line node/no-missing-require
webpackConfigs.push(require("../../../webpack.config")({})); // Path outside of build webpackConfigs.push(require("../../../webpack.config")({})); // Path outside of build
} }
if (args.devPlugin) { if (args.devPlugin) {
@@ -397,7 +420,7 @@ export default class Controller {
} }
this.app.locals.devPlugins = devPlugins; this.app.locals.devPlugins = devPlugins;
} }
/* eslint-enable @typescript-eslint/no-var-requires, node/no-unpublished-require */
const compiler = webpack(webpackConfigs); const compiler = webpack(webpackConfigs);
this.devMiddleware = webpackDevMiddleware(compiler, { serverSideRender: true }); this.devMiddleware = webpackDevMiddleware(compiler, { serverSideRender: true });
@@ -589,6 +612,7 @@ export default class Controller {
this.instances.save(), this.instances.save(),
this.saves.save(), this.saves.save(),
this.modPacks.save(), this.modPacks.save(),
this.roles.save(),
]); ]);
if (this.userManager.dirty) { if (this.userManager.dirty) {
@@ -649,6 +673,20 @@ export default class Controller {
return instance; return instance;
} }
static migrateRoles(rawJson: unknown[]): Static<typeof lib.Role.jsonSchema>[] {
const serialized = rawJson as Static<typeof lib.Role.jsonSchema>[];
return serialized.map(json => {
json.permissions = json.permissions.map(permission => {
// migrate: core.instance.save.list.subscribe was renamed in alpha 17
if (permission === "core.instance.save.list.subscribe") {
return "core.instance.save.subscribe";
}
return permission;
});
return json;
});
}
static async loadJsonObject(filePath: string, throwOnMissing: boolean = false): Promise<any> { static async loadJsonObject(filePath: string, throwOnMissing: boolean = false): Promise<any> {
let manifest = {}; let manifest = {};
try { try {
@@ -1052,27 +1090,34 @@ export default class Controller {
} }
} }
/** rolesUpdated(roles: lib.Role[]) {
* Notify connected control clients with the given role that the this.subscriptions.broadcast(new lib.RoleUpdatesEvent(roles));
* permissions may have changed. // lib.invokeHook(this.plugins, "onRolesUpdated", roles); // This doesn't exist at the moment
* @param role - Role permisions updated for. // Notify connected control clients with the given role that the permissions may have changed.
*/ for (const role of roles) {
rolePermissionsUpdated(role: lib.Role) { for (let controlConnection of this.wsServer.controlConnections.values()) {
for (let controlConnection of this.wsServer.controlConnections.values()) { if (controlConnection.user.roles.has(role)) {
if (controlConnection.user.roles.has(role)) { controlConnection.send(
controlConnection.send( new lib.AccountUpdateEvent(
new lib.AccountUpdateEvent( [...controlConnection.user.roles].map(r => ({
[...controlConnection.user.roles].map(r => ({ name: r.name,
name: r.name, id: r.id,
id: r.id, permissions: [...r.permissions],
permissions: [...r.permissions], }))
})) )
) );
); }
} }
} }
} }
async handleRoleSubscription(request: lib.SubscriptionRequest) {
const roles = [...this.roles.values()].filter(
role => role.updatedAtMs > request.lastRequestTimeMs,
);
return roles.length ? new lib.RoleUpdatesEvent(roles) : null;
}
async loadPlugins() { async loadPlugins() {
for (let pluginInfo of this.pluginInfos) { for (let pluginInfo of this.pluginInfos) {
try { try {
+10 -7
View File
@@ -1,10 +1,13 @@
import { Static, Type } from "@sinclair/typebox"; import { Static, Type } from "@sinclair/typebox";
import { IControllerUser, PermissionError, PlayerStats, Role, User, permissions } from "@clusterio/lib";
import type UserManager from "./UserManager"; import {
IControllerUser, PermissionError, PlayerStats,
Role, SubscribableDatastore, User, permissions,
} from "@clusterio/lib";
export default class ControllerUser extends User implements IControllerUser { export default class ControllerUser extends User implements IControllerUser {
constructor( constructor(
public userManager: UserManager, private _controllerRoles: SubscribableDatastore<Role>,
/** Unix time in seconds the user token must be issued after to be valid. */ /** Unix time in seconds the user token must be issued after to be valid. */
public tokenValidAfter = 0, public tokenValidAfter = 0,
...args: ConstructorParameters<typeof User> ...args: ConstructorParameters<typeof User>
@@ -17,7 +20,7 @@ export default class ControllerUser extends User implements IControllerUser {
token_valid_after: Type.Optional(Type.Number()), token_valid_after: Type.Optional(Type.Number()),
}); });
static fromJSON(json: Static<typeof this.jsonSchema>, userManager: UserManager) { static fromJSON(json: Static<typeof this.jsonSchema>, controllerRoles: SubscribableDatastore<Role>) {
const roleIds = new Set<number>(json.roles ?? []); const roleIds = new Set<number>(json.roles ?? []);
const instanceStats = new Map( const instanceStats = new Map(
(json.instance_stats ?? []).map( (json.instance_stats ?? []).map(
@@ -26,7 +29,7 @@ export default class ControllerUser extends User implements IControllerUser {
); );
const playerStats = User._calculatePlayerStats(instanceStats); const playerStats = User._calculatePlayerStats(instanceStats);
return new this( return new this(
userManager, controllerRoles,
json.token_valid_after, json.token_valid_after,
json.name, json.name,
roleIds, roleIds,
@@ -57,7 +60,7 @@ export default class ControllerUser extends User implements IControllerUser {
get roles(): ReadonlySet<Readonly<Role>> { get roles(): ReadonlySet<Readonly<Role>> {
return new Set([...this.roleIds].map( return new Set([...this.roleIds].map(
id => this.userManager.roles.get(id) id => this._controllerRoles.get(id)
).filter( ).filter(
(r): r is Role => Boolean(r) (r): r is Role => Boolean(r)
)); ));
@@ -79,7 +82,7 @@ export default class ControllerUser extends User implements IControllerUser {
} }
for (let roleId of this.roleIds) { for (let roleId of this.roleIds) {
let role = this.userManager.roles.get(roleId); let role = this._controllerRoles.get(roleId);
if (!role) { if (!role) {
continue; continue;
} }
+1 -1
View File
@@ -47,7 +47,7 @@ export default class HostConnection extends BaseConnection {
this._checkPluginVersions(); this._checkPluginVersions();
for (let event of ["connect", "drop", "resume", "close"] as const) { for (let event of ["connect", "drop", "resume", "close"] as const) {
// eslint-disable-next-line no-loop-func
this.connector.on(event, () => { this.connector.on(event, () => {
for (let plugin of this._controller.plugins.values()) { for (let plugin of this._controller.plugins.values()) {
plugin.onHostConnectionEvent(this, event); plugin.onHostConnectionEvent(this, event);
+1
View File
@@ -45,6 +45,7 @@ export default class InstanceInfo {
this.status, this.status,
this.factorioVersion, this.factorioVersion,
this.updatedAtMs, this.updatedAtMs,
this.config.get("instance.exclude_from_start_all"),
); );
} }
+13 -28
View File
@@ -10,7 +10,6 @@ import ControllerUser from "./ControllerUser";
* @alias module:controller/src/UserManager * @alias module:controller/src/UserManager
*/ */
export default class UserManager { export default class UserManager {
roles: Map<lib.Role["id"], lib.Role> = new Map();
users: Map<ControllerUser["id"], ControllerUser> = new Map(); users: Map<ControllerUser["id"], ControllerUser> = new Map();
dirty = false; dirty = false;
@@ -20,7 +19,8 @@ export default class UserManager {
onlineUsers = new Set<ControllerUser>(); onlineUsers = new Set<ControllerUser>();
constructor( constructor(
private _config: lib.ControllerConfig private _config: lib.ControllerConfig,
private _roles: lib.SubscribableDatastore<lib.Role>,
) { ) {
} }
@@ -31,14 +31,15 @@ export default class UserManager {
async load(filePath: string): Promise<void> { async load(filePath: string): Promise<void> {
try { try {
let content = JSON.parse(await fs.readFile(filePath, { encoding: "utf8" })); let content = JSON.parse(await fs.readFile(filePath, { encoding: "utf8" }));
for (let serializedRole of content.roles) { if ("roles" in content) { // Split file format after 2.0.0-alpha.22
let role = lib.Role.fromJSON(serializedRole); this._roles.setMany(content.roles.map((serializedRole: any) => lib.Role.fromJSON(serializedRole)));
this.roles.set(role.id, role); await this._roles.save(); // Force a save to prevent data loss
content = content.users;
} }
let duplicates = 0; let duplicates = 0;
for (let serializedUser of content.users) { for (const serializedUser of content) {
let user = ControllerUser.fromJSON(serializedUser, this); const user = ControllerUser.fromJSON(serializedUser, this._roles);
const existingUser = this.users.get(user.id); const existingUser = this.users.get(user.id);
if (existingUser) { if (existingUser) {
// Required migration to all lowercase ids in alpha 19 // Required migration to all lowercase ids in alpha 19
@@ -65,30 +66,14 @@ export default class UserManager {
if (err.code !== "ENOENT") { if (err.code !== "ENOENT") {
throw err; throw err;
} }
// Create default roles if loading failed
lib.ensureDefaultAdminRole(this.roles);
lib.ensureDefaultPlayerRole(this.roles);
} }
} }
async save(filePath: string): Promise<void> { async save(filePath: string): Promise<void> {
let serializedRoles = [];
for (let role of this.roles.values()) {
serializedRoles.push(role.toJSON());
}
let serializedUsers = [];
for (let user of this.users.values()) {
serializedUsers.push(user.toJSON(true));
}
let serialized = {
users: serializedUsers,
roles: serializedRoles,
};
this.dirty = false; this.dirty = false;
await lib.safeOutputFile(filePath, JSON.stringify(serialized, null, "\t")); await lib.safeOutputFile(filePath,
JSON.stringify([...this.users.values()].map(user => user.toJSON(true)), null, "\t")
);
} }
/** /**
@@ -103,11 +88,11 @@ export default class UserManager {
let roles = new Set<number>(); let roles = new Set<number>();
let defaultRoleId = this._config.get("controller.default_role_id"); let defaultRoleId = this._config.get("controller.default_role_id");
if (defaultRoleId !== null && this.roles.has(defaultRoleId)) { if (defaultRoleId !== null && this._roles.has(defaultRoleId)) {
roles.add(defaultRoleId); roles.add(defaultRoleId);
} }
let user = new ControllerUser(this, 0, name, roles); let user = new ControllerUser(this._roles, 0, name, roles);
this.users.set(user.id, user); this.users.set(user.id, user);
this.dirty = true; this.dirty = true;
return user; return user;
+5 -8
View File
@@ -1,6 +1,7 @@
import type WebSocket from "ws"; import type WebSocket from "ws";
import events from "events"; import events from "events";
import assert from "assert/strict";
import * as lib from "@clusterio/lib"; import * as lib from "@clusterio/lib";
const { logger } = lib; const { logger } = lib;
@@ -113,8 +114,7 @@ export default class WsServerConnector extends lib.WebSocketBaseConnector {
_timedOut() { _timedOut() {
logger.verbose("Connector | Connection timed out"); logger.verbose("Connector | Connection timed out");
this._reset(); this._close();
this.emit("close");
} }
_attachSocketHandlers() { _attachSocketHandlers() {
@@ -130,8 +130,7 @@ export default class WsServerConnector extends lib.WebSocketBaseConnector {
this._socket = null; this._socket = null;
if (this._closing) { if (this._closing) {
this._reset(); this._close();
this.emit("close");
} else { } else {
this._state = "resuming"; this._state = "resuming";
@@ -187,8 +186,7 @@ export default class WsServerConnector extends lib.WebSocketBaseConnector {
} }
if (this._state === "resuming") { if (this._state === "resuming") {
this._reset(); this._close();
this.emit("close");
return; return;
} }
@@ -223,8 +221,7 @@ export default class WsServerConnector extends lib.WebSocketBaseConnector {
*/ */
setClosing() { setClosing() {
if (this._state === "resuming") { if (this._state === "resuming") {
this._reset(); this._close();
this.emit("close");
return; return;
} }
+7 -1
View File
@@ -266,6 +266,12 @@ async function uploadExport(req: Request, res: Response) {
res.sendStatus(200); res.sendStatus(200);
} }
type ProxyStreamEvents = {
"error": [ err: any ],
"close": [],
"timeout": [],
"source": [],
}
export interface ProxyStream { export interface ProxyStream {
id: string; id: string;
@@ -274,7 +280,7 @@ export interface ProxyStream {
size?: string; size?: string;
mime?: string; mime?: string;
filename: string | null; filename: string | null;
events: events.EventEmitter; events: events.EventEmitter<ProxyStreamEvents>;
timeout: ReturnType<typeof setTimeout>; timeout: ReturnType<typeof setTimeout>;
} }
+1 -1
View File
@@ -5,7 +5,7 @@ const { merge } = require("webpack-merge");
const common = require("@clusterio/web_ui/webpack.common"); const common = require("@clusterio/web_ui/webpack.common");
module.exports = (env = {}) => merge(common(env), { module.exports = (env = {}, argv = {}) => merge(common(env, argv), {
context: __dirname, context: __dirname,
entry: "./web/index.tsx", entry: "./web/index.tsx",
devServer: { devServer: {
+4 -3
View File
@@ -114,7 +114,7 @@ async function execFile(cmd, args) {
escaped, escaped,
{ {
shell: true, shell: true,
// eslint-disable-next-line node/no-process-env
env: process.platform === "win32" ? { ...process.env, pct: "%" } : undefined, env: process.platform === "win32" ? { ...process.env, pct: "%" } : undefined,
}, },
(err, stdout, stderr) => { (err, stdout, stderr) => {
@@ -396,7 +396,7 @@ async function installClusterio(mode, plugins) {
} }
for (let plugin of plugins) { for (let plugin of plugins) {
if (!pluginList.has(plugin)) { if (!pluginList.has(plugin)) {
// eslint-disable-next-line node/global-require
let pluginInfo = require(require.resolve(plugin, { paths: [process.cwd()] })).plugin; let pluginInfo = require(require.resolve(plugin, { paths: [process.cwd()] })).plugin;
pluginList.set(pluginInfo.name, plugin); pluginList.set(pluginInfo.name, plugin);
} }
@@ -689,7 +689,8 @@ async function inquirerMissingArgs(args) {
} }
if (["standalone", "controller", "host"].includes(answers.mode)) { if (["standalone", "controller", "host"].includes(answers.mode)) {
answers = inquirer.prompt([ if (args.hasOwnProperty("remoteNpm")) { answers.remoteNpm = args.remoteNpm; }
answers = await inquirer.prompt([
{ {
type: "confirm", type: "confirm",
name: "remoteNpm", name: "remoteNpm",
+1 -1
View File
@@ -50,7 +50,7 @@ function escapeArg(arg) {
// For all other platforms the command is /bin/sh -c <command arg arg ...> // For all other platforms the command is /bin/sh -c <command arg arg ...>
// The command and its arguments are passed as a single argument to the shell. // The command and its arguments are passed as a single argument to the shell.
// See https://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_02 // See https://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_02
// eslint-disable-next-line no-lonely-if
if (!/[|&;<>()$`\\"' \t*?\[#~=%]/.test(arg)) { if (!/[|&;<>()$`\\"' \t*?\[#~=%]/.test(arg)) {
return arg; return arg;
} }
+1 -1
View File
@@ -3,7 +3,7 @@
"description": "Installer for clusterio", "description": "Installer for clusterio",
"author": "Hornwitser", "author": "Hornwitser",
"license": "MIT", "license": "MIT",
"version": "2.0.0-alpha.21", "version": "2.0.0-alpha.21c",
"main": "create.js", "main": "create.js",
"bin": { "bin": {
"clusteriocreate": "./create.js" "clusteriocreate": "./create.js"
+15 -7
View File
@@ -3,6 +3,8 @@ const { logger } = require("./logging");
const fs = require("fs-extra"); const fs = require("fs-extra");
const path = require("path"); const path = require("path");
const _package = require("./package.json");
async function copyTemplateFile(src, dst, properties) { async function copyTemplateFile(src, dst, properties) {
logger.verbose(`Writing ${dst} from template ${src}`); logger.verbose(`Writing ${dst} from template ${src}`);
@@ -102,6 +104,7 @@ async function copyPluginTemplates(pluginName, templates) {
prepare.push("tsc --build"); prepare.push("tsc --build");
files.set("tsconfig.json", path.join(templatePath, "tsconfig.json")); files.set("tsconfig.json", path.join(templatePath, "tsconfig.json"));
files.set("tsconfig.node.json", path.join(templatePath, "tsconfig.node.json")); files.set("tsconfig.node.json", path.join(templatePath, "tsconfig.node.json"));
files.set("tsconfig.base.json", path.join(templatePath, "tsconfig.base.json"));
if (webpack) { if (webpack) {
files.set("tsconfig.browser.json", path.join(templatePath, "tsconfig.browser.json")); files.set("tsconfig.browser.json", path.join(templatePath, "tsconfig.browser.json"));
} }
@@ -109,7 +112,7 @@ async function copyPluginTemplates(pluginName, templates) {
// Files and dependences to support webpack // Files and dependences to support webpack
if (webpack) { if (webpack) {
prepare.push("webpack-cli --env production"); prepare.push("webpack-cli --mode production");
files.set("webpack.config.js", path.join(commonPath, "webpack.config.js")); files.set("webpack.config.js", path.join(commonPath, "webpack.config.js"));
if (templates.includes("web")) { if (templates.includes("web")) {
files.set(`web/index.${ext}x`, path.join(templatePath, `web/plugin.${ext}x`)); files.set(`web/index.${ext}x`, path.join(templatePath, `web/plugin.${ext}x`));
@@ -139,7 +142,6 @@ async function copyPluginTemplates(pluginName, templates) {
// Files for lua modules // Files for lua modules
if (templates.includes("module")) { if (templates.includes("module")) {
files.set(".luacheckrc", path.join(commonPath, ".luacheckrc"));
files.set("module/module.json", path.join(commonPath, "module/module.json")); files.set("module/module.json", path.join(commonPath, "module/module.json"));
files.set("module/control.lua", path.join(commonPath, "module/control.lua")); files.set("module/control.lua", path.join(commonPath, "module/control.lua"));
files.set("module/module_exports.lua", path.join(commonPath, "module/module_exports.lua")); files.set("module/module_exports.lua", path.join(commonPath, "module/module_exports.lua"));
@@ -147,7 +149,6 @@ async function copyPluginTemplates(pluginName, templates) {
files.set("module/globals.lua", path.join(commonPath, "module/globals.lua")); files.set("module/globals.lua", path.join(commonPath, "module/globals.lua"));
} else { } else {
files.set(`instance.${ext}`, path.join(templatePath, `instance_empty.${ext}`)); files.set(`instance.${ext}`, path.join(templatePath, `instance_empty.${ext}`));
pluginContexts += 1;
} }
} }
@@ -164,18 +165,25 @@ async function copyPluginTemplates(pluginName, templates) {
// Properties that will control the replacements in the templates // Properties that will control the replacements in the templates
const properties = { const properties = {
config: config, // Weather this is ts or js
typescript: !javascriptOnly, typescript: !javascriptOnly,
ext: ext,
// Which templates where requested
multi_context: pluginContexts > 1,
controller: templates.includes("controller"), controller: templates.includes("controller"),
host: templates.includes("host"), host: templates.includes("host"),
instance: templates.includes("instance"), instance: templates.includes("instance"),
module: templates.includes("module"), module: templates.includes("module"),
ctl: templates.includes("ctl"), ctl: templates.includes("ctl"),
web: templates.includes("web"), web: templates.includes("web"),
multi_context: pluginContexts > 1, // Macro flags for context requirements
plugin_name: pluginName, webpack: webpack,
config: config,
// String values for package json
clusterio_version: _package.version,
node_version: _package.engines.node,
prepare: prepare.join(" && "), prepare: prepare.join(" && "),
ext: ext, plugin_name: pluginName,
}; };
// Write all the template files // Write all the template files
+1 -2
View File
@@ -1,3 +1,2 @@
dist/
node_modules/ node_modules/
package-lock.json dist/
File diff suppressed because it is too large. Load diff
+1 -1
View File
@@ -1,3 +1,3 @@
webpack.config.js webpack.config.js
dist/web/build
dist/browser dist/browser
dist/web
@@ -1,3 +1,14 @@
--[[
The 'control' file within factorio is used as the entry point for mods, in Clusterio this is only a convention
You can change which files are loaded (exports event handlers) and required (no events) by Clusterio within module.json
It is highly advised to use FMTK (justarandomgeek.factoriomod-debug) when writing Lua code for factorio
Most of your code will be within this one file, but you can create more and require them
clusterio_api exposes functions to enable communication with your InstancePlugin
compat exposes shims to simplify compatibly between factorio versions, use the following to require 2.0
`assert(compat.version_ge("2.0.0"), "__plugin_name__ requires factorio 2.0")`
]]
local clusterio_api = require("modules/clusterio/api") local clusterio_api = require("modules/clusterio/api")
local compat = require("modules/clusterio/compat") local compat = require("modules/clusterio/compat")
@@ -6,10 +17,12 @@ local compat = require("modules/clusterio/compat")
local MyModule = { local MyModule = {
} }
--- script_data is 'synced' between players, you should use your plugin name to avoid name conflicts --[[
-- The following helper function is desync safe and avoids name conflicts after being called during on_server_startup `compat.script_data` persists between restarts and is shared between modules, therefore you should use your plugin name to avoid conflicts
-- There are edge cases in the following events: pre player left, player left, console command, and config changed The following helper function is desync safe and avoids name conflicts after being called during `clusterio_api.events.on_server_startup`
-- If you use any of these events and access globalData then make sure to call this function first There are edge cases in the following events: pre player left, player left, console command, and config changed
If you use any of these events and access `script_data` then make sure to call this function first
]]
local script_data = {} local script_data = {}
local function setup_script_data() local function setup_script_data()
if compat.script_data["__plugin_name__"] == nil then if compat.script_data["__plugin_name__"] == nil then
@@ -28,12 +41,13 @@ end
--- Public methods should be available though your top level module table --- Public methods should be available though your top level module table
function MyModule.foo() function MyModule.foo()
game.print("foo") game.print("foo: " .. (script_data.counter or 0))
end end
--- Private methods should be local to the file, this will prevent others from calling it --- Private methods should be local to the file, this will prevent others from calling it
local function bar() local function bar()
game.print("bar") script_data.counter = (script_data.counter or 0) + 1
game.print("bar: " .. script_data.counter)
end end
--- Clusterio provides a few custom events, on_server_startup is the most useful and should be used in place of on_init --- Clusterio provides a few custom events, on_server_startup is the most useful and should be used in place of on_init
@@ -61,7 +75,7 @@ local function on_nth_tick_300()
bar() bar()
end end
--- Factorio events are accessible through defines.events, you can have one handler per event per module --- Factorio events are accessible through defines.events, you can have one handler per event per file
local e = defines.events local e = defines.events
local events = { local events = {
[clusterio_api.events.on_server_startup] = on_server_startup, [clusterio_api.events.on_server_startup] = on_server_startup,
@@ -73,7 +87,7 @@ local on_nth_tick = {
[300] = on_nth_tick_300, [300] = on_nth_tick_300,
} }
--- Always return the top level module table from control, this is how clusterio will access your event handlers --- Always return the top level module table from control, this is how Clusterio will access your event handlers
MyModule.events = events --- @package MyModule.events = events --- @package
MyModule.on_nth_tick = on_nth_tick --- @package MyModule.on_nth_tick = on_nth_tick --- @package
return MyModule return MyModule
@@ -1,3 +1,9 @@
--- Expose any globals here, typically just your control file if you want to access it through rcon or commands --[[
-- luacheck: globals __plugin_name__ It is best practice to not expose any globals because all modules share a global environment
However, sometimes you need globals, for example to access functions within rcon commands
Therefore, we advise that this should be the only file in your module to expose globals
Typically this would be your control file as shown in the example below
]]
-- Access using `/sc __plugin_name__.foo()`
__plugin_name__ = require("modules/__plugin_name__/control") __plugin_name__ = require("modules/__plugin_name__/control")
@@ -1,4 +1,8 @@
--- Can contain anything you want to allow other plugins to have access to, this example exposes the control file --[[
--- If you only export a single file then it may be better to rename that file to module_exports and save the redirection It is typical for a module to have a control file as the entry point, although this is not a requirement
-- Access the exports from other modules using require("modules/__plugin_name__") Therefore, Clusterio allows you to specify a single default export that can be accessed by other modules
You are not required to specify any default export, but note that a module can still require yours directly
]]
-- Access using `local __plugin_name__ = require("modules/__plugin_name__")`
return require("modules/__plugin_name__/control") return require("modules/__plugin_name__/control")
@@ -12,10 +12,10 @@
"prepare": "__prepare__" "prepare": "__prepare__"
}, },
"engines": { "engines": {
"node": ">=18" "node": "__node_version__"
}, },
"peerDependencies": { "peerDependencies": {
"@clusterio/lib": "workspace:*" "@clusterio/lib": "^__clusterio_version__"
}, },
"devDependencies": { "devDependencies": {
//%// Typescript and type declarations //%// Typescript and type declarations
@@ -32,13 +32,13 @@
"react": "^18.2.0", "react": "^18.2.0",
"react-dom": "^18.2.0", "react-dom": "^18.2.0",
//%endif //%endif
//%if web | controller // The controller uses webpack even when there is no plugin code //%if webpack
"webpack": "^5.88.2", "webpack": "^5.88.2",
"webpack-cli": "^5.1.4", "webpack-cli": "^5.1.4",
"webpack-merge": "^5.9.0", "webpack-merge": "^5.9.0",
"@clusterio/web_ui": "workspace:*", "@clusterio/web_ui": "^__clusterio_version__",
//%endif //%endif
"@clusterio/lib": "workspace:*" "@clusterio/lib": "^__clusterio_version__"
}, },
"dependencies": { "dependencies": {
"@sinclair/typebox": "^0.30.4" "@sinclair/typebox": "^0.30.4"
@@ -5,7 +5,7 @@ const { merge } = require("webpack-merge");
const common = require("@clusterio/web_ui/webpack.common"); const common = require("@clusterio/web_ui/webpack.common");
module.exports = (env = {}) => merge(common(env), { module.exports = (env = {}, argv = {}) => merge(common(env, argv), {
context: __dirname, context: __dirname,
entry: "./web/index.__ext__x", entry: "./web/index.__ext__x",
output: { output: {
@@ -18,9 +18,7 @@ module.exports = (env = {}) => merge(common(env), {
exposes: { exposes: {
"./": "./index.__ext__", "./": "./index.__ext__",
"./package.json": "./package.json", "./package.json": "./package.json",
//%if web
"./web": "./web/index.__ext__x", "./web": "./web/index.__ext__x",
//%endif
}, },
shared: { shared: {
"@clusterio/lib": { import: false }, "@clusterio/lib": { import: false },
@@ -1,7 +1,7 @@
"use strict"; "use strict";
const lib = require("@clusterio/lib"); const lib = require("@clusterio/lib");
const { BaseControllerPlugin } = require("@clusterio/controller"); const { BaseControllerPlugin } = require("@clusterio/controller");
//%if multi_context // Subscribing requires multi context //%if multi_context // Messages requires multi context
const { const {
PluginExampleEvent, PluginExampleRequest, PluginExampleEvent, PluginExampleRequest,
@@ -9,7 +9,7 @@ const {
//%if controller & web // Subscribing requires web content and the controller //%if controller & web // Subscribing requires web content and the controller
ExampleSubscribableUpdate, ExampleSubscribableValue, ExampleSubscribableUpdate, ExampleSubscribableValue,
//%endif //%endif
//%if multi_context // Subscribing requires multi context //%if multi_context // Messages requires multi context
} = require("./messages"); } = require("./messages");
//%endif //%endif
@@ -26,7 +26,8 @@ class ControllerPlugin extends BaseControllerPlugin {
//%endif //%endif
//%if controller & web // Subscribing requires web content and the controller //%if controller & web // Subscribing requires web content and the controller
this.controller.subscriptions.handle(ExampleSubscribableUpdate, this.handleExampleSubscription.bind(this)); this.controller.subscriptions.handle(ExampleSubscribableUpdate, this.handleExampleSubscription.bind(this));
this.exampleDatabase = new Map(); // If needed, replace with loading from database file // If needed, replace with loading from database file such as lib.Datastore
this.exampleDatabase = new Map([["foo", new ExampleSubscribableValue("foo", 0, false)]]);
//%endif //%endif
//%if multi_context // Subscribing requires multi context //%if multi_context // Subscribing requires multi context
} }
@@ -70,6 +71,7 @@ class ControllerPlugin extends BaseControllerPlugin {
//%if controller & web // Subscribing requires web content and the controller //%if controller & web // Subscribing requires web content and the controller
async handleExampleSubscription(request) { async handleExampleSubscription(request) {
this.logger.info(JSON.stringify(request));
const values = [...this.exampleDatabase.values()].filter( const values = [...this.exampleDatabase.values()].filter(
value => value.updatedAtMs > request.lastRequestTimeMs, value => value.updatedAtMs > request.lastRequestTimeMs,
); );
+5 -1
View File
@@ -7,12 +7,14 @@ lib.definePermission({
name: "__plugin_name__.example.permission.event", name: "__plugin_name__.example.permission.event",
title: "Example permission event", title: "Example permission event",
description: "Example Description. Event. Change me in index.js", description: "Example Description. Event. Change me in index.js",
grantByDefault: true,
}); });
lib.definePermission({ lib.definePermission({
name: "__plugin_name__.example.permission.request", name: "__plugin_name__.example.permission.request",
title: "Example permission request", title: "Example permission request",
description: "Example Description. Request. Change me in index.js", description: "Example Description. Request. Change me in index.js",
grantByDefault: true,
}); });
//%endif //%endif
//%if controller & web // Subscribing requires web content and the controller //%if controller & web // Subscribing requires web content and the controller
@@ -21,6 +23,7 @@ lib.definePermission({
name: "__plugin_name__.example.permission.subscribe", name: "__plugin_name__.example.permission.subscribe",
title: "Example permission subscribe", title: "Example permission subscribe",
description: "Example Description. Subscribe. Change me in index.js", description: "Example Description. Subscribe. Change me in index.js",
grantByDefault: true,
}); });
//%endif //%endif
//%if web //%if web
@@ -29,6 +32,7 @@ lib.definePermission({
name: "__plugin_name__.page.view", name: "__plugin_name__.page.view",
title: "Example page view permission", title: "Example page view permission",
description: "Example Description. View. Change me in index.js", description: "Example Description. View. Change me in index.js",
grantByDefault: true,
}); });
//%endif //%endif
@@ -40,7 +44,7 @@ const plugin = {
//%endif //%endif
//%if controller //%if controller
controllerEntrypoint: "./dist/node/controller", controllerEntrypoint: "./dist/node/controller",
//%endif //%endif
//%if controller & config //%if controller & config
controllerConfigFields: { controllerConfigFields: {
@@ -24,18 +24,26 @@ class InstancePlugin extends BaseInstancePlugin {
} }
async onStart() { async onStart() {
// Called once rcon becomes available
this.logger.info("instance::onStart"); this.logger.info("instance::onStart");
} }
async onStop() { async onStop() {
// Called during normal exits before rcon becomes unavailable
this.logger.info("instance::onStop"); this.logger.info("instance::onStop");
} }
onExit() {
// Called during all exits, including crashes and init failures, rcon is not available
this.logger.info("instance::onExit");
}
async onPlayerEvent(event) { async onPlayerEvent(event) {
this.logger.info(`onPlayerEvent::onPlayerEvent ${JSON.stringify(event)}`); this.logger.info(`onPlayerEvent::onPlayerEvent ${JSON.stringify(event)}`);
//%if module //%if module
if (this.instance.status === "running") { if (this.instance.status === "running") {
this.sendRcon("/sc __plugin_name__.foo()"); await this.sendRcon("/sc __plugin_name__.foo()");
} }
//%endif //%endif
} }
@@ -12,7 +12,7 @@ import React, {
import { import {
BaseWebPlugin, PageLayout, PageHeader, Control, ControlContext, notifyErrorHandler, BaseWebPlugin, PageLayout, PageHeader, Control, ControlContext, notifyErrorHandler,
} from "@clusterio/web_ui"; } from "@clusterio/web_ui";
//%if multi_context // Subscribing requires multi context //%if multi_context // Messages requires multi context
import { import {
PluginExampleEvent, PluginExampleRequest, PluginExampleEvent, PluginExampleRequest,
@@ -20,7 +20,7 @@ import {
//%if controller // Subscribing requires web content and the controller //%if controller // Subscribing requires web content and the controller
ExampleSubscribableUpdate, ExampleSubscribableValue, ExampleSubscribableUpdate, ExampleSubscribableValue,
//%endif //%endif
//%if multi_context // Subscribing requires multi context //%if multi_context // Messages requires multi context
} from "../messages"; } from "../messages";
//%endif //%endif
@@ -57,7 +57,7 @@ export class WebPlugin extends BaseWebPlugin {
permission: "__plugin_name__.example.permission.subscribe", permission: "__plugin_name__.example.permission.subscribe",
//%endif //%endif
//%if !controller //%if !controller
permission: undefined, // "__plugin_name__.example.permission.request", permission: "__plugin_name__.example.permission.view",
//%endif //%endif
content: <MyTemplatePage/>, content: <MyTemplatePage/>,
}, },
@@ -1,6 +1,6 @@
import * as lib from "@clusterio/lib"; import * as lib from "@clusterio/lib";
import { BaseControllerPlugin, InstanceInfo } from "@clusterio/controller"; import { BaseControllerPlugin, InstanceInfo } from "@clusterio/controller";
//%if multi_context // Subscribing requires multi context //%if multi_context // Messages requires multi context
import { import {
PluginExampleEvent, PluginExampleRequest, PluginExampleEvent, PluginExampleRequest,
@@ -8,7 +8,7 @@ import {
//%if controller & web // Subscribing requires web content and the controller //%if controller & web // Subscribing requires web content and the controller
ExampleSubscribableUpdate, ExampleSubscribableValue, ExampleSubscribableUpdate, ExampleSubscribableValue,
//%endif //%endif
//%if multi_context // Subscribing requires multi context //%if multi_context // Messages requires multi context
} from "./messages"; } from "./messages";
//%endif //%endif
@@ -25,7 +25,8 @@ export class ControllerPlugin extends BaseControllerPlugin {
//%endif //%endif
//%if controller & web // Subscribing requires web content and the controller //%if controller & web // Subscribing requires web content and the controller
this.controller.subscriptions.handle(ExampleSubscribableUpdate, this.handleExampleSubscription.bind(this)); this.controller.subscriptions.handle(ExampleSubscribableUpdate, this.handleExampleSubscription.bind(this));
this.exampleDatabase = new Map(); // If needed, replace with loading from database file // If needed, replace with loading from database file such as lib.Datastore
this.exampleDatabase = new Map([["foo", new ExampleSubscribableValue("foo", 0, false)]]);
//%endif //%endif
//%if multi_context // Subscribing requires multi context //%if multi_context // Subscribing requires multi context
} }
@@ -69,6 +70,7 @@ export class ControllerPlugin extends BaseControllerPlugin {
//%if controller & web // Subscribing requires web content and the controller //%if controller & web // Subscribing requires web content and the controller
async handleExampleSubscription(request: lib.SubscriptionRequest) { async handleExampleSubscription(request: lib.SubscriptionRequest) {
this.logger.info(JSON.stringify(request));
const values = [...this.exampleDatabase.values()].filter( const values = [...this.exampleDatabase.values()].filter(
value => value.updatedAtMs > request.lastRequestTimeMs, value => value.updatedAtMs > request.lastRequestTimeMs,
); );
@@ -6,12 +6,14 @@ lib.definePermission({
name: "__plugin_name__.example.permission.event", name: "__plugin_name__.example.permission.event",
title: "Example permission event", title: "Example permission event",
description: "Example Description. Event. Change me in index.ts", description: "Example Description. Event. Change me in index.ts",
grantByDefault: true,
}); });
lib.definePermission({ lib.definePermission({
name: "__plugin_name__.example.permission.request", name: "__plugin_name__.example.permission.request",
title: "Example permission request", title: "Example permission request",
description: "Example Description. Request. Change me in index.ts", description: "Example Description. Request. Change me in index.ts",
grantByDefault: true,
}); });
//%endif //%endif
//%if controller & web // Subscribing requires web content and the controller //%if controller & web // Subscribing requires web content and the controller
@@ -20,6 +22,7 @@ lib.definePermission({
name: "__plugin_name__.example.permission.subscribe", name: "__plugin_name__.example.permission.subscribe",
title: "Example permission subscribe", title: "Example permission subscribe",
description: "Example Description. Subscribe. Change me in index.ts", description: "Example Description. Subscribe. Change me in index.ts",
grantByDefault: true,
}); });
//%endif //%endif
//%if web //%if web
@@ -28,6 +31,7 @@ lib.definePermission({
name: "__plugin_name__.page.view", name: "__plugin_name__.page.view",
title: "Example page view permission", title: "Example page view permission",
description: "Example Description. View. Change me in index.ts", description: "Example Description. View. Change me in index.ts",
grantByDefault: true,
}); });
//%endif //%endif
//%if config //%if config
@@ -31,18 +31,25 @@ export class InstancePlugin extends BaseInstancePlugin {
} }
async onStart() { async onStart() {
// Called once rcon becomes available
this.logger.info("instance::onStart"); this.logger.info("instance::onStart");
} }
async onStop() { async onStop() {
// Called during normal exits before rcon becomes unavailable
this.logger.info("instance::onStop"); this.logger.info("instance::onStop");
} }
onExit() {
// Called during all exits, including crashes and init failures, rcon is not available
this.logger.info("instance::onExit");
}
async onPlayerEvent(event: lib.PlayerEvent) { async onPlayerEvent(event: lib.PlayerEvent) {
this.logger.info(`onPlayerEvent::onPlayerEvent ${JSON.stringify(event)}`); this.logger.info(`onPlayerEvent::onPlayerEvent ${JSON.stringify(event)}`);
//%if module //%if module
if (this.instance.status === "running") { if (this.instance.status === "running") {
this.sendRcon("/sc __plugin_name__.foo()"); await this.sendRcon("/sc __plugin_name__.foo()");
} }
//%endif //%endif
} }
@@ -0,0 +1,13 @@
{
"compilerOptions": {
"composite": true,
"declaration": true,
"declarationMap": true,
"incremental": true,
"sourceMap": true,
"strict": true,
"esModuleInterop": true,
"resolveJsonModule": true,
"skipLibCheck": true,
},
}
@@ -1,8 +1,13 @@
{ {
"extends": "../../tsconfig.browser.json", "extends": "./tsconfig.base.json",
"references": [ "compilerOptions": {
{ "path": "../../packages/lib/tsconfig.browser.json" }, "lib": ["dom", "es2023"],
{ "path": "../../packages/web_ui/tsconfig.browser.json" }, "module": "es2022",
], "moduleResolution": "bundler",
"target": "es2022",
"jsx": "react-jsx",
"noEmitOnError": true,
"outDir": "${configDir}/dist/browser",
},
"include": [ "web/**/*.tsx", "web/**/*.ts", "messages.ts", "package.json" ], "include": [ "web/**/*.tsx", "web/**/*.ts", "messages.ts", "package.json" ],
} }
@@ -1,8 +1,13 @@
{ {
"extends": "../../tsconfig.node.json", "extends": "./tsconfig.base.json",
"references": [ "compilerOptions": {
{ "path": "../../packages/lib/tsconfig.node.json" }, "lib": ["es2023"],
], "module": "node16",
"moduleResolution": "node16",
"target": "es2022",
"forceConsistentCasingInFileNames": true,
"outDir": "${configDir}/dist/node"
},
"include": ["./**/*.ts"], "include": ["./**/*.ts"],
"exclude": ["test/*", "./dist/*"], "exclude": ["test/*", "./dist/*"],
} }
@@ -12,7 +12,7 @@ import React, {
import { import {
BaseWebPlugin, PageLayout, PageHeader, Control, ControlContext, notifyErrorHandler, BaseWebPlugin, PageLayout, PageHeader, Control, ControlContext, notifyErrorHandler,
} from "@clusterio/web_ui"; } from "@clusterio/web_ui";
//%if multi_context // Subscribing requires multi context //%if multi_context // Messages requires multi context
import { import {
PluginExampleEvent, PluginExampleRequest, PluginExampleEvent, PluginExampleRequest,
@@ -20,7 +20,7 @@ import {
//%if controller & web // Subscribing requires web content and the controller //%if controller & web // Subscribing requires web content and the controller
ExampleSubscribableUpdate, ExampleSubscribableValue, ExampleSubscribableUpdate, ExampleSubscribableValue,
//%endif //%endif
//%if multi_context // Subscribing requires multi context //%if multi_context // Messages requires multi context
} from "../messages"; } from "../messages";
//%endif //%endif
@@ -57,7 +57,7 @@ export class WebPlugin extends BaseWebPlugin {
permission: "__plugin_name__.example.permission.subscribe", permission: "__plugin_name__.example.permission.subscribe",
//%endif //%endif
//%if !controller //%if !controller
permission: undefined, // "__plugin_name__.example.permission.request", permission: "__plugin_name__.example.permission.view",
//%endif //%endif
content: <MyTemplatePage/>, content: <MyTemplatePage/>,
}, },
+78 -35
View File
@@ -5,7 +5,7 @@
* @module ctl/ctl * @module ctl/ctl
*/ */
import fs from "fs-extra"; import fs from "fs-extra";
import yargs from "yargs"; import yargs, { type Argv } from "yargs";
import path from "path"; import path from "path";
import { version } from "./package.json"; import { version } from "./package.json";
import setBlocking from "set-blocking"; import setBlocking from "set-blocking";
@@ -143,8 +143,30 @@ interface CtlArguments {
pluginList: string, pluginList: string,
} }
async function startControl() { interface InitializeParameters {
yargs args: CtlArguments;
shouldRun: boolean;
ctlPlugins?: Map<string, BaseCtlPlugin>;
rootCommands?: lib.CommandTree;
controlConfig?: lib.ControlConfig;
}
export async function initialize(
argv: string | string[],
ctlPlugins?: Map<string, BaseCtlPlugin>,
noLoggerTransport?: boolean,
): Promise<InitializeParameters> {
// Build a fresh, isolated yargs parser each time this function is called.
// If the currently loaded yargs object supports .reset() we use that (older versions),
// otherwise we fall back to creating a brand-new parser instance by invoking the
// yargs factory function directly with an empty argv array. This avoids Mocha’s
// own CLI flags (or anything else that touched yargs earlier in the same process)
// from leaking into subsequent parses inside the test runner.
const parser: Argv = typeof (yargs as any).reset === "function"
? (yargs as any).reset()
: (yargs as any)([]);
parser
.scriptName("clusterioctl") .scriptName("clusterioctl")
.usage("$0 <command> [options]") .usage("$0 <command> [options]")
.option("log-level", { .option("log-level", {
@@ -169,44 +191,47 @@ async function startControl() {
}) })
.command("plugin", "Manage available plugins", lib.pluginCommand) .command("plugin", "Manage available plugins", lib.pluginCommand)
.command("control-config", "Manage Control config", lib.configCommand) .command("control-config", "Manage Control config", lib.configCommand)
.wrap(yargs.terminalWidth()) .wrap(parser.terminalWidth())
.help(false) // Disable help to avoid triggering it on the first parse. .help(false) // Disable help to avoid triggering it on the first parse.
; ;
// Parse the args first to get the configured plugin list. // Parse the args first to get the configured plugin list.
// eslint-disable-next-line node/no-sync // eslint-disable-next-line node/no-sync
let args = yargs.parseSync() as CtlArguments; let args = parser.parseSync(argv) as CtlArguments;
// Log stream for the ctl session. // Log stream for the ctl session. Skipped in testing.
logger.add( if (!noLoggerTransport) {
new ConsoleTransport({ logger.add(
errorLevels: Object.keys(levels), new ConsoleTransport({
level: args.logLevel, errorLevels: Object.keys(levels),
format: new lib.TerminalFormat(), level: args.logLevel,
}) format: new lib.TerminalFormat(),
); })
lib.handleUnhandledErrors(); );
lib.handleUnhandledErrors();
logger.verbose(`Loading available plugins from ${args.pluginList}`);
let pluginList = await lib.loadPluginList(args.pluginList);
// If the command is plugin management we don't try to load plugins
if (args._[0] === "plugin") {
await lib.handlePluginCommand(args, pluginList, args.pluginList);
return;
} }
logger.verbose("Loading Plugins"); // Discover and load plugins. This check exists to allow tests to inject plugins.
let ctlPlugins = await loadPlugins(pluginList); if (!ctlPlugins || args._[0] === "plugin") {
logger.verbose(`Loading available plugins from ${args.pluginList}`);
const pluginList = await lib.loadPluginList(args.pluginList);
// Add all cluster management commands including ones from plugins // If the command is plugin management we don't try to load plugins
let rootCommands = await commands.registerCommands(ctlPlugins, yargs); if (args._[0] === "plugin") {
await lib.handlePluginCommand(args, pluginList, args.pluginList);
return { args, shouldRun: false };
}
// Reparse after commands have been added with help and strict checking. logger.verbose("Loading Plugins");
args = yargs ctlPlugins = await loadPlugins(pluginList);
}
// Add all commands including from plugins and reparse with help and strict checking.
const rootCommands = await commands.registerCommands(ctlPlugins, parser);
args = parser
.help() .help()
.strict() .strict()
.parse() as CtlArguments .parse(argv) as CtlArguments
; ;
let controlConfig; let controlConfig;
@@ -226,25 +251,41 @@ async function startControl() {
} }
if (args._.length === 0) { if (args._.length === 0) {
yargs.showHelp(); parser.showHelp();
yargs.exit(1, undefined as unknown as Error); // Type definition file is wrong. parser.exit(1, undefined as unknown as Error); // Type definition file is wrong.
} }
// Handle the control-config command before trying to connect. // Handle the control-config command before trying to connect.
if (args._[0] === "control-config") { if (args._[0] === "control-config") {
await lib.handleConfigCommand(args, controlConfig); await lib.handleConfigCommand(args, controlConfig);
return; return { args, controlConfig, ctlPlugins, rootCommands, shouldRun: false };
} }
// Determine which command is being executed. return { args, controlConfig, ctlPlugins, rootCommands, shouldRun: true };
}
export function selectTargetCommand(args: CtlArguments, rootCommands: lib.CommandTree): lib.Command {
let commandPath = [...args._] as string[]; let commandPath = [...args._] as string[];
let targetCommand: lib.CommandTree | lib.Command = rootCommands; let targetCommand: lib.CommandTree | lib.Command = rootCommands;
while (commandPath.length && targetCommand instanceof lib.CommandTree) { while (commandPath.length && targetCommand instanceof lib.CommandTree) {
targetCommand = targetCommand.get(commandPath.shift()!)!; targetCommand = targetCommand.get(commandPath.shift()!)!;
} }
assert(targetCommand instanceof lib.Command); assert(targetCommand instanceof lib.Command);
return targetCommand;
}
async function startControl() {
const {
args,
shouldRun,
ctlPlugins,
rootCommands,
controlConfig,
} = await initialize(process.argv.slice(2));
if (!shouldRun || !ctlPlugins || !rootCommands || !controlConfig) {
return;
}
// The remaining commands require connecting to the controller.
if (!controlConfig.get("control.controller_url") || !controlConfig.get("control.controller_token")) { if (!controlConfig.get("control.controller_url") || !controlConfig.get("control.controller_token")) {
logger.error("Missing URL and/or token to connect with. See README.md for setting up access."); logger.error("Missing URL and/or token to connect with. See README.md for setting up access.");
process.exitCode = 1; process.exitCode = 1;
@@ -263,6 +304,7 @@ async function startControl() {
tlsCa, tlsCa,
controlConfig.get("control.controller_token")!, controlConfig.get("control.controller_token")!,
); );
let control = new Control(controlConnector, controlConfig, tlsCa, ctlPlugins); let control = new Control(controlConnector, controlConfig, tlsCa, ctlPlugins);
try { try {
await controlConnector.connect(); await controlConnector.connect();
@@ -278,12 +320,13 @@ async function startControl() {
control.shutdown().catch(err => { control.shutdown().catch(err => {
setBlocking(true); setBlocking(true);
logger.error(err.stack); logger.error(err.stack);
// eslint-disable-next-line node/no-process-exit
process.exit(1); process.exit(1);
}); });
}); });
try { try {
const targetCommand = selectTargetCommand(args, rootCommands);
await targetCommand.run(args, control); await targetCommand.run(args, control);
} catch (err) { } catch (err) {
+167 -74
View File
@@ -197,28 +197,24 @@ controllerConfigCommands.add(new lib.Command({
editorSpawn.on("data", (data) => { editorSpawn.on("data", (data) => {
process.stdout.pipe(data); process.stdout.pipe(data);
}); });
let doneEmitter = new events.EventEmitter(); await events.once(editorSpawn, "exit");
editorSpawn.on("exit", async (exit) => { const data = await fs.readFile(tmpFile, "utf8");
const data = await fs.readFile(tmpFile, "utf8"); const final = await configToKeyVal(data);
const final = await configToKeyVal(data); for (let index in final) {
for (let index in final) { if (index in final) {
if (index in final) { try {
try { await control.send(new lib.ControllerConfigSetFieldRequest(
await control.send(new lib.ControllerConfigSetFieldRequest( index,
index, final[index],
final[index], ));
)); } catch (err) {
} catch (err) { // eslint-disable-next-line
// eslint-disable-next-line print(`Attempt to set ${index} to ${final[index] || String(null)} failed; set back to previous value.`);
print(`Attempt to set ${index} to ${final[index] || String(null)} failed; set back to previous value.`); print(err);
print(err); // If the string is empty, it's better to just print "" instead of nothing
// If the string is empty, it's better to just print "" instead of nothing
}
} }
} }
doneEmitter.emit("dot_on_done"); }
});
await events.once(doneEmitter, "dot_on_done");
try { try {
await fs.unlink(tmpFile); await fs.unlink(tmpFile);
} catch (err) { } catch (err) {
@@ -487,33 +483,29 @@ hostConfigCommands.add(new lib.Command({
editorSpawn.on("data", (data) => { editorSpawn.on("data", (data) => {
process.stdout.pipe(data); process.stdout.pipe(data);
}); });
let doneEmitter = new events.EventEmitter(); await events.once(editorSpawn, "exit");
editorSpawn.on("exit", async (exit) => { const data = await fs.readFile(tmpFile, "utf8");
const data = await fs.readFile(tmpFile, "utf8"); const final = await configToKeyVal(data);
const final = await configToKeyVal(data); for (let index in final) {
for (let index in final) { if (index in final) {
if (index in final) { try {
try { await control.sendTo({ hostId }, new lib.HostConfigSetFieldRequest(
await control.sendTo({ hostId }, new lib.HostConfigSetFieldRequest( index,
index, final[index],
final[index], ));
)); } catch (err) {
} catch (err) { // eslint-disable-next-line
// eslint-disable-next-line print(`\n\n\nAttempt to set ${index} to ${final[index] || String(null)} failed; set back to previous value.`);
print(`\n\n\nAttempt to set ${index} to ${final[index] || String(null)} failed; set back to previous value.`); // If the string is empty, it's better to just print "" instead of nothing
// If the string is empty, it's better to just print "" instead of nothing print("This message shouldn't normally appear; if the below message does not indicate it");
print("This message shouldn't normally appear; if the below message does not indicate it"); print("was a user mistake, please report it to the clustorio devs.");
print("was a user mistake, please report it to the clustorio devs."); // added this because it could be a missed entry in disallowedList
// added this because it could be a missed entry in disallowedList // i've added all the vanilla clustorio configs, but there may be
// i've added all the vanilla clustorio configs, but there may be // some modded ones that need to be added.
// some modded ones that need to be added. print(err);
print(err);
}
} }
} }
doneEmitter.emit("dot_on_done"); }
});
await events.once(doneEmitter, "dot_on_done");
try { try {
await fs.unlink(tmpFile); await fs.unlink(tmpFile);
} catch (err) { } catch (err) {
@@ -732,34 +724,30 @@ instanceConfigCommands.add(new lib.Command({
editorSpawn.on("data", (data) => { editorSpawn.on("data", (data) => {
process.stdout.pipe(data); process.stdout.pipe(data);
}); });
let doneEmitter = new events.EventEmitter(); await events.once(editorSpawn, "exit");
editorSpawn.on("exit", async (exit) => { const data = await fs.readFile(tmpFile, "utf8");
const data = await fs.readFile(tmpFile, "utf8"); const final = await configToKeyVal(data);
const final = await configToKeyVal(data); for (let index in final) {
for (let index in final) { if (index in final) {
if (index in final) { try {
try { await control.send(new lib.InstanceConfigSetFieldRequest(
await control.send(new lib.InstanceConfigSetFieldRequest( instanceId,
instanceId, index,
index, final[index],
final[index], ));
)); } catch (err) {
} catch (err) { // eslint-disable-next-line
// eslint-disable-next-line print(`\n\n\nAttempt to set ${index} to ${final[index] || String(null)} failed; set back to previous value.`);
print(`\n\n\nAttempt to set ${index} to ${final[index] || String(null)} failed; set back to previous value.`); // If the string is empty, it's better to just print "" instead of nothing
// If the string is empty, it's better to just print "" instead of nothing print("This message shouldn't normally appear; if the below message does not indicate it");
print("This message shouldn't normally appear; if the below message does not indicate it"); print("was a user mistake, please report it to the clustorio devs.");
print("was a user mistake, please report it to the clustorio devs."); // added this because it could be a missed entry in disallowedList
// added this because it could be a missed entry in disallowedList // i've added all the vanilla clustorio configs, but there may be
// i've added all the vanilla clustorio configs, but there may be // some modded ones that need to be added.
// some modded ones that need to be added. print(err);
print(err);
}
} }
} }
doneEmitter.emit("dot_on_done"); }
});
await events.once(doneEmitter, "dot_on_done");
try { try {
await fs.unlink(tmpFile); await fs.unlink(tmpFile);
} catch (err) { } catch (err) {
@@ -1050,17 +1038,87 @@ instanceCommands.add(new lib.Command({
definition: ["start <instance>", "Start instance", (yargs) => { definition: ["start <instance>", "Start instance", (yargs) => {
yargs.positional("instance", { describe: "Instance to start", type: "string" }); yargs.positional("instance", { describe: "Instance to start", type: "string" });
yargs.options({ yargs.options({
"save": { describe: "Save load, defaults to latest", nargs: 1, type: "string" }, "save": { describe: "Save to load, defaults to latest", nargs: 1, type: "string" },
"keep-open": { describe: "Keep console open", nargs: 0, type: "boolean", default: false }, "keep-open": { describe: "Keep console open", nargs: 0, type: "boolean", default: false },
}); });
}], }],
handler: async function(args: { instance: string, save?: string, keepOpen: boolean }, control: Control) { handler: async function(args: { instance: string, save?: string, keepOpen: boolean }, control: Control) {
let instanceId = await lib.resolveInstance(control, args.instance); const instanceId = await lib.resolveInstance(control, args.instance);
await control.setLogSubscriptions({ instanceIds: [instanceId] }); await control.setLogSubscriptions({ instanceIds: [instanceId] });
await control.sendTo({ instanceId }, new lib.InstanceStartRequest(args.save)); await control.sendTo({ instanceId }, new lib.InstanceStartRequest(args.save));
control.keepOpen = args.keepOpen; control.keepOpen = args.keepOpen;
}, },
})); }));
instanceCommands.add(new lib.Command({
definition: ["restart <instance>", "Restart instance", (yargs) => {
yargs.positional("instance", { describe: "Instance to restart", type: "string" });
yargs.options({
"save": { describe: "Save to load, defaults to latest", nargs: 1, type: "string" },
"keep-open": { describe: "Keep console open", nargs: 0, type: "boolean", default: false },
});
}],
handler: async function(args: { instance: string, save?: string, keepOpen: boolean }, control: Control) {
const instanceId = await lib.resolveInstance(control, args.instance);
await control.setLogSubscriptions({ instanceIds: [instanceId] });
await control.sendTo({ instanceId }, new lib.InstanceRestartRequest(args.save));
control.keepOpen = args.keepOpen;
},
}));
instanceCommands.add(new lib.Command({
definition: ["start-all", "Start all stopped instances (respects exclude_from_start_all setting)", (yargs) => {
yargs.options({
"force": {
describe: "Start instances even if they have exclude_from_start_all set",
nargs: 0,
type: "boolean",
default: false,
},
});
}],
handler: async function(args: { force: boolean }, control: Control) {
// Get all instances
const instances = await control.send(new lib.InstanceDetailsListRequest());
// Filter instances that should be started
const instancesToStart = instances.filter((instance: lib.InstanceDetails) => {
// Only start instances that are currently stopped
if (instance.status !== "stopped") {
return false;
}
// Respect exclude_from_start_all setting unless --force is used
if (!args.force && instance.excludeFromStartAll) {
return false;
}
return true;
});
if (instancesToStart.length === 0) {
print("No instances to start.");
return;
}
print(`Starting ${instancesToStart.length} instance(s):`);
for (const instance of instancesToStart) {
print(` - ${instance.name} (ID: ${instance.id})`);
}
// Start all filtered instances
const startPromises = instancesToStart.map(async (instance: lib.InstanceDetails) => {
try {
await control.sendTo({ instanceId: instance.id }, new lib.InstanceStartRequest());
print(`✓ Started ${instance.name}`);
} catch (error) {
print(`✗ Failed to start ${instance.name}: ${error}`);
}
});
await Promise.all(startPromises);
print("Start all operation completed.");
},
}));
instanceCommands.add(new lib.Command({ instanceCommands.add(new lib.Command({
definition: ["load-scenario <instance> <scenario>", "Start instance by loading a scenario", (yargs) => { definition: ["load-scenario <instance> <scenario>", "Start instance by loading a scenario", (yargs) => {
@@ -1107,6 +1165,41 @@ instanceCommands.add(new lib.Command({
}, },
})); }));
instanceCommands.add(new lib.Command({
definition: ["stop-all", "Stop all running instances", () => {}],
handler: async function(_args, control: Control) {
// Get all instances
const instances = await control.send(new lib.InstanceDetailsListRequest());
// Filter instances that should be stopped
const instancesToStop = instances
.filter((instance: lib.InstanceDetails) => ["starting", "running"].includes(instance.status));
if (instancesToStop.length === 0) {
print("No instances to stop.");
return;
}
print(`Stopping ${instancesToStop.length} instance(s):`);
for (const instance of instancesToStop) {
print(` - ${instance.name} (ID: ${instance.id})`);
}
// Stop all filtered instances
const stopPromises = instancesToStop.map(async (instance: lib.InstanceDetails) => {
try {
await control.sendTo({ instanceId: instance.id }, new lib.InstanceStopRequest());
print(`✓ Stopped ${instance.name}`);
} catch (error) {
print(`✗ Failed to stop ${instance.name}: ${error}`);
}
});
await Promise.all(stopPromises);
print("Stop all operation completed.");
},
}));
instanceCommands.add(new lib.Command({ instanceCommands.add(new lib.Command({
definition: ["kill <instance>", "Kill instance", (yargs) => { definition: ["kill <instance>", "Kill instance", (yargs) => {
yargs.positional("instance", { describe: "Instance to kill", type: "string" }); yargs.positional("instance", { describe: "Instance to kill", type: "string" });
@@ -2059,7 +2152,7 @@ userCommands.add(new lib.Command({
exportType = "whitelist"; exportType = "whitelist";
} }
fs.writeJSON(args.filepath, await control.send( await fs.writeJSON(args.filepath, await control.send(
new lib.UserBulkExportRequest(exportType) new lib.UserBulkExportRequest(exportType)
), { spaces: 2 }); ), { spaces: 2 });
print(`Exported ${exportType} to ${args.filepath}`); print(`Exported ${exportType} to ${args.filepath}`);
+2 -2
View File
@@ -243,7 +243,7 @@ async function startHost() {
if (secondSigint) { if (secondSigint) {
setBlocking(true); setBlocking(true);
logger.fatal("Caught second interrupt, terminating immediately"); logger.fatal("Caught second interrupt, terminating immediately");
// eslint-disable-next-line node/no-process-exit
process.exit(1); process.exit(1);
} }
@@ -256,7 +256,7 @@ async function startHost() {
if (secondSigterm) { if (secondSigterm) {
setBlocking(true); setBlocking(true);
logger.fatal("Caught second termination, terminating immediately"); logger.fatal("Caught second termination, terminating immediately");
// eslint-disable-next-line node/no-process-exit
process.exit(1); process.exit(1);
} }
+2 -2
View File
@@ -250,7 +250,7 @@ export class HostRouter {
* Connects to the controller over the WebSocket and manages intsances. * Connects to the controller over the WebSocket and manages intsances.
*/ */
export default class Host extends lib.Link { export default class Host extends lib.Link {
declare ["connector"]: HostConnector; declare "connector": HostConnector;
router = new HostRouter(this); router = new HostRouter(this);
/** /**
@@ -1201,7 +1201,7 @@ export default class Host extends lib.Link {
+------------------------------------------------------------+ +------------------------------------------------------------+
${err.stack}` ${err.stack}`
); );
// eslint-disable-next-line node/no-process-exit
process.exit(1); process.exit(1);
} }
} }
+9
View File
@@ -289,6 +289,7 @@ export default class Instance extends lib.Link {
this.handle(lib.InstanceSaveDetailsListRequest, this.handleInstanceSaveDetailsListRequest.bind(this)); this.handle(lib.InstanceSaveDetailsListRequest, this.handleInstanceSaveDetailsListRequest.bind(this));
this.handle(lib.InstanceCreateSaveRequest, this.handleInstanceCreateSaveRequest.bind(this)); this.handle(lib.InstanceCreateSaveRequest, this.handleInstanceCreateSaveRequest.bind(this));
this.handle(lib.InstanceExportDataRequest, this.handleInstanceExportDataRequest.bind(this)); this.handle(lib.InstanceExportDataRequest, this.handleInstanceExportDataRequest.bind(this));
this.handle(lib.InstanceRestartRequest, this.handleInstanceRestartRequest.bind(this));
this.handle(lib.InstanceStopRequest, this.handleInstanceStopRequest.bind(this)); this.handle(lib.InstanceStopRequest, this.handleInstanceStopRequest.bind(this));
this.handle(lib.InstanceKillRequest, this.handleInstanceKillRequest.bind(this)); this.handle(lib.InstanceKillRequest, this.handleInstanceKillRequest.bind(this));
this.handle(lib.InstanceSendRconRequest, this.handleInstanceSendRconRequest.bind(this)); this.handle(lib.InstanceSendRconRequest, this.handleInstanceSendRconRequest.bind(this));
@@ -1300,6 +1301,14 @@ end`.replace(/\r?\n/g, " ");
} }
} }
async handleInstanceRestartRequest(request: lib.InstanceRestartRequest) {
await this.stop();
// Stopping invalidates this instance object, a new one must be created by the host
// To do this we simulate a waking an instance and sending a start request
const instanceConnection = await this._host._connectInstance(this.id);
await instanceConnection.instance.handleInstanceStartRequest(new lib.InstanceStartRequest(request.save));
}
async handleInstanceStopRequest() { async handleInstanceStopRequest() {
await this.stop(); await this.stop();
} }
+1 -1
View File
@@ -221,7 +221,7 @@ async function loadLayeredIcon(
iconLayer.scale(realScale); iconLayer.scale(realScale);
} }
// eslint-disable-next-line no-loop-func
iconLayer.scan(0, 0, iconLayer.bitmap.width, iconLayer.bitmap.height, (x, y, sidx) => { iconLayer.scan(0, 0, iconLayer.bitmap.width, iconLayer.bitmap.height, (x, y, sidx) => {
x += xs; x += xs;
y += ys; y += ys;
+29 -3
View File
@@ -454,6 +454,32 @@ export interface FactorioServerOptions {
shutdownTimeoutMs?: number, shutdownTimeoutMs?: number,
} }
type FactorioServerEvents = {
// Public Events
"stdout": [ rawLine: Buffer ],
"stderr": [ rawLine: Buffer ],
"output": [ parsed: lib.ParsedFactorioOutput, line: string ]
"error": [ err: any ],
"rcon-ready": [],
"game-ready": [],
"exit": [],
"autosave-start": [ name: string ],
"autosave-finished": [ name: string ],
"save-finished": [],
"whitelist-change": [ added: string[], removed: string[] ],
// Private Events
"_autosave": [ name: string ]
"_saving": [],
"_saved": [],
// IPS events
[ipcEvent: `ipc-${string}`]: [ event: any ],
};
/** /**
* Factorio Server interface * Factorio Server interface
* *
@@ -473,7 +499,7 @@ export interface FactorioServerOptions {
* - exit - invoked when the sterver has exited * - exit - invoked when the sterver has exited
* @extends events.EventEmitter * @extends events.EventEmitter
*/ */
export class FactorioServer extends events.EventEmitter { export class FactorioServer extends events.EventEmitter<FactorioServerEvents> {
/** Path to executable to invoke when starting the server */ /** Path to executable to invoke when starting the server */
executablePath?: string; executablePath?: string;
/** UDP port used for hosting the Factorio game server on */ /** UDP port used for hosting the Factorio game server on */
@@ -721,7 +747,7 @@ export class FactorioServer extends events.EventEmitter {
this._rconClient.on("authenticated", () => { this._rconClient.on("authenticated", () => {
this._rconReady = true; this._rconReady = true;
this.emit("rcon-ready"); this.emit("rcon-ready");
}); });
this._rconClient.on("end", () => { this._rconClient.on("end", () => {
this._rconClient = null; this._rconClient = null;
if (!this._rconReady) { if (!this._rconReady) {
@@ -1212,7 +1238,7 @@ export class FactorioServer extends events.EventEmitter {
// complete before the RCON connection can be used // complete before the RCON connection can be used
if (!this._rconReady) { if (!this._rconReady) {
// Not using events.once here to avoid throwing on error events. // Not using events.once here to avoid throwing on error events.
await new Promise(resolve => this.once("rcon-ready", resolve)); await new Promise<void>(resolve => this.once("rcon-ready", resolve));
} }
// The Factorio server may have decided to get ahead of us and // The Factorio server may have decided to get ahead of us and
-1
View File
@@ -15,4 +15,3 @@ export * from "./src/subscriptions";
export { default as ExponentialBackoff } from "./src/ExponentialBackoff"; export { default as ExponentialBackoff } from "./src/ExponentialBackoff";
export { default as RateLimiter } from "./src/RateLimiter"; export { default as RateLimiter } from "./src/RateLimiter";
export { default as TypedEventEmitter } from "./src/TypedEventEmitter";
+7 -7
View File
@@ -1,10 +1,10 @@
export interface BuildArgs { export interface BuildArgs {
factorioVersion?: string; factorioVersion?: string;
dependencies?: Record<string, string>; dependencies?: Record<string, string>;
clean?: boolean; clean?: boolean;
pack?: boolean; pack?: boolean;
build?: boolean; build?: boolean;
outputDir: string; outputDir: string;
sourceDir: string; sourceDir: string;
}; };
export function build(args: BuildArgs): Promise<void>; export function build(args: BuildArgs): Promise<void>;
-1
View File
@@ -35,4 +35,3 @@ export * from "./src/rce_ops";
export { default as ExponentialBackoff } from "./src/ExponentialBackoff"; export { default as ExponentialBackoff } from "./src/ExponentialBackoff";
export { default as ModStore } from "./src/ModStore"; export { default as ModStore } from "./src/ModStore";
export { default as RateLimiter } from "./src/RateLimiter"; export { default as RateLimiter } from "./src/RateLimiter";
export { default as TypedEventEmitter } from "./src/TypedEventEmitter";
+4 -4
View File
@@ -1,16 +1,16 @@
import fs from "fs-extra"; import fs from "fs-extra";
import path from "path"; import path from "path";
import events from "events";
import { Static } from "@sinclair/typebox"; import { Static } from "@sinclair/typebox";
import { logger } from "./logging"; import { logger } from "./logging";
import { integerModVersion, ModInfo, ModPack, ModRecord } from "./data"; import { ModInfo, ModPack } from "./data";
import TypedEventEmitter from "./TypedEventEmitter";
import { safeOutputFile } from "./file_ops"; import { safeOutputFile } from "./file_ops";
import { Writable } from "stream"; import { Writable } from "stream";
import { ModPortalReleaseSchema, ModPortalDetailsSchema } from "./data/messages_mod"; import { ModPortalReleaseSchema, ModPortalDetailsSchema } from "./data/messages_mod";
export interface ModStoreEvents { export interface ModStoreEvents {
/** A stored mod was created, updated or deleted */ /** A stored mod was created, updated or deleted */
change: (mod: ModInfo) => void; "change": [ mod: ModInfo ];
} }
interface ModsInfoResponse { interface ModsInfoResponse {
@@ -37,7 +37,7 @@ interface ModPortalResponse {
results: Static<typeof ModPortalDetailsSchema>[]; results: Static<typeof ModPortalDetailsSchema>[];
} }
export default class ModStore extends TypedEventEmitter<keyof ModStoreEvents, ModStoreEvents> { export default class ModStore extends events.EventEmitter<ModStoreEvents> {
constructor( constructor(
public modsDirectory: string, public modsDirectory: string,
public files: Map<string, ModInfo>, public files: Map<string, ModInfo>,
-27
View File
@@ -1,27 +0,0 @@
import EventEmitter from "events";
/**
* Type checked version of EventEmitter
*
* @example
* ```ts
* interface Events {
* "foo": (a: number, b: number) => void,
* "bar": (spam: string) => void,
* }
*
* class Emitter extends TypedEventEmitter<keyof Events, Events> {}
*
* const e = new Emitter();
* e.emit("foo", 1, 2) // type checked arguments
* ```
*/
export default abstract class TypedEventEmitter<
Keys extends string,
Events extends Record<Keys, (...args: [...any]) => void>,
> extends EventEmitter {
declare ["on"]: <E extends Keys>(event: E, listener: Events[E]) => this;
declare ["off"]: <E extends Keys>(event: E, listener: Events[E]) => this;
declare ["once"]: <E extends Keys>(event: E, listener: Events[E]) => this;
declare ["emit"]: <E extends Keys>(event: E, ...args: Parameters<Events[E]>) => boolean;
}
+3 -6
View File
@@ -1,8 +1,8 @@
// Configuration classes // Configuration classes
import { Type, Static } from "@sinclair/typebox"; import { Type, Static } from "@sinclair/typebox";
import * as fs from "fs-extra"; import * as fs from "fs-extra";
import events from "events";
import TypedEventEmitter from "../TypedEventEmitter";
import isDeepStrictEqual from "../is_deep_strict_equal"; import isDeepStrictEqual from "../is_deep_strict_equal";
import { basicType } from "../helpers"; import { basicType } from "../helpers";
import * as libSchema from "../schema"; import * as libSchema from "../schema";
@@ -152,7 +152,7 @@ function defaultValue(def: FieldDefinition) {
} }
export type ConfigEvents = { export type ConfigEvents = {
fieldChanged: (name: string, curr: FieldValue, prev: FieldValue) => void; fieldChanged: [ name: string, curr: FieldValue, prev: FieldValue ],
} }
export enum ConfigAccess { export enum ConfigAccess {
@@ -178,10 +178,7 @@ export enum ConfigAccess {
*/ */
export class Config< export class Config<
Fields extends { [Field in keyof Fields]: FieldValue }, Fields extends { [Field in keyof Fields]: FieldValue },
> extends TypedEventEmitter< > extends events.EventEmitter<ConfigEvents> {
keyof ConfigEvents,
ConfigEvents
> {
/** /**
* Mapping of config name to field meta data * Mapping of config name to field meta data
* Note that mutating this object will lead to unexpected behaviour. * Note that mutating this object will lead to unexpected behaviour.
+6
View File
@@ -398,6 +398,7 @@ export interface InstanceConfigFields {
"instance.id": number; "instance.id": number;
"instance.assigned_host": number | null; "instance.assigned_host": number | null;
"instance.auto_start": boolean; "instance.auto_start": boolean;
"instance.exclude_from_start_all": boolean;
"factorio.version": string; "factorio.version": string;
"factorio.executable_path": string | null; "factorio.executable_path": string | null;
@@ -465,6 +466,11 @@ export class InstanceConfig extends classes.Config<InstanceConfigFields> {
type: "boolean", type: "boolean",
initialValue: false, initialValue: false,
}, },
"instance.exclude_from_start_all": {
description: "Exclude this instance from the 'Start all' button operation",
type: "boolean",
initialValue: false,
},
"factorio.version": { "factorio.version": {
description: "Version of the game to run, use latest to run the latest installed version", description: "Version of the game to run, use latest to run the latest installed version",
restartRequired: true, restartRequired: true,
+3 -3
View File
@@ -161,7 +161,7 @@ export default class ModPack {
if (json.name) { modPack.name = json.name; } if (json.name) { modPack.name = json.name; }
if (json.description) { modPack.description = json.description; } if (json.description) { modPack.description = json.description; }
if (json.factorio_version) { modPack.factorioVersion = json.factorio_version; } if (json.factorio_version) { modPack.factorioVersion = json.factorio_version; }
if (json.mods) { modPack.mods = new Map(json.mods.map(m => [m.name, m])); } if (json.mods) { modPack.mods = new Map(json.mods.map((m: ModRecord) => [m.name, m])); }
if (json.settings) { if (json.settings) {
modPack.settings = { modPack.settings = {
"startup": new Map(Object.entries(json.settings["startup"])), "startup": new Map(Object.entries(json.settings["startup"])),
@@ -218,7 +218,7 @@ export default class ModPack {
let buf = Buffer.from(modPackString, "base64"); let buf = Buffer.from(modPackString, "base64");
try { try {
// eslint-disable-next-line node/no-sync // eslint-disable-next-line node/no-sync
buf = zlib.inflateSync(buf); buf = Buffer.from(zlib.inflateSync(buf));
} catch (err: any) { } catch (err: any) {
if (err.code.startsWith("Z_")) { if (err.code.startsWith("Z_")) {
throw new Error("Malformed mod pack string: zlib inflate failed"); throw new Error("Malformed mod pack string: zlib inflate failed");
@@ -291,7 +291,7 @@ export default class ModPack {
const sizeBytes = uint32Bytes(entries.length); const sizeBytes = uint32Bytes(entries.length);
const itemBytes = entries.flatMap(([key, item]) => [ const itemBytes = entries.flatMap(([key, item]) => [
immutableStringBytes(key), immutableStringBytes(key),
// eslint-disable-next-line no-use-before-define
propertyTreeBytes(item), propertyTreeBytes(item),
]); ]);
return Buffer.concat([ return Buffer.concat([
+9 -9
View File
@@ -10,6 +10,8 @@ export default class Role {
public name: string, public name: string,
public description: string, public description: string,
public permissions: Set<string>, public permissions: Set<string>,
public updatedAtMs = 0,
public isDeleted = false,
) { } ) { }
static jsonSchema = Type.Object({ static jsonSchema = Type.Object({
@@ -17,22 +19,18 @@ export default class Role {
name: Type.String(), name: Type.String(),
description: Type.String(), description: Type.String(),
permissions: Type.Array(Type.String()), permissions: Type.Array(Type.String()),
updated_at_ms: Type.Optional(Type.Number()),
is_deleted: Type.Optional(Type.Boolean()),
}); });
static remapPermission(permission: string) {
// migrate: core.instance.save.list.subscribe was renamed in alpha 17
if (permission === "core.instance.save.list.subscribe") {
return "core.instance.save.subscribe";
}
return permission;
}
static fromJSON(json: Static<typeof this.jsonSchema>) { static fromJSON(json: Static<typeof this.jsonSchema>) {
return new this( return new this(
json.id, json.id,
json.name, json.name,
json.description, json.description,
new Set(json.permissions.map(this.remapPermission)), new Set(json.permissions),
json.updated_at_ms,
json.is_deleted,
); );
} }
@@ -42,6 +40,8 @@ export default class Role {
name: this.name, name: this.name,
description: this.description, description: this.description,
permissions: [...this.permissions], permissions: [...this.permissions],
updated_at_ms: this.updatedAtMs,
is_deleted: this.isDeleted,
}; };
} }
+1
View File
@@ -21,5 +21,6 @@ export * from "./messages_host";
export * from "./messages_instance"; export * from "./messages_instance";
export * from "./messages_mod"; export * from "./messages_mod";
export * from "./messages_user"; export * from "./messages_user";
export * from "./messages_role";
export * from "./messages_plugin"; export * from "./messages_plugin";
export * from "./version"; export * from "./version";
+3 -3
View File
@@ -1,6 +1,6 @@
// Note: Run compile_validator script after making changes to this file. // Note: Run compile_validator script after making changes to this file.
import { TSchema, Type, Static } from "@sinclair/typebox"; import { TSchema, Type, Static } from "@sinclair/typebox";
// eslint-disable-next-line node/no-missing-import
import messageValidate from "./message_validate"; // generated file import messageValidate from "./message_validate"; // generated file
import { StringEnum } from "./composites"; import { StringEnum } from "./composites";
@@ -154,7 +154,7 @@ export class Message {
static validate = messageValidate; static validate = messageValidate;
static fromJSON(json: any) { static fromJSON(json: any) {
/* eslint-disable no-use-before-define */
if (json.type === "hello") { return MessageHello.fromJSON(json); } if (json.type === "hello") { return MessageHello.fromJSON(json); }
if (json.type === "registerHost") { return MessageRegisterHost.fromJSON(json); } if (json.type === "registerHost") { return MessageRegisterHost.fromJSON(json); }
if (json.type === "registerControl") { return MessageRegisterControl.fromJSON(json); } if (json.type === "registerControl") { return MessageRegisterControl.fromJSON(json); }
@@ -168,7 +168,7 @@ export class Message {
if (json.type === "responseError") { return MessageResponseError.fromJSON(json); } if (json.type === "responseError") { return MessageResponseError.fromJSON(json); }
if (json.type === "event") { return MessageEvent.fromJSON(json); } if (json.type === "event") { return MessageEvent.fromJSON(json); }
if (json.type === "disconnect") { return MessageDisconnect.fromJSON(json); } if (json.type === "disconnect") { return MessageDisconnect.fromJSON(json); }
/* eslint-enable no-use-before-define */
throw new Error(`Unrecognized message type ${json.type}`); throw new Error(`Unrecognized message type ${json.type}`);
} }
} }
@@ -45,6 +45,7 @@ export class InstanceDetails {
public factorioVersion: string | undefined, public factorioVersion: string | undefined,
/** Millisecond Unix timestamp this entry was last updated at */ /** Millisecond Unix timestamp this entry was last updated at */
public updatedAtMs = 0, public updatedAtMs = 0,
public excludeFromStartAll = false,
) { } ) { }
static jsonSchema = Type.Object({ static jsonSchema = Type.Object({
@@ -58,6 +59,7 @@ export class InstanceDetails {
]), ]),
"factorioVersion": Type.Optional(Type.String()), "factorioVersion": Type.Optional(Type.String()),
"updatedAtMs": Type.Optional(Type.Number()), "updatedAtMs": Type.Optional(Type.Number()),
"excludeFromStartAll": Type.Optional(Type.Boolean()),
}); });
static fromJSON(json: Static<typeof this.jsonSchema>) { static fromJSON(json: Static<typeof this.jsonSchema>) {
@@ -69,6 +71,7 @@ export class InstanceDetails {
json.status, json.status,
json.factorioVersion, json.factorioVersion,
json.updatedAtMs, json.updatedAtMs,
json.excludeFromStartAll,
); );
} }
@@ -284,6 +287,26 @@ export class InstanceStartRequest {
} }
} }
export class InstanceRestartRequest {
declare ["constructor"]: typeof InstanceRestartRequest;
static type = "request" as const;
static src = ["control", "controller"] as const;
static dst = "instance" as const;
static permission = "core.instance.restart" as const;
constructor(
public save?: string,
) { }
static jsonSchema = Type.Object({
"save": Type.Optional(Type.String()),
});
static fromJSON(json: Static<typeof this.jsonSchema>) {
return new this(json.save);
}
}
export class SaveDetails { export class SaveDetails {
constructor( constructor(
public instanceId: number, public instanceId: number,
+134
View File
@@ -0,0 +1,134 @@
import { Type, Static } from "@sinclair/typebox";
import { JsonNumber, jsonArray } from "./composites";
import Permission from "./Permission";
import Role from "./Role";
export class PermissionListRequest {
declare ["constructor"]: typeof PermissionListRequest;
static type = "request" as const;
static src = "control" as const;
static dst = "controller" as const;
static permission = "core.permission.list" as const;
static Response = jsonArray(Permission);
}
export class RoleListRequest {
declare ["constructor"]: typeof RoleListRequest;
static type = "request" as const;
static src = "control" as const;
static dst = "controller" as const;
static permission = "core.role.list" as const;
static Response = jsonArray(Role);
}
export class RoleUpdatesEvent {
declare ["constructor"]: typeof RoleUpdatesEvent;
static type = "event" as const;
static src = "controller" as const;
static dst = "control" as const;
static permission = "core.role.subscribe" as const;
constructor(
public updates: Role[],
) { }
static jsonSchema = Type.Object({
"updates": Type.Array(Role.jsonSchema),
});
static fromJSON(json: Static<typeof this.jsonSchema>) {
return new this(json.updates.map(update => Role.fromJSON(update)));
}
}
export class RoleCreateRequest {
declare ["constructor"]: typeof RoleCreateRequest;
static type = "request" as const;
static src = "control" as const;
static dst = "controller" as const;
static permission = "core.role.create" as const;
constructor(
public name: string,
public description: string,
public permissions: string[],
) { }
static jsonSchema = Type.Object({
name: Type.String(),
description: Type.String(),
permissions: Type.Array(Type.String()),
});
static fromJSON(json: Static<typeof this.jsonSchema>) {
return new this(json.name, json.description, json.permissions);
}
static Response = JsonNumber;
}
export class RoleUpdateRequest {
declare ["constructor"]: typeof RoleUpdateRequest;
static type = "request" as const;
static src = "control" as const;
static dst = "controller" as const;
static permission = "core.role.update" as const;
constructor(
public id: number,
public name: string,
public description: string,
public permissions: string[],
) { }
static jsonSchema = Type.Object({
id: Type.Integer(),
name: Type.String(),
description: Type.String(),
permissions: Type.Array(Type.String()),
});
static fromJSON(json: Static<typeof this.jsonSchema>) {
return new this(json.id, json.name, json.description, json.permissions);
}
}
export class RoleGrantDefaultPermissionsRequest {
declare ["constructor"]: typeof RoleGrantDefaultPermissionsRequest;
static type = "request" as const;
static src = "control" as const;
static dst = "controller" as const;
static permission = "core.role.update" as const;
constructor(
public id: number,
) { }
static jsonSchema = Type.Object({
id: Type.Integer(),
});
static fromJSON(json: Static<typeof this.jsonSchema>) {
return new this(json.id);
}
}
export class RoleDeleteRequest {
declare ["constructor"]: typeof RoleDeleteRequest;
static type = "request" as const;
static src = "control" as const;
static dst = "controller" as const;
static permission = "core.role.delete" as const;
constructor(
public id: number,
) { }
static jsonSchema = Type.Object({
id: Type.Integer(),
});
static fromJSON(json: Static<typeof this.jsonSchema>) {
return new this(json.id);
}
}
+1 -113
View File
@@ -1,120 +1,8 @@
import { Type, Static } from "@sinclair/typebox"; import { Type, Static } from "@sinclair/typebox";
import Permission from "./Permission";
import Role from "./Role";
import User, { IControllerUser } from "./User"; import User, { IControllerUser } from "./User";
import { JsonNumber, StringEnum, jsonArray, plainJson } from "./composites"; import { StringEnum, jsonArray, plainJson } from "./composites";
import { MessageRequest } from "./messages_core"; import { MessageRequest } from "./messages_core";
export class PermissionListRequest {
declare ["constructor"]: typeof PermissionListRequest;
static type = "request" as const;
static src = "control" as const;
static dst = "controller" as const;
static permission = "core.permission.list" as const;
static Response = jsonArray(Permission);
}
export class RoleListRequest {
declare ["constructor"]: typeof RoleListRequest;
static type = "request" as const;
static src = "control" as const;
static dst = "controller" as const;
static permission = "core.role.list" as const;
static Response = jsonArray(Role);
}
export class RoleCreateRequest {
declare ["constructor"]: typeof RoleCreateRequest;
static type = "request" as const;
static src = "control" as const;
static dst = "controller" as const;
static permission = "core.role.create" as const;
constructor(
public name: string,
public description: string,
public permissions: string[],
) { }
static jsonSchema = Type.Object({
name: Type.String(),
description: Type.String(),
permissions: Type.Array(Type.String()),
});
static fromJSON(json: Static<typeof this.jsonSchema>) {
return new this(json.name, json.description, json.permissions);
}
static Response = JsonNumber;
}
export class RoleUpdateRequest {
declare ["constructor"]: typeof RoleUpdateRequest;
static type = "request" as const;
static src = "control" as const;
static dst = "controller" as const;
static permission = "core.role.update" as const;
constructor(
public id: number,
public name: string,
public description: string,
public permissions: string[],
) { }
static jsonSchema = Type.Object({
id: Type.Integer(),
name: Type.String(),
description: Type.String(),
permissions: Type.Array(Type.String()),
});
static fromJSON(json: Static<typeof this.jsonSchema>) {
return new this(json.id, json.name, json.description, json.permissions);
}
}
export class RoleGrantDefaultPermissionsRequest {
declare ["constructor"]: typeof RoleGrantDefaultPermissionsRequest;
static type = "request" as const;
static src = "control" as const;
static dst = "controller" as const;
static permission = "core.role.update" as const;
constructor(
public id: number,
) { }
static jsonSchema = Type.Object({
id: Type.Integer(),
});
static fromJSON(json: Static<typeof this.jsonSchema>) {
return new this(json.id);
}
}
export class RoleDeleteRequest {
declare ["constructor"]: typeof RoleDeleteRequest;
static type = "request" as const;
static src = "control" as const;
static dst = "controller" as const;
static permission = "core.role.delete" as const;
constructor(
public id: number,
) { }
static jsonSchema = Type.Object({
id: Type.Integer(),
});
static fromJSON(json: Static<typeof this.jsonSchema>) {
return new this(json.id);
}
}
export class UserGetRequest { export class UserGetRequest {
declare ["constructor"]: typeof UserGetRequest; declare ["constructor"]: typeof UserGetRequest;
static type = "request" as const; static type = "request" as const;
+29 -22
View File
@@ -1,11 +1,11 @@
import path from "path";
import fs from "fs-extra"; import fs from "fs-extra";
import { EventEmitter } from "events";
import { safeOutputFile } from "./file_ops"; import { safeOutputFile } from "./file_ops";
import { SubscribableValue } from "./subscriptions"; import { SubscribableValue } from "./subscriptions";
import { logger } from "./logging"; import { logger } from "./logging";
import { EventEmitter } from "stream";
import { ControllerConfig } from "./config"; import { ControllerConfig } from "./config";
import path from "path";
type DatastoreKey = string | number; type DatastoreKey = string | number;
type DatastoreValue = string | number | boolean | object; type DatastoreValue = string | number | boolean | object;
@@ -30,7 +30,7 @@ export class MemoryDatastoreProvider<
V extends DatastoreValue, V extends DatastoreValue,
> extends DatastoreProvider<K, V> { > extends DatastoreProvider<K, V> {
constructor( constructor(
private value: Map<K, V> = new Map() private value = new Map<K, V>()
) { ) {
super(); super();
} }
@@ -39,34 +39,33 @@ export class MemoryDatastoreProvider<
this.value = new Map(data); this.value = new Map(data);
} }
async load() { async load(): Promise<Map<K, V>> {
return new Map(this.value); return new Map(this.value);
} }
} }
// Store all data within a json object file and validate the result against a schema // Store all data within a json object file and validate the result against a schema
export class JsonDatastoreProvider< export class JsonDatastoreProvider<
K extends DatastoreKey,
V extends DatastoreValue, V extends DatastoreValue,
J, // Intermediate type returned from migrations J, // Intermediate type returned from migrations
> extends DatastoreProvider<K, V> { > extends DatastoreProvider<string, V> {
constructor( constructor(
private filePath: string, private filePath: string,
private fromJson: (json: J) => V = v => v as any, private fromJson: (json: J) => V = v => v as any as V,
private migrations: (rawJson: Record<DatastoreKey, unknown>) => Record<DatastoreKey, J> = v => v as any, private migrations: (rawJson: Record<string, unknown>) => Record<string, J> = v => v as Record<string, J>,
private finalise: (obj: V) => V = v => v, private finalise: (obj: V) => V = v => v,
) { ) {
super(); super();
} }
// Save the data to the json file // Save the data to the json file
async save(data: Map<K, V>) { async save(data: Map<string, V>) {
logger.verbose(`Saving ${this.filePath}`); logger.verbose(`Saving ${this.filePath}`);
await safeOutputFile(this.filePath, JSON.stringify(Object.fromEntries(data), null, "\t")); await safeOutputFile(this.filePath, JSON.stringify(Object.fromEntries(data), null, "\t"));
} }
// Load the data from the json file // Load the data from the json file
async load() { async load(): Promise<Map<string, V>> {
// Read the raw json from the file // Read the raw json from the file
let rawJson; let rawJson;
try { try {
@@ -89,27 +88,26 @@ export class JsonDatastoreProvider<
// Store all data within a json array file where each element has a unique id // Store all data within a json array file where each element has a unique id
export class JsonIdDatastoreProvider< export class JsonIdDatastoreProvider<
K extends DatastoreKey, V extends DatastoreValue & { id: DatastoreKey },
V extends DatastoreValue & { id: K },
J, // Intermediate type returned from migrations J, // Intermediate type returned from migrations
> extends DatastoreProvider<K, V> { > extends DatastoreProvider<V["id"], V> {
constructor( constructor(
private filePath: string, private filePath: string,
private fromJson: (json: J) => V = v => v as any, private fromJson: (json: J) => V = v => v as any as V,
private migrations: (rawJson: Array<unknown>) => Array<J> = v => v as any, private migrations: (rawJson: Array<unknown>) => Array<J> = v => v as Array<J>,
private finalise: (obj: V) => V = v => v, private finalise: (obj: V) => V = v => v,
) { ) {
super(); super();
} }
// Save the data to the json file // Save the data to the json file
async save(data: Map<K, V>) { async save(data: Map<V["id"], V>) {
logger.verbose(`Saving ${this.filePath}`); logger.verbose(`Saving ${this.filePath}`);
await safeOutputFile(this.filePath, JSON.stringify([...data.values()], null, "\t")); await safeOutputFile(this.filePath, JSON.stringify([...data.values()], null, "\t"));
} }
// Load the data from the json file // Load the data from the json file
async load() { async load(): Promise<Map<V["id"], V>> {
// Read the raw json from the file // Read the raw json from the file
let rawJson; let rawJson;
try { try {
@@ -137,7 +135,10 @@ export class JsonIdDatastoreProvider<
export abstract class Datastore< export abstract class Datastore<
K extends DatastoreKey, K extends DatastoreKey,
V extends DatastoreValue, V extends DatastoreValue,
> extends EventEmitter { U = V,
> extends EventEmitter<{
"update": [ updates: U[] ],
}> {
private dirty = false; private dirty = false;
constructor( constructor(
@@ -167,7 +168,7 @@ export abstract class Datastore<
} }
// Set the dirty flag and call update handlers // Set the dirty flag and call update handlers
protected touch(updates: any[]) { protected touch(updates: U[]) {
if (updates.length) { if (updates.length) {
this.dirty = true; this.dirty = true;
this.emit("update", updates); this.emit("update", updates);
@@ -208,13 +209,17 @@ export abstract class Datastore<
valuesMutable() { valuesMutable() {
return this.data.values(); return this.data.values();
} }
keys() {
return this.data.keys();
}
} }
// General key value mapping which can be saved and loaded with the file system // General key value mapping which can be saved and loaded with the file system
export class KeyValueDatastore< export class KeyValueDatastore<
K extends DatastoreKey, K extends DatastoreKey,
V extends DatastoreValue, V extends DatastoreValue,
> extends Datastore<K, V> { > extends Datastore<K, V, [key: K, value: V, isDeleted?: boolean]> {
// Set the value in the datastore, be careful of race conditions if you await any functions before calling set // Set the value in the datastore, be careful of race conditions if you await any functions before calling set
set(key: K, value: V) { set(key: K, value: V) {
this.data.set(key, value); this.data.set(key, value);
@@ -232,8 +237,10 @@ export class KeyValueDatastore<
// Delete a value in the datastore // Delete a value in the datastore
delete(key: K) { delete(key: K) {
const value = this.data.get(key); const value = this.data.get(key);
this.data.delete(key); if (value !== undefined) {
this.touch([[key, value!, true]]); this.data.delete(key);
this.touch([[key, value, true]]);
}
} }
// Delete many values at once from an array of keys // Delete many values at once from an array of keys
+1 -1
View File
@@ -414,7 +414,7 @@ export function readMapExchangeString(exchangeString: string) {
let buf = Buffer.from(exchangeString.slice(3, -3), "base64"); let buf = Buffer.from(exchangeString.slice(3, -3), "base64");
try { try {
// eslint-disable-next-line node/no-sync // eslint-disable-next-line node/no-sync
buf = zlib.inflateSync(buf); buf = Buffer.from(zlib.inflateSync(buf));
} catch (err: any) { } catch (err: any) {
if (err.code.startsWith("Z_")) { if (err.code.startsWith("Z_")) {
throw new Error("Malformed map exchange string: zlib inflate failed"); throw new Error("Malformed map exchange string: zlib inflate failed");
+3 -3
View File
@@ -1,8 +1,8 @@
/* eslint-disable node/global-require */
"use strict"; "use strict";
// eslint-disable-next-line node/no-process-env
if (process.env.APP_ENV === "browser") { if (process.env.APP_ENV === "browser") {
// eslint-disable-next-line node/no-extraneous-require
module.exports = require("fast-deep-equal/es6"); module.exports = require("fast-deep-equal/es6");
} else { } else {
module.exports = require("util").isDeepStrictEqual; module.exports = require("util").isDeepStrictEqual;
+1 -1
View File
@@ -1,3 +1,3 @@
"use strict"; "use strict";
// eslint-disable-next-line node/no-process-env
module.exports = process.env.APP_ENV === "browser" ? window.WebSocket : require("ws"); module.exports = process.env.APP_ENV === "browser" ? window.WebSocket : require("ws");
+46 -23
View File
@@ -1,8 +1,8 @@
// Connection adapters for Links // Connection adapters for Links
import { strict as assert } from "assert"; import { strict as assert } from "assert";
import events from "events"; import events from "events";
import WebSocket from "./WebSocket";
import WebSocket from "./WebSocket";
import * as libData from "../data"; import * as libData from "../data";
import * as libErrors from "../errors"; import * as libErrors from "../errors";
import { logger } from "../logging"; import { logger } from "../logging";
@@ -36,12 +36,21 @@ export enum ConnectionClosed {
RecoveryMode = 4001, RecoveryMode = 4001,
}; };
type BaseConnectorEvents = {
"message": [ message: libData.Message ],
"error": [ err: any ],
"invalidate": [],
"reset": [],
};
/** /**
* Base connector for links * Base connector for links
* *
* @extends events.EventEmitter * @extends events.EventEmitter
*/ */
export abstract class BaseConnector extends events.EventEmitter { export abstract class BaseConnector<
E extends Record<string, any[]> | [never] = [never], // Should be "extends EventMap = DefaultEventMap"
> extends events.EventEmitter<E | BaseConnectorEvents> {
protected _seq = 1; protected _seq = 1;
constructor( constructor(
@@ -53,10 +62,12 @@ export abstract class BaseConnector extends events.EventEmitter {
_reset() { _reset() {
this._seq = 1; this._seq = 1;
this.emit("reset");
} }
_invalidate() { _invalidate() {
this._seq = 1; this._seq = 1;
this.emit("invalidate");
} }
protected abstract send(message: libData.MessageRoutable): void; protected abstract send(message: libData.MessageRoutable): void;
@@ -131,6 +142,15 @@ export abstract class BaseConnector extends events.EventEmitter {
type ConnectorState = "closed" | "connecting" | "connected" | "resuming"; type ConnectorState = "closed" | "connecting" | "connected" | "resuming";
type WebSocketBaseConnectorEvents = {
"disconnectReady": [],
"disconnectPrepare": [],
"connect": [ data: any ],
"resume": [],
"close": [],
"drop": [],
};
export type WebSocketClusterio = WebSocket.WebSocket & { export type WebSocketClusterio = WebSocket.WebSocket & {
clusterio_ignore_dump?: boolean; clusterio_ignore_dump?: boolean;
}; };
@@ -140,7 +160,9 @@ export type WebSocketClusterio = WebSocket.WebSocket & {
* *
* @extends module:lib.BaseConnector * @extends module:lib.BaseConnector
*/ */
export abstract class WebSocketBaseConnector extends BaseConnector { export abstract class WebSocketBaseConnector<
E extends Record<string, any[]> | [never] = [never], // Should be "extends EventMap = DefaultEventMap"
> extends BaseConnector<E | WebSocketBaseConnectorEvents> {
// One of closed, connecting (client only), connected and resuming. // One of closed, connecting (client only), connected and resuming.
_state: ConnectorState = "closed"; _state: ConnectorState = "closed";
_closing = false; _closing = false;
@@ -166,7 +188,7 @@ export abstract class WebSocketBaseConnector extends BaseConnector {
_invalidate() { _invalidate() {
this._state = "connecting"; this._state = "connecting";
assert(this._closing === false); assert(this._closing === false);
assert(this._socket); // We do not care about the socket state
this._lastHeartbeatMs = null; this._lastHeartbeatMs = null;
assert(this._heartbeatId === null); assert(this._heartbeatId === null);
this._heartbeatInterval = null; this._heartbeatInterval = null;
@@ -175,6 +197,11 @@ export abstract class WebSocketBaseConnector extends BaseConnector {
super._invalidate(); super._invalidate();
} }
_close() {
this._reset();
this.emit("close");
}
_check(...expectedStates: ConnectorState[]) { _check(...expectedStates: ConnectorState[]) {
if (!expectedStates.includes(this._state)) { if (!expectedStates.includes(this._state)) {
throw new Error( throw new Error(
@@ -244,7 +271,7 @@ export abstract class WebSocketBaseConnector extends BaseConnector {
this._check("connected"); this._check("connected");
if (Date.now() - this._lastHeartbeatMs! > 2000 * this._heartbeatInterval!) { if (Date.now() - this._lastHeartbeatMs! > 2000 * this._heartbeatInterval!) {
logger.verbose("Connector | closing after heartbeat timed out"); logger.verbose("Connector | closing after heartbeat timed out");
// eslint-disable-next-line node/no-process-env
if (process.env.APP_ENV === "browser") { if (process.env.APP_ENV === "browser") {
this._socket!.close(ConnectionClosed.Timeout, "Heartbeat timeout"); this._socket!.close(ConnectionClosed.Timeout, "Heartbeat timeout");
} else { } else {
@@ -385,12 +412,16 @@ export abstract class WebSocketBaseConnector extends BaseConnector {
} }
} }
type WebSocketClientConnectorEvents = {
"hello": [ data: any ],
};
/** /**
* Connector for controller clients * Connector for controller clients
* *
* @extends module:lib.WebSocketBaseConnector * @extends module:lib.WebSocketBaseConnector
*/ */
export abstract class WebSocketClientConnector extends WebSocketBaseConnector { export abstract class WebSocketClientConnector extends WebSocketBaseConnector<WebSocketClientConnectorEvents> {
_reconnectId?: ReturnType<typeof setTimeout>; _reconnectId?: ReturnType<typeof setTimeout>;
_sessionToken: string | null = null; _sessionToken: string | null = null;
_sessionTimeout: number | null = null; _sessionTimeout: number | null = null;
@@ -418,8 +449,8 @@ export abstract class WebSocketClientConnector extends WebSocketBaseConnector {
this._sessionToken = null; this._sessionToken = null;
this._sessionTimeout = null; this._sessionTimeout = null;
this._startedResumingMs = null; this._startedResumingMs = null;
super._reset();
this.src = undefined as any; this.src = undefined as any;
super._reset();
} }
_invalidate() { _invalidate() {
@@ -427,8 +458,8 @@ export abstract class WebSocketClientConnector extends WebSocketBaseConnector {
this._sessionToken = null; this._sessionToken = null;
this._sessionTimeout = null; this._sessionTimeout = null;
this._startedResumingMs = null; this._startedResumingMs = null;
super._invalidate();
this.src = undefined as any; this.src = undefined as any;
super._invalidate();
} }
/** /**
@@ -463,8 +494,7 @@ export abstract class WebSocketClientConnector extends WebSocketBaseConnector {
await events.once(this, "close"); await events.once(this, "close");
} else { } else {
this._reset(); this._close();
this.emit("close");
} }
} }
@@ -489,8 +519,7 @@ export abstract class WebSocketClientConnector extends WebSocketBaseConnector {
this._socket!.close(ConnectionClosed.NormalClosure, "Connector closing"); this._socket!.close(ConnectionClosed.NormalClosure, "Connector closing");
} else { } else {
this._reset(); this._close();
this.emit("close");
} }
} }
@@ -515,7 +544,7 @@ export abstract class WebSocketClientConnector extends WebSocketBaseConnector {
// Open WebSocket to controller // Open WebSocket to controller
logger.verbose(`Connector | connecting to ${url}`); logger.verbose(`Connector | connecting to ${url}`);
// eslint-disable-next-line node/no-process-env
if (process.env.APP_ENV === "browser") { if (process.env.APP_ENV === "browser") {
this._socket = new WebSocket(url) as WebSocketClusterio; this._socket = new WebSocket(url) as WebSocketClusterio;
@@ -546,13 +575,10 @@ export abstract class WebSocketClientConnector extends WebSocketBaseConnector {
&& this._startedResumingMs! + this._sessionTimeout! * 1000 < Date.now() + delayMs && this._startedResumingMs! + this._sessionTimeout! * 1000 < Date.now() + delayMs
) { ) {
logger.error("Connector | Session timed out trying to resume"); logger.error("Connector | Session timed out trying to resume");
this._reset();
if (this._closing) { if (this._closing) {
this._reset(); this._close();
this.emit("close");
} else { } else {
this._state = "connecting"; this._invalidate();
this.emit("invalidate");
} }
} }
logger.verbose( logger.verbose(
@@ -604,8 +630,7 @@ export abstract class WebSocketClientConnector extends WebSocketBaseConnector {
} else { } else {
// eslint-disable-next-line no-lonely-if // eslint-disable-next-line no-lonely-if
if (this._closing) { if (this._closing) {
this._reset(); this._close();
this.emit("close");
} else { } else {
this.reconnect(); this.reconnect();
@@ -711,11 +736,9 @@ export abstract class WebSocketClientConnector extends WebSocketBaseConnector {
} else if (type === "invalidate") { } else if (type === "invalidate") {
logger.warn("Connector | session invalidated by controller"); logger.warn("Connector | session invalidated by controller");
if (this._closing) { if (this._closing) {
this._reset(); this._close();
this.emit("close");
} else { } else {
this._invalidate(); this._invalidate();
this.emit("invalidate");
this.register(); this.register();
} }
} }
+3 -3
View File
@@ -113,7 +113,7 @@ export class Link {
// Process messages received by the connector // Process messages received by the connector
connector.on("message", payload => { connector.on("message", payload => {
try { try {
this._processMessage(payload); this._processMessage(payload as MessageRoutable);
} catch (err) { } catch (err) {
if (err instanceof libErrors.InvalidMessage) { if (err instanceof libErrors.InvalidMessage) {
logger.error(err.message); logger.error(err.message);
@@ -128,10 +128,10 @@ export class Link {
} }
}); });
// The events below exist only on websocket connectors, we can't early return because of test mocking
const webSocketConnector = this.connector as WebSocketBaseConnector;
connector.on("disconnectPrepare", () => { connector.on("disconnectPrepare", () => {
this.prepareDisconnect().finally(() => { this.prepareDisconnect().finally(() => {
// Only WebSocket connectors issue disconnection events.
const webSocketConnector = this.connector as WebSocketBaseConnector;
if (webSocketConnector.hasSession) { if (webSocketConnector.hasSession) {
webSocketConnector.sendDisconnectReady(); webSocketConnector.sendDisconnectReady();
} }
+10 -6
View File
@@ -4,6 +4,7 @@ import * as host from "../data/messages_host";
import * as instance from "../data/messages_instance"; import * as instance from "../data/messages_instance";
import * as mod from "../data/messages_mod"; import * as mod from "../data/messages_mod";
import * as user from "../data/messages_user"; import * as user from "../data/messages_user";
import * as role from "../data/messages_role";
import * as plugin from "../data/messages_plugin"; import * as plugin from "../data/messages_plugin";
import * as subscriptions from "../subscriptions"; import * as subscriptions from "../subscriptions";
import type { RequestClass, EventClass } from "./link"; import type { RequestClass, EventClass } from "./link";
@@ -62,6 +63,7 @@ export const dataClasses: (RequestClass<unknown, unknown> | EventClass<unknown>)
instance.InstanceAssignRequest, instance.InstanceAssignRequest,
instance.InstanceMetricsRequest, instance.InstanceMetricsRequest,
instance.InstanceStartRequest, instance.InstanceStartRequest,
instance.InstanceRestartRequest,
instance.InstanceSaveDetailsListRequest, instance.InstanceSaveDetailsListRequest,
instance.InstanceSaveDetailsUpdatesEvent, instance.InstanceSaveDetailsUpdatesEvent,
instance.InstanceCreateSaveRequest, instance.InstanceCreateSaveRequest,
@@ -107,12 +109,14 @@ export const dataClasses: (RequestClass<unknown, unknown> | EventClass<unknown>)
mod.ModUpdatesEvent, mod.ModUpdatesEvent,
mod.ModPortalDownloadRequest, mod.ModPortalDownloadRequest,
user.PermissionListRequest, role.PermissionListRequest,
user.RoleListRequest, role.RoleListRequest,
user.RoleCreateRequest, role.RoleUpdatesEvent,
user.RoleUpdateRequest, role.RoleCreateRequest,
user.RoleGrantDefaultPermissionsRequest, role.RoleUpdateRequest,
user.RoleDeleteRequest, role.RoleGrantDefaultPermissionsRequest,
role.RoleDeleteRequest,
user.UserGetRequest, user.UserGetRequest,
user.UserListRequest, user.UserListRequest,
user.UserCreateRequest, user.UserCreateRequest,
+2 -2
View File
@@ -519,7 +519,7 @@ export async function queryLog(logDirectory: string, filter: QueryLogFilter, ind
} }
export function handleUnhandledErrors() { export function handleUnhandledErrors() {
/* eslint-disable node/no-process-exit */
process.on("uncaughtException", err => { process.on("uncaughtException", err => {
logger.fatal(`Uncaught exception:\n${err.stack}`); logger.fatal(`Uncaught exception:\n${err.stack}`);
process.exit(1); process.exit(1);
@@ -528,7 +528,7 @@ export function handleUnhandledErrors() {
logger.fatal(`Unhandled rejection:\n${reason.stack ? reason.stack : reason}`); logger.fatal(`Unhandled rejection:\n${reason.stack ? reason.stack : reason}`);
process.exit(1); process.exit(1);
}); });
/* eslint-enable node/no-process-exit */
} }
// for testing only // for testing only
+16 -4
View File
@@ -7,6 +7,7 @@
* @module lib/users * @module lib/users
*/ */
import { Permission, Role } from "./data"; import { Permission, Role } from "./data";
import { SubscribableDatastore } from "./datastore";
export const permissions = new Map<string, Permission>(); export const permissions = new Map<string, Permission>();
@@ -66,7 +67,7 @@ export function definePermission({
* @param roles - role storage to modify. * @param roles - role storage to modify.
* @returns the default admin role * @returns the default admin role
*/ */
export function ensureDefaultAdminRole(roles: Map<number, Role>) { export function ensureDefaultAdminRole(roles: SubscribableDatastore<Role>) {
let admin = roles.get(0); let admin = roles.get(0);
if (!admin) { if (!admin) {
admin = Role.fromJSON({ admin = Role.fromJSON({
@@ -75,9 +76,9 @@ export function ensureDefaultAdminRole(roles: Map<number, Role>) {
description: "Cluster wide administrator.", description: "Cluster wide administrator.",
permissions: [], permissions: [],
}); });
roles.set(0, admin);
} }
admin.permissions.add("core.admin"); admin.permissions.add("core.admin");
roles.set(admin);
return admin; return admin;
} }
@@ -90,7 +91,7 @@ export function ensureDefaultAdminRole(roles: Map<number, Role>) {
* *
* @param roles - role storage to modify. * @param roles - role storage to modify.
*/ */
export function ensureDefaultPlayerRole(roles: Map<number, Role>) { export function ensureDefaultPlayerRole(roles: SubscribableDatastore<Role>) {
let player = roles.get(1); let player = roles.get(1);
if (!player) { if (!player) {
player = Role.fromJSON({ player = Role.fromJSON({
@@ -99,9 +100,9 @@ export function ensureDefaultPlayerRole(roles: Map<number, Role>) {
description: "Default player role.", description: "Default player role.",
permissions: [], permissions: [],
}); });
roles.set(1, player);
} }
player.grantDefaultPermissions(); player.grantDefaultPermissions();
roles.set(player);
} }
@@ -306,6 +307,11 @@ definePermission({
title: "Start instance", title: "Start instance",
description: "Start instances.", description: "Start instances.",
}); });
definePermission({
name: "core.instance.restart",
title: "Restart instance",
description: "Restart instances.",
});
definePermission({ definePermission({
name: "core.instance.load_scenario", name: "core.instance.load_scenario",
title: "Load scenario", title: "Load scenario",
@@ -431,6 +437,12 @@ definePermission({
description: "Get the full list of roles and their permissions in the cluster.", description: "Get the full list of roles and their permissions in the cluster.",
grantByDefault: true, grantByDefault: true,
}); });
definePermission({
name: "core.role.subscribe",
title: "Subscribe to role updates",
description: "Subscribe to be notified on updates on the details of roles.",
grantByDefault: true,
});
definePermission({ definePermission({
name: "core.role.create", name: "core.role.create",
title: "Create role", title: "Create role",
+1 -1
View File
@@ -1,4 +1,4 @@
/* eslint-disable @typescript-eslint/no-var-requires */
/** /**
* Helpers for loading plugins in Node.js * Helpers for loading plugins in Node.js
* @module lib/plugin_loader * @module lib/plugin_loader
+1 -1
View File
@@ -58,7 +58,7 @@ export async function handlePluginCommand(
let pluginInfo: { name: string }; let pluginInfo: { name: string };
try { try {
// eslint-disable-next-line @typescript-eslint/no-var-requires
pluginInfo = require(pluginPath).plugin; pluginInfo = require(pluginPath).plugin;
} catch (err: any) { } catch (err: any) {
logger.error(`Unable to import plugin info from ${args.path}:\n${err.stack}`); logger.error(`Unable to import plugin info from ${args.path}:\n${err.stack}`);
+71 -14
View File
@@ -39,30 +39,45 @@ export class SubscriptionRequest {
public eventName: string, public eventName: string,
public subscribe: boolean, public subscribe: boolean,
public lastRequestTimeMs: number = 0, public lastRequestTimeMs: number = 0,
public filters: string | string[] | undefined = undefined,
) { ) {
if (!Link._eventsByName.has(eventName)) { if (!Link._eventsByName.has(eventName)) {
throw new Error(`Unregistered Event class ${eventName}`); throw new Error(`Unregistered Event class ${eventName}`);
} }
} }
static jsonSchema = Type.Tuple([ static jsonSchema = Type.Union([
Type.String(), Type.Tuple([
Type.Boolean(), Type.String(),
Type.Number(), Type.Boolean(),
Type.Number(),
]),
Type.Tuple([
Type.String(),
Type.Boolean(),
Type.Number(),
Type.Union([Type.String(), Type.Array(Type.String())]),
]),
]); ]);
toJSON() { toJSON() {
if (this.filters !== undefined) {
return [this.eventName, this.subscribe, this.lastRequestTimeMs, this.filters];
}
return [this.eventName, this.subscribe, this.lastRequestTimeMs]; return [this.eventName, this.subscribe, this.lastRequestTimeMs];
} }
static fromJSON(json: Static<typeof SubscriptionRequest.jsonSchema>): SubscriptionRequest { static fromJSON(json: Static<typeof SubscriptionRequest.jsonSchema>): SubscriptionRequest {
return new this(...json); const [eventName, subscribe, lastRequestTimeMs, filters] = json;
return new this(eventName, subscribe, lastRequestTimeMs, filters);
} }
} }
type Subscriber = { type Subscriber = {
link: Link, link: Link,
dst: Address, dst: Address,
/** Optional filters this subscriber is interested in. Undefined means all events */
filters?: string[],
} }
type EventData = { type EventData = {
@@ -77,6 +92,13 @@ type EventData = {
export class SubscriptionController { export class SubscriptionController {
_events = new Map<string, EventData>(); _events = new Map<string, EventData>();
private static normalizeFilters(value?: string | string[]): string[] | undefined {
if (value === undefined) {
return undefined;
}
return Array.isArray(value) ? value : [value];
}
/** /**
* Allow clients to subscribe to an event by telling the subscription controller to accept them * Allow clients to subscribe to an event by telling the subscription controller to accept them
* Has an optional subscription update handler which is called when a client subscribes * Has an optional subscription update handler which is called when a client subscribes
@@ -102,7 +124,7 @@ export class SubscriptionController {
* Broadcast an event to all subscribers of that event * Broadcast an event to all subscribers of that event
* @param event - Event to broadcast. * @param event - Event to broadcast.
*/ */
broadcast<T>(event: Event<T>) { broadcast<T>(event: Event<T>, filter?: string | string[]) {
const entry = Link._eventsByClass.get(event.constructor); const entry = Link._eventsByClass.get(event.constructor);
if (!entry) { if (!entry) {
throw new Error(`Unregistered Event class ${event.constructor.name}`); throw new Error(`Unregistered Event class ${event.constructor.name}`);
@@ -112,10 +134,19 @@ export class SubscriptionController {
throw new Error(`Event ${entry.name} is not a registered as subscribable`); throw new Error(`Event ${entry.name} is not a registered as subscribable`);
} }
const toRemove: Subscriber[] = []; const toRemove: Subscriber[] = [];
const filtersToMatch = SubscriptionController.normalizeFilters(filter);
for (const subscriber of eventData.subscriptions) { for (const subscriber of eventData.subscriptions) {
if ((subscriber.link.connector as WebSocketBaseConnector).closing) { if ((subscriber.link.connector as WebSocketBaseConnector).closing) {
toRemove.push(subscriber); toRemove.push(subscriber);
} else { continue;
}
if (
filtersToMatch === undefined
|| subscriber.filters === undefined
|| subscriber.filters.some(f => filtersToMatch.includes(f))
) {
subscriber.link.sendTo(subscriber.dst, event); subscriber.link.sendTo(subscriber.dst, event);
} }
} }
@@ -164,13 +195,37 @@ export class SubscriptionController {
throw new Error(`Event ${event.eventName} is not a registered as subscribable`); throw new Error(`Event ${event.eventName} is not a registered as subscribable`);
} }
if (event.subscribe === false) { if (event.subscribe === false) {
const index = eventData.subscriptions.findLastIndex(subscriber => subscriber.dst.addressedTo(src)); // Unsubscribe logic
if (index >= 0) { const subscriber = eventData.subscriptions.find(sub => sub.dst.addressedTo(src));
eventData.subscriptions.splice(index, 1); if (!subscriber) {
return false;
}
if (event.filters === undefined || subscriber.filters === undefined) {
// Remove entire subscription for this address
eventData.subscriptions = eventData.subscriptions.filter(sub => !sub.dst.addressedTo(src));
} else {
const filtersToRemove = Array.isArray(event.filters) ? event.filters : [event.filters];
subscriber.filters = subscriber.filters.filter(f => !filtersToRemove.includes(f));
if (subscriber.filters.length === 0) {
// No filters left, remove subscription
eventData.subscriptions = eventData.subscriptions.filter(sub => sub !== subscriber);
}
} }
} else { } else {
if (!eventData.subscriptions.some(subscriber => subscriber.dst.addressedTo(src))) { // Subscribe logic
eventData.subscriptions.push({ link: link, dst: src }); let subscriber = eventData.subscriptions.find(sub => sub.dst.addressedTo(src));
const newFilters = SubscriptionController.normalizeFilters(event.filters);
if (!subscriber) {
eventData.subscriptions.push({ link: link, dst: src, filters: newFilters });
} else if (subscriber.filters === undefined || newFilters === undefined) {
// Either was already subscribed to all or new request wants all
subscriber.filters = undefined;
} else {
for (const f of newFilters) {
if (!subscriber.filters.includes(f)) {
subscriber.filters.push(f);
}
}
} }
if (eventData.subscriptionUpdate) { if (eventData.subscriptionUpdate) {
const eventReplay = await eventData.subscriptionUpdate(event, src, dst); const eventReplay = await eventData.subscriptionUpdate(event, src, dst);
@@ -222,10 +277,12 @@ export class EventSubscriber<
public control: Link, public control: Link,
) { ) {
control.handle(Event, this._handleEvent.bind(this)); control.handle(Event, this._handleEvent.bind(this));
control.connector.on("connect", () => { // The events below exist only on websocket connectors, we can't early return because of test mocking
const webSocketConnector = control.connector as WebSocketBaseConnector;
webSocketConnector.on("connect", () => {
this.handleConnectionEvent("connect"); this.handleConnectionEvent("connect");
}); });
control.connector.on("close", () => { webSocketConnector.on("close", () => {
this.handleConnectionEvent("close"); this.handleConnectionEvent("close");
}); });
} }
+1
View File
@@ -6,6 +6,7 @@
"./src/api.ts", "./src/api.ts",
"./src/config/*.ts", "./src/config/*.ts",
"./src/data/*.ts", "./src/data/*.ts",
"./src/datastore.ts",
"./src/errors.ts", "./src/errors.ts",
"./src/factorio/exchange_string.ts", "./src/factorio/exchange_string.ts",
"./src/helpers.ts", "./src/helpers.ts",
+1 -1
View File
@@ -21,7 +21,7 @@
"@ant-design/icons": "^5.6.1", "@ant-design/icons": "^5.6.1",
"@clusterio/lib": "workspace:*", "@clusterio/lib": "workspace:*",
"@sinclair/typebox": "^0.30.4", "@sinclair/typebox": "^0.30.4",
"@swc/core": "^1.11.1", "@swc/core": "^1.13.3",
"antd": "^5.24.2", "antd": "^5.24.2",
"assert": "^2.0.0", "assert": "^2.0.0",
"browserify-zlib": "^0.2.0", "browserify-zlib": "^0.2.0",
@@ -226,7 +226,7 @@ export default function BaseConfigTree(props: BaseConfigTreeProps) {
</>; </>;
} }
// eslint-disable-next-line complexity
function computeTreeData( function computeTreeData(
control: Control, control: Control,
form: FormInstance<any>, form: FormInstance<any>,
@@ -1,5 +1,5 @@
import React, {useContext, useState} from "react"; import React, {useContext, useState} from "react";
import { Button, Descriptions, Flex, Popconfirm, Space, Tooltip, Typography } from "antd"; import { Descriptions, Flex, Popconfirm, Space, Tooltip, Typography } from "antd";
import { ExclamationCircleOutlined } from "@ant-design/icons"; import { ExclamationCircleOutlined } from "@ant-design/icons";
import * as lib from "@clusterio/lib"; import * as lib from "@clusterio/lib";
@@ -19,60 +19,77 @@ import PageLayout from "./PageLayout";
import { notifyErrorHandler } from "../util/notify"; import { notifyErrorHandler } from "../util/notify";
import webUiPackage from "../../package.json"; import webUiPackage from "../../package.json";
import { hasNpmButtonPermission, NpmButton } from "./NpmButton"; import { hasNpmButtonPermission, NpmButton } from "./NpmButton";
import VariableDropdownButton, { VariableDropdownButtonProps } from "./VariableDropdownButton";
const { Title } = Typography; const { Title } = Typography;
type ControllerControlButtonProps = { canRestart?: boolean, restartRequired?: boolean };
function ControllerControlButton({ canRestart, restartRequired }: ControllerControlButtonProps) {
const account = useAccount();
const control = useContext(ControlContext);
const actions: VariableDropdownButtonProps["actions"] = [];
if (account.hasPermission("core.controller.restart") && canRestart) {
actions.push({
key: "restart",
label: (
<Tooltip title={restartRequired ? "Restart Required" : null}>
Restart {restartRequired ? <ExclamationCircleOutlined style={{ color: "yellow" }}/> : undefined}
</Tooltip>
),
onClick: () => {
control.send(
new lib.ControllerRestartRequest()
).catch(notifyErrorHandler("Error restarting controller"));
},
});
}
if (account.hasPermission("core.controller.stop")) {
actions.push({
key: "stop",
danger: true,
label: (
<Popconfirm
title={<>
Stopping the controller will leave the cluster inoperable until someone with
access to the system it runs on manually starts it again.<br />
Are you sure you want to stop the controller?
</>}
placement="bottomRight"
okText="Stop"
okButtonProps={{ danger: true }}
onConfirm={() => {
control.send(
new lib.ControllerStopRequest()
).catch(notifyErrorHandler("Error stopping controller"));
}}
>
Stop
</Popconfirm>
),
});
}
return <VariableDropdownButton actions={actions} />;
}
export default function ControllerPage() { export default function ControllerPage() {
let account = useAccount(); const account = useAccount();
const control = useContext(ControlContext);
const [systems] = useSystems(); const [systems] = useSystems();
const system = systems.get("controller"); const system = systems.get("controller");
const [maxLevel, setMaxLevel] = useState<keyof typeof lib.levels>("info"); const [maxLevel, setMaxLevel] = useState<keyof typeof lib.levels>("info");
const canShowNpm = hasNpmButtonPermission(true);
return <PageLayout nav={[{ name: "Controller" }]}> return <PageLayout nav={[{ name: "Controller" }]}>
<PageHeader <PageHeader
title="Controller" title="Controller"
extra={<Space> extra={<Space>
<ControllerControlButton canRestart={system?.canRestart} restartRequired={system?.restartRequired}/>
{ {
account.hasPermission("core.controller.stop") canShowNpm
&& <Popconfirm
title={<>
Stopping the controller will leave the cluster inoperable until someone with
access to the system it runs on manually starts it again.<br />
Are you sure you want to stop the controller?
</>}
placement="bottomRight"
okText="Stop"
okButtonProps={{ danger: true }}
onConfirm={() => {
control.send(
new lib.ControllerStopRequest()
).catch(notifyErrorHandler("Error stopping controller"));
}}
>
<Button danger>Stop</Button>
</Popconfirm>
}
{
account.hasPermission("core.controller.restart")
&& <Tooltip title={system?.restartRequired ? "Restart Required" : null}>
<Button
disabled={system?.canRestart === false}
onClick={() => {
control.send(
new lib.ControllerRestartRequest()
).catch(notifyErrorHandler("Error restarting controller"));
}}
>
Restart
{!system?.restartRequired ? undefined
: <ExclamationCircleOutlined style={{ color: "yellow" }}/>}
</Button>
</Tooltip>
}
{
hasNpmButtonPermission(true)
&& <NpmButton target="controller" canRestart={system?.canRestart}/> && <NpmButton target="controller" canRestart={system?.canRestart}/>
} }
</Space>} </Space>}
+60 -43
View File
@@ -22,9 +22,64 @@ import {
import { formatTimestamp } from "../util/time_format"; import { formatTimestamp } from "../util/time_format";
import { useSystems } from "../model/system"; import { useSystems } from "../model/system";
import { hasNpmButtonPermission, NpmButton } from "./NpmButton"; import { hasNpmButtonPermission, NpmButton } from "./NpmButton";
import VariableDropdownButton, { VariableDropdownButtonProps } from "./VariableDropdownButton";
const { Title } = Typography; const { Title } = Typography;
type HostControlButtonProps = { hostId: number, canRestart?: boolean, restartRequired?: boolean };
function HostControlButton({ hostId, canRestart, restartRequired }: HostControlButtonProps) {
const account = useAccount();
const control = useContext(ControlContext);
const actions: VariableDropdownButtonProps["actions"] = [];
if (account.hasPermission("core.host.restart") && canRestart) {
actions.push({
key: "restart",
label: (
<Tooltip title={restartRequired ? "Restart Required" : null}>
Restart {restartRequired ? <ExclamationCircleOutlined style={{ color: "yellow" }}/> : undefined}
</Tooltip>
),
onClick: () => {
control.sendTo(
{ hostId },
new lib.HostRestartRequest()
).catch(notifyErrorHandler("Error restarting host"));
},
});
}
if (account.hasPermission("core.host.stop")) {
actions.push({
key: "stop",
danger: true,
label: (
<Popconfirm
title={<>
Stopping this host will leave it inaccessible until someone with
access to the system it runs on manually starts it again.<br />
Are you sure you want to stop the host?
</>}
placement="bottomRight"
okText="Stop"
okButtonProps={{ danger: true }}
onConfirm={() => {
control.sendTo(
{ hostId },
new lib.HostStopRequest()
).catch(notifyErrorHandler("Error stopping host"));
}}
>
Stop
</Popconfirm>
),
});
}
return <VariableDropdownButton actions={actions} />;
}
export default function HostViewPage() { export default function HostViewPage() {
let params = useParams(); let params = useParams();
let hostId = Number(params.id); let hostId = Number(params.id);
@@ -35,6 +90,7 @@ export default function HostViewPage() {
const system = systems.get(hostId); const system = systems.get(hostId);
const [host, synced] = useHost(hostId); const [host, synced] = useHost(hostId);
const [maxLevel, setMaxLevel] = useState<keyof typeof lib.levels>("info"); const [maxLevel, setMaxLevel] = useState<keyof typeof lib.levels>("info");
const canShowNpm = hasNpmButtonPermission(false);
const hostInstances = new Map([...instances].filter(([_id, instance]) => instance.assignedHost === hostId)); const hostInstances = new Map([...instances].filter(([_id, instance]) => instance.assignedHost === hostId));
let nav = [{ name: "Hosts", path: "/hosts" }, { name: host?.name ?? String(hostId) }]; let nav = [{ name: "Hosts", path: "/hosts" }, { name: host?.name ?? String(hostId) }];
@@ -50,6 +106,7 @@ export default function HostViewPage() {
} }
let hostButtons = <Space> let hostButtons = <Space>
<HostControlButton hostId={hostId} canRestart={system?.canRestart} restartRequired={system?.restartRequired}/>
{ {
account.hasPermission("core.host.revoke_token") account.hasPermission("core.host.revoke_token")
&& <Popconfirm && <Popconfirm
@@ -68,49 +125,9 @@ export default function HostViewPage() {
</Button> </Button>
</Popconfirm> </Popconfirm>
} }
{ {canShowNpm && (
account.hasPermission("core.host.stop") <NpmButton target={{ hostId }} canRestart={system?.canRestart} disabled={!host["connected"]}/>
&& <Popconfirm )}
title={<>
Stopping this host will leave it inaccessible until someone with
access to the system it runs on manually starts it again.<br />
Are you sure you want to stop the host?
</>}
placement="bottomRight"
okText="Stop"
okButtonProps={{ danger: true }}
onConfirm={() => {
control.sendTo(
{ hostId },
new lib.HostStopRequest()
).catch(notifyErrorHandler("Error stopping host"));
}}
>
<Button danger>Stop</Button>
</Popconfirm>
}
{
account.hasPermission("core.host.restart")
&& <Tooltip title={system?.restartRequired ? "Restart Required" : null}>
<Button
disabled={system?.canRestart === false}
onClick={() => {
control.sendTo(
{ hostId },
new lib.HostRestartRequest()
).catch(notifyErrorHandler("Error restarting host"));
}}
>
Restart
{!system?.restartRequired ? undefined
: <ExclamationCircleOutlined style={{ color: "yellow" }} />}
</Button>
</Tooltip>
}
{
hasNpmButtonPermission(false)
&& <NpmButton target={{ hostId }} canRestart={system?.canRestart} disabled={!host["connected"]}/>
}
</Space>; </Space>;
return <PageLayout nav={nav}> return <PageLayout nav={nav}>
+2 -13
View File
@@ -1,21 +1,10 @@
import React, { useContext, useEffect, useState } from "react";
import { Select } from "antd"; import { Select } from "antd";
import * as lib from "@clusterio/lib";
import ControlContext from "./ControlContext";
import { notifyErrorHandler } from "../util/notify";
import { InputComponentProps } from "../BaseWebPlugin"; import { InputComponentProps } from "../BaseWebPlugin";
import { useRoles } from "../model/roles";
export default function InputRole(props: InputComponentProps) { export default function InputRole(props: InputComponentProps) {
let control = useContext(ControlContext); const [roles] = useRoles();
let [roles, setRoles] = useState<lib.Role[]>([]);
useEffect(() => {
control.send(new lib.RoleListRequest()).then(newRoles => {
setRoles(newRoles);
}).catch(notifyErrorHandler("Error fetching role list"));
}, []);
return <Select return <Select
showSearch showSearch
@@ -0,0 +1,122 @@
import React, { useContext, useState } from "react";
import { Popconfirm } from "antd";
import * as lib from "@clusterio/lib";
import ControlContext from "./ControlContext";
import { useAccount } from "../model/account";
import { notifyErrorHandler } from "../util/notify";
import VariableDropdownButton, { VariableDropdownButtonProps } from "./VariableDropdownButton";
type InstanceControlButtonProps = Omit<VariableDropdownButtonProps, "actions"> & {
instance: lib.InstanceDetails;
onFinish?: () => void;
};
export const InstanceControlButtonPermissions = [
"core.instance.start", "core.instance.restart", "core.instance.stop", "core.instance.kill",
] as const;
export default function InstanceControlButton(props: InstanceControlButtonProps) {
const account = useAccount();
const control = useContext(ControlContext);
const [switching, setSwitching] = useState<boolean>(false);
const instanceId = props.instance.id;
const instanceStatus = props.instance.status;
const showStart = ["stopped", "stopping"].includes(instanceStatus);
const showStop = ["running", "starting"].includes(instanceStatus);
function actionFinish() {
setSwitching(false);
if (props.onFinish) {
props.onFinish();
}
}
const actions: VariableDropdownButtonProps["actions"] = [];
if (account.hasPermission("core.instance.start") && showStart !== switching) {
actions.push({
key: "start",
label: "Start",
onClick: () => {
setSwitching(true);
control.sendTo(
{ instanceId },
new lib.InstanceStartRequest(undefined),
).catch(
notifyErrorHandler("Error starting instance")
).finally(actionFinish);
},
});
} else if (account.hasPermission("core.instance.stop")) { // else if because it is stop or start
actions.push({
key: "stop",
label: "Stop",
danger: true,
onClick: () => {
setSwitching(true);
control.sendTo(
{ instanceId },
new lib.InstanceStopRequest(),
).catch(
notifyErrorHandler("Error stopping instance")
).finally(actionFinish);
},
});
}
if (account.hasPermission("core.instance.restart")) {
actions.push({
key: "restart",
label: "Restart",
disabled: instanceStatus !== "running",
onClick: () => {
setSwitching(true);
control.sendTo(
{ instanceId },
new lib.InstanceRestartRequest(undefined),
).catch(
notifyErrorHandler("Error restarting instance")
).finally(actionFinish);
},
});
}
if (account.hasPermission("core.instance.kill")) {
actions.push({
key: "kill",
danger: true,
disabled: instanceStatus === "stopped",
label: (<Popconfirm
title={<>
Killing this instance may leave you save and player data corrupted.
Are you sure you want to kill the instance?
</>}
placement="bottomRight"
okText="Kill"
okButtonProps={{ danger: true }}
onConfirm={() => {
control.sendTo(
{ instanceId },
new lib.InstanceKillRequest(),
).catch(
notifyErrorHandler("Error killing instance")
).finally(actionFinish);
}}
>
Kill
</Popconfirm>),
});
}
return <VariableDropdownButton
{...props}
type="primary"
actions={actions}
loading={switching}
disabled={!(showStart || showStop)}
/>;
}
@@ -8,7 +8,7 @@ import type { ColumnsType } from "antd/es/table";
import { useAccount } from "../model/account"; import { useAccount } from "../model/account";
import { useHosts } from "../model/host"; import { useHosts } from "../model/host";
import InstanceStatusTag from "./InstanceStatusTag"; import InstanceStatusTag from "./InstanceStatusTag";
import StartStopInstanceButton from "./StartStopInstanceButton"; import InstanceControlButton, { InstanceControlButtonPermissions } from "./InstanceControlButton";
import * as lib from "@clusterio/lib"; import * as lib from "@clusterio/lib";
import Link from "./Link"; import Link from "./Link";
import { instancePublicAddress } from "../util/instance"; import { instancePublicAddress } from "../util/instance";
@@ -98,13 +98,10 @@ export default function InstanceList(props: InstanceListProps) {
}, },
]; ];
if (account.hasAnyPermission("core.instance.start", "core.instance.stop")) { if (account.hasAnyPermission(...InstanceControlButtonPermissions)) {
columns.push({ columns.push({
key: "action", key: "action",
render: (_, instance) => <StartStopInstanceButton render: (_, instance) => <InstanceControlButton size="small" instance={instance} />,
buttonProps={{ size: "small" }}
instance={instance}
/>,
responsive: ["sm"], responsive: ["sm"],
align: "right", align: "right",
width: 100, width: 100,
@@ -15,9 +15,10 @@ import InstanceConfigTree from "./InstanceConfigTree";
import LogConsole, { SelectMaxLogLevel } from "./LogConsole"; import LogConsole, { SelectMaxLogLevel } from "./LogConsole";
import InstanceRcon from "./InstanceRcon"; import InstanceRcon from "./InstanceRcon";
import AssignInstanceModal from "./AssignInstanceModal"; import AssignInstanceModal from "./AssignInstanceModal";
import StartStopInstanceButton from "./StartStopInstanceButton"; import InstanceControlButton, { InstanceControlButtonPermissions } from "./InstanceControlButton";
import LoadScenarioModal from "./LoadScenarioModal"; import LoadScenarioModal from "./LoadScenarioModal";
import SavesList from "./SavesList"; import SavesList from "./SavesList";
import OnlinePlayersList from "./OnlinePlayersList";
import { notifyErrorHandler } from "../util/notify"; import { notifyErrorHandler } from "../util/notify";
import { useInstance } from "../model/instance"; import { useInstance } from "../model/instance";
import { useHost } from "../model/host"; import { useHost } from "../model/host";
@@ -91,13 +92,6 @@ function InstanceButtons(props: { instance: lib.InstanceDetails }) {
label: "Extract players from save", label: "Extract players from save",
}); });
} }
if (account.hasPermission("core.instance.kill")) {
instanceButtonMenuItems.push({
disabled: ["unknown", "unassigned", "stopped"].includes(instance.status!),
key: "kill",
label: "Kill process",
});
}
if (account.hasPermission("core.instance.delete")) { if (account.hasPermission("core.instance.delete")) {
if (instanceButtonMenuItems.length) { if (instanceButtonMenuItems.length) {
instanceButtonMenuItems.push({ type: "divider" }); instanceButtonMenuItems.push({ type: "divider" });
@@ -130,12 +124,6 @@ function InstanceButtons(props: { instance: lib.InstanceDetails }) {
new lib.InstanceExtractPlayersRequest(), new lib.InstanceExtractPlayersRequest(),
).catch(notifyErrorHandler("Error extracting player data")); ).catch(notifyErrorHandler("Error extracting player data"));
} else if (key === "kill") {
control.sendTo(
{ instanceId },
new lib.InstanceKillRequest(),
).catch(notifyErrorHandler("Error killing instance"));
} else if (key === "delete") { } else if (key === "delete") {
Modal.confirm({ Modal.confirm({
autoFocusButton: "cancel", autoFocusButton: "cancel",
@@ -155,8 +143,8 @@ function InstanceButtons(props: { instance: lib.InstanceDetails }) {
}; };
return <Space> return <Space>
{ {
account.hasAnyPermission("core.instance.start", "core.instance.stop") account.hasAnyPermission(...InstanceControlButtonPermissions)
&& <StartStopInstanceButton instance={instance} /> && <InstanceControlButton instance={instance} />
} }
<Button <Button
onClick={() => { onClick={() => {
@@ -173,7 +161,6 @@ function InstanceButtons(props: { instance: lib.InstanceDetails }) {
{account.hasAnyPermission( {account.hasAnyPermission(
"core.instance.export_data", "core.instance.export_data",
"core.instance.extract_players", "core.instance.extract_players",
"core.instance.kill",
"core.instance.delete", "core.instance.delete",
) )
&& <Dropdown placement="bottomRight" trigger={["click"]} menu={instanceButtonsMenuProps}> && <Dropdown placement="bottomRight" trigger={["click"]} menu={instanceButtonsMenuProps}>
@@ -225,6 +212,8 @@ export default function InstanceViewPage() {
/> />
<InstanceDescription host={host} instance={instance} /> <InstanceDescription host={host} instance={instance} />
{account.hasPermission("core.user.list") && <OnlinePlayersList instanceId={instanceId} />}
{ {
account.hasAllPermission("core.instance.save.list", "core.instance.save.subscribe") account.hasAllPermission("core.instance.save.list", "core.instance.save.subscribe")
&& <SavesList instance={instance} /> && <SavesList instance={instance} />
@@ -1,6 +1,6 @@
import React, { useContext, useState } from "react"; import React, { useContext, useState } from "react";
import { useNavigate } from "react-router-dom"; import { useNavigate } from "react-router-dom";
import { Button, Form, Input, Modal, Select, Tooltip } from "antd"; import { Button, Form, Input, Modal, Select, Space, Tooltip } from "antd";
import * as lib from "@clusterio/lib"; import * as lib from "@clusterio/lib";
@@ -82,11 +82,11 @@ export default function InstancesPage() {
return <PageLayout nav={[{ name: "Instances" }]}> return <PageLayout nav={[{ name: "Instances" }]}>
<PageHeader <PageHeader
title="Instances" title="Instances"
extra={<> extra={<Space>
{account.hasPermission("core.instance.create") && <CreateInstanceButton instances={instances}/>} {account.hasPermission("core.instance.create") && <CreateInstanceButton instances={instances}/>}
{account.hasPermission("core.instance.start") {account.hasPermission("core.instance.start")
&& <Button onClick={e => instances.forEach(instance => { && <Button onClick={e => instances.forEach(instance => {
if (instance.status === "stopped") { if (instance.status === "stopped" && !instance.excludeFromStartAll) {
control.sendTo( control.sendTo(
{ instanceId: instance.id }, { instanceId: instance.id },
new lib.InstanceStartRequest(undefined), new lib.InstanceStartRequest(undefined),
@@ -108,7 +108,7 @@ export default function InstancesPage() {
}> }>
Stop all Stop all
</Button>} </Button>}
</>} </Space>}
/> />
<InstanceList instances={instances} /> <InstanceList instances={instances} />
@@ -0,0 +1,31 @@
import React from "react";
import { useUsers } from "../model/user";
import UsersTable from "./UsersTable";
type OnlinePlayersListProps = {
instanceId: number;
};
export default function OnlinePlayersList({ instanceId }: OnlinePlayersListProps) {
const [users] = useUsers();
// Filter users to only show those online on this specific instance
const onlineUsers = [...users.values()].filter(user => user.instances && user.instances.has(instanceId));
if (onlineUsers.length === 0) {
return null;
}
return (
<div style={{ marginTop: 16 }}>
<h4>Online Players ({onlineUsers.length})</h4>
<UsersTable instanceId={instanceId} onlyOnline size="small" pagination={{
defaultPageSize: 10,
showSizeChanger: true,
pageSizeOptions: ["10", "20", "50", "100", "200"],
showTotal: (total: number) => `${total} Users`,
}} />
</div>
);
}
@@ -5,6 +5,7 @@ import DeleteOutlined from "@ant-design/icons/DeleteOutlined";
import * as lib from "@clusterio/lib"; import * as lib from "@clusterio/lib";
import { useRole } from "../model/roles";
import { useAccount } from "../model/account"; import { useAccount } from "../model/account";
import ControlContext from "./ControlContext"; import ControlContext from "./ControlContext";
import PageHeader from "./PageHeader"; import PageHeader from "./PageHeader";
@@ -12,30 +13,6 @@ import PageLayout from "./PageLayout";
import PluginExtra from "./PluginExtra"; import PluginExtra from "./PluginExtra";
import { notifyErrorHandler } from "../util/notify"; import { notifyErrorHandler } from "../util/notify";
function useRole(id: number): [Readonly<lib.Role> | undefined, boolean, () => void] {
let control = useContext(ControlContext);
let [role, setRole] = useState<lib.Role>();
let [synced, setSynced] = useState(false);
function updateRole() {
// XXX optimize by requesting only the role in question
control.send(new lib.RoleListRequest()).then(roles => {
let match = roles.find(u => u.id === id);
if (match) {
setRole(match);
}
setSynced(true);
});
}
useEffect(() => {
updateRole();
}, [id]);
return [role, synced, updateRole];
}
export default function RoleViewPage() { export default function RoleViewPage() {
let params = useParams(); let params = useParams();
let roleId = Number(params.id); let roleId = Number(params.id);
@@ -44,7 +21,7 @@ export default function RoleViewPage() {
let account = useAccount(); let account = useAccount();
let control = useContext(ControlContext); let control = useContext(ControlContext);
const [role, synced, updateRole] = useRole(roleId); const [role, synced] = useRole(roleId);
let [edited, setEdited] = useState(false); let [edited, setEdited] = useState(false);
@@ -63,6 +40,7 @@ export default function RoleViewPage() {
</PageLayout>; </PageLayout>;
} }
// TODO: Update displayed perms when role perms change and have not been edited locally
let initialValues = { let initialValues = {
name: role["name"], name: role["name"],
description: role["description"], description: role["description"],
@@ -88,7 +66,6 @@ export default function RoleViewPage() {
new lib.RoleUpdateRequest(roleId, values.name || "", values.description || "", newPermissions) new lib.RoleUpdateRequest(roleId, values.name || "", values.description || "", newPermissions)
).then(() => { ).then(() => {
setEdited(false); setEdited(false);
updateRole();
}).catch(notifyErrorHandler("Error applying changes")); }).catch(notifyErrorHandler("Error applying changes"));
}} }}
> >
+3 -10
View File
@@ -4,6 +4,7 @@ import { Button, Form, Input, Modal, Table } from "antd";
import * as lib from "@clusterio/lib"; import * as lib from "@clusterio/lib";
import { useRoles } from "../model/roles";
import { useAccount } from "../model/account"; import { useAccount } from "../model/account";
import ControlContext from "./ControlContext"; import ControlContext from "./ControlContext";
import { notifyErrorHandler } from "../util/notify"; import { notifyErrorHandler } from "../util/notify";
@@ -60,16 +61,8 @@ function CreateRoleButton() {
export default function RolesPage() { export default function RolesPage() {
let account = useAccount(); let account = useAccount();
let control = useContext(ControlContext);
let navigate = useNavigate(); let navigate = useNavigate();
const [roles] = useRoles();
let [roles, setRoles] = useState<lib.Role[]>([]);
useEffect(() => {
control.send(new lib.RoleListRequest()).then(newRoles => {
setRoles(newRoles);
}).catch(notifyErrorHandler("Error fetching role list"));
}, []);
return <PageLayout nav={[{ name: "Roles" }]}> return <PageLayout nav={[{ name: "Roles" }]}>
<PageHeader <PageHeader
@@ -88,7 +81,7 @@ export default function RolesPage() {
dataIndex: "description", dataIndex: "description",
}, },
]} ]}
dataSource={roles} dataSource={[...roles.values()]}
pagination={false} pagination={false}
rowKey={role => role.id} rowKey={role => role.id}
onRow={(role, rowIndex) => ({ onRow={(role, rowIndex) => ({
@@ -1,61 +0,0 @@
import React, { useContext, useState } from "react";
import { Button } from "antd";
import * as lib from "@clusterio/lib";
import ControlContext from "./ControlContext";
import { notifyErrorHandler } from "../util/notify";
import { ButtonProps } from "antd/es/button";
type StartStopInstanceButtonProps = {
instance: lib.InstanceDetails;
onFinish?: () => void;
buttonProps?: ButtonProps;
};
export default function StartStopInstanceButton(props: StartStopInstanceButtonProps) {
let control = useContext(ControlContext);
let [switching, setSwitching] = useState<boolean>(false);
function onClick(event: React.MouseEvent<HTMLElement>) {
event.stopPropagation();
setSwitching(true);
let action;
if (props.instance.status === "stopped") {
action = control.sendTo(
{ instanceId: props.instance.id },
new lib.InstanceStartRequest(undefined),
).catch(
notifyErrorHandler("Error starting instance")
);
} else if (["starting", "running"].includes(props.instance.status)) {
action = control.sendTo(
{ instanceId: props.instance.id },
new lib.InstanceStopRequest(),
).catch(
notifyErrorHandler("Error stopping instance")
);
} else {
setSwitching(false);
return;
}
action.finally(() => {
setSwitching(false);
if (props.onFinish) {
props.onFinish();
}
});
};
return <Button
{...(props.buttonProps || {})}
loading={switching}
type="primary"
disabled={!["starting", "running", "stopped"].includes(props.instance.status)}
onClick={onClick}
>
{props.instance.status === "stopped" ? "Start" : "Stop"}
</Button>;
}
@@ -8,6 +8,7 @@ import DeleteOutlined from "@ant-design/icons/DeleteOutlined";
import * as lib from "@clusterio/lib"; import * as lib from "@clusterio/lib";
import { useRoles } from "../model/roles";
import { useAccount } from "../model/account"; import { useAccount } from "../model/account";
import { useInstances } from "../model/instance"; import { useInstances } from "../model/instance";
import ControlContext from "./ControlContext"; import ControlContext from "./ControlContext";
@@ -35,21 +36,13 @@ export default function UserViewPage() {
let control = useContext(ControlContext); let control = useContext(ControlContext);
let [instances] = useInstances(); let [instances] = useInstances();
const [user, synced] = useUser(userName); const [user, synced] = useUser(userName);
let [roles, setRoles] = useState<Map<number, lib.Role>>(new Map()); let [roles] = useRoles();
let [form] = Form.useForm(); let [form] = Form.useForm();
let [rolesDirty, setRolesDirty] = useState<boolean>(false); let [rolesDirty, setRolesDirty] = useState<boolean>(false);
let [banReasonDirty, setBanReasonDirty] = useState<boolean>(false); let [banReasonDirty, setBanReasonDirty] = useState<boolean>(false);
let [applyingRoles, setApplyingRoles] = useState<boolean>(false); let [applyingRoles, setApplyingRoles] = useState<boolean>(false);
let [rolesError, setRolesError] = useState<string|undefined>(); let [rolesError, setRolesError] = useState<string|undefined>();
useEffect(() => {
control.send(new lib.RoleListRequest()).then(newRoles => {
setRoles(new Map(newRoles.map(role => [role.id, role])));
}).catch(() => {
setRoles(new Map());
});
}, []);
useEffect(() => { useEffect(() => {
if ( if (
account.hasPermission("core.user.set_banned") account.hasPermission("core.user.set_banned")
@@ -76,6 +69,7 @@ export default function UserViewPage() {
</PageLayout>; </PageLayout>;
} }
// TODO: Update displayed roles when user roles change and have not been edited locally
let roleSelector = <Form.Item let roleSelector = <Form.Item
noStyle noStyle
name="roles" name="roles"
+13 -113
View File
@@ -1,30 +1,24 @@
import React, { useEffect, useContext, useState, useRef } from "react"; import React, { useContext, useState } from "react";
import { useNavigate } from "react-router-dom"; import { useNavigate } from "react-router-dom";
import { Static } from "@sinclair/typebox"; import { Static } from "@sinclair/typebox";
import { import {
Button, Form, FormInstance, Input, InputRef, Modal, Button, Form, FormInstance, Input, Modal,
Radio, Space, Table, Tag, Upload, UploadProps, Radio, Space, Upload, UploadProps,
} from "antd"; } from "antd";
import { import { InboxOutlined } from "@ant-design/icons";
InboxOutlined, SearchOutlined,
} from "@ant-design/icons";
import * as lib from "@clusterio/lib"; import * as lib from "@clusterio/lib";
import { useAccount } from "../model/account"; import { useAccount } from "../model/account";
import ControlContext from "./ControlContext"; import ControlContext from "./ControlContext";
import { notifyErrorHandler } from "../util/notify"; import { notifyErrorHandler } from "../util/notify";
import { formatDuration } from "../util/time_format";
import { saveJson } from "../util/save_file"; import { saveJson } from "../util/save_file";
import PageHeader from "./PageHeader"; import PageHeader from "./PageHeader";
import PageLayout from "./PageLayout"; import PageLayout from "./PageLayout";
import PluginExtra from "./PluginExtra"; import PluginExtra from "./PluginExtra";
import { formatFirstSeen, formatLastSeen, sortFirstSeen, sortLastSeen, useUsers } from "../model/user"; import UsersTable from "./UsersTable";
import Link from "./Link";
const strcmp = new Intl.Collator(undefined, { numeric: true, sensitivity: "base" }).compare;
function CreateUserButton() { function CreateUserButton() {
let control = useContext(ControlContext); let control = useContext(ControlContext);
@@ -320,7 +314,7 @@ function BulkUserActionButton() {
const [formAction, setFormAction] = useState<string | undefined>(undefined); const [formAction, setFormAction] = useState<string | undefined>(undefined);
const [form] = Form.useForm(); const [form] = Form.useForm();
function onValuesChange({ action } : { action?: string }) { function onValuesChange({ action }: { action?: string }) {
if (action) { if (action) {
setFormAction(action); setFormAction(action);
} }
@@ -347,7 +341,7 @@ function BulkUserActionButton() {
title="Bulk Actions" title="Bulk Actions"
okText="Apply" okText="Apply"
open={open} open={open}
okButtonProps={{disabled: formAction === undefined}} okButtonProps={{ disabled: formAction === undefined }}
onOk={() => { onOk().catch(notifyErrorHandler(`Error running ${formAction}`)); }} onOk={() => { onOk().catch(notifyErrorHandler(`Error running ${formAction}`)); }}
onCancel={() => { setOpen(false); }} onCancel={() => { setOpen(false); }}
destroyOnClose destroyOnClose
@@ -363,9 +357,9 @@ function BulkUserActionButton() {
? <Radio.Button value="restore">Restore</Radio.Button> : undefined} ? <Radio.Button value="restore">Restore</Radio.Button> : undefined}
</Radio.Group> </Radio.Group>
</Form.Item> </Form.Item>
{formAction === "import" ? <UserBulkActionImport {...{setApplyAction, form}}/> : undefined} {formAction === "import" ? <UserBulkActionImport {...{ setApplyAction, form }} /> : undefined}
{formAction === "export" ? <UserBulkActionExport {...{setApplyAction, form}}/> : undefined} {formAction === "export" ? <UserBulkActionExport {...{ setApplyAction, form }} /> : undefined}
{formAction === "restore" ? <UserBulkActionImport restore {...{setApplyAction, form}}/> : undefined} {formAction === "restore" ? <UserBulkActionImport restore {...{ setApplyAction, form }} /> : undefined}
</Form> </Form>
</Modal> </Modal>
</>; </>;
@@ -373,111 +367,17 @@ function BulkUserActionButton() {
export default function UsersPage() { export default function UsersPage() {
let account = useAccount(); let account = useAccount();
let control = useContext(ControlContext);
let navigate = useNavigate();
let [users] = useUsers();
const [roles, setRoles] = useState(new Map());
const searchInput = useRef<InputRef>(null);
useEffect(() => {
control.send(new lib.RoleListRequest()).then(newRoles => {
setRoles(new Map(newRoles.map(role => [role.id, role])));
}).catch(() => {
// ignore
});
}, []);
return <PageLayout nav={[{ name: "Users" }]}> return <PageLayout nav={[{ name: "Users" }]}>
<PageHeader <PageHeader
title="Users" title="Users"
extra={<> extra={<Space>
{account.hasPermission("core.user.create") ? <CreateUserButton /> : undefined} {account.hasPermission("core.user.create") ? <CreateUserButton /> : undefined}
{account.hasAnyPermission("core.user.bulk_import", "core.user.bulk_export") {account.hasAnyPermission("core.user.bulk_import", "core.user.bulk_export")
? <BulkUserActionButton /> : undefined} ? <BulkUserActionButton /> : undefined}
</>} </Space>}
/>
<Table
columns={[
{
title: "Name",
key: "name",
render: (_, user) => <Space>
{user.name}
<span>
{user.isAdmin && <Tag color="gold">Admin</Tag>}
{user.isWhitelisted && <Tag>Whitelisted</Tag>}
{user.isBanned && <Tag color="red">Banned</Tag>}
</span>
</Space>,
defaultSortOrder: "ascend",
sorter: (a, b) => strcmp(a.name, b.name),
filterIcon: (filtered) => <SearchOutlined style={{ color: filtered ? "#1677ff" : undefined }} />,
onFilter: (value, record) => record.name.toLowerCase().includes((value as string).toLowerCase()),
filterDropdownProps: {
onOpenChange: open => open && setTimeout(() => searchInput.current?.select(), 100),
},
filterDropdown: ({ selectedKeys, setSelectedKeys, confirm, clearFilters }) => (
<div style={{ padding: 4 }} onKeyDown={(e) => e.stopPropagation()}>
<Input.Search
allowClear
ref={searchInput}
placeholder={"Search username"}
value={selectedKeys[0]}
onChange={(e) => setSelectedKeys([e.target.value])}
onClear={() => clearFilters && clearFilters({ confirm: true, closeDropdown: true })}
onSearch={() => confirm({ closeDropdown: true })}
/>
</div>
),
},
{
title: "Roles",
key: "roles",
render: (_, user) => (
[...user.roleIds]
.map(id => <Link key={id} to={`/roles/${id}/view`} onClick={e => e.stopPropagation()}>
<Tag>{(roles.get(id) || { name: id }).name}</Tag>
</Link>)
),
},
{
title: "Online time",
key: "onlineTime",
render: (_, user) => (user.playerStats?.onlineTimeMs
? formatDuration(user.playerStats.onlineTimeMs) : null),
sorter: (a, b) => (a.playerStats?.onlineTimeMs ?? 0) -
(b.playerStats?.onlineTimeMs ?? 0),
responsive: ["lg"],
},
{
title: "First seen",
key: "firstSeen",
render: (_, user) => formatFirstSeen(user),
sorter: (a, b) => sortFirstSeen(a, b),
},
{
title: "Last seen",
key: "lastSeen",
render: (_, user) => formatLastSeen(user),
sorter: (a, b) => sortLastSeen(a, b),
responsive: ["lg"],
},
]}
dataSource={[...users.values()]}
pagination={{
defaultPageSize: 50,
showSizeChanger: true,
pageSizeOptions: ["10", "20", "50", "100", "200"],
showTotal: total => `${total} Users`,
}}
rowKey={user => user.name}
onRow={(user, rowIndex) => ({
onClick: event => {
navigate(`/users/${user.name}/view`);
},
})}
/> />
<UsersTable />
<PluginExtra component="UsersPage" /> <PluginExtra component="UsersPage" />
</PageLayout>; </PageLayout>;
} }
@@ -0,0 +1,262 @@
import React, { useRef } from "react";
import { Table, Tag, Space, Input, InputRef } from "antd";
import type { FilterDropdownProps } from "antd/es/table/interface";
import { SearchOutlined } from "@ant-design/icons";
import { useNavigate } from "react-router-dom";
import * as lib from "@clusterio/lib";
import { useRoles } from "../model/roles";
import { formatDuration } from "../util/time_format";
import {
formatFirstSeen,
formatLastSeen,
sortFirstSeen,
sortLastSeen,
useUsers,
} from "../model/user";
import Link from "./Link";
export interface UsersTableProps {
/**
* Optional instance id.
* – If provided, instance-specific columns (Play Time, Join Count, First Seen) are shown.
* – If omitted, global player statistics columns (Online Time, First/Last Seen) are shown.
*/
instanceId?: number;
/** Show only players that are currently online, works with instanceId to show online of a particular instance */
onlyOnline?: boolean;
/** Ant Design pagination prop. Pass `false` to disable pagination. */
pagination?: false | object;
/** Ant Design size prop */
size?: "small" | "middle" | "large";
}
const strcmp = new Intl.Collator(undefined, { numeric: true, sensitivity: "base" }).compare;
export default function UsersTable({ instanceId, onlyOnline = false, pagination, size }: UsersTableProps) {
const [roles] = useRoles();
const navigate = useNavigate();
const searchInput = useRef<InputRef>(null);
const [users] = useUsers();
const data = [...users.values()];
// Determine online predicate based on instanceId
const isUserOnline = (user: lib.User) => {
if (instanceId !== undefined) {
return user.instances && user.instances.has(instanceId);
}
return user.instances && user.instances.size > 0;
};
// Prepare filters for roles column
const roleFilters = [...roles.values()].map(role => ({ text: role.name, value: role.id }));
const columns: any[] = [
{
title: "Name",
key: "name",
render: (_: any, user: lib.User) => (
<Space>
{user.name}
<span>
{user.isAdmin && <Tag color="gold">Admin</Tag>}
{user.isWhitelisted && <Tag>Whitelisted</Tag>}
{user.isBanned && <Tag color="red">Banned</Tag>}
</span>
</Space>
),
defaultSortOrder: "ascend",
sorter: (a: lib.User, b: lib.User) => strcmp(a.name, b.name),
filterIcon: (filtered: boolean) => (
<SearchOutlined style={{ color: filtered ? "#1677ff" : undefined }} />
),
onFilter: (value: string | number | boolean, record: lib.User) => record.name
.toLowerCase()
.includes((value as string).toLowerCase()),
filterDropdownProps: {
onOpenChange: (open: boolean) => open && setTimeout(() => searchInput.current?.select(), 100),
},
filterDropdown: ({ selectedKeys, setSelectedKeys, confirm, clearFilters }: {
selectedKeys: string[],
setSelectedKeys: (keys: string[]) => void,
confirm: FilterDropdownProps["confirm"],
clearFilters: FilterDropdownProps["clearFilters"],
}) => (
<div style={{ padding: 4 }} onKeyDown={(e) => e.stopPropagation()}>
<Input.Search
allowClear
ref={searchInput}
placeholder={"Search username"}
value={selectedKeys[0]}
onChange={(e) => setSelectedKeys([e.target.value])}
onSearch={() => confirm({ closeDropdown: false })}
onClear={() => {
clearFilters?.({ closeDropdown: false });
confirm({ closeDropdown: true });
}}
/>
</div>
),
},
{
title: "Roles",
key: "roles",
filters: roleFilters,
filterMultiple: true,
onFilter: (value: string | number | boolean, record: lib.User) => record.roleIds.has(value as number),
render: (_: any, user: lib.User) => (
[...user.roleIds].map((id) => (
<Link key={id} to={`/roles/${id}/view`} onClick={(e) => e.stopPropagation()}>
<Tag>{(roles.get(id) || { name: id }).name}</Tag>
</Link>
))
),
},
];
// Helper to get last seen timestamp
function getLastSeenTimestamp(user: lib.User): number | undefined {
const stats = instanceId !== undefined ? user.instanceStats.get(instanceId) : user.playerStats;
if (!stats) { return undefined; }
if (stats.lastLeaveAt && stats.lastLeaveAt.getTime() > (stats.lastJoinAt?.getTime() ?? 0)) {
return stats.lastLeaveAt.getTime();
}
if (stats.lastJoinAt) {
return stats.lastJoinAt.getTime();
}
return undefined;
}
if (instanceId !== undefined) {
columns.push(
{
title: "Play Time",
key: "playTime",
render: (_: any, user: lib.User) => {
const instanceStats = user.instanceStats.get(instanceId);
return instanceStats?.onlineTimeMs ? formatDuration(instanceStats.onlineTimeMs) : "-";
},
sorter: (a: lib.User, b: lib.User) => {
const statsA = a.instanceStats.get(instanceId);
const statsB = b.instanceStats.get(instanceId);
return (statsA?.onlineTimeMs ?? 0) - (statsB?.onlineTimeMs ?? 0);
},
},
{
title: "Join Count",
key: "joinCount",
render: (_: any, user: lib.User) => {
const instanceStats = user.instanceStats.get(instanceId);
return instanceStats?.joinCount ?? 0;
},
sorter: (a: lib.User, b: lib.User) => {
const statsA = a.instanceStats.get(instanceId);
const statsB = b.instanceStats.get(instanceId);
return (statsA?.joinCount ?? 0) - (statsB?.joinCount ?? 0);
},
},
{
title: "First Seen",
key: "firstSeen",
render: (_: any, user: lib.User) => formatFirstSeen(user, instanceId),
sorter: (a: lib.User, b: lib.User) => {
const statsA = a.instanceStats.get(instanceId);
const statsB = b.instanceStats.get(instanceId);
const firstSeenA = statsA?.firstJoinAt?.getTime() ?? 0;
const firstSeenB = statsB?.firstJoinAt?.getTime() ?? 0;
return firstSeenA - firstSeenB;
},
},
);
} else {
columns.push(
{
title: "Online time",
key: "onlineTime",
render: (_: any, user: lib.User) => (user.playerStats?.onlineTimeMs
? formatDuration(user.playerStats.onlineTimeMs)
: null),
// eslint-disable-next-line max-len
sorter: (a: lib.User, b: lib.User) => (a.playerStats?.onlineTimeMs ?? 0) - (b.playerStats?.onlineTimeMs ?? 0),
responsive: ["lg"],
},
{
title: "First seen",
key: "firstSeen",
render: (_: any, user: lib.User) => formatFirstSeen(user),
sorter: (a: lib.User, b: lib.User) => sortFirstSeen(a, b),
},
);
}
columns.push(
{
title: "Last seen",
key: "lastSeen",
filterMultiple: false,
defaultFilteredValue: onlyOnline ? ["online"] : undefined,
filters: [
{ text: "Online", value: "online" },
{ text: "24h", value: "24h" },
{ text: "7d", value: "7d" },
{ text: "30d", value: "30d" },
],
onFilter: (value: string | number | boolean, record: lib.User) => {
const online = isUserOnline(record);
if (value === "online") {
return online;
}
// Online players should appear in all buckets
if (online) {
return true;
}
const ts = getLastSeenTimestamp(record);
if (!ts) { return false; }
const diff = Date.now() - ts;
switch (value) {
case "24h":
return diff <= 24 * 60 * 60 * 1000;
case "7d":
return diff <= 7 * 24 * 60 * 60 * 1000;
case "30d":
return diff <= 30 * 24 * 60 * 60 * 1000;
default:
return false;
}
},
sorter: (a: lib.User, b: lib.User) => sortLastSeen(a, b, instanceId, instanceId),
render: (_: any, user: lib.User) => formatLastSeen(user, instanceId),
responsive: ["lg"],
},
);
const defaultPagination = pagination === undefined
? {
defaultPageSize: 50,
showSizeChanger: true,
pageSizeOptions: ["10", "20", "50", "100", "200"],
showTotal: (total: number) => `${total} Users`,
}
: pagination;
return (
<Table
columns={columns}
dataSource={data}
rowKey={(user) => user.name}
pagination={defaultPagination}
size={size}
onRow={(user) => ({
onClick: (event) => {
if ((event.target as HTMLElement).closest("a")) {
return;
}
navigate(`/users/${user.name}/view`);
},
})}
/>
);
}
@@ -0,0 +1,43 @@
import React from "react";
import { Button, Dropdown } from "antd";
import { MenuItemType } from "antd/es/menu/interface";
import { DropdownButtonProps } from "antd/es/dropdown";
export type VariableDropdownButtonProps = DropdownButtonProps & {
actions: (MenuItemType & { onClick?: () => void })[],
};
export default function VariableDropdownButton(props: VariableDropdownButtonProps) {
const menuActions = [...props.actions];
const mainAction = menuActions.shift();
if (!mainAction) {
return <></>;
}
const buttonProps: DropdownButtonProps = {
...props,
danger: mainAction.danger,
onClick: (event) => {
event.stopPropagation();
if (mainAction.onClick) {
mainAction.onClick();
}
},
};
return menuActions.length === 0
? <Button {...buttonProps}>
{mainAction.label}
</Button>
: <Dropdown.Button
{...buttonProps}
// stopPropagation is needed to prevent propagation to table rows
menu={{ items: menuActions, onClick: (e: any) => e.domEvent.stopPropagation() }}
buttonsRender={([left, right]) => [
left, React.cloneElement(right as any, { onClick: (e: any) => e.stopPropagation() }),
]}
>
{mainAction.label}
</Dropdown.Button>;
}
+1 -1
View File
@@ -22,7 +22,7 @@ export { default as AssignInstanceModal } from "./components/AssignInstanceModal
export { default as InstanceList } from "./components/InstanceList"; export { default as InstanceList } from "./components/InstanceList";
export { default as InstanceRcon } from "./components/InstanceRcon"; export { default as InstanceRcon } from "./components/InstanceRcon";
export { default as InstanceStatusTag, statusColors } from "./components/InstanceStatusTag"; export { default as InstanceStatusTag, statusColors } from "./components/InstanceStatusTag";
export { default as StartStopInstanceButton } from "./components/StartStopInstanceButton"; export { default as InstanceControlButton, InstanceControlButtonPermissions } from "./components/InstanceControlButton";
export { default as PageHeader } from "./components/PageHeader"; export { default as PageHeader } from "./components/PageHeader";
export { default as PageLayout } from "./components/PageLayout"; export { default as PageLayout } from "./components/PageLayout";
+23
View File
@@ -0,0 +1,23 @@
import { useCallback, useContext, useSyncExternalStore } from "react";
import ControlContext from "../components/ControlContext";
import * as lib from "@clusterio/lib";
export function useRolesOfUser(user?: lib.User) {
const [roles, synced] = useRoles();
return [
user !== undefined ? new Map([...user.roleIds].map(roleId => [roleId, roles.get(roleId)])) : new Map(),
synced,
] as const;
}
export function useRole(id?: number) {
const [roles, synced] = useRoles();
return [id !== undefined ? roles.get(id) : undefined, synced] as const;
}
export function useRoles() {
const control = useContext(ControlContext);
const subscribe = useCallback((callback: () => void) => control.roles.subscribe(callback), [control]);
return useSyncExternalStore(subscribe, () => control.roles.getSnapshot());
}
+5 -1
View File
@@ -1,7 +1,11 @@
import { useEffect, useState } from "react"; import { useEffect, useState } from "react";
import { EventEmitter } from "events"; import { EventEmitter } from "events";
class Permission extends EventEmitter { type PermissionEvents = {
"change": [ status: string ]
};
class Permission extends EventEmitter<PermissionEvents> {
status!: { state: string }; status!: { state: string };
constructor(name: PermissionName) { constructor(name: PermissionName) {
+1
View File
@@ -67,6 +67,7 @@ export class Control extends lib.Link {
modPacks = new lib.EventSubscriber(lib.ModPackUpdatesEvent, this); modPacks = new lib.EventSubscriber(lib.ModPackUpdatesEvent, this);
mods = new lib.EventSubscriber(lib.ModUpdatesEvent, this); mods = new lib.EventSubscriber(lib.ModUpdatesEvent, this);
users = new lib.EventSubscriber(lib.UserUpdatesEvent, this); users = new lib.EventSubscriber(lib.UserUpdatesEvent, this);
roles = new lib.EventSubscriber(lib.RoleUpdatesEvent, this);
declare connector: ControlConnector; declare connector: ControlConnector;
+7 -8
View File
@@ -4,9 +4,10 @@ const { CleanWebpackPlugin } = require("clean-webpack-plugin");
const { WebpackManifestPlugin } = require("webpack-manifest-plugin"); const { WebpackManifestPlugin } = require("webpack-manifest-plugin");
const TerserPlugin = require("terser-webpack-plugin"); const TerserPlugin = require("terser-webpack-plugin");
module.exports = (env = {}) => ({ module.exports = (env = {}, argv = {}) => ({
mode: env.production ? "production" : "development", mode: argv.mode ?? "development",
devtool: env.production ? "source-map" : "eval-source-map", devtool: argv.mode === "production" ? "source-map" : "eval-source-map",
cache: { type: "filesystem" },
performance: { performance: {
maxAssetSize: 2**21, maxAssetSize: 2**21,
maxEntrypointSize: 2**21, maxEntrypointSize: 2**21,
@@ -34,7 +35,7 @@ module.exports = (env = {}) => ({
new webpack.NormalModuleReplacementPlugin( new webpack.NormalModuleReplacementPlugin(
/@ant-design\/icons\/[A-Z]/, /@ant-design\/icons\/[A-Z]/,
resource => { resource => {
resource.request = resource.request.replace(/@ant-design\/icons/, "$&/es/icons"); resource.request = resource.request.replace("@ant-design\/icons", "$&/es/icons");
} }
), ),
], ],
@@ -60,7 +61,7 @@ module.exports = (env = {}) => ({
{ {
loader: require.resolve("css-loader"), loader: require.resolve("css-loader"),
options: { options: {
sourceMap: !env.production, sourceMap: argv.mode !== "production",
}, },
}, },
], ],
@@ -138,9 +139,7 @@ module.exports = (env = {}) => ({
moduleIds: "deterministic", moduleIds: "deterministic",
minimizer: [ minimizer: [
new TerserPlugin({ new TerserPlugin({
// TerserPlugin.swcMinify spams log with "false" after bump to @swc/core@1.11.1 minify: TerserPlugin.swcMinify,
// https://github.com/clusterio/clusterio/issues/737
// minify: TerserPlugin.swcMinify,
terserOptions: { terserOptions: {
compress: { compress: {
keep_classnames: true, keep_classnames: true,
+1 -1
View File
@@ -13,7 +13,7 @@
"factorio" "factorio"
], ],
"scripts": { "scripts": {
"prepare": "tsc --build && webpack-cli --env production", "prepare": "tsc --build && webpack-cli --mode production",
"test": "echo \"Error: run tests from root\" && exit 1" "test": "echo \"Error: run tests from root\" && exit 1"
}, },
"bugs": { "bugs": {
-1
View File
@@ -26,7 +26,6 @@ describe("global_chat plugin", function() {
let instancePlugin; let instancePlugin;
before(async function() { before(async function() {
lib.Link.register(ChatEvent);
instancePlugin = new instance.InstancePlugin(info, new mock.MockInstance(), new mock.MockHost()); instancePlugin = new instance.InstancePlugin(info, new mock.MockInstance(), new mock.MockHost());
await instancePlugin.init(); await instancePlugin.init();
}); });
+1 -1
View File
@@ -5,7 +5,7 @@ const { merge } = require("webpack-merge");
const common = require("@clusterio/web_ui/webpack.common"); const common = require("@clusterio/web_ui/webpack.common");
module.exports = (env = {}) => merge(common(env), { module.exports = (env = {}, argv = {}) => merge(common(env, argv), {
context: __dirname, context: __dirname,
entry: "./web/index.tsx", entry: "./web/index.tsx",
output: { output: {
+1 -1
View File
@@ -13,7 +13,7 @@
"factorio" "factorio"
], ],
"scripts": { "scripts": {
"prepare": "tsc --build && webpack-cli --env production", "prepare": "tsc --build && webpack-cli --mode production",
"test": "echo \"Error: run tests from root\" && exit 1" "test": "echo \"Error: run tests from root\" && exit 1"
}, },
"bugs": { "bugs": {
Loaded 100 of 129 files, more files were not shown because too many files have changed in this diff. Show more