Prefix clusterio/lib imports with lib

Use lib* prefix for the modules impored from the lib package to help
distinguish them more from ordinary variables.  Fix up the naming
convention for files to be consistently lowercase_underscore for
JavaScript files.
This commit is contained in:
Hornwitser committed 2020-10-23 21:22:43 +02:00
1 parent fbbaf3dd3a
commit 24397b75cc
55 files changed
+692 -668

No files matched your search

+8 -8
View File
@@ -7,8 +7,8 @@
* @module lib/command
*/
"use strict";
const link = require("@clusterio/lib/link");
const errors = require("@clusterio/lib/errors");
const libLink = require("@clusterio/lib/link");
const libErrors = require("@clusterio/lib/errors");
/**
* Represents a command that can be runned by clusterioctl
@@ -150,7 +150,7 @@ async function resolveSlave(client, slaveName) {
if (/^-?\d+$/.test(slaveName)) {
slaveId = parseInt(slaveName, 10);
} else {
let response = await link.messages.listSlaves.send(client);
let response = await libLink.messages.listSlaves.send(client);
for (let slave of response.list) {
if (slave.name === slaveName) {
slaveId = slave.id;
@@ -159,7 +159,7 @@ async function resolveSlave(client, slaveName) {
}
if (slaveId === undefined) {
throw new errors.CommandError(`No slave named ${slaveName}`);
throw new libErrors.CommandError(`No slave named ${slaveName}`);
}
}
@@ -182,7 +182,7 @@ async function resolveInstance(client, instanceName) {
if (/^-?\d+$/.test(instanceName)) {
instanceId = parseInt(instanceName, 10);
} else {
let response = await link.messages.listInstances.send(client);
let response = await libLink.messages.listInstances.send(client);
for (let instance of response.list) {
if (instance.name === instanceName) {
instanceId = instance.id;
@@ -191,7 +191,7 @@ async function resolveInstance(client, instanceName) {
}
if (instanceId === undefined) {
throw new errors.CommandError(`No instance named ${instanceName}`);
throw new libErrors.CommandError(`No instance named ${instanceName}`);
}
}
@@ -210,7 +210,7 @@ async function resolveInstance(client, instanceName) {
* @static
*/
async function retrieveRole(client, roleName) {
let response = await link.messages.listRoles.send(client);
let response = await libLink.messages.listRoles.send(client);
let resolvedRole;
if (/^-?\d+$/.test(roleName)) {
@@ -232,7 +232,7 @@ async function retrieveRole(client, roleName) {
}
if (!resolvedRole) {
throw new errors.CommandError(`No role named ${roleName}`);
throw new libErrors.CommandError(`No role named ${roleName}`);
}
return resolvedRole;
+2 -2
View File
@@ -6,7 +6,7 @@ const ini = require("ini");
const Jimp = require("jimp");
const JSZip = require("jszip");
const buildMod = require("@clusterio/lib/build_mod");
const libBuildMod = require("@clusterio/lib/build_mod");
/**
* Generate the export mod needed for exportData
@@ -29,7 +29,7 @@ async function generateExportMod(server) {
}
}
await buildMod.build({
await libBuildMod.build({
clean: false,
build: true,
pack: true,
+2 -2
View File
@@ -7,7 +7,7 @@ const jszip = require("jszip");
const path = require("path");
const semver = require("semver");
const hash = require("@clusterio/lib/hash");
const libHash = require("@clusterio/lib/hash");
const knownScenarios = {
@@ -225,7 +225,7 @@ async function patch(savePath, modules) {
// No info file present, try to detect if it's a known compatible scenario.
} else {
let controlStream = root.file("control.lua").nodeStream("nodebuffer");
let controlHash = await hash.hashStream(controlStream);
let controlHash = await libHash.hashStream(controlStream);
if (controlHash in knownScenarios) {
patchInfo = {
+2 -2
View File
@@ -9,7 +9,7 @@ const crypto = require("crypto");
const ini = require("ini");
const rconClient = require("rcon-client");
const errors = require("@clusterio/lib/errors");
const libErrors = require("@clusterio/lib/errors");
/**
@@ -705,7 +705,7 @@ class FactorioServer extends events.EventEmitter {
if (this._state !== "stopping") {
if (this._unexpected.length === 0) {
if (signal === "SIGKILL") {
this.emit("error", new errors.EnvironmentError(
this.emit("error", new libErrors.EnvironmentError(
"Factorio server was unexpectedly killed, is the system low on memory?"
));
-3
View File
@@ -1,3 +0,0 @@
"use strict";
const fileOps = require("./fileOps");
module.exports = fileOps;
@@ -1,5 +1,5 @@
/**
* @module lib/fileOps
* @module lib/file_ops
*/
"use strict";
const fs = require("fs-extra");
+7 -7
View File
@@ -3,8 +3,8 @@
const events = require("events");
const WebSocket = require("isomorphic-ws");
const schema = require("@clusterio/lib/schema");
const errors = require("@clusterio/lib/errors");
const libSchema = require("@clusterio/lib/schema");
const libErrors = require("@clusterio/lib/errors");
/**
@@ -60,10 +60,10 @@ class WebSocketBaseConnector extends events.EventEmitter {
}
_processHeartbeat(message) {
if (!schema.heartbeat(message)) {
if (!libSchema.heartbeat(message)) {
console.log("SOCKET | closing after received invalid heartbeat:", message);
this._socket.close(1002, "Invalid heartbeat");
console.log(schema.heartbeat.errors);
console.log(libSchema.heartbeat.errors);
return;
}
@@ -100,7 +100,7 @@ class WebSocketBaseConnector extends events.EventEmitter {
*/
send(type, data) {
if (!["handshake", "connected", "closing"].includes(this._state)) {
throw new errors.SessionLost("No session");
throw new libErrors.SessionLost("No session");
}
let message = { seq: this._seq, type, data };
this._sendBuffer.push(message);
@@ -287,7 +287,7 @@ class WebSocketClientConnector extends WebSocketBaseConnector {
console.log(`SOCKET | Close (code: ${event.code}, reason: ${event.reason})`);
// Authentication failed
if (event.code === 4003) {
this.emit("error", new errors.AuthenticationFailed(event.reason));
this.emit("error", new libErrors.AuthenticationFailed(event.reason));
this._state = "closing";
}
@@ -345,7 +345,7 @@ class WebSocketClientConnector extends WebSocketBaseConnector {
}
_processHandshake(message) {
if (!schema.serverHandshake(message)) {
if (!libSchema.serverHandshake(message)) {
console.log("SOCKET | closing after received invalid handshake:", message);
this._socket.close(1002, "Invalid handshake");
return;
+10 -10
View File
@@ -1,8 +1,8 @@
// Implementation of Link class
"use strict";
const schema = require("@clusterio/lib/schema");
const errors = require("@clusterio/lib/errors");
const libSchema = require("@clusterio/lib/schema");
const libErrors = require("@clusterio/lib/errors");
const messages = require("./messages");
// Some definitions for the terminology used here:
@@ -34,7 +34,7 @@ class Link {
try {
this.processMessage(payload);
} catch (err) {
if (err instanceof errors.InvalidMessage) {
if (err instanceof libErrors.InvalidMessage) {
console.error(`Invalid message on ${this.source}-${this.target} link: ${err.message}`);
if (err.errors) {
console.error(err.errors);
@@ -48,7 +48,7 @@ class Link {
connector.on("invalidate", () => {
for (let waiterType of this._waiters.values()) {
for (let waiter of waiterType) {
waiter.reject(new errors.SessionLost("Session Lost"));
waiter.reject(new libErrors.SessionLost("Session Lost"));
}
}
@@ -58,7 +58,7 @@ class Link {
connector.on("close", () => {
for (let waiterType of this._waiters.values()) {
for (let waiter of waiterType) {
waiter.reject(new errors.SessionLost("Session Closed"));
waiter.reject(new libErrors.SessionLost("Session Closed"));
}
}
@@ -78,17 +78,17 @@ class Link {
* handlers/waiters were invoked to handle the message.
*/
processMessage(message) {
if (!schema.message(message)) {
throw new errors.InvalidMessage("Malformed", schema.message.errors);
if (!libSchema.message(message)) {
throw new libErrors.InvalidMessage("Malformed", libSchema.message.errors);
}
let validator = this._validators.get(message.type);
if (!validator) {
throw new errors.InvalidMessage(`No validator for ${message.type} on ${this.source}-${this.target}`);
throw new libErrors.InvalidMessage(`No validator for ${message.type} on ${this.source}-${this.target}`);
}
if (!validator(message)) {
throw new errors.InvalidMessage(`Validation failed for ${message.type}`, validator.errors);
throw new libErrors.InvalidMessage(`Validation failed for ${message.type}`, validator.errors);
}
let hadHandlers = this._processHandler(message);
@@ -96,7 +96,7 @@ class Link {
if (!hadWaiters && !hadHandlers) {
// XXX console.error(`Unhandled message: ${JSON.stringify(message, null, 4)}`);
throw new errors.InvalidMessage(`Unhandled message ${message.type}`);
throw new libErrors.InvalidMessage(`Unhandled message ${message.type}`);
}
}
+7 -7
View File
@@ -1,7 +1,7 @@
// Message definitions for links
"use strict";
const schema = require("@clusterio/lib/schema");
const errors = require("@clusterio/lib/errors");
const libSchema = require("@clusterio/lib/schema");
const libErrors = require("@clusterio/lib/errors");
/**
* Represents a message that can be sent over the link
@@ -88,7 +88,7 @@ class Request extends Message {
throw new Error(`Invalid forwardTo value ${forwardTo}`);
}
this._requestValidator = schema.compile({
this._requestValidator = libSchema.compile({
$schema: "http://json-schema.org/draft-07/schema#",
properties: {
"type": { const: this.requestType },
@@ -100,7 +100,7 @@ class Request extends Message {
},
});
this._responseValidator = schema.compile({
this._responseValidator = libSchema.compile({
$schema: "http://json-schema.org/draft-07/schema#",
properties: {
"type": { const: this.responseType },
@@ -195,7 +195,7 @@ class Request extends Message {
link.connector.send(this.responseType, { ...response, seq: message.seq });
}).catch(err => {
if (!(err instanceof errors.RequestError)) {
if (!(err instanceof libErrors.RequestError)) {
console.error(`Unexpected error while responding to ${this.requestType}`, err);
}
link.connector.send(this.responseType, { seq: message.seq, error: err.message });
@@ -223,7 +223,7 @@ class Request extends Message {
let seq = link.connector.send(this.requestType, data);
let responseMessage = await link.waitFor(this.responseType, { seq });
if (responseMessage.data.error) {
throw new errors.RequestError(responseMessage.data.error);
throw new libErrors.RequestError(responseMessage.data.error);
}
return responseMessage.data;
}
@@ -702,7 +702,7 @@ class Event extends Message {
}
this.eventType = type + "_event";
this._eventValidator = schema.compile({
this._eventValidator = libSchema.compile({
$schema: "http://json-schema.org/draft-07/schema#",
properties: {
"type": { const: this.eventType },
@@ -1,6 +1,6 @@
/**
* Utilities for dealing with Lua
* @module lib/luaTools
* @module lib/lua_tools
*/
"use strict";
File renamed without changes.
+3 -3
View File
@@ -5,7 +5,7 @@
"use strict";
const path = require("path");
const errors = require("@clusterio/lib/errors");
const libErrors = require("@clusterio/lib/errors");
/**
@@ -409,11 +409,11 @@ async function loadPluginInfos(pluginList) {
pluginPackage = require(path.posix.join(pluginPath, "package.json"));
} catch (err) {
throw new errors.PluginError(pluginName, err);
throw new libErrors.PluginError(pluginName, err);
}
if (pluginInfo.name !== pluginName) {
throw new errors.EnvironmentError(
throw new libErrors.EnvironmentError(
`Expected plugin at ${pluginPath} to be named ${pluginName} but got ${pluginInfo.name}`
);
}