Refactor second experiment to use outbound beacon to conclude experimentation

TODO: the javascript for the event listener needs a bit more refinement in terms of the data collection it performs - there may not need to be any additional data in the payload, because the controller just needs to be called - no parameters are passed.

Author: matt-bernhardt

app/controllers/beacon_controller.rb

@@ -0,0 +1,6 @@
+class BeaconController < ApplicationController
+  def outbound
+    ab_finished(:result_format)
+    head :ok
+  end
+end

app/controllers/record_controller.rb

@@ -3,19 +3,6 @@ class RecordController < ApplicationController
 
   include RecordHelper
 
-  # The out method is used for concluding A/B testing experiments that rely on the user following outbound links.
-  #
-  # @param url String a URL where the URL will be redirected
-  def out
-    if params[:url].present?
-      ab_finished(:result_format)
-
-      redirect_to params[:url], allow_other_host: true
-    else
-      redirect_to '/'
-    end
-  end
-
   def view
     id = params[:id]
     index = ENV.fetch('TIMDEX_INDEX', nil)

app/helpers/search_helper.rb

@@ -18,7 +18,6 @@ def format_highlight_label(field_name)
 
   def link_to_result(result)
     if result[:source_link].present?
-      Rails.logger.debug(outbound_path(url: result[:source_link]))
       link_to(result[:title], result[:source_link])
     else
       result[:title]

app/javascript/application.js

@@ -2,6 +2,7 @@
 import "@hotwired/turbo-rails"
 import "controllers"
 import "loading_spinner"
+import "outbound_beacon"
 
 // Show the progress bar after 200 milliseconds, not the default 500
 Turbo.config.drive.progressBarDelay = 200;

app/javascript/outbound_beacon.js

@@ -0,0 +1,15 @@
+const resultsContainer = document.querySelector('.results-list');
+
+if (resultsContainer) {
+  resultsContainer.addEventListener('click', (event) => {
+    const link = event.target.closest('a');
+
+    // Discard clicks that aren't on links
+    if (!link || !resultsContainer.contains(link)) return;
+
+    const data = new FormData();
+    data.append('experiment', 'result_format');
+    console.log(data);
+    navigator.sendBeacon('/beacon', data);
+  });
+}

app/views/record/out.html.erb

@@ -58,6 +58,9 @@
 
     <% if Feature.enabled?(:record_link) %>
       <div class="result-get">
+        <% if @fulfillment == 'link' %>
+          <%= link_to 'View full record', 'https://example.org', class: 'button' %>
+        <% end %>
         <%= view_record(result) %>
       </div>
     <% end %>

app/views/search/_result.html.erb

@@ -6,7 +6,6 @@
     <h3 class="record-title">
       <span class="sr">Title: </span>
       <% if result[:links]&.find { |link| link['kind'] == 'full record' } %>
-        <% Rails.logger.debug(outbound_path(url: result[:links].find { |link| link['kind'] == 'full record' }['url'])) %>
         <%= link_to(result[:title], result[:links].find { |link| link['kind'] == 'full record' }['url']) %>
       <% else %>
         <%= result[:title] %>
@@ -60,6 +59,9 @@
     </div>
 
     <div class="result-get">
+      <% if @fulfillment == 'link' %>
+        <%= link_to 'View full record', 'https://example.org', class: 'button' %>
+      <% end %>
       <% if result[:links].present? %>
         <% result[:links].each do |link| %>
           <% if link['kind'].downcase == 'full record' %>

app/views/search/_result_primo.html.erb

@@ -2,6 +2,7 @@
 
 pin "application", preload: true
 pin "loading_spinner", preload: true
+pin "outbound_beacon", preload: true
 pin "@hotwired/turbo-rails", to: "turbo.min.js", preload: true
 pin "@hotwired/stimulus", to: "stimulus.min.js", preload: true
 pin "@hotwired/stimulus-loading", to: "stimulus-loading.js", preload: true

config/importmap.rb

@@ -5,8 +5,6 @@
 
   get 'lookup', to: 'libkey#lookup'
 
-  get 'out', to: 'record#out', as: "outbound"
-  
   get 'record/(:id)',
       to: 'record#view',
       as: 'record',
@@ -18,5 +16,7 @@
 
   mount Split::Dashboard, at: 'split'
 
+  post 'beacon', to: 'beacon#outbound'
+
   get 'robots.txt', to: 'robots#robots'
 end