refactor(segmentGroups): store archives under segmentations

Author: PaulHax

src/components/SaveSegmentGroupDialog.vue

@@ -7,7 +7,7 @@
       <v-form v-model="valid" @submit.prevent="saveSegmentGroup">
         <v-text-field
           v-model="fileName"
-          hint="Filename used for downloads. Invalid filename characters are replaced automatically."
+          hint="Filename used for downloads."
           label="Filename"
           :rules="[validFileName]"
           required

src/io/state-file/__tests__/segmentGroupArchivePath.spec.ts

@@ -8,18 +8,18 @@ describe('io/state-file/segmentGroupArchivePath', () => {
 
       expect(
         makeSegmentGroupArchivePath('Liver: left/right*?', 'vti', usedPaths)
-      ).to.equal('labels/Liver left right.vti');
+      ).to.equal('segmentations/Liver left right.vti');
     });
 
     it('deduplicates colliding sanitized names case-insensitively', () => {
       const usedPaths = new Set<string>();
 
       expect(
         makeSegmentGroupArchivePath('Liver/Left', 'vti', usedPaths)
-      ).to.equal('labels/Liver Left.vti');
+      ).to.equal('segmentations/Liver Left.vti');
       expect(
         makeSegmentGroupArchivePath('liver:left', 'vti', usedPaths)
-      ).to.equal('labels/liver left (2).vti');
+      ).to.equal('segmentations/liver left (2).vti');
     });
   });
 });

src/io/state-file/segmentGroupArchivePath.ts

@@ -2,6 +2,7 @@ import { normalize } from '@/src/utils/path';
 import { sanitizeFileStem } from '@/src/io/fileName';
 
 export const DEFAULT_SEGMENT_GROUP_ARCHIVE_STEM = 'Segment Group';
+const SEGMENT_GROUP_ARCHIVE_DIR = 'segmentations';
 
 export function sanitizeSegmentGroupFileStem(
   name: string,
@@ -22,10 +23,12 @@ export function makeSegmentGroupArchivePath(
   const stem = sanitizeSegmentGroupFileStem(name);
 
   let index = 1;
-  let path = normalize(`labels/${stem}.${extension}`);
+  let path = normalize(`${SEGMENT_GROUP_ARCHIVE_DIR}/${stem}.${extension}`);
   while (usedPaths.has(makeArchivePathKey(path))) {
     index += 1;
-    path = normalize(`labels/${stem} (${index}).${extension}`);
+    path = normalize(
+      `${SEGMENT_GROUP_ARCHIVE_DIR}/${stem} (${index}).${extension}`
+    );
   }
 
   usedPaths.add(makeArchivePathKey(path));

tests/pageobjects/volview.page.ts

@@ -7,7 +7,7 @@ import Page from './page';
 
 let lastId = 0;
 const getId = () => {
-  return lastId++;
+  return `${process.pid}-${Date.now()}-${lastId++}`;
 };
 
 export const setValueVueInput = async (
@@ -216,7 +216,10 @@ class VolViewPage extends Page {
     await confirm.click();
 
     cleanuptotal.addCleanup(async () => {
-      fs.unlinkSync(path.join(TEMP_DIR, fileName));
+      const filePath = path.join(TEMP_DIR, fileName);
+      if (fs.existsSync(filePath)) {
+        fs.unlinkSync(filePath);
+      }
     });
 
     return fileName;

tests/specs/session-large-uri-base.e2e.ts

@@ -78,7 +78,7 @@ const createSessionZip = async (
     segmentGroups: [
       {
         id: 'seg-1',
-        path: 'labels/seg-1.nii.gz',
+        path: 'segmentations/seg-1.nii.gz',
         metadata: {
           name: 'Annotation',
           parentImage: '0',
@@ -100,7 +100,7 @@ const createSessionZip = async (
 
   const zip = new JSZip();
   zip.file('manifest.json', JSON.stringify(manifest, null, 2));
-  zip.file('labels/seg-1.nii.gz', labelmapNiftiGz);
+  zip.file('segmentations/seg-1.nii.gz', labelmapNiftiGz);
   return zip.generateAsync({ type: 'nodebuffer', compression: 'STORE' });
 };
 

tests/specs/session-state-lifecycle.e2e.ts

@@ -133,22 +133,22 @@ describe('Session state lifecycle', () => {
     await openUrls([PROSTATEX_DATASET]);
 
     const segmentGroupName = 'Liver: left/right*?';
-    const sanitizedFilePath = 'labels/Liver left right.vti';
+    const sanitizedFilePath = 'segmentations/Liver left right.vti';
 
     await volViewPage.createSegmentGroup(segmentGroupName);
 
     const { manifest, zip } = await saveAndParseManifest();
     if (!zip) {
       throw new Error('Expected saved session zip to be available');
     }
-    const labelMaps = manifest.labelMaps as Array<{
+    const segmentGroups = manifest.segmentGroups as Array<{
       path: string;
       metadata: { name: string };
     }>;
 
-    expect(labelMaps.length).toEqual(1);
-    expect(labelMaps[0].metadata.name).toEqual(segmentGroupName);
-    expect(labelMaps[0].path).toEqual(sanitizedFilePath);
+    expect(segmentGroups.length).toEqual(1);
+    expect(segmentGroups[0].metadata.name).toEqual(segmentGroupName);
+    expect(segmentGroups[0].path).toEqual(sanitizedFilePath);
     expect(Object.keys(zip.files)).toContain(sanitizedFilePath);
   });
 });