Skip to content

feat: improve async signing error handling #6587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
vitormattos merged 34 commits into from
Jan 26, 2026
Merged

feat: improve async signing error handling #6587

vitormattos merged 34 commits into from
Jan 26, 2026
+3,037 −240

Conversation

@vitormattos
Copy link
Member

@vitormattos vitormattos commented Jan 26, 2026

No description provided.

@vitormattos
feat: add error reporting infrastructure for async signing
20b84e0 
Add StatusCacheService for caching file status during async operations.
Add SignRequestErrorReporter for storing and retrieving per-file errors.
Add ErrorPayloadBuilder for consistent error payloads.

These services enable granular error tracking during background signing
jobs and provide detailed feedback to users about which specific files
failed and why.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
feat: extend ProgressService with per-file error tracking
598f90a 
Add methods to set/get/clear errors for individual files and sign requests.
Implement long-polling with error detection across envelope children.
Add fallback to metadata when cache is not available.

This allows the frontend to display specific error messages for each
file in a multi-file signing workflow, improving user feedback.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
refactor: inject StatusCacheService into StatusService
66a50e4 
Replace direct cache access with StatusCacheService dependency.
Add getByEnvelopeChildrenAndIdentifyMethod to SignRequestMapper for
querying child sign requests.

This improves testability and centralizes status caching logic.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
feat: integrate error reporting in SignJobCoordinator
ba96277 
Inject ProgressService and SignRequestErrorReporter.
Clear errors before signing and report errors on exceptions.
Preserve detailed error messages with HTTP status codes.

Background jobs now store specific error information that the
frontend can retrieve and display to users.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
refactor: inject StatusService dependency in signing services
145eea9 
Update SignFileService, AsyncSigningService, and background jobs to
inject StatusService explicitly instead of relying on internal creation.

Improves dependency injection and testability.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
feat: enhance FileProgressController with detailed error info
bd44877 
Add per-file error details to progress responses.
Improve envelope progress with child file error aggregation.
Change from short polling to long-polling for better efficiency.

Users now see specific error messages for each file that fails
during async signing, rather than generic failure messages.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
feat: display per-file errors in SigningProgress component
a17fc61 
Show individual file error messages with error icons.
Improve polling logic to handle file-level errors gracefully.
Switch to long-polling (immediate retry) for better responsiveness.
Add error state detection to stop polling when appropriate.

Users now see which specific files failed and why during batch
signing operations.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
feat: improve async signing UX in Validation view
b8a6a4a 
Hide sidebar when async signing starts for cleaner UI.
Keep async view visible on error to show per-file error details.
Improve error handling flow in RequestSignatureTab.

This prevents the UI from closing prematurely and allows users to
see detailed error information for failed signing operations.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
test: add unit tests for error reporting infrastructure
99b1359 
Add comprehensive tests for ErrorPayloadBuilder and SignRequestErrorReporter.
Cover error serialization, HTTP code extraction, and error storage/retrieval.

Ensures error reporting services work correctly and maintain data integrity.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
test: extend ProgressServiceTest with error tracking tests
63d715f 
Add tests for per-file error storage and retrieval.
Test error fallback to metadata when cache unavailable.
Add tests for envelope progress with file errors.
Include long-polling tests with error detection.

Validates that error tracking works across all progress
calculation scenarios including envelopes and single files.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
test: update existing tests for new dependencies
5e387e0 
Update SignJobCoordinatorTest with error reporting validation.
Update SignFileServiceTest, StatusServiceTest, and RequestSignatureServiceTest
to inject StatusCacheService and StatusService.

Maintains test coverage after dependency injection changes.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
test: add comprehensive tests for FileProgressController
b13b215 
Add tests for envelope progress endpoint with error details.
Test single file progress with error information.
Validate error payload structure and HTTP responses.
Test long-polling timeout behavior.

Ensures controller correctly exposes per-file error information
to the frontend via API endpoints.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
chore: regenerate OpenAPI spec and TypeScript types
8c8ae56 
Update OpenAPI specifications and TypeScript types to reflect
new error fields in FileProgressController responses.

Generated from updated PHP annotations.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos vitormattos added this to the Next Major (34) milestone Jan 26, 2026
@vitormattos vitormattos self-assigned this Jan 26, 2026
@github-project-automation github-project-automation bot moved this to 0. Needs triage in Roadmap Jan 26, 2026
@vitormattos
fix: reduce mixed usage and use specific types
28e9457 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
fix: update documentation
0ae800b 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
chore: move cache ttl to a constant
a9d499c 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
fix: cs
890210a 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
feat: add new response type to clean code
a3418e7 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
chore: update documentation
38dccd5 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
fix: update docblock
3ece2e1 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
fix: typing
3946029 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
fix: psalm
4e1a4c3 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
refactor: remove empty row
c9b6940 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
fix: indent
4753c53 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
chore: clean code
10d78e7 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
fix: improve unit test
180e765 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
chore: tests improvements
dd664f8 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
refactor: use ncnotecard
677a82f 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
chore: remove unecessary comment
3c9e3b2 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
refactor: cleanup tests
81153a2 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
feat: cover with more dataproviders
68f087a 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
feat: cover with more scenarios
09bb985 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
feat: cover with more tests
22f907c 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
fix: cs
6e91822 
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
Copy link
Member Author

vitormattos commented Jan 26, 2026

/backport to stable32

@vitormattos
Copy link
Member Author

vitormattos commented Jan 26, 2026

/backport to stable33

@vitormattos vitormattos merged commit 4e56d16 into main Jan 26, 2026
42 checks passed
@vitormattos vitormattos deleted the feat/improve-async-signing-error-handling branch January 26, 2026 22:29
@github-project-automation github-project-automation bot moved this from 0. Needs triage to 4. to release in Roadmap Jan 26, 2026
@vitormattos
Copy link
Member Author

vitormattos commented Jan 26, 2026

/backport to stable33

This was referenced Jan 26, 2026
Merged
Merged
@backportbot-libresign
Copy link

backportbot-libresign bot commented Jan 26, 2026

The backport to stable33 failed. Please do this backport manually.

# Switch to the target branch and update it
git checkout stable33
git pull origin stable33

# Create the new backport branch
git checkout -b backport/6587/stable33

# Cherry pick the change from the commit sha1 of the change against the default branch
# This might cause conflicts, resolve them
git cherry-pick 20b84e07 598f90ac 66a50e4b ba962777 145eea91 bd448770 a17fc610 b8a6a4a0 99b1359c 63d715f4 5e387e0a b13b215f 8c8ae564 28e94578 0ae800bc a9d499c5 890210a5 a3418e7e 38dccd56 3ece2e19 39460297 4e1a4c31 c9b6940a 4753c539 10d78e74 180e765a dd664f83 677a82f7 3c9e3b22 81153a2e

# Push the cherry pick commit to the remote repository and open a pull request
git push origin backport/6587/stable33

Error: Failed to create pull request: Validation Failed: {"resource":"PullRequest","code":"custom","message":"A pull request already exists for LibreSign:backport/6587/stable33."}

Learn more about backports at https://docs.nextcloud.com/server/stable/go.php?to=developer-backports.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@vitormattos vitormattos

Labels

None yet

Projects

Roadmap
Status: 4. to release

Milestone

Next Major (34)

Development

Successfully merging this pull request may close these issues.

2 participants

@vitormattos