Refactor docs to use search_data.json instead of search-data.js

compiler-core/src/docs.rs

@@ -363,7 +363,7 @@ pub fn generate_html<IO: FileSystemReader>(
         ),
     });
 
-    // lunr.min.js, search-data.js, search_data.json and index.js
+    // lunr.min.js, search_data.json and index.js
 
     files.push(OutputFile {
         path: Utf8PathBuf::from("js/lunr.min.js"),
@@ -376,11 +376,6 @@ pub fn generate_html<IO: FileSystemReader>(
     })
     .expect("search index serialization");
 
-    files.push(OutputFile {
-        path: Utf8PathBuf::from("search-data.js"),
-        content: Content::Text(format!("window.Gleam.initSearch({});", search_data_json)),
-    });
-
     files.push(OutputFile {
         path: Utf8PathBuf::from("search_data.json"),
         content: Content::Text(search_data_json.to_string()),

compiler-core/src/docs/snapshots/gleam_core__docs__tests__canonical_link.snap

@@ -1,6 +1,7 @@
 ---
 source: compiler-core/src/docs/tests.rs
 expression: "compile_with_markdown_pages(config, modules, pages,\nCompileWithMarkdownPagesOpts::default())"
+snapshot_kind: text
 ---
 //// LICENSE.html
 
@@ -313,11 +314,14 @@ expression: "compile_with_markdown_pages(config, modules, pages,\nCompileWithMar
       });
       hljs.highlightAll();
     </script>
+
     <script src="./js/lunr.min.js?v=GLEAM_VERSION_HERE"></script>
     <script src="./js/index.js?v=0"></script>
-
-    <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="./search-data.js?v=0"></script>
+    <script>
+      fetch("./search_data.json?v=0")
+        .then(response => response.json())
+        .then(data => window.Gleam.initSearch(data));
+    </script>
   </body>
 </html>
 
@@ -678,11 +682,14 @@ expression: "compile_with_markdown_pages(config, modules, pages,\nCompileWithMar
       });
       hljs.highlightAll();
     </script>
+
     <script src="./js/lunr.min.js?v=GLEAM_VERSION_HERE"></script>
     <script src="./js/index.js?v=0"></script>
-
-    <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="./search-data.js?v=0"></script>
+    <script>
+      fetch("./search_data.json?v=0")
+        .then(response => response.json())
+        .then(data => window.Gleam.initSearch(data));
+    </script>
   </body>
 </html>
 
@@ -1043,10 +1050,13 @@ expression: "compile_with_markdown_pages(config, modules, pages,\nCompileWithMar
       });
       hljs.highlightAll();
     </script>
+
     <script src="../../js/lunr.min.js?v=GLEAM_VERSION_HERE"></script>
     <script src="../../js/index.js?v=0"></script>
-
-    <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../../search-data.js?v=0"></script>
+    <script>
+      fetch("../../search_data.json?v=0")
+        .then(response => response.json())
+        .then(data => window.Gleam.initSearch(data));
+    </script>
   </body>
 </html>

compiler-core/src/docs/snapshots/gleam_core__docs__tests__discarded_arguments_are_not_shown.snap

@@ -1,6 +1,7 @@
 ---
 source: compiler-core/src/docs/tests.rs
 expression: "compile(config, modules)"
+snapshot_kind: text
 ---
 //// app.html
 
@@ -349,10 +350,13 @@ expression: "compile(config, modules)"
       });
       hljs.highlightAll();
     </script>
+
     <script src="./js/lunr.min.js?v=GLEAM_VERSION_HERE"></script>
     <script src="./js/index.js?v=0"></script>
-
-    <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="./search-data.js?v=0"></script>
+    <script>
+      fetch("./search_data.json?v=0")
+        .then(response => response.json())
+        .then(data => window.Gleam.initSearch(data));
+    </script>
   </body>
 </html>

compiler-core/src/docs/snapshots/gleam_core__docs__tests__docs_of_a_type_constructor_are_not_used_by_the_following_function.snap

@@ -1,6 +1,7 @@
 ---
 source: compiler-core/src/docs/tests.rs
 expression: "compile(config, modules)"
+snapshot_kind: text
 ---
 //// app.html
 
@@ -424,10 +425,13 @@ expression: "compile(config, modules)"
       });
       hljs.highlightAll();
     </script>
+
     <script src="./js/lunr.min.js?v=GLEAM_VERSION_HERE"></script>
     <script src="./js/index.js?v=0"></script>
-
-    <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="./search-data.js?v=0"></script>
+    <script>
+      fetch("./search_data.json?v=0")
+        .then(response => response.json())
+        .then(data => window.Gleam.initSearch(data));
+    </script>
   </body>
 </html>

compiler-core/src/docs/snapshots/gleam_core__docs__tests__hello_docs.snap

@@ -1,6 +1,7 @@
 ---
 source: compiler-core/src/docs/tests.rs
 expression: "compile(config, modules)"
+snapshot_kind: text
 ---
 //// app.html
 
@@ -350,10 +351,13 @@ expression: "compile(config, modules)"
       });
       hljs.highlightAll();
     </script>
+
     <script src="./js/lunr.min.js?v=GLEAM_VERSION_HERE"></script>
     <script src="./js/index.js?v=0"></script>
-
-    <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="./search-data.js?v=0"></script>
+    <script>
+      fetch("./search_data.json?v=0")
+        .then(response => response.json())
+        .then(data => window.Gleam.initSearch(data));
+    </script>
   </body>
 </html>

compiler-core/src/docs/snapshots/gleam_core__docs__tests__internal_definitions_are_not_included.snap

@@ -1,6 +1,7 @@
 ---
 source: compiler-core/src/docs/tests.rs
 expression: "compile(config, modules)"
+snapshot_kind: text
 ---
 //// app.html
 
@@ -319,10 +320,13 @@ expression: "compile(config, modules)"
       });
       hljs.highlightAll();
     </script>
+
     <script src="./js/lunr.min.js?v=GLEAM_VERSION_HERE"></script>
     <script src="./js/index.js?v=0"></script>
-
-    <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="./search-data.js?v=0"></script>
+    <script>
+      fetch("./search_data.json?v=0")
+        .then(response => response.json())
+        .then(data => window.Gleam.initSearch(data));
+    </script>
   </body>
 </html>

compiler-core/src/docs/snapshots/gleam_core__docs__tests__long_function_wrapping.snap

@@ -1,6 +1,7 @@
 ---
 source: compiler-core/src/docs/tests.rs
 expression: "compile(config, modules)"
+snapshot_kind: text
 ---
 //// app.html
 
@@ -423,10 +424,13 @@ function for a fallback value.</p>
       });
       hljs.highlightAll();
     </script>
+
     <script src="./js/lunr.min.js?v=GLEAM_VERSION_HERE"></script>
     <script src="./js/index.js?v=0"></script>
-
-    <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="./search-data.js?v=0"></script>
+    <script>
+      fetch("./search_data.json?v=0")
+        .then(response => response.json())
+        .then(data => window.Gleam.initSearch(data));
+    </script>
   </body>
 </html>

compiler-core/src/docs/snapshots/gleam_core__docs__tests__markdown_code_from_function_comment_is_trimmed.snap

@@ -1,6 +1,7 @@
 ---
 source: compiler-core/src/docs/tests.rs
 expression: "compile(config, modules)"
+snapshot_kind: text
 ---
 //// app.html
 
@@ -353,10 +354,13 @@ expression: "compile(config, modules)"
       });
       hljs.highlightAll();
     </script>
+
     <script src="./js/lunr.min.js?v=GLEAM_VERSION_HERE"></script>
     <script src="./js/index.js?v=0"></script>
-
-    <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="./search-data.js?v=0"></script>
+    <script>
+      fetch("./search_data.json?v=0")
+        .then(response => response.json())
+        .then(data => window.Gleam.initSearch(data));
+    </script>
   </body>
 </html>

compiler-core/src/docs/snapshots/gleam_core__docs__tests__markdown_code_from_module_comment_is_trimmed.snap

@@ -1,6 +1,7 @@
 ---
 source: compiler-core/src/docs/tests.rs
 expression: "compile(config, modules)"
+snapshot_kind: text
 ---
 //// app.html
 
@@ -323,10 +324,13 @@ expression: "compile(config, modules)"
       });
       hljs.highlightAll();
     </script>
+
     <script src="./js/lunr.min.js?v=GLEAM_VERSION_HERE"></script>
     <script src="./js/index.js?v=0"></script>
-
-    <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="./search-data.js?v=0"></script>
+    <script>
+      fetch("./search_data.json?v=0")
+        .then(response => response.json())
+        .then(data => window.Gleam.initSearch(data));
+    </script>
   </body>
 </html>

compiler-core/src/docs/snapshots/gleam_core__docs__tests__markdown_code_from_standalone_pages_is_not_trimmed.snap

@@ -1,6 +1,7 @@
 ---
 source: compiler-core/src/docs/tests.rs
 expression: "compile_with_markdown_pages(config, vec![], pages,\nCompileWithMarkdownPagesOpts::default())"
+snapshot_kind: text
 ---
 //// one.html
 
@@ -313,10 +314,13 @@ expression: "compile_with_markdown_pages(config, vec![], pages,\nCompileWithMark
       });
       hljs.highlightAll();
     </script>
+
     <script src="./js/lunr.min.js?v=GLEAM_VERSION_HERE"></script>
     <script src="./js/index.js?v=0"></script>
-
-    <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="./search-data.js?v=0"></script>
+    <script>
+      fetch("./search_data.json?v=0")
+        .then(response => response.json())
+        .then(data => window.Gleam.initSearch(data));
+    </script>
   </body>
 </html>

compiler-core/src/docs/snapshots/gleam_core__docs__tests__no_hex_publish.snap

@@ -1,6 +1,7 @@
 ---
 source: compiler-core/src/docs/tests.rs
 expression: "compile_with_markdown_pages(config, modules, pages,\nCompileWithMarkdownPagesOpts { hex_publish: Some(DocContext::Build) })"
+snapshot_kind: text
 ---
 //// LICENSE.html
 
@@ -306,11 +307,14 @@ expression: "compile_with_markdown_pages(config, modules, pages,\nCompileWithMar
       });
       hljs.highlightAll();
     </script>
+
     <script src="./js/lunr.min.js?v=GLEAM_VERSION_HERE"></script>
     <script src="./js/index.js?v=0"></script>
-
-    <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="./search-data.js?v=0"></script>
+    <script>
+      fetch("./search_data.json?v=0")
+        .then(response => response.json())
+        .then(data => window.Gleam.initSearch(data));
+    </script>
   </body>
 </html>
 
@@ -664,11 +668,14 @@ expression: "compile_with_markdown_pages(config, modules, pages,\nCompileWithMar
       });
       hljs.highlightAll();
     </script>
+
     <script src="./js/lunr.min.js?v=GLEAM_VERSION_HERE"></script>
     <script src="./js/index.js?v=0"></script>
-
-    <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="./search-data.js?v=0"></script>
+    <script>
+      fetch("./search_data.json?v=0")
+        .then(response => response.json())
+        .then(data => window.Gleam.initSearch(data));
+    </script>
   </body>
 </html>
 
@@ -1022,10 +1029,13 @@ expression: "compile_with_markdown_pages(config, modules, pages,\nCompileWithMar
       });
       hljs.highlightAll();
     </script>
+
     <script src="../../js/lunr.min.js?v=GLEAM_VERSION_HERE"></script>
     <script src="../../js/index.js?v=0"></script>
-
-    <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../../search-data.js?v=0"></script>
+    <script>
+      fetch("../../search_data.json?v=0")
+        .then(response => response.json())
+        .then(data => window.Gleam.initSearch(data));
+    </script>
   </body>
 </html>

compiler-core/src/docs/snapshots/gleam_core__docs__tests__tables.snap

@@ -1,6 +1,7 @@
 ---
 source: compiler-core/src/docs/tests.rs
 expression: "compile(config, modules)"
+snapshot_kind: text
 ---
 //// app.html
 
@@ -353,10 +354,13 @@ expression: "compile(config, modules)"
       });
       hljs.highlightAll();
     </script>
+
     <script src="./js/lunr.min.js?v=GLEAM_VERSION_HERE"></script>
     <script src="./js/index.js?v=0"></script>
-
-    <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="./search-data.js?v=0"></script>
+    <script>
+      fetch("./search_data.json?v=0")
+        .then(response => response.json())
+        .then(data => window.Gleam.initSearch(data));
+    </script>
   </body>
 </html>

compiler-core/src/docs/tests.rs

@@ -551,11 +551,3 @@ fn output_of_search_data_json() {
     let json = serde_to_string(&data).unwrap();
     insta::assert_snapshot!(json);
 }
-
-#[test]
-fn output_of_search_data_js() {
-    let data = create_sample_search_data();
-    let json = serde_to_string(&data).unwrap();
-    let json_wrapped_in_js = format!("window.Gleam.initSearch({});", json);
-    insta::assert_snapshot!(json_wrapped_in_js);
-}