Skip to content

Fix GetDocumentationUri resource lookup for missing doc file - #1510

Merged
imnasnainaec merged 3 commits into
masterfrom
fix-1392-access-protocol-documentation-uri
Jun 18, 2026
Merged

Fix GetDocumentationUri resource lookup for missing doc file#1510
imnasnainaec merged 3 commits into
masterfrom
fix-1392-access-protocol-documentation-uri

Conversation

@imnasnainaec

@imnasnainaec imnasnainaec commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Fixes #1392

ArchiveAccessProtocol.GetDocumentationUri stripped the extension from DocumentationFile before calling GetResource (e.g. "ailca.html""ailca"), so the lookup no longer matched the embedded resource manifest name SIL.Archiving.Resources.ailca.html and the missing documentation file could not be created from the resource.

The fix passes the full filename to GetResource.

Where the bug was introduced

PR #1317 ("Renamed project to SIL.Windows.Forms.Archiving", merge commit 0dfeebe3) rewrote the resource accessor so GetResource prepends SIL.Archiving.Resources. and requires the full filename including the extension. The extension-stripping logic in GetDocumentationUri was carried over against this new accessor, producing the mismatch.

Testing

The covering test is in a fixture categorized SkipOnTeamCity, so it does not run on CI and must be run by hand:

SIL.Archiving.Tests.AccessProtocolListTests.GetDocumentationUri_ProgramDirectoryNotSpecified_ReturnsRootedPathToExistingFile

dotnet test SIL.Archiving.Tests/SIL.Archiving.Tests.csproj --filter "FullyQualifiedName~GetDocumentationUri_ProgramDirectoryNotSpecified_ReturnsRootedPathToExistingFile"

Devin review: https://app.devin.ai/review/sillsdev/libpalaso/pull/1510

🤖 Generated with Claude Code


This change is Reviewable

#1392)

GetDocumentationUri stripped the extension from DocumentationFile before
calling GetResource, so "ailca.html" became "ailca" and no longer matched
the embedded resource name SIL.Archiving.Resources.ailca.html. Pass the
full filename so the missing file can be created from the resource.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@imnasnainaec imnasnainaec self-assigned this Jun 16, 2026
@imnasnainaec
imnasnainaec marked this pull request as ready for review June 16, 2026 19:28
@github-actions

github-actions Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Palaso Tests

     4 files  ±0       4 suites  ±0   10m 13s ⏱️ +16s
 5 102 tests ±0   4 869 ✅ ±0  233 💤 ±0  0 ❌ ±0 
16 618 runs  ±0  15 899 ✅ +1  719 💤  - 1  0 ❌ ±0 

Results for commit b58aa60. ± Comparison against base commit f48a3d5.

♻️ This comment has been updated with latest results.

@imnasnainaec imnasnainaec changed the title Fix GetDocumentationUri resource lookup for missing documentation file (#1392) Fix GetDocumentationUri resource lookup for missing doc file Jun 16, 2026

@myieye myieye left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any idea if SkipOnTeamCity should actually be removed?

@imnasnainaec

Copy link
Copy Markdown
Contributor Author

Any idea if SkipOnTeamCity should actually be removed?

There are global files being modified in those tests, so they would require significant refactor.

@imnasnainaec
imnasnainaec enabled auto-merge (squash) June 18, 2026 13:19
@imnasnainaec
imnasnainaec merged commit 87d3e6d into master Jun 18, 2026
9 checks passed
@imnasnainaec
imnasnainaec deleted the fix-1392-access-protocol-documentation-uri branch June 18, 2026 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

GetDocumentationUri_ProgramDirectoryNotSpecified_ReturnsRootedPathToExistingFile fails

2 participants