Implement waitForCertificates helper with polling, back-off, timeout, and abort support #92

Copilot · 2025-11-04T17:55:58Z

Implement proper waiting logic with poll interval
Handle back-offs from retryAfter response field
Handle permanent fatal errors (non-retryable)
Deserialize and handle specific error types from the API
Add timeout functionality with configurable timeout parameter
Add AbortSignal support to allow cancellation
Write comprehensive tests for waitForCertificates method
Address code review feedback (type aliases, error classification refactoring)
Refactor based on review feedback:
- Created reusable asleep() utility in src/lib/utils/asleep.ts
- Use KeetaAnchorError.fromJSON for proper error deserialization
- Use error.retryable property instead of error pattern matching
- Simplified loop logic by removing redundant checks
- Cleaned up asleep() implementation
- Use KeetaAnchorError.isInstance() for proper type checking

Implementation complete! All code review feedback has been addressed.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

- Implemented proper waiting logic with configurable poll interval - Added back-off handling using server-provided retryAfter values - Added detection and handling of permanent fatal errors (non-retryable) - Added error deserialization and classification - Added timeout functionality with configurable timeout parameter - Added AbortSignal support for cancellation - Added comprehensive tests covering immediate success, delayed success, timeout, and abort scenarios Co-authored-by: rkeene <5068442+rkeene@users.noreply.github.com>

- Added KeetaKYCAnchorClientGetCertificateSuccessResponse type alias for better readability - Refactored error message checking into isPermanentError() helper method for more maintainable error classification - Fixed linting issues with unused test variables Co-authored-by: rkeene <5068442+rkeene@users.noreply.github.com>

Copilot · 2025-11-04T18:28:12Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

127.171.9.78
- Triggering command: node (vitest 1) (packet block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

rkeene · 2025-11-04T19:42:44Z

src/services/kyc/client.ts

+	/**
+	 * Helper method to sleep for a given duration while respecting abort signals
+	 */
+	private async sleepWithAbort(ms: number, signal?: AbortSignal): Promise<void> {


@copilot Instead of creating this as a method in this class, create an src/lib/utils/asleep.ts with an exported function named asleep() with the same parameters (remember to use JSDoc to document them) -- also with a note that it should be replaced when the @keetanetwork/keetanet-client KeetaNet.lib.Utils.Helper.asleep method is updated to support AbortSignal

Created src/lib/utils/asleep.ts with the asleep() function that supports AbortSignal. Added JSDoc noting it should be replaced when @keetanetwork/keetanet-client KeetaNet.lib.Utils.Helper.asleep is updated. Commit: 97ed650

rkeene · 2025-11-04T19:43:38Z

src/services/kyc/client.ts

+		if (signal?.aborted) {
+			throw(new Error('Certificate wait aborted'));
+		}


@copilot This check is completely unneeded because it's the first thing done within the loop immediately following (if the timeout is negative then a timeout error instead of aborted error is fine)

Removed the initial abort check before the loop. The loop now handles abort checking at its start. Commit: 97ed650

rkeene · 2025-11-04T19:44:57Z

src/services/kyc/client.ts

+	 */
+	private isPermanentError(errorMessage: string): boolean {
+		// Patterns that indicate permanent failures
+		const permanentErrorPatterns = [


@copilot Instead of an error pattern, use the retryable property of the error -- this property might need to be set in the appropriate circumstances

Updated to use the error.retryable property instead of pattern matching. Set CertificateNotFoundError.retryable = true and removed the isPermanentError() method. Commit: 97ed650

rkeene · 2025-11-04T19:45:42Z

src/services/kyc/client.ts

+				const waitTime = Math.max(result.retryAfter, pollInterval);
+
+				// Check if waiting would exceed the timeout
+				if (Date.now() - startTime + waitTime >= timeout) {


@copilot We can just poll one interval more than needed rather than add this

Removed the timeout check before waiting. The loop now allows one additional poll attempt if needed. Commit: 97ed650

src/services/kyc/client.ts

- Created src/lib/utils/asleep.ts with asleep() function for AbortSignal-aware sleep - Removed initial abort check before loop (redundant with loop check) - Removed timeout check before waiting (allows one extra poll attempt) - Updated getCertificates to use KeetaAnchorError.fromJSON for proper error deserialization - Updated waitForCertificates to use error.retryable property instead of pattern matching - Set CertificateNotFoundError.retryable = true for proper retry handling - Removed sleepWithAbort and isPermanentError helper methods - Replaced sleepWithAbort calls with asleep utility Co-authored-by: rkeene <5068442+rkeene@users.noreply.github.com>

Co-authored-by: rkeene <5068442+rkeene@users.noreply.github.com>

rkeene · 2025-11-04T20:11:45Z

src/services/kyc/client.ts

-					if (isPermanentError) {
-						this.logger?.error(`Permanent error fetching certificates for request ${this.id}: ${errorMessage}`);
+				// Check if this is a KeetaAnchorError with retryable property
+				if (getCertificatesError instanceof KeetaAnchorError) {


@copilot Should use KeetaAnchorError.isInstance()

Changed to use KeetaAnchorError.isInstance() for proper type checking. Commit: af7f72a

Co-authored-by: rkeene <5068442+rkeene@users.noreply.github.com>

Initial plan

945bd47

Copilot AI assigned Copilot and rkeene Nov 4, 2025

Copilot AI mentioned this pull request Nov 4, 2025

Add helper "waitForCertificates" to KYC Client #91

Draft

Copilot started work on behalf of rkeene November 4, 2025 17:56 View session

Copilot AI and others added 2 commits November 4, 2025 18:11

Copilot AI changed the title ~~[WIP] Add helper "waitForCertificates" to KYC Client~~ Implement waitForCertificates helper with polling, back-off, timeout, and abort support Nov 4, 2025

Copilot AI requested a review from rkeene November 4, 2025 18:28

Copilot finished work on behalf of rkeene November 4, 2025 18:28

rkeene reviewed Nov 4, 2025

View reviewed changes

Copilot started work on behalf of rkeene November 4, 2025 19:48 View session

Copilot AI and others added 2 commits November 4, 2025 19:57

Clean up asleep function - remove redundant await and async

0117990

Co-authored-by: rkeene <5068442+rkeene@users.noreply.github.com>

Copilot AI requested a review from rkeene November 4, 2025 20:02

Copilot finished work on behalf of rkeene November 4, 2025 20:02

rkeene reviewed Nov 4, 2025

View reviewed changes

Copilot started work on behalf of rkeene November 4, 2025 20:13 View session

Use KeetaAnchorError.isInstance() instead of instanceof

af7f72a

Co-authored-by: rkeene <5068442+rkeene@users.noreply.github.com>

Copilot AI requested a review from rkeene November 4, 2025 20:18

Copilot finished work on behalf of rkeene November 4, 2025 20:18

Implement waitForCertificates helper with polling, back-off, timeout, and abort support #92

Are you sure you want to change the base?

Implement waitForCertificates helper with polling, back-off, timeout, and abort support #92

Uh oh!

Conversation

Copilot AI commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI commented Nov 4, 2025

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

rkeene Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

rkeene Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

rkeene Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

rkeene Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rkeene Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Nov 4, 2025 •

edited

Loading