itsi 0.1.11 → 0.1.12

data/crates/itsi_tracing/src/lib.rs

@@ -1,58 +1,229 @@
-use std::env;
-
 use atty::{Stream, is};
-use tracing::level_filters::LevelFilter;
-pub use tracing::{debug, error, info, trace, warn};
-pub use tracing_attributes::instrument; // Explicitly export from tracing-attributes
-use tracing_subscriber::{
-    EnvFilter, Layer,
-    fmt::{self, format},
-    layer::SubscriberExt,
+use std::{
+    env,
+    sync::{Mutex, OnceLock},
 };
+pub use tracing::{debug, error, info, trace, warn};
+use tracing_appender::rolling;
+use tracing_subscriber::Layer;
+use tracing_subscriber::fmt::writer::BoxMakeWriter;
+use tracing_subscriber::{EnvFilter, fmt, prelude::*, reload};
+
+// Global reload handle for changing the level at runtime.
+static RELOAD_HANDLE: OnceLock<
+    Mutex<Option<reload::Handle<EnvFilter, tracing_subscriber::Registry>>>,
+> = OnceLock::new();
+
+/// Log format: Plain or JSON.
+#[derive(Debug, Clone)]
+pub enum LogFormat {
+    Plain,
+    Json,
+}
+
+/// Log target: STDOUT, File, or Both.
+#[derive(Debug, Clone)]
+pub enum LogTarget {
+    Stdout,
+    File(String), // file name (rotated daily)
+    Both(String), // file name (rotated daily) plus STDOUT
+}
+
+/// Logger configuration.
+#[derive(Debug, Clone)]
+pub struct LogConfig {
+    /// Log level as a string (e.g. "info", "debug").
+    pub level: String,
+    /// Format: Plain (with optional ANSI) or JSON.
+    pub format: LogFormat,
+    /// Target: STDOUT, File, or Both.
+    pub target: LogTarget,
+    /// Whether to enable ANSI coloring (for plain text).
+    pub use_ansi: bool,
+}
 
-#[instrument]
+impl Default for LogConfig {
+    fn default() -> Self {
+        let level = env::var("ITSI_LOG").unwrap_or_else(|_| "info".into());
+        let format = match env::var("ITSI_LOG_FORMAT").as_deref() {
+            Ok("json") => LogFormat::Json,
+            _ => LogFormat::Plain,
+        };
+        let target = match env::var("ITSI_LOG_TARGET").as_deref() {
+            Ok("file") => {
+                let file = env::var("ITSI_LOG_FILE").unwrap_or_else(|_| "app.log".into());
+                LogTarget::File(file)
+            }
+            Ok("both") => {
+                let file = env::var("ITSI_LOG_FILE").unwrap_or_else(|_| "app.log".into());
+                LogTarget::Both(file)
+            }
+            _ => LogTarget::Stdout,
+        };
+        // If ITSI_LOG_ANSI is set, use that; otherwise, use ANSI if stdout is a TTY.
+        let use_ansi = env::var("ITSI_LOG_ANSI")
+            .map(|s| s == "true")
+            .unwrap_or_else(|_| is(Stream::Stdout));
+        Self {
+            level,
+            format,
+            target,
+            use_ansi,
+        }
+    }
+}
+
+/// Initialize the global tracing subscriber with the default configuration.
 pub fn init() {
-    let env_filter = EnvFilter::builder()
-        .with_env_var("ITSI_LOG")
-        .try_from_env()
-        .unwrap_or_else(|_| EnvFilter::new("info"));
-
-    let format = fmt::format()
-        .compact()
-        .with_file(false)
-        .with_level(true)
-        .with_line_number(false)
-        .with_source_location(false)
-        .with_target(false)
-        .with_thread_ids(false);
-
-    let is_tty = is(Stream::Stdout);
-
-    let subscriber = tracing_subscriber::fmt()
-        .event_format(format)
-        .with_env_filter(env_filter);
-
-    if (is_tty && env::var("ITSI_LOG_PLAIN").is_err()) || env::var("ITSI_LOG_ANSI").is_ok() {
-        subscriber.with_ansi(true).init();
+    init_with_config(LogConfig::default());
+}
+
+/// Initialize the global tracing subscriber with a given configuration.
+pub fn init_with_config(config: LogConfig) {
+    // Build an EnvFilter from the configured level.
+    let env_filter = EnvFilter::new(config.level);
+
+    // Build the formatting layer based on target and format.
+    let fmt_layer = match config.target {
+        LogTarget::Stdout => match config.format {
+            LogFormat::Plain => fmt::layer()
+                .compact()
+                .with_file(false)
+                .with_line_number(false)
+                .with_target(false)
+                .with_thread_ids(false)
+                .with_writer(BoxMakeWriter::new(std::io::stdout))
+                .with_ansi(config.use_ansi)
+                .boxed(),
+            LogFormat::Json => fmt::layer()
+                .compact()
+                .with_file(false)
+                .with_line_number(false)
+                .with_target(false)
+                .with_thread_ids(false)
+                .with_writer(BoxMakeWriter::new(std::io::stdout))
+                .with_ansi(config.use_ansi)
+                .json()
+                .boxed(),
+        },
+        LogTarget::File(file) => match config.format {
+            LogFormat::Plain => fmt::layer()
+                .compact()
+                .with_file(false)
+                .with_line_number(false)
+                .with_target(false)
+                .with_thread_ids(false)
+                .with_writer(BoxMakeWriter::new({
+                    let file = file.clone();
+                    move || rolling::daily(".", file.clone())
+                }))
+                .with_ansi(false)
+                .boxed(),
+            LogFormat::Json => fmt::layer()
+                .compact()
+                .with_file(false)
+                .with_line_number(false)
+                .with_target(false)
+                .with_thread_ids(false)
+                .with_writer(BoxMakeWriter::new({
+                    let file = file.clone();
+                    move || rolling::daily(".", file.clone())
+                }))
+                .with_ansi(false)
+                .json()
+                .boxed(),
+        },
+        LogTarget::Both(file) => {
+            // For "Both" target, handle each format separately to avoid type mismatches
+            match config.format {
+                LogFormat::Plain => {
+                    let stdout_layer = fmt::layer()
+                        .compact()
+                        .with_file(false)
+                        .with_line_number(false)
+                        .with_target(false)
+                        .with_thread_ids(false)
+                        .with_writer(BoxMakeWriter::new(std::io::stdout))
+                        .with_ansi(config.use_ansi);
+
+                    let file_layer = fmt::layer()
+                        .compact()
+                        .with_file(false)
+                        .with_line_number(false)
+                        .with_target(false)
+                        .with_thread_ids(false)
+                        .with_writer(BoxMakeWriter::new({
+                            let file = file.clone();
+                            move || rolling::daily(".", file.clone())
+                        }))
+                        .with_ansi(false);
+
+                    stdout_layer.and_then(file_layer).boxed()
+                }
+                LogFormat::Json => {
+                    let stdout_layer = fmt::layer()
+                        .compact()
+                        .with_file(false)
+                        .with_line_number(false)
+                        .with_target(false)
+                        .with_thread_ids(false)
+                        .with_writer(BoxMakeWriter::new(std::io::stdout))
+                        .with_ansi(config.use_ansi)
+                        .json();
+
+                    let file_layer = fmt::layer()
+                        .compact()
+                        .with_file(false)
+                        .with_line_number(false)
+                        .with_target(false)
+                        .with_thread_ids(false)
+                        .with_writer(BoxMakeWriter::new({
+                            let file = file.clone();
+                            move || rolling::daily(".", file.clone())
+                        }))
+                        .with_ansi(false)
+                        .json();
+
+                    stdout_layer.and_then(file_layer).boxed()
+                }
+            }
+        }
+    };
+
+    // Create a reloadable filter layer so we can update the level at runtime.
+    let (filter_layer, handle) = reload::Layer::new(env_filter);
+
+    // Build the subscriber registry
+    let subscriber = tracing_subscriber::registry()
+        .with(filter_layer)
+        .with(fmt_layer);
+
+    tracing::subscriber::set_global_default(subscriber)
+        .expect("Unable to set global tracing subscriber");
+
+    RELOAD_HANDLE.set(Mutex::new(Some(handle))).unwrap();
+}
+
+/// Change the log level at runtime.
+pub fn set_level(new_level: &str) {
+    if let Some(handle) = RELOAD_HANDLE.get().unwrap().lock().unwrap().as_ref() {
+        handle
+            .modify(|filter| *filter = EnvFilter::new(new_level))
+            .expect("Failed to update log level");
     } else {
-        subscriber
-            .fmt_fields(format::JsonFields::default())
-            .event_format(fmt::format().json())
-            .init();
+        eprintln!("Reload handle not initialized; call init() first.");
     }
 }
 
+/// Run a function silently by temporarily setting a no-op subscriber.
 pub fn run_silently<F, R>(f: F) -> R
 where
     F: FnOnce() -> R,
 {
-    // Build a minimal subscriber that filters *everything* out
-    let no_op_subscriber =
-        tracing_subscriber::registry().with(fmt::layer().with_filter(LevelFilter::OFF));
-
-    // Turn that subscriber into a `Dispatch`
-    let no_op_dispatch = tracing::dispatcher::Dispatch::new(no_op_subscriber);
-
-    // Temporarily set `no_op_dispatch` as the *default* within this closure
-    tracing::dispatcher::with_default(&no_op_dispatch, f)
+    let no_op_subscriber = tracing_subscriber::fmt()
+        .with_writer(std::io::sink)
+        .with_max_level(tracing_subscriber::filter::LevelFilter::OFF)
+        .finish();
+    let dispatch = tracing::Dispatch::new(no_op_subscriber);
+    tracing::dispatcher::with_default(&dispatch, f)
 }

data/docs/.gitignore

@@ -0,0 +1,7 @@
+# Hugo output
+public/
+resources/
+.hugo_build.lock
+
+# Editor
+.vscode/

data/docs/.gitpod.yml

@@ -0,0 +1,15 @@
+# This configuration file was automatically generated by Gitpod.
+# Please adjust to your needs (see https://www.gitpod.io/docs/introduction/learn-gitpod/gitpod-yaml)
+# and commit this file to your remote git repository to share the goodness with others.
+
+# Learn more from ready-to-use templates: https://www.gitpod.io/docs/introduction/getting-started/quickstart
+
+tasks:
+  - name: Install Hugo
+    before: brew install hugo
+    init: echo "Your version of Hugo is `hugo version`" && hugo mod tidy
+    command: hugo server -D -F --baseURL $(gp url 1313) --liveReloadPort=443 --appendPort=false --bind=0.0.0.0 --disableFastRender
+
+ports:
+  - port: 1313
+    onOpen: open-preview

data/docs/Itsi.rb

@@ -0,0 +1,17 @@
+bind 'http://0.0.0.0:3000'
+
+workers 1
+
+watch 'Itsi.rb', [%w[bundle exec itsi restart]]
+watch '**/**.md', [%w[hugo build]]
+
+location '/' do
+  static_assets \
+    root_dir: 'public',
+    not_found_behavior: { index: '404.html' },
+    auto_index: false,
+    try_html_extension: true,
+    max_file_size_in_memory: 10 * 1024 * 1024,
+    max_files_in_memory: 100,
+    file_check_interval: 1
+end

data/docs/content/_index.md

@@ -0,0 +1,17 @@
+---
+title: My Site
+toc: false
+---
+
+This is the landing page.
+
+## Explore
+
+{{< cards >}}
+  {{< card link="docs" title="Docs" icon="book-open" >}}
+  {{< card link="about" title="About" icon="user" >}}
+{{< /cards >}}
+
+## Documentation
+
+For more information, visit [Hextra](https://imfing.github.io/hextra).

data/docs/content/about.md

@@ -0,0 +1,6 @@
+---
+title: About
+type: about
+---
+
+This is the about page.

data/docs/content/docs/_index.md

@@ -0,0 +1,18 @@
+---
+title: Documentation
+next: first-page
+---
+
+This is a demo of the theme's documentation layout.
+
+## Hello, World!
+
+```go {filename="main.go"}
+package main
+
+import "fmt"
+
+func main() {
+    fmt.Println("Hello, World!")
+}
+```

data/docs/content/docs/first-page.md

@@ -0,0 +1,9 @@
+---
+title: Demo Page
+type: docs
+prev: /
+next: docs/folder/
+---
+
+A simple demo page.
+

data/docs/content/docs/folder/_index.md

@@ -0,0 +1,10 @@
+---
+title: Folder
+type: docs
+prev: docs/first-page
+next: docs/folder/leaf
+sidebar:
+  open: true
+---
+
+Pages can be organized into folders.

data/docs/content/docs/folder/leaf.md

@@ -0,0 +1,7 @@
+---
+title: Leaf Page
+type: docs
+prev: docs/folder/
+---
+
+This page is under a folder.

data/docs/go.mod

@@ -0,0 +1,5 @@
+module github.com/imfing/hextra-starter-template
+
+go 1.21
+
+require github.com/imfing/hextra v0.9.7 // indirect

data/docs/go.sum

@@ -0,0 +1,2 @@
+github.com/imfing/hextra v0.9.7 h1:Zg5n24us36Bn/S/5mEUPkRW6uwE6vHHEqWSgN0bPXaM=
+github.com/imfing/hextra v0.9.7/go.mod h1:cEfel3lU/bSx7lTE/+uuR4GJaphyOyiwNR3PTqFTXpI=

data/docs/hugo.yaml

@@ -0,0 +1,77 @@
+# Hugo configuration file
+title: My Site
+
+# import hextra as module
+module:
+  imports:
+    - path: github.com/imfing/hextra
+  mounts:
+    - source: "../crates"
+      target: "content/crates"
+      includeFiles: ["*.md", "*/**.md", "**/**.md"]
+    - source: "../gems/scheduler/README.md"
+      target: "content/gems/_index.md"
+    - source: "../gems"
+      target: "content/gems"
+      includeFiles: ["*.md", "*/*.md"]
+      excludeFiles: ["*/tmp/**.md"]
+    - source: "content"
+      target: "content"
+    - source: "static"
+      target: "static"
+
+markup:
+  # allow raw html
+  goldmark:
+    renderer:
+      unsafe: true
+
+  # enable hextra syntax highlight
+  highlight:
+    noClasses: false
+
+menu:
+  main:
+    - name: Docs
+      pageRef: /docs
+      weight: 1
+    - name: About
+      pageRef: /about
+      weight: 2
+    - name: Crates
+      pageRef: /crates
+      weight: 2
+    - name: Contact ↗
+      url: "https://github.com/imfing"
+      weight: 3
+    - name: Search
+      weight: 4
+      params:
+        type: search
+    - name: GitHub
+      weight: 5
+      url: "https://github.com/imfing/hextra-starter-template"
+      params:
+        icon: github
+    - name: Twitter
+      weight: 6
+      url: "https://twitter.com/"
+      params:
+        icon: x-twitter
+
+params:
+  navbar:
+    displayTitle: true
+    displayLogo: false
+
+  footer:
+    displayCopyright: false
+    displayPoweredBy: true
+
+  editURL:
+    enable: true
+    base: "https://github.com/imfing/hextra-starter-template/edit/main/content"
+
+ignoreFiles:
+  - "\\.rs$"
+  - "\\.rb$"

data/examples/static_assets_example.rb

@@ -0,0 +1,83 @@
+# Example of how to use the Static Assets middleware in Itsi.rb
+
+workers 1
+threads 1
+bind 'http://localhost:3000'
+
+# Example 1: Using the "alias" behavior (default)
+# With alias behavior, if you access /assets/image.png, it looks for the file at public/assets/image.png
+location '/assets' do
+  # Serve static files from the "public/assets" directory
+  static_assets root_dir: "public/assets",
+                # Default behavior is "alias" - the location pattern is stripped from the path
+                # root_is_prefix: false,  # This is the default, so we don't need to specify it
+                # Only allow certain file extensions
+                allowed_extensions: %w[css js jpg jpeg png gif svg ico woff woff2 ttf otf html],
+                # Return a 404 error if file is not found
+                not_found: 'error',
+                # Enable auto-indexing of directories
+                auto_index: true,
+                # Try adding .html extension to extensionless URLs
+                try_html_extension: true,
+                # Files under this size are cached in memory
+                max_file_size_in_memory: 1024 * 1024, # 1MB
+                # Maximum number of files to keep in memory cache
+                max_files_in_memory: 1000,
+                # Check for file modifications every 5 seconds
+                file_check_interval: 5,
+                # Add custom headers to all responses
+                headers: {
+                  'Cache-Control' => 'public, max-age=86400',
+                  'X-Content-Type-Options' => 'nosniff'
+                }
+end
+
+# Example 2: Using the "root" behavior
+# With root behavior, if you access /static/image.png, it looks for the file at public/static/image.png
+location '/static' do
+  # Serve static files from the "public" directory
+  static_assets root_dir: "public",
+                # Use "root" behavior - keep the location pattern as part of the path
+                root_is_prefix: true,
+                not_found: 'error',
+                auto_index: true
+end
+
+# Example 3: Serving a Single Page Application (SPA)
+location '/app' do
+  static_assets root_dir: "public/app",
+                # If file is not found, serve index.html (typical SPA behavior)
+                not_found: "index", # equivalent to not_found: { index: "index.html" }
+                headers: {
+                  'Cache-Control' => 'public, max-age=3600'
+                }
+end
+
+# Example 4: Using file_server as an alias for static_assets
+location '/public' do
+  file_server root_dir: "public",
+              auto_index: true,
+              not_found: "fallthrough"
+end
+
+# Example of a restricted files area
+location '/downloads' do
+  # Basic authentication before serving files
+  auth_basic realm: 'Downloads Area', credential_pairs: { 'user' => 'password' }
+
+  # Serve files after authentication
+  static_assets root_dir: 'private/downloads',
+                # Only allow PDF files
+                allowed_extensions: ['pdf'],
+                # If file is not found, fall through to the next middleware
+                not_found: 'fallthrough'
+end
+
+# Example of redirecting to another location if file is not found
+location '/docs' do
+  static_assets root_dir: 'documentation',
+                # Redirect to documentation homepage if file not found
+                not_found: 'redirect', # equivalent to not_found: { redirect: "/docs/index.html" }
+                # Don't cache these files in memory
+                max_file_size_in_memory: 0
+end

data/gems/_index.md

@@ -0,0 +1,18 @@
+---
+title: Gems
+next: first-page
+---
+
+Gems
+
+## Hello, World!
+
+```go {filename="main.go"}
+package main
+
+import "fmt"
+
+func main() {
+    fmt.Println("Hello, World!")
+}
+```

data/gems/scheduler/CODE_OF_CONDUCT.md

@@ -1,3 +1,10 @@
+---
+title: Code of Conduct
+type: docs
+next: docs/
+prev: docs/folder/
+---
+
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge