include a default favicon in sqlpage

lovasoa · lovasoa · commit e99e386a5f32 · 2024-06-23T18:19:21.000+02:00
this fixes the Unable to read file "favicon.ico" error that was displayed by default in the console when opening a page in a browser
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -35,6 +35,7 @@
  - New `max_pending_rows` [configuration option](https://sql.ophir.dev/configuration.md) to limit the number of messages that can be sent to the client before they are read. Usefule when sending large amounts of data to slow clients.
  - Update sqlite to v3.46: https://www.sqlite.org/releaselog/3_46_0.html
  - Faster initial page load. SQLPage used to wait for the first component to be rendered before sending the shell to the client. We now send the shell immediately, and the first component as soon as it is ready. This can make the initial page load faster, especially when the first component requires a long computation on the database side.
+ - Include a default favicon when none is specified in the shell component. This fixes the `Unable to read file "favicon.ico"` error message that would appear in the logs by default. 
 
 ## 0.23.0 (2024-06-09)
 
diff --git a/build.rs b/build.rs
@@ -20,6 +20,7 @@ async fn main() {
         spawn(download_deps(c.clone(), "tabler-icons.svg")),
         spawn(download_deps(c.clone(), "apexcharts.js")),
         spawn(download_deps(c.clone(), "tomselect.js")),
+        spawn(download_deps(c.clone(), "favicon.svg")),
     ] {
         h.await.unwrap();
     }
diff --git a/sqlpage/favicon.svg b/sqlpage/favicon.svg
@@ -0,0 +1,11 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="1024" height="1024" fill="none" stroke="#e7f6f8" stroke-linecap="round" stroke-linejoin="round" stroke-width="75">
+  <defs>
+    <filter id="b" width="200%" height="200%" x="-50%" y="-50%">
+      <feGaussianBlur stdDeviation="45"/>
+    </filter>
+    <path id="a" d="M171 264a341 122 0 1 0 682 0 341 122 0 1 0-682 0m0 0v245a341 122 0 0 0 682 0V264M171 509v244a341 122 0 0 0 682 0V509"/>
+  </defs>
+  <rect width="100%" height="100%" fill="#0f3953" stroke="none" ry="64"/>
+  <use href="#a"/>
+  <use filter="url(#b)" href="#a"/>
+</svg>
diff --git a/sqlpage/templates/shell.handlebars b/sqlpage/templates/shell.handlebars
@@ -3,9 +3,7 @@
 <head>
     <meta charset="utf-8"/>
     <title>{{default title "SQLPage"}}</title>
-    {{#if favicon}}
-        <link rel="icon" href="{{favicon}}">
-    {{/if}}
+    <link rel="icon" href="{{#if favicon}}{{favicon}}{{else}}{{static_path 'favicon.svg'}}{{/if}}">
     {{#if manifest}}
         <link rel="manifest" href="{{manifest}}">
     {{/if}}
diff --git a/src/template_helpers.rs b/src/template_helpers.rs
@@ -151,6 +151,7 @@ impl CanHelp for StaticPathHelper {
             "sqlpage.css" => static_filename!("sqlpage.css"),
             "apexcharts.js" => static_filename!("apexcharts.js"),
             "tomselect.js" => static_filename!("tomselect.js"),
+            "favicon.svg" => static_filename!("favicon.svg"),
             other => return Err(format!("unknown static file: {other:?}")),
         };
         Ok(format!("{}{}", self.0, path).into())
diff --git a/src/webserver/http.rs b/src/webserver/http.rs
@@ -525,6 +525,7 @@ pub fn create_app(
                 .service(static_content::tomselect_js())
                 .service(static_content::css())
                 .service(static_content::icons())
+                .service(static_content::favicon())
                 .default_service(fn_service(main_handler)),
         )
         // when receiving a request outside of the prefix, redirect to the prefix
diff --git a/src/webserver/static_content.rs b/src/webserver/static_content.rs
@@ -49,3 +49,7 @@ pub fn css() -> Resource {
 pub fn icons() -> Resource {
     static_file_endpoint!("tabler-icons", "svg", "image/svg+xml")
 }
+
+pub fn favicon() -> Resource {
+    static_file_endpoint!("favicon", "svg", "image/svg+xml")
+}

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ async fn main() {`
`20`	`20`	`spawn(download_deps(c.clone(), "tabler-icons.svg")),`
`21`	`21`	`spawn(download_deps(c.clone(), "apexcharts.js")),`
`22`	`22`	`spawn(download_deps(c.clone(), "tomselect.js")),`
	`23`	`+ spawn(download_deps(c.clone(), "favicon.svg")),`
`23`	`24`	`] {`
`24`	`25`	`h.await.unwrap();`
`25`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -525,6 +525,7 @@ pub fn create_app(`
`525`	`525`	`.service(static_content::tomselect_js())`
`526`	`526`	`.service(static_content::css())`
`527`	`527`	`.service(static_content::icons())`
	`528`	`+ .service(static_content::favicon())`
`528`	`529`	`.default_service(fn_service(main_handler)),`
`529`	`530`	`)`
`530`	`531`	`// when receiving a request outside of the prefix, redirect to the prefix`
Original file line number	Diff line number	Diff line change
`@@ -49,3 +49,7 @@ pub fn css() -> Resource {`
`49`	`49`	`pub fn icons() -> Resource {`
`50`	`50`	`static_file_endpoint!("tabler-icons", "svg", "image/svg+xml")`
`51`	`51`	`}`
	`52`	`+`
	`53`	`+pub fn favicon() -> Resource {`
	`54`	`+ static_file_endpoint!("favicon", "svg", "image/svg+xml")`
	`55`	`+}`