Make JA4s have names + drop unused index (#1453)

* Make JA4s have names + drop unused index

* Update Swagger specs

Author: skyfallwastaken

app/controllers/concerns/api/admin/v1/user_utilities.rb

@@ -307,7 +307,7 @@ def user_heartbeats
           total_count = query.count
           source_types = Heartbeat.source_types.invert
           rows = query.order(time: :asc).limit(limit).offset(offset).pluck(*HEARTBEAT_RESPONSE_COLUMNS)
-          ja4s_by_id = Ja4.where(id: rows.filter_map(&:last).uniq).pluck(:id, :fingerprint).to_h
+          ja4s_by_id = Ja4.where(id: rows.filter_map(&:last).uniq).index_by(&:id)
           heartbeats = rows.map do |id, time, lineno, cursorpos, is_write, project, language, entity, branch, category, editor, machine, user_agent, ip_address, lines, source_type, ja4_id|
             {
               id: id,
@@ -324,7 +324,7 @@ def user_heartbeats
               machine: machine,
               user_agent: user_agent,
               ip_address: ip_address,
-              ja4: ja4s_by_id[ja4_id],
+              ja4: ja4s_by_id[ja4_id]&.then { |ja4| { fingerprint: ja4.fingerprint, name: ja4.name } },
               lines: lines,
               source_type: source_types[source_type] || source_type
             }

db/migrate/20260619131952_add_name_to_ja4s.rb

@@ -0,0 +1,5 @@
+class AddNameToJa4s < ActiveRecord::Migration[8.1]
+  def change
+    add_column :ja4s, :name, :text, if_not_exists: true
+  end
+end

db/migrate/20260620232900_drop_unused_heartbeat_indexes.rb

@@ -0,0 +1,29 @@
+class DropUnusedHeartbeatIndexes < ActiveRecord::Migration[8.1]
+  disable_ddl_transaction!
+
+  def up
+    remove_index :heartbeats,
+      name: :index_heartbeats_on_time_imported,
+      algorithm: :concurrently,
+      if_exists: true
+
+    remove_index :heartbeats,
+      name: :index_heartbeats_on_last_language_user_id,
+      algorithm: :concurrently,
+      if_exists: true
+  end
+
+  def down
+    add_index :heartbeats, :time,
+      name: :index_heartbeats_on_time_imported,
+      where: "source_type != 0",
+      algorithm: :concurrently,
+      if_not_exists: true
+
+    add_index :heartbeats, :user_id,
+      name: :index_heartbeats_on_last_language_user_id,
+      where: "language = '<<LAST_LANGUAGE>>'",
+      algorithm: :concurrently,
+      if_not_exists: true
+  end
+end

db/schema.rb

@@ -177,7 +177,14 @@
                   machine: { type: :string, nullable: true, example: 'Orpheus-MacBook-Pro' },
                   user_agent: { type: :string, nullable: true, example: 'wakatime/v1.115.2 (darwin-24.6.0) go1.23 vscode/1.96.0' },
                   ip_address: { type: :string, nullable: true, example: '203.0.113.7' },
-                  ja4: { type: :string, nullable: true, example: 't13d1516h2_8daaf6152771_02713d6af862' },
+                  ja4: {
+                    type: :object,
+                    nullable: true,
+                    properties: {
+                      fingerprint: { type: :string, example: 't13d1516h2_8daaf6152771_02713d6af862' },
+                      name: { type: :string, nullable: true, example: 'Go net/http' }
+                    }
+                  },
                   lines: { type: :integer, nullable: true, example: 350 },
                   source_type: { type: :string, example: 'direct_entry' }
                 }
@@ -195,7 +202,7 @@
             entity: 'app/models/user.rb',
             time: Time.current.to_f,
             source_type: :direct_entry,
-            ja4: Ja4.create!(fingerprint: 't13d1516h2_8daaf6152771_02713d6af862')
+            ja4: Ja4.create!(fingerprint: 't13d1516h2_8daaf6152771_02713d6af862', name: 'Go net/http')
           )
           u
         end
@@ -210,7 +217,10 @@
         let(:limit) { 10 }
         let(:offset) { 0 }
         run_test! do |response|
-          expect(JSON.parse(response.body).dig('heartbeats', 0, 'ja4')).to eq('t13d1516h2_8daaf6152771_02713d6af862')
+          expect(JSON.parse(response.body).dig('heartbeats', 0, 'ja4')).to eq(
+            'fingerprint' => 't13d1516h2_8daaf6152771_02713d6af862',
+            'name' => 'Go net/http'
+          )
         end
       end
 

spec/requests/api/admin/v1/admin_user_utils_spec.rb

@@ -1850,9 +1850,16 @@ paths:
                           nullable: true
                           example: 203.0.113.7
                         ja4:
-                          type: string
+                          type: object
                           nullable: true
-                          example: t13d1516h2_8daaf6152771_02713d6af862
+                          properties:
+                            fingerprint:
+                              type: string
+                              example: t13d1516h2_8daaf6152771_02713d6af862
+                            name:
+                              type: string
+                              nullable: true
+                              example: Go net/http
                         lines:
                           type: integer
                           nullable: true

swagger/admin/swagger.yaml

@@ -0,0 +1,31 @@
+require "test_helper"
+
+class Api::Admin::V1::AdminControllerTest < ActionDispatch::IntegrationTest
+  test "user heartbeats returns ja4 fingerprint and name" do
+    admin = User.create!(timezone: "UTC", admin_level: :superadmin)
+    key = admin.admin_api_keys.create!(name: "test")
+    user = User.create!(timezone: "UTC", username: "admin_heartbeats_ja4")
+    ja4 = Ja4.create!(fingerprint: "t13d1312h2_f57a46bbacb6_ab7e3b40a677", name: "Go net/http")
+
+    user.heartbeats.create!(
+      time: Time.current.to_i,
+      project: "test-project",
+      entity: "test.rb",
+      source_type: :direct_entry,
+      ja4: ja4
+    )
+
+    get "/api/admin/v1/user/heartbeats", params: { user_id: user.id }, headers: auth_headers(key)
+
+    assert_response :success
+    response_ja4 = response.parsed_body.fetch("heartbeats").first.fetch("ja4")
+    assert_equal "t13d1312h2_f57a46bbacb6_ab7e3b40a677", response_ja4.fetch("fingerprint")
+    assert_equal "Go net/http", response_ja4.fetch("name")
+  end
+
+  private
+
+  def auth_headers(key)
+    { "Authorization" => ActionController::HttpAuthentication::Token.encode_credentials(key.token) }
+  end
+end