Improve Test Coverage for packages/web3/src/utils #468

Benjtalkshow · 2024-11-24T21:57:30Z

Closes #457

Improve Test Coverage for packages/web3/src/utils

Overview

This pull request significantly enhances the test coverage for the utils.ts file and other utility functions in the packages/web3/src/utils directory. We've added new test cases, improved existing ones, and created new test files to ensure comprehensive coverage of our utility functions.

Main Changes

utils.test.ts

Expanded test coverage for existing functions
Added new test cases for previously untested functions
Improved error case testing

bs58.test.ts

Enhanced existing tests for isBase58 function:
- Added more test cases for valid and invalid Base58 strings
- Included tests for empty strings and whitespace-only strings
Added new tests for base58ToBytes function:
- Test for successful conversion
- Tests for error cases (invalid input and empty string)
Added tests for bs58 object:
- Tests for encoding and decoding
- Test for handling empty input

djb2.test.ts

Expanded test cases for the djb2 function:
- Added tests for various input types (empty string, single characters, short strings, long strings)
- Included tests for special characters and non-ASCII inputs
Improved assertion messages for better clarity in test results

subscription.test.ts (New File)

Created comprehensive test suite for the Subscription class:
- Tests for initialization with correct properties
- Tests for subscribe and unsubscribe functionality
- Tests for polling behavior and cancellation
- Tests for error handling in callbacks
Implemented mock class TestSubscription to test abstract Subscription class
Added tests for edge cases and multiple subscribe/unsubscribe scenarios

Additional Notes

The changes in utils.ts resolve type errors related to the SignatureInput type
Test coverage has been significantly improved across all utility functions
New test file subscription.test.ts provides thorough coverage for the Subscription class
All tests are passing after the modifications

Benjtalkshow · 2024-11-24T21:58:16Z

@polarker please review

h0ngcha0 · 2024-11-27T13:32:57Z

Thanks for the contribution.

Please make sure all the updated test suite pass, right now all of them have failing tests. You can run them by

pnpm install
pnpm build
pnpm test

Benjtalkshow · 2024-11-29T11:43:33Z

Thanks for the contribution.

Please make sure all the updated test suite pass, right now all of them have failing tests. You can run them by
pnpm install
pnpm build
pnpm test

Alright ser

Benjtalkshow · 2024-11-30T00:31:06Z

@h0ngcha0 Will update my PR Soon

Benjtalkshow · 2024-11-30T08:34:35Z

@h0ngcha0 Will update my PR Soon

Fix bs58.test.ts
Fix djb2.test.ts
Fixing... subscription.test.ts
Fixing... utils.test.ts

Benjtalkshow · 2024-12-01T16:15:43Z

@h0ngcha0 Please review.

h0ngcha0 · 2024-12-03T05:13:33Z

packages/web3/src/utils/djb2.ts

@@ -22,4 +22,4 @@ export default function djb2(bytes: Uint8Array): number {
    hash = (hash << 5) + hash + (bytes[`${i}`] & 0xff)
  }
  return hash
-}
+}


The change of this file is unnecessary.

h0ngcha0 · 2024-12-03T05:15:47Z

packages/web3/package.json

@@ -34,7 +34,7 @@
  "author": "Alephium dev <[email protected]>",
  "config": {
    "alephium_version": "3.9.0",
-    "explorer_backend_version": "2.2.6"


Is this change relevant in this PR? Usually the version is updated when we want to update the explorer backend API file, which doesn't seem to be the case here.

h0ngcha0 · 2024-12-03T05:16:57Z

packages/web3/package.json

@@ -98,4 +98,4 @@
    "node": ">=14.0.0",
    "npm": ">=7.0.0"
  }
-}
+}


Please revert the end-of-file change to all updated files, maybe it is a editor config issue.

It was a mistake. will revert it

h0ngcha0 · 2024-12-03T05:46:32Z

packages/web3/src/utils/bs58.ts

@@ -36,11 +36,13 @@ export function isBase58(s: string): boolean {
 }

 export function base58ToBytes(s: string): Uint8Array {
+  if (s === '') {


Maybe we we should allow empty string here?

h0ngcha0 · 2024-12-03T05:47:17Z

packages/web3/src/utils/djb2.test.ts

+  });
+});
+
+


Please remove extra lines.

h0ngcha0 · 2024-12-03T05:55:26Z

packages/web3/src/utils/bs58.test.ts

+    it('should convert valid base58 strings to bytes', () => {
+      const result = base58ToBytes('32UWxgjUHwH7P1J61tb12')
+      expect(result).toBeInstanceOf(Uint8Array)
+      expect(result.length).toBeGreaterThan(0)


Perhaps we can check bs58.encode(result) would give us 32UWxgjUHwH7P1J61tb12 instead.

pragmaxim

LGTM

Improve Test Coverage for packages/web3/src/utils

c4f25be

fix bs58.test.ts, djb2.test.ts

22849a1

Benjtalkshow added 2 commits December 1, 2024 06:28

fix subscription.test.ts

34bd80c

fix utils.test.ts

b75b8cd

h0ngcha0 reviewed Dec 3, 2024

View reviewed changes

pragmaxim approved these changes Dec 3, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve Test Coverage for packages/web3/src/utils #468

Improve Test Coverage for packages/web3/src/utils #468

Benjtalkshow commented Nov 24, 2024

Benjtalkshow commented Nov 24, 2024

h0ngcha0 commented Nov 27, 2024 •

edited

Loading

Benjtalkshow commented Nov 29, 2024

Benjtalkshow commented Nov 30, 2024

Benjtalkshow commented Nov 30, 2024 •

edited

Loading

Benjtalkshow commented Dec 1, 2024

h0ngcha0 Dec 3, 2024

Benjtalkshow Dec 3, 2024

h0ngcha0 Dec 3, 2024

h0ngcha0 Dec 3, 2024

Benjtalkshow Dec 3, 2024

h0ngcha0 Dec 3, 2024

Benjtalkshow Dec 3, 2024

h0ngcha0 Dec 3, 2024

h0ngcha0 Dec 3, 2024

pragmaxim left a comment

Improve Test Coverage for packages/web3/src/utils #468

Are you sure you want to change the base?

Improve Test Coverage for packages/web3/src/utils #468

Conversation

Benjtalkshow commented Nov 24, 2024

Improve Test Coverage for packages/web3/src/utils

Overview

Main Changes

utils.test.ts

bs58.test.ts

djb2.test.ts

subscription.test.ts (New File)

Additional Notes

Benjtalkshow commented Nov 24, 2024

h0ngcha0 commented Nov 27, 2024 • edited Loading

Benjtalkshow commented Nov 29, 2024

Benjtalkshow commented Nov 30, 2024

Benjtalkshow commented Nov 30, 2024 • edited Loading

Benjtalkshow commented Dec 1, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pragmaxim left a comment

Choose a reason for hiding this comment

h0ngcha0 commented Nov 27, 2024 •

edited

Loading

Benjtalkshow commented Nov 30, 2024 •

edited

Loading