Skip to content

A platform for community discussion. Free, open, simple.

FEATURE: beacon-based implementation for BPV (#38897)

Osama Sayegh27a843fa0f72
diff --git a/app/helpers/application_helper.rb b/app/helpers/application_helper.rb
index 5d4f3ee5579..e177b307ced 100644
--- a/app/helpers/application_helper.rb
+++ b/app/helpers/application_helper.rb
@@ -427,11 +427,18 @@ module ApplicationHelper
end
end
- def discourse_track_view_session_tag
- return if !SiteSetting.trigger_browser_pageview_events
- <<~HTML.html_safe
- <meta name="discourse-track-view-session-id" content="#{SecureRandom.base64(32)}">
- HTML
+ def discourse_pageview_tracking_meta_tags
+ if !SiteSetting.trigger_browser_pageview_events &&
+ !SiteSetting.use_beacon_for_browser_page_views
+ return ""
+ end
+
+ tags = +""
+ tags << tag.meta(name: "discourse-track-view-session-id", content: SecureRandom.base64(32))
+ if SiteSetting.use_beacon_for_browser_page_views
+ tags << tag.meta(name: "discourse-beacon-pageview-enabled", content: "true")
+ end
+ tags.html_safe
end
def gsub_emoji_to_unicode(str)
diff --git a/app/models/application_request.rb b/app/models/application_request.rb
index ba93f5a1913..9fd33152647 100644
--- a/app/models/application_request.rb
+++ b/app/models/application_request.rb
@@ -19,6 +19,10 @@ class ApplicationRequest < ActiveRecord::Base
page_view_anon_browser_mobile: 14,
page_view_logged_in_browser: 15,
page_view_logged_in_browser_mobile: 16,
+ page_view_anon_browser_beacon: 17,
+ page_view_anon_browser_mobile_beacon: 18,
+ page_view_logged_in_browser_beacon: 19,
+ page_view_logged_in_browser_mobile_beacon: 20,
}
include CachedCounting
diff --git a/app/queries/reports/list_query.rb b/app/queries/reports/list_query.rb
index 3f411b2ef63..03dd1d39416 100644
--- a/app/queries/reports/list_query.rb
+++ b/app/queries/reports/list_query.rb
@@ -102,7 +102,7 @@ module Reports
ApplicationRequest
.req_types
.keys
- .select { |r| r =~ /\Apage_view_/ && r !~ /mobile/ }
+ .select { |r| r =~ /\Apage_view_/ && r !~ /mobile/ && r !~ /beacon/ }
.map { |r| r + "_reqs" }
if !SiteSetting.use_legacy_pageviews
diff --git a/app/views/layouts/_head.html.erb b/app/views/layouts/_head.html.erb
index 280bc15a224..14e070e2c31 100644
--- a/app/views/layouts/_head.html.erb
+++ b/app/views/layouts/_head.html.erb
@@ -15,7 +15,7 @@
<% end %>
<%= canonical_link_tag %>
<%= render_sitelinks_search_tag %>
-<%= discourse_track_view_session_tag %>
+<%= discourse_pageview_tracking_meta_tags %>
<% if SiteSetting.google_site_verification_token.present? %>
<meta name="google-site-verification" content="<%= SiteSetting.google_site_verification_token %>">
<% end %>
diff --git a/config/site_settings.yml b/config/site_settings.yml
index ddaa1d24ff4..091fa0a1a9c 100644
--- a/config/site_settings.yml
+++ b/config/site_settings.yml
@@ -596,6 +596,10 @@ basic:
trigger_browser_pageview_events:
default: false
hidden: true
+ use_beacon_for_browser_page_views:
+ default: false
+ hidden: true
+ client: true
interface_color_selector:
client: true
enum: "InterfaceColorSelectorSetting"
diff --git a/frontend/discourse/app/initializers/rails-testing.js b/frontend/discourse/app/initializers/rails-testing.js
index 7aa68547381..fc301b76939 100644
--- a/frontend/discourse/app/initializers/rails-testing.js
+++ b/frontend/discourse/app/initializers/rails-testing.js
@@ -1,6 +1,7 @@
/* eslint-disable ember/no-jquery */
import { DEBUG } from "@glimmer/env";
import $ from "jquery";
+import { hasPendingBeaconRequests } from "discourse/lib/beacon-pageview";
import { isRailsTesting } from "discourse/lib/environment";
export default {
@@ -117,7 +118,11 @@ export default {
track();
const settled = () => {
- return pendingRequests.length === 0 && pendingDomEvents.length === 0;
+ return (
+ pendingRequests.length === 0 &&
+ pendingDomEvents.length === 0 &&
+ !hasPendingBeaconRequests()
+ );
};
const timeoutErrorMessage = (timeoutMs) => {
@@ -151,6 +156,10 @@ export default {
errorMessage += `\n Pending DOM events: ${pendingDOMEventsText.join(", ")}`;
}
+ if (hasPendingBeaconRequests()) {
+ errorMessage += `\n Pending beacon pageview requests`;
+ }
+
return errorMessage;
};
diff --git a/frontend/discourse/app/instance-initializers/page-tracking.js b/frontend/discourse/app/instance-initializers/page-tracking.js
index 0a1c7e30bce..e57f6e4b227 100644
--- a/frontend/discourse/app/instance-initializers/page-tracking.js
+++ b/frontend/discourse/app/instance-initializers/page-tracking.js
@@ -4,6 +4,7 @@ import {
trackNextAjaxAsPageview,
trackNextAjaxAsTopicView,
} from "discourse/lib/ajax";
+import { sendBeaconPageview } from "discourse/lib/beacon-pageview";
import {
googleTagManagerPageChanged,
resetPageTracking,
@@ -11,6 +12,8 @@ import {
} from "discourse/lib/page-tracker";
import { sendDeferredPageview } from "./message-bus";
+let _preNavigationUrl = null;
+
export default {
after: "inject-objects",
before: "message-bus",
@@ -28,6 +31,11 @@ export default {
const router = owner.lookup("router:main");
router.on("routeWillChange", this.handleRouteWillChange);
+ const siteSettings = owner.lookup("service:site-settings");
+ if (siteSettings.use_beacon_for_browser_page_views) {
+ router.on("routeDidChange", this.handleRouteDidChange);
+ }
+
let appEvents = owner.lookup("service:app-events");
let documentTitle = owner.lookup("service:document-title");
@@ -79,6 +87,39 @@ export default {
}
},
+ handleRouteDidChange(transition) {
+ if (
+ transition.isAborted ||
+ (transition.urlMethod === "replace" && transition.queryParamsOnly)
+ ) {
+ return;
+ }
+
+ const trackingSessionId = document.querySelector(
+ "meta[name=discourse-track-view-session-id]"
+ )?.content;
+ const referrerUrl = transition.from
+ ? _preNavigationUrl
+ : document.referrer.length
+ ? document.referrer
+ : null;
+
+ let topicId;
+ if (
+ transition.to.name === "topic.fromParamsNear" ||
+ transition.to.name === "topic.fromParams"
+ ) {
+ topicId = transition.to.parent.params.id;
+ }
+
+ sendBeaconPageview({
+ sessionId: trackingSessionId,
+ url: window.location.href,
+ referrer: referrerUrl,
+ topicId,
+ });
+ },
+
handleRouteWillChange(transition) {
// transition.from will be null on initial boot transition, which is already tracked as a pageview via the HTML request
if (!transition.from) {
@@ -116,6 +157,7 @@ export default {
trackingUrl = new URL(path, window.location.origin).href;
trackingReferrer = window.location.href;
}
+ _preNavigationUrl = window.location.href;
trackNextAjaxAsPageview(trackingSessionId, trackingUrl, trackingReferrer);
if (
diff --git a/frontend/discourse/app/lib/beacon-pageview.js b/frontend/discourse/app/lib/beacon-pageview.js
new file mode 100644
index 00000000000..92d72965dbc
--- /dev/null
+++ b/frontend/discourse/app/lib/beacon-pageview.js
@@ -0,0 +1,26 @@
+import getURL from "discourse/lib/get-url";
+
+let _pendingBeaconRequests = 0;
+
+export function hasPendingBeaconRequests() {
+ return _pendingBeaconRequests > 0;
+}
+
+export function sendBeaconPageview({ sessionId, url, referrer, topicId }) {
+ const body = {
+ session_id: sessionId,
+ url,
+ referrer,
+ };
+ if (topicId) {
+ body.topic_id = topicId;
+ }
+
+ _pendingBeaconRequests++;
+ fetch(getURL("/srv/pv"), {
+ method: "POST",
+ keepalive: true,
+ headers: { "Content-Type": "application/json" },
+ body: JSON.stringify(body),
+ }).finally(() => _pendingBeaconRequests--);
+}
diff --git a/frontend/discourse/scripts/pageview.js b/frontend/discourse/scripts/pageview.js
index 408a2cc6476..16515d24374 100644
--- a/frontend/discourse/scripts/pageview.js
+++ b/frontend/discourse/scripts/pageview.js
@@ -11,6 +11,10 @@ document.addEventListener("DOMContentLoaded", function () {
"meta[name=discourse-track-view-session-id]"
)?.content;
+ const useBeacon =
+ document.querySelector("meta[name=discourse-beacon-pageview-enabled]")
+ ?.content === "true";
+
let headers = {
"Discourse-Track-View-Deferred": "true",
};
@@ -26,5 +30,19 @@ document.addEventListener("DOMContentLoaded", function () {
method: "POST",
headers,
});
+
+ if (useBeacon) {
+ const body = {
+ session_id: trackViewSessionId,
+ url: window.location.href,
+ referrer: document.referrer.length ? document.referrer : null,
+ };
+ fetch(`${root}/srv/pv`, {
+ method: "POST",
+ keepalive: true,
+ headers: { "Content-Type": "application/json" },
+ body: JSON.stringify(body),
+ });
+ }
}
});
diff --git a/lib/discourse.rb b/lib/discourse.rb
index 7950d36f848..a86ad608317 100644
--- a/lib/discourse.rb
+++ b/lib/discourse.rb
@@ -691,6 +691,10 @@ module Discourse
nil
end
+ def self.beacon_pv_tracking_path
+ "#{Discourse.base_path}/srv/pv"
+ end
+
class << self
alias_method :base_url_no_path, :base_url_no_prefix
end
diff --git a/lib/middleware/request_tracker.rb b/lib/middleware/request_tracker.rb
index 9893086e8e5..632355980b2 100644
--- a/lib/middleware/request_tracker.rb
+++ b/lib/middleware/request_tracker.rb
@@ -105,7 +105,7 @@ class Middleware::RequestTracker
end
end
- if data[:browser_page_view] && !data[:is_crawler]
+ if data[:browser_page_view] && !data[:is_crawler] && !data[:is_beacon]
if data[:has_auth_cookie]
ApplicationRequest.increment!(:page_view_logged_in_browser)
ApplicationRequest.increment!(:page_view_logged_in_browser_mobile) if data[:is_mobile]
@@ -131,6 +131,34 @@ class Middleware::RequestTracker
end
end
+ if data[:is_beacon] && !data[:is_crawler]
+ if data[:has_auth_cookie]
+ ApplicationRequest.increment!(:page_view_logged_in_browser_beacon)
+ if data[:is_mobile]
+ ApplicationRequest.increment!(:page_view_logged_in_browser_mobile_beacon)
+ end
+
+ trigger_beacon_browser_pageview_event(data)
+
+ if data[:topic_id].present? && data[:current_user_id].present?
+ TopicsController.defer_topic_view(
+ data[:topic_id],
+ data[:request_remote_ip],
+ data[:current_user_id],
+ )
+ end
+ elsif !SiteSetting.login_required
+ ApplicationRequest.increment!(:page_view_anon_browser_beacon)
+ ApplicationRequest.increment!(:page_view_anon_browser_mobile_beacon) if data[:is_mobile]
+
+ trigger_beacon_browser_pageview_event(data)
+
+ if data[:topic_id].present?
+ TopicsController.defer_topic_view(data[:topic_id], data[:request_remote_ip])
+ end
+ end
+ end
+
ApplicationRequest.increment!(:http_total)
status = data[:status]
@@ -313,6 +341,11 @@ class Middleware::RequestTracker
env["discourse.request_tracker"] = self
+ if self.class.is_beacon_tracking_request?(request)
+ result = [204, {}, []]
+ return result
+ end
+
MethodProfiler.start
if SiteSetting.instrument_gc_stat_per_request
@@ -518,6 +551,8 @@ class Middleware::RequestTracker
status ||= 200
headers ||= {}
+ return extract_beacon_view_tracking_data(env) if is_beacon_tracking_request?(request)
+
is_html_request = headers["Content-Type"]&.include?("text/html")
is_ajax_request = request.xhr?
@@ -578,6 +613,43 @@ class Middleware::RequestTracker
}
end
+ def self.is_beacon_tracking_request?(request)
+ SiteSetting.use_beacon_for_browser_page_views && request.post? &&
+ request.path == Discourse.beacon_pv_tracking_path
+ end
+
+ def self.extract_beacon_view_tracking_data(env)
+ body = env["rack.input"]&.read
+ env["rack.input"]&.rewind
+ data =
+ begin
+ JSON.parse(body)
+ rescue JSON::ParserError
+ {}
+ end
+
+ topic_id = data["topic_id"]&.to_i
+ tracking_url = data["url"]&.slice(0, MAX_URL_LENGTH)
+ tracking_referrer = data["referrer"]&.slice(0, MAX_URL_LENGTH)
+ tracking_session_id = data["session_id"]&.slice(0, MAX_SESSION_ID_LENGTH)
+ user_agent = env["HTTP_USER_AGENT"]&.slice(0, MAX_USER_AGENT_LENGTH)
+
+ {
+ track_view: false,
+ explicit_track_view: false,
+ deferred_track_view: true,
+ implicit_track_view: false,
+ browser_page_view: true,
+ is_beacon: true,
+ topic_id: topic_id,
+ tracking_url: tracking_url,
+ tracking_referrer: tracking_referrer,
+ tracking_session_id: tracking_session_id,
+ user_agent: user_agent,
+ }
+ end
+ private_class_method :extract_beacon_view_tracking_data
+
def self.trigger_browser_pageview_event(data)
if SiteSetting.trigger_browser_pageview_events
DiscourseEvent.trigger(:browser_pageview, build_browser_pageview_event_payload(data))
@@ -585,6 +657,13 @@ class Middleware::RequestTracker
end
private_class_method :trigger_browser_pageview_event
+ def self.trigger_beacon_browser_pageview_event(data)
+ if SiteSetting.trigger_browser_pageview_events
+ DiscourseEvent.trigger(:beacon_browser_pageview, build_browser_pageview_event_payload(data))
+ end
+ end
+ private_class_method :trigger_beacon_browser_pageview_event
+
def self.build_browser_pageview_event_payload(data)
{
user_id: data[:current_user_id],
diff --git a/spec/lib/middleware/request_tracker_spec.rb b/spec/lib/middleware/request_tracker_spec.rb
index c862a82a349..8cbf660f9b2 100644
--- a/spec/lib/middleware/request_tracker_spec.rb
+++ b/spec/lib/middleware/request_tracker_spec.rb
@@ -760,6 +760,128 @@ RSpec.describe Middleware::RequestTracker do
end
end
+ describe "beacon pageview tracking via /srv/pv" do
+ before do
+ SiteSetting.use_beacon_for_browser_page_views = true
+ freeze_time
+ ApplicationRequest.clear_cache!
+ end
+
+ def beacon_env(body_hash, extra = {})
+ json_body = JSON.generate(body_hash)
+ env(
+ {
+ :path => "/srv/pv",
+ "REQUEST_METHOD" => "POST",
+ "CONTENT_TYPE" => "application/json",
+ "rack.input" => StringIO.new(json_body),
+ }.merge(extra),
+ )
+ end
+
+ it "returns 204 and does not call the app" do
+ app_called = false
+ middleware =
+ Middleware::RequestTracker.new(
+ lambda do |env|
+ app_called = true
+ [200, {}, ["OK"]]
+ end,
+ )
+ status, = middleware.call(beacon_env({}))
+
+ expect(status).to eq(204)
+ expect(app_called).to eq(false)
+ end
+
+ it "returns 204 for beacon requests in a subfolder setup" do
+ set_subfolder "/forum"
+ middleware = Middleware::RequestTracker.new(lambda { |env| [200, {}, ["OK"]] })
+ status, = middleware.call(beacon_env({}, { path: "/forum/srv/pv" }))
+
+ expect(status).to eq(204)
+ end
+
+ it "handles malformed JSON body gracefully" do
+ middleware = Middleware::RequestTracker.new(lambda { |env| [200, {}, ["OK"]] })
+ status, =
+ middleware.call(
+ env(
+ :path => "/srv/pv",
+ "REQUEST_METHOD" => "POST",
+ "CONTENT_TYPE" => "application/json",
+ "rack.input" => StringIO.new("not json"),
+ ),
+ )
+
+ expect(status).to eq(204)
+ end
+
+ it "increments beacon-specific counters and fires beacon event with correct data" do
+ SiteSetting.trigger_browser_pageview_events = true
+ middleware = Middleware::RequestTracker.new(lambda { |env| [200, {}, ["OK"]] })
+
+ events =
+ DiscourseEvent.track_events(:beacon_browser_pageview) do
+ middleware.call(
+ beacon_env(
+ {
+ url: "https://test.com/t/topic/123",
+ referrer: "https://test.com/",
+ session_id: "abc123",
+ topic_id: 123,
+ },
+ ),
+ )
+ end
+
+ CachedCounting.flush
+
+ expect(ApplicationRequest.page_view_anon_browser_beacon.first.count).to eq(1)
+ expect(ApplicationRequest.page_view_anon.first).to be_nil
+ expect(ApplicationRequest.page_view_anon_browser.first).to be_nil
+
+ event = events[0][:params].last
+ expect(event[:url]).to eq("https://test.com/t/topic/123")
+ expect(event[:referrer]).to eq("https://test.com/")
+ expect(event[:session_id]).to eq("abc123")
+ expect(event[:topic_id]).to eq(123)
+ expect(event[:user_agent]).to eq(
+ "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36",
+ )
+ end
+
+ it "increments legacy and BPV counters from non-beacon requests" do
+ middleware = Middleware::RequestTracker.new(lambda { |env| [200, {}, ["OK"]] })
+ middleware.call(env("HTTP_DISCOURSE_TRACK_VIEW" => "1"))
+ CachedCounting.flush
+
+ expect(ApplicationRequest.page_view_anon.first.count).to eq(1)
+ expect(ApplicationRequest.page_view_anon_browser.first.count).to eq(1)
+
+ expect(ApplicationRequest.page_view_anon_browser_beacon.first).to be_nil
+ end
+
+ context "when SiteSetting.use_beacon_for_browser_page_views is false" do
+ before { SiteSetting.use_beacon_for_browser_page_views = false }
+
+ it "returns the app's response for beacon requests instead of 204" do
+ app_called = false
+ middleware =
+ Middleware::RequestTracker.new(
+ lambda do |env|
+ app_called = true
+ [404, {}, ["unknown app path"]]
+ end,
+ )
+ status, = middleware.call(beacon_env({}))
+
+ expect(status).to eq(404)
+ expect(app_called).to eq(true)
+ end
+ end
+ end
+
describe "rate limiting" do
let(:fake_logger) { FakeLogger.new }
diff --git a/spec/system/request_tracker_spec.rb b/spec/system/request_tracker_spec.rb
index 3ffc5f5e1c0..643a91a9b36 100644
--- a/spec/system/request_tracker_spec.rb
+++ b/spec/system/request_tracker_spec.rb
@@ -263,6 +263,176 @@ describe "Request tracking" do
expect(event[:referrer]).to be_blank
expect(event[:session_id]).to be_present
end
+
+ context "when use_beacon_for_browser_page_views is enabled" do
+ before { SiteSetting.use_beacon_for_browser_page_views = true }
+
+ it "tracks an anonymous visit correctly" do
+ all_events =
+ DiscourseEvent.track_events do
+ visit "/"
+ try_until_success do
+ CachedCounting.flush
+ expect(ApplicationRequest.stats).to include(
+ "page_view_anon_total" => 1,
+ "page_view_anon_browser_total" => 1,
+ "page_view_anon_browser_beacon_total" => 1,
+ "page_view_logged_in_total" => 0,
+ "page_view_crawler_total" => 0,
+ )
+ end
+ end
+
+ beacon_events = all_events.select { |e| e[:event_name] == :beacon_browser_pageview }
+ non_beacon_events = all_events.select { |e| e[:event_name] == :browser_pageview }
+
+ expect(beacon_events.size).to eq(1)
+ expect(non_beacon_events.size).to eq(1)
+
+ beacon_event = beacon_events[0][:params].last
+ non_beacon_event = non_beacon_events[0][:params].last
+
+ [beacon_event, non_beacon_event].each do |event|
+ expect(event[:user_id]).to be_nil
+ expect(event[:url]).to eq("#{Discourse.base_url_no_prefix}/")
+ expect(event[:ip_address]).to eq("::1")
+ expect(event[:referrer]).to be_blank
+ expect(event[:session_id]).to be_present
+ end
+
+ expect(beacon_event[:session_id]).to eq(non_beacon_event[:session_id])
+
+ all_events =
+ DiscourseEvent.track_events do
+ find(".nav-item_categories a").click
+
+ CachedCounting.flush
+ expect(ApplicationRequest.stats).to include(
+ "page_view_anon_total" => 2,
+ "page_view_anon_browser_total" => 2,
+ "page_view_anon_browser_beacon_total" => 2,
+ "page_view_logged_in_total" => 0,
+ "page_view_crawler_total" => 0,
+ )
+ end
+
+ beacon_events_2 = all_events.select { |e| e[:event_name] == :beacon_browser_pageview }
+ non_beacon_events_2 = all_events.select { |e| e[:event_name] == :browser_pageview }
+
+ expect(beacon_events_2.size).to eq(1)
+ expect(non_beacon_events_2.size).to eq(1)
+
+ beacon_event_2 = beacon_events_2[0][:params].last
+ non_beacon_event_2 = non_beacon_events_2[0][:params].last
+
+ [beacon_event_2, non_beacon_event_2].each do |event|
+ expect(event[:user_id]).to be_nil
+ expect(event[:url]).to eq("#{Discourse.base_url_no_prefix}/categories")
+ expect(event[:ip_address]).to eq("::1")
+ expect(event[:referrer]).to eq("#{Discourse.base_url}/")
+ expect(event[:session_id]).to eq(beacon_event[:session_id])
+ end
+ end
+
+ it "tracks a logged-in session correctly" do
+ user = Fabricate(:user)
+ sign_in user
+
+ all_events =
+ DiscourseEvent.track_events do
+ visit "/"
+
+ try_until_success do
+ CachedCounting.flush
+ expect(ApplicationRequest.stats).to include(
+ "page_view_anon_total" => 0,
+ "page_view_anon_browser_total" => 0,
+ "page_view_logged_in_total" => 1,
+ "page_view_logged_in_browser_total" => 1,
+ "page_view_logged_in_browser_beacon_total" => 1,
+ "page_view_crawler_total" => 0,
+ )
+ end
+ end
+
+ beacon_events = all_events.select { |e| e[:event_name] == :beacon_browser_pageview }
+ non_beacon_events = all_events.select { |e| e[:event_name] == :browser_pageview }
+
+ expect(beacon_events.size).to eq(1)
+ expect(non_beacon_events.size).to eq(1)
+
+ beacon_event = beacon_events[0][:params].last
+ non_beacon_event = non_beacon_events[0][:params].last
+
+ [beacon_event, non_beacon_event].each do |event|
+ expect(event[:user_id]).to eq(user.id)
+ expect(event[:url]).to eq("#{Discourse.base_url_no_prefix}/")
+ expect(event[:ip_address]).to eq("::1")
+ expect(event[:referrer]).to be_blank
+ expect(event[:session_id]).to be_present
+ expect(event[:topic_id]).to be_blank
+ end
+
+ expect(beacon_event[:session_id]).to eq(non_beacon_event[:session_id])
+
+ all_events =
+ DiscourseEvent.track_events do
+ find(".nav-item_categories a").click
+ CachedCounting.flush
+ expect(ApplicationRequest.stats).to include(
+ "page_view_anon_total" => 0,
+ "page_view_anon_browser_total" => 0,
+ "page_view_logged_in_total" => 2,
+ "page_view_logged_in_browser_total" => 2,
+ "page_view_logged_in_browser_beacon_total" => 2,
+ "page_view_crawler_total" => 0,
+ )
+ end
+
+ beacon_events_2 = all_events.select { |e| e[:event_name] == :beacon_browser_pageview }
+ non_beacon_events_2 = all_events.select { |e| e[:event_name] == :browser_pageview }
+
+ expect(beacon_events_2.size).to eq(1)
+ expect(non_beacon_events_2.size).to eq(1)
+
+ beacon_event_2 = beacon_events_2[0][:params].last
+ non_beacon_event_2 = non_beacon_events_2[0][:params].last
+
+ [beacon_event_2, non_beacon_event_2].each do |event|
+ expect(event[:user_id]).to eq(user.id)
+ expect(event[:url]).to eq("#{Discourse.base_url_no_prefix}/categories")
+ expect(event[:ip_address]).to eq("::1")
+ expect(event[:referrer]).to eq("#{Discourse.base_url}/")
+ expect(event[:session_id]).to eq(beacon_event[:session_id])
+ end
+ end
+
+ it "tracks a crawler visit correctly" do
+ SiteSetting.crawler_user_agents += "|chrome"
+
+ all_events =
+ DiscourseEvent.track_events do
+ visit "/"
+
+ try_until_success do
+ CachedCounting.flush
+ expect(ApplicationRequest.stats).to include(
+ "page_view_anon_total" => 0,
+ "page_view_anon_browser_total" => 0,
+ "page_view_anon_browser_beacon_total" => 0,
+ "page_view_logged_in_total" => 0,
+ "page_view_crawler_total" => 1,
+ )
+ end
+ end
+
+ beacon_events = all_events.select { |e| e[:event_name] == :beacon_browser_pageview }
+ non_beacon_events = all_events.select { |e| e[:event_name] == :browser_pageview }
+
+ expect(beacon_events).to be_blank
+ expect(non_beacon_events).to be_blank
+ end
+ end
end
describe "topic views" do
@@ -297,7 +467,7 @@ describe "Request tracking" do
event = events[0][:params].last
expect(event[:user_id]).to eq(current_user.id)
- expect(event[:url]).to eq("#{Discourse.base_url_no_prefix}/t/#{topic.slug}/#{topic.id}")
+ expect(event[:url]).to eq(topic.url)
expect(event[:ip_address]).to eq("::1")
expect(event[:referrer]).to be_blank
expect(event[:session_id]).to be_present
@@ -333,7 +503,7 @@ describe "Request tracking" do
expect(event).to be_present
expect(event[:user_id]).to eq(current_user.id)
- expect(event[:url]).to eq("#{Discourse.base_url_no_prefix}/t/#{topic.slug}/#{topic.id}")
+ expect(event[:url]).to eq(topic.url)
expect(event[:ip_address]).to eq("::1")
expect(event[:referrer]).to eq("#{Discourse.base_url_no_prefix}/")
expect(event[:session_id]).to be_present
@@ -363,7 +533,7 @@ describe "Request tracking" do
event = events[0][:params].last
expect(event[:user_id]).to be_blank
- expect(event[:url]).to eq("#{Discourse.base_url_no_prefix}/t/#{topic.slug}/#{topic.id}")
+ expect(event[:url]).to eq(topic.url)
expect(event[:ip_address]).to eq("::1")
expect(event[:referrer]).to be_blank
expect(event[:session_id]).to be_present
@@ -396,11 +566,112 @@ describe "Request tracking" do
expect(event).to be_present
expect(event[:user_id]).to be_blank
- expect(event[:url]).to eq("#{Discourse.base_url_no_prefix}/t/#{topic.slug}/#{topic.id}")
+ expect(event[:url]).to eq(topic.url)
expect(event[:ip_address]).to eq("::1")
- expect(event[:referrer]).to eq("#{Discourse.base_url_no_prefix}/")
+ expect(event[:referrer]).to eq("#{Discourse.base_url}/")
expect(event[:session_id]).to be_present
end
end
+
+ context "when use_beacon_for_browser_page_views is enabled" do
+ before { SiteSetting.use_beacon_for_browser_page_views = true }
+
+ context "when logged in" do
+ before { sign_in(current_user) }
+
+ it "tracks topic views correctly via beacon" do
+ visit "/"
+
+ all_events =
+ DiscourseEvent.track_events do
+ find(".topic-list-item .raw-topic-link[data-topic-id='#{topic.id}']").click
+
+ CachedCounting.flush
+ expect(TopicViewItem.exists?(topic_id: topic.id, user_id: current_user.id)).to eq(
+ true,
+ )
+ expect(
+ TopicViewStat.exists?(
+ topic_id: topic.id,
+ viewed_at: Time.zone.now.to_date,
+ anonymous_views: 0,
+ logged_in_views: 1,
+ ),
+ ).to eq(true)
+ end
+
+ beacon_event =
+ all_events
+ .select { |e| e[:event_name] == :beacon_browser_pageview }
+ .find { |e| e[:params].last[:topic_id] == topic.id }
+ &.dig(:params)
+ &.last
+ non_beacon_event =
+ all_events
+ .select { |e| e[:event_name] == :browser_pageview }
+ .find { |e| e[:params].last[:topic_id] == topic.id }
+ &.dig(:params)
+ &.last
+
+ expect(beacon_event).to be_present
+ expect(non_beacon_event).to be_present
+
+ [beacon_event, non_beacon_event].each do |event|
+ expect(event[:user_id]).to eq(current_user.id)
+ expect(event[:url]).to eq(topic.url)
+ expect(event[:ip_address]).to eq("::1")
+ expect(event[:referrer]).to eq("#{Discourse.base_url}/")
+ expect(event[:session_id]).to be_present
+ expect(event[:topic_id]).to eq(topic.id)
+ end
+ end
+ end
+
+ context "when anonymous" do
+ it "tracks topic views correctly via beacon" do
+ visit "/"
+
+ all_events =
+ DiscourseEvent.track_events do
+ find(".topic-list-item .raw-topic-link[data-topic-id='#{topic.id}']").click
+
+ CachedCounting.flush
+ expect(TopicViewItem.exists?(topic_id: topic.id, user_id: nil)).to eq(true)
+ expect(
+ TopicViewStat.exists?(
+ topic_id: topic.id,
+ viewed_at: Time.zone.now.to_date,
+ anonymous_views: 1,
+ logged_in_views: 0,
+ ),
+ ).to eq(true)
+ end
+
+ beacon_event =
+ all_events
+ .select { |e| e[:event_name] == :beacon_browser_pageview }
+ .find { |e| e[:params].last[:topic_id] == topic.id }
+ &.dig(:params)
+ &.last
+ non_beacon_event =
+ all_events
+ .select { |e| e[:event_name] == :browser_pageview }
+ .find { |e| e[:params].last[:topic_id] == topic.id }
+ &.dig(:params)
+ &.last
+
+ expect(beacon_event).to be_present
+ expect(non_beacon_event).to be_present
+
+ [beacon_event, non_beacon_event].each do |event|
+ expect(event[:user_id]).to be_blank
+ expect(event[:url]).to eq(topic.url)
+ expect(event[:ip_address]).to eq("::1")
+ expect(event[:referrer]).to eq("#{Discourse.base_url}/")
+ expect(event[:session_id]).to be_present
+ end
+ end
+ end
+ end
end
end