a8b7f6eea4
* Use proper auth chain before checking parameters * Refactor AnalyticsController * Add a bunch of test and rewrite reactions counts with a single query * Add tests for follows totals * Use round and add more refactoring * Add tests to group by day to fallback during refactoring * Use group by to calculate comments count by day * Use group by to calculate follows count by day * Use group by to calculate reactions stats by day * Use group by to calculate page_views stats by day * Move calculations per day back in the cached block * Add a few comments and a little bit of refactoring * Add indexes (concurrently) for analytics * Make tests more time robust * Use a date range cache related to the requesting user or org * Freezing time in UTC should help when tests are ran on time zones over the day line * Remove explicit returns * Page title is escaped, guard against that * Move Analytics service spec in the proper place
362 lines
15 KiB
Ruby
362 lines
15 KiB
Ruby
require "rails_helper"
|
|
|
|
RSpec.describe AnalyticsService, type: :service do
|
|
let(:user) { create(:user) }
|
|
let(:organization) { create(:organization) }
|
|
let(:article) { create(:article, user: user, published: true) }
|
|
|
|
before { Timecop.freeze(Time.current.utc) }
|
|
|
|
after { Timecop.return }
|
|
|
|
describe "initialization" do
|
|
it "raises an error if start date is invalid" do
|
|
expect(-> { described_class.new(user, start_date: "2000-") }).to raise_error(ArgumentError)
|
|
end
|
|
|
|
it "raises an error if end date is invalid" do
|
|
expect(-> { described_class.new(user, end_date: "2000-") }).to raise_error(ArgumentError)
|
|
end
|
|
|
|
it "raises an error if an article does not belong to the user" do
|
|
other_user = create(:user)
|
|
article = create(:article, user: other_user)
|
|
expect(-> { described_class.new(user, article_id: article.id) }).to raise_error(ArgumentError)
|
|
end
|
|
end
|
|
|
|
describe "#totals" do
|
|
let(:analytics_service) { described_class.new(user) }
|
|
|
|
it "returns totals stats for comments, reactions, follows and page views" do
|
|
totals = analytics_service.totals
|
|
expect(totals.keys.to_set).to eq(%i[comments reactions follows page_views].to_set)
|
|
end
|
|
|
|
it "returns totals stats for an org" do
|
|
totals = described_class.new(organization).totals
|
|
expect(totals.keys.to_set).to eq(%i[comments reactions follows page_views].to_set)
|
|
end
|
|
|
|
describe "comments stats" do
|
|
it "returns stats" do
|
|
stats = analytics_service.totals[:comments]
|
|
expect(stats.keys).to eq(%i[total])
|
|
end
|
|
|
|
it "returns the total number of comments" do
|
|
create(:comment, commentable: article, score: 1)
|
|
expected_stats = { total: 1 }
|
|
expect(analytics_service.totals[:comments]).to eq(expected_stats)
|
|
end
|
|
|
|
it "returns zero as total if there are no scored comments" do
|
|
create(:comment, commentable: article, score: 0)
|
|
expected_stats = { total: 0 }
|
|
expect(analytics_service.totals[:comments]).to eq(expected_stats)
|
|
end
|
|
end
|
|
|
|
describe "reactions stats" do
|
|
before { Reaction.where(reactable: article).delete_all }
|
|
|
|
it "returns stats" do
|
|
stats = described_class.new(user).totals[:reactions]
|
|
expect(stats.keys).to eq(%i[total like readinglist unicorn])
|
|
end
|
|
|
|
it "returns the total number of reactions" do
|
|
create(:reaction, reactable: article)
|
|
expect(analytics_service.totals[:reactions][:total]).to eq(1)
|
|
end
|
|
|
|
it "returns zero as total if there are no reactions with points" do
|
|
reaction = create(:reaction, reactable: article)
|
|
reaction.update_columns(points: 0.0)
|
|
expect(analytics_service.totals[:reactions][:total]).to eq(0)
|
|
end
|
|
|
|
it "returns the number of like reactions" do
|
|
create(:reaction, reactable: article, category: :like)
|
|
expect(analytics_service.totals[:reactions][:like]).to eq(1)
|
|
end
|
|
|
|
it "returns zero as the number of like reactions" do
|
|
create(:reaction, reactable: article, category: :unicorn)
|
|
expect(analytics_service.totals[:reactions][:like]).to eq(0)
|
|
end
|
|
|
|
it "returns the number of readinglist reactions" do
|
|
create(:reaction, reactable: article, category: :readinglist)
|
|
expect(analytics_service.totals[:reactions][:readinglist]).to eq(1)
|
|
end
|
|
|
|
it "returns zero as the number of readinglist reactions" do
|
|
create(:reaction, reactable: article, category: :unicorn)
|
|
expect(analytics_service.totals[:reactions][:readinglist]).to eq(0)
|
|
end
|
|
|
|
it "returns the number of unicorn reactions" do
|
|
create(:reaction, reactable: article, category: :unicorn)
|
|
expect(analytics_service.totals[:reactions][:unicorn]).to eq(1)
|
|
end
|
|
|
|
it "returns zero as the number of unicorn reactions" do
|
|
create(:reaction, reactable: article, category: :like)
|
|
expect(analytics_service.totals[:reactions][:unicorn]).to eq(0)
|
|
end
|
|
end
|
|
|
|
describe "follows stats" do
|
|
it "returns stats" do
|
|
stats = analytics_service.totals[:follows]
|
|
expect(stats.keys).to eq(%i[total])
|
|
end
|
|
|
|
it "returns the total number of follows" do
|
|
create(:follow, followable: user)
|
|
expected_stats = { total: 1 }
|
|
expect(analytics_service.totals[:follows]).to eq(expected_stats)
|
|
end
|
|
|
|
it "returns zero as total if there are no follows" do
|
|
expected_stats = { total: 0 }
|
|
expect(analytics_service.totals[:follows]).to eq(expected_stats)
|
|
end
|
|
end
|
|
|
|
describe "page views stats" do
|
|
it "returns stats" do
|
|
stats = analytics_service.totals[:page_views]
|
|
expect(stats.keys).to eq(%i[total average_read_time_in_seconds total_read_time_in_seconds])
|
|
end
|
|
|
|
it "returns the total number of page views from page_views_count" do
|
|
article.update_columns(page_views_count: 1)
|
|
expect(analytics_service.totals[:page_views][:total]).to eq(1)
|
|
end
|
|
|
|
it "returns zero as total if there are no page views" do
|
|
expect(analytics_service.totals[:page_views][:total]).to eq(0)
|
|
end
|
|
|
|
it "returns the average read time in seconds" do
|
|
create(:page_view, user: user, article: article, time_tracked_in_seconds: 15)
|
|
create(:page_view, user: user, article: article, time_tracked_in_seconds: 45)
|
|
expect(analytics_service.totals[:page_views][:average_read_time_in_seconds]).to eq(30)
|
|
end
|
|
|
|
it "returns zero as the average read time in seconds without views" do
|
|
expect(analytics_service.totals[:page_views][:average_read_time_in_seconds]).to eq(0)
|
|
end
|
|
|
|
it "returns the total read time in seconds" do
|
|
article.update_columns(page_views_count: 1)
|
|
create(:page_view, user: user, article: article, time_tracked_in_seconds: 15)
|
|
create(:page_view, user: user, article: article, time_tracked_in_seconds: 45)
|
|
# average read time * total_views
|
|
expect(analytics_service.totals[:page_views][:total_read_time_in_seconds]).to eq(30)
|
|
end
|
|
|
|
it "returns zero as the total read time in seconds with no page views" do
|
|
expect(analytics_service.totals[:page_views][:total_read_time_in_seconds]).to eq(0)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe "#grouped_by_day" do
|
|
def format_date(datetime)
|
|
datetime.to_date.iso8601
|
|
end
|
|
|
|
it "returns stats grouped by day" do
|
|
stats = described_class.new(
|
|
user, start_date: "2019-04-01", end_date: "2019-04-04"
|
|
).grouped_by_day
|
|
expect(stats.keys).to eq(["2019-04-01", "2019-04-02", "2019-04-03", "2019-04-04"])
|
|
end
|
|
|
|
it "returns stats for comments, reactions, follows and page views for a specific day" do
|
|
stats = described_class.new(user, start_date: "2019-04-01").grouped_by_day
|
|
expect(stats["2019-04-01"].keys.to_set).to eq(%i[comments reactions page_views follows].to_set)
|
|
end
|
|
|
|
it "returns stats for an org" do
|
|
stats = described_class.new(
|
|
organization, start_date: "2019-04-01", end_date: "2019-04-04"
|
|
).grouped_by_day
|
|
expect(stats.keys).to eq(["2019-04-01", "2019-04-02", "2019-04-03", "2019-04-04"])
|
|
expect(stats["2019-04-01"].keys.to_set).to eq(%i[comments reactions page_views follows].to_set)
|
|
end
|
|
|
|
describe "comments stats on a specific day" do
|
|
it "returns stats" do
|
|
analytics_service = described_class.new(user, start_date: "2019-04-01", end_date: "2019-04-04")
|
|
stats = analytics_service.grouped_by_day["2019-04-01"][:comments]
|
|
expect(stats.keys).to eq(%i[total])
|
|
end
|
|
|
|
it "returns the total number of comments" do
|
|
comment = create(:comment, commentable: article, score: 1)
|
|
expected_stats = { total: 1 }
|
|
date = format_date(comment.created_at)
|
|
analytics_service = described_class.new(user, start_date: date)
|
|
expect(analytics_service.grouped_by_day[date][:comments]).to eq(expected_stats)
|
|
end
|
|
|
|
it "returns zero as total if there are no scored comments" do
|
|
comment = create(:comment, commentable: article, score: 0)
|
|
expected_stats = { total: 0 }
|
|
date = format_date(comment.created_at)
|
|
analytics_service = described_class.new(user, start_date: date)
|
|
expect(analytics_service.grouped_by_day[date][:comments]).to eq(expected_stats)
|
|
end
|
|
end
|
|
|
|
describe "reactions stats on a specific day" do
|
|
before { Reaction.where(reactable: article).delete_all }
|
|
|
|
it "returns stats" do
|
|
analytics_service = described_class.new(user, start_date: "2019-04-01")
|
|
stats = analytics_service.grouped_by_day["2019-04-01"][:reactions]
|
|
expect(stats.keys).to eq(%i[total like readinglist unicorn])
|
|
end
|
|
|
|
it "returns the total number of reactions" do
|
|
reaction = create(:reaction, reactable: article)
|
|
date = format_date(reaction.created_at)
|
|
analytics_service = described_class.new(user, start_date: date)
|
|
expect(analytics_service.grouped_by_day[date][:reactions][:total]).to eq(1)
|
|
end
|
|
|
|
it "returns zero as total if there are no reactions with points" do
|
|
reaction = create(:reaction, reactable: article)
|
|
reaction.update_columns(points: 0.0)
|
|
date = format_date(reaction.created_at)
|
|
analytics_service = described_class.new(user, start_date: date)
|
|
expect(analytics_service.grouped_by_day[date][:reactions][:total]).to eq(0)
|
|
end
|
|
|
|
it "returns the number of like reactions" do
|
|
reaction = create(:reaction, reactable: article, category: :like)
|
|
date = format_date(reaction.created_at)
|
|
analytics_service = described_class.new(user, start_date: date)
|
|
expect(analytics_service.grouped_by_day[date][:reactions][:like]).to eq(1)
|
|
end
|
|
|
|
it "returns zero as the number of like reactions" do
|
|
reaction = create(:reaction, reactable: article, category: :unicorn)
|
|
date = format_date(reaction.created_at)
|
|
analytics_service = described_class.new(user, start_date: date)
|
|
expect(analytics_service.grouped_by_day[date][:reactions][:like]).to eq(0)
|
|
end
|
|
|
|
it "returns the number of readinglist reactions" do
|
|
reaction = create(:reaction, reactable: article, category: :readinglist)
|
|
date = format_date(reaction.created_at)
|
|
analytics_service = described_class.new(user, start_date: date)
|
|
expect(analytics_service.grouped_by_day[date][:reactions][:readinglist]).to eq(1)
|
|
end
|
|
|
|
it "returns zero as the number of readinglist reactions" do
|
|
reaction = create(:reaction, reactable: article, category: :unicorn)
|
|
date = format_date(reaction.created_at)
|
|
analytics_service = described_class.new(user, start_date: date)
|
|
expect(analytics_service.grouped_by_day[date][:reactions][:readinglist]).to eq(0)
|
|
end
|
|
|
|
it "returns the number of unicorn reactions" do
|
|
reaction = create(:reaction, reactable: article, category: :unicorn)
|
|
date = format_date(reaction.created_at)
|
|
analytics_service = described_class.new(user, start_date: date)
|
|
expect(analytics_service.grouped_by_day[date][:reactions][:unicorn]).to eq(1)
|
|
end
|
|
|
|
it "returns zero as the number of unicorn reactions" do
|
|
reaction = create(:reaction, reactable: article, category: :like)
|
|
date = format_date(reaction.created_at)
|
|
analytics_service = described_class.new(user, start_date: date)
|
|
expect(analytics_service.grouped_by_day[date][:reactions][:unicorn]).to eq(0)
|
|
end
|
|
end
|
|
|
|
describe "follows stats for a specific day" do
|
|
it "returns stats" do
|
|
analytics_service = described_class.new(user, start_date: "2019-04-01")
|
|
stats = analytics_service.grouped_by_day["2019-04-01"][:follows]
|
|
expect(stats.keys).to eq(%i[total])
|
|
end
|
|
|
|
it "returns the total number of follows" do
|
|
follow = create(:follow, followable: user)
|
|
date = format_date(follow.created_at)
|
|
analytics_service = described_class.new(user, start_date: date)
|
|
expected_stats = { total: 1 }
|
|
expect(analytics_service.grouped_by_day[date][:follows]).to eq(expected_stats)
|
|
end
|
|
|
|
it "returns zero as total if there are no follows" do
|
|
date = format_date(Time.current)
|
|
analytics_service = described_class.new(user, start_date: date)
|
|
expected_stats = { total: 0 }
|
|
expect(analytics_service.grouped_by_day[date][:follows]).to eq(expected_stats)
|
|
end
|
|
end
|
|
|
|
describe "page views stats for a specific day" do
|
|
before { PageView.where(article: article).delete_all }
|
|
|
|
it "returns stats" do
|
|
analytics_service = described_class.new(user, start_date: "2019-04-01")
|
|
stats = analytics_service.grouped_by_day["2019-04-01"][:page_views]
|
|
expect(stats.keys).to eq(%i[total average_read_time_in_seconds total_read_time_in_seconds])
|
|
end
|
|
|
|
it "returns the total number of page views from counts_for_number_of_views" do
|
|
pv = create(:page_view, user: user, article: article, counts_for_number_of_views: 5)
|
|
date = format_date(pv.created_at)
|
|
analytics_service = described_class.new(user, start_date: date)
|
|
expect(analytics_service.grouped_by_day[date][:page_views][:total]).to eq(5)
|
|
end
|
|
|
|
it "returns zero as total if there are no page views" do
|
|
date = format_date(Time.current)
|
|
analytics_service = described_class.new(user, start_date: date)
|
|
expect(analytics_service.grouped_by_day[date][:page_views][:total]).to eq(0)
|
|
end
|
|
|
|
it "returns the average read time in seconds" do
|
|
create(:page_view, user: user, article: article, time_tracked_in_seconds: 15)
|
|
pv = create(:page_view, user: user, article: article, time_tracked_in_seconds: 45)
|
|
date = format_date(pv.created_at)
|
|
analytics_service = described_class.new(user, start_date: date)
|
|
expect(analytics_service.grouped_by_day[date][
|
|
:page_views][:average_read_time_in_seconds]).to eq(30)
|
|
end
|
|
|
|
it "returns zero as the average read time in seconds without views" do
|
|
date = format_date(Time.current)
|
|
analytics_service = described_class.new(user, start_date: date)
|
|
expect(analytics_service.grouped_by_day[date][
|
|
:page_views][:average_read_time_in_seconds]).to eq(0)
|
|
end
|
|
|
|
it "returns the total read time in seconds" do
|
|
create(:page_view, user: user, article: article, time_tracked_in_seconds: 15)
|
|
create(:page_view, user: user, article: article, time_tracked_in_seconds: 45)
|
|
date = format_date(article.created_at)
|
|
analytics_service = described_class.new(user, start_date: date)
|
|
# average read time (30) * total_views (2)
|
|
expect(analytics_service.grouped_by_day[date][
|
|
:page_views][:total_read_time_in_seconds]).to eq(60)
|
|
end
|
|
|
|
it "returns zero as the total read time in seconds with no page views" do
|
|
date = format_date(Time.current)
|
|
analytics_service = described_class.new(user, start_date: date)
|
|
expect(analytics_service.grouped_by_day[date][
|
|
:page_views][:total_read_time_in_seconds]).to eq(0)
|
|
end
|
|
end
|
|
end
|
|
end
|