Bug fixes issue #10 by ututono · Pull Request #71 · UKPLab/CARE

ututono · 2026-01-27T14:00:14Z

Goal: This patch aims to resolve the issue #10, addressing multiple bugs related to document validation. The main focus is on providing a better user experience when documents are missing, deleted, or inaccessible.

Key Changes:

Added a new validateDocument() method in backend/webserver/sockets/document.js that centralizes document validation logic:
- Checks for: database record existence, user access permissions, and file existence on disk
- Returns structured error codes (DOCUMENT_NOT_FOUND, ACCESS_DENIED, FILE_MISSING), details are in the comment [BUG] Error when document is not loaded #10 (comment), for consistent error handling
Improved UX - Error Pages Instead of Toasts. Replaced toast notifications with more informative error pages when documents are unavailable. Implemented in both Document.vue and Study.vue components.
Loading Modal Fixes. Fixed issue where the loading modal would freeze when encountering document errors. The result why close() can not correctly terminate the loading modal seems to be hide() deferred when isShown=false, but component unmounts before deferred hide runs in frontend/src/basic/Modal.vue. Modal now properly closes and emits error events when a document cannot be loaded by replacing hide() with dispose() in beforeunmount().
Error messages are now consistent whether a file was deleted through the UI or is missing from the file system.

Demonstration:
Test accessing shared links to the document which has been deleted from the UI interface and from the filesystem accordingly.

Test accessing shared links to the study which uses a document which has been deleted from the UI interface and from the filesystem accordingly.

… display a error page if an error occur while loading a doucment

… triggle a error prompt and the step modal doesn't freeze the window

…ile corrputed in file system

backend/webserver/sockets/app.js

frontend/src/components/Study.vue

…orMessage`.

ututono · 2026-02-11T14:19:12Z

@dennis-zyska I’ve addressed your requested changes and pushed an updated commit 5216562. Could you please take another look?

@NilsDy FYI

dennis-zyska

The solution with the text parsing with the error codes should be improved. We can change the function here: https://github.com/UKPLab/CARE/blob/main/backend/webserver/Socket.js#L86 and add a specific variables for the error code. It should be backward compatible. One possible solution would be to create an Error from the Error class and set the error code. If the error code is set, we send it back to the frontend, otherwise we use the previous solultion (in that way we don't need to adapt to much from the existing code). Here is a potential solution that could work: https://stackoverflow.com/a/69166148

dennis-zyska · 2026-02-13T12:15:08Z

backend/webserver/sockets/document.js

+            let filePath;
+            if (document.type === this.models['document'].docTypes.DOC_TYPE_HTML || 
+                document.type === this.models['document'].docTypes.DOC_TYPE_MODAL) {
+                filePath = `${UPLOAD_PATH}/${document.hash}.delta`;


there is not always a delta file for HTML or MODAL documents and also no need, as every edit is still saved in the database. It is enough to only consider the PDF case.

dennis-zyska · 2026-02-13T12:40:04Z

frontend/src/components/Document.vue

+    /**
+     * Parse "ERROR_CODE|message" format from server error
+     */
+    parseErrorMessage(raw) {


I'm not sure if it is a good idea to parse error codes like this, I can also find code in different components that is used the same time. Maybe we should integrate error codes properly.

…moved dead `documentError` socket listener

ututono · 2026-02-18T16:57:53Z

@dennis-zyska I’ve addressed your requested changes and pushed an updated commit. And also merged the latest dev into this bug fix branch. Could you please take another look?

@NilsDy FYI

dennis-zyska · 2026-02-26T13:38:11Z

backend/webserver/sockets/app.js

+
+        if (!record) {
+            // Record doesn't exist or was deleted
+            errorCode = "NOT_FOUND";


Maybe we can create a new helper function in the utils/generic.js, such that we don't need 5 lines, to be able to reduce it, something like, as an example `throw new GenerateError("NOT_FOUND", "The request ..")

I introduced a reusable generateError(code, message) helper in utils/generic.js and refactored this branch to use throw generateError(...) here (and in similar socket paths)

dennis-zyska · 2026-02-26T13:39:14Z

frontend/src/components/study/LoadingModal.vue

      this.close();
    },
+
+    getErrorMessage(response) {


We define here the message and codes again, does this make sense? If we send all the data already from the backend to the frontend?

I removed the duplicated local error-message map in LoadingModal and same function in other place such as Document.vue and now use backend-provided response.message directly, but I introduced a map titleMap between error code and title of the loading modal to provide more readable information in frontend.

frontend/src/components/Document.vue

…n in sockets and backend

…gic with `titleMap` so that front emits the same end error message and error cod as backend

ututono · 2026-03-09T19:09:06Z

@dennis-zyska I’ve addressed your requested changes and pushed an updated commit. And also merged the latest dev into this bug fix branch. Could you please take another look?

@NilsDy FYI

Also this PR could be reviewed within my team first, I'd assign it to one of team members for first review

ututono added 8 commits January 5, 2026 13:05

fix: Fix null checks in sendByHash, getDocument, getData

e8592bb

fix: unified document validation into validateDocument. Document will…

f93ac75

… display a error page if an error occur while loading a doucment

fix: fix return empty value and cleanup the code

3c0674c

fix: access a session with missing document from UI interface now can…

5ab0012

… triggle a error prompt and the step modal doesn't freeze the window

clean: revise error message

7828744

fix: completely terminate loading modal

a2963f1

fix: enhance UX by providing an error page instead of a toast

20b5f00

fix: keep error message consistent between file deleted from UI and f…

39861ec

…ile corrputed in file system

ututono self-assigned this Jan 27, 2026

ututono linked an issue Jan 27, 2026 that may be closed by this pull request

[BUG] Error when document is not loaded #10

Open

3 tasks

dennis-zyska requested a review from pdji1602003 February 6, 2026 22:28

dennis-zyska requested changes Feb 6, 2026

View reviewed changes

backend/webserver/sockets/app.js Outdated Show resolved Hide resolved

frontend/src/components/Study.vue Outdated Show resolved Hide resolved

fix: removed socket events and centralized error parsing in `parseErr…

5216562

…orMessage`.

ututono requested a review from dennis-zyska February 11, 2026 14:20

dennis-zyska requested changes Feb 13, 2026

View reviewed changes

ututono added 5 commits February 17, 2026 14:51

Merge remote-tracking branch 'origin/dev' into fix-10-bug_fixes

7e53400

fix: add a new field error code in callback response

4a0cab3

fix: uses err.code instead of `"CODE|msg" string pattern.

0fd111a

fix: Removed parseErrorMessage(), uses response.code directly. Re…

52ce7e8

…moved dead `documentError` socket listener

Merge branch 'dev' into fix-10-bug_fixes

8fc4226

ututono requested a review from dennis-zyska February 18, 2026 16:56

ututono changed the title ~~Fix 10 bug fixes~~ Bug fixes issue #10 Feb 19, 2026

dennis-zyska requested changes Feb 26, 2026

View reviewed changes

ututono added 4 commits March 3, 2026 10:45

Merge branch 'dev' into fix-10-bug_fixes

47aca6a

fix: centralize error handling with generateError() utility functio…

8043172

…n in sockets and backend

fix: unify error message parsing by replacing redundant errorMap lo…

fe35b6e

…gic with `titleMap` so that front emits the same end error message and error cod as backend

Merge branch 'dev' into fix-10-bug_fixes_merge

43a3b33

ututono requested a review from dennis-zyska March 9, 2026 19:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bug fixes issue #10 #71

Bug fixes issue #10 #71
ututono wants to merge 18 commits intodevfrom
fix-10-bug_fixes

ututono commented Jan 27, 2026

Uh oh!

Uh oh!

Uh oh!

ututono commented Feb 11, 2026 •

edited

Loading

Uh oh!

dennis-zyska left a comment

Uh oh!

dennis-zyska Feb 13, 2026

Uh oh!

dennis-zyska Feb 13, 2026

Uh oh!

ututono commented Feb 18, 2026 •

edited

Loading

Uh oh!

dennis-zyska Feb 26, 2026

Uh oh!

ututono Mar 9, 2026

Uh oh!

dennis-zyska Feb 26, 2026

Uh oh!

ututono Mar 9, 2026 •

edited

Loading

Uh oh!

Uh oh!

ututono commented Mar 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

ututono commented Jan 27, 2026

Uh oh!

Uh oh!

Uh oh!

ututono commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dennis-zyska left a comment

Choose a reason for hiding this comment

Uh oh!

dennis-zyska Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

dennis-zyska Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

ututono commented Feb 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dennis-zyska Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

ututono Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

dennis-zyska Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

ututono Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ututono commented Mar 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ututono commented Feb 11, 2026 •

edited

Loading

ututono commented Feb 18, 2026 •

edited

Loading

ututono Mar 9, 2026 •

edited

Loading