Fix issue where fonts referenced from GBVM scripts weren't being incl…

…uded in project

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Fixed
+
+- Fix issue where fonts referenced from GBVM scripts weren't being included in project
+
 ## [4.0.0-rc.2] - 2024-06-13
 
 ### Changed

src/lib/compiler/precompile/determineUsedAssets.ts

@@ -100,6 +100,7 @@ export const determineUsedAssets = ({
         const references = cmd.args?.references as Reference[];
         addReferences(references, "variable", addVariableById);
         addReferences(references, "sound", addSoundById);
+        addReferences(references, "font", addFontById);
       }
 
       // Sounds

test/data/compiler/determineUsedAssets.test.ts

@@ -0,0 +1,157 @@
+import { Dictionary } from "@reduxjs/toolkit";
+import { determineUsedAssets } from "lib/compiler/precompile/determineUsedAssets";
+import { CustomEvent, FontData } from "shared/lib/entities/entitiesTypes";
+import { ProjectData } from "store/features/project/projectActions";
+import { getTestScriptHandlers } from "../../getTestScriptHandlers";
+import { dummyProjectData, dummyScene } from "../../dummydata";
+
+test("should include default font when provided", async () => {
+  const projectData = {
+    ...dummyProjectData,
+    fonts: [
+      {
+        id: "font1",
+      },
+      {
+        id: "font2",
+      },
+      {
+        id: "font3",
+      },
+    ] as FontData[],
+    settings: {
+      ...dummyProjectData.settings,
+      defaultFontId: "font2",
+    },
+  } as ProjectData;
+  const customEventsLookup = {} as Dictionary<CustomEvent>;
+  const scriptEventHandlers = await getTestScriptHandlers();
+  const usedAssets = determineUsedAssets({
+    projectData,
+    customEventsLookup,
+    scriptEventHandlers,
+  });
+  expect(usedAssets.referencedFonts).toHaveLength(1);
+  expect(usedAssets.referencedFonts[0].id).toBe("font2");
+});
+
+test("should include first font when default not provided", async () => {
+  const projectData = {
+    ...dummyProjectData,
+    fonts: [
+      {
+        id: "font1",
+      },
+      {
+        id: "font2",
+      },
+      {
+        id: "font3",
+      },
+    ] as FontData[],
+  } as ProjectData;
+  const customEventsLookup = {} as Dictionary<CustomEvent>;
+  const scriptEventHandlers = await getTestScriptHandlers();
+  const usedAssets = determineUsedAssets({
+    projectData,
+    customEventsLookup,
+    scriptEventHandlers,
+  });
+  expect(usedAssets.referencedFonts).toHaveLength(1);
+  expect(usedAssets.referencedFonts[0].id).toBe("font1");
+});
+
+test("should include fonts referenced in gbvm script blocks", async () => {
+  const projectData = {
+    ...dummyProjectData,
+    fonts: [
+      {
+        id: "font1",
+      },
+      {
+        id: "font2",
+      },
+      {
+        id: "font3",
+      },
+    ] as FontData[],
+    scenes: [
+      {
+        ...dummyScene,
+        id: "scene1",
+        script: [
+          {
+            id: "event1",
+            command: "EVENT_GBVM_SCRIPT",
+            args: {
+              script: "",
+              references: [
+                {
+                  type: "font",
+                  id: "font3",
+                },
+              ],
+            },
+          },
+        ],
+      },
+    ],
+  } as ProjectData;
+  const customEventsLookup = {} as Dictionary<CustomEvent>;
+  const scriptEventHandlers = await getTestScriptHandlers();
+  const usedAssets = determineUsedAssets({
+    projectData,
+    customEventsLookup,
+    scriptEventHandlers,
+  });
+  expect(usedAssets.referencedFonts).toHaveLength(2);
+  expect(usedAssets.referencedFonts[0].id).toBe("font1");
+  expect(usedAssets.referencedFonts[1].id).toBe("font3");
+});
+
+test("should include fonts referenced in dialogue", async () => {
+  const projectData = {
+    ...dummyProjectData,
+    fonts: [
+      {
+        id: "3060ae1a-dde6-47f7-af40-5a28bba5a649",
+      },
+      {
+        id: "88f417f8-829b-47d8-8b41-fcf51a12d18e",
+      },
+      {
+        id: "4bd653f0-e08d-424e-9e5b-c1f3aaa21e47",
+      },
+    ] as FontData[],
+    scenes: [
+      {
+        ...dummyScene,
+        id: "scene1",
+        script: [
+          {
+            command: "EVENT_TEXT",
+            args: {
+              text: ["!F:4bd653f0-e08d-424e-9e5b-c1f3aaa21e47!"],
+              avatarId: "",
+            },
+            id: "event1",
+          },
+        ],
+      },
+    ],
+  } as ProjectData;
+  const customEventsLookup = {} as Dictionary<CustomEvent>;
+  const scriptEventHandlers = await getTestScriptHandlers();
+  const usedAssets = determineUsedAssets({
+    projectData,
+    customEventsLookup,
+    scriptEventHandlers,
+  });
+  expect(usedAssets.referencedFonts).toHaveLength(2);
+  expect(usedAssets.referencedFonts[0].id).toBe(
+    "3060ae1a-dde6-47f7-af40-5a28bba5a649"
+  );
+  expect(usedAssets.referencedFonts[1].id).toBe(
+    "4bd653f0-e08d-424e-9e5b-c1f3aaa21e47"
+  );
+});