feat: Retry WSANO_DATA DNS errors and surface recovery guidance#45
Merged
Conversation
- Broaden the transient-error regex in Invoke-PatApi to retry the Windows
WSANO_DATA (11004) socket error ("no data of the requested type"),
which can occur when DNS records are still propagating or when only
AAAA records are returned.
- After retries are exhausted on a DNS-class failure, throw a single
actionable message naming Resolve-DnsName, Test-NetConnection,
Get-PatStoredServer, and Add-PatServer -Force as recovery steps,
mirroring the existing 401 token-recovery pattern. Original error is
preserved for diagnostics.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughInvoke-PatApi classifies Windows WSANO_DATA (11004) as a transient DNS condition so it participates in exponential-backoff retries, and after retries exhaust it surfaces a single, actionable DNS-resolution guidance message (naming specific cmdlets) instead of emitting the raw socket error. Changes
Sequence Diagram(s)sequenceDiagram
participant Caller as Caller (Invoke-PatApi)
participant Retry as Retry Logic
participant DNS as DNS Resolver
participant Plex as Plex API
Caller->>Retry: Invoke request
Retry->>DNS: Resolve host (may return WSANO_DATA / DNS error)
alt DNS resolved
DNS->>Plex: Connect and send API request
Plex-->>Caller: API response
else Transient DNS error (WSANO_DATA)
Retry-->>Caller: wait/backoff, retry
Retry->>DNS: Resolve host (retry)
alt Success on retry
DNS->>Plex: Connect and send API request
Plex-->>Caller: API response
else Retries exhausted
DNS-->>Caller: Consolidated DNS remediation guidance (Resolve-DnsName, Test-NetConnection, Get-PatStoredServer, Add-PatServer -Force) with original error text
end
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Review rate limit: 0/1 reviews remaining, refill in 60 minutes.Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the resilience and usability of the internal Plex API wrapper (Invoke-PatApi) by retrying an additional Windows DNS-related socket error (WSANO_DATA / 11004) and, when retries are exhausted for DNS-class failures, throwing a single actionable recovery message instead of propagating layered/raw socket errors.
Changes:
- Expand transient DNS error detection to include the Windows
WSANO_DATA(“no data of the requested type”) wording so it participates in the retry loop. - Add a DNS-specific “recovery guidance” error message when DNS-class transient retries are exhausted (while preserving the original error text for diagnostics).
- Add unit tests covering WSANO_DATA retry success, DNS guidance on exhaustion (including original error preservation), and ensuring non-DNS transient errors still use the generic message.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
PlexAutomationToolkit/Private/Invoke-PatApi.ps1 |
Broaden DNS transient detection and add DNS-specific actionable error after retry exhaustion. |
tests/Unit/Private/Invoke-PatApi.tests.ps1 |
Add Pester coverage for WSANO_DATA retry behavior and DNS guidance messaging. |
CHANGELOG.md |
Document the new retry signature and the improved DNS failure messaging. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
PlexAutomationToolkit/Private/Invoke-PatApi.ps1 (1)
151-163: Consider centralizing the DNS match pattern.The retry predicate and the final remediation branch now rely on the same message list in two places. Extracting it once would keep the retry classification and the surfaced guidance from drifting apart later.
♻️ Possible cleanup
+ $dnsTransientPattern = 'No such host|DNS|name.+not.+resolve|no data of the requested type' + function Test-TransientError { param([System.Management.Automation.ErrorRecord]$ErrorRecord) @@ - if ($message -match 'No such host|DNS|name.+not.+resolve|no data of the requested type') { + if ($message -match $dnsTransientPattern) { return $true } @@ - if ($errorMessage -match 'No such host|DNS|name.+not.+resolve|no data of the requested type') { + if ($errorMessage -match $dnsTransientPattern) { throw ("Plex API request failed after $MaxRetries attempts: DNS could not resolve the server hostname. " +🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@PlexAutomationToolkit/Private/Invoke-PatApi.ps1` around lines 151 - 163, Extract the DNS error regex into a single named variable (e.g., $DnsErrorPattern) at the top of the Invoke-PatApi function or module scope and replace the inline pattern in the remediation branch (the -match against $errorMessage inside the if ($isTransient -and $attempt -eq $MaxRetries) block) and the retry predicate that classifies transient DNS/connection failures to use that variable instead; ensure the variable uses the same regex options (case-insensitive) and is referenced wherever the current hard-coded 'No such host|DNS|name.+not.+resolve|no data of the requested type' pattern is repeated so both classification and user guidance remain in sync.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@PlexAutomationToolkit/Private/Invoke-PatApi.ps1`:
- Around line 151-163: Extract the DNS error regex into a single named variable
(e.g., $DnsErrorPattern) at the top of the Invoke-PatApi function or module
scope and replace the inline pattern in the remediation branch (the -match
against $errorMessage inside the if ($isTransient -and $attempt -eq $MaxRetries)
block) and the retry predicate that classifies transient DNS/connection failures
to use that variable instead; ensure the variable uses the same regex options
(case-insensitive) and is referenced wherever the current hard-coded 'No such
host|DNS|name.+not.+resolve|no data of the requested type' pattern is repeated
so both classification and user guidance remain in sync.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: c3468a0f-c903-43de-965a-d136404e973f
📒 Files selected for processing (3)
CHANGELOG.mdPlexAutomationToolkit/Private/Invoke-PatApi.ps1tests/Unit/Private/Invoke-PatApi.tests.ps1
- Extract the DNS error regex into a single $dnsErrorPattern variable used by both Test-TransientError and the post-exhaustion guidance branch, so the retry classification and the surfaced guidance cannot drift if either pattern is widened later (CodeRabbit, Copilot nit). - Tighten the comment on the post-exhaustion branch to clarify that only DNS resolution failures get the actionable message; timeouts and connection-refused remain transient but fall through to the generic message because they have a different recovery story (Copilot nit). - Reword the CHANGELOG entry as two bullets to avoid implying that multiple new retry conditions were added when only one (WSANO_DATA) was (Copilot nit). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Roll up the WSANO_DATA retry classification and DNS post-exhaustion guidance changes from this branch into a release. Bump ModuleVersion 0.11.1 -> 0.11.2 (PATCH; ### Changed-only refinements, no public API changes), and convert the [Unreleased] section in CHANGELOG.md into the dated [0.11.2] section. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Invoke-PatApito retry the WindowsWSANO_DATA(11004) socket error — "The requested name is valid, but no data of the requested type was found." — which can occur when DNS records are propagating or when only AAAA records are returned. Previously this error fell through the existing exponential-backoff retry (1s/2s/4s) and surfaced immediately.Resolve-DnsName,Test-NetConnection,Get-PatStoredServer, andAdd-PatServer -Forceas concrete recovery steps. This mirrors the existing 401-token-recovery pattern and replaces the raw socket error wrapped through three cmdlet layers (e.g.Update-PatLibrary→Get-PatLibrary→Invoke-PatApi). The original error is preserved at the end for diagnostics.Motivation
A user hit
WSANO_DATAmid-session and saw a confusing three-layer error:The error self-resolved on the next attempt, confirming it was transient — but the existing regex
'No such host|DNS|name.+not.+resolve'did not match the WSANO_DATA wording, so the retry path was never engaged.Test Plan
pwsh -Command "Set-BuildEnvironment -Force; Invoke-Pester -Path tests/Unit/Private/Invoke-PatApi.tests.ps1"— 57/57 pass (4 new)Breaking Changes
None.
🤖 Generated with Claude Code
Summary by CodeRabbit
Bug Fixes
Tests
Chores