Files
speckle-server/packages/server/modules/workspaces/services/projectRegions.ts
T
Chuck Driesler 0cafe77013 feat(regions): change project region once move is complete (#3995)
* chore(regions): failing test for moving blobs

* fix(blobs): use blob storage table

* chore(regions): include file_uploads table for thoroughness

* fix(regions): extract repeated string to utils

* chore(regions): move validation as own service

* feat(regions): update project region key after move

* chore(regions): update tests to make gql requests
2025-02-28 09:35:44 +00:00

150 lines
5.5 KiB
TypeScript

import { GetProjectAutomationCount } from '@/modules/automate/domain/operations'
import { GetStreamCommentCount } from '@/modules/comments/domain/operations'
import { GetStreamBranchCount } from '@/modules/core/domain/branches/operations'
import { GetStreamCommitCount } from '@/modules/core/domain/commits/operations'
import { GetStreamObjectCount } from '@/modules/core/domain/objects/operations'
import { GetProject } from '@/modules/core/domain/projects/operations'
import { UpdateProjectRegionKey } from '@/modules/multiregion/services/projectRegion'
import { GetStreamWebhooks } from '@/modules/webhooks/domain/operations'
import {
CopyProjectAutomations,
CopyProjectBlobs,
CopyProjectComments,
CopyProjectModels,
CopyProjectObjects,
CopyProjects,
CopyProjectVersions,
CopyProjectWebhooks,
CopyWorkspace,
GetAvailableRegions,
UpdateProjectRegion,
ValidateProjectRegionCopy
} from '@/modules/workspaces/domain/operations'
import { ProjectRegionAssignmentError } from '@/modules/workspaces/errors/regions'
export const updateProjectRegionFactory =
(deps: {
getProject: GetProject
getAvailableRegions: GetAvailableRegions
copyWorkspace: CopyWorkspace
copyProjects: CopyProjects
copyProjectModels: CopyProjectModels
copyProjectVersions: CopyProjectVersions
copyProjectObjects: CopyProjectObjects
copyProjectAutomations: CopyProjectAutomations
copyProjectComments: CopyProjectComments
copyProjectWebhooks: CopyProjectWebhooks
copyProjectBlobs: CopyProjectBlobs
validateProjectRegionCopy: ValidateProjectRegionCopy
updateProjectRegionKey: UpdateProjectRegionKey
}): UpdateProjectRegion =>
async (params) => {
const { projectId, regionKey } = params
const project = await deps.getProject({ projectId })
if (!project) {
throw new ProjectRegionAssignmentError('Project not found', {
info: { params }
})
}
if (!project.workspaceId) {
throw new ProjectRegionAssignmentError('Project not a part of a workspace', {
info: { params }
})
}
const availableRegions = await deps.getAvailableRegions({
workspaceId: project.workspaceId
})
if (!availableRegions.find((region) => region.key === regionKey)) {
throw new ProjectRegionAssignmentError(
'Specified region not available for workspace',
{
info: {
params,
workspaceId: project.workspaceId
}
}
)
}
// Move workspace
await deps.copyWorkspace({ workspaceId: project.workspaceId })
// Move commits
const projectIds = await deps.copyProjects({ projectIds: [projectId] })
const copiedModelCount = await deps.copyProjectModels({ projectIds })
const copiedVersionCount = await deps.copyProjectVersions({ projectIds })
// Move objects
const copiedObjectCount = await deps.copyProjectObjects({ projectIds })
// Move automations
const copiedAutomationCount = await deps.copyProjectAutomations({ projectIds })
// Move comments
const copiedCommentCount = await deps.copyProjectComments({ projectIds })
// Move webhooks
const copiedWebhookCount = await deps.copyProjectWebhooks({ projectIds })
// Move file blobs
await deps.copyProjectBlobs({ projectIds })
// Validate that state after move captures latest state of project
const isValidCopy = await deps.validateProjectRegionCopy({
projectId,
copiedRowCount: {
models: copiedModelCount[projectId],
versions: copiedVersionCount[projectId],
objects: copiedObjectCount[projectId],
automations: copiedAutomationCount[projectId],
comments: copiedCommentCount[projectId],
webhooks: copiedWebhookCount[projectId]
}
})
if (!isValidCopy) {
// TODO: Move failed or source project added data while changing regions. Retry move.
throw new ProjectRegionAssignmentError(
'Missing data from source project in target region copy after move.'
)
}
// Update project region in db and update relevant caches
return await deps.updateProjectRegionKey({ projectId, regionKey })
}
export const validateProjectRegionCopyFactory =
(deps: {
countProjectModels: GetStreamBranchCount
countProjectVersions: GetStreamCommitCount
countProjectObjects: GetStreamObjectCount
countProjectAutomations: GetProjectAutomationCount
countProjectComments: GetStreamCommentCount
getProjectWebhooks: GetStreamWebhooks
}): ValidateProjectRegionCopy =>
async ({ projectId, copiedRowCount }): Promise<boolean> => {
const sourceProjectModelCount = await deps.countProjectModels(projectId)
const sourceProjectVersionCount = await deps.countProjectVersions(projectId)
const sourceProjectObjectCount = await deps.countProjectObjects({
streamId: projectId
})
const sourceProjectAutomationCount = await deps.countProjectAutomations({
projectId
})
const sourceProjectCommentCount = await deps.countProjectComments(projectId)
const sourceProjectWebhooks = await deps.getProjectWebhooks({ streamId: projectId })
const tests = [
copiedRowCount.models === sourceProjectModelCount,
copiedRowCount.versions === sourceProjectVersionCount,
copiedRowCount.objects === sourceProjectObjectCount,
copiedRowCount.automations === sourceProjectAutomationCount,
copiedRowCount.comments === sourceProjectCommentCount,
copiedRowCount.webhooks === sourceProjectWebhooks.length
]
return tests.every((test) => !!test)
}