Compare commits

...
Author SHA1 Message Date
Hornwitser 1e4292876c v2.0.0-alpha.12 2022-04-22 12:36:00 +02:00
Hornwitser ca6464baeb Merge pull request #456 from Hornwitser/save-transfer
Save transfer
2022-03-30 22:51:04 +02:00
Hornwitser c2cb58d088 Comment out command logging in tests
Don't log commands executed while running tests as these spam the output
more than they are useful right now.
2022-03-29 22:55:13 +02:00
Hornwitser 38c249ec70 Implement save transfer
Add ability to move or copy saves between instances.  For instances on
the same slave the saves are transferred with filesystem operations, for
instances on two different slaves the proxy stream interface is used to
send the save via the master server.
2022-03-28 20:42:08 +02:00
Hornwitser 2e1c1fd3c8 Remove duplicated instance check
Deduplicate instance existence check for requests in master.
2022-03-28 20:42:08 +02:00
Hornwitser 4edc7a2949 Implement rename and copy save
Add ability to rename and copy existing saves on an instance.
2022-03-27 19:59:29 +02:00
Hornwitser 9b5c6f8554 Remove duplicated request checks
Move duplicated checking of save filenames and instance existing from
requests into separate functions.
2022-03-27 18:50:15 +02:00
Hornwitser 0de964ec02 Reorganise instance save commands
Move create, list, upload and dalete save management commands to its own
'instance save' namespace in the command line interface.
2022-03-27 15:50:42 +02:00
Hornwitser 7db091d427 Simplify wording of save permissions
Use shorter and more consise titles for the save management related
permissions.
2022-03-27 15:39:40 +02:00
Hornwitser 9cf7dea579 Add mods for subspace_storage in GitHub Actions (#455)
The GitHub Actions workflow was missing the mods needed to do the tests
for subspace_storage, causing coverage to be lower than it should be.
2022-03-27 13:16:12 +02:00
Hornwitser 9465a488cc Migrate coverage reporting to GitHub Actions (#454)
Travis seems to be going away from supporting Open Source Software for
free and their proceedure to gaining free tokens is getting harder and
hander to find for each year that passes.  Remove Travis CI integration
and migrate the coverage reporting previously provided by the Travis
build over to the GitHub Actions.
2022-03-26 21:23:19 +01:00
Hornwitser 5e94198216 Merge pull request #453 from Hornwitser/small-things-7
Small things 7
2022-03-26 21:22:35 +01:00
Hornwitser 854d2b3c79 Suggested grammar fix 2022-03-26 20:27:59 +01:00
Hornwitser 946847c95d Send save list update after manual save
Trigger a save list update in the event an admin manually saves the game
with the /server-save command.
2022-03-25 23:15:07 +01:00
Hornwitser ce95f868fd Fix curently typo 2022-03-25 23:15:07 +01:00
Hornwitser e5a63a3508 Add start-stop button to instance list 2022-03-25 23:15:07 +01:00
Hornwitser 1e4d709a06 Implement kill instance
Add ability to kill running instances in case it is desirable to stop
the server without saving over the current save file.
2022-03-25 20:52:31 +01:00
Hornwitser a93f048814 Add support for sidebar groups
Allow sidebar entries to be grouped together by specifiying a name under
which they will be grouped.  To avoid confusion groups are rendered at
the bottom of the list.
2022-02-10 14:51:51 +01:00
Hornwitser 5319ff3907 Add hook to add extra content to Web UI pages
Allow plugins to extend Web UI pages provided by Clusterio by
adding components in the componentExtra property of the plugin.
2022-02-10 14:51:51 +01:00
Hornwitser 68b8ac6b8c Add onMasterConfigFieldChanged hook
Add hook for master plugin code to react to the master config changing.
2022-02-10 10:29:47 +01:00
Arvids Godjuks a979c0cfac Merge pull request #446 from jake-87/ctl-docs
Added more documentation for managing-a-cluster.md
2022-01-19 13:39:45 +02:00
J87 3da8c30a64 Remove unnecessary information 2022-01-11 19:55:18 +11:00
J87 f8c72a1e0a Fixed wording issue 2022-01-10 12:37:02 +11:00
Hornwitser 4a059efe18 Merge pull request #447 from Hornwitser/lgtm-alerts
Fix issues detected by lgtm.com
2022-01-09 19:06:38 +01:00
Hornwitser dec5467538 Use anonymous master metrics
Convert the master metrics to void instead of storing them in a variable
as they are completely self contained, and this makes it more clear that
there are no use of references to the metrics.
2022-01-05 19:45:24 +01:00
Hornwitser 61cd5bd76c Fix issues detected by lgtm.com 2022-01-03 19:45:46 +01:00
jake-87 1b1524e787 Fix poor wording 2022-01-02 19:23:54 +11:00
jake-87 488d81f424 Updated wording in docs
Also added more information on the banned-bulk-import option.
2022-01-02 19:16:23 +11:00
jake-87 8ecc6d1c83 Added instance and user documentation 2021-12-10 13:01:03 +11:00
77 changed files with 1256 additions and 334 deletions

No files matched your search

+13 -1
View File
@@ -24,8 +24,20 @@ jobs:
- run: npm i --no-optional - run: npm i --no-optional
- run: wget -q -O factorio.tar.gz https://www.factorio.com/get-download/latest/headless/linux64 && tar -xf factorio.tar.gz && rm factorio.tar.gz - run: wget -q -O factorio.tar.gz https://www.factorio.com/get-download/latest/headless/linux64 && tar -xf factorio.tar.gz && rm factorio.tar.gz
- run: npx lerna bootstrap --hoist - run: npx lerna bootstrap --hoist
- run: node packages/lib/build_mod --source-dir packages/slave/lua/clusterio_lib --output-dir temp/test/sharedMods
- run: wget -q -O temp/test/sharedMods/subspace_storage_1.99.8.zip -L https://github.com/clusterio/subspace_storage/releases/download/1.99.6/subspace_storage_1.99.8.zip
- run: npx lerna run build - run: npx lerna run build
- run: npm test - name: Run tests
if: ${{ matrix.node-version != '12.x' }}
run: npm test
- name: Run coverage
if: ${{ matrix.node-version == '12.x' }}
run: npm run ci-cover
- name : Upload coverage to Codecov
if: ${{ matrix.node-version == '12.x' }}
uses: codecov/codecov-action@v2
with:
files: ./coverage/lcov.info
lint: lint:
runs-on: ubuntu-latest runs-on: ubuntu-latest
-15
View File
@@ -1,15 +0,0 @@
language: node_js
node_js:
- 12
before_install:
- curl -o factorio.tar.gz -L https://www.factorio.com/get-download/latest/headless/linux64
- tar -xf factorio.tar.gz
- npm install -g codecov
script:
- npx lerna bootstrap --hoist --no-ci
- node packages/lib/build_mod --source-dir packages/slave/lua/clusterio_lib --output-dir temp/test/sharedMods
- curl -o temp/test/sharedMods/subspace_storage_1.99.8.zip -L https://github.com/clusterio/subspace_storage/releases/download/1.99.6/subspace_storage_1.99.8.zip
- npx lerna run build
- npm run-script ci-cover
- codecov -f coverage/lcov.info
- npm run-script lint
+1 -1
View File
@@ -19,7 +19,7 @@
- Packaged and uploaded to npm again, greatly simplifying distribution and installation of both Clusterio and plugins. - Packaged and uploaded to npm again, greatly simplifying distribution and installation of both Clusterio and plugins.
- Added centralized logging for the cluster. - Added centralized logging for the cluster.
All logs from both Clusterio and Factorio is stored in a shared log which can be inspected and queried. All logs from both Clusterio and Factorio is stored in a shared log which can be inspected and queried.
- Added remote save management with the ability to list, create, upload, download, delete and load saves for instances. - Added remote save management with the ability to list, create, rename, copy, upload, download, transfer, delete and load saves for instances.
### Features ### Features
+1 -1
View File
@@ -125,7 +125,7 @@ Otherwise see below for OS specific instructions.
**Ubuntu with Docker** **Ubuntu with Docker**
The Docker support for Clusterio is curently broken. The Docker support for Clusterio is currently broken.
If you need it open an issue about it. If you need it open an issue about it.
<!-- <!--
+2 -2
View File
@@ -183,11 +183,11 @@ The format of this log should be self explanatory, please follow it carefully.
## Supported Node.js and Factorio Versions ## Supported Node.js and Factorio Versions
Clusterio run on Node.js v12 and up, make sure to check that the Node builtin API's and npm packages you use are supported on these versions. Clusterio run on Node.js v12 and up, make sure to check that the Node builtin API's and npm packages you use are supported on these versions.
The Travis CI tests are runned on whatever version of Node.js v12 is the default. The GitHub Actions tests are run on whatever version of Node.js v12, v14, and v16 is the default.
For Factorio Clusterio 2.0 aims to support version 0.17.69 and up, including the latest experimental release. For Factorio Clusterio 2.0 aims to support version 0.17.69 and up, including the latest experimental release.
It's recommended that you use the lua API reference for 0.17.69, as there's no information on what version Factorio API's were introduced in. It's recommended that you use the lua API reference for 0.17.69, as there's no information on what version Factorio API's were introduced in.
The Travis CI tests are runned against latest experimental release. The GitHub Actions tests are run against the latest experimental release.
## Code Style ## Code Style
+91 -1
View File
@@ -10,13 +10,76 @@ The easiest way to do this is to run `npx clusteriomaster bootstrap create-ctl-c
## Slaves ## Slaves
To be written. ### List slaves
ctl> slave list
Lists all slaves.
### Generate token
ctl> slave generate-token [--id <slave id>]
Generate a token for a slave. `--id` is the slave id.
### Create config
ctl> slave create-config [--id <slave id>] [--name <slave name>] [--generate-token <bool>] [--output <path to output>]
Create a slave config. `--id` id the slave id. `--name` is the slave name. `--generate-token` decides whether to also generate a token, defaulting to `0`. `--output` is the filename for the output of the config; Default is "config-slave.json", "-" for stdout.
## Instances ## Instances
### List Instances
ctl> instance list
List instances.
### Create instance
ctl> instance create <name> [--id <instance id>]
Create a new instance. `name` is the instance name. `--id` is the optional id.
### Kill instance
ctl> instance kill <name>
Terminates the running Factorio server without giving it a chance to save or cleanup after itself.
Note: This may cause loss of data.
### Config management
#### List Configuration
ctl> instance config list <instance>
List config values for an instance. `instance` is the instance whose config values to list.
#### Set config value
ctl> instance config set <instance> <field> [value] [--stdin]
Set field in instance config. `instance` is instance to set. `field` is field to set. `value` is value to set in field. `--stdin` signals to read value from stdin.
#### Set config property of field
To be written. To be written.
#### Edit instance config
ctl> instance config edit <instance> [editor]
Edit instance config in a text editor. Once file is saved and editor has been exited, config values will be read back in. `instance` is the instance to edit, `editor` is the editor to use. If `editor` is not given, clusterioctl will read from the `EDITOR` or `VISUAL` enviroment variables.
### Assign instance to slave
ctl> instace assign <instance> [slave]
Assigns instance to slave. `instance` is instance to assign, `slave` is slave to assign to. If `slave` is not provided, instance will be unassigned.
## Users ## Users
@@ -74,6 +137,33 @@ Since ban status is a part of the account data the account must exist for this t
Note: This bans the user from logging in to Factorio servers in the cluster, it does not revoke access to any cluster management they might have, see next section on setting roles for revoking tha. Note: This bans the user from logging in to Factorio servers in the cluster, it does not revoke access to any cluster management they might have, see next section on setting roles for revoking tha.
### Bulk importing admin, whitelist and ban lists
Whitelists and admin lists can be bulk imported with the following commands:
ctl> user whitelist-bulk-import <file> [--create]
ctl> user admin-bulk-import <file> [--create]
The file should simply be newline seperated names:
joe
bob
allan
The `--create` option will create the user if they do not exist, and then set the relevent value.
Banlists can be bulk imported with the following command:
ctl> user banned-bulk-import <file> [--create]
The file should be names, followed by a ban reason:
joe greifed copper mines
bob stole materials
allan rude language
The first string on the line is used as the username, the others are used as the ban reason.
The `--create` option will create the user if they do not exist, then ban them.
### Set Cluster Roles ### Set Cluster Roles
+1 -1
View File
@@ -4,5 +4,5 @@
"plugins/*", "plugins/*",
"test" "test"
], ],
"version": "2.0.0-alpha.11" "version": "2.0.0-alpha.12"
} }
-2
View File
@@ -2,7 +2,6 @@
"use strict"; "use strict";
const child_process = require("child_process"); const child_process = require("child_process");
const events = require("events");
const fs = require("fs-extra"); const fs = require("fs-extra");
const inquirer = require("inquirer"); const inquirer = require("inquirer");
const os = require("os"); const os = require("os");
@@ -94,7 +93,6 @@ async function safeOutputFile(file, data, options={}) {
async function execFile(cmd, args) { async function execFile(cmd, args) {
logger.verbose(`executing ${cmd} ${args.join(" ")}`); logger.verbose(`executing ${cmd} ${args.join(" ")}`);
const asyncExec = util.promisify(child_process.execFile);
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
let child = child_process.execFile(cmd, args, (err, stdout, stderr) => { let child = child_process.execFile(cmd, args, (err, stdout, stderr) => {
if (err) { if (err) {
+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.11", "version": "2.0.0-alpha.12",
"main": "create.js", "main": "create.js",
"bin": { "bin": {
"clusteriocreate": "./create.js" "clusteriocreate": "./create.js"
+95 -18
View File
@@ -327,7 +327,7 @@ instanceCommands.add(new libCommand.Command({
} }
instanceConfig.set("instance.name", args.name); instanceConfig.set("instance.name", args.name);
let serialized_config = instanceConfig.serialize("master"); let serialized_config = instanceConfig.serialize("master");
let response = await libLink.messages.createInstance.send(control, { serialized_config }); await libLink.messages.createInstance.send(control, { serialized_config });
}, },
})); }));
@@ -533,8 +533,11 @@ async function loadMapSettings(args) {
}; };
} }
instanceCommands.add(new libCommand.Command({ const instanceSaveCommands = new libCommand.CommandTree({
definition: ["list-saves <instance>", "list saves on an instance", (yargs) => { name: "save", alias: ["s"], description: "Instance save management",
});
instanceSaveCommands.add(new libCommand.Command({
definition: ["list <instance>", "list saves on an instance", (yargs) => {
yargs.positional("instance", { describe: "Instance to list saves on", type: "string" }); yargs.positional("instance", { describe: "Instance to list saves on", type: "string" });
}], }],
handler: async function(args, control) { handler: async function(args, control) {
@@ -548,8 +551,8 @@ instanceCommands.add(new libCommand.Command({
}, },
})); }));
instanceCommands.add(new libCommand.Command({ instanceSaveCommands.add(new libCommand.Command({
definition: ["create-save <instance> [name]", "Create a new save on an instance", (yargs) => { definition: ["create <instance> [name]", "Create a new save on an instance", (yargs) => {
yargs.positional("instance", { describe: "Instance to create on", type: "string" }); yargs.positional("instance", { describe: "Instance to create on", type: "string" });
yargs.positional("name", { describe: "Name of save to create.", type: "string", default: "world.zip" }); yargs.positional("name", { describe: "Name of save to create.", type: "string", default: "world.zip" });
yargs.options({ yargs.options({
@@ -563,7 +566,7 @@ instanceCommands.add(new libCommand.Command({
let instanceId = await libCommand.resolveInstance(control, args.instance); let instanceId = await libCommand.resolveInstance(control, args.instance);
let { seed, mapGenSettings, mapSettings } = await loadMapSettings(args); let { seed, mapGenSettings, mapSettings } = await loadMapSettings(args);
await control.setLogSubscriptions({ instance_ids: [instanceId] }); await control.setLogSubscriptions({ instance_ids: [instanceId] });
let response = await libLink.messages.createSave.send(control, { await libLink.messages.createSave.send(control, {
instance_id: instanceId, instance_id: instanceId,
name: args.name, name: args.name,
seed, seed,
@@ -573,8 +576,40 @@ instanceCommands.add(new libCommand.Command({
}, },
})); }));
instanceCommands.add(new libCommand.Command({ instanceSaveCommands.add(new libCommand.Command({
definition: ["upload-save <instance> <filepath>", "Upload a save to an instance", (yargs) => { definition: ["rename <instance> <old-name> <new-name>", "Rename a save on an instance", (yargs) => {
yargs.positional("instance", { describe: "Instance to rename save on", type: "string" });
yargs.positional("old-name", { describe: "Old name of save.", type: "string" });
yargs.positional("new-name", { describe: "New name of save.", type: "string" });
}],
handler: async function(args, control) {
let instanceId = await libCommand.resolveInstance(control, args.instance);
await libLink.messages.renameSave.send(control, {
instance_id: instanceId,
old_name: args.oldName,
new_name: args.newName,
});
},
}));
instanceSaveCommands.add(new libCommand.Command({
definition: ["copy <instance> <source> <destination>", "Copy a save on an instance", (yargs) => {
yargs.positional("instance", { describe: "Instance to copy save on", type: "string" });
yargs.positional("source", { describe: "Save to copy.", type: "string" });
yargs.positional("destination", { describe: "Name of copy.", type: "string" });
}],
handler: async function(args, control) {
let instanceId = await libCommand.resolveInstance(control, args.instance);
await libLink.messages.copySave.send(control, {
instance_id: instanceId,
source: args.source,
destination: args.destination,
});
},
}));
instanceSaveCommands.add(new libCommand.Command({
definition: ["upload <instance> <filepath>", "Upload a save to an instance", (yargs) => {
yargs.positional("instance", { describe: "Instance to upload to", type: "string" }); yargs.positional("instance", { describe: "Instance to upload to", type: "string" });
yargs.positional("filepath", { describe: "Path to save to upload", type: "string" }); yargs.positional("filepath", { describe: "Path to save to upload", type: "string" });
yargs.options({ yargs.options({
@@ -611,7 +646,7 @@ instanceCommands.add(new libCommand.Command({
} }
for (let requestError of result.body.request_errors || []) { for (let requestError of result.body.request_errors || []) {
logger.error(error); logger.error(requestError);
} }
if (result.body.saves && result.body.saves.length) { if (result.body.saves && result.body.saves.length) {
@@ -624,8 +659,36 @@ instanceCommands.add(new libCommand.Command({
}, },
})); }));
instanceCommands.add(new libCommand.Command({ instanceSaveCommands.add(new libCommand.Command({
definition: ["download-save <instance> <save>", "Download a save from an instance", (yargs) => { definition: [
"transfer <source-instance> <source-save> <target-instance> [target-save]",
"Transfer a save between instances",
(yargs) => {
yargs.positional("source-instance", { describe: "Instance to transfer save from", type: "string" });
yargs.positional("source-save", { describe: "Save to transfer.", type: "string" });
yargs.positional("target-instance", { describe: "Instance to transfer to", type: "string" });
yargs.positional("target-save", { describe: "Name to give transferred save.", type: "string" });
yargs.options({
"copy": { describe: "Copy instead of moving the save", type: "boolean", default: false },
});
},
],
handler: async function(args, control) {
let sourceInstanceId = await libCommand.resolveInstance(control, args.sourceInstance);
let targetInstanceId = await libCommand.resolveInstance(control, args.targetInstance);
let result = await libLink.messages.transferSave.send(control, {
instance_id: sourceInstanceId,
source_save: args.sourceSave,
target_instance_id: targetInstanceId,
target_save: args.targetSave || args.sourceSave,
copy: args.copy,
});
print(`Transferred as ${result.save} to ${args.targetInstance}.`);
},
}));
instanceSaveCommands.add(new libCommand.Command({
definition: ["download <instance> <save>", "Download a save from an instance", (yargs) => {
yargs.positional("instance", { describe: "Instance to download save from", type: "string" }); yargs.positional("instance", { describe: "Instance to download save from", type: "string" });
yargs.positional("save", { describe: "Save to download", type: "string" }); yargs.positional("save", { describe: "Save to download", type: "string" });
}], }],
@@ -669,8 +732,8 @@ instanceCommands.add(new libCommand.Command({
}, },
})); }));
instanceCommands.add(new libCommand.Command({ instanceSaveCommands.add(new libCommand.Command({
definition: ["delete-save <instance> <save>", "Delete a save from an instance", (yargs) => { definition: ["delete <instance> <save>", "Delete a save from an instance", (yargs) => {
yargs.positional("instance", { describe: "Instance to delete save from", type: "string" }); yargs.positional("instance", { describe: "Instance to delete save from", type: "string" });
yargs.positional("save", { describe: "Save to delete", type: "string" }); yargs.positional("save", { describe: "Save to delete", type: "string" });
}], }],
@@ -682,6 +745,7 @@ instanceCommands.add(new libCommand.Command({
}); });
}, },
})); }));
instanceCommands.add(instanceSaveCommands);
instanceCommands.add(new libCommand.Command({ instanceCommands.add(new libCommand.Command({
definition: ["export-data <instance>", "Export item icons and locale from instance", (yargs) => { definition: ["export-data <instance>", "Export item icons and locale from instance", (yargs) => {
@@ -690,7 +754,7 @@ instanceCommands.add(new libCommand.Command({
handler: async function(args, control) { handler: async function(args, control) {
let instanceId = await libCommand.resolveInstance(control, args.instance); let instanceId = await libCommand.resolveInstance(control, args.instance);
await control.setLogSubscriptions({ instance_ids: [instanceId] }); await control.setLogSubscriptions({ instance_ids: [instanceId] });
let response = await libLink.messages.exportData.send(control, { await libLink.messages.exportData.send(control, {
instance_id: instanceId, instance_id: instanceId,
}); });
}, },
@@ -707,7 +771,7 @@ instanceCommands.add(new libCommand.Command({
handler: async function(args, control) { handler: async function(args, control) {
let instanceId = await libCommand.resolveInstance(control, args.instance); let instanceId = await libCommand.resolveInstance(control, args.instance);
await control.setLogSubscriptions({ instance_ids: [instanceId] }); await control.setLogSubscriptions({ instance_ids: [instanceId] });
let response = await libLink.messages.startInstance.send(control, { await libLink.messages.startInstance.send(control, {
instance_id: instanceId, instance_id: instanceId,
save: args.save || null, save: args.save || null,
}); });
@@ -731,7 +795,7 @@ instanceCommands.add(new libCommand.Command({
let instanceId = await libCommand.resolveInstance(control, args.instance); let instanceId = await libCommand.resolveInstance(control, args.instance);
await control.setLogSubscriptions({ instance_ids: [instanceId] }); await control.setLogSubscriptions({ instance_ids: [instanceId] });
let { seed, mapGenSettings, mapSettings } = await loadMapSettings(args); let { seed, mapGenSettings, mapSettings } = await loadMapSettings(args);
let response = await libLink.messages.loadScenario.send(control, { await libLink.messages.loadScenario.send(control, {
instance_id: instanceId, instance_id: instanceId,
scenario: args.scenario, scenario: args.scenario,
seed, seed,
@@ -749,7 +813,20 @@ instanceCommands.add(new libCommand.Command({
handler: async function(args, control) { handler: async function(args, control) {
let instanceId = await libCommand.resolveInstance(control, args.instance); let instanceId = await libCommand.resolveInstance(control, args.instance);
await control.setLogSubscriptions({ instance_ids: [instanceId] }); await control.setLogSubscriptions({ instance_ids: [instanceId] });
let response = await libLink.messages.stopInstance.send(control, { await libLink.messages.stopInstance.send(control, {
instance_id: instanceId,
});
},
}));
instanceCommands.add(new libCommand.Command({
definition: ["kill <instance>", "Kill instance", (yargs) => {
yargs.positional("instance", { describe: "Instance to kill", type: "string" });
}],
handler: async function(args, control) {
let instanceId = await libCommand.resolveInstance(control, args.instance);
await control.setLogSubscriptions({ instance_ids: [instanceId] });
await libLink.messages.killInstance.send(control, {
instance_id: instanceId, instance_id: instanceId,
}); });
}, },
@@ -760,7 +837,7 @@ instanceCommands.add(new libCommand.Command({
yargs.positional("instance", { describe: "Instance to delete", type: "string" }); yargs.positional("instance", { describe: "Instance to delete", type: "string" });
}], }],
handler: async function(args, control) { handler: async function(args, control) {
let response = await libLink.messages.deleteInstance.send(control, { await libLink.messages.deleteInstance.send(control, {
instance_id: await libCommand.resolveInstance(control, args.instance), instance_id: await libCommand.resolveInstance(control, args.instance),
}); });
}, },
+2 -2
View File
@@ -3,7 +3,7 @@
"description": "Clusterio command line management tool", "description": "Clusterio command line management tool",
"author": "Hornwitser", "author": "Hornwitser",
"license": "MIT", "license": "MIT",
"version": "2.0.0-alpha.11", "version": "2.0.0-alpha.12",
"main": "ctl.js", "main": "ctl.js",
"scripts": { "scripts": {
"test": "echo \"Error: no test specified\" && exit 1" "test": "echo \"Error: no test specified\" && exit 1"
@@ -18,7 +18,7 @@
"node": ">=12" "node": ">=12"
}, },
"dependencies": { "dependencies": {
"@clusterio/lib": "^2.0.0-alpha.11", "@clusterio/lib": "^2.0.0-alpha.12",
"as-table": "^1.0.31", "as-table": "^1.0.31",
"fs-extra": "^8.1.0", "fs-extra": "^8.1.0",
"phin": "^3.5.1", "phin": "^3.5.1",
+2 -2
View File
@@ -83,7 +83,7 @@ async function build(args) {
for (let entry of await fs.readdir(args.outputDir)) { for (let entry of await fs.readdir(args.outputDir)) {
let match = splitter.exec(entry); let match = splitter.exec(entry);
if (match) { if (match) {
let [, name, version] = match; let name = match[1];
if (name === info.name) { if (name === info.name) {
let modPath = path.join(args.outputDir, entry); let modPath = path.join(args.outputDir, entry);
console.log(`Removing ${modPath}`); console.log(`Removing ${modPath}`);
@@ -94,7 +94,7 @@ async function build(args) {
} }
if (info.variants) { if (info.variants) {
for (let [variant, variantOverrides] of Object.entries(info.variants)) { for (let variantOverrides of info.variants) {
let variantInfo = { let variantInfo = {
...info, ...info,
...variantOverrides, ...variantOverrides,
+2 -2
View File
@@ -376,9 +376,9 @@ ControlConfig.registerGroup(ControlGroup);
function validateGroup(pluginInfo, groupName) { function validateGroup(pluginInfo, groupName) {
if (!pluginInfo[groupName] instanceof classes.PluginConfigGroup) { if (!(pluginInfo[groupName].prototype instanceof classes.PluginConfigGroup)) {
throw new Error( throw new Error(
`Expected ${groupName} for ${pluginInfo.name} to be an instance of PluginConfigGroup` `Expected ${groupName} for ${pluginInfo.name} to be a subclass of PluginConfigGroup`
); );
} }
+30 -17
View File
@@ -409,6 +409,7 @@ const outputHeuristics = [
* - game-ready - invoked when the server is finished starting up * - game-ready - invoked when the server is finished starting up
* - autosave-start - invoked when the server starts an autosave * - autosave-start - invoked when the server starts an autosave
* - autosave-fnished - invoked when the autosave finished * - autosave-fnished - invoked when the autosave finished
* - save-finished - invoked when the server has finished a manual save
* - exit - invoked when the sterver has exited * - exit - invoked when the sterver has exited
* @extends events.EventEmitter * @extends events.EventEmitter
* @memberof module:lib/factorio * @memberof module:lib/factorio
@@ -487,6 +488,7 @@ class FactorioServer extends events.EventEmitter {
// Array of possible causes for an unexpected shutdown // Array of possible causes for an unexpected shutdown
this._unexpected = []; this._unexpected = [];
this._killed = false;
// Track autosaving // Track autosaving
this._runningAutosave = null; this._runningAutosave = null;
@@ -499,6 +501,8 @@ class FactorioServer extends events.EventEmitter {
if (this._runningAutosave) { if (this._runningAutosave) {
this.emit("autosave-finished", this._runningAutosave); this.emit("autosave-finished", this._runningAutosave);
this._runningAutosave = null; this._runningAutosave = null;
} else {
this.emit("save-finished");
} }
}); });
} }
@@ -694,28 +698,30 @@ class FactorioServer extends events.EventEmitter {
_watchExit() { _watchExit() {
this._server.on("exit", (code, signal) => { this._server.on("exit", (code, signal) => {
if (this._state !== "stopping") { if (this._state !== "stopping") {
if (this._unexpected.length === 0) { if (signal === "SIGKILL") {
if (signal === "SIGKILL") { if (this._killed) {
this.emit("error", new libErrors.EnvironmentError("Factorio server was killed"));
} else {
this.emit("error", new libErrors.EnvironmentError( this.emit("error", new libErrors.EnvironmentError(
"Factorio server was unexpectedly killed, is the system low on memory?" "Factorio server was unexpectedly killed, is the system low on memory?"
)); ));
} else {
let msg;
if (code !== null) {
msg = `Factorio server unexpectedly shut down with code ${code}`;
} else {
msg = `Factorio server was unexpectedly shut by down by signal ${signal}`;
}
this.emit("error", new Error(msg));
} }
} else if (this._unexpected.length === 0) {
let msg;
if (code !== null) {
msg = `Factorio server unexpectedly shut down with code ${code}`;
} else {
msg = `Factorio server was unexpectedly shut by down by signal ${signal}`;
}
this.emit("error", new libErrors.EnvironmentError(msg));
} else if (this._unexpected.length === 1) { } else if (this._unexpected.length === 1) {
this.emit("error", new Error(this._unexpected[0])); this.emit("error", new libErrors.EnvironmentError(this._unexpected[0]));
} else { } else {
this.emit("error", new Error( this.emit("error", new libErrors.EnvironmentError(
"Factorio server unexpectedly shut down. Possible causes:"+ "Factorio server unexpectedly shut down. Possible causes:"+
`\n- ${this._unexpected.join("\n- ")}` `\n- ${this._unexpected.join("\n- ")}`
)); ));
@@ -791,6 +797,7 @@ class FactorioServer extends events.EventEmitter {
try { try {
let [code, signal] = await events.once(this._server, "exit"); let [code, signal] = await events.once(this._server, "exit");
void signal;
if (code !== 0) { if (code !== 0) {
throw new Error(`Factorio exited with status ${code}`); throw new Error(`Factorio exited with status ${code}`);
} }
@@ -1003,12 +1010,18 @@ class FactorioServer extends events.EventEmitter {
* Kill the server * Kill the server
* *
* Terminates the server without any cleanup or saving. * Terminates the server without any cleanup or saving.
* @param {boolean} [unexpected=false] -
* If true raise an error event as a result of killing the Factorio
* process.
*/ */
async kill() { async kill(unexpected = false) {
this._check(["running", "stopping"]); this._check(["running", "stopping"]);
this._state = "stopping"; this._killed = true;
if (!unexpected) {
this._state = "stopping";
}
this._server.kill("SIGKILL"); this._server.kill("SIGKILL");
await events.once(this._server, "exit"); await new Promise(resolve => this._server.once("exit", resolve));
} }
/** /**
+1 -1
View File
@@ -445,7 +445,7 @@ class WebSocketClientConnector extends WebSocketBaseConnector {
return; return;
} }
let { seq, type, data } = message; let { type, data } = message;
if (type === "hello") { if (type === "hello") {
logger.verbose(`Connector | received hello from master version ${data.version}`); logger.verbose(`Connector | received hello from master version ${data.version}`);
this.emit("hello", data); this.emit("hello", data);
+1 -2
View File
@@ -4,7 +4,6 @@
const libSchema = require("../schema"); const libSchema = require("../schema");
const libErrors = require("../errors"); const libErrors = require("../errors");
const { logger } = require("../logging"); const { logger } = require("../logging");
const messages = require("./messages");
// Some definitions for the terminology used here: // Some definitions for the terminology used here:
// link: Either side of a master - client connection // link: Either side of a master - client connection
@@ -135,7 +134,7 @@ class Link {
* @returns {Boolean} true if a waiter was triggered. * @returns {Boolean} true if a waiter was triggered.
*/ */
_processWaiters(message) { _processWaiters(message) {
let { seq, type, data } = message; let { type, data } = message;
let waiters = this._waiters.get(type); let waiters = this._waiters.get(type);
if (!waiters || !waiters.length) { if (!waiters || !waiters.length) {
return false; return false;
+45
View File
@@ -550,6 +550,28 @@ messages.createSave = new Request({
}, },
}); });
messages.renameSave = new Request({
type: "rename_save",
links: ["control-master", "master-slave"],
permission: "core.instance.save.rename",
forwardTo: "instance",
requestProperties: {
"old_name": { type: "string" },
"new_name": { type: "string" },
},
});
messages.copySave = new Request({
type: "copy_save",
links: ["control-master", "master-slave"],
permission: "core.instance.save.copy",
forwardTo: "instance",
requestProperties: {
"source": { type: "string" },
"destination": { type: "string" },
},
});
messages.deleteSave = new Request({ messages.deleteSave = new Request({
type: "delete_save", type: "delete_save",
links: ["control-master", "master-slave"], links: ["control-master", "master-slave"],
@@ -573,6 +595,22 @@ messages.downloadSave = new Request({
}, },
}); });
messages.transferSave = new Request({
type: "transfer_save",
links: ["control-master", "master-slave"],
permission: "core.instance.save.transfer",
requestProperties: {
"instance_id": { type: "integer" },
"source_save": { type: "string" },
"target_instance_id": { type: "integer" },
"target_save": { type: "string" },
"copy": { type: "boolean" },
},
responseProperties: {
"save": { type: "string" },
},
});
messages.pullSave = new Request({ messages.pullSave = new Request({
type: "pull_save", type: "pull_save",
links: ["master-slave"], links: ["master-slave"],
@@ -636,6 +674,13 @@ messages.stopInstance = new Request({
forwardTo: "instance", forwardTo: "instance",
}); });
messages.killInstance = new Request({
type: "kill_instance",
links: ["control-master", "master-slave", "slave-instance"],
permission: "core.instance.kill",
forwardTo: "instance",
});
messages.deleteInstance = new Request({ messages.deleteInstance = new Request({
type: "delete_instance", type: "delete_instance",
links: ["control-master", "master-slave"], links: ["control-master", "master-slave"],
+1 -1
View File
@@ -1,7 +1,7 @@
{ {
"name": "@clusterio/lib", "name": "@clusterio/lib",
"description": "Shared library for Clusterio", "description": "Shared library for Clusterio",
"version": "2.0.0-alpha.11", "version": "2.0.0-alpha.12",
"repository": "https://github.com/clusterio/clusterio", "repository": "https://github.com/clusterio/clusterio",
"license": "MIT", "license": "MIT",
"browser": "browser.js", "browser": "browser.js",
+55 -3
View File
@@ -78,7 +78,7 @@ class BaseInstancePlugin {
* changed. * changed.
* *
* @param {module:lib/config.ConfigGroup} group - * @param {module:lib/config.ConfigGroup} group -
* The group who's field got changed on. * The group who's field got changed.
* @param {string} field - Name of the field that changed. * @param {string} field - Name of the field that changed.
* @param {*} prev - The previous value of the field. * @param {*} prev - The previous value of the field.
*/ */
@@ -355,6 +355,19 @@ class BaseMasterPlugin {
*/ */
async onInstanceStatusChanged(instance, prev) { } async onInstanceStatusChanged(instance, prev) { }
/**
* Called when the value of a master config field changed.
*
* Invoked after the value of the config field given by `field` has
* changed on the master.
*
* @param {module:lib/config.ConfigGroup} group -
* The group who's field got changed.
* @param {string} field - Name of the field that changed.
* @param {*} prev - The previous value of the field.
*/
async onMasterConfigFieldChanged(group, field, prev) { }
/** /**
* Called when the value of an instance config field changed. * Called when the value of an instance config field changed.
* *
@@ -363,7 +376,7 @@ class BaseMasterPlugin {
* *
* @param {Object} instance - The instance the config changed on. * @param {Object} instance - The instance the config changed on.
* @param {module:lib/config.ConfigGroup} group - * @param {module:lib/config.ConfigGroup} group -
* The group who's field got changed on. * The group who's field got changed.
* @param {string} field - Name of the field that changed. * @param {string} field - Name of the field that changed.
* @param {*} prev - The previous value of the field. * @param {*} prev - The previous value of the field.
*/ */
@@ -575,11 +588,14 @@ class BaseControlPlugin {
/** /**
* Plugin supplied pages * Plugin supplied pages
* @typedef {Object} module:Lib/plugin~Page * @typedef {Object} module:lib/plugin~Page
* @property {string} path - URL path to this page. * @property {string} path - URL path to this page.
* @property {string=} sidebarPath - * @property {string=} sidebarPath -
* If present and this path matches one of the pages in the sidebar it * If present and this path matches one of the pages in the sidebar it
* will cause that sidebar entry to be highlighted as active. * will cause that sidebar entry to be highlighted as active.
* @property {string=} sidebarGroup -
* If present group this entry under a group of the given name in the
* sidebar.
* @property {string=} sidebarName - * @property {string=} sidebarName -
* If present creates an entry in the sidebar for this page with the * If present creates an entry in the sidebar for this page with the
* given text. * given text.
@@ -640,6 +656,42 @@ class BaseWebPlugin {
* @type {Array<module:lib/plugin~Page>} * @type {Array<module:lib/plugin~Page>}
*/ */
this.pages = []; this.pages = [];
/**
* Extra react component to add to core components
*
* Interface to augment core components of the web UI. Setting a
* component as one of the supported properties of this object will
* cause the web UI to render it when displaying that component,
* usually at the end. Each component will receive a `plugin` param
* which is the instance of the web plugin that contained the
* component extra.
*
* @type {object}
* @property {React.ComponentType} MasterPage -
* Placed at the end of the master page.
* @property {React.ComponentType} SlavesPage -
* Placed at the end of the slaves list page.
* @property {React.ComponentType} SlaveViewPage -
* Placed at the end of each slave page. Takes a `slave` param
* which is the slave the page is displayed for.
* @property {React.ComponentType} InstancesPage -
* Placed at the end of the instance list page.
* @property {React.ComponentType} InstanceViewPage -
* Placed at the end of each instance page. Takes an `instance`
* param which is the instance the page is displayed for.
* @property {React.ComponentType} UsersPage -
* Placed at the end of the users list page.
* @property {React.ComponentType} UserViewPage -
* Placed at the end of each user page. Takes a `user` param
* which is the user object the page is displayed for.
* @property {React.ComponentType} RolesPage -
* Placed at the end of the roles list page.
* @property {React.ComponentType} RoleViewPage -
* Placed at the end of each role page. Takes a `role` param
* which is the role object the page is displayed for.
*/
this.componentExtra = {};
} }
/** /**
-1
View File
@@ -3,7 +3,6 @@
* @module lib/shared_commands * @module lib/shared_commands
*/ */
"use strict"; "use strict";
const fs = require("fs-extra");
const path = require("path"); const path = require("path");
const libConfig = require("./config"); const libConfig = require("./config");
+25 -5
View File
@@ -379,7 +379,7 @@ definePermission({
}); });
definePermission({ definePermission({
name: "core.instance.save.list", name: "core.instance.save.list",
title: "List saves on instance", title: "List saves",
description: "List the saves currently on the instance.", description: "List the saves currently on the instance.",
}); });
definePermission({ definePermission({
@@ -389,22 +389,37 @@ definePermission({
}); });
definePermission({ definePermission({
name: "core.instance.save.create", name: "core.instance.save.create",
title: "Create new instance save", title: "Create new save",
description: "Create new savegames on instances.", description: "Create new savegames on instances.",
}); });
definePermission({
name: "core.instance.save.rename",
title: "Rename save",
description: "Rename savegames on instances.",
});
definePermission({
name: "core.instance.save.copy",
title: "Copy save",
description: "Create copies of savegames on instances.",
});
definePermission({ definePermission({
name: "core.instance.save.delete", name: "core.instance.save.delete",
title: "Delete instance save", title: "Delete save",
description: "Delete savegames on instances.", description: "Delete savegames on instances.",
}); });
definePermission({ definePermission({
name: "core.instance.save.upload", name: "core.instance.save.upload",
title: "Upload save to instance", title: "Upload save",
description: "Upload savegames to instances.", description: "Upload savegames to instances.",
}); });
definePermission({
name: "core.instance.save.transfer",
title: "Transfer save",
description: "Transfer savegames between instances.",
});
definePermission({ definePermission({
name: "core.instance.save.download", name: "core.instance.save.download",
title: "Download save from instance", title: "Download save",
description: "Download savegames from instances.", description: "Download savegames from instances.",
}); });
definePermission({ definePermission({
@@ -427,6 +442,11 @@ definePermission({
title: "Stop instance", title: "Stop instance",
description: "Stop instances.", description: "Stop instances.",
}); });
definePermission({
name: "core.instance.kill",
title: "Kill instance",
description: "Terminate running instances without saving or cleanup.",
});
definePermission({ definePermission({
name: "core.instance.delete", name: "core.instance.delete",
title: "Delete instance", title: "Delete instance",
+12 -12
View File
@@ -43,18 +43,18 @@ const UserManager = require("./src/UserManager");
let master; let master;
const slaveMappingGauge = new libPrometheus.Gauge( void new libPrometheus.Gauge(
"clusterio_master_slave_mapping", "clusterio_master_slave_mapping",
"Mapping of Slave ID to name", "Mapping of Slave ID to name",
{ {
labels: ["slave_id", "slave_name"], labels: ["slave_id", "slave_name"],
callback: function() { callback: function(gauge) {
slaveMappingGauge.clear(); gauge.clear();
if (!master || !master.slaves) { if (!master || !master.slaves) {
return; return;
} }
for (let [id, slave] of master.slaves) { for (let [id, slave] of master.slaves) {
slaveMappingGauge.labels({ gauge.labels({
slave_id: String(id), slave_id: String(id),
slave_name: slave.name, slave_name: slave.name,
}).set(1); }).set(1);
@@ -63,18 +63,18 @@ const slaveMappingGauge = new libPrometheus.Gauge(
} }
); );
const instanceMappingGauge = new libPrometheus.Gauge( void new libPrometheus.Gauge(
"clusterio_master_instance_mapping", "clusterio_master_instance_mapping",
"Mapping of Instance ID to name and slave", "Mapping of Instance ID to name and slave",
{ {
labels: ["instance_id", "instance_name", "slave_id"], labels: ["instance_id", "instance_name", "slave_id"],
callback: function() { callback: function(gauge) {
instanceMappingGauge.clear(); gauge.clear();
if (!master || !master.instances) { if (!master || !master.instances) {
return; return;
} }
for (let [id, instance] of master.instances) { for (let [id, instance] of master.instances) {
instanceMappingGauge.labels({ gauge.labels({
instance_id: String(id), instance_id: String(id),
instance_name: String(instance.config.get("instance.name")), instance_name: String(instance.config.get("instance.name")),
slave_id: String(instance.config.get("instance.assigned_slave")), slave_id: String(instance.config.get("instance.assigned_slave")),
@@ -84,19 +84,19 @@ const instanceMappingGauge = new libPrometheus.Gauge(
} }
); );
const wsActiveConnectionsGauge = new libPrometheus.Gauge( void new libPrometheus.Gauge(
"clusterio_master_websocket_active_connections", "clusterio_master_websocket_active_connections",
"How many WebSocket connections are currently open to the master server", "How many WebSocket connections are currently open to the master server",
{ callback: function(gauge) { gauge.set(master.wsServer.activeConnectors.size); }} { callback: function(gauge) { gauge.set(master.wsServer.activeConnectors.size); }}
); );
const wsActiveSlavesGauge = new libPrometheus.Gauge( void new libPrometheus.Gauge(
"clusterio_master_active_slaves", "clusterio_master_active_slaves",
"How many slaves are currently connected to the master", "How many slaves are currently connected to the master",
{ callback: function(gauge) { gauge.set(master.wsServer.slaveConnections.size); }} { callback: function(gauge) { gauge.set(master.wsServer.slaveConnections.size); }}
); );
const masterConnectedClientsCount = new libPrometheus.Gauge( void new libPrometheus.Gauge(
"clusterio_master_connected_clients_count", "How many clients are currently connected to this master server", "clusterio_master_connected_clients_count", "How many clients are currently connected to this master server",
{ {
labels: ["type"], callback: async function(gauge) { labels: ["type"], callback: async function(gauge) {
@@ -356,7 +356,7 @@ async function startup() {
// add better stack traces on promise rejection // add better stack traces on promise rejection
process.on("unhandledRejection", err => logger.error(`Unhandled rejection:\n${err.stack}`)); process.on("unhandledRejection", err => logger.error(`Unhandled rejection:\n${err.stack}`));
let { args, shouldRun, clusterLogger, pluginInfos, masterConfigPath, masterConfig } = await initialize(master); let { args, shouldRun, clusterLogger, pluginInfos, masterConfigPath, masterConfig } = await initialize();
if (!shouldRun) { if (!shouldRun) {
return; return;
} }
+3 -3
View File
@@ -3,7 +3,7 @@
"description": "Implementation of Clusterio master server", "description": "Implementation of Clusterio master server",
"author": "Hornwitser", "author": "Hornwitser",
"license": "MIT", "license": "MIT",
"version": "2.0.0-alpha.11", "version": "2.0.0-alpha.12",
"main": "master.js", "main": "master.js",
"scripts": { "scripts": {
"build": "webpack-cli --env production", "build": "webpack-cli --env production",
@@ -19,7 +19,7 @@
"node": ">=12" "node": ">=12"
}, },
"dependencies": { "dependencies": {
"@clusterio/lib": "^2.0.0-alpha.11", "@clusterio/lib": "^2.0.0-alpha.12",
"busboy": "^0.3.1", "busboy": "^0.3.1",
"compression": "^1.7.2", "compression": "^1.7.2",
"express": "^4.16.2", "express": "^4.16.2",
@@ -33,7 +33,7 @@
"yargs": "^14.2.0" "yargs": "^14.2.0"
}, },
"devDependencies": { "devDependencies": {
"@clusterio/web_ui": "^2.0.0-alpha.11", "@clusterio/web_ui": "^2.0.0-alpha.12",
"fast-deep-equal": "^3.1.3", "fast-deep-equal": "^3.1.3",
"react": "^16.13.1", "react": "^16.13.1",
"react-dom": "^16.13.1", "react-dom": "^16.13.1",
+87 -29
View File
@@ -1,5 +1,6 @@
"use strict"; "use strict";
const jwt = require("jsonwebtoken"); const jwt = require("jsonwebtoken");
const events = require("events");
const libConfig = require("@clusterio/lib/config"); const libConfig = require("@clusterio/lib/config");
const libErrors = require("@clusterio/lib/errors"); const libErrors = require("@clusterio/lib/errors");
@@ -159,10 +160,7 @@ class ControlConnection extends BaseConnection {
async getInstanceRequestHandler(message) { async getInstanceRequestHandler(message) {
let id = message.data.id; let id = message.data.id;
let instance = this._master.instances.get(id); let instance = this._master.getRequestInstance(id);
if (!instance) {
throw new libErrors.RequestError(`Instance with ID ${id} does not exist`);
}
return { return {
id, id,
@@ -249,11 +247,7 @@ class ControlConnection extends BaseConnection {
} }
async deleteInstanceRequestHandler(message, request) { async deleteInstanceRequestHandler(message, request) {
let instance = this._master.instances.get(message.data.instance_id); let instance = this._master.getRequestInstance(message.data.instance_id);
if (!instance) {
throw new libErrors.RequestError(`Instance with ID ${message.data.instance_id} does not exist`);
}
if (instance.config.get("instance.assigned_slave") !== null) { if (instance.config.get("instance.assigned_slave") !== null) {
await this.forwardRequestToInstance(message, request); await this.forwardRequestToInstance(message, request);
} }
@@ -266,11 +260,7 @@ class ControlConnection extends BaseConnection {
} }
async getInstanceConfigRequestHandler(message) { async getInstanceConfigRequestHandler(message) {
let instance = this._master.instances.get(message.data.instance_id); let instance = this._master.getRequestInstance(message.data.instance_id);
if (!instance) {
throw new libErrors.RequestError(`Instance with ID ${message.data.instance_id} does not exist`);
}
return { return {
serialized_config: instance.config.serialize("control"), serialized_config: instance.config.serialize("control"),
}; };
@@ -290,11 +280,7 @@ class ControlConnection extends BaseConnection {
} }
async setInstanceConfigFieldRequestHandler(message) { async setInstanceConfigFieldRequestHandler(message) {
let instance = this._master.instances.get(message.data.instance_id); let instance = this._master.getRequestInstance(message.data.instance_id);
if (!instance) {
throw new libErrors.RequestError(`Instance with ID ${message.data.instance_id} does not exist`);
}
if (message.data.field === "instance.assigned_slave") { if (message.data.field === "instance.assigned_slave") {
throw new libErrors.RequestError("instance.assigned_slave must be set through the assign-slave interface"); throw new libErrors.RequestError("instance.assigned_slave must be set through the assign-slave interface");
} }
@@ -309,11 +295,7 @@ class ControlConnection extends BaseConnection {
} }
async setInstanceConfigPropRequestHandler(message) { async setInstanceConfigPropRequestHandler(message) {
let instance = this._master.instances.get(message.data.instance_id); let instance = this._master.getRequestInstance(message.data.instance_id);
if (!instance) {
throw new libErrors.RequestError(`Instance with ID ${message.data.instance_id} does not exist`);
}
let { field, prop, value } = message.data; let { field, prop, value } = message.data;
instance.config.setProp(field, prop, value, "control"); instance.config.setProp(field, prop, value, "control");
await this.updateInstanceConfig(instance); await this.updateInstanceConfig(instance);
@@ -321,10 +303,7 @@ class ControlConnection extends BaseConnection {
async assignInstanceCommandRequestHandler(message, request) { async assignInstanceCommandRequestHandler(message, request) {
let { slave_id, instance_id } = message.data; let { slave_id, instance_id } = message.data;
let instance = this._master.instances.get(instance_id); let instance = this._master.getRequestInstance(instance_id);
if (!instance) {
throw new libErrors.RequestError(`Instance with ID ${instance_id} does not exist`);
}
// Check if target slave is connected // Check if target slave is connected
let newSlaveConnection; let newSlaveConnection;
@@ -385,7 +364,7 @@ class ControlConnection extends BaseConnection {
}); });
ready.catch(() => {}); ready.catch(() => {});
let result = await this._master.forwardRequestToInstance(libLink.messages.pushSave, { await this._master.forwardRequestToInstance(libLink.messages.pushSave, {
instance_id, instance_id,
stream_id: stream.id, stream_id: stream.id,
save, save,
@@ -395,6 +374,85 @@ class ControlConnection extends BaseConnection {
return { stream_id: stream.id }; return { stream_id: stream.id };
} }
async transferSaveRequestHandler(message, request) {
let { source_save, target_save, copy, instance_id, target_instance_id } = message.data;
if (copy) {
this.user.checkPermission("core.instance.save.copy");
} else if (source_save !== target_save) {
this.user.checkPermission("core.instance.save.rename");
}
if (instance_id === target_instance_id) {
throw new libErrors.RequestError("Source and target instance may not be the same");
}
let sourceInstance = this._master.getRequestInstance(instance_id);
let targetInstance = this._master.getRequestInstance(target_instance_id);
let sourceSlaveId = sourceInstance.config.get("instance.assigned_slave");
let targetSlaveId = targetInstance.config.get("instance.assigned_slave");
if (sourceSlaveId === null) {
throw new libErrors.RequestError("Source instance is not assigned a slave");
}
if (targetSlaveId === null) {
throw new libErrors.RequestError("Target instance is not assigned a slave");
}
// Let slave handle request if source and target is on the same slave.
if (sourceSlaveId === targetSlaveId) {
return await this.forwardRequestToInstance(message, request);
}
// Check connectivity
let sourceSlaveConnection = this._master.wsServer.slaveConnections.get(sourceSlaveId);
if (!sourceSlaveConnection || sourceSlaveConnection.closing) {
throw new libErrors.RequestError("Source slave is not connected to the master server");
}
let targetSlaveConnection = this._master.wsServer.slaveConnections.get(targetSlaveId);
if (!targetSlaveConnection || targetSlaveConnection.closing) {
throw new libErrors.RequestError("Target slave is not connected to the master server");
}
// Create stream to proxy from target to source
let stream = await routes.createProxyStream(this._master.app);
stream.events.on("timeout", () => {
if (stream.source) {
stream.source.destroy();
}
stream.events.emit("error", new libErrors.RequestError("Timed out establishing transfer stream"));
});
// Ignore errors if not listening for them to avoid crash.
stream.events.on("error", () => { /* ignore */ });
// Establish push from source slave to stream, this is done first to
// ensure the file size is known prior to the target slave pull.
await Promise.all([
this._master.forwardRequestToInstance(libLink.messages.pushSave, {
instance_id,
stream_id: stream.id,
save: source_save,
}),
events.once(stream.events, "source"),
]);
// Establish pull from target slave to stream and wait for completion.
let result = await this._master.forwardRequestToInstance(libLink.messages.pullSave, {
instance_id: target_instance_id,
stream_id: stream.id,
filename: target_save,
});
// Delete source save if this is not a copy
if (!copy) {
await this._master.forwardRequestToInstance(libLink.messages.deleteSave, {
instance_id,
save: source_save,
});
}
return { save: result.save };
}
async setLogSubscriptionsRequestHandler(message) { async setLogSubscriptionsRequestHandler(message) {
this.logSubscriptions = message.data; this.logSubscriptions = message.data;
this.updateLogSubscriptions(); this.updateLogSubscriptions();
-1
View File
@@ -1,7 +1,6 @@
"use strict"; "use strict";
const http = require("http"); const http = require("http");
const https = require("https"); const https = require("https");
const util = require("util");
/** /**
* Gracefully close a Node.js HTTP(S) server * Gracefully close a Node.js HTTP(S) server
+20 -6
View File
@@ -97,7 +97,7 @@ class Master {
} }
async start(args) { async start(args) {
if (!this._state === "new") { if (this._state !== "new") {
throw new Error(`Cannot start in state ${this._state}`); throw new Error(`Cannot start in state ${this._state}`);
} }
@@ -162,6 +162,9 @@ class Master {
this.userManager = new UserManager(this.config); this.userManager = new UserManager(this.config);
await this.userManager.load(path.join(databaseDirectory, "users.json")); await this.userManager.load(path.join(databaseDirectory, "users.json"));
this.config.on("fieldChanged", (group, field, prev) => {
libPlugin.invokeHook(this.plugins, "onMasterConfigFieldChanged", group, field, prev);
});
for (let instance of this.instances.values()) { for (let instance of this.instances.values()) {
this.addInstanceHooks(instance); this.addInstanceHooks(instance);
} }
@@ -421,6 +424,21 @@ class Master {
} }
} }
/**
* Get instance by ID for a request
*
* @param {number} instanceId - ID of instance to get.
* @returns {object} instance
* @throws {module:lib/errors.RequestError} if the instance does not exist.
*/
getRequestInstance(instanceId) {
let instance = this.instances.get(instanceId);
if (!instance) {
throw new libErrors.RequestError(`Instance with ID ${instanceId} does not exist`);
}
return instance;
}
addInstanceHooks(instance) { addInstanceHooks(instance) {
instance.config.on("fieldChanged", (group, field, prev) => { instance.config.on("fieldChanged", (group, field, prev) => {
if (group.name === "instance" && field === "name") { if (group.name === "instance" && field === "name") {
@@ -605,11 +623,7 @@ class Master {
* @returns {object} data returned from the request. * @returns {object} data returned from the request.
*/ */
async forwardRequestToInstance(request, data) { async forwardRequestToInstance(request, data) {
let instance = this.instances.get(data.instance_id); let instance = this.getRequestInstance(data.instance_id);
if (!instance) {
throw new libErrors.RequestError(`Instance with ID ${data.instance_id} does not exist`);
}
let slaveId = instance.config.get("instance.assigned_slave"); let slaveId = instance.config.get("instance.assigned_slave");
if (slaveId === null) { if (slaveId === null) {
throw new libErrors.RequestError("Instance is not assigned to a slave"); throw new libErrors.RequestError("Instance is not assigned to a slave");
+1 -1
View File
@@ -176,7 +176,7 @@ ${err.stack}`
return; return;
} }
let { seq, type, data } = message; let { type, data } = message;
if (type === "resume") { if (type === "resume") {
let connector; let connector;
@@ -49,7 +49,7 @@ local has_create_grid = version_ge("1.1.7")
-- If the equipment is a burner the following is also present: -- If the equipment is a burner the following is also present:
-- i: burner inventory -- i: burner inventory
-- r: result inventory -- r: result inventory
-- b: curently burning (optional) -- b: currently burning (optional)
-- f: remaining_burning_fuel (optional) -- f: remaining_burning_fuel (optional)
function serialize.serialize_equipment_grid(grid) function serialize.serialize_equipment_grid(grid)
local serialized = {} local serialized = {}
+2 -2
View File
@@ -3,7 +3,7 @@
"description": "Implementation of Clusterio slave server", "description": "Implementation of Clusterio slave server",
"author": "Hornwitser", "author": "Hornwitser",
"license": "MIT", "license": "MIT",
"version": "2.0.0-alpha.11", "version": "2.0.0-alpha.12",
"main": "slave.js", "main": "slave.js",
"scripts": { "scripts": {
"test": "echo \"Error: no test specified\" && exit 1" "test": "echo \"Error: no test specified\" && exit 1"
@@ -18,7 +18,7 @@
"node": ">=12" "node": ">=12"
}, },
"dependencies": { "dependencies": {
"@clusterio/lib": "^2.0.0-alpha.11", "@clusterio/lib": "^2.0.0-alpha.12",
"fs-extra": "^8.1.0", "fs-extra": "^8.1.0",
"phin": "^3.5.1", "phin": "^3.5.1",
"pidusage": "^2.0.18", "pidusage": "^2.0.18",
+126 -38
View File
@@ -186,7 +186,11 @@ class Instance extends libLink.Link {
}); });
this.server.on("error", err => { this.server.on("error", err => {
this.logger.error(`Error in instance ${this.name}:\n${err.stack}`); if (err instanceof libErrors.EnvironmentError) {
this.logger.error(err.message);
} else {
this.logger.error(`${this.name}:\n${err.stack}`);
}
}); });
this.server.on("autosave-finished", name => { this.server.on("autosave-finished", name => {
@@ -195,6 +199,12 @@ class Instance extends libLink.Link {
}); });
}); });
this.server.on("save-finished", () => {
this.sendSaveListUpdate().catch(err => {
this.logger.error(`Error handling save-finished in instance ${this.name}:\n${err.stack}`);
});
});
this.server.on("ipc-player_event", event => { this.server.on("ipc-player_event", event => {
libLink.messages.playerEvent.send(this, { libLink.messages.playerEvent.send(this, {
instance_id: this.id, instance_id: this.id,
@@ -697,6 +707,13 @@ class Instance extends libLink.Link {
} }
} }
async kill() {
if (this._status === "stopped") {
return;
}
await this.server.kill(true);
}
async masterConnectionEventEventHandler(message) { async masterConnectionEventEventHandler(message) {
await libPlugin.invokeHook(this.plugins, "onMasterConnectionEvent", message.data.event); await libPlugin.invokeHook(this.plugins, "onMasterConnectionEvent", message.data.event);
} }
@@ -833,6 +850,10 @@ class Instance extends libLink.Link {
await this.stop(); await this.stop();
} }
async killInstanceRequestHandler() {
await this.kill();
}
async sendRconRequestHandler(message) { async sendRconRequestHandler(message) {
let result = await this.sendRcon(message.data.command); let result = await this.sendRcon(message.data.command);
return { result }; return { result };
@@ -1056,6 +1077,15 @@ function checkFilename(name) {
} }
} }
function checkRequestSaveName(name) {
try {
checkFilename(name);
} catch (err) {
throw new libErrors.RequestError(`Save name ${err.message}`);
}
}
/** /**
* Handles running the slave * Handles running the slave
* *
@@ -1330,6 +1360,14 @@ class Slave extends libLink.Link {
} }
} }
getRequestInstanceInfo(instanceId) {
let instanceInfo = this.instanceInfos.get(instanceId);
if (!instanceInfo) {
throw new libErrors.RequestError(`Instance with ID ${instanceId} does not exist`);
}
return instanceInfo;
}
/** /**
* Initialize and connect an unloaded instance * Initialize and connect an unloaded instance
* *
@@ -1337,11 +1375,7 @@ class Slave extends libLink.Link {
* @returns {module:slave/slave~InstanceConnection} connection to instance. * @returns {module:slave/slave~InstanceConnection} connection to instance.
*/ */
async _connectInstance(instanceId) { async _connectInstance(instanceId) {
let instanceInfo = this.instanceInfos.get(instanceId); let instanceInfo = this.getRequestInstanceInfo(instanceId);
if (!instanceInfo) {
throw new libErrors.RequestError(`Instance with ID ${instanceId} does not exist`);
}
if (this.instanceConnections.has(instanceId)) { if (this.instanceConnections.has(instanceId)) {
throw new libErrors.RequestError(`Instance with ID ${instanceId} is running`); throw new libErrors.RequestError(`Instance with ID ${instanceId} is running`);
} }
@@ -1403,11 +1437,7 @@ class Slave extends libLink.Link {
return await request.send(instanceConnection, message.data); return await request.send(instanceConnection, message.data);
} }
let instanceInfo = this.instanceInfos.get(instanceId); let instanceInfo = this.getRequestInstanceInfo(instanceId);
if (!instanceInfo) {
throw new libErrors.RequestError(`Instance with ID ${instanceId} does not exist`);
}
return { return {
list: await Instance.listSaves(path.join(instanceInfo.path, "saves"), null), list: await Instance.listSaves(path.join(instanceInfo.path, "saves"), null),
}; };
@@ -1419,6 +1449,85 @@ class Slave extends libLink.Link {
await request.send(instanceConnection, message.data); await request.send(instanceConnection, message.data);
} }
async renameSaveRequestHandler(message) {
let { instance_id, old_name, new_name } = message.data;
checkRequestSaveName(old_name);
checkRequestSaveName(new_name);
let instanceInfo = this.getRequestInstanceInfo(instance_id);
try {
await fs.move(
path.join(instanceInfo.path, "saves", old_name),
path.join(instanceInfo.path, "saves", new_name),
{ overwrite: false },
);
} catch (err) {
if (err.code === "ENOENT") {
throw new libErrors.RequestError(`${old_name} does not exist`);
}
throw err;
}
await this.sendSaveListUpdate(instance_id, path.join(instanceInfo.path, "saves"));
}
async copySaveRequestHandler(message) {
let { instance_id, source, destination } = message.data;
checkRequestSaveName(source);
checkRequestSaveName(destination);
let instanceInfo = this.getRequestInstanceInfo(instance_id);
try {
await fs.copy(
path.join(instanceInfo.path, "saves", source),
path.join(instanceInfo.path, "saves", destination),
{ overwrite: false, errorOnExist: true },
);
} catch (err) {
if (err.code === "ENOENT") {
throw new libErrors.RequestError(`${old_name} does not exist`);
}
throw err;
}
await this.sendSaveListUpdate(instance_id, path.join(instanceInfo.path, "saves"));
}
async transferSaveRequestHandler(message) {
let { source_save, target_save, copy, instance_id, target_instance_id } = message.data;
checkRequestSaveName(source_save);
checkRequestSaveName(target_save);
let sourceInstanceInfo = this.getRequestInstanceInfo(instance_id);
let targetInstanceInfo = this.getRequestInstanceInfo(target_instance_id);
// For consistency with remote transfer initiated through pullSave the
// target is renamed if it already exists.
target_save = await libFileOps.findUnusedName(
path.join(targetInstanceInfo.path, "saves"), target_save, ".zip"
);
try {
if (copy) {
await fs.copy(
path.join(sourceInstanceInfo.path, "saves", source_save),
path.join(targetInstanceInfo.path, "saves", target_save),
{ overwrite: true },
);
} else {
await fs.move(
path.join(sourceInstanceInfo.path, "saves", source_save),
path.join(targetInstanceInfo.path, "saves", target_save),
{ overwrite: true },
);
}
} catch (err) {
if (err.code === "ENOENT") {
throw new libErrors.RequestError(`${source_save} does not exist`);
}
throw err;
}
await this.sendSaveListUpdate(instance_id, path.join(sourceInstanceInfo.path, "saves"));
await this.sendSaveListUpdate(target_instance_id, path.join(targetInstanceInfo.path, "saves"));
return { save: target_save };
}
async sendSaveListUpdate(instance_id, savesDir) { async sendSaveListUpdate(instance_id, savesDir) {
let instanceConnection = this.instanceConnections.get(instance_id); let instanceConnection = this.instanceConnections.get(instance_id);
let saveList; let saveList;
@@ -1433,15 +1542,8 @@ class Slave extends libLink.Link {
async deleteSaveRequestHandler(message) { async deleteSaveRequestHandler(message) {
let { instance_id, save } = message.data; let { instance_id, save } = message.data;
try { checkRequestSaveName(save);
checkFilename(save); let instanceInfo = this.getRequestInstanceInfo(instance_id);
} catch (err) {
throw new libErrors.RequestError(`Save name ${err.message}`);
}
let instanceInfo = this.instanceInfos.get(instance_id);
if (!instanceInfo) {
throw new libErrors.RequestError(`Instance with ID ${instance_id} does not exist`);
}
try { try {
await fs.unlink(path.join(instanceInfo.path, "saves", save)); await fs.unlink(path.join(instanceInfo.path, "saves", save));
@@ -1456,15 +1558,8 @@ class Slave extends libLink.Link {
async pullSaveRequestHandler(message) { async pullSaveRequestHandler(message) {
let { instance_id, stream_id, filename } = message.data; let { instance_id, stream_id, filename } = message.data;
try { checkRequestSaveName(filename);
checkFilename(filename); let instanceInfo = this.getRequestInstanceInfo(instance_id);
} catch (err) {
throw new libErrors.RequestError(`Save name ${err.message}`);
}
let instanceInfo = this.instanceInfos.get(instance_id);
if (!instanceInfo) {
throw new libErrors.RequestError(`Instance with ID ${instance_id} does not exist`);
}
let url = new URL(this.config.get("slave.master_url")); let url = new URL(this.config.get("slave.master_url"));
url.pathname += `api/stream/${stream_id}`; url.pathname += `api/stream/${stream_id}`;
@@ -1507,15 +1602,8 @@ class Slave extends libLink.Link {
async pushSaveRequestHandler(message) { async pushSaveRequestHandler(message) {
let { instance_id, stream_id, save } = message.data; let { instance_id, stream_id, save } = message.data;
try { checkRequestSaveName(save);
checkFilename(save); let instanceInfo = this.getRequestInstanceInfo(instance_id);
} catch (err) {
throw new libErrors.RequestError(`Save name ${err.message}`);
}
let instanceInfo = this.instanceInfos.get(instance_id);
if (!instanceInfo) {
throw new libErrors.RequestError(`Instance with ID ${instance_id} does not exist`);
}
let content; let content;
try { try {
+2 -2
View File
@@ -3,7 +3,7 @@
"description": "Clusterio web interface implementation", "description": "Clusterio web interface implementation",
"author": "Hornwitser", "author": "Hornwitser",
"license": "MIT", "license": "MIT",
"version": "2.0.0-alpha.11", "version": "2.0.0-alpha.12",
"browser": "src/index.jsx", "browser": "src/index.jsx",
"scripts": { "scripts": {
"test": "echo \"Error: no test specified\" && exit 1" "test": "echo \"Error: no test specified\" && exit 1"
@@ -18,7 +18,7 @@
"@ant-design/icons": "^4.2.2", "@ant-design/icons": "^4.2.2",
"@babel/core": "^7.13.8", "@babel/core": "^7.13.8",
"@babel/preset-react": "^7.12.13", "@babel/preset-react": "^7.12.13",
"@clusterio/lib": "^2.0.0-alpha.11", "@clusterio/lib": "^2.0.0-alpha.12",
"antd": "^4.16.0", "antd": "^4.16.0",
"assert": "^2.0.0", "assert": "^2.0.0",
"babel-loader": "^8.2.2", "babel-loader": "^8.2.2",
-1
View File
@@ -1,4 +1,3 @@
import events from "events";
import React, { useEffect, useState } from "react"; import React, { useEffect, useState } from "react";
import { BrowserRouter } from "react-router-dom"; import { BrowserRouter } from "react-router-dom";
@@ -1,4 +1,4 @@
import React, { useEffect, useContext, useState } from "react"; import React, { useEffect, useState } from "react";
import { Button, Card, Checkbox, Form, Input, InputNumber, Space, Spin, Tree, Typography } from "antd"; import { Button, Card, Checkbox, Form, Input, InputNumber, Space, Spin, Tree, Typography } from "antd";
const { Title } = Typography; const { Title } = Typography;
@@ -1,5 +1,5 @@
import React, { useContext, useState } from "react"; import React, { useContext, useState } from "react";
import { Button, Col, Form, Input, Modal, Row, Typography } from "antd"; import { Button, Form, Input, Modal } from "antd";
import { libFactorio, libLink } from "@clusterio/lib"; import { libFactorio, libLink } from "@clusterio/lib";
+1 -3
View File
@@ -1,8 +1,6 @@
import React, { useContext } from "react"; import React from "react";
import { Typography } from "antd"; import { Typography } from "antd";
import { libLink } from "@clusterio/lib";
import PageLayout from "./PageLayout"; import PageLayout from "./PageLayout";
const { Paragraph } = Typography; const { Paragraph } = Typography;
@@ -1,5 +1,4 @@
import React, { useContext } from "react"; import React, { useContext } from "react";
import { Typography } from "antd";
import { libConfig, libLink } from "@clusterio/lib"; import { libConfig, libLink } from "@clusterio/lib";
@@ -1,10 +1,11 @@
import React from "react"; import React from "react";
import { useHistory } from "react-router-dom"; import { useHistory } from "react-router-dom";
import { message, Button, Table } from "antd"; import { message, Button, Space, Table } from "antd";
import CopyOutlined from "@ant-design/icons/CopyOutlined"; import CopyOutlined from "@ant-design/icons/CopyOutlined";
import { useSlaveList } from "../model/slave"; import { useSlaveList } from "../model/slave";
import InstanceStatusTag from "./InstanceStatusTag"; import InstanceStatusTag from "./InstanceStatusTag";
import StartStopInstanceButton from "./StartStopInstanceButton";
const strcmp = new Intl.Collator(undefined, { numerice: "true", sensitivity: "base" }).compare; const strcmp = new Intl.Collator(undefined, { numerice: "true", sensitivity: "base" }).compare;
@@ -43,6 +44,7 @@ export default function InstanceList(props) {
key: "assigned_slave", key: "assigned_slave",
render: instance => slaveName(instance["assigned_slave"]), render: instance => slaveName(instance["assigned_slave"]),
sorter: (a, b) => strcmp(slaveName(a["assigned_slave"]), slaveName(b["assigned_slave"])), sorter: (a, b) => strcmp(slaveName(a["assigned_slave"]), slaveName(b["assigned_slave"])),
responsive: ["sm"],
}, },
{ {
title: "Public address", title: "Public address",
@@ -63,13 +65,24 @@ export default function InstanceList(props) {
</> : ""; </> : "";
}, },
sorter: (a, b) => strcmp(slavePublicAddress(a["assigned_slave"]), slavePublicAddress(b["assigned_slave"])), sorter: (a, b) => strcmp(slavePublicAddress(a["assigned_slave"]), slavePublicAddress(b["assigned_slave"])),
responsive: ["lg"],
}, },
{ {
title: "Status", title: "Status",
dataIndex: "status", key: "status",
render: status => <InstanceStatusTag status={status} />, render: instance => <InstanceStatusTag status={instance["status"]} />,
sorter: (a, b) => strcmp(a["status"], b["status"]), sorter: (a, b) => strcmp(a["status"], b["status"]),
}, },
{
key: "action",
render: instance => <StartStopInstanceButton
buttonProps={{ size: "small" }}
instance={instance}
/>,
responsive: ["sm"],
align: "right",
width: 100,
},
]; ];
if (props.hideAssignedSlave) { if (props.hideAssignedSlave) {
@@ -1,13 +1,15 @@
import React, { useContext, useState } from "react"; import React, { useContext, useState } from "react";
import { useHistory, useParams } from "react-router-dom"; import { useHistory, useParams } from "react-router-dom";
import { Alert, Button, Descriptions, Popconfirm, Space, Spin, Typography } from "antd"; import { Alert, Button, Descriptions, Dropdown, Menu, Modal, PageHeader, Space, Spin, Typography } from "antd";
import DeleteOutlined from "@ant-design/icons/DeleteOutlined"; import DeleteOutlined from "@ant-design/icons/DeleteOutlined";
import DownOutlined from "@ant-design/icons/DownOutlined";
import { libLink } from "@clusterio/lib"; import { libLink } from "@clusterio/lib";
import { useAccount } from "../model/account"; import { useAccount } from "../model/account";
import ControlContext from "./ControlContext"; import ControlContext from "./ControlContext";
import PageLayout from "./PageLayout"; import PageLayout from "./PageLayout";
import PluginExtra from "./PluginExtra";
import InstanceConfigTree from "./InstanceConfigTree"; import InstanceConfigTree from "./InstanceConfigTree";
import LogConsole from "./LogConsole"; import LogConsole from "./LogConsole";
import InstanceRcon from "./InstanceRcon"; import InstanceRcon from "./InstanceRcon";
@@ -20,9 +22,39 @@ import { useInstance } from "../model/instance";
import { useSlave } from "../model/slave"; import { useSlave } from "../model/slave";
import InstanceStatusTag from "./InstanceStatusTag"; import InstanceStatusTag from "./InstanceStatusTag";
const { Title, Paragraph } = Typography; const { Title } = Typography;
function InstanceDescription(props) {
let account = useAccount();
const { slave, instance } = props;
let assigned = instance["assigned_slave"] !== null;
return <Descriptions
bordered
size="small"
>
<Descriptions.Item label="Slave">
{!assigned
? <em>Unassigned</em>
: slave["name"] || instance["assigned_slave"]
}
{account.hasPermission("core.instance.assign") && <AssignInstanceModal
id={instance["id"]}
slaveId={instance["assigned_slave"]}
buttonProps={{
size: "small",
style: { float: "Right" },
type: assigned ? "default" : "primary",
disabled: !["unknown", "unassigned", "stopped"].includes(instance["status"]),
}}
buttonContent={assigned ? "Reassign" : "Assign"}
/>}
</Descriptions.Item>
<Descriptions.Item label="Status"><InstanceStatusTag status={instance["status"]} /></Descriptions.Item>
</Descriptions>;
}
export default function InstanceViewPage(props) { export default function InstanceViewPage(props) {
let params = useParams(); let params = useParams();
let instanceId = Number(params.id); let instanceId = Number(params.id);
@@ -60,16 +92,9 @@ export default function InstanceViewPage(props) {
</PageLayout>; </PageLayout>;
} }
let instanceButtons = <Space> let instanceButtonsMenu = <Menu
{ onClick={({ key }) => {
account.hasAnyPermission("core.instance.start", "core.instance.stop") if (key === "export") {
&& <StartStopInstanceButton instance={instance} />
}
{account.hasPermission("core.instance.load_scenario") && <LoadScenarioModal instance={instance} />}
{account.hasPermission("core.instance.export_data") && <Button
loading={exportingData}
disabled={instance.status !== "stopped"}
onClick={() => {
setExportingData(true); setExportingData(true);
libLink.messages.exportData.send( libLink.messages.exportData.send(
control, { instance_id: instanceId } control, { instance_id: instanceId }
@@ -78,59 +103,69 @@ export default function InstanceViewPage(props) {
).finally(() => { ).finally(() => {
setExportingData(false); setExportingData(false);
}); });
}}
> } else if (key === "kill") {
Export data libLink.messages.killInstance.send(
</Button>}
{account.hasPermission("core.instance.delete") && <Popconfirm
title="Permanently delete instance and server saves?"
okText="Delete"
placement="bottomRight"
okButtonProps={{ danger: true }}
onConfirm={() => {
libLink.messages.deleteInstance.send(
control, { instance_id: instanceId } control, { instance_id: instanceId }
).then(() => { ).catch(notifyErrorHandler("Error killing instance"));
history.push("/instances");
}).catch(notifyErrorHandler("Error deleting instance")); } else if (key === "delete") {
}} Modal.confirm({
> autoFocusButton: "cancel",
<Button content: "Permamently delete instance and server saves?",
danger okText: "Delete",
okButtonProps: { danger: true },
onOk: () => {
libLink.messages.deleteInstance.send(
control, { instance_id: instanceId }
).then(() => {
history.push("/instances");
}).catch(notifyErrorHandler("Error deleting instance"));
},
});
}
}}
>
{account.hasPermission("core.instance.export_data") && <Menu.Item
disabled={exportingData || instance.status !== "stopped"}
key="export"
>Export data</Menu.Item>}
{account.hasPermission("core.instance.kill") && <Menu.Item
disabled={["unknown", "unassigned", "stopped"].includes(instance["status"])}
key="kill"
>Kill process</Menu.Item>}
{account.hasPermission("core.instance.delete") && <>
<Menu.Divider />
<Menu.Item
disabled={!["unknown", "unassigned", "stopped"].includes(instance["status"])} disabled={!["unknown", "unassigned", "stopped"].includes(instance["status"])}
> danger
<DeleteOutlined /> key="delete"
</Button> icon={<DeleteOutlined />}
</Popconfirm>} >Delete</Menu.Item>
</>}
</Menu>;
let instanceButtons = <Space>
{
account.hasAnyPermission("core.instance.start", "core.instance.stop")
&& <StartStopInstanceButton instance={instance} />
}
{account.hasPermission("core.instance.load_scenario") && <LoadScenarioModal instance={instance} />}
{account.hasAnyPermission(
"core.instance.export_data",
"core.instance.kill",
"core.instance.delete",
) && <Dropdown placement="bottomRight" trigger={["click"]} overlay={instanceButtonsMenu}>
<Button>More <DownOutlined /></Button>
</Dropdown>}
</Space>; </Space>;
let assigned = instance["assigned_slave"] !== null;
return <PageLayout nav={nav}> return <PageLayout nav={nav}>
<Descriptions <PageHeader
bordered className="site-page-header"
size="small"
title={instance["name"]} title={instance["name"]}
extra={instanceButtons} extra={instanceButtons}
> />
<Descriptions.Item label="Slave"> <InstanceDescription slave={slave} instance={instance} />
{!assigned
? <em>Unassigned</em>
: slave["name"] || instance["assigned_slave"]
}
{account.hasPermission("core.instance.assign") && <AssignInstanceModal
id={instanceId}
slaveId={instance["assigned_slave"]}
buttonProps={{
size: "small",
style: { float: "Right" },
type: assigned ? "default" : "primary",
disabled: !["unknown", "unassigned", "stopped"].includes(instance["status"]),
}}
buttonContent={assigned ? "Reassign" : "Assign"}
/>}
</Descriptions.Item>
<Descriptions.Item label="Status"><InstanceStatusTag status={instance["status"]} /></Descriptions.Item>
</Descriptions>
{ {
account.hasAllPermission("core.instance.save.list", "core.instance.save.list_subscribe") account.hasAllPermission("core.instance.save.list", "core.instance.save.list_subscribe")
@@ -147,5 +182,7 @@ export default function InstanceViewPage(props) {
} }
{account.hasPermission("core.instance.get_config") && <InstanceConfigTree id={instanceId} />} {account.hasPermission("core.instance.get_config") && <InstanceConfigTree id={instanceId} />}
<PluginExtra component="InstanceViewPage" instance={instance} />
</PageLayout>; </PageLayout>;
} }
@@ -7,6 +7,7 @@ import { libConfig, libLink } from "@clusterio/lib";
import { useAccount } from "../model/account"; import { useAccount } from "../model/account";
import ControlContext from "./ControlContext"; import ControlContext from "./ControlContext";
import PageLayout from "./PageLayout"; import PageLayout from "./PageLayout";
import PluginExtra from "./PluginExtra";
import { useInstanceList } from "../model/instance"; import { useInstanceList } from "../model/instance";
import InstanceList from "./InstanceList"; import InstanceList from "./InstanceList";
import { notifyErrorHandler } from "../util/notify"; import { notifyErrorHandler } from "../util/notify";
@@ -28,7 +29,7 @@ function CreateInstanceButton(props) {
await instanceConfig.init(); await instanceConfig.init();
instanceConfig.set("instance.name", values.instanceName); instanceConfig.set("instance.name", values.instanceName);
let serialized_config = instanceConfig.serialize("master"); let serialized_config = instanceConfig.serialize("master");
let result = await libLink.messages.createInstance.send(control, { serialized_config }); await libLink.messages.createInstance.send(control, { serialized_config });
setVisible(false); setVisible(false);
history.push(`/instances/${instanceConfig.get("instance.id")}/view`); history.push(`/instances/${instanceConfig.get("instance.id")}/view`);
} }
@@ -94,5 +95,6 @@ export default function InstancesPage() {
/> />
<InstanceList instances={instanceList} /> <InstanceList instances={instanceList} />
<PluginExtra component="InstancesPage" />
</PageLayout>; </PageLayout>;
} }
@@ -1,5 +1,5 @@
import React, { useContext, useState } from "react"; import React, { useContext, useState } from "react";
import { Button, Col, Form, Input, Modal, Row, Typography } from "antd"; import { Button, Form, Input, Modal } from "antd";
import { libFactorio, libLink } from "@clusterio/lib"; import { libFactorio, libLink } from "@clusterio/lib";
+3 -3
View File
@@ -1,11 +1,11 @@
import React, { Fragment, useContext } from "react"; import React, { Fragment, useContext } from "react";
import { Button, Card, Divider, Form, Image, Input, List, Space, Spin, Typography } from "antd"; import { Button, Card, Divider, Form, Image, Input, Space, Typography } from "antd";
import LockOutlined from "@ant-design/icons/LockOutlined"; import LockOutlined from "@ant-design/icons/LockOutlined";
import logo from "../images/logo.png"; import logo from "../images/logo.png";
import ControlContext from "./ControlContext"; import ControlContext from "./ControlContext";
const { Paragraph, Text } = Typography; const { Paragraph } = Typography;
function TokenAuth(props) { function TokenAuth(props) {
@@ -22,7 +22,7 @@ function TokenAuth(props) {
> >
<Input <Input
style={{ width: "14em" }} style={{ width: "14em" }}
prefix=<LockOutlined className="site-form-item-icon" /> prefix={<LockOutlined className="site-form-item-icon" />}
type="password" type="password"
placeholder="Authentication Token" placeholder="Authentication Token"
/> />
@@ -1,5 +1,4 @@
import React, { useContext } from "react"; import React, { useContext } from "react";
import { Typography } from "antd";
import { libConfig, libLink } from "@clusterio/lib"; import { libConfig, libLink } from "@clusterio/lib";
@@ -1,6 +1,7 @@
import React, { useContext } from "react"; import React from "react";
import { Typography } from "antd"; import { Typography } from "antd";
import PluginExtra from "./PluginExtra";
import LogConsole from "./LogConsole"; import LogConsole from "./LogConsole";
import { useAccount } from "../model/account"; import { useAccount } from "../model/account";
import MasterConfigTree from "./MasterConfigTree"; import MasterConfigTree from "./MasterConfigTree";
@@ -9,7 +10,7 @@ import PageLayout from "./PageLayout";
const { Title } = Typography; const { Title } = Typography;
export default function SlavesPage() { export default function MasterPage() {
let account = useAccount(); let account = useAccount();
return <PageLayout nav={[{ name: "Master" }]}> return <PageLayout nav={[{ name: "Master" }]}>
@@ -19,5 +20,6 @@ export default function SlavesPage() {
<LogConsole master={true} /> <LogConsole master={true} />
</>} </>}
{account.hasPermission("core.master.get_config") && <MasterConfigTree />} {account.hasPermission("core.master.get_config") && <MasterConfigTree />}
<PluginExtra component="MasterPage" />
</PageLayout>; </PageLayout>;
}; };
@@ -1,6 +1,6 @@
import React from "react"; import React from "react";
import { Link } from "react-router-dom"; import { Link } from "react-router-dom";
import { Layout, Menu, Breadcrumb, Typography } from "antd"; import { Layout, Breadcrumb } from "antd";
const { Content } = Layout; const { Content } = Layout;
@@ -0,0 +1,17 @@
import React, { useContext } from "react";
import ControlContext from "./ControlContext";
export default function PluginExtra(params) {
let control = useContext(ControlContext);
let components = [];
for (let [name, plugin] of control.plugins) {
if (Object.prototype.hasOwnProperty.call(plugin.componentExtra, params.component)) {
let ComponentExtra = plugin.componentExtra[params.component];
components.push(<ComponentExtra key={name} plugin={plugin} {...params}/>);
}
}
return components;
}
@@ -1,10 +1,9 @@
import React, { useEffect, useContext, useState } from "react"; import React, { useEffect, useContext, useState } from "react";
import { useHistory, useParams } from "react-router-dom"; import { useParams } from "react-router-dom";
import { Alert, Descriptions, Spin } from "antd"; import { Alert, Descriptions, Spin } from "antd";
import ControlContext from "./ControlContext"; import ControlContext from "./ControlContext";
import PageLayout from "./PageLayout"; import PageLayout from "./PageLayout";
import { notifyErrorHandler } from "../util/notify";
export default function PluginViewPage() { export default function PluginViewPage() {
@@ -8,6 +8,7 @@ import { libLink, libUsers } from "@clusterio/lib";
import { useAccount } from "../model/account"; import { useAccount } from "../model/account";
import ControlContext from "./ControlContext"; import ControlContext from "./ControlContext";
import PageLayout from "./PageLayout"; import PageLayout from "./PageLayout";
import PluginExtra from "./PluginExtra";
import { notifyErrorHandler } from "../util/notify"; import { notifyErrorHandler } from "../util/notify";
@@ -149,5 +150,6 @@ export default function RoleViewPage() {
</Form.Item> </Form.Item>
))} ))}
</Form> </Form>
<PluginExtra component="RoleViewPage" role={role} />
</PageLayout>; </PageLayout>;
} }
@@ -8,6 +8,7 @@ import { useAccount } from "../model/account";
import ControlContext from "./ControlContext"; import ControlContext from "./ControlContext";
import { notifyErrorHandler } from "../util/notify"; import { notifyErrorHandler } from "../util/notify";
import PageLayout from "./PageLayout"; import PageLayout from "./PageLayout";
import PluginExtra from "./PluginExtra";
const strcmp = new Intl.Collator(undefined, { numerice: "true", sensitivity: "base" }).compare; const strcmp = new Intl.Collator(undefined, { numerice: "true", sensitivity: "base" }).compare;
@@ -99,5 +100,6 @@ export default function RolesPage() {
}, },
})} })}
/> />
<PluginExtra component="RolesPage" />
</PageLayout>; </PageLayout>;
} }
+176 -1
View File
@@ -1,5 +1,8 @@
import React, { useContext, useState } from "react"; import React, { useContext, useState } from "react";
import { Button, List, Popconfirm, Progress, Space, Table, Tooltip, Upload } from "antd"; import {
message, Button, Checkbox, Form, Input, List, Modal,
Popconfirm, Progress, Select, Space, Table, Tooltip, Upload,
} from "antd";
import CaretLeftOutlined from "@ant-design/icons/CaretLeftOutlined"; import CaretLeftOutlined from "@ant-design/icons/CaretLeftOutlined";
import LeftOutlined from "@ant-design/icons/LeftOutlined"; import LeftOutlined from "@ant-design/icons/LeftOutlined";
@@ -9,10 +12,173 @@ import { useAccount } from "../model/account";
import ControlContext from "./ControlContext"; import ControlContext from "./ControlContext";
import CreateSaveModal from "./CreateSaveModal"; import CreateSaveModal from "./CreateSaveModal";
import SectionHeader from "./SectionHeader"; import SectionHeader from "./SectionHeader";
import { useInstanceList } from "../model/instance";
import { useSaves } from "../model/saves"; import { useSaves } from "../model/saves";
import { notifyErrorHandler } from "../util/notify"; import { notifyErrorHandler } from "../util/notify";
function RenameModal(props) {
let control = useContext(ControlContext);
let [visible, setVisible] = useState(false);
let [form] = Form.useForm();
return <>
<Button disabled={props.disabled} onClick={() => setVisible(true)}>Rename</Button>
<Modal
title="Rename save"
okText="Rename"
visible={visible}
onOk={() => form.submit()}
onCancel={() => setVisible(false)}
>
<Form
form={form}
layout="vertical"
initialValues={{ newName: props.save.name }}
onFinish={values => {
libLink.messages.renameSave.send(control,
{ instance_id: props.instanceId, old_name: props.save.name, new_name: values.newName }
).then(() => {
setVisible(false);
form.resetFields();
}).catch(notifyErrorHandler("Error renaming save"));
}}
>
<Form.Item
name="newName"
label="New name"
rules={[{ required: true, message: "New name is required" }]}
>
<Input autoFocus />
</Form.Item>
</Form>
</Modal>
</>;
}
function CopyModal(props) {
let control = useContext(ControlContext);
let [visible, setVisible] = useState(false);
let [form] = Form.useForm();
return <>
<Button disabled={props.disabled} onClick={() => setVisible(true)}>Copy</Button>
<Modal
title="Copy save"
okText="Copy"
visible={visible}
onOk={() => form.submit()}
onCancel={() => setVisible(false)}
>
<Form
form={form}
layout="vertical"
initialValues={{ newName: props.save.name }}
onFinish={values => {
libLink.messages.copySave.send(control,
{ instance_id: props.instanceId, source: props.save.name, destination: values.newName }
).then(() => {
setVisible(false);
form.resetFields();
}).catch(notifyErrorHandler("Error copying save"));
}}
>
<Form.Item
name="newName"
label="New name"
rules={[{ required: true, message: "New name is required" }]}
>
<Input autoFocus />
</Form.Item>
</Form>
</Modal>
</>;
}
function TransferModal(props) {
let account = useAccount();
let control = useContext(ControlContext);
let [visible, setVisible] = useState(false);
let [form] = Form.useForm();
let [instanceList] = useInstanceList();
return <>
<Button disabled={props.disabled} onClick={() => setVisible(true)}>Transfer</Button>
<Modal
title="Transfer save"
okText="Transfer"
visible={visible}
onOk={() => form.submit()}
onCancel={() => setVisible(false)}
destroyOnClose
>
<Form
form={form}
labelCol={{ span: 6 }}
wrapperCol={{ span: 18 }}
initialValues={{ transferredName: props.save.name, copy: false }}
onFinish={values => {
setVisible(false);
let hide = message.loading("Transferring save...", 0);
libLink.messages.transferSave.send(control, {
instance_id: props.instanceId,
source_save: props.save.name,
target_instance_id: values.targetInstanceId,
target_save: values.transferredName || props.save.name,
copy: values.copy,
}).then(() => {
message.success("Transfer complete");
form.resetFields();
}).catch(
notifyErrorHandler("Error transfering save")
).finally(() => hide());
}}
>
<Form.Item
name="targetInstanceId"
label="Target Instance"
rules={[{ required: true, message: "Target Instance is required" }]}
>
<Select
autoFocus
showSearch
filterOption={(input, option) => option.title.toLowerCase().indexOf(input.toLowerCase()) >= 0}
>
{instanceList.filter(
instance => instance["id"] !== props.instanceId
).map((instance) => <Select.Option
key={instance["id"]}
value={instance["id"]}
title={instance["name"]}
disabled={["unassigned", "unknown"].includes(instance["status"])}
>
{instance["name"]}
{instance["status"] === "unassigned" && " (unassigned)"}
{instance["status"] === "unknown" && " (offline)"}
</Select.Option>)}
</Select>
</Form.Item>
<Form.Item
name="transferredName"
label="Transferred name"
disabled={!account.hasAnyPermission("core.instance.save.rename", "core.instance.save.copy")}
>
<Input />
</Form.Item>
<Form.Item
name="copy"
valuePropName="checked"
label="Copy"
tooltip="Copy instead of moving the save to the new instance."
disabled={!account.hasPermission("core.instance.save.copy")}
>
<Checkbox />
</Form.Item>
</Form>
</Modal>
</>;
}
function formatBytes(bytes) { function formatBytes(bytes) {
if (bytes === 0) { if (bytes === 0) {
return "0 Bytes"; return "0 Bytes";
@@ -81,6 +247,12 @@ export default function SavesList(props) {
); );
}} }}
>Load save</Button>} >Load save</Button>}
{account.hasPermission("core.instance.save.rename") && <RenameModal
disabled={slaveOffline} instanceId={props.instance.id} save={save}
/>}
{account.hasPermission("core.instance.save.copy") && <CopyModal
disabled={slaveOffline} instanceId={props.instance.id} save={save}
/>}
{account.hasPermission("core.instance.save.download") && <Button {account.hasPermission("core.instance.save.download") && <Button
disabled={slaveOffline} disabled={slaveOffline}
onClick={() => { onClick={() => {
@@ -95,6 +267,9 @@ export default function SavesList(props) {
); );
}} }}
>Download</Button>} >Download</Button>}
{account.hasPermission("core.instance.save.transfer") && <TransferModal
disabled={slaveOffline} instanceId={props.instance.id} save={save}
/>}
{account.hasPermission("core.instance.save.delete") && <Popconfirm {account.hasPermission("core.instance.save.delete") && <Popconfirm
title="Permanently delete save?" title="Permanently delete save?"
okText="Delete" okText="Delete"
@@ -1,4 +1,4 @@
import React, { useContext, useState } from "react"; import React from "react";
export default function SectionHeader(props) { export default function SectionHeader(props) {
return <div className="section-header"> return <div className="section-header">
+23 -6
View File
@@ -37,6 +37,27 @@ export default function SiteLayout(props) {
combinedPages.push(...plugin.pages); combinedPages.push(...plugin.pages);
} }
let menuItems = [];
let menuGroups = new Map();
for (let { sidebarName, sidebarGroup, permission, path } of combinedPages) {
if (!sidebarName || permission && !account.hasPermission(permission)) {
continue;
}
if (sidebarGroup) {
let group = menuGroups.get(sidebarGroup);
if (!group) {
group = [];
menuGroups.set(sidebarGroup, group);
}
group.push(<Menu.Item key={path}>{sidebarName}</Menu.Item>);
} else {
menuItems.push(<Menu.Item key={path}>{sidebarName}</Menu.Item>);
}
}
for (let [name, group] of menuGroups) {
menuItems.push(<Menu.ItemGroup key={name} title={name}>{group}</Menu.ItemGroup>);
}
return <Layout style={{ minHeight: "100vh" }}> return <Layout style={{ minHeight: "100vh" }}>
<Header className="header"> <Header className="header">
<div className="site-logo" /> <div className="site-logo" />
@@ -65,16 +86,12 @@ export default function SiteLayout(props) {
> >
<Menu <Menu
mode="inline" mode="inline"
defaultOpenKeys={[...menuGroups.keys()]}
selectedKeys={[currentSidebarPath]} selectedKeys={[currentSidebarPath]}
style={{ height: "100%", borderRight: 0 }} style={{ height: "100%", borderRight: 0 }}
onClick={({ key }) => history.push(key)} onClick={({ key }) => history.push(key)}
> >
{combinedPages.map(({sidebarName, permission, path}) => { {menuItems}
if (!sidebarName || permission && !account.hasPermission(permission)) {
return null;
}
return <Menu.Item key={path}>{sidebarName}</Menu.Item>;
})}
</Menu> </Menu>
</Sider> </Sider>
<Layout className="site-layout-content-container"> <Layout className="site-layout-content-container">
@@ -1,4 +1,4 @@
import React, { useContext, useState } from "react"; import React from "react";
import { Descriptions, PageHeader, Spin, Tag, Typography } from "antd"; import { Descriptions, PageHeader, Spin, Tag, Typography } from "antd";
import { useParams } from "react-router-dom"; import { useParams } from "react-router-dom";
@@ -8,6 +8,7 @@ import { useAccount } from "../model/account";
import { useInstanceList } from "../model/instance"; import { useInstanceList } from "../model/instance";
import { useSlave } from "../model/slave"; import { useSlave } from "../model/slave";
import PageLayout from "./PageLayout"; import PageLayout from "./PageLayout";
import PluginExtra from "./PluginExtra";
const { Title } = Typography; const { Title } = Typography;
@@ -60,5 +61,6 @@ export default function SlaveViewPage(props) {
<Title level={5} style={{ marginTop: 16 }}>Console</Title> <Title level={5} style={{ marginTop: 16 }}>Console</Title>
<LogConsole slaves={[slaveId]} /> <LogConsole slaves={[slaveId]} />
</>} </>}
<PluginExtra component="SlaveViewPage" slave={slave} />
</PageLayout>; </PageLayout>;
} }
@@ -7,6 +7,7 @@ import { libLink } from "@clusterio/lib";
import { useAccount } from "../model/account"; import { useAccount } from "../model/account";
import ControlContext from "./ControlContext"; import ControlContext from "./ControlContext";
import PageLayout from "./PageLayout"; import PageLayout from "./PageLayout";
import PluginExtra from "./PluginExtra";
import { useSlaveList } from "../model/slave"; import { useSlaveList } from "../model/slave";
import { notifyErrorHandler } from "../util/notify"; import { notifyErrorHandler } from "../util/notify";
@@ -129,5 +130,6 @@ export default function SlavesPage() {
}, },
})} })}
/> />
<PluginExtra component="SlavesPage" />
</PageLayout>; </PageLayout>;
}; };
@@ -11,7 +11,8 @@ export default function StartStopInstanceButton(props) {
let control = useContext(ControlContext); let control = useContext(ControlContext);
let [switching, setSwitching] = useState(false); let [switching, setSwitching] = useState(false);
function onClick() { function onClick(event) {
event.stopPropagation();
setSwitching(true); setSwitching(true);
let action; let action;
if (props.instance["status"] === "stopped") { if (props.instance["status"] === "stopped") {
@@ -8,6 +8,7 @@ import { libLink } from "@clusterio/lib";
import { useAccount } from "../model/account"; import { useAccount } from "../model/account";
import ControlContext from "./ControlContext"; import ControlContext from "./ControlContext";
import PageLayout from "./PageLayout"; import PageLayout from "./PageLayout";
import PluginExtra from "./PluginExtra";
import { notifyErrorHandler } from "../util/notify"; import { notifyErrorHandler } from "../util/notify";
@@ -258,5 +259,6 @@ export default function UserViewPage() {
</Space> </Space>
</Form.Item> </Form.Item>
</Form> </Form>
<PluginExtra component="UserViewPage" user={user} />
</PageLayout>; </PageLayout>;
} }
@@ -8,6 +8,7 @@ import { useAccount } from "../model/account";
import ControlContext from "./ControlContext"; import ControlContext from "./ControlContext";
import { notifyErrorHandler } from "../util/notify"; import { notifyErrorHandler } from "../util/notify";
import PageLayout from "./PageLayout"; import PageLayout from "./PageLayout";
import PluginExtra from "./PluginExtra";
const strcmp = new Intl.Collator(undefined, { numerice: "true", sensitivity: "base" }).compare; const strcmp = new Intl.Collator(undefined, { numerice: "true", sensitivity: "base" }).compare;
@@ -121,5 +122,6 @@ export default function UsersPage() {
}, },
})} })}
/> />
<PluginExtra component="UsersPage" />
</PageLayout>; </PageLayout>;
} }
+1 -1
View File
@@ -1,4 +1,4 @@
import React, { useEffect, useContext, useState } from "react"; import { useEffect, useContext, useState } from "react";
import ControlContext from "../components/ControlContext"; import ControlContext from "../components/ControlContext";
import { libLink, libLogging } from "@clusterio/lib"; import { libLink, libLogging } from "@clusterio/lib";
+1 -1
View File
@@ -1,4 +1,4 @@
import React, { useEffect, useState } from "react"; import { useEffect, useState } from "react";
let itemMetadataCache = null; let itemMetadataCache = null;
+1 -1
View File
@@ -1,4 +1,4 @@
import React, { useEffect, useContext, useState } from "react"; import { useEffect, useContext, useState } from "react";
import ControlContext from "../components/ControlContext"; import ControlContext from "../components/ControlContext";
import { libLink, libLogging } from "@clusterio/lib"; import { libLink, libLogging } from "@clusterio/lib";
+1 -1
View File
@@ -1,4 +1,4 @@
import React, { useEffect, useContext, useState } from "react"; import { useEffect, useContext, useState } from "react";
import ControlContext from "../components/ControlContext"; import ControlContext from "../components/ControlContext";
import { libLink } from "@clusterio/lib"; import { libLink } from "@clusterio/lib";
+3 -3
View File
@@ -1,6 +1,6 @@
{ {
"name": "@clusterio/plugin-global_chat", "name": "@clusterio/plugin-global_chat",
"version": "2.0.0-alpha.11", "version": "2.0.0-alpha.12",
"description": "Clusterio plugin forwarding between Factorio servers", "description": "Clusterio plugin forwarding between Factorio servers",
"author": "Hornwitser <github@hornwitser.no>", "author": "Hornwitser <github@hornwitser.no>",
"homepage": "https://github.com/clusterio/clusterio#readme", "homepage": "https://github.com/clusterio/clusterio#readme",
@@ -20,8 +20,8 @@
"@clusterio/lib": "^2.0.0-alpha.0" "@clusterio/lib": "^2.0.0-alpha.0"
}, },
"devDependencies": { "devDependencies": {
"@clusterio/lib": "^2.0.0-alpha.11", "@clusterio/lib": "^2.0.0-alpha.12",
"@clusterio/web_ui": "^2.0.0-alpha.11", "@clusterio/web_ui": "^2.0.0-alpha.12",
"webpack": "^5.36.2", "webpack": "^5.36.2",
"webpack-cli": "^4.7.0", "webpack-cli": "^4.7.0",
"webpack-merge": "^5.2.0" "webpack-merge": "^5.2.0"
-1
View File
@@ -4,7 +4,6 @@ const path = require("path");
const libFileOps = require("@clusterio/lib/file_ops"); const libFileOps = require("@clusterio/lib/file_ops");
const libPlugin = require("@clusterio/lib/plugin"); const libPlugin = require("@clusterio/lib/plugin");
const libErrors = require("@clusterio/lib/errors");
async function loadDatabase(config, logger) { async function loadDatabase(config, logger) {
let itemsPath = path.resolve(config.get("master.database_directory"), "inventories.json"); let itemsPath = path.resolve(config.get("master.database_directory"), "inventories.json");
+3 -3
View File
@@ -1,6 +1,6 @@
{ {
"name": "@clusterio/plugin-inventory_sync", "name": "@clusterio/plugin-inventory_sync",
"version": "2.0.0-alpha.11", "version": "2.0.0-alpha.12",
"description": "Clusterio plugin forwarding between Factorio servers", "description": "Clusterio plugin forwarding between Factorio servers",
"author": "Danielv <danielv@danielv.no>", "author": "Danielv <danielv@danielv.no>",
"homepage": "https://github.com/clusterio/factorioClusterio#readme", "homepage": "https://github.com/clusterio/factorioClusterio#readme",
@@ -23,8 +23,8 @@
"fs-extra": "^8.1.0" "fs-extra": "^8.1.0"
}, },
"devDependencies": { "devDependencies": {
"@clusterio/lib": "^2.0.0-alpha.11", "@clusterio/lib": "^2.0.0-alpha.12",
"@clusterio/web_ui": "^2.0.0-alpha.11", "@clusterio/web_ui": "^2.0.0-alpha.12",
"antd": "^4.16.0", "antd": "^4.16.0",
"react": "^16.13.1", "react": "^16.13.1",
"react-dom": "^16.13.1", "react-dom": "^16.13.1",
-1
View File
@@ -3,7 +3,6 @@
*/ */
"use strict"; "use strict";
const libPlugin = require("@clusterio/lib/plugin"); const libPlugin = require("@clusterio/lib/plugin");
const libLuaTools = require("@clusterio/lib/lua_tools");
class InstancePlugin extends libPlugin.BaseInstancePlugin { class InstancePlugin extends libPlugin.BaseInstancePlugin {
+1 -1
View File
@@ -78,7 +78,7 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
return; return;
} }
for (let [player, entry] of this.players) { for (let entry of this.players.values()) {
if (entry.playerCode === playerCode && entry.expires > Date.now()) { if (entry.playerCode === playerCode && entry.expires > Date.now()) {
let verifyCode = await generateCode(this.master.config.get("player_auth.code_length")); let verifyCode = await generateCode(this.master.config.get("player_auth.code_length"));
let secret = Buffer.from(this.master.config.get("master.auth_secret"), "base64"); let secret = Buffer.from(this.master.config.get("master.auth_secret"), "base64");
+3 -3
View File
@@ -1,6 +1,6 @@
{ {
"name": "@clusterio/plugin-player_auth", "name": "@clusterio/plugin-player_auth",
"version": "2.0.0-alpha.11", "version": "2.0.0-alpha.12",
"description": "Clusterio plugin authenticating logged in players to the web interface", "description": "Clusterio plugin authenticating logged in players to the web interface",
"author": "Hornwitser <github@hornwitser.no>", "author": "Hornwitser <github@hornwitser.no>",
"homepage": "https://github.com/clusterio/clusterio#readme", "homepage": "https://github.com/clusterio/clusterio#readme",
@@ -24,8 +24,8 @@
"jsonwebtoken": "^8.2.1" "jsonwebtoken": "^8.2.1"
}, },
"devDependencies": { "devDependencies": {
"@clusterio/lib": "^2.0.0-alpha.11", "@clusterio/lib": "^2.0.0-alpha.12",
"@clusterio/web_ui": "^2.0.0-alpha.11", "@clusterio/web_ui": "^2.0.0-alpha.12",
"antd": "^4.16.0", "antd": "^4.16.0",
"phin": "^3.5.1", "phin": "^3.5.1",
"react": "^16.13.1", "react": "^16.13.1",
+1 -1
View File
@@ -1,7 +1,7 @@
import React, { useEffect, useState } from "react"; import React, { useEffect, useState } from "react";
import { libPlugin } from "@clusterio/lib"; import { libPlugin } from "@clusterio/lib";
import { notify, notifyErrorHandler } from "@clusterio/web_ui"; import { notifyErrorHandler } from "@clusterio/web_ui";
import { Button, Form, Input, Spin, Typography } from "antd"; import { Button, Form, Input, Spin, Typography } from "antd";
import "./index.css"; import "./index.css";
+1 -1
View File
@@ -43,7 +43,7 @@ class InstancePlugin extends libPlugin.BaseInstancePlugin {
if (!this.syncStarted || !["starting", "running"].includes(this.instance.status)) { if (!this.syncStarted || !["starting", "running"].includes(this.instance.status)) {
return; return;
} }
let { name, level, researched } = message.data; let { name, level } = message.data;
await this.sendOrderedRcon( await this.sendOrderedRcon(
`/sc research_sync.research_technology("${libLuaTools.escapeString(name)}", ${level})`, true `/sc research_sync.research_technology("${libLuaTools.escapeString(name)}", ${level})`, true
); );
+3 -3
View File
@@ -1,6 +1,6 @@
{ {
"name": "@clusterio/plugin-research_sync", "name": "@clusterio/plugin-research_sync",
"version": "2.0.0-alpha.11", "version": "2.0.0-alpha.12",
"description": "Clusterio plugin for synchronizing research between Factorio servers", "description": "Clusterio plugin for synchronizing research between Factorio servers",
"author": "Hornwitser <github@hornwitser.no>", "author": "Hornwitser <github@hornwitser.no>",
"homepage": "https://github.com/clusterio/clusterio#readme", "homepage": "https://github.com/clusterio/clusterio#readme",
@@ -23,8 +23,8 @@
"fs-extra": "^8.1.0" "fs-extra": "^8.1.0"
}, },
"devDependencies": { "devDependencies": {
"@clusterio/lib": "^2.0.0-alpha.11", "@clusterio/lib": "^2.0.0-alpha.12",
"@clusterio/web_ui": "^2.0.0-alpha.11", "@clusterio/web_ui": "^2.0.0-alpha.12",
"webpack": "^5.36.2", "webpack": "^5.36.2",
"webpack-cli": "^4.7.0", "webpack-cli": "^4.7.0",
"webpack-merge": "^5.2.0" "webpack-merge": "^5.2.0"
+3 -3
View File
@@ -1,6 +1,6 @@
{ {
"name": "@clusterio/plugin-statistics_exporter", "name": "@clusterio/plugin-statistics_exporter",
"version": "2.0.0-alpha.11", "version": "2.0.0-alpha.12",
"description": "Clusterio plugin for gathering statistics from Factorio servers", "description": "Clusterio plugin for gathering statistics from Factorio servers",
"author": "Hornwitser <github@hornwitser.no>", "author": "Hornwitser <github@hornwitser.no>",
"homepage": "https://github.com/clusterio/clusterio#readme", "homepage": "https://github.com/clusterio/clusterio#readme",
@@ -20,8 +20,8 @@
"@clusterio/lib": "^2.0.0-alpha.0" "@clusterio/lib": "^2.0.0-alpha.0"
}, },
"devDependencies": { "devDependencies": {
"@clusterio/lib": "^2.0.0-alpha.11", "@clusterio/lib": "^2.0.0-alpha.12",
"@clusterio/web_ui": "^2.0.0-alpha.11", "@clusterio/web_ui": "^2.0.0-alpha.12",
"webpack": "^5.36.2", "webpack": "^5.36.2",
"webpack-cli": "^4.7.0", "webpack-cli": "^4.7.0",
"webpack-merge": "^5.2.0" "webpack-merge": "^5.2.0"
+3 -5
View File
@@ -62,7 +62,6 @@ function dose(numreq, instore, store_last_tick, dole, carry, prev_req, numreq_to
debt, debt,
]; // 5..12 ]; // 5..12
let inputs = inp1.concat(inp2); let inputs = inp1.concat(inp2);
let internal = new Array(20).fill(0);
let outputs = [0, 0, 0, 0]; let outputs = [0, 0, 0, 0];
// NN: Please don't touch :), code is generated // NN: Please don't touch :), code is generated
@@ -78,7 +77,7 @@ function dose(numreq, instore, store_last_tick, dole, carry, prev_req, numreq_to
outputs[0]=1.0; outputs[0]=1.0;
} }
let res1 = Number(outputs[0]) * numreq+outputs[3] + debt; let res1 = Number(outputs[0]) * numreq + outputs[3] + debt;
let res_capped = Math.round(res1); let res_capped = Math.round(res1);
if (res_capped > numreq) { res_capped = numreq; } if (res_capped > numreq) { res_capped = numreq; }
@@ -88,7 +87,7 @@ function dose(numreq, instore, store_last_tick, dole, carry, prev_req, numreq_to
res1 = res1 || 0; res1 = res1 || 0;
res_capped = res_capped || 0; // Safeguard against wrong values res_capped = res_capped || 0; // Safeguard against wrong values
debt = res1 - res_capped; debt = res1 - res_capped;
debt_cap = Math.round(numreq * 1.5) + 5; let debt_cap = Math.round(numreq * 1.5) + 5;
if (debt > debt_cap) { if (debt > debt_cap) {
debt = debt_cap; debt = debt_cap;
} }
@@ -129,7 +128,6 @@ function tick(instore, dole, store_last_tick, numreq_total_adj) {
store_last_tick, store_last_tick,
numreq_total_adj, numreq_total_adj,
]; ];
let internal = new Array(10).fill(0);
let outputs = [0, 0]; let outputs = [0, 0];
// NN: Please don't touch :), code is generated // NN: Please don't touch :), code is generated
@@ -139,7 +137,7 @@ function tick(instore, dole, store_last_tick, numreq_total_adj) {
outputs[1] = outputs[0] * 1.828422785; outputs[1] = outputs[0] * 1.828422785;
outputs[1] = sigmoid3(outputs[1]); outputs[1] = sigmoid3(outputs[1]);
avg = outputs[1]; let avg = outputs[1];
if (numreq_total_adj < 0.11) { if (numreq_total_adj < 0.11) {
// When no item's are requested, result is 0.1; In that case there is // When no item's are requested, result is 0.1; In that case there is
// no deficit, so return 1 = 100% demand fulfilled // no deficit, so return 1 = 100% demand fulfilled
-2
View File
@@ -1,6 +1,4 @@
"use strict"; "use strict";
const fs = require("fs-extra");
const libPlugin = require("@clusterio/lib/plugin"); const libPlugin = require("@clusterio/lib/plugin");
const libLuaTools = require("@clusterio/lib/lua_tools"); const libLuaTools = require("@clusterio/lib/lua_tools");
+3 -3
View File
@@ -1,6 +1,6 @@
{ {
"name": "@clusterio/plugin-subspace_storage", "name": "@clusterio/plugin-subspace_storage",
"version": "2.0.0-alpha.11", "version": "2.0.0-alpha.12",
"description": "Clusterio plugin for sharing storage between Factorio servers", "description": "Clusterio plugin for sharing storage between Factorio servers",
"author": "Hornwitser <github@hornwitser.no>", "author": "Hornwitser <github@hornwitser.no>",
"homepage": "https://github.com/clusterio/clusterio#readme", "homepage": "https://github.com/clusterio/clusterio#readme",
@@ -23,8 +23,8 @@
"fs-extra": "^8.1.0" "fs-extra": "^8.1.0"
}, },
"devDependencies": { "devDependencies": {
"@clusterio/lib": "^2.0.0-alpha.11", "@clusterio/lib": "^2.0.0-alpha.12",
"@clusterio/web_ui": "^2.0.0-alpha.11", "@clusterio/web_ui": "^2.0.0-alpha.12",
"antd": "^4.16.0", "antd": "^4.16.0",
"react": "^16.13.1", "react": "^16.13.1",
"react-dom": "^16.13.1", "react-dom": "^16.13.1",
-3
View File
@@ -1,7 +1,4 @@
"use strict"; "use strict";
const path = require("path");
function addApiRoutes(app, items, endpointHitCounter) { function addApiRoutes(app, items, endpointHitCounter) {
/** /**
+242 -33
View File
@@ -3,9 +3,11 @@ const assert = require("assert").strict;
const fs = require("fs-extra"); const fs = require("fs-extra");
const path = require("path"); const path = require("path");
const events = require("events"); const events = require("events");
const phin = require("phin");
const libLink = require("@clusterio/lib/link"); const libLink = require("@clusterio/lib/link");
const libUsers = require("@clusterio/lib/users"); const libUsers = require("@clusterio/lib/users");
const { wait } = require("@clusterio/lib/helpers");
const testStrings = require("../lib/factorio/test_strings"); const testStrings = require("../lib/factorio/test_strings");
const { const {
@@ -24,6 +26,24 @@ async function checkInstanceStatus(id, status) {
assert.equal(instances.get(44).status, status, "incorrect instance status"); assert.equal(instances.get(44).status, status, "incorrect instance status");
} }
async function uploadSave(instanceId, name, content) {
return await phin({
url: `https://localhost:4443/api/upload-save?instance_id=${instanceId}&filename=${name}`,
method: "POST",
core: { rejectUnauthorized: false },
headers: {
"X-Access-Token": controlToken,
"Content-Type": "application/zip",
"Content-Length": String(content.length),
},
data: content,
});
}
async function deleteSave(instanceId, save) {
await libLink.messages.deleteSave.send(getControl(), { instance_id: instanceId, save });
}
describe("Integration of Clusterio", function() { describe("Integration of Clusterio", function() {
describe("clusteriomaster", function() { describe("clusteriomaster", function() {
describe("bootstrap generate-user-token", function() { describe("bootstrap generate-user-token", function() {
@@ -114,10 +134,14 @@ describe("Integration of Clusterio", function() {
let config = "alt-slave-config.json"; let config = "alt-slave-config.json";
let configPath = path.join("temp", "test", config); let configPath = path.join("temp", "test", config);
await fs.remove(configPath); await fs.remove(configPath);
await fs.remove(path.join("temp", "test", "alt-instances"));
await execCtl(`slave create-config --id 5 --name alt-slave --generate-token --output ${config}`); await execCtl(`slave create-config --id 5 --name alt-slave --generate-token --output ${config}`);
await exec( await exec(
`node ../../packages/slave --config ${config} config set slave.tls_ca ../../test/file/tls/cert.pem` `node ../../packages/slave --config ${config} config set slave.tls_ca ../../test/file/tls/cert.pem`
); );
await exec(
`node ../../packages/slave --config ${config} config set slave.instances_directory alt-instances`
);
let slaveProcess; let slaveProcess;
try { try {
@@ -249,10 +273,11 @@ describe("Integration of Clusterio", function() {
}); });
}); });
describe("instance create-save", function() { describe("instance save create", function() {
it("creates a save", async function() { it("creates a save", async function() {
slowTest(this); slowTest(this);
await execCtl("instance create-save test"); getControl().saveListUpdates = [];
await execCtl("instance save create test");
await checkInstanceStatus(44, "stopped"); await checkInstanceStatus(44, "stopped");
}); });
}); });
@@ -264,10 +289,10 @@ describe("Integration of Clusterio", function() {
}); });
}); });
describe("instance list-saves", function() { describe("instance save list", function() {
it("lists the created save", async function() { it("lists the created save", async function() {
slowTest(this); slowTest(this);
let result = await execCtl("instance list-saves test"); let result = await execCtl("instance save list test");
assert(/world\.zip/.test(result.stdout), "world.zip not present in list save output"); assert(/world\.zip/.test(result.stdout), "world.zip not present in list save output");
}); });
}); });
@@ -325,8 +350,32 @@ describe("Integration of Clusterio", function() {
describe("instance send-rcon", function() { describe("instance send-rcon", function() {
it("sends the command", async function() { it("sends the command", async function() {
slowTest(this); slowTest(this);
await execCtl("instance send-rcon test test"); await execCtl("instance send-rcon test technobabble");
// TODO check that the command was received let { log } = await libLink.messages.queryLog.send(getControl(), {
all: false,
master: false,
slave_ids: [],
instance_ids: [44],
max_level: null,
limit: 10,
order: "desc",
});
assert(log.some(info => /technobabble/.test(info.message)), "Command was not sent");
});
it("should trigger saveListUpdate on save", async function() {
slowTest(this);
getControl().saveListUpdates = [];
await execCtl("instance send-rcon test /server-save");
let received = false;
for (let x = 0; x < 10; x++) {
if (getControl().saveListUpdates.length) {
received = true;
break;
}
await wait(100);
}
assert(received, "saveListUpdate not sent");
}); });
}); });
@@ -481,29 +530,33 @@ describe("Integration of Clusterio", function() {
await execCtl("instance config set 44 research_sync.load_plugin false"); await execCtl("instance config set 44 research_sync.load_plugin false");
await execCtl("instance config set 44 statistics_exporter.load_plugin false"); await execCtl("instance config set 44 statistics_exporter.load_plugin false");
await execCtl("instance config set 44 subspace_storage.load_plugin false"); await execCtl("instance config set 44 subspace_storage.load_plugin false");
try {
let exchangeString = testStrings.modified.replace(/[\n\r]+/g, "");
let args = `base/freeplay --seed 1234 --map-exchange-string "${exchangeString}"`;
await execCtl(`instance load-scenario test ${args}`);
await checkInstanceStatus(44, "running");
await sendRcon(44, '/c game.print("disable achievements")');
await sendRcon(44, '/c game.print("disable achievements")');
assert.equal(await sendRcon(44, "/c rcon.print(game.default_map_gen_settings.seed)"), "1234\n");
assert.equal(await sendRcon(44, "/c rcon.print(game.map_settings.pollution.ageing)"), "1.5\n");
assert.equal(
await sendRcon(44, "/c rcon.print(game.difficulty_settings.research_queue_setting)"), "never\n"
);
} finally { let exchangeString = testStrings.modified.replace(/[\n\r]+/g, "");
await execCtl("instance stop test"); let args = `base/freeplay --seed 1234 --map-exchange-string "${exchangeString}"`;
} await execCtl(`instance load-scenario test ${args}`);
await checkInstanceStatus(44, "running");
await sendRcon(44, '/c game.print("disable achievements")');
await sendRcon(44, '/c game.print("disable achievements")');
assert.equal(await sendRcon(44, "/c rcon.print(game.default_map_gen_settings.seed)"), "1234\n");
assert.equal(await sendRcon(44, "/c rcon.print(game.map_settings.pollution.ageing)"), "1.5\n");
assert.equal(
await sendRcon(44, "/c rcon.print(game.difficulty_settings.research_queue_setting)"), "never\n"
);
}); });
}); });
describe("instance upload-save", function() { describe("instance kill", function() {
it("kills the instance", async function() {
slowTest(this);
await execCtl("instance kill test");
await checkInstanceStatus(44, "stopped");
});
});
describe("instance save upload", function() {
it("should upload a zip file", async function() { it("should upload a zip file", async function() {
await fs.outputFile(path.join("temp", "test", "upload.zip"), "a test"); await fs.outputFile(path.join("temp", "test", "upload.zip"), "a test");
await execCtl("instance upload-save 44 upload.zip"); await execCtl("instance save upload 44 upload.zip");
assert( assert(
await fs.pathExists(path.join("temp", "test", "instances", "test", "saves", "upload.zip")), await fs.pathExists(path.join("temp", "test", "instances", "test", "saves", "upload.zip")),
"file not uploaded to saves directory" "file not uploaded to saves directory"
@@ -511,42 +564,198 @@ describe("Integration of Clusterio", function() {
}); });
it("should reject non-zip files", async function() { it("should reject non-zip files", async function() {
await fs.outputFile(path.join("temp", "test", "invalid"), "a test"); await fs.outputFile(path.join("temp", "test", "invalid"), "a test");
await assert.rejects(execCtl("instance upload-save 44 invalid")); await assert.rejects(execCtl("instance save upload 44 invalid"));
}); });
it("should reject path traversal attacks", async function() { it("should reject path traversal attacks", async function() {
await fs.outputFile(path.join("temp", "test", "upload.zip"), "a test"); await fs.outputFile(path.join("temp", "test", "upload.zip"), "a test");
await assert.rejects(execCtl("instance upload-save 44 upload.zip --name ../traversal.zip")); await assert.rejects(execCtl("instance save upload 44 upload.zip --name ../traversal.zip"));
}); });
}); });
describe("instance download-save", function() { describe("instance save download", function() {
it("should download a save", async function() { it("should download a save", async function() {
await fs.remove(path.join("temp", "test", "upload.zip")); await fs.remove(path.join("temp", "test", "upload.zip"));
await execCtl("instance download-save 44 upload.zip"); await execCtl("instance save download 44 upload.zip");
assert(await fs.pathExists(path.join("temp", "test", "upload.zip"))); assert(await fs.pathExists(path.join("temp", "test", "upload.zip")));
}); });
it("should error if save does not exist", async function() { it("should error if save does not exist", async function() {
await assert.rejects(execCtl("instance download-save 44 invalid")); await assert.rejects(execCtl("instance save download 44 invalid"));
}); });
it("should error on path traversal attacks", async function() { it("should error on path traversal attacks", async function() {
await assert.rejects(execCtl("instance download-save 44 ../factorio-current.log")); await assert.rejects(execCtl("instance save download 44 ../factorio-current.log"));
}); });
}); });
describe("instance delete-save", function() { describe("instance save copy", function() {
it("copy a save file", async function() {
await execCtl("instance save copy 44 upload.zip copy.zip");
assert(await fs.pathExists(path.join("temp", "test", "instances", "test", "saves", "copy.zip")));
});
it("should error if destination exist", async function() {
await assert.rejects(execCtl("instance save copy 44 upload.zip copy.zip"));
});
it("should error if source does not exist", async function() {
await assert.rejects(execCtl("instance save copy 44 not-here.zip invalid.zip"));
});
it("should reject path traversal attacks", async function() {
await assert.rejects(execCtl("instance save copy 44 upload.zip ../traversal.zip"));
await assert.rejects(execCtl("instance save copy 44 ../saves/upload.zip traversal.zip "));
});
});
describe("instance save rename", function() {
it("rename a save file", async function() {
await execCtl("instance save rename 44 copy.zip rename.zip");
assert(!await fs.pathExists(path.join("temp", "test", "instances", "test", "saves", "copy.zip")));
assert(await fs.pathExists(path.join("temp", "test", "instances", "test", "saves", "rename.zip")));
});
it("should error if new name exist", async function() {
await assert.rejects(execCtl("instance save rename 44 upload.zip rename.zip"));
});
it("should error if old name does not exist", async function() {
await assert.rejects(execCtl("instance save rename 44 not-here.zip invalid.zip"));
});
it("should reject path traversal attacks", async function() {
await assert.rejects(execCtl("instance save rename 44 upload.zip ../traversal.zip"));
await assert.rejects(execCtl("instance save rename 44 ../saves/upload.zip traversal.zip "));
});
});
describe("instance save transfer", function() {
before(async function() {
slowTest(this);
await execCtl("instance create spam --id 66");
await execCtl("instance assign spam 4");
await execCtl("instance create unassign --id 77");
});
after(async function() {
await execCtl("instance delete spam");
});
for (let remote of [false, true]) {
let pri = 44;
let sec = remote ? 99 : 66;
let priSaves = path.join("temp", "test", "instances", "test", "saves");
let secSaves = remote
? path.join("temp", "test", "alt-instances", "alt-test", "saves")
: path.join("temp", "test", "instances", "spam", "saves")
;
describe(remote ? "remote" : "local", function() {
if (remote) {
let slaveProcess;
before(async function() {
// On windows there's currently no way to automate graceful shutdown of the slave
// process as CTRL+C is some weird terminal thing and SIGINT isn't a thing.
if (process.platform === "win32") {
this.skip();
}
slowTest(this);
// Reuse from the clusterioslave test
let config = "alt-slave-config.json";
slaveProcess = await spawn(
"alt-slave:", `node ../../packages/slave run --config ${config}`, /Started slave/
);
});
after(async function() {
if (slaveProcess) {
slaveProcess.kill("SIGINT");
await events.once(slaveProcess, "exit");
}
});
}
it("should transfers a save", async function() {
await uploadSave(pri, "transfer.zip", "transfer.zip");
await execCtl(`instance save transfer ${pri} transfer.zip ${sec}`);
assert(!await fs.pathExists(path.join(priSaves, "transfer.zip")), "save still at pri");
assert(await fs.pathExists(path.join(secSaves, "transfer.zip")), "save not at sec");
await deleteSave(sec, "transfer.zip");
});
it("should support rename", async function() {
await uploadSave(pri, "transfer.zip", "transfer.zip");
await execCtl(`instance save transfer ${pri} transfer.zip ${sec} rename.zip`);
assert(!await fs.pathExists(path.join(priSaves, "transfer.zip")), "save still at pri");
assert(await fs.pathExists(path.join(secSaves, "rename.zip")), "save not at sec");
await deleteSave(sec, "rename.zip");
});
it("should auto-rename if target exists", async function() {
await uploadSave(pri, "transfer.zip", "transfer.zip");
await uploadSave(sec, "transfer.zip", "transfer.zip");
await execCtl(`instance save transfer ${pri} transfer.zip ${sec}`);
assert(!await fs.pathExists(path.join(priSaves, "transfer.zip")), "save still at pri");
assert(await fs.pathExists(path.join(secSaves, "transfer-2.zip")), "save not at sec");
await deleteSave(sec, "transfer.zip");
await deleteSave(sec, "transfer-2.zip");
});
it("should copy when using --copy", async function() {
await uploadSave(pri, "transfer.zip", "transfer.zip");
await execCtl(`instance save transfer ${pri} transfer.zip ${sec} --copy`);
assert(await fs.pathExists(path.join(priSaves, "transfer.zip")), "save not at pri");
assert(await fs.pathExists(path.join(secSaves, "transfer.zip")), "save not at sec");
await deleteSave(pri, "transfer.zip");
await deleteSave(sec, "transfer.zip");
});
it("should fail if save does not exist", async function() {
await assert.rejects(execCtl(`instance save transfer ${pri} not-here.zip ${sec}`));
});
it("should fail if source save name is invalid", async function() {
await assert.rejects(execCtl(`instance save transfer ${pri} nul 111`));
});
it("should fail if target save name is invalid", async function() {
await uploadSave(pri, "transfer.zip", "transfer.zip");
await assert.rejects(execCtl(`instance save transfer ${pri} transfer.zip 111 nul`));
await deleteSave(pri, "transfer.zip");
});
it("should reject path traversal of source save", async function() {
await assert.rejects(execCtl(`instance save transfer ${pri} ../saves/transfer.zip 111`));
});
it("should reject path traversal of target save", async function() {
await uploadSave(pri, "transfer.zip", "transfer.zip");
await assert.rejects(
execCtl(`instance save transfer ${pri} transfer.zip 111 ../saves/transfer.zip`)
);
await deleteSave(pri, "transfer.zip");
});
if (!remote) {
it("should fail if source and target instance is the same instance", async function() {
await uploadSave(pri, "transfer.zip", "transfer.zip");
await assert.rejects(execCtl(`instance save transfer ${pri} transfer.zip ${pri}`));
await deleteSave(pri, "transfer.zip");
});
it("should fail if source instance does not exist", async function() {
await assert.rejects(execCtl(`instance save transfer 111 not-here.zip ${sec}`));
});
it("should fail if target instance does not exist", async function() {
await uploadSave(pri, "transfer.zip", "transfer.zip");
await assert.rejects(execCtl(`instance save transfer ${pri} transfer.zip 111`));
await deleteSave(pri, "transfer.zip");
});
it("should fail if source instance is not assigned", async function() {
await assert.rejects(execCtl(`instance save transfer 77 transfer.zip ${pri}`));
});
it("should fail if target instance is not assigned", async function() {
await uploadSave(pri, "transfer.zip", "transfer.zip");
await assert.rejects(execCtl(`instance save transfer ${pri} transfer.zip 77`));
await deleteSave(pri, "transfer.zip");
});
}
});
}
});
describe("instance save delete", function() {
it("should delete a save", async function() { it("should delete a save", async function() {
await execCtl("instance delete-save 44 upload.zip"); await execCtl("instance save delete 44 upload.zip");
assert( assert(
!await fs.pathExists(path.join("temp", "test", "instances", "test", "saves", "upload.zip")), !await fs.pathExists(path.join("temp", "test", "instances", "test", "saves", "upload.zip")),
"file not deleted" "file not deleted"
); );
}); });
it("should error if save does not exist", async function() { it("should error if save does not exist", async function() {
await assert.rejects(execCtl("instance delete-save 44 upload.zip")); await assert.rejects(execCtl("instance save delete 44 upload.zip"));
}); });
it("should error on path traversal attacks", async function() { it("should error on path traversal attacks", async function() {
await fs.outputFile(path.join("temp", "test", "upload.zip"), "a test"); await fs.outputFile(path.join("temp", "test", "upload.zip"), "a test");
await assert.rejects(execCtl("instance delete-save 44 ../../upload.zip")); await assert.rejects(execCtl("instance save delete 44 ../../upload.zip"));
}); });
}); });
+2 -1
View File
@@ -109,7 +109,8 @@ let slaveConfigPath = path.join("temp", "test", "config-slave.json");
let controlConfigPath = path.join("temp", "test", "config-control.json"); let controlConfigPath = path.join("temp", "test", "config-control.json");
async function exec(command, options = {}) { async function exec(command, options = {}) {
console.log(command); // Uncomment to show commands run in tests
// console.log(command);
options = { cwd: path.join("temp", "test"), ...options }; options = { cwd: path.join("temp", "test"), ...options };
return await util.promisify(child_process.exec)(command, options); return await util.promisify(child_process.exec)(command, options);
} }
+2
View File
@@ -62,6 +62,8 @@ describe("lib/plugin", function() {
}); });
it("should define defaults for hooks", async function() { it("should define defaults for hooks", async function() {
await masterPlugin.onInstanceStatusChanged({}, "running", "initialized"); await masterPlugin.onInstanceStatusChanged({}, "running", "initialized");
await masterPlugin.onMasterConfigFieldChanged({}, "foo", null);
await masterPlugin.onInstanceConfigFieldChanged({}, {}, "foo", null);
await masterPlugin.onMetrics(); await masterPlugin.onMetrics();
await masterPlugin.onShutdown(); await masterPlugin.onShutdown();
masterPlugin.onSlaveConnectionEvent({}, "connect"); masterPlugin.onSlaveConnectionEvent({}, "connect");