Flatten lib namespace

Move all functions and classes currently available through lib/name and
libName to be under a single flat namespace in lib.  This make
reorganising the lib namespace much simpler as the location of symbols
can move without breaking the consumers of lib.

The multi-entrypoint design was already problematic for the web plugin
system which couldn't effectively use it due to how webpack's shared
module system is awkward to set up with multiple entrypoints per package.
This commit is contained in:
Hornwitser committed 2023-07-28 16:03:29 +02:00
1 parent bb58670597
commit bfe119eaa3
143 files changed
+1798 -1918

No files matched your search

+29 -29
View File
@@ -1,25 +1,25 @@
"use strict";
const assert = require("assert").strict;
const libUsers = require("@clusterio/lib/users");
const lib = require("@clusterio/lib");
describe("lib/users", function() {
describe("definePermission()", function() {
it("should validate the types of its arguments", function() {
assert.throws(
() => libUsers.definePermission({ name: 123, title: "Test", description: "A test" }),
() => lib.definePermission({ name: 123, title: "Test", description: "A test" }),
new Error("Expected name to be a non-empty string")
);
assert.throws(
() => libUsers.definePermission({ name: "test", title: 123, description: "A test" }),
() => lib.definePermission({ name: "test", title: 123, description: "A test" }),
new Error("Expected title to be a non-empty string")
);
assert.throws(
() => libUsers.definePermission({ name: "test", title: "Test", description: 123 }),
() => lib.definePermission({ name: "test", title: "Test", description: 123 }),
new Error("Expected description to be a non-empty string")
);
assert.throws(
() => libUsers.definePermission({
() => lib.definePermission({
name: "test", title: "Test", description: "A test", grantByDefault: 1,
}),
new Error("Expected grantByDefault to be a boolean")
@@ -27,10 +27,10 @@ describe("lib/users", function() {
});
it("should define a permission", function() {
libUsers.definePermission({ name: "test", title: "Test", description: "A test" });
assert(libUsers.permissions.has("test"), "Permission was not defined");
lib.definePermission({ name: "test", title: "Test", description: "A test" });
assert(lib.permissions.has("test"), "Permission was not defined");
let test = libUsers.permissions.get("test");
let test = lib.permissions.get("test");
assert.equal(test.name, "test");
assert.equal(test.title, "Test");
assert.equal(test.description, "A test");
@@ -39,7 +39,7 @@ describe("lib/users", function() {
it("should throw on already defined permission", function() {
assert.throws(
() => libUsers.definePermission({ name: "test", title: "Test", description: "A test" }),
() => lib.definePermission({ name: "test", title: "Test", description: "A test" }),
new Error("Permission 'test' is already defined")
);
});
@@ -47,19 +47,19 @@ describe("lib/users", function() {
describe("class Role", function() {
it("should round trip serialize", function() {
let orig = new libUsers.Role({ id: 11, name: "Role", description: "My Role", permissions: ["test"] });
let copy = new libUsers.Role(orig.serialize());
let orig = new lib.Role({ id: 11, name: "Role", description: "My Role", permissions: ["test"] });
let copy = new lib.Role(orig.serialize());
assert.deepEqual(copy, orig);
});
describe(".grantDefaultRoles()", function() {
it("should only grant permissions with grantByDefault", function() {
let role = new libUsers.Role({ id: 11, name: "Role", description: "My Role" });
let role = new lib.Role({ id: 11, name: "Role", description: "My Role" });
role.grantDefaultPermissions();
assert(role.permissions.size > 0, "No permissions were granted");
for (let permission of role.permissions) {
assert(
libUsers.permissions.get(permission).grantByDefault === true,
lib.permissions.get(permission).grantByDefault === true,
"Non-default permission granted"
);
}
@@ -69,15 +69,15 @@ describe("lib/users", function() {
describe("class User", function() {
let roles = new Map([
[1, new libUsers.Role({ id: 1, name: "a", description: "a role", permissions: ["core.admin"] })],
[2, new libUsers.Role({ id: 2, name: "b", description: "b role", permissions: ["test"] })],
[1, new lib.Role({ id: 1, name: "a", description: "a role", permissions: ["core.admin"] })],
[2, new lib.Role({ id: 2, name: "b", description: "b role", permissions: ["test"] })],
]);
it("should round trip serialize", function() {
function test_roundtrip(serialized) {
let user = new libUsers.User(serialized, roles);
let user = new lib.User(serialized, roles);
let user_serialized = user.serialize();
assert.deepEqual(user_serialized, serialized);
let user_deserialized = new libUsers.User(user_serialized, roles);
let user_deserialized = new lib.User(user_serialized, roles);
assert.deepEqual(user_deserialized, user);
}
@@ -88,36 +88,36 @@ describe("lib/users", function() {
test_roundtrip({ name: "user", instance_stats: [[1, { join_count: 1 }]]});
});
it("should ignore invalid roles", function() {
let user = new libUsers.User({ name: "test", roles: [1, 4, 55] }, roles);
let user = new lib.User({ name: "test", roles: [1, 4, 55] }, roles);
assert.equal(user.roles.size, 1, "Unexpected count of roles");
});
it("should track online users", function() {
let user = new libUsers.User({ name: "admin", roles: [1] }, roles);
assert(!libUsers.User.onlineUsers.has(user));
let user = new lib.User({ name: "admin", roles: [1] }, roles);
assert(!lib.User.onlineUsers.has(user));
assert.deepEqual(user.instances, new Set());
user.notifyJoin(12);
assert(libUsers.User.onlineUsers.has(user));
assert(lib.User.onlineUsers.has(user));
assert.deepEqual(user.instances, new Set([12]));
user.notifyJoin(8);
assert(libUsers.User.onlineUsers.has(user));
assert(lib.User.onlineUsers.has(user));
assert.deepEqual(user.instances, new Set([12, 8]));
user.notifyLeave(11);
assert(libUsers.User.onlineUsers.has(user));
assert(lib.User.onlineUsers.has(user));
assert.deepEqual(user.instances, new Set([12, 8]));
user.notifyLeave(12);
assert(libUsers.User.onlineUsers.has(user));
assert(lib.User.onlineUsers.has(user));
assert.deepEqual(user.instances, new Set([8]));
user.notifyLeave(8);
assert(!libUsers.User.onlineUsers.has(user));
assert(!lib.User.onlineUsers.has(user));
assert.deepEqual(user.instances, new Set());
});
it("should calculate playerStats", function() {
let user = new libUsers.User({ name: "test", roles: [1], instance_stats: [
let user = new lib.User({ name: "test", roles: [1], instance_stats: [
[1, {
join_count: 1,
online_time_ms: 60e3,
@@ -148,9 +148,9 @@ describe("lib/users", function() {
describe(".checkPermission()", function() {
it("should correctly resolve permissions", function() {
let a = new libUsers.User({ name: "admin", roles: [1] }, roles);
let b = new libUsers.User({ name: "user", roles: [2] }, roles);
let c = new libUsers.User({ name: "null", roles: [] }, roles);
let a = new lib.User({ name: "admin", roles: [1] }, roles);
let b = new lib.User({ name: "user", roles: [2] }, roles);
let c = new lib.User({ name: "null", roles: [] }, roles);
a.checkPermission("core.control.connect");
assert.throws(() => b.checkPermission("core.control.connect"), new Error("Permission denied"));