discourse/spec/system/request_tracker_spec.rb

# frozen_string_literal: true

describe "Request tracking", type: :system do
  before do
    ApplicationRequest.enable
    CachedCounting.reset
    CachedCounting.enable
  end

  after do
    CachedCounting.reset
    ApplicationRequest.disable
    CachedCounting.disable
  end

  describe "pageviews" do
    it "tracks an anonymous visit correctly" 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_logged_in_total" => 0,
          "page_view_crawler_total" => 0,
        )
      end

      find(".nav-item_categories a").click

      try_until_success do
        CachedCounting.flush
        expect(ApplicationRequest.stats).to include(
          "page_view_anon_total" => 2,
          "page_view_anon_browser_total" => 2,
          "page_view_logged_in_total" => 0,
          "page_view_crawler_total" => 0,
        )
      end
    end

    it "tracks a crawler visit correctly" do
      # Can't change Selenium's user agent... so change site settings to make Discourse detect chrome as a crawler
      SiteSetting.crawler_user_agents += "|chrome"

      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" => 0,
          "page_view_crawler_total" => 1,
        )
      end
    end

    it "tracks a logged-in session correctly" do
      sign_in Fabricate(:user)

      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_crawler_total" => 0,
          "page_view_logged_in_browser_total" => 1,
        )
      end

      find(".nav-item_categories a").click

      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" => 2,
          "page_view_crawler_total" => 0,
          "page_view_logged_in_browser_total" => 2,
        )
      end
    end

    it "tracks normal error pages correctly" do
      SiteSetting.bootstrap_error_pages = false

      visit "/foobar"

      try_until_success do
        CachedCounting.flush

        # Does not count error as a pageview
        expect(ApplicationRequest.stats).to include(
          "http_4xx_total" => 1,
          "page_view_anon_total" => 0,
          "page_view_anon_browser_total" => 0,
          "page_view_logged_in_total" => 0,
          "page_view_crawler_total" => 0,
        )
      end

      click_logo

      try_until_success do
        CachedCounting.flush
        expect(ApplicationRequest.stats).to include(
          "http_4xx_total" => 1,
          "page_view_anon_total" => 1,
          "page_view_anon_browser_total" => 1,
          "page_view_logged_in_total" => 0,
          "page_view_crawler_total" => 0,
        )
      end
    end

    it "tracks non-ember pages correctly" do
      visit "/safe-mode"

      try_until_success do
        CachedCounting.flush

        # Does not count error as a pageview
        expect(ApplicationRequest.stats).to include(
          "page_view_anon_total" => 1,
          "page_view_anon_browser_total" => 1,
          "page_view_logged_in_total" => 0,
          "page_view_crawler_total" => 0,
        )
      end
    end

    it "tracks bootstrapped error pages correctly" do
      SiteSetting.bootstrap_error_pages = true

      visit "/foobar"

      try_until_success do
        CachedCounting.flush

        # Does not count error as a pageview
        expect(ApplicationRequest.stats).to include(
          "http_4xx_total" => 1,
          "page_view_anon_total" => 0,
          "page_view_anon_browser_total" => 0,
          "page_view_logged_in_total" => 0,
          "page_view_crawler_total" => 0,
        )
      end

      click_logo

      try_until_success do
        CachedCounting.flush
        expect(ApplicationRequest.stats).to include(
          "http_4xx_total" => 1,
          "page_view_anon_total" => 1,
          "page_view_anon_browser_total" => 1,
          "page_view_logged_in_total" => 0,
          "page_view_crawler_total" => 0,
        )
      end
    end

    it "tracks published pages correctly" do
      SiteSetting.enable_page_publishing = true
      page =
        Fabricate(:published_page, public: true, slug: "some-page", topic: Fabricate(:post).topic)

      visit "/pub/some-page"

      try_until_success do
        CachedCounting.flush

        # Does not count error as a pageview
        expect(ApplicationRequest.stats).to include(
          "page_view_anon_total" => 1,
          "page_view_anon_browser_total" => 1,
          "page_view_logged_in_total" => 0,
          "page_view_crawler_total" => 0,
        )
      end
    end
  end

  describe "topic views" do
    fab!(:current_user) { Fabricate(:user) }
    fab!(:topic)
    fab!(:post) { Fabricate(:post, topic: topic) }

    context "when logged in" do
      before { sign_in(current_user) }

      it "tracks user viewing a topic correctly with deferred tracking" do
        visit topic.url

        try_until_success do
          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
      end

      it "tracks user viewing a topic correctly with explicit tracking" do
        visit "/"

        find(".topic-list-item .raw-topic-link[data-topic-id='#{topic.id}']").click

        try_until_success do
          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
      end
    end

    context "when anonymous" do
      it "tracks an anonymous user viewing a topic correctly with deferred tracking" do
        visit topic.url

        try_until_success do
          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
      end

      it "tracks an anonymous user viewing a topic correctly with explicit tracking" do
        visit "/"

        find(".topic-list-item .raw-topic-link[data-topic-id='#{topic.id}']").click

        try_until_success do
          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
      end
    end
  end
end