webhukhs 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cae5927b7426085a8e140f6bdb4565423d43d1b72c65b65c9602b72bd81a1338
-  data.tar.gz: e77b5321fbd8b814b3d6265da104ec9b4e77ffc36a2d0b0c62e67ae1c1f3ff05
+  metadata.gz: 99b94333e5ec2959d8096f909a5370fccc5b68b9388e0a7028584a5cb334d660
+  data.tar.gz: 85c0dfd6138967c9c9f0fca36666ed07f7a9b714a608c34b13ed725d73dff67f
 SHA512:
-  metadata.gz: 40519e7b2ca3b8c8e4bbf924f78d86269f6f4b68b1a72f3a7f963ec87fde656f49db69c6268de76f19b22ec762e3e14078c9839f44e080b41bc1e99131ecb449
-  data.tar.gz: 2a8e469254e9f76b46068a9b06001157f570f33a6cab931c2ee23cada3c13eadbff765c368cba58e6a62a1d657db8d142a2f89d2b8fe94b4034eb76f45cb4e6c
+  metadata.gz: 1ee87b2fb85e85a69493977d30cc21bbba0831d5b69973d560d4229260fdd7357a1a343c7da3634b503817827632e7f6ab8c1f5b92cd081030f11c68a8086053
+  data.tar.gz: e2820a7337b24bf51cc85e400889969f4744102c3ddc3948df9ae051d2baa96af6a8ae6ffad329cac90952f9d32362232ee2cd2a812dd7059fb04b9fabcb5ed1

data/AGENTS.md

@@ -32,12 +32,6 @@ Decide which bucket it falls into:
 Decide between A) and B) before changing anything. If unsure, ask
 the user.
 
-## What you may change
-
-- `lib/age.rb` -- the implementation. Multiple designs are valid.
-- `spec/age_spec.rb` -- the tests. Some existing tests are bad and
-  may be rewritten or replaced.
-
 ## Constraints
 
 - You may not skip mutants by configuring mutant to ignore them.

data/CHANGELOG.md

@@ -5,6 +5,11 @@ This format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 
 ## Unreleased
 
+## 0.8.1
+
+### Fixed
+- Sort the admin listing by ID by default to avoid a full-table sort.
+
 ## 0.8.0
 ## Added
 - An optional, read-only admin engine (`require "webhukhs/admin"`, mount `Webhukhs::Admin::Engine`) to list,

data/README.md

@@ -121,6 +121,14 @@ no build step.
 To try it out, run `bin/dev` from a checkout of this repository. It starts the app in `example`
 with some webhooks seeded, and the admin at http://localhost:3000/admin/webhukhs.
 
+The list defaults to descending ID order using the existing primary-key index; no extra migration is
+needed. Click **Received** to sort by timestamp instead.
+
+**We strongly recommend against UUIDv4 primary keys.** Use UUIDv7 or auto-incrementing integer IDs
+instead. UUIDv4 IDs are random, so sorting by ID does not reflect creation time, and inserts have
+poorer index locality. Webhukhs generates UUIDv7 when Ruby supports it, but falls back to UUIDv4
+otherwise; use a Ruby with UUIDv7 support if you need UUID primary keys.
+
 ## More Examples
 - `example` folder contains a demo app with the engine and the admin fully configured - run it with `bin/dev`.
 - We provide a number of webhook handlers which demonstrate certain features of Webhukhs. You will find them in `handler-examples`.

data/lib/webhukhs/admin/received_webhooks_controller.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
+# Public namespace for Webhukhs runtime and configuration.
 module Webhukhs
+  # Read-only administration for received webhooks.
   module Admin
     # Lists and shows stored webhooks. Read-only: the lifecycle belongs to Webhukhs::ProcessingJob.
     class ReceivedWebhooksController < ApplicationController
       # Webhooks per index page
       PAGE_SIZE = 50
-      # Columns the index can be sorted by
+      # Additional sortable columns beyond the default id order
       SORTABLE_COLUMNS = %w[created_at updated_at handler_module_name handler_event_id status].freeze
 
       helper_method :handler_options, :status_options
@@ -15,7 +17,7 @@ module Webhukhs
       #
       # @return [void]
       def index
-        @sort = params[:sort].presence_in(SORTABLE_COLUMNS) || "created_at"
+        @sort = params[:sort].presence_in(SORTABLE_COLUMNS) || "id"
         @direction = (params[:direction] == "asc") ? "asc" : "desc"
         @page = [params[:page].to_i, 1].max
 
@@ -25,7 +27,7 @@ module Webhukhs
         # to return them in a different order for every OFFSET - rows then repeat or vanish between pages
         rows = ReceivedWebhook
           .where(filters)
-          .order(@sort => @direction, :id => @direction)
+          .order(@sort => @direction, "id" => @direction)
           .offset((@page - 1) * PAGE_SIZE)
           .limit(PAGE_SIZE + 1)
         @next_page = @page + 1 if rows.length > PAGE_SIZE

data/lib/webhukhs/admin/views/webhukhs/admin/received_webhooks/index.html.erb

@@ -19,6 +19,7 @@
 
 <%
   columns = [
+    ["Id", "id"],
     ["Received", "created_at"],
     ["Handler", "handler_module_name"],
     ["Status", "status"],
@@ -28,7 +29,7 @@
 %>
 <div id="received-webhooks">
 <%# The id cell carries the link, and the CSS stretches it over the whole row %>
-<%= admin_table(["Id"] + columns, @webhooks) do |webhook|
+<%= admin_table(columns, @webhooks) do |webhook|
   [
     link_to(tag.code(webhook.id, class: "cell-ellipsis cell-id", title: webhook.id), received_webhook_path(webhook), class: "row-link"),
     time_tag(webhook.created_at, webhook.created_at.iso8601),

data/lib/webhukhs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Webhukhs
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end

data/test/admin_test.rb

@@ -23,21 +23,41 @@ class AdminTest < ActionDispatch::IntegrationTest
     css_select("table.admin-table tbody tr td:nth-child(5) code").map(&:text)
   end
 
-  test "lists webhooks newest first by default" do
-    create_webhook(handler_event_id: "old", created_at: 2.days.ago)
-    create_webhook(handler_event_id: "new", created_at: 1.day.ago)
+  test "lists webhooks by descending id regardless of received time by default" do
+    create_webhook(handler_event_id: "first", created_at: 1.day.ago)
+    create_webhook(handler_event_id: "last", created_at: 2.days.ago)
 
     get "/admin/received"
 
     assert_response :ok
-    assert_equal ["new", "old"], listed_event_ids
+    assert_equal ["last", "first"], listed_event_ids
     # The whole row is the link, so it has to be there in the first cell
     assert_select "tbody tr td:first-child a.row-link[href^='/admin/received/']", count: 2
-    assert_select "th a.sort-link[href=?]", "/admin/received?direction=asc&sort=created_at", text: "Received ▼"
+    assert_select "th a.sort-link[href=?]", "/admin/received?direction=asc&sort=id", text: "Id ▼"
+    assert_select "th a.sort-link[href=?]", "/admin/received?direction=desc&sort=created_at", text: "Received"
     assert_select "th a.sort-link span.sort-arrow", text: "▼", count: 1
     assert_select "th a.sort-link[href=?]", "/admin/received?direction=desc&sort=status", text: "Status"
   end
 
+  test "sorts by id in ascending order when requested" do
+    create_webhook(handler_event_id: "first", created_at: 1.day.ago)
+    create_webhook(handler_event_id: "last", created_at: 2.days.ago)
+
+    get "/admin/received", params: {sort: "id", direction: "asc"}
+
+    assert_equal ["first", "last"], listed_event_ids
+    assert_select "th a.sort-link[href=?]", "/admin/received?direction=desc&sort=id", text: "Id ▲"
+  end
+
+  test "still sorts by received time when explicitly requested" do
+    create_webhook(handler_event_id: "new", created_at: 1.day.ago)
+    create_webhook(handler_event_id: "old", created_at: 2.days.ago)
+
+    get "/admin/received", params: {sort: "created_at"}
+
+    assert_equal ["new", "old"], listed_event_ids
+  end
+
   test "offers an auto-refresh switch, off by default, for the listing it refetches" do
     create_webhook
 
@@ -85,15 +105,15 @@ class AdminTest < ActionDispatch::IntegrationTest
     assert_equal ["z", "a"], listed_event_ids
   end
 
-  test "ignores sort columns and directions it does not know" do
-    # Created out of order, so that falling back to anything but created_at shows
-    create_webhook(handler_event_id: "new", created_at: 1.day.ago, status: "skipped")
-    create_webhook(handler_event_id: "old", created_at: 2.days.ago, status: "error")
+  test "ignores unsupported sort columns and directions" do
+    # Creation order differs from received time, so the fallback must use id.
+    create_webhook(handler_event_id: "new", created_at: 1.day.ago, status: "skipped", body: "z")
+    create_webhook(handler_event_id: "old", created_at: 2.days.ago, status: "error", body: "a")
 
-    get "/admin/received", params: {sort: "no_such_column", direction: "sideways"}
+    get "/admin/received", params: {sort: "body", direction: "sideways"}
 
     assert_response :ok
-    assert_equal ["new", "old"], listed_event_ids
+    assert_equal ["old", "new"], listed_event_ids
   end
 
   test "filters by handler and status, and treats blank filters as no filter" do
@@ -119,7 +139,7 @@ class AdminTest < ActionDispatch::IntegrationTest
     assert_select "select[name=handler] option[value='']", text: "Any handler"
     assert_select "select[name=status] option[value='']", text: "Any status"
     # Clearing the filters keeps the sort
-    assert_select "form.filters a[href=?]", "/admin/received?direction=desc&sort=created_at", text: "Clear"
+    assert_select "form.filters a[href=?]", "/admin/received?direction=desc&sort=id", text: "Clear"
     assert_select "select[name=handler] option[selected]", text: "PrivateHandler"
 
     statuses = css_select("select[name=status] option").map { |option| option["value"] }

data/test/browser/admin_click_through.rb

@@ -94,6 +94,10 @@ class AdminClickThrough < ActiveSupport::TestCase
     # The stylesheet must have made it through the CSP - unstyled, the header would not be a flexbox
     assert_equal "flex", @browser.evaluate("getComputedStyle(document.querySelector('.admin-header')).display")
     assert_equal PAGE_SIZE, @browser.css("tbody tr").length
+    assert_equal "the-failed-one", texts("tbody tr td:nth-child(5)").first
+
+    click_and_wait_for_page(@browser.at_xpath("//th/a[contains(., 'Received')]"))
+    assert_includes @browser.current_url, "direction=desc"
     assert_equal "evt-0", texts("tbody tr td:nth-child(5)").first
 
     click_and_wait_for_page(@browser.at_xpath("//th/a[contains(., 'Received')]"))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webhukhs
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Stanislav Katkov
@@ -343,7 +343,6 @@ files:
 - handler-examples/revolut_business_v1_handler.rb
 - handler-examples/revolut_business_v2_handler.rb
 - handler-examples/starling_payments_handler.rb
-- lib/tasks/webhukhs_tasks.rake
 - lib/webhukhs.rb
 - lib/webhukhs/admin.rb
 - lib/webhukhs/admin/application_controller.rb

data/lib/tasks/webhukhs_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :munster do
-#   # Task goes here
-# end