fixed missing puma details for docs, use start event

Author: ndbroadbent

lib/log_struct/enums/event.rb

@@ -40,12 +40,8 @@ class Event < T::Enum
       Restore = new(:restore)
 
       # Server lifecycle (e.g., Puma)
-      Boot = new(:boot)
-      Started = new(:started)
-      Listening = new(:listening)
+      # Start already defined above
       Shutdown = new(:shutdown)
-      Goodbye = new(:goodbye)
-      Exiting = new(:exiting)
 
       # Security events
       IPSpoof = new(:ip_spoof)

lib/log_struct/integrations/puma.rb

@@ -299,7 +299,7 @@ def emit_boot_if_needed!
         sig { void }
         def emit_started!
           si = T.cast(STATE[:start_info], T::Hash[Symbol, T.untyped])
-          log = Log::Puma::Started.new(
+          log = Log::Puma::Start.new(
             mode: T.cast(si[:mode], T.nilable(String)),
             puma_version: T.cast(si[:puma_version], T.nilable(String)),
             puma_codename: T.cast(si[:puma_codename], T.nilable(String)),

lib/log_struct/log/puma.rb

@@ -6,6 +6,5 @@
 # Schemas dir: schemas/log_sources/
 # Template: tools/codegen/templates/sorbet/source_parent.rb.erb
 
-require_relative "puma/boot"
-require_relative "puma/started"
+require_relative "puma/start"
 require_relative "puma/shutdown"

lib/log_struct/log/puma/boot.rb

@@ -20,7 +20,7 @@
 module LogStruct
   module Log
     class Puma
-      class Started < T::Struct
+      class Start < T::Struct
         # typed: strict
         # frozen_string_literal: true
 
@@ -30,7 +30,7 @@ class Started < T::Struct
 
         # Shared/common fields
         const :source, Source::Puma, default: Source::Puma
-        const :event, Event, default: Event::Started
+        const :event, Event, default: Event::Start
         const :timestamp, Time, factory: -> { Time.now }
         const :level, Level, default: Level::Info
 

lib/log_struct/log/puma/started.rb lib/log_struct/log/puma/start.rblib/log_struct/log/puma/started.rb renamed to lib/log_struct/log/puma/start.rb

@@ -73,7 +73,7 @@ class Railtie < ::Rails::Railtie
             break
           end
         end
-        started = LogStruct::Log::Puma::Started.new(
+        started = LogStruct::Log::Puma::Start.new(
           mode: "single",
           environment: (defined?(::Rails) && ::Rails.respond_to?(:env)) ? ::Rails.env : nil,
           process_id: Process.pid,

lib/log_struct/railtie.rb

@@ -74,22 +74,22 @@ def test_rails_server_emits_structured_puma_logs_and_on_exit
       end
       puma_logs = after_json.select { |h| h["src"] == "puma" }
 
-      # Expect exactly 2 structured logs: started, shutdown
+      # Expect exactly 2 structured logs: start, shutdown
       assert_equal 2, puma_logs.length, "Expected exactly 2 Puma logs. Output: #{output}\nSTDERR: #{stderr.read}"
 
       events = puma_logs.map { |h| h["evt"] }
 
-      assert_equal ["started", "shutdown"], events, "Expected Puma events in order: started, shutdown"
+      assert_equal ["start", "shutdown"], events, "Expected Puma events in order: start, shutdown"
 
-      started = puma_logs[0]
+      start = puma_logs[0]
 
-      assert_equal "puma", started["src"]
-      assert_equal "info", started["lvl"]
-      assert_equal "single", started["mode"]
-      assert_equal "test", started["environment"]
-      assert_kind_of Integer, started["pid"]
-      assert_kind_of Array, started["listening_addresses"]
-      assert started["listening_addresses"].any? { |a| a.include?(":#{port}") }, "Expected listening address to include :#{port}"
+      assert_equal "puma", start["src"]
+      assert_equal "info", start["lvl"]
+      assert_equal "single", start["mode"]
+      assert_equal "test", start["environment"]
+      assert_kind_of Integer, start["pid"]
+      assert_kind_of Array, start["listening_addresses"]
+      assert start["listening_addresses"].any? { |a| a.include?(":#{port}") }, "Expected listening address to include :#{port}"
 
       shutdown = puma_logs[1]
 

rails_test_app/templates/test/integration/puma_integration_test.rb

@@ -5,11 +5,7 @@ snake_case: puma
 additional_data: true
 
 events:
-  Boot:
-    fields:
-      ProcessId: Integer
-
-  Started:
+  Start:
     default_required: false
     fields:
       Mode: String

schemas/log_sources/puma.yml

@@ -1,6 +1,6 @@
 'use client';
 
-import React from 'react';
+import React, { useId } from 'react';
 import { useFiltering } from '@/components/filtering-context';
 import { Tabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs';
 import { CodeBlock } from '@/components/code-block';
@@ -21,9 +21,11 @@ export function IntegrationExamples({
 }) {
   const { filtering, setFiltering } = useFiltering();
   const gen = new LogGenerator(12345, filtering);
+  const baseFilteringId = useId();
 
   if (events.length <= 1) {
     const only = events[0];
+    const inputId = `${baseFilteringId}-filter`;
     return (
       <div className="relative">
         <CodeBlock language="json">
@@ -35,11 +37,14 @@ export function IntegrationExamples({
           )}
         </CodeBlock>
         <div className="absolute bottom-2 right-3 text-xs text-neutral-500 dark:text-neutral-400 flex items-center gap-2 bg-white/60 dark:bg-neutral-900/60 px-2 py-1 rounded">
-          <label className="cursor-pointer select-none">Apply filtering</label>
+          <label className="cursor-pointer select-none" htmlFor={inputId}>
+            Apply filtering
+          </label>
           <input
             aria-label="Apply filtering"
             type="checkbox"
             className="cursor-pointer"
+            id={inputId}
             checked={filtering}
             onChange={(e) => setFiltering(e.target.checked)}
           />
@@ -62,32 +67,43 @@ export function IntegrationExamples({
             </TabsTrigger>
           ))}
         </TabsList>
-        {events.map((evt) => (
-          <TabsContent key={String(evt)} value={String(evt)} className="mt-0.5">
-            <div className="relative">
-              <CodeBlock language="json">
-                {formatLog(
-                  gen.generateLogWithOptions(logType, {
-                    preferredEvent: evt,
-                    filtering,
-                  }),
-                )}
-              </CodeBlock>
-              <div className="absolute bottom-2 right-3 text-xs text-neutral-500 dark:text-neutral-400 flex items-center gap-2 bg-white/60 dark:bg-neutral-900/60 px-2 py-1 rounded">
-                <label className="cursor-pointer select-none">
-                  Apply filtering
-                </label>
-                <input
-                  aria-label="Apply filtering"
-                  type="checkbox"
-                  className="cursor-pointer"
-                  checked={filtering}
-                  onChange={(e) => setFiltering(e.target.checked)}
-                />
+        {events.map((evt) => {
+          const inputId = `${baseFilteringId}-${String(evt)}`;
+          return (
+            <TabsContent
+              key={String(evt)}
+              value={String(evt)}
+              className="mt-0.5"
+            >
+              <div className="relative">
+                <CodeBlock language="json">
+                  {formatLog(
+                    gen.generateLogWithOptions(logType, {
+                      preferredEvent: evt,
+                      filtering,
+                    }),
+                  )}
+                </CodeBlock>
+                <div className="absolute bottom-2 right-3 text-xs text-neutral-500 dark:text-neutral-400 flex items-center gap-2 bg-white/60 dark:bg-neutral-900/60 px-2 py-1 rounded">
+                  <label
+                    className="cursor-pointer select-none"
+                    htmlFor={inputId}
+                  >
+                    Apply filtering
+                  </label>
+                  <input
+                    aria-label="Apply filtering"
+                    type="checkbox"
+                    className="cursor-pointer"
+                    id={inputId}
+                    checked={filtering}
+                    onChange={(e) => setFiltering(e.target.checked)}
+                  />
+                </div>
               </div>
-            </div>
-          </TabsContent>
-        ))}
+            </TabsContent>
+          );
+        })}
       </Tabs>
     </div>
   );

site/components/integration-examples.tsx

@@ -40,7 +40,8 @@ describe('Log Structure Descriptions', () => {
   it('getLogStructureDescription throws an error for unknown structures', () => {
     // Test with an unknown structure
     expect(() => getLogStructureDescription('NonExistentStructure')).toThrow(
-      'No description found for log structure: NonExistentStructure',
+      'No description found for log structure: NonExistentStructure. ' +
+        'Add it to lib/log-structure-descriptions.ts',
     );
   });
 });