295 contentchanged for layers and pages

[cubap]

No description provided.

[cubap]

This pull request introduces several improvements and bug fixes focused on the handling and updating of Page and Layer objects, as well as enhancements to reference management and request validation. The most important changes are grouped below by theme.

Reference management and data consistency

• Added a new upgradeReferences utility function to standardize and upgrade object references (such as partOf) to use the RERUMIDPREFIX format, and integrated its use in the Page class constructor. [1] [2] [3]
• Ensured the type property defaults to "Annotation" in the Line class when not explicitly set, improving data consistency.

Page and Layer update logic

• Refactored the updatePageAndProject function to remove the contentChanged parameter, streamline the update process, and ensure the correct layer and page are updated in the project. Now, the function always updates the appropriate layer and project if the page has a RERUM ID.
• Improved the Page class's update method to better detect when updates are necessary by checking for the presence of items or objects with a body property.

API and validation improvements

• Enhanced the page update API endpoint to more robustly validate incoming update data, ensuring it is a non-empty object, and improved error handling for missing or invalid layers. [1] [2]
• Updated the URL validation utility to properly capture and ignore caught errors, preventing unhandled exceptions.

Minor bug fixes and cleanup

• Removed unnecessary checks and streamlined logic in the page update endpoint, including redundant checks for pageContentChanged and improved property assignment. [1] [2] [3]
• Fixed a bug in getLayerContainingPage to safely handle projects that may not have a data property.

[cubap]

flowchart TD
    A([Start]) --> B{Project exists?}
    B -- No --> E1[Throw Error: Must know project to update Layer]
    B -- Yes --> C{Layer is provided?}
    C -- No --> E2[Throw Error: Layer must be provided to update]
    C -- Yes --> D{UserId exists?}
    D -- No --> E3[Throw Error: Must know user id to update layer]
    D -- Yes --> F{Layer creator exists?}
    F -- No --> G[Set layer creator using fetchUserAgent with userId]
    F -- Yes --> H[Find layer index in project layers]
    G --> H
    H --> I[Update layer and store as updatedLayer]
    I --> J{Layer id in project equals updatedLayer id?}
    J -- Yes --> M[Replace project layer at index with updatedLayer]
    J -- No --> K[Initialize pageOverwrites array]
    K --> L[Loop through each page in updatedLayer]
    L --> L1[Set page partOf id to updatedLayer id]
    L1 --> L2{Page id starts with RERUMIDPREFIX?}
    L2 -- No --> L3[Continue to next page]
    L2 -- Yes --> L4[Find old page in RERUM using tiny]
    L4 --> L5{Old page found?}
    L5 -- No --> E4[Throw Error: Page not found in RERUM]
    L5 -- Yes --> L6[Update old page partOf to reference updatedLayer]
    L6 --> L7[Push overwrite promise to pageOverwrites]
    L3 --> N[Replace project layer at index with updatedLayer]
    L7 --> N
    M --> O[Await all pageOverwrites and catch errors]
    N --> O
    O --> P[Update project]
    P --> Q([End])

Loading

[thehabes]

Unfortunately this makes updatePageAndProject() non-functional as experienced through the /annotator interface and the http://localhost:4000/components/manage-layers/index.html component POC.

Originally it threw a 500
Cannot update Page. Its Layer was not found.

This was a failure due to a naïve falsey checker, which I put in a commit for.

After that, I received a different 500
User ID is required to fetch user agent

Gotta stop chasing the rabbit. This needs attention because it has breaking changes. I cannot use the /annotator interface or reorder pages with http://localhost:4000/components/manage-layers/index.html anymore.

[thehabes]

I went through this using TPEN Interfaces to test the scenarios where we do or do not introduce content/creators into the data flow. Data remained temp or was upgraded as expected. The creator property accompanies RERUM data.

Temp ids resolve as expected, and devstore.rerum.io ids resolve as expected.