Fixed option comparison.

Author: ciscoheat

CHANGELOG.md

@@ -5,6 +5,12 @@ Headlines: Added, Changed, Deprecated, Removed, Fixed, Security
 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).
 
+## [2.3.1] - 2024-01-07
+
+### Fixed
+
+- Options weren't compared properly, causing problems when navigating.
+
 ## [2.3.0] - 2023-12-15
 
 ### Added

src/lib/client.ts

@@ -15,6 +15,7 @@ export type FlashOptions = Partial<{
 type FlashContext = {
   store: Writable<App.PageData['flash']>;
   options: FlashOptions;
+  optionHash: string;
 };
 
 const flashStores = new WeakMap<Readable<Page>, FlashContext>();
@@ -41,22 +42,7 @@ export function initFlash(
 
 function _initFlash(page: Readable<Page>, options?: FlashOptions): Writable<App.PageData['flash']> {
   const flashStore = flashStores.get(page);
-
-  if (flashStore && !options) {
-    /*
-    console.log(
-      {
-        hasStore: true,
-        route: get(page).route.id,
-        customOptions: flashStore.options !== defaultOptions
-      },
-      flashStore.options
-    );
-    */
-    return flashStore.store;
-  } else if (flashStore && options && flashStore.options !== options) {
-    throw new Error('getFlash options can only be set once, at a top-level component.');
-  }
+  if (flashStore && !options) return flashStore.store;
 
   const currentOptions: FlashOptions = options
     ? {
@@ -69,19 +55,12 @@ function _initFlash(page: Readable<Page>, options?: FlashOptions): Writable<App.
       }
     : defaultOptions;
 
+  if (flashStore && options && serializeOptions(currentOptions) !== flashStore.optionHash) {
+    throw new Error('getFlash options can only be set once, at a top-level component.');
+  }
+
   const store = writable<App.PageData['flash']>();
-  const context = { store, options: currentOptions };
-
-  /*
-  console.log(
-    {
-      hasStore: false,
-      route: get(page).route.id,
-      customOptions: context.options !== defaultOptions
-    },
-    context.options
-  );
-  */
+  const context = { store, options: currentOptions, optionHash: serializeOptions(currentOptions) };
 
   flashStores.set(page, context);
   clearCookieAndUpdateIfNewData(context, get(page).data.flash);
@@ -145,6 +124,10 @@ function _initFlash(page: Readable<Page>, options?: FlashOptions): Writable<App.
   return store;
 }
 
+function serializeOptions(opts: FlashOptions) {
+  return JSON.stringify(opts);
+}
+
 /**
  * Retrieves the flash message store for display or modification.
  * @param page Page store, imported from `$app/stores`.

src/routes/(app)/errorpage/+page.svelte

@@ -0,0 +1,4 @@
+<script>
+  import {error} from '@sveltejs/kit';
+  throw error(500);
+</script>

src/routes/(app)/multi-init/+page.svelte

@@ -5,7 +5,7 @@
   let error = '';
 
   try {
-    getFlash(page, { clearOnNavigate: true });
+    getFlash(page, { clearOnNavigate: false });
   } catch (e) {
     error = String(e);
   }