FIX: links and icons theme setting migrations to handle blank str…

…ing (#50) If the old theme setting value is set to a blank string, we will end up not migrating it and thus cause an error to be raised.
discourse · Aug 1, 2024 · 9e7c224 · 9e7c224
1 parent f458dc9
commit 9e7c224
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 2 deletions.
diff --git a/migrations/settings/0001-migrate-links-setting.js b/migrations/settings/0001-migrate-links-setting.js
@@ -1,7 +1,7 @@
 export default function migrate(settings) {
   const oldSetting = settings.get("links");
 
-  if (oldSetting) {
+  if (typeof oldSetting === "string") {
     const newLinks = [];
 
     oldSetting.split("|").forEach((link) => {

diff --git a/migrations/settings/0002-migrate-icons-setting.js b/migrations/settings/0002-migrate-icons-setting.js
@@ -1,7 +1,7 @@
 export default function migrate(settings) {
   const oldSetting = settings.get("icons");
 
-  if (oldSetting) {
+  if (typeof oldSetting === "string") {
     const newIcons = [];
 
     oldSetting.split("|").map((link) => {

diff --git a/test/unit/migrations/settings/0001-migrate-links-setting-test.js b/test/unit/migrations/settings/0001-migrate-links-setting-test.js
@@ -4,6 +4,22 @@ import migrate from "../../../../migrations/settings/0001-migrate-links-setting"
 module(
   "Brand Header | Unit | Migrations | Settings | 0001-migrate-links-setting",
   function () {
+    test("migrate when old setting is a blank string", function (assert) {
+      const settings = new Map(Object.entries({ links: "" }));
+      const result = migrate(settings);
+
+      const expectedResult = new Map(
+        Object.entries({
+          links: [],
+        })
+      );
+
+      assert.deepEqual(
+        Object.fromEntries(result.entries()),
+        Object.fromEntries(expectedResult.entries())
+      );
+    });
+
     test("migrate when old setting is of an invalid format", function (assert) {
       const settings = new Map(
         Object.entries({

diff --git a/test/unit/migrations/settings/0002-migrate-icons-setting-test.js b/test/unit/migrations/settings/0002-migrate-icons-setting-test.js
@@ -4,6 +4,22 @@ import migrate from "../../../../migrations/settings/0002-migrate-icons-setting"
 module(
   "Brand Header | Unit | Migrations | Settings | 0002-migrate-icons-setting",
   function () {
+    test("migrate when old setting is a blank string", function (assert) {
+      const settings = new Map(Object.entries({ icons: "" }));
+      const result = migrate(settings);
+
+      const expectedResult = new Map(
+        Object.entries({
+          icons: [],
+        })
+      );
+
+      assert.deepEqual(
+        Object.fromEntries(result.entries()),
+        Object.fromEntries(expectedResult.entries())
+      );
+    });
+
     test("migrate when old setting value is of an invalid format", function (assert) {
       const settings = new Map(
         Object.entries({