Merge branch 'release-strategy-docs' into release-process-docs

Brings in the Node 24 buffer fix and the temp-directory race fix so
this branch's CI can pass before #518 merges. Once #518 lands, the
diff of #519 collapses back to just the process files.

Author: awatson1978

RELEASE_PLAN.md

@@ -1,7 +1,6 @@
-import fs from "fs";
 import "../src/index.js";
 import Segmentation_4X from "../src/adapters/Cornerstone/Segmentation_4X";
-import { getTestDataset } from "./testUtils.js";
+import { getTestDataset, readFileAsArrayBuffer } from "./testUtils.js";
 
 const mockMetadataProvider = {
     get: (type, imageId) => {
@@ -31,7 +30,7 @@ it("Can generate tool state (4X) with SEG sourcing MG images without throwing an
     const url =
         "https://github.com/dcmjs-org/data/releases/download/mg-seg/seg-test-SEG.dcm";
     const dcmPath = await getTestDataset(url, "seg-test-SEG.dcm");
-    const arrayBuffer = fs.readFileSync(dcmPath).buffer;
+    const arrayBuffer = readFileAsArrayBuffer(dcmPath);
 
     expect(() => {
         Segmentation_4X.generateToolState(

test/adapters.test.js

@@ -1,6 +1,6 @@
 import dcmjs from "../src/index.js";
-import fs from "fs";
 import { validationLog } from "./../src/log.js";
+import { readFileAsArrayBuffer } from "./testUtils.js";
 
 // Ignore validation errors
 validationLog.setLevel(5);
@@ -14,7 +14,7 @@ it("test_export", () => {
 
 it("test_anonymization", () => {
     // given
-    const arrayBuffer = fs.readFileSync("test/sample-dicom.dcm").buffer;
+    const arrayBuffer = readFileAsArrayBuffer("test/sample-dicom.dcm");
     const dicomDict = DicomMessage.readFile(arrayBuffer);
 
     const tagInfo = dcmjs.data.DicomMetaDictionary.nameMap["PatientName"];
@@ -41,7 +41,7 @@ it("test_anonymization", () => {
 
 it("test_anonymization_no_change_ref", () => {
     // given
-    const arrayBuffer = fs.readFileSync("test/sample-sr.dcm").buffer;
+    const arrayBuffer = readFileAsArrayBuffer("test/sample-sr.dcm");
     const dicomDict = DicomMessage.readFile(arrayBuffer);
 
     // multiple value name
@@ -87,7 +87,7 @@ it("test_anonymization_no_change_ref", () => {
 
 it("test_anonymization_tagtoreplace_param", () => {
     // given
-    const arrayBuffer = fs.readFileSync("test/sample-dicom.dcm").buffer;
+    const arrayBuffer = readFileAsArrayBuffer("test/sample-dicom.dcm");
     const dicomDict = DicomMessage.readFile(arrayBuffer);
 
     const tagInfo = dcmjs.data.DicomMetaDictionary.nameMap["PatientName"];
@@ -120,7 +120,7 @@ it("test_anonymization_tagtoreplace_param", () => {
 
 it("test_anonymization_keep_tag", () => {
     // given
-    const arrayBuffer = fs.readFileSync("test/sample-dicom.dcm").buffer;
+    const arrayBuffer = readFileAsArrayBuffer("test/sample-dicom.dcm");
     const dicomDict = DicomMessage.readFile(arrayBuffer);
 
     const tagInfo = dcmjs.data.DicomMetaDictionary.nameMap["SeriesDescription"];
@@ -148,7 +148,7 @@ it("test_anonymization_keep_tag", () => {
 
 it("test_anonymization_anonymize_tag", () => {
     // given
-    const arrayBuffer = fs.readFileSync("test/sample-dicom.dcm").buffer;
+    const arrayBuffer = readFileAsArrayBuffer("test/sample-dicom.dcm");
     const dicomDict = DicomMessage.readFile(arrayBuffer);
 
     const tagInfo = dcmjs.data.DicomMetaDictionary.nameMap["SeriesInstanceUID"];

test/anonymizer.test.js

@@ -5,7 +5,7 @@ import {
     IMPLICIT_LITTLE_ENDIAN,
     UNDEFINED_LENGTH
 } from "../src/constants/dicom";
-import { getTestDataset } from "./testUtils.js";
+import { getTestDataset, readFileAsArrayBuffer } from "./testUtils.js";
 import { videoTestMeta, videoTestDict } from "./video-test-dict.js";
 import { oddFrameBitData } from "./odd-frame-bit-data.js";
 import {
@@ -566,7 +566,7 @@ describe("AsyncDicomReader", () => {
 
         // First, read the file with DicomMessage to identify which private tags exist
         // and determine their order relative to PixelData
-        const syncDict = DicomMessage.readFile(fs.readFileSync(dcmPath).buffer);
+        const syncDict = DicomMessage.readFile(readFileAsArrayBuffer(dcmPath));
 
         // Get all tags in order (approximate - dict keys may not preserve exact order)
         const { dict } = syncDict;

test/async-data.test.js

@@ -1,6 +1,5 @@
-import { getZippedTestDataset } from "./testUtils.js";
+import { getZippedTestDataset, readFileAsArrayBuffer } from "./testUtils.js";
 import dcmjs from "../src/index.js";
-import fs from "fs";
 import fsPromises from "fs/promises";
 import path from "path";
 
@@ -34,9 +33,9 @@ it("test_encodings", async () => {
 
     fileNames.forEach(fileName => {
         if (fileName in expectedPatientNames) {
-            const arrayBuffer = fs.readFileSync(
+            const arrayBuffer = readFileAsArrayBuffer(
                 path.join(filesPath, fileName)
-            ).buffer;
+            );
             const dicomDict = DicomMessage.readFile(arrayBuffer);
             const dataset = DicomMetaDictionary.naturalizeDataset(
                 dicomDict.dict

test/data-encoding.test.js

@@ -1,9 +1,11 @@
 import dcmjs from "../src/index.js";
-import fs from "fs";
 import path from "path";
-import { promisify } from "util";
 import fsPromises from "fs/promises";
-import { getZippedTestDataset, getTestDataset } from "./testUtils.js";
+import {
+    getZippedTestDataset,
+    getTestDataset,
+    readFileAsArrayBuffer
+} from "./testUtils.js";
 
 const { DicomMetaDictionary, DicomMessage } = dcmjs.data;
 
@@ -12,20 +14,20 @@ const areEqual = (first, second) =>
     first.every((value, index) => value === second[index]);
 
 it("test_untilTag", () => {
-    const buffer = fs.readFileSync("test/sample-dicom.dcm");
+    const buffer = readFileAsArrayBuffer("test/sample-dicom.dcm");
     console.time("readFile");
-    const fullData = DicomMessage.readFile(buffer.buffer);
+    const fullData = DicomMessage.readFile(buffer);
     console.timeEnd("readFile");
 
     console.time("readFile without untilTag");
-    const dicomData = DicomMessage.readFile(buffer.buffer, {
+    const dicomData = DicomMessage.readFile(buffer, {
         untilTag: "7FE00010",
         includeUntilTagValue: false
     });
     console.timeEnd("readFile without untilTag");
 
     console.time("readFile with untilTag");
-    const dicomData2 = DicomMessage.readFile(buffer.buffer, {
+    const dicomData2 = DicomMessage.readFile(buffer, {
         untilTag: "7FE00010",
         includeUntilTagValue: true
     });
@@ -49,13 +51,13 @@ it("noCopy multiframe DICOM which has trailing padding", async () => {
         "https://github.com/dcmjs-org/data/releases/download/binary-parsing-stressors/multiframe-ultrasound.dcm";
     const dcmPath = await getTestDataset(url, "multiframe-ultrasound.dcm");
     const dicomDictNoCopy = DicomMessage.readFile(
-        fs.readFileSync(dcmPath).buffer,
+        readFileAsArrayBuffer(dcmPath),
         {
             noCopy: true
         }
     );
 
-    const dicomDict = DicomMessage.readFile(fs.readFileSync(dcmPath).buffer, {
+    const dicomDict = DicomMessage.readFile(readFileAsArrayBuffer(dcmPath), {
         noCopy: false
     });
 
@@ -77,13 +79,13 @@ it("noCopy multiframe DICOM with large private tags before and after the image d
     const dcmPath = await getTestDataset(url, "large-private-tags.dcm");
 
     const dicomDictNoCopy = DicomMessage.readFile(
-        fs.readFileSync(dcmPath).buffer,
+        readFileAsArrayBuffer(dcmPath),
         {
             noCopy: true
         }
     );
 
-    const dicomDict = DicomMessage.readFile(fs.readFileSync(dcmPath).buffer, {
+    const dicomDict = DicomMessage.readFile(readFileAsArrayBuffer(dcmPath), {
         noCopy: false
     });
 
@@ -103,13 +105,13 @@ it("noCopy binary data into an ArrayBuffer", async () => {
     const url =
         "https://github.com/dcmjs-org/data/releases/download/binary-tag/binary-tag.dcm";
     const dcmPath = await getTestDataset(url, "binary-tag.dcm");
-    const fileData = await promisify(fs.readFile)(dcmPath);
+    const fileData = readFileAsArrayBuffer(dcmPath);
 
-    const dicomDictNoCopy = DicomMessage.readFile(fileData.buffer, {
+    const dicomDictNoCopy = DicomMessage.readFile(fileData, {
         noCopy: true
     });
 
-    const dicomDict = DicomMessage.readFile(fileData.buffer, {
+    const dicomDict = DicomMessage.readFile(fileData, {
         noCopy: false
     });
 
@@ -138,9 +140,9 @@ it("noCopy test_multiframe_1", async () => {
     const fileNames = await fsPromises.readdir(mrHeadPath);
 
     fileNames.forEach(fileName => {
-        const arrayBuffer = fs.readFileSync(
+        const arrayBuffer = readFileAsArrayBuffer(
             path.join(mrHeadPath, fileName)
-        ).buffer;
+        );
         const dicomDictNoCopy = DicomMessage.readFile(arrayBuffer, {
             noCopy: true
         });
@@ -168,13 +170,13 @@ it("noCopy test_fragment_multiframe", async () => {
         url,
         "encapsulation-fragment-multiframe-b.dcm"
     );
-    const file = fs.readFileSync(dcmPath);
+    const file = readFileAsArrayBuffer(dcmPath);
 
-    const dicomDict = dcmjs.data.DicomMessage.readFile(file.buffer, {
+    const dicomDict = dcmjs.data.DicomMessage.readFile(file, {
         // ignoreErrors: true,
     });
 
-    const dicomDictNoCopy = DicomMessage.readFile(file.buffer, {
+    const dicomDictNoCopy = DicomMessage.readFile(file, {
         noCopy: true
     });