Skip to content

478 role action false success #506

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

Merged
thehabes merged 6 commits into from
Mar 16, 2026
Merged

478 role action false success #506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c6a816e
Update project.test.js
cubap Mar 10, 2026
df60ecb
Validate API responses and improve error handling
cubap Mar 10, 2026
f2c837c
Merge branch 'main' into 478-role-action-false-success
thehabes Mar 16, 2026
69d9f03
Changes during review
thehabes Mar 16, 2026
718d6ef
Changes during review
thehabes Mar 16, 2026
af0e655
Ready to merge, but needs fixed because the manage collaborators inte…
thehabes Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
327 changes: 125 additions & 202 deletions api/Project.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,47 @@ import { userMessage } from "../components/iiif-tools/index.js"

export default class Project {

#authentication
#isLoaded

// We eventually want this caught and managed better upstream, but we might get 200 responses here that do not represent success (#478).
async #validateResponse(response, fallbackMessage) {
const contentType = response?.headers?.get?.('content-type') ?? ''
let payload = null

if (contentType.includes('application/json')) {
payload = await response.json().catch(() => null)
} else {
const text = await response.text().catch(() => '')
if (text) {
try {
payload = JSON.parse(text)
} catch {
payload = { message: text }
}
}
}

if (!response.ok) {
const errorMessage = payload?.message ?? payload?.error ?? payload?.errorResponse?.errmsg ?? `${fallbackMessage}: ${response.status}`
throw new Error(errorMessage)
}

const hasSemanticError = Boolean(
payload?.error ||
payload?.errorResponse ||
payload?.ok === false ||
payload?.success === false ||
(typeof payload?.status === 'number' && payload.status >= 400)
)

if (hasSemanticError) {
const semanticMessage = payload?.message ?? payload?.error?.message ?? payload?.errorResponse?.errmsg ?? payload?.error ?? fallbackMessage
throw new Error(semanticMessage)
}

return payload
}

constructor(_id) {
if (typeof _id !== "string") {
throw new Error("Project ID must be a string")
Expand Down Expand Up @@ -103,163 +141,119 @@ export default class Project {
}

async addMember(email, roles = undefined) {
try {
const AUTH_TOKEN = TPEN.getAuthorization() ?? TPEN.login()
const response = await fetch(`${TPEN.servicesURL}/project/${this._id}/invite-member`, {
headers: {
Authorization: `Bearer ${AUTH_TOKEN}`,
'Content-Type': 'application/json',
},
method: "POST",
body: JSON.stringify({ email, roles }),
})
if (!response.ok) {
const errorData = await response.json()
throw new Error(errorData.message || `Failed to invite collaborator: ${response.statusText}`)
}

return await response.json()
} catch (error) {
userMessage(error.message)
}
const AUTH_TOKEN = TPEN.getAuthorization() ?? TPEN.login()
const response = await fetch(`${TPEN.servicesURL}/project/${this._id}/invite-member`, {
headers: {
Authorization: `Bearer ${AUTH_TOKEN}`,
'Content-Type': 'application/json',
},
method: "POST",
body: JSON.stringify({ email, roles }),
})
const payload = await this.#validateResponse(response, 'Failed to invite collaborator')
return payload ?? response
}

async removeMember(userId) {
try {
const token = TPEN.getAuthorization() ?? TPEN.login()
const response = await fetch(`${TPEN.servicesURL}/project/${this._id}/remove-member`, {
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ userId }),
})
if (!response.ok) {
throw new Error(`Error removing member: ${response.status}`)
}
const token = TPEN.getAuthorization() ?? TPEN.login()
const response = await fetch(`${TPEN.servicesURL}/project/${this._id}/remove-member`, {
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ userId }),
})
const payload = await this.#validateResponse(response, 'Error removing member')

delete this.collaborators[userId]
return await response
} catch (error) {
userMessage(error.message)
}
delete this.collaborators[userId]
return payload ?? response
}

async makeLeader(userId) {
try {
const token = TPEN.getAuthorization() ?? TPEN.login()
const response = await fetch(`${TPEN.servicesURL}/project/${this._id}/collaborator/${userId}/addRoles`, {
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
'Content-Type': 'application/json',
},
body: JSON.stringify(["LEADER"]),
})
if (!response.ok) {
throw new Error(`Error promoting user to LEADER: ${response.status}`)
}
const token = TPEN.getAuthorization() ?? TPEN.login()
const response = await fetch(`${TPEN.servicesURL}/project/${this._id}/collaborator/${userId}/addRoles`, {
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
'Content-Type': 'application/json',
},
body: JSON.stringify(["LEADER"]),
})
const payload = await this.#validateResponse(response, 'Error promoting user to LEADER')

if (this.collaborators[userId] && !this.collaborators[userId].roles.includes("LEADER")) {
this.collaborators[userId].roles.push("LEADER")
}
return response
} catch (error) {
userMessage(error.message)
if (this.collaborators[userId] && !this.collaborators[userId].roles.includes("LEADER")) {
this.collaborators[userId].roles.push("LEADER")
}
return payload ?? response
}

async demoteLeader(userId) {
try {
const token = TPEN.getAuthorization() ?? TPEN.login()
const response = await fetch(`${TPEN.servicesURL}/project/${this._id}/collaborator/${userId}/removeRoles`, {
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
'Content-Type': 'application/json',
},
body: JSON.stringify(["LEADER"]),
})
if (!response.ok) {
throw new Error(`Error removing LEADER role: ${response.status}`)
}
const token = TPEN.getAuthorization() ?? TPEN.login()
const response = await fetch(`${TPEN.servicesURL}/project/${this._id}/collaborator/${userId}/removeRoles`, {
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
'Content-Type': 'application/json',
},
body: JSON.stringify(["LEADER"]),
})
const payload = await this.#validateResponse(response, 'Error removing LEADER role')

if (this.collaborators[userId]) {
this.collaborators[userId].roles = this.collaborators[userId].roles.filter(role => role !== "LEADER")
}
return response
} catch (error) {
userMessage(error.message)
if (this.collaborators[userId]) {
this.collaborators[userId].roles = this.collaborators[userId].roles.filter(role => role !== "LEADER")
}
return payload ?? response
}

async setToViewer(userId) {
try {
const token = TPEN.getAuthorization() ?? TPEN.login()
const response = await fetch(`${TPEN.servicesURL}/project/${this._id}/collaborator/${userId}/setRoles`, {
method: "PUT",
headers: {
Authorization: `Bearer ${token}`,
'Content-Type': 'application/json',
},
body: JSON.stringify(["VIEWER"]),
})
if (!response.ok) {
throw new Error(`Error revoking write access: ${response.status}`)
}
if (this.collaborators[userId]) {
this.collaborators[userId].roles = ["VIEWER"]
} return response
} catch (error) {
userMessage(error.message)
const token = TPEN.getAuthorization() ?? TPEN.login()
const response = await fetch(`${TPEN.servicesURL}/project/${this._id}/collaborator/${userId}/setRoles`, {
method: "PUT",
headers: {
Authorization: `Bearer ${token}`,
'Content-Type': 'application/json',
},
body: JSON.stringify(["VIEWER"]),
})
const payload = await this.#validateResponse(response, 'Error revoking write access')
if (this.collaborators[userId]) {
this.collaborators[userId].roles = ["VIEWER"]
}
return payload ?? response
}

async cherryPickRoles(userId, roles) {
try {
const token = TPEN.getAuthorization() ?? TPEN.login()
const response = await fetch(`${TPEN.servicesURL}/project/${this._id}/collaborator/${userId}/setRoles`, {
method: "PUT",
headers: {
Authorization: `Bearer ${token}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ roles }),
})
if (!response.ok) {
throw new Error(`Error setting user roles: ${response.status}`)
}
const token = TPEN.getAuthorization() ?? TPEN.login()
const response = await fetch(`${TPEN.servicesURL}/project/${this._id}/collaborator/${userId}/setRoles`, {
method: "PUT",
headers: {
Authorization: `Bearer ${token}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ roles }),
})
const payload = await this.#validateResponse(response, 'Error setting user roles')

if (this.collaborators[userId]) {
this.collaborators[userId].roles = roles
}
return response
} catch (error) {
userMessage(error.message)
if (this.collaborators[userId]) {
this.collaborators[userId].roles = roles
}
return payload ?? response
}

async transferOwnership(userId) {
try {
const token = TPEN.getAuthorization() ?? TPEN.login()
const response = await fetch(`${TPEN.servicesURL}/project/${this._id}/switch/owner`, {
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ newOwnerId: userId })
})
const token = TPEN.getAuthorization() ?? TPEN.login()
const response = await fetch(`${TPEN.servicesURL}/project/${this._id}/switch/owner`, {
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ newOwnerId: userId })
})

if (!response.ok) {
throw new Error("Failed to update roles")
}
return response
} catch (error) {
console.error("Error updating roles:", error)
eventDispatcher.dispatch('tpen-alert', { message: "Failed to update roles. Please try again." })
}
const payload = await this.#validateResponse(response, 'Failed to update roles')
return payload ?? response
}

setMetadata(metadata) {
Expand Down Expand Up @@ -299,77 +293,6 @@ export default class Project {
return this.save()
}

async inviteCollaborator(email, roles) {
return fetch(`${TPEN.servicesURL}/project/${this._id}/invite-member`, {
method: "POST",
headers: new Headers({
Authorization: `Bearer ${this.#authentication}`,
"Content-Type": "application/json"
}),
body: JSON.stringify({ email, roles })
}).catch(err => Promise.reject(err))
}

async removeCollaborator(userID) {
// userID is the _id (Hex String) of the user to remove from the project
if (!this.collaborators?.[userID]) {
return Promise.reject(new Error("User not found in collaborators list"))
}
return fetch(`${TPEN.servicesURL}/project/${this._id}/remove-member`, {
method: "POST",
headers: new Headers({
Authorization: `Bearer ${this.#authentication}`,
"Content-Type": "application/json"
}),
body: JSON.stringify({ userID })
}).catch(err => Promise.reject(err))
}

async addCollaboratorRole(userID, roles) {
// role is a string value of the role to add to the user
if (!this.collaborators?.[userID]) {
return Promise.reject(new Error("User not found in collaborators list"))
}
return fetch(`${TPEN.servicesURL}/project/${this._id}/collaborator/${userID}/addRoles`, {
method: "POST",
headers: new Headers({
Authorization: `Bearer ${this.#authentication}`,
"Content-Type": "application/json"
}),
body: JSON.stringify(roles)
}).catch(err => Promise.reject(err))
}

async removeCollaboratorRole(userID, roles) {
// role is a string value of the role to remove from the user
if (!this.collaborators?.[userID]) {
return Promise.reject(new Error("User not found in collaborators list"))
}
return fetch(`${TPEN.servicesURL}/project/${this._id}/collaborator/${userID}/removeRoles`, {
method: "POST",
headers: new Headers({
Authorization: `Bearer ${this.#authentication}`,
"Content-Type": "application/json"
}),
body: JSON.stringify(roles)
}).catch(err => Promise.reject(err))
}

async setCollaboratorRoles(userID, roles) {
// role is a string value of the role to set for the user
if (!this.collaborators?.[userID]) {
return Promise.reject(new Error("User not found in collaborators list"))
}
return fetch(`${TPEN.servicesURL}/project/${this._id}/collaborator/${userID}/setRoles`, {
method: "PUT",
headers: new Headers({
Authorization: `Bearer ${this.#authentication}`,
"Content-Type": "application/json"
}),
body: JSON.stringify(roles)
}).catch(err => Promise.reject(err))
}

async storeInterfacesCustomization(customizations, replace = false) {
if (!this.#isLoaded) {
throw new Error("Project must be loaded before storing interface customizations")
Expand Down
Loading
Loading