Rework getter setter into virtual

Author: PE39806

backend/src/connectors/audit/stroom.ts

@@ -258,23 +258,23 @@ export class StroomAuditConnector extends BaseAuditConnector {
   }
 
   async onCreateRelease(req: Request, release: ReleaseDoc) {
-    this.auditGenericEvent(req, `${release.modelId}:${release.semver}`)
+    this.auditGenericEvent(req, `${release.modelId}:${release.semverString}`)
   }
 
   async onViewRelease(req: Request, release: ReleaseDoc) {
-    this.auditGenericEvent(req, `${release.modelId}:${release.semver}`)
+    this.auditGenericEvent(req, `${release.modelId}:${release.semverString}`)
   }
 
   async onViewReleases(req: Request, releases: ReleaseDoc[]) {
     this.auditMultipleViewEvent(
       req,
-      releases.map((release) => ({ Id: `${release.modelId}:${release.semver}` })),
+      releases.map((release) => ({ Id: `${release.modelId}:${release.semverString}` })),
       'release',
     )
   }
 
   async onUpdateRelease(req: Request, release: ReleaseDoc) {
-    this.auditGenericEvent(req, `${release.modelId}:${release.semver}`)
+    this.auditGenericEvent(req, `${release.modelId}:${release.semverString}`)
   }
 
   async onDeleteRelease(req: Request, modelId: string, semver: string) {

backend/src/migrations/020_2426_remove_orphaned_reviews_responses.ts

@@ -9,8 +9,8 @@ export async function up() {
   const deletedReviews: ReviewDoc[] = []
 
   // For each deleted release, deleted the reviews associated with it
-  for (const { modelId, semver } of deletedReleases) {
-    const reviews = await removeReleaseReviews(modelId, semver)
+  for (const { modelId, semverString } of deletedReleases) {
+    const reviews = await removeReleaseReviews(modelId, semverString)
     deletedReviews.push(...reviews)
   }
 

backend/src/migrations/025_fix_partial_020_2426.ts

@@ -9,10 +9,10 @@ export async function up() {
   const deletedReviews: ReviewDoc[] = []
 
   // For each deleted release, find the already deleted reviews (from 020_2426_remove_orphaned_reviews_responses.ts) associated with it
-  for (const { modelId, semver } of deletedReleases) {
+  for (const { modelId, semverString } of deletedReleases) {
     const reviews: ReviewDoc[] = await Review.find({
       modelId,
-      semver,
+      semver: semverString,
       deleted: true,
     })
     deletedReviews.push(...reviews)

backend/src/models/Release.ts

@@ -1,6 +1,6 @@
 import { HydratedDocument, model, ObjectId, Schema, Types } from 'mongoose'
 
-import { semverObjectToString, semverStringToObject } from '../services/release.js'
+import { semverObjectToString, semverStringToObject } from '../utils/semver.js'
 import { SoftDeleteDocument, softDeletionPlugin } from './plugins/softDeletePlugin.js'
 
 // This interface stores information about the properties on the base object.
@@ -10,7 +10,7 @@ export interface ReleaseInterface {
   modelId: string
   modelCardVersion: number
 
-  semver: string
+  semver: SemverObject
   notes: string
 
   minor: boolean
@@ -26,6 +26,10 @@ export interface ReleaseInterface {
   updatedAt: Date
 }
 
+export interface ReleaseVirtuals {
+  semverString: string
+}
+
 export interface ImageNameRef {
   repository: string
   name: string
@@ -44,7 +48,12 @@ export type ImageRef = ImageTagRef | ImageDigestRef
 export type ReleaseDoc = HydratedDocument<
   Omit<ReleaseInterface, 'images'> & {
     images: Array<HydratedDocument<ImageTagRef>>
-  }
+  },
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+  {},
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+  {},
+  ReleaseVirtuals
 > &
   SoftDeleteDocument
 
@@ -55,24 +64,15 @@ export interface SemverObject {
   metadata?: string
 }
 
-const ReleaseSchema = new Schema<ReleaseDoc & { semver: string | SemverObject }>(
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+const ReleaseSchema = new Schema<ReleaseDoc, {}, {}, ReleaseVirtuals>(
   {
     modelId: { type: String, required: true },
     modelCardVersion: { type: Number, required: true },
 
     semver: {
       type: Schema.Types.Mixed,
       required: true,
-      set: function (semver: string) {
-        return semverStringToObject(semver)
-      },
-      get: function (semver: SemverObject | string) {
-        if (typeof semver === 'string') {
-          return semver
-        } else {
-          return semverObjectToString(semver)
-        }
-      },
     },
 
     notes: { type: String, required: true },
@@ -110,6 +110,17 @@ const ReleaseSchema = new Schema<ReleaseDoc & { semver: string | SemverObject }>
   },
 )
 
+ReleaseSchema.virtual('semverString').get(function () {
+  return semverObjectToString(this.semver)
+})
+ReleaseSchema.virtual('semverString').set(function (semver: SemverObject | string) {
+  if (typeof semver === 'string') {
+    this.semver = semverStringToObject(semver)
+  } else {
+    this.semver = semver
+  }
+})
+
 ReleaseSchema.plugin(softDeletionPlugin)
 ReleaseSchema.index({ modelId: 1, semver: 1 }, { unique: true })
 ReleaseSchema.index({ modelId: 1 })

backend/src/routes/v2/release/getRelease.ts

@@ -39,7 +39,7 @@ registerPath({
 })
 
 interface getReleaseResponse {
-  release: ReleaseInterface & { files: FileWithScanResultsAggregate[] }
+  release: Omit<ReleaseInterface, 'semver'> & { semver: string; files: FileWithScanResultsAggregate[] }
 }
 
 export const getRelease = [
@@ -52,7 +52,7 @@ export const getRelease = [
     const release = await getReleaseBySemver(req.user, modelId, semver)
     await audit.onViewRelease(req, release)
     const files = await getFilesByIds(req.user, modelId, release.fileIds)
-    const releaseWithFiles = { ...release.toObject(), files, kind: ResponseKind.Comment }
+    const releaseWithFiles = { ...release.toObject(), semver: release.semverString, files, kind: ResponseKind.Comment }
 
     res.json({
       release: releaseWithFiles,

backend/src/seeds/data/models.ts

@@ -76,7 +76,11 @@ export const release: ReleaseInterface = {
   modelId: 'example',
   modelCardVersion: 0,
 
-  semver: 'v1.0.0',
+  semver: {
+    major: 1,
+    minor: 0,
+    patch: 0,
+  },
   notes: `This makes major steps forward in both speed and quality of \
 results given by the model.  Here is a table of the updated speed:
 

backend/src/services/mirroredModel/exporters/documents.ts

@@ -10,6 +10,7 @@ import { UserInterface } from '../../../models/User.js'
 import { MirrorExportLogData, MirrorKind } from '../../../types/types.js'
 import config from '../../../utils/config.js'
 import { BadReq, InternalError } from '../../../utils/error.js'
+import { semverObjectToString } from '../../../utils/semver.js'
 import { getFilesByIds, getTotalFileSize } from '../../file.js'
 import log from '../../log.js'
 import { getModelCardRevisions } from '../../model.js'
@@ -40,7 +41,7 @@ export class DocumentsExporter extends BaseExporter {
 
   protected async _init() {
     if (this.releases.length > 0) {
-      const semvers = this.getSemvers()
+      const semvers = this.getSemvers().map((semver) => semverObjectToString(semver))
       const fileIds = await getAllFileIds(this.model.id, semvers)
       this.files = await getFilesByIds(this.user, this.model.id, fileIds)
 
@@ -201,7 +202,7 @@ export class DocumentsExporter extends BaseExporter {
         error,
         modelId: this.model.id,
         mirroredModelId: this.model!.settings.mirror.destinationModelId!,
-        releaseId: release.id,
+        releaseId: release._id.toString(),
         ...this.logData,
       })
     }

backend/src/services/mirroredModel/importers/documents.ts

@@ -28,7 +28,7 @@ export type MongoDocumentMirrorInformation = {
   metadata: DocumentsMirrorMetadata
   modelCardVersions: ModelCardRevisionDoc['version'][]
   newModelCards: Omit<ModelCardRevisionDoc, '_id'>[]
-  releaseSemvers: ReleaseDoc['semver'][]
+  releaseSemvers: ReleaseDoc['semverString'][]
   newReleases: Omit<ReleaseDoc, '_id'>[]
   fileIds: { key: Types.ObjectId; name: string }[]
   imageIds: string[]
@@ -118,7 +118,7 @@ export class DocumentsImporter extends BaseImporter {
             } as DistributionPackageName),
           )
         }
-        this.releaseSemvers.push(release.semver)
+        this.releaseSemvers.push(release.semverString)
         const savedRelease = await saveImportedRelease(release)
         if (savedRelease) {
           this.newReleases.push(savedRelease)

backend/src/services/model.ts

@@ -231,7 +231,7 @@ export async function removeModel(user: UserInterface, modelId: string, kind?: E
       deleteReleases(
         user,
         modelId,
-        allModelReleases.flatMap((release) => release.semver),
+        allModelReleases.flatMap((release) => release.semverString),
         true,
         session,
       ),

backend/src/services/release.ts

@@ -16,6 +16,7 @@ import { findDuplicates } from '../utils/array.js'
 import { toEntity } from '../utils/entity.js'
 import { BadReq, Forbidden, InternalError, NotFound } from '../utils/error.js'
 import { isMongoServerError } from '../utils/mongo.js'
+import { semverObjectToString, semverStringToObject } from '../utils/semver.js'
 import { arrayOfObjectsHasKeysOfType, hasKeysOfType } from '../utils/typeguards.js'
 import { getFileById, getFilesByIds } from './file.js'
 import log from './log.js'
@@ -49,8 +50,8 @@ export function isReleaseDoc(data: unknown): data is ReleaseDoc {
 }
 
 export async function validateRelease(user: UserInterface, model: ModelDoc, release: ReleaseDoc) {
-  if (!semver.valid(release.semver)) {
-    throw BadReq(`The version '${release.semver}' is not a valid semver value.`)
+  if (!semver.valid(release.semverString)) {
+    throw BadReq(`The version '${release.semverString}' is not a valid semver value.`)
   }
 
   if (release.images && release.images.length > 0) {
@@ -89,7 +90,7 @@ export async function validateRelease(user: UserInterface, model: ModelDoc, rele
         if (isBailoError(e) && e.code === 404) {
           throw BadReq('Unable to create release as the file cannot be found.', {
             fileId,
-            semver: release.semver,
+            semver: release.semverString,
             modelId: release.modelId,
           })
         }
@@ -125,10 +126,9 @@ export async function validateRelease(user: UserInterface, model: ModelDoc, rele
 }
 
 export type CreateReleaseParams = Optional<
-  Pick<
-    ReleaseInterface,
-    'modelId' | 'modelCardVersion' | 'semver' | 'notes' | 'minor' | 'draft' | 'fileIds' | 'images'
-  >,
+  Pick<ReleaseInterface, 'modelId' | 'modelCardVersion' | 'notes' | 'minor' | 'draft' | 'fileIds' | 'images'> & {
+    semver: string
+  },
   'modelCardVersion'
 >
 export async function createRelease(user: UserInterface, releaseParams: CreateReleaseParams) {
@@ -150,7 +150,7 @@ export async function createRelease(user: UserInterface, releaseParams: CreateRe
 
   const deletedRelease = await ReleaseModel.findOne({
     modelId: releaseParams.modelId,
-    semver: releaseParams.semver,
+    semver: semverStringToObject(releaseParams.semver),
     deleted: true,
   })
   if (deletedRelease) {
@@ -162,6 +162,8 @@ export async function createRelease(user: UserInterface, releaseParams: CreateRe
   const release = new ReleaseModel({
     createdBy: user.dn,
     ...releaseParams,
+    // override semver string to be the object representation
+    semver: semverStringToObject(releaseParams.semver),
   })
 
   await validateRelease(user, model, release)
@@ -198,7 +200,7 @@ export async function createRelease(user: UserInterface, releaseParams: CreateRe
   sendWebhooks(
     release.modelId,
     WebhookEvent.CreateRelease,
-    `Release ${release.semver} has been created for model ${release.modelId}`,
+    `Release ${release.semverString} has been created for model ${release.modelId}`,
     { release },
   )
 
@@ -223,7 +225,10 @@ export async function updateRelease(user: UserInterface, modelId: string, semver
       modelId: modelId,
     })
   }
-  const updatedRelease = await ReleaseModel.findOneAndUpdate({ modelId, semver }, { $set: release })
+  const updatedRelease = await ReleaseModel.findOneAndUpdate(
+    { modelId, semver: semverStringToObject(semver) },
+    { $set: release },
+  )
 
   if (!updatedRelease) {
     throw NotFound(`The requested release was not found.`, { modelId, semver })
@@ -232,7 +237,7 @@ export async function updateRelease(user: UserInterface, modelId: string, semver
   sendWebhooks(
     release.modelId,
     WebhookEvent.UpdateRelease,
-    `ReleaseModel ${release.semver} has been updated for model ${release.modelId}`,
+    `ReleaseModel ${release.semverString} has been updated for model ${release.modelId}`,
     { release },
   )
 
@@ -245,7 +250,7 @@ export async function newReleaseComment(user: UserInterface, modelId: string, se
     throw BadReq(`Cannot create a new comment on a mirrored model.`)
   }
 
-  const release = await ReleaseModel.findOne({ modelId, semver })
+  const release = await ReleaseModel.findOne({ modelId, semver: semverStringToObject(semver) })
   if (!release) {
     throw NotFound(`The requested release was not found.`, { modelId, semver })
   }
@@ -320,12 +325,13 @@ export async function getModelReleases(
 
 export async function getReleasesForExport(user: UserInterface, modelId: string, semvers: string[]) {
   const model = await getModelById(user, modelId)
+  const semverObjects = semvers.map((semver) => semverStringToObject(semver))
   const releases = await ReleaseModel.find({
     modelId,
-    semver: { $in: semvers },
+    semver: { $in: semverObjects },
   })
 
-  const missing = semvers.filter((x) => !releases.some((release) => release.semver === x))
+  const missing = semvers.filter((x) => !releases.some((release) => release.semverString === x))
   if (missing.length > 0) {
     throw NotFound('The following releases were not found.', { modelId, releases: missing })
   }
@@ -335,43 +341,19 @@ export async function getReleasesForExport(user: UserInterface, modelId: string,
   if (failedReleases.length > 0) {
     throw Forbidden('You do not have the necessary permissions to export these releases.', {
       modelId,
-      releases: failedReleases.map((release) => release.semver),
+      releases: failedReleases.map((release) => release.semverString),
       user,
     })
   }
 
   return releases
 }
 
-export function semverStringToObject(semver: string): SemverObject {
-  const vIdentifierIndex = semver.indexOf('v')
-  const trimmedSemver = vIdentifierIndex === -1 ? semver : semver.slice(vIdentifierIndex + 1)
-  const [version, metadata] = trimmedSemver.split('-')
-  const [major, minor, patch] = version.split('.')
-  const majorNum: number = Number(major)
-  const minorNum: number = Number(minor)
-  const patchNum: number = Number(patch)
-  return { major: majorNum, minor: minorNum, patch: patchNum, ...(metadata && { metadata }) }
-}
-
-export function semverObjectToString(semver: SemverObject): string {
-  if (!semver) {
-    return ''
-  }
-  let metadata: string
-  if (semver.metadata != undefined) {
-    metadata = `-${semver.metadata}`
-  } else {
-    metadata = ``
-  }
-  return `${semver.major}.${semver.minor}.${semver.patch}${metadata}`
-}
-
 export async function getReleaseBySemver(user: UserInterface, model: string | ModelDoc, semver: string) {
   if (typeof model === 'string') {
     model = await getModelById(user, model)
   }
-  const release = await ReleaseModel.findOne({ modelId: model.id, semver })
+  const release = await ReleaseModel.findOne({ modelId: model.id, semver: semverStringToObject(semver) })
 
   if (!release) {
     throw NotFound(`The requested release was not found.`, { modelId: model.id, semver })
@@ -538,7 +520,7 @@ export async function deleteReleases(
 
     await release.delete(session)
     await removeReleaseReviews(modelId, semver, session)
-    await removeResponsesByParentIds([...reviewsForRelease.map((review) => review.id), release.id], session)
+    await removeResponsesByParentIds([...reviewsForRelease.map((review) => review.id), release._id.toString()], session)
   }
 
   return { modelId, semvers }