fix: fixed keys renew and reset tests

It's a race condition with propagating keys changes. We needed to wait and then attempt calls with the new nodeId. I think there's a separate issue when verifying with the old nodeId. That needs to be checked inside `Polykey` though.
MatrixAI · Oct 17, 2023 · ace9535 · ace9535
1 parent 8066278
commit ace9535
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 20 deletions.
diff --git a/tests/keys/renew.test.ts b/tests/keys/renew.test.ts
@@ -1,19 +1,18 @@
-import type { NodeId } from 'polykey/dist/ids';
 import path from 'path';
 import fs from 'fs';
 import Logger, { LogLevel, StreamHandler } from '@matrixai/logger';
 import PolykeyAgent from 'polykey/dist/PolykeyAgent';
 import * as keysUtils from 'polykey/dist/keys/utils';
 import * as nodesUtils from 'polykey/dist/nodes/utils';
+import { sleep } from 'polykey/dist/utils';
 import * as testUtils from '../utils';
 
 describe('renew', () => {
   const logger = new Logger('renew test', LogLevel.WARN, [new StreamHandler()]);
-  const password = 'helloworld';
+  const password = 'helloWorld';
   let dataDir: string;
   let nodePath: string;
   let pkAgent: PolykeyAgent;
-  let oldNodeId: NodeId;
   beforeEach(async () => {
     dataDir = await fs.promises.mkdtemp(
       path.join(globalThis.tmpDir, 'polykey-test-'),
@@ -33,7 +32,6 @@ describe('renew', () => {
       },
       logger,
     });
-    oldNodeId = pkAgent.keyRing.getNodeId();
   }, globalThis.defaultTimeout * 2);
   afterEach(async () => {
     await pkAgent.stop();
@@ -87,6 +85,10 @@ describe('renew', () => {
         },
       ));
       expect(exitCode).toBe(0);
+      await sleep(1000);
+      const nodeIdEncodedNew = nodesUtils.encodeNodeId(
+        pkAgent.keyRing.getNodeId(),
+      );
       // Get new keypair and nodeId and compare against old
       ({ exitCode, stdout } = await testUtils.pkStdio(
         ['keys', 'keypair', '--format', 'json'],
@@ -95,9 +97,7 @@ describe('renew', () => {
             PK_NODE_PATH: nodePath,
             PK_PASSWORD: 'password-new',
             PK_PASSWORD_NEW: 'some-password',
-            // Client server still using old nodeId, this should be removed if
-            // this is fixed.
-            PK_NODE_ID: nodesUtils.encodeNodeId(oldNodeId),
+            PK_NODE_ID: nodeIdEncodedNew,
             PK_CLIENT_HOST: '127.0.0.1',
             PK_CLIENT_PORT: `${pkAgent.clientServicePort}`,
           },
@@ -113,9 +113,7 @@ describe('renew', () => {
           env: {
             PK_NODE_PATH: nodePath,
             PK_PASSWORD: 'password-new',
-            // Client server still using old nodeId, this should be removed if
-            // this is fixed.
-            PK_NODE_ID: nodesUtils.encodeNodeId(oldNodeId),
+            PK_NODE_ID: nodeIdEncodedNew,
             PK_CLIENT_HOST: '127.0.0.1',
             PK_CLIENT_PORT: `${pkAgent.clientServicePort}`,
           },

diff --git a/tests/keys/reset.test.ts b/tests/keys/reset.test.ts
@@ -1,19 +1,18 @@
-import type { NodeId } from 'polykey/dist/ids';
 import path from 'path';
 import fs from 'fs';
 import Logger, { LogLevel, StreamHandler } from '@matrixai/logger';
 import PolykeyAgent from 'polykey/dist/PolykeyAgent';
 import * as keysUtils from 'polykey/dist/keys/utils';
 import * as nodesUtils from 'polykey/dist/nodes/utils';
+import { sleep } from 'polykey/dist/utils';
 import * as testUtils from '../utils';
 
 describe('reset', () => {
   const logger = new Logger('reset test', LogLevel.WARN, [new StreamHandler()]);
-  const password = 'helloworld';
+  const password = 'helloWorld';
   let dataDir: string;
   let nodePath: string;
   let pkAgent: PolykeyAgent;
-  let oldNodeId: NodeId;
   beforeEach(async () => {
     dataDir = await fs.promises.mkdtemp(
       path.join(globalThis.tmpDir, 'polykey-test-'),
@@ -33,7 +32,6 @@ describe('reset', () => {
       },
       logger,
     });
-    oldNodeId = pkAgent.keyRing.getNodeId();
   }, globalThis.defaultTimeout * 2);
   afterEach(async () => {
     await pkAgent.stop();
@@ -87,6 +85,11 @@ describe('reset', () => {
         },
       ));
       expect(exitCode).toBe(0);
+      // Wait for keys changes to propagate to the network
+      await sleep(1000);
+      const nodeIdEncodedNew = nodesUtils.encodeNodeId(
+        pkAgent.keyRing.getNodeId(),
+      );
       // Get new keypair and nodeId and compare against old
       ({ exitCode, stdout } = await testUtils.pkStdio(
         ['keys', 'keypair', '--format', 'json'],
@@ -95,9 +98,7 @@ describe('reset', () => {
             PK_NODE_PATH: nodePath,
             PK_PASSWORD: 'password-new',
             PK_PASSWORD_NEW: 'some-password',
-            // Client server still using old nodeId, this should be removed if
-            // this is fixed.
-            PK_NODE_ID: nodesUtils.encodeNodeId(oldNodeId),
+            PK_NODE_ID: nodeIdEncodedNew,
             PK_CLIENT_HOST: '127.0.0.1',
             PK_CLIENT_PORT: `${pkAgent.clientServicePort}`,
           },
@@ -113,9 +114,7 @@ describe('reset', () => {
           env: {
             PK_NODE_PATH: nodePath,
             PK_PASSWORD: 'password-new',
-            // Client server still using old nodeId, this should be removed if
-            // this is fixed.
-            PK_NODE_ID: nodesUtils.encodeNodeId(oldNodeId),
+            PK_NODE_ID: nodeIdEncodedNew,
             PK_CLIENT_HOST: '127.0.0.1',
             PK_CLIENT_PORT: `${pkAgent.clientServicePort}`,
           },