Add time unit suffixes to variables (#561)

Add suffixes like Ms and Ns to variables whos time unit is not in
seconds.  This is aligning with a new code style of putting units
on variables that are not in SI base units.
This commit is contained in:
Hornwitser authored and GitHub committed 2024-01-20 13:26:55 +01:00
1 parent 9842705eb9
commit c53781d16c
38 files changed
+221 -201

No files matched your search

+7 -7
View File
@@ -36,7 +36,7 @@ async function saveDatabase(
}
export class ControllerPlugin extends BaseControllerPlugin {
acquiredPlayers!: Map<string, { instanceId: number, expires?: number }>;
acquiredPlayers!: Map<string, { instanceId: number, expiresMs?: number }>;
playerDatastore!: Map<string, IpcPlayerData>;
playerDatastoreDirty = false;
@@ -62,18 +62,18 @@ export class ControllerPlugin extends BaseControllerPlugin {
}
if (["unknown", "stopped"].includes(instance.status)) {
let timeout = this.controller.config.get("inventory_sync.player_lock_timeout") * 1000;
let timeoutMs = this.controller.config.get("inventory_sync.player_lock_timeout") * 1000;
for (let acquisitonRecord of this.acquiredPlayers.values()) {
if (acquisitonRecord.instanceId === instanceId && !acquisitonRecord.expires) {
acquisitonRecord.expires = Date.now() + timeout;
if (acquisitonRecord.instanceId === instanceId && !acquisitonRecord.expiresMs) {
acquisitonRecord.expiresMs = Date.now() + timeoutMs;
}
}
}
if (instance.status === "running") {
for (let acquisitonRecord of this.acquiredPlayers.values()) {
if (acquisitonRecord.instanceId === instanceId && acquisitonRecord.expires) {
delete acquisitonRecord.expires;
if (acquisitonRecord.instanceId === instanceId && acquisitonRecord.expiresMs) {
delete acquisitonRecord.expiresMs;
}
}
}
@@ -85,7 +85,7 @@ export class ControllerPlugin extends BaseControllerPlugin {
!acquisitionRecord
|| acquisitionRecord.instanceId === instanceId
|| !this.controller.instances.has(acquisitionRecord.instanceId)
|| acquisitionRecord.expires && acquisitionRecord.expires < Date.now()
|| acquisitionRecord.expiresMs && acquisitionRecord.expiresMs < Date.now()
) {
this.acquiredPlayers.set(playerName, { instanceId });
return true;
+8 -8
View File
@@ -26,7 +26,7 @@ async function generateCode(length: number): Promise<string> {
}
type PlayerCode = { playerCode: string, verifyCode: string | null, expires: number };
type PlayerCode = { playerCode: string, verifyCode: string | null, expiresMs: number };
export class ControllerPlugin extends BaseControllerPlugin {
players!: Map<string, PlayerCode>;
@@ -39,7 +39,7 @@ export class ControllerPlugin extends BaseControllerPlugin {
setInterval(() => {
let now = Date.now();
for (let [player, entry] of this.players) {
if (entry.expires < now) {
if (entry.expiresMs < now) {
this.players.delete(player);
}
}
@@ -88,13 +88,13 @@ export class ControllerPlugin extends BaseControllerPlugin {
}
for (let entry of this.players.values()) {
if (entry.playerCode === playerCode && entry.expires > Date.now()) {
if (entry.playerCode === playerCode && entry.expiresMs > Date.now()) {
let verifyCode = await generateCode(this.controller.config.get("player_auth.code_length"));
let secret = Buffer.from(this.controller.config.get("controller.auth_secret"), "base64");
let verifyToken = jwt.sign(
{
aud: "player_auth.verify_code",
exp: Math.floor(entry.expires / 1000),
exp: Math.floor(entry.expiresMs / 1000),
verify_code: verifyCode,
player_code: playerCode,
},
@@ -150,7 +150,7 @@ export class ControllerPlugin extends BaseControllerPlugin {
}
for (let [player, entry] of this.players) {
if (entry.playerCode === playerCode && entry.expires > Date.now()) {
if (entry.playerCode === playerCode && entry.expiresMs > Date.now()) {
if (entry.verifyCode === verifyCode) {
let user = this.controller.userManager.users.get(player);
if (!user) {
@@ -174,8 +174,8 @@ export class ControllerPlugin extends BaseControllerPlugin {
async handleFetchPlayerCodeRequest(request: FetchPlayerCodeRequest) {
let playerCode = await generateCode(this.controller.config.get("player_auth.code_length"));
let expires = Date.now() + this.controller.config.get("player_auth.code_timeout") * 1000;
this.players.set(request.player, { playerCode, verifyCode: null, expires });
let expiresMs = Date.now() + this.controller.config.get("player_auth.code_timeout") * 1000;
this.players.set(request.player, { playerCode, verifyCode: null, expiresMs });
return { player_code: playerCode, controller_url: this.controller.getControllerUrl() };
}
@@ -183,7 +183,7 @@ export class ControllerPlugin extends BaseControllerPlugin {
let { player, verifyCode } = request;
let entry = this.players.get(player);
if (!entry || entry.expires < Date.now()) {
if (!entry || entry.expiresMs < Date.now()) {
throw new lib.RequestError("invalid player");
}
+19 -16
View File
@@ -123,8 +123,8 @@ describe("player_auth", function() {
}
});
it("should return invalid player_code if the code is expired", async function() {
let expires = Date.now() - 1000;
controllerPlugin.players.set("expired", { playerCode: "expried", verifyCode: null, expires });
let expiresMs = Date.now() - 1000;
controllerPlugin.players.set("expired", { playerCode: "expired", verifyCode: null, expiresMs });
let result = await phin({
url: `${controllerUrl}/api/player_auth/player_code`,
method: "POST",
@@ -134,8 +134,8 @@ describe("player_auth", function() {
assert.deepEqual(result.body, { error: true, message: "invalid player_code" });
});
it("should return a verify code and token if code is valid", async function() {
let expires = Date.now() + 1000;
controllerPlugin.players.set("valid", { playerCode: "valid", verifyCode: null, expires });
let expiresMs = Date.now() + 1000;
controllerPlugin.players.set("valid", { playerCode: "valid", verifyCode: null, expiresMs });
let result = await phin({
url: `${controllerUrl}/api/player_auth/player_code`,
method: "POST",
@@ -214,8 +214,8 @@ describe("player_auth", function() {
await verify({ aud: "not_player_auth" });
});
it("should return invalid player_code if the code is expired", async function() {
let expires = Date.now() - 1000;
controllerPlugin.players.set("expired", { playerCode: "expried", verifyCode: "verify", expires });
let expiresMs = Date.now() - 1000;
controllerPlugin.players.set("expired", { playerCode: "expired", verifyCode: "verify", expiresMs });
let result = await phin({
url: `${controllerUrl}/api/player_auth/verify`,
method: "POST",
@@ -233,8 +233,11 @@ describe("player_auth", function() {
assert.deepEqual(result.body, { error: true, message: "invalid player_code" });
});
it("should return verified false if verify code has not yet been set", async function() {
let expires = Date.now() + 1000;
controllerPlugin.players.set("unverified", { playerCode: "unverified", verifyCode: null, expires });
let expiresMs = Date.now() + 1000;
controllerPlugin.players.set(
"unverified",
{ playerCode: "unverified", verifyCode: null, expiresMs },
);
let result = await phin({
url: `${controllerUrl}/api/player_auth/verify`,
method: "POST",
@@ -252,8 +255,8 @@ describe("player_auth", function() {
assert.deepEqual(result.body, { verified: false });
});
it("should return error if user is missing", async function() {
let expires = Date.now() + 1000;
controllerPlugin.players.set("missing", { playerCode: "missing", verifyCode: "verify", expires });
let expiresMs = Date.now() + 1000;
controllerPlugin.players.set("missing", { playerCode: "missing", verifyCode: "verify", expiresMs });
let result = await phin({
url: `${controllerUrl}/api/player_auth/verify`,
method: "POST",
@@ -271,8 +274,8 @@ describe("player_auth", function() {
assert.deepEqual(result.body, { error: true, message: "invalid user" });
});
it("should return verified true with token if valid verification", async function() {
let expires = Date.now() + 1000;
controllerPlugin.players.set("player", { playerCode: "player", verifyCode: "verify", expires });
let expiresMs = Date.now() + 1000;
controllerPlugin.players.set("player", { playerCode: "player", verifyCode: "verify", expiresMs });
let result = await phin({
url: `${controllerUrl}/api/player_auth/verify`,
method: "POST",
@@ -299,8 +302,8 @@ describe("player_auth", function() {
);
assert(typeof result.player_code === "string", "no code returned");
assert(result.player_code.length === 10, "incorrect code length returned");
let expires = controllerPlugin.players.get("test").expires;
let msFromExpected = Math.abs(expires - Date.now() - 1000);
let expiresMs = controllerPlugin.players.get("test").expiresMs;
let msFromExpected = Math.abs(expiresMs - Date.now() - 1000);
assert(msFromExpected < 100, `expiry time expected outside window (${msFromExpected}ms)`);
});
});
@@ -315,8 +318,8 @@ describe("player_auth", function() {
);
});
it("should throw if player code has expired", async function() {
let expires = Date.now() - 1000;
controllerPlugin.players.set("expired", { playerCode: "expried", verifyCode: null, expires });
let expiresMs = Date.now() - 1000;
controllerPlugin.players.set("expired", { playerCode: "expired", verifyCode: null, expiresMs });
await assert.rejects(
controllerPlugin.handleSetVerifyCodeRequest(
new SetVerifyCodeRequest("expired", "expired")
+2 -2
View File
@@ -109,8 +109,8 @@ export class InstancePlugin extends BaseInstancePlugin {
// take a long time for the command to go through if the command
// stream is overloaded. Should the timeout be exceeded the
// previous values for the metrics will end up being sent to controller.
let timeout = this.instance.config.get("statistics_exporter.command_timeout") * 1000;
await lib.timeout(this.gatherMetrics(), timeout, undefined);
let timeoutMs = this.instance.config.get("statistics_exporter.command_timeout") * 1000;
await lib.timeout(this.gatherMetrics(), timeoutMs, undefined);
}
}