Port ctl package to TypeScript

This commit is contained in:
Hornwitser committed 2023-08-12 20:36:33 +02:00
1 parent 5ec7c9f99c
commit ec0fded0cc
6 files changed
+383 -244

No files matched your search

+64 -61
View File
@@ -4,18 +4,18 @@
* Command line interface for controlling a Clusterio cluster * Command line interface for controlling a Clusterio cluster
* @module ctl/ctl * @module ctl/ctl
*/ */
"use strict"; import fs from "fs-extra";
const fs = require("fs-extra"); import yargs from "yargs";
const yargs = require("yargs"); import { version } from "./package.json";
const version = require("./package").version; import setBlocking from "set-blocking";
const setBlocking = require("set-blocking"); import { strict as assert } from "assert";
// Reduce startup time by lazy compiling schemas. // Reduce startup time by lazy compiling schemas.
global.lazySchemaCompilation = true; (global as any).lazySchemaCompilation = true;
const lib = require("@clusterio/lib"); import * as lib from "@clusterio/lib";
const { ConsoleTransport, levels, logger } = lib; import { ConsoleTransport, levels, logger } from "@clusterio/lib";
const commands = require("./src/commands"); import * as commands from "./src/commands";
/** /**
@@ -23,7 +23,9 @@ const commands = require("./src/commands");
* @private * @private
*/ */
class ControlConnector extends lib.WebSocketClientConnector { class ControlConnector extends lib.WebSocketClientConnector {
constructor(url, maxReconnectDelay, tlsCa, token) { private _token: string;
constructor(url: string, maxReconnectDelay: number, tlsCa: string | undefined, token: string) {
super(url, maxReconnectDelay, tlsCa); super(url, maxReconnectDelay, tlsCa);
this._token = token; this._token = token;
} }
@@ -48,32 +50,27 @@ class ControlConnector extends lib.WebSocketClientConnector {
* Connects to the controller over WebSocket and sends commands to it. * Connects to the controller over WebSocket and sends commands to it.
* @static * @static
*/ */
class Control extends lib.Link { export class Control extends lib.Link {
constructor(connector, controlConfig, tlsCa, controlPlugins) { /** Control config used for connecting to the controller. */
config: lib.ControlConfig;
/** Certificate authority used to validate TLS connections to the controller. */
tlsCa?: string;
/** Mapping of plugin names to their instance for loaded plugins. */
plugins: Map<string, lib.BaseControlPlugin>;
/** Keep the control connection alive after the command completes. */
keepOpen = false;
constructor(
connector: ControlConnector,
controlConfig: lib.ControlConfig,
tlsCa: string | undefined,
controlPlugins: Map<string, lib.BaseControlPlugin>
) {
super(connector); super(connector);
/**
* Control config used for connecting to the controller.
* @type {module:lib.ControlConfig}
*/
this.config = controlConfig; this.config = controlConfig;
/**
* Certificate authority used to validate TLS connections to the controller.
* @type {?string}
*/
this.tlsCa = tlsCa; this.tlsCa = tlsCa;
/**
* Mapping of plugin names to their instance for loaded plugins.
* @type {Map<string, module:lib.BaseControlPlugin>}
*/
this.plugins = controlPlugins; this.plugins = controlPlugins;
/**
* Keep the control connection alive after the command completes.
* @type {boolean}
*/
this.keepOpen = false;
this.handle(lib.LogMessageEvent, this.handleLogMessageEvent.bind(this)); this.handle(lib.LogMessageEvent, this.handleLogMessageEvent.bind(this));
this.handle(lib.DebugWsMessageEvent, this.handleDebugWsMessageEvent.bind(this)); this.handle(lib.DebugWsMessageEvent, this.handleDebugWsMessageEvent.bind(this));
} }
@@ -81,9 +78,9 @@ class Control extends lib.Link {
async setLogSubscriptions({ async setLogSubscriptions({
all = false, all = false,
controller = false, controller = false,
hostIds = [], hostIds = [] as number[],
instanceIds = [], instanceIds = [] as number[],
maxLevel = undefined, maxLevel = undefined as keyof typeof levels | undefined,
}) { }) {
await this.send( await this.send(
new lib.LogSetSubscriptionsRequest( new lib.LogSetSubscriptionsRequest(
@@ -92,18 +89,18 @@ class Control extends lib.Link {
); );
} }
async handleLogMessageEvent(event) { async handleLogMessageEvent(event: lib.LogMessageEvent) {
logger.log(event.info); logger.log(event.info as any);
} }
async handleDebugWsMessageEvent(event) { async handleDebugWsMessageEvent(event: lib.DebugWsMessageEvent) {
// eslint-disable-next-line no-console // eslint-disable-next-line no-console
console.log("WS", event.direction, event.content); console.log("WS", event.direction, event.content);
} }
async shutdown() { async shutdown() {
try { try {
await this.connector.disconnect(); await (this.connector as ControlConnector).disconnect();
} catch (err) { } catch (err) {
if (!(err instanceof lib.SessionLost)) { if (!(err instanceof lib.SessionLost)) {
throw err; throw err;
@@ -112,13 +109,13 @@ class Control extends lib.Link {
} }
} }
async function loadPlugins(pluginList) { async function loadPlugins(pluginList: Map<string, string>) {
let pluginInfos = await lib.loadPluginInfos(pluginList); let pluginInfos = await lib.loadPluginInfos(pluginList);
lib.registerPluginMessages(pluginInfos); lib.registerPluginMessages(pluginInfos);
lib.registerPluginConfigGroups(pluginInfos); lib.registerPluginConfigGroups(pluginInfos);
lib.finalizeConfigs(); lib.finalizeConfigs();
let controlPlugins = new Map(); let controlPlugins = new Map<string, lib.BaseControlPlugin>();
for (let pluginInfo of pluginInfos) { for (let pluginInfo of pluginInfos) {
if (!pluginInfo.controlEntrypoint) { if (!pluginInfo.controlEntrypoint) {
continue; continue;
@@ -132,6 +129,15 @@ async function loadPlugins(pluginList) {
return controlPlugins; return controlPlugins;
} }
interface CtlArguments {
[index: string]: unknown;
$0: string,
_: (string | number)[],
logLevel: keyof typeof levels,
config: string,
pluginList: string,
}
async function startControl() { async function startControl() {
yargs yargs
.scriptName("clusterioctl") .scriptName("clusterioctl")
@@ -163,7 +169,7 @@ async function startControl() {
; ;
// Parse the args first to get the configured plugin list. // Parse the args first to get the configured plugin list.
let args = yargs.parse(); let args = yargs.parseSync() as CtlArguments;
// Log stream for the ctl session. // Log stream for the ctl session.
logger.add( logger.add(
@@ -173,13 +179,13 @@ async function startControl() {
format: new lib.TerminalFormat(), format: new lib.TerminalFormat(),
}) })
); );
lib.handleUnhandledErrors(logger); lib.handleUnhandledErrors();
logger.verbose(`Loading available plugins from ${args.pluginList}`); logger.verbose(`Loading available plugins from ${args.pluginList}`);
let pluginList = new Map(); let pluginList = new Map();
try { try {
pluginList = new Map(JSON.parse(await fs.readFile(args.pluginList))); pluginList = new Map(JSON.parse(await fs.readFile(args.pluginList, "utf8")));
} catch (err) { } catch (err: any) {
if (err.code !== "ENOENT") { if (err.code !== "ENOENT") {
throw err; throw err;
} }
@@ -201,15 +207,15 @@ async function startControl() {
args = yargs args = yargs
.help() .help()
.strict() .strict()
.parse() .parse() as CtlArguments
; ;
logger.verbose(`Loading config from ${args.config}`); logger.verbose(`Loading config from ${args.config}`);
let controlConfig = new lib.ControlConfig("control"); let controlConfig = new lib.ControlConfig("control");
try { try {
await controlConfig.load(JSON.parse(await fs.readFile(args.config))); await controlConfig.load(JSON.parse(await fs.readFile(args.config, "utf8")));
} catch (err) { } catch (err: any) {
if (err.code === "ENOENT") { if (err.code === "ENOENT") {
logger.verbose("Config not found, initializing new config"); logger.verbose("Config not found, initializing new config");
await controlConfig.init(); await controlConfig.init();
@@ -221,7 +227,7 @@ async function startControl() {
if (args._.length === 0) { if (args._.length === 0) {
yargs.showHelp(); yargs.showHelp();
yargs.exit(); yargs.exit(1, undefined as unknown as Error); // Type definition file is wrong.
} }
// Handle the control-config command before trying to connect. // Handle the control-config command before trying to connect.
@@ -231,11 +237,12 @@ async function startControl() {
} }
// Determine which command is being executed. // Determine which command is being executed.
let commandPath = [...args._]; let commandPath = [...args._] as string[];
let targetCommand = rootCommands; let targetCommand: lib.CommandTree | lib.Command = rootCommands;
while (commandPath.length && targetCommand instanceof lib.CommandTree) { while (commandPath.length && targetCommand instanceof lib.CommandTree) {
targetCommand = targetCommand.get(commandPath.shift()); targetCommand = targetCommand.get(commandPath.shift()!)!;
} }
assert(targetCommand instanceof lib.Command);
// The remaining commands require connecting to the controller. // The remaining commands require connecting to the controller.
if (!controlConfig.get("control.controller_url") || !controlConfig.get("control.controller_token")) { if (!controlConfig.get("control.controller_url") || !controlConfig.get("control.controller_token")) {
@@ -244,17 +251,17 @@ async function startControl() {
return; return;
} }
let tlsCa = null; let tlsCa: string | undefined;
let tlsCaPath = controlConfig.get("control.tls_ca"); let tlsCaPath = controlConfig.get("control.tls_ca") as string | null;
if (tlsCaPath) { if (tlsCaPath) {
tlsCa = await fs.readFile(tlsCaPath); tlsCa = await fs.readFile(tlsCaPath, "utf8");
} }
let controlConnector = new ControlConnector( let controlConnector = new ControlConnector(
controlConfig.get("control.controller_url"), controlConfig.get("control.controller_url") as string,
controlConfig.get("control.max_reconnect_delay"), controlConfig.get("control.max_reconnect_delay") as number,
tlsCa, tlsCa,
controlConfig.get("control.controller_token") controlConfig.get("control.controller_token") as string,
); );
let control = new Control(controlConnector, controlConfig, tlsCa, controlPlugins); let control = new Control(controlConnector, controlConfig, tlsCa, controlPlugins);
try { try {
@@ -304,10 +311,6 @@ async function startControl() {
} }
} }
module.exports = {
Control,
};
if (module === require.main) { if (module === require.main) {
// eslint-disable-next-line no-console // eslint-disable-next-line no-console
+10 -2
View File
@@ -4,12 +4,13 @@
"author": "Hornwitser", "author": "Hornwitser",
"license": "MIT", "license": "MIT",
"version": "2.0.0-alpha.13", "version": "2.0.0-alpha.13",
"main": "ctl.js", "main": "dist/ctl.js",
"scripts": { "scripts": {
"prepare": "tsc --build",
"test": "echo \"Error: no test specified\" && exit 1" "test": "echo \"Error: no test specified\" && exit 1"
}, },
"bin": { "bin": {
"clusterioctl": "./ctl.js" "clusterioctl": "./dist/ctl.js"
}, },
"keywords": [ "keywords": [
"factorio" "factorio"
@@ -28,5 +29,12 @@
}, },
"publishConfig": { "publishConfig": {
"access": "public" "access": "public"
},
"devDependencies": {
"@types/fs-extra": "^11.0.1",
"@types/node": "^20.4.5",
"@types/set-blocking": "^2.0.0",
"@types/yargs": "^17.0.24",
"typescript": "^5.1.6"
} }
} }
File diff suppressed because it is too large. Load diff
+19
View File
@@ -0,0 +1,19 @@
{
"include": ["package.json", "ctl.ts", "src/**/*.ts"],
"compilerOptions": {
"lib": ["es2023"],
"module": "commonjs",
"target": "es2022",
"rootDir": ".",
"outDir": "dist",
"composite": true,
"sourceMap": true,
"strict": true,
"alwaysStrict": true,
"allowJs": true,
"checkJs": false,
"resolveJsonModule": true,
"esModuleInterop": true,
"skipLibCheck": true
}
}
-8
View File
@@ -1,8 +0,0 @@
"use strict";
const assert = require("assert").strict;
const clusterioctl = require("@clusterio/ctl/ctl.js");
describe("clusterioctl", function() {
});
+1 -1
View File
@@ -821,7 +821,7 @@ describe("Integration of Clusterio", function() {
let modPacks = await getControl().send(new lib.ModPackListRequest()); let modPacks = await getControl().send(new lib.ModPackListRequest());
let modPack = modPacks.find(entry => entry.name === "full-pack"); let modPack = modPacks.find(entry => entry.name === "full-pack");
assert(modPack, "created mod pack not found"); assert(modPack, "created mod pack not found");
let reference = lib.ModPack.fromJSON({}); let reference = lib.ModPack.fromJSON({ factorio_version: "0.17.59" });
reference.id = modPack.id; reference.id = modPack.id;
reference.name = "full-pack"; reference.name = "full-pack";
reference.description = "Description"; reference.description = "Description";