feat: enhance search cache compatibility version handling

attack-search/__tests__/search-events.test.js

@@ -83,6 +83,16 @@ describe('search event bindings', () => {
     expect(eventsForSelector('[data-search-filter-reset]')).toContain('touchend');
   });
 
+  test('search cache key includes the serialized index compatibility version', () => {
+    const { searchCacheCompatibilityVersion, searchCacheSchemaVersion } = require('../src/settings');
+
+    require('../src/index');
+
+    expect(global.localStorage.getItem).toHaveBeenCalledWith(
+      `saved_uuid_search_schema_${searchCacheSchemaVersion}-${searchCacheCompatibilityVersion}`,
+    );
+  });
+
   test('dropdown toggles open before the search service is initialized', () => {
     require('../src/index');
 

attack-search/__tests__/settings.test.js

@@ -1,6 +1,16 @@
-const { searchFilePaths } = require('../src/settings');
+const {
+  searchCacheCompatibilityVersion,
+  searchFilePaths,
+} = require('../src/settings');
+const packageJson = require('../package.json');
 
 describe('search settings', () => {
+  test('includes the FlexSearch version in the cache compatibility token', () => {
+    const expectedFlexSearchVersion = packageJson.dependencies.flexsearch.replace(/^[^\d]*/, '');
+
+    expect(searchCacheCompatibilityVersion).toBe(`flexsearch-${expectedFlexSearchVersion}`);
+  });
+
   test('loads the generated sub-technique search index', () => {
     expect(searchFilePaths).toContain('sub-techniques.json');
   });

attack-search/src/index.js

@@ -10,7 +10,12 @@ const $ = require('jquery');
  */
 
 // Import required modules with the correct file extension
-const { baseURL, searchCacheSchemaVersion, searchFilePaths } = require('./settings.js');
+const {
+  baseURL,
+  searchCacheCompatibilityVersion,
+  searchCacheSchemaVersion,
+  searchFilePaths,
+} = require('./settings.js');
 const Debouncer = require('./debouncer.js');
 const SearchService = require('./search-service.js');
 const { loadSearchDocuments } = require('./search-loader.js');
@@ -26,7 +31,8 @@ const {
   closeButton,
 } = require('./components.js');
 
-const searchCacheKey = `saved_uuid_search_schema_${searchCacheSchemaVersion}`;
+const searchCacheVersion = `${searchCacheSchemaVersion}-${searchCacheCompatibilityVersion}`;
+const searchCacheKey = `saved_uuid_search_schema_${searchCacheVersion}`;
 let searchService;
 let openFilterDropdownKey = null;
 
@@ -89,7 +95,7 @@ async function initializeSearchService() {
   searchParsingIcon.show();
 
   const saved_uuid = localStorage.getItem(searchCacheKey);
-  const cachedBuildId = `${build_uuid}-search-${searchCacheSchemaVersion}`;
+  const cachedBuildId = `${build_uuid}-search-${searchCacheVersion}`;
   console.debug(`Retrieved the saved_uuid from localStorage: ${saved_uuid}`);
 
   // Check if the browser supports IndexedDB. Search service can only work in environments that support IndexedDB.

attack-search/src/settings.js

@@ -1,5 +1,9 @@
 const baseURL = ''; // TODO migrate from base_url (generated via Pelican)
+const packageJson = require('../package.json');
+
 const searchCacheSchemaVersion = 2;
+const flexSearchVersion = packageJson.dependencies.flexsearch.replace(/^[^\d]*/, '');
+const searchCacheCompatibilityVersion = `flexsearch-${flexSearchVersion}`;
 
 const searchFilePaths = [
   'campaigns.json',
@@ -19,6 +23,7 @@ const searchFilePaths = [
 ];
 module.exports = {
   baseURL,
+  searchCacheCompatibilityVersion,
   searchCacheSchemaVersion,
   searchFilePaths,
 };