cronwatch 0.9.0 → 0.11.0

data/lib/cronwatch/web/html.rb

@@ -21,6 +21,8 @@ module Cronwatch
     # Motion is CSS only and says something: marks arrive in time order, the
     # now line drops in last, and open problems (a missed slot, a running bar)
     # breathe slowly. prefers-reduced-motion turns all of it off.
+    #
+    # @api private
     module HTML
       CSS = "\n" + <<~'CSS'
         :root{color-scheme:light dark;--paper:#f4f4f5;--sheet:#fff;--sunk:#fafafa;--rule:#e4e4e7;--rule-2:#d4d4d8;--tick:#909098;--ink:#000;--body:#18181b;--muted:#71717a;--ok:#15803d;--warn:#a16207;--bad:#b91c1c;--serif:"Newsreader",ui-serif,Georgia,Cambria,"Times New Roman",serif;--mono:"IBM Plex Mono",ui-monospace,SFMono-Regular,Menlo,Consolas,monospace;--who:200px}
@@ -242,7 +244,7 @@ module Cronwatch
 
       # Object.entries: integer-like keys first, ascending, then the rest in insertion order.
       def entries(hash)
-        return [] if hash.nil?
+        return [] unless hash.is_a?(Hash)
 
         JS.object_keys(hash).map { |k| [k.to_s, hash[k]] }
       end
@@ -456,7 +458,8 @@ module Cronwatch
             truthy?(run.error) ? %(<details class="out error" open><summary>error</summary><pre>#{h(run.error)}</pre></details>) : "",
             truthy?(run.output) ? %(<details class="out"#{run.status.to_s == "ok" ? "" : " open"}><summary>output</summary><pre>#{h(run.output)}</pre></details>) : "",
           ].join
-          metrics = entries(run.metrics).map do |k, v|
+          # A foreign row may hold a metric that is no finite number (null, text); it is left out.
+          metrics = entries(run.metrics).select { |_, v| v.is_a?(Numeric) && v.real? && JS.finite?(v) }.map do |k, v|
             %(<span><span class="k">#{h(k)}</span> #{h(JS.integer?(v) ? v : to_fixed(v, 4))}</span>)
           end.join
           took = run.duration_ms.nil? ? %(<span class="muted">running</span>) : h(Duration.format(run.duration_ms))
@@ -563,13 +566,14 @@ module Cronwatch
         layout("#{job.name}: CronWatch", body, base, refresh: 60)
       end
 
-      # A page with one message. With `sign_in`, a form under it takes the
-      # token and sends it as ?token=, which the app moves into the cookie:
+      # A page with one message. With `sign_in`, a form under it posts the
+      # token to <base>/signin in the body, keeping it out of the URL and
+      # access logs, and the app sets the cookie:
       # the way in where there is no address bar to open a link with, such as
       # an app on an iPhone's home screen, which keeps its cookies apart from
       # Safari's.
       def message_page(title, message, base, sign_in: false)
-        form = sign_in ? %(<form class="signin" method="get" action="#{h(base)}/"><label for="token">Token</label><input id="token" name="token" type="password" autocomplete="current-password" autocapitalize="off" spellcheck="false" required><button class="primary" type="submit">Sign in</button></form>) : ""
+        form = sign_in ? %(<form class="signin" method="post" action="#{h(base)}/signin"><label for="token">Token</label><input id="token" name="token" type="password" autocomplete="current-password" autocapitalize="off" spellcheck="false" required><button class="primary" type="submit">Sign in</button></form>) : ""
         layout(title, %(<header class="top">#{brand(base)}</header><main class="message"><h1>#{h(title)}</h1><p>#{h(message)}</p>#{form}</main>), base)
       end
     end

data/lib/cronwatch/web/origin.rb

@@ -10,6 +10,8 @@ module Cronwatch
     # ignored, the host is lowercased (percent escapes decoded, IPv4 numbers
     # written out, IPv6 compressed, a non-ASCII host converted to punycode)
     # and a default port is left out. A port outside 1 to 65535 is refused.
+    #
+    # @api private
     module Origin
       ABSOLUTE = "routes: origin must be an absolute URL such as \"https://app.example.com\", got %s"
       FORBIDDEN_HOST = /[\x00-\x20#%\/:<>?@\[\\\]^|\x7F]/

data/lib/cronwatch/web/pwa.rb

@@ -7,6 +7,8 @@ module Cronwatch
     # that registers it and a page to show offline. None of it says anything
     # about the jobs, so it is served without the token (a browser fetches the
     # manifest and icons without cookies in some flows).
+    #
+    # @api private
     module PWA
       # The page colours the app's window takes: the paper behind the sheet,
       # and the sheet the header sits on.

data/lib/cronwatch/web/timeline.rb

@@ -15,6 +15,8 @@ module Cronwatch
     # open, and a visually hidden list says the same things in words.
     #
     # Every time is UTC: without script the page cannot know the viewer's zone.
+    #
+    # @api private
     module Timeline
       HOUR = 3_600_000
       DAY = 24 * HOUR

data/lib/cronwatch/web.rb

@@ -3,8 +3,7 @@
 # The dashboard and JSON API, as a Rack app. Needs the rack gem; the Rails
 # integration loads this file itself.
 #
-#   require "cronwatch/web"
-#   run Cronwatch::Web.new(CW)
+#   run CW.routes # Client#routes requires this file itself
 begin
   require "rack"
 rescue LoadError => e

data/lib/cronwatch/zone.rb

@@ -5,6 +5,8 @@ require "fugit"
 module Cronwatch
   # IANA zones through TZInfo (which Fugit brings, by way of et-orbi), or the
   # process's own zone when none is named, as JavaScript's Date does.
+  #
+  # @api private
   module Zone
     @zones = {}
     @names = nil

data/lib/cronwatch.rb

@@ -4,6 +4,7 @@ require "json"
 
 require_relative "cronwatch/version"
 require_relative "cronwatch/js"
+require_relative "cronwatch/deprecation"
 require_relative "cronwatch/types"
 require_relative "cronwatch/duration"
 require_relative "cronwatch/stats"
@@ -49,6 +50,7 @@ module Cronwatch
   # The options Cronwatch.configure sets. Anything left unset takes the client's default.
   class Configuration
     OPTIONS = %i[store alerts triage cron_secret retention defaults redact deliver now on_error sources].freeze
+    private_constant :OPTIONS
 
     attr_accessor(*OPTIONS)
 

data/lib/generators/cronwatch/install/install_generator.rb

@@ -11,8 +11,11 @@ module Cronwatch
     # Writes a migration for the three tables the ActiveRecord store uses
     # (created with the SDK's own DDL, so a Node process can share them) and
     # config/initializers/cronwatch.rb, then prints how to schedule
-    # Cronwatch::CheckJob and mount the dashboard. The templates live in this
-    # file so the gem ships nothing but Ruby.
+    # Cronwatch::CheckJob and mount the dashboard. With --database, the
+    # migration goes to that database and app/models/cronwatch_record.rb, an
+    # abstract class connected to it, is the store's connection_class, so the
+    # store reads the tables where the migration made them. The templates
+    # live in this file so the gem ships nothing but Ruby.
     class InstallGenerator < ::Rails::Generators::Base
       include ::ActiveRecord::Generators::Migration
 
@@ -21,7 +24,10 @@ module Cronwatch
       class_option :prefix, type: :string, default: Cronwatch::Stores::ActiveRecord::DEFAULT_PREFIX,
                             desc: "Table name prefix: lowercase letters, digits and underscores"
       class_option :database, type: :string, aliases: %i[--db],
-                              desc: "The database for the migration, in an app with several"
+                              desc: "The database for the tables, in an app with several (from config/database.yml)"
+
+      # The abstract class --database writes, which the store connects through.
+      RECORD_CLASS = "CronwatchRecord"
 
       def check_prefix
         Cronwatch::Stores::ActiveRecord.table_prefix(options[:prefix])
@@ -41,6 +47,12 @@ module Cronwatch
         create_file File.join(dir, "#{number}_#{migration_name}.rb"), migration
       end
 
+      def create_connection_class
+        return unless database_name
+
+        create_file "app/models/cronwatch_record.rb", connection_class
+      end
+
       def create_initializer
         create_file "config/initializers/cronwatch.rb", initializer
       end
@@ -60,9 +72,33 @@ module Cronwatch
         "create_cronwatch_#{prefix.squeeze("_").delete_prefix("_").delete_suffix("_")}_tables"
       end
 
+      # The --database name, or nil.
+      def database_name
+        name = options[:database].to_s
+        name.empty? ? nil : name
+      end
+
       def store_args
         prefix = options[:prefix]
-        prefix == Cronwatch::Stores::ActiveRecord::DEFAULT_PREFIX ? "" : "(prefix: #{prefix.inspect})"
+        args = []
+        args << "prefix: #{prefix.inspect}" unless prefix == Cronwatch::Stores::ActiveRecord::DEFAULT_PREFIX
+        # Named, not referenced, so the initializer does not load an app class at boot.
+        args << "connection_class: #{RECORD_CLASS.inspect}" if database_name
+        args.empty? ? "" : "(#{args.join(", ")})"
+      end
+
+      def connection_class
+        <<~RUBY
+          # frozen_string_literal: true
+
+          # The #{database_name} database, where CronWatch keeps its tables. The store in
+          # config/initializers/cronwatch.rb connects through this class.
+          class #{RECORD_CLASS} < ActiveRecord::Base
+            self.abstract_class = true
+
+            connects_to database: { writing: :#{database_name} }
+          end
+        RUBY
       end
 
       def migration
@@ -102,7 +138,7 @@ module Cronwatch
           #
           # and run Cronwatch::CheckJob every few minutes to catch the runs that never happen.
           Cronwatch.configure do |c|
-            # Jobs, runs and alert state, in this app's database.
+            # Jobs, runs and alert state, in #{database_name ? "the #{database_name} database (see app/models/cronwatch_record.rb)" : "this app's database"}.
             c.store = Cronwatch::Stores::ActiveRecord.new#{store_args}
 
             # Where alerts go. With none set, they are written to standard error.
@@ -127,14 +163,22 @@ module Cronwatch
         RUBY
       end
 
+      # What the next steps say about --database after the migrate line, or "".
+      def database_step
+        return "" unless database_name
+
+        "\n\n   The store connects through #{RECORD_CLASS} (app/models/cronwatch_record.rb),\n   " \
+          "which connects_to the #{database_name} database named in config/database.yml."
+      end
+
       def next_steps
         <<~TEXT
 
           CronWatch is installed. Next:
 
-          1. Create the tables:
+          1. Create the tables#{database_name ? " in the #{database_name} database" : ""}:
 
-               bin/rails db:migrate
+               bin/rails db:migrate#{database_step}
 
           2. Monitor a job:
 
@@ -163,7 +207,7 @@ module Cronwatch
 
           4. Mount the dashboard in config/routes.rb:
 
-               mount Cronwatch::Web.new(Cronwatch.client) => "/cronwatch"
+               mount Cronwatch.client.routes => "/cronwatch"
 
              Outside development it needs CRONWATCH_TOKEN set to sign in. In
              development, without one, the server prints a sign-in link on

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronwatch
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Jon C. Phillips
@@ -57,6 +57,7 @@ files:
 - lib/cronwatch/alerts/webhook.rb
 - lib/cronwatch/client.rb
 - lib/cronwatch/cron_pattern.rb
+- lib/cronwatch/deprecation.rb
 - lib/cronwatch/duration.rb
 - lib/cronwatch/environment.rb
 - lib/cronwatch/evaluate.rb