use objects

Author: anthony-nhs

packages/deploymentUtils/src/changesets/checkDestructiveChanges.ts

@@ -1,5 +1,3 @@
-import {readFileSync} from "node:fs"
-
 export type ChangeRequiringAttention = {
   logicalId: string;
   physicalId: string;
@@ -26,14 +24,17 @@ const requiresReplacement = (replacement: unknown): boolean => {
   return normalized === "True" || normalized === "Conditional"
 }
 
-export function checkDestructiveChanges(filePath: string): Array<ChangeRequiringAttention> {
-  if (!filePath) {
-    throw new Error("A change set file path must be provided")
+type ChangeSet = {
+  Changes?: unknown;
+}
+
+export function checkDestructiveChanges(changeSet: ChangeSet | undefined | null): Array<ChangeRequiringAttention> {
+  if (!changeSet || typeof changeSet !== "object") {
+    throw new Error("A change set object must be provided")
   }
 
-  const raw = readFileSync(filePath, "utf-8")
-  const data = JSON.parse(raw)
-  const changes = Array.isArray(data?.Changes) ? data.Changes : []
+  const {Changes} = changeSet as ChangeSet
+  const changes = Array.isArray(Changes) ? (Changes as Array<RawChange>) : []
 
   return changes
     .map((change: RawChange) => {

packages/deploymentUtils/tests/changesets/checkDestructiveChanges.test.ts

@@ -1,5 +1,4 @@
-import {mkdtempSync, writeFileSync} from "node:fs"
-import {tmpdir} from "node:os"
+import {readFileSync} from "node:fs"
 import {dirname, join} from "node:path"
 import {fileURLToPath} from "node:url"
 import {describe, expect, test} from "vitest"
@@ -9,8 +8,10 @@ const __filename = fileURLToPath(import.meta.url)
 const __dirname = dirname(__filename)
 const fixturesDir = join(__dirname, "examples")
 
-const destructiveChangeSet = join(fixturesDir, "destructive_changeset.json")
-const safeChangeSet = join(fixturesDir, "safe_changeset.json")
+const loadChangeSet = (filePath: string) => JSON.parse(readFileSync(filePath, "utf-8"))
+
+const destructiveChangeSet = loadChangeSet(join(fixturesDir, "destructive_changeset.json"))
+const safeChangeSet = loadChangeSet(join(fixturesDir, "safe_changeset.json"))
 
 describe("checkDestructiveChanges", () => {
   test("returns resources that require replacement", () => {
@@ -32,8 +33,6 @@ describe("checkDestructiveChanges", () => {
   })
 
   test("includes resources marked for removal", () => {
-    const tempDir = mkdtempSync(join(tmpdir(), "changeset-"))
-    const removalFixture = join(tempDir, "removal.json")
     const changeSet = {
       Changes: [
         {
@@ -47,9 +46,7 @@ describe("checkDestructiveChanges", () => {
         }
       ]
     }
-    writeFileSync(removalFixture, JSON.stringify(changeSet), "utf-8")
-
-    const replacements = checkDestructiveChanges(removalFixture)
+    const replacements = checkDestructiveChanges(changeSet)
 
     expect(replacements).toEqual([
       {