Add cache buster

GMOD · Dec 6, 2022 · 61c8ae4 · 61c8ae4
1 parent eca394c
commit 61c8ae4
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 1 deletion.
diff --git a/products/jbrowse-web/src/SessionLoader.ts b/products/jbrowse-web/src/SessionLoader.ts
@@ -251,7 +251,14 @@ const SessionLoader = types
     },
 
     async fetchConfig() {
-      const { configPath = 'config.json' } = self
+      let { configPath = 'config.json' } = self
+
+      // @ts-ignore
+      // eslint-disable-next-line no-underscore-dangle
+      if (window.__jbrowseCacheBuster) {
+        configPath += `?rand=${Math.random()}`
+      }
+
       const text = await openLocation({
         uri: configPath,
         locationType: 'UriLocation',

diff --git a/website/docs/config_guides/avoiding_stale_config.md b/website/docs/config_guides/avoiding_stale_config.md
@@ -0,0 +1,23 @@
+---
+id: avoiding_stale_config
+title: Avoiding stale config
+toplevel: true
+---
+
+Some servers strongly cache the "config.json" file. If you want to avoid this,
+you can edit the index.html of JBrowse to include the following
+
+```
+
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <script>
+      window.__jbrowseCacheBuster = true
+    </script>
+    <meta charset="utf-8" />
+```
+
+This will request the config.json file with a random query string appended to
+force the data to be fetched from the server instead of being loaded from the
+local browser cache