style: restricted use of global as a global variable

`globalThis` is the correct name, so introduced an eslint rule to restrict using `global`
MatrixAI · Aug 8, 2022 · fd87744 · fd87744
1 parent 6e09a00
commit fd87744
Show file tree

Hide file tree

Showing 46 changed files with 123 additions and 116 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -23,6 +23,7 @@
   "rules": {
     "linebreak-style": ["error", "unix"],
     "no-empty": 1,
+    "no-restricted-globals": ["error", "window", "global"],
     "no-useless-catch": 1,
     "no-prototype-builtins": 1,
     "no-constant-condition": 0,

diff --git a/tests/agent/GRPCClientAgent.test.ts b/tests/agent/GRPCClientAgent.test.ts
@@ -169,7 +169,7 @@ describe(GRPCClientAgent.name, () => {
       serverHost: host,
       serverPort: port,
     });
-  }, global.defaultTimeout);
+  }, globalThis.defaultTimeout);
   afterEach(async () => {
     await testAgentUtils.closeTestAgentClient(client);
     await testAgentUtils.closeTestAgentServer(server);

diff --git a/tests/agent/service/nodesChainDataGet.test.ts b/tests/agent/service/nodesChainDataGet.test.ts
@@ -61,7 +61,7 @@ describe('nodesClosestLocalNode', () => {
       port: grpcServer.getPort(),
       logger,
     });
-  }, global.defaultTimeout);
+  }, globalThis.defaultTimeout);
   afterEach(async () => {
     await grpcClient.destroy();
     await grpcServer.stop();

diff --git a/tests/agent/service/nodesClosestLocalNode.test.ts b/tests/agent/service/nodesClosestLocalNode.test.ts
@@ -61,7 +61,7 @@ describe('nodesChainDataGet', () => {
       port: grpcServer.getPort(),
       logger,
     });
-  }, global.defaultTimeout);
+  }, globalThis.defaultTimeout);
   afterEach(async () => {
     await grpcClient.destroy();
     await grpcServer.stop();

diff --git a/tests/agent/service/nodesCrossSignClaim.test.ts b/tests/agent/service/nodesCrossSignClaim.test.ts
@@ -84,7 +84,7 @@ describe('nodesCrossSignClaim', () => {
       port: grpcServer.getPort(),
       logger,
     });
-  }, global.defaultTimeout);
+  }, globalThis.defaultTimeout);
   afterEach(async () => {
     await grpcClient.destroy();
     await grpcServer.stop();

diff --git a/tests/agent/service/nodesHolePunchMessage.test.ts b/tests/agent/service/nodesHolePunchMessage.test.ts
@@ -61,7 +61,7 @@ describe('nodesHolePunchMessage', () => {
       port: grpcServer.getPort(),
       logger,
     });
-  }, global.defaultTimeout);
+  }, globalThis.defaultTimeout);
   afterEach(async () => {
     await grpcClient.destroy();
     await grpcServer.stop();

diff --git a/tests/agent/service/notificationsSend.test.ts b/tests/agent/service/notificationsSend.test.ts
@@ -156,7 +156,7 @@ describe('notificationsSend', () => {
       port: grpcServer.getPort(),
       logger,
     });
-  }, global.defaultTimeout);
+  }, globalThis.defaultTimeout);
   afterEach(async () => {
     await grpcClient.destroy();
     await grpcServer.stop();

diff --git a/tests/bin/agent/start.test.ts b/tests/bin/agent/start.test.ts
@@ -21,7 +21,7 @@ describe('start', () => {
   let dataDir: string;
   beforeEach(async () => {
     dataDir = await fs.promises.mkdtemp(
-      path.join(global.tmpDir, 'polykey-test-'),
+      path.join(globalThis.tmpDir, 'polykey-test-'),
     );
   });
   afterEach(async () => {
@@ -99,7 +99,7 @@ describe('start', () => {
       const statusInfo = (await status.waitFor('DEAD'))!;
       expect(statusInfo.status).toBe('DEAD');
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
   runTestIfPlatforms()(
     'start in background',
@@ -202,7 +202,7 @@ describe('start', () => {
       const statusInfo2 = await status.waitFor('DEAD');
       expect(statusInfo2.status).toBe('DEAD');
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
   runTestIfPlatforms('docker')(
     'concurrent starts results in 1 success',
@@ -298,7 +298,7 @@ describe('start', () => {
         agentProcess1.kill('SIGQUIT');
       }
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
   runTestIfPlatforms('docker')(
     'concurrent with bootstrap results in 1 success',
@@ -388,7 +388,7 @@ describe('start', () => {
         agentProcess.kill('SIGTERM');
       }
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
   runTestIfPlatforms('docker')(
     'start with existing state',
@@ -462,7 +462,7 @@ describe('start', () => {
       const statusInfo = (await status.waitFor('DEAD'))!;
       expect(statusInfo.status).toBe('DEAD');
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
   runTestIfPlatforms('docker')(
     'start when interrupted, requires fresh on next start',
@@ -573,7 +573,7 @@ describe('start', () => {
       const statusInfo = (await status.readStatus())!;
       expect(statusInfo.status).toBe('DEAD');
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
   runTestIfPlatforms('docker')(
     'start from recovery code',
@@ -715,7 +715,7 @@ describe('start', () => {
       agentProcess4.kill('SIGTERM');
       await execUtils.processExit(agentProcess4);
     },
-    global.defaultTimeout * 3,
+    globalThis.defaultTimeout * 3,
   );
   runTestIfPlatforms('docker')(
     'start with network configuration',
@@ -770,7 +770,7 @@ describe('start', () => {
       // Check for graceful exit
       await status.waitFor('DEAD');
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
   runTestIfPlatforms('docker')(
     'start with PK_ROOT_KEY env override',
@@ -810,7 +810,7 @@ describe('start', () => {
       // Check for graceful exit
       await status.waitFor('DEAD');
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
   runTestIfPlatforms('docker')(
     'start with --root-key-file override',
@@ -861,7 +861,7 @@ describe('start', () => {
       // Check for graceful exit
       await status.waitFor('DEAD');
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
   runDescribeIfPlatforms()('start with global agent', () => {
     let agentDataDir;
@@ -878,7 +878,7 @@ describe('start', () => {
     beforeEach(async () => {
       // Additional seed node
       agentDataDir = await fs.promises.mkdtemp(
-        path.join(global.tmpDir, 'polykey-test-'),
+        path.join(globalThis.tmpDir, 'polykey-test-'),
       );
       ({ agentStatus: agent1Status, agentClose: agent1Close } =
         await execUtils.setupTestAgent(globalRootKeyPems[0], logger));
@@ -962,7 +962,7 @@ describe('start', () => {
         mockedConfigDefaultsNetwork.mockRestore();
         await status.waitFor('DEAD');
       },
-      global.defaultTimeout * 2,
+      globalThis.defaultTimeout * 2,
     );
     test(
       'start with seed nodes environment variable',
@@ -1025,7 +1025,7 @@ describe('start', () => {
         mockedConfigDefaultsNetwork.mockRestore();
         await status.waitFor('DEAD');
       },
-      global.defaultTimeout * 2,
+      globalThis.defaultTimeout * 2,
     );
   });
 });
diff --git a/tests/bin/agent/status.test.ts b/tests/bin/agent/status.test.ts
@@ -15,7 +15,7 @@ describe('status', () => {
   let dataDir: string;
   beforeEach(async () => {
     dataDir = await fs.promises.mkdtemp(
-      path.join(global.tmpDir, 'polykey-test-'),
+      path.join(globalThis.tmpDir, 'polykey-test-'),
     );
   });
   afterEach(async () => {
@@ -116,7 +116,7 @@ describe('status', () => {
         status: 'DEAD',
       });
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
   runTestIfPlatforms('docker')('status on missing agent', async () => {
     const { exitCode, stdout } = await execUtils.pkExec(

diff --git a/tests/bin/agent/stop.test.ts b/tests/bin/agent/stop.test.ts
@@ -15,7 +15,7 @@ describe('stop', () => {
   let dataDir: string;
   beforeEach(async () => {
     dataDir = await fs.promises.mkdtemp(
-      path.join(global.testDir, 'polykey-test-'),
+      path.join(globalThis.testDir, 'polykey-test-'),
     );
   });
   afterEach(async () => {
@@ -71,7 +71,7 @@ describe('stop', () => {
       await sleep(5000);
       agentProcess.kill();
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
   runTestIfPlatforms('docker')(
     'stopping is idempotent during concurrent calls and STOPPING or DEAD status',
@@ -163,7 +163,7 @@ describe('stop', () => {
       expect(agentStop4.exitCode).toBe(0);
       agentProcess.kill();
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
   runTestIfPlatforms()(
     'stopping starting agent results in error',
@@ -227,7 +227,7 @@ describe('stop', () => {
       await status.waitFor('DEAD');
       agentProcess.kill();
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
   runTestIfPlatforms('docker')(
     'stopping while unauthenticated does not stop',
@@ -290,6 +290,6 @@ describe('stop', () => {
       await status.waitFor('DEAD');
       agentProcess.kill();
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
 });
diff --git a/tests/bin/bootstrap.test.ts b/tests/bin/bootstrap.test.ts
@@ -15,7 +15,7 @@ describe('bootstrap', () => {
   let dataDir: string;
   beforeEach(async () => {
     dataDir = await fs.promises.mkdtemp(
-      path.join(global.tmpDir, 'polykey-test-'),
+      path.join(globalThis.tmpDir, 'polykey-test-'),
     );
   });
   afterEach(async () => {
@@ -53,7 +53,7 @@ describe('bootstrap', () => {
           recoveryCode.split(' ').length === 24,
       ).toBe(true);
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
   runTestIfPlatforms('docker')(
     'bootstraps node state from provided private key',
@@ -96,7 +96,7 @@ describe('bootstrap', () => {
       );
       expect(exitCode2).toBe(0);
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
   runTestIfPlatforms('docker')(
     'bootstrapping occupied node state',
@@ -152,7 +152,7 @@ describe('bootstrap', () => {
           recoveryCode.split(' ').length === 24,
       ).toBe(true);
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
   runTestIfPlatforms('docker')(
     'concurrent bootstrapping results in 1 success',
@@ -237,7 +237,7 @@ describe('bootstrap', () => {
         expect(exitCode2).toBe(0);
       }
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
   runTestIfPlatforms('docker')(
     'bootstrap when interrupted, requires fresh on next bootstrap',
@@ -314,6 +314,6 @@ describe('bootstrap', () => {
           recoveryCode.split(' ').length === 24,
       ).toBe(true);
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
 });
diff --git a/tests/bin/identities/allowDisallowPermissions.test.ts b/tests/bin/identities/allowDisallowPermissions.test.ts
@@ -37,7 +37,7 @@ describe('allow/disallow/permissions', () => {
   let nodePort: Port;
   beforeEach(async () => {
     dataDir = await fs.promises.mkdtemp(
-      path.join(global.tmpDir, 'polykey-test-'),
+      path.join(globalThis.tmpDir, 'polykey-test-'),
     );
     nodePath = path.join(dataDir, 'polykey');
     pkAgent = await PolykeyAgent.createPolykeyAgent({

diff --git a/tests/bin/identities/authenticateAuthenticated.test.ts b/tests/bin/identities/authenticateAuthenticated.test.ts
@@ -26,7 +26,7 @@ describe('authenticate/authenticated', () => {
   let testProvider: TestProvider;
   beforeEach(async () => {
     dataDir = await fs.promises.mkdtemp(
-      path.join(global.tmpDir, 'polykey-test-'),
+      path.join(globalThis.tmpDir, 'polykey-test-'),
     );
     nodePath = path.join(dataDir, 'polykey');
     // Cannot use global shared agent since we need to register a provider

diff --git a/tests/bin/identities/claim.test.ts b/tests/bin/identities/claim.test.ts
@@ -28,7 +28,7 @@ describe('claim', () => {
   let testProvider: TestProvider;
   beforeEach(async () => {
     dataDir = await fs.promises.mkdtemp(
-      path.join(global.tmpDir, 'polykey-test-'),
+      path.join(globalThis.tmpDir, 'polykey-test-'),
     );
     nodePath = path.join(dataDir, 'polykey');
     // Cannot use global shared agent since we need to register a provider

diff --git a/tests/bin/identities/discoverGet.test.ts b/tests/bin/identities/discoverGet.test.ts
@@ -40,7 +40,7 @@ describe('discover/get', () => {
   let nodeAPort: Port;
   beforeEach(async () => {
     dataDir = await fs.promises.mkdtemp(
-      path.join(global.tmpDir, 'polykey-test-'),
+      path.join(globalThis.tmpDir, 'polykey-test-'),
     );
     // Setup the remote gestalt state here
     // Setting up remote nodes

diff --git a/tests/bin/identities/search.test.ts b/tests/bin/identities/search.test.ts
@@ -110,7 +110,7 @@ describe('search', () => {
   let pkAgent: PolykeyAgent;
   beforeEach(async () => {
     dataDir = await fs.promises.mkdtemp(
-      path.join(global.tmpDir, 'polykey-test-'),
+      path.join(globalThis.tmpDir, 'polykey-test-'),
     );
     nodePath = path.join(dataDir, 'polykey');
     // Cannot use global shared agent since we need to register a provider

diff --git a/tests/bin/identities/trustUntrustList.test.ts b/tests/bin/identities/trustUntrustList.test.ts
@@ -36,7 +36,7 @@ describe('trust/untrust/list', () => {
   let nodePort: Port;
   beforeEach(async () => {
     dataDir = await fs.promises.mkdtemp(
-      path.join(global.tmpDir, 'polykey-test-'),
+      path.join(globalThis.tmpDir, 'polykey-test-'),
     );
     nodePath = path.join(dataDir, 'polykey');
     pkAgent = await PolykeyAgent.createPolykeyAgent({
@@ -225,7 +225,7 @@ describe('trust/untrust/list', () => {
       // @ts-ignore - get protected property
       pkAgent.discovery.visitedVertices.clear();
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
   runTestIfPlatforms()(
     'trusts and untrusts a gestalt by identity, adds it to the gestalt graph, and lists the gestalt with notify permission',
@@ -370,7 +370,7 @@ describe('trust/untrust/list', () => {
       // @ts-ignore - get protected property
       pkAgent.discovery.visitedVertices.clear();
     },
-    global.defaultTimeout * 2,
+    globalThis.defaultTimeout * 2,
   );
   runTestIfPlatforms()('should fail on invalid inputs', async () => {
     let exitCode;

diff --git a/tests/bin/keys/renew.test.ts b/tests/bin/keys/renew.test.ts
@@ -28,7 +28,7 @@ describe('renew', () => {
       .mockResolvedValueOnce(globalKeyPair)
       .mockResolvedValue(newKeyPair);
     dataDir = await fs.promises.mkdtemp(
-      path.join(global.tmpDir, 'polykey-test-'),
+      path.join(globalThis.tmpDir, 'polykey-test-'),
     );
     nodePath = path.join(dataDir, 'polykey');
     pkAgent = await PolykeyAgent.createPolykeyAgent({
@@ -42,7 +42,7 @@ describe('renew', () => {
       },
       logger,
     });
-  }, global.defaultTimeout * 2);
+  }, globalThis.defaultTimeout * 2);
   afterAll(async () => {
     await pkAgent.stop();
     await fs.promises.rm(dataDir, {