Layer Routes With Layer, Page, and Line Class Refactor (#469)

* First push at refactoring for the Layer

* First push at refactoring for the Layer

* Changes during readthrough and testing

* Changes during readthrough and testing

* Changes during readthrough and testing

* Changes during readthrough and testing

* Changes during readthrough and testing

* Changes during readthrough and testing

* Changes during readthrough and testing

* Changes during readthrough and testing

* Changes during readthrough and testing

* Changes during readthrough and testing

* Changes during review and testing

* move this back

* changes during testing and review

* changes during testing and review

* changes during testing and review

* changes during testing and review

* changes during testing and review

* Changes from cubap review

* Changes from cubap review

* Make sure Layer references in the Pages are upgraded when Layer is upgraded

Author: thehabes

classes/Layer/Layer.js

@@ -1,5 +1,4 @@
 import dbDriver from "../../database/driver.js"
-import { handleVersionConflict } from "../../utilities/shared.js"
 import Page from "../Page/Page.js"
 import { fetchUserAgent } from "../../utilities/shared.js"
 import ProjectFactory from "../Project/ProjectFactory.js"
@@ -8,6 +7,7 @@ const databaseTiny = new dbDriver("tiny")
 
 export default class Layer {
     #tinyAction = 'create'
+    #hydrated = false
 
     /**
      * Constructs a Layer from the JSON Object in the Project `layers` Array.
@@ -17,6 +17,7 @@ export default class Layer {
      * @param {string} id The ID of the layer. This is the Layer stored in the Project.
      * @param {string} label The label of the layer. This is the Layer stored in the Project.
      * @param {Array} pages The pages in the layer by reference.
+     * @param {string|null} [creator=null] The creator/agent URI for this layer.
      * @seeAlso {@link Layer.build}
      */
     constructor(projectId, { id, label, pages, creator = null }) {
@@ -31,6 +32,9 @@ export default class Layer {
         this.label = label
         this.creator = creator
         this.pages = pages
+        this.total = pages.length
+        this.first = pages.at(0)?.id
+        this.last = pages.at(-1)?.id
         if (this.id.startsWith(process.env.RERUMIDPREFIX)) {
             this.#tinyAction = 'update'
         }
@@ -79,13 +83,49 @@ export default class Layer {
             this.#setRerumId()
             await this.#saveCollectionToRerum()
         }
+        this.total = this.pages.length
+        this.first = this.pages.at(0)?.id
+        this.last = this.pages.at(-1)?.id
+        this.#hydrated = true
         return this.#formatCollectionForProject()
     }
 
     asProjectLayer() {
         return this.#formatCollectionForProject()
     }
 
+    /**
+     * Returns a JSON representation of the Layer as a W3C AnnotationCollection.
+     * @param {boolean} isLD - If true, returns JSON-LD format with @context and type. If false, returns a simple object.
+     * @returns {Promise<Object>} The Layer as JSON.
+     */
+    async asJSON(isLD) {
+        if (!this.#hydrated && this.id?.startsWith?.(process.env.RERUMIDPREFIX)) {
+            await this.#loadAnnotationCollectionDataFromRerum()
+        }
+        let result
+        if (isLD) {
+            result = {
+                '@context': 'http://iiif.io/api/presentation/3/context.json',
+                id: this.id,
+                type: 'AnnotationCollection',
+                label: { "none": [this.label] },
+                total: this.pages.length,
+                first: this.pages.at(0)?.id,
+                last: this.pages.at(-1)?.id
+            }
+            if (this.creator) result.creator = this.creator
+        }
+        else {
+            result = {
+                id: this.id,
+                label: this.label,
+                pages: this.pages
+            }
+        }
+        return result
+    }
+
     // Private Methods
     #setRerumId() {
         if (!this.id.startsWith(process.env.RERUMIDPREFIX)) {
@@ -94,6 +134,45 @@ export default class Layer {
         return this
     }
 
+    /**
+     * Resolve the RERUM URI of the Layer and sync Layer properties with the AnnotationCollection properties.
+     * The RERUM data will take preference and overwrite any properties that are already set.
+     * Only RERUM URIs are supported.
+     */
+    async #loadAnnotationCollectionDataFromRerum() {
+        if (this.id.startsWith?.(process.env.RERUMIDPREFIX)) {
+            const rawLayerData = await fetch(this.id).then(async (resp) => {
+                if (resp.ok) return resp.json()
+                let rerumErrorMessage
+                try {
+                    rerumErrorMessage = `${resp.status ?? 500}: ${this.id} - ${await resp.text()}`
+                } catch (e) {
+                    rerumErrorMessage = `500: ${this.id} - A RERUM error occurred`
+                }
+                const err = new Error(rerumErrorMessage)
+                err.status = 502
+                throw err
+            })
+            .catch(err => {
+                if (err.status === 502) throw err
+                const genericRerumNetworkError = new Error(`500: ${this.id} - A RERUM error occurred`)
+                genericRerumNetworkError.status = 502
+                throw genericRerumNetworkError
+            })
+            if (!(rawLayerData.id || rawLayerData["@id"])) {
+                const genericRerumNetworkError = new Error(`500: ${this.id} - A RERUM error occurred`)
+                genericRerumNetworkError.status = 502
+                throw genericRerumNetworkError
+            }
+            this.#tinyAction = 'update'
+            this.id = rawLayerData.id ?? rawLayerData["@id"] ?? this.id
+            if (rawLayerData.label) this.label = ProjectFactory.getLabelAsString(rawLayerData.label)
+            if (rawLayerData.creator) this.creator = rawLayerData.creator
+            this.#hydrated = true
+        }
+        return this
+    }
+
     #formatCollectionForProject() {
         return {
             id: this.id,
@@ -108,40 +187,53 @@ export default class Layer {
 
     async #saveCollectionToRerum() {
         const layerAsCollection = {
-            "@context": "http://www.w3.org/ns/anno.jsonld",
+            "@context": "http://iiif.io/api/presentation/3/context.json",
             id: this.id,
             type: "AnnotationCollection",
             label: { "none": [this.label] },
             creator: await fetchUserAgent(this.creator),
             total: this.pages.length,
-            first: this.pages.at(0).id,
-            last: this.pages.at(-1).id
+            first: this.pages.at(0)?.id,
+            last: this.pages.at(-1)?.id
         }
 
         if (this.#tinyAction === 'create') {
-            await databaseTiny.save(layerAsCollection).catch(err => {
+            await databaseTiny.save(layerAsCollection)
+            .catch(err => {
                 console.error(err, layerAsCollection)
                 throw new Error(`Failed to save Layer to RERUM: ${err.message}`)
             })
             this.#tinyAction = 'update'
+            this.#hydrated = true
             return this
         }
 
-        const existingLayer = await fetch(this.id).then(res => res.json())
-        if (!existingLayer) {
-            throw new Error(`Layer not found in RERUM: ${this.id}`)
-        }
-        const updatedLayer = { ...existingLayer, ...layerAsCollection }
-        
-        // Handle optimistic locking version if available        
-        try {
-            await databaseTiny.overwrite(updatedLayer)
-            return this
-        } catch (err) {
-            if (err.status === 409) {
-                throw handleVersionConflict(null, err)
+        const existingLayer = await fetch(this.id).then(async (resp) => {
+            if (resp.ok) return resp.json()
+            let rerumErrorMessage
+            try {
+                rerumErrorMessage = `${resp.status ?? 500}: ${this.id} - ${await resp.text()}`
+            } catch (e) {
+                rerumErrorMessage = `500: ${this.id} - A RERUM error occurred`
             }
+            const err = new Error(rerumErrorMessage)
+            err.status = 502
             throw err
+        })
+        .catch(err => {
+            if (err.status === 502) throw err
+            const genericRerumNetworkError = new Error(`500: ${this.id} - A RERUM error occurred`)
+            genericRerumNetworkError.status = 502
+            throw genericRerumNetworkError
+        })
+        if (!(existingLayer?.id || existingLayer?.["@id"])) {
+            const genericRerumNetworkError = new Error(`500: ${this.id} - A RERUM error occurred`)
+            genericRerumNetworkError.status = 502
+            throw genericRerumNetworkError
         }
+        const updatedLayer = { ...existingLayer, ...layerAsCollection }
+        await databaseTiny.overwrite(updatedLayer)
+        this.#hydrated = true
+        return this
     }
 }

layer/index.js

@@ -7,7 +7,7 @@ import cors from 'cors'
 import common_cors from '../utilities/common_cors.json' with {type: 'json'}
 import Project from '../classes/Project/Project.js'
 import Layer from '../classes/Layer/Layer.js'
-import { findPageById, findLayerById, updateLayerAndProject, respondWithError } from '../utilities/shared.js'
+import { findPageById, findLayerById, updateLayerAndProject, respondWithError, handleVersionConflict } from '../utilities/shared.js'
 import { ACTIONS, ENTITIES, SCOPES } from '../project/groups/permissions_parameters.js'
 
 const router = express.Router({ mergeParams: true })
@@ -19,35 +19,16 @@ router.route('/:layerId')
     .get(async (req, res) => {
         const { projectId, layerId } = req.params
         try {
-            const layer = await findLayerById(layerId, projectId, true)
-            if (!layer) {
-                return respondWithError(res, 404, 'No layer found with that ID.')
-            }
-            if (layer.id?.startsWith(process.env.RERUMIDPREFIX)) {
-                // If the page is a RERUM document, we need to fetch it from the server
-                res.status(200).json(layer)
-                return
-            }
-            // Make this internal Layer look more like a RERUM AnnotationCollection
-            const layerAsCollection = {
-                '@context': 'http://www.w3.org/ns/anno.jsonld',
-                id: layer.id,
-                type: 'AnnotationCollection',
-                label: { none: [layer.label] },
-                total: layer.pages.length,
-                first: layer.pages.at(0).id,
-                last: layer.pages.at(-1).id
-            }
-            if (layer.creator) layerAsCollection.creator = layer.creator
-            return res.status(200).json(layerAsCollection)
+            const layer = await findLayerById(layerId, projectId)
+            const layerJson = await layer.asJSON(true)
+            return res.status(200).json(layerJson)
         } catch (error) {
             console.error(error)
             return respondWithError(res, error.status ?? 500, error.message ?? 'Internal Server Error')
         }
     })
     .put(auth0Middleware(), screenContentMiddleware(), async (req, res) => {
         const { projectId, layerId } = req.params
-        let label = req.body?.label
         const update = req.body
         const providedPages = update?.pages
         const user = req.user
@@ -56,21 +37,19 @@ router.route('/:layerId')
         if (!layerId) return respondWithError(res, 400, 'Layer ID is required')
         try {
             if (hasSuspiciousLayerData(req.body)) return respondWithError(res, 400, "Suspicious layer data will not be processed.")
-            const projectObj = new Project(projectId)
-            if (!(await projectObj.checkUserAccess(user._id, ACTIONS.UPDATE, SCOPES.ALL, ENTITIES.LAYER))) {
+            const project = new Project(projectId)
+            if (!(await project.checkUserAccess(user._id, ACTIONS.UPDATE, SCOPES.ALL, ENTITIES.LAYER))) {
                 return respondWithError(res, 403, 'You do not have permission to update this layer')
             }
-            const project = await Project.getById(projectId)
-            if (!project?._id) return respondWithError(res, 404, `Project '${projectId}' does not exist`)
+            if (!project?.data) return respondWithError(res, 404, `Project ${projectId} was not found`)
             const layer = await findLayerById(layerId, projectId)
-            if (!layer?.id) return respondWithError(res, 404, `Layer '${layerId}' not found in project`)
             // Only update top-level properties that are present in the request
             Object.keys(update ?? {}).forEach(key => {
                 layer[key] = update[key]
             })
             Object.keys(layer).forEach(key => {
                 if (layer[key] === undefined || layer[key] === null) {
-                  // Remove properties that are undefined or null.  prev and next can be null
+                  // Remove properties that are undefined or null.  first and last can be null
                   if (key !== "first" && key !== "last") delete layer[key]
                   else layer[key] = null
                 }
@@ -81,14 +60,22 @@ router.route('/:layerId')
                 layer.pages = pages
             }
             await updateLayerAndProject(layer, project, user._id)
-            res.status(200).json(layer)
+            const layerJson = await layer.asJSON(true)
+            res.status(200).json(layerJson)
         } catch (error) {
             console.error(error)
-            return respondWithError(res, error.status ?? 500, error.message ?? 'Error updating layer')
+            // Handle version conflicts with optimistic locking
+            if (error.status === 409) {
+                if (res.headersSent) return
+                return handleVersionConflict(res, error)
+            } else {
+                if (res.headersSent) return
+                return respondWithError(res, error.status ?? 500, error.message ?? 'Error updating layer')
+            }
         }
     })
     .all((req, res) => {
-        return respondWithError(res, 405, 'Improper request method. Use GET instead.')
+        return respondWithError(res, 405, 'Improper request method. Use GET or PUT.')
     })
 
 // Route to create a new layer within a project
@@ -106,12 +93,11 @@ router.route('/').post(auth0Middleware(), screenContentMiddleware(), async (req,
     }
     try {
         if (hasSuspiciousLayerData(req.body)) return respondWithError(res, 400, "Suspicious layer data will not be processed.")
-        const projectObj = new Project(projectId)
-        if (!(await projectObj.checkUserAccess(user._id, ACTIONS.CREATE, SCOPES.ALL, ENTITIES.LAYER))) {
+        const project = new Project(projectId)
+        if (!(await project.checkUserAccess(user._id, ACTIONS.CREATE, SCOPES.ALL, ENTITIES.LAYER))) {
             return respondWithError(res, 403, 'You do not have permission to create layers in this project')
         }
-        const project = await Project.getById(projectId)
-        if (!project) return respondWithError(res, 404, 'Project does not exist')
+        if (!project?.data) return respondWithError(res, 404, `Project ${projectId} was not found`)
         const newLayer = Layer.build(projectId, label, canvases)
         project.addLayer(newLayer.asProjectLayer())
         await project.update()