Merge pull request #6278 from gabina/data-rearchitecture-rewrite-IndividualStatisticsTimeslicePresenter-without-revisions

[Data rearchitecture] Rewrite individual statistics timeslice presenter without revisions

Author: ragesoss

app/assets/javascripts/components/user_profiles/student_stats.jsx

@@ -15,29 +15,35 @@ const StudentStats = ({ username, stats, maxProject }) => {
             {I18n.t(`${stats.course_string_prefix}.courses_enrolled`)}
           </small>
         </div>
-        <div className= "stat-display__stat">
+        <div className= "stat-display__stat tooltip-trigger">
           <div className="stat-display__value">
             {stats.individual_word_count}
+            <img src ="/assets/images/info.svg" alt = "tooltip default logo" />
           </div>
           <small>
             {I18n.t('metrics.word_count')}
           </small>
+          <div className="tooltip dark">
+            <h4> {stats.individual_word_count} </h4>
+            <p>
+              {I18n.t('user_profiles.words_added_disclaimer')}
+            </p>
+          </div>
         </div>
-        <div className= "stat-display__stat">
+        <div className= "stat-display__stat tooltip-trigger">
           <div className="stat-display__value">
             {stats.individual_references_count}
+            <img src ="/assets/images/info.svg" alt = "tooltip default logo" />
           </div>
           <small>
             {I18n.t('metrics.references_count')}
           </small>
-        </div>
-        <div className= "stat-display__stat">
-          <div className="stat-display__value">
-            {stats.individual_article_views}
+          <div className="tooltip dark">
+            <h4> {stats.individual_references_count} </h4>
+            <p>
+              {I18n.t('user_profiles.references_disclaimer')}
+            </p>
           </div>
-          <small>
-            {I18n.t(`metrics.${ArticleUtils.projectSuffix(maxProject, 'view_count_description')}`)}
-          </small>
         </div>
         <div className= "stat-display__stat">
           <div className="stat-display__value">
@@ -47,14 +53,6 @@ const StudentStats = ({ username, stats, maxProject }) => {
             {I18n.t(`metrics.${ArticleUtils.projectSuffix(maxProject, 'articles_edited')}`)}
           </small>
         </div>
-        <div className= "stat-display__stat">
-          <div className="stat-display__value">
-            {stats.individual_articles_created}
-          </div>
-          <small>
-            {I18n.t(`metrics.${ArticleUtils.projectSuffix(maxProject, 'articles_created')}`)}
-          </small>
-        </div>
         <div className ="stat-display__stat tooltip-trigger">
           <div className="stat-display__value">
             {stats.individual_upload_count}

app/controllers/user_profiles_controller.rb

@@ -40,7 +40,7 @@ def update
 
   def stats
     @courses_users = @user.courses_users.includes(:course).where(courses: { private: false })
-    @individual_stats_presenter = IndividualStatisticsPresenter.new(user: @user)
+    @individual_stats_presenter = IndividualStatisticsTimeslicePresenter.new(user: @user)
     @courses_list = public_courses
                     .where(courses_users: { role: CoursesUsers::Roles::INSTRUCTOR_ROLE })
     @courses_presenter = CoursesPresenter.new(current_user:,

app/presenters/individual_statistics_timeslice_presenter.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_dependency "#{Rails.root}/lib/word_count"
+
+# Presenter to provide statistics about a user's individual contributions during
+# courses in which the user was a student.
+class IndividualStatisticsTimeslicePresenter
+  def initialize(user:)
+    @user = user
+    set_data_from_course_user
+    set_data_from_article_course
+    set_upload_usage_counts
+  end
+
+  def individual_courses
+    @user.courses.nonprivate.where(courses_users: { role: CoursesUsers::Roles::STUDENT_ROLE })
+  end
+
+  def course_string_prefix
+    Features.default_course_string_prefix
+  end
+
+  def individual_word_count
+    WordCount.from_characters individual_character_count
+  end
+
+  def individual_character_count
+    @course_user_data[:characters]
+  end
+
+  def individual_references_count
+    @course_user_data[:references]
+  end
+
+  def individual_upload_count
+    @upload_usage_counts.length
+  end
+
+  def individual_upload_usage_count
+    @upload_usage_counts.values.sum
+  end
+
+  def individual_article_count
+    @article_course_data.length
+  end
+
+  private
+
+  def set_data_from_course_user
+    @course_user_data = {}
+    @course_user_data[:characters] = 0
+    @course_user_data[:references] = 0
+    individual_courses.each do |course|
+      course_user_records(course).each do |course_user|
+        @course_user_data[:characters] += course_user.character_sum_ms
+        @course_user_data[:references] += course_user.references_count
+      end
+    end
+  end
+
+  def set_data_from_article_course
+    @article_course_data = {}
+    individual_courses.each do |course|
+      article_course_records(course).each do |article_course|
+        @article_course_data[article_course.article_id] = 1
+      end
+    end
+  end
+
+  def set_upload_usage_counts
+    @upload_usage_counts = {}
+    individual_courses.each do |course|
+      course.uploads.where(user_id: @user.id).each do |upload|
+        @upload_usage_counts[upload.id] = upload.usage_count || 0
+      end
+    end
+  end
+
+  def article_course_records(course)
+    course.articles_courses
+          .where('user_ids LIKE ?', "%- #{@user.id}\n%")
+          .joins(:article)
+          .includes(:article)
+          .where(articles: { namespace: Article::Namespaces::MAINSPACE, deleted: false })
+  end
+
+  def course_user_records(course)
+    course.courses_users.where(user: @user)
+  end
+end

app/views/user_profiles/stats.json.jbuilder

@@ -42,12 +42,8 @@ if @user.course_student?
     json.individual_word_count number_to_human @individual_stats_presenter.individual_word_count
     json.individual_references_count number_to_human @individual_stats_presenter
       .individual_references_count
-    json.individual_article_views number_to_human @individual_stats_presenter
-      .individual_article_views
     json.individual_article_count number_to_human @individual_stats_presenter
       .individual_article_count
-    json.individual_articles_created number_to_human @individual_stats_presenter
-      .individual_articles_created
     json.individual_upload_count number_to_human @individual_stats_presenter
       .individual_upload_count
     json.individual_upload_usage_count number_to_human @individual_stats_presenter

config/locales/en.yml

@@ -1639,6 +1639,8 @@ en:
     location_placeholder: Add your location (optional)
     institution_placeholder: Institution name (optional)
     image_link_placeholder: Add link to image (optional)
+    references_disclaimer: References might be overcounted if the same user edit is considered part of multiple courses.
+    words_added_disclaimer: Words added might be overcounted if the same user edit is considered part of multiple courses.
 
   wiki_edits:
     notify_overdue:

spec/presenters/individual_statistics_timeslice_presenter_spec.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+require_relative '../../app/presenters/individual_statistics_presenter'
+
+describe IndividualStatisticsTimeslicePresenter do
+  describe 'individual_article_views' do
+    subject { described_class.new(user:) }
+
+    let(:start) { 1.year.ago.beginning_of_day }
+    let(:course_end) { 1.day.ago.end_of_day }
+    let(:course1) { create(:course, start:, end: course_end) }
+    let(:course2) { create(:course, slug: 'foo/2', start:, end: course_end) }
+    let(:user) { create(:user) }
+    let(:article) { create(:article, average_views: 10) }
+    let(:refs_tags_key) { 'feature.wikitext.revision.ref_tags' }
+    let(:array_revisions) { [] }
+
+    context 'when a user is in two courses that overlap' do
+      before do
+        create(:commons_upload, user_id: user.id, usage_count: 1,
+                                uploaded_at: start + 1.minute)
+        array_revisions << create(:revision, views: 100, user_id: user.id, article_id: article.id,
+                          date: start + 1.minute, new_article: true, characters: 100,
+                          features: {
+                            refs_tags_key => 22
+                          }, scoped: true)
+        create(:courses_user, user_id: user.id, course_id: course1.id)
+        create(:courses_user, user_id: user.id, course_id: course2.id)
+        create(:articles_course, article_id: article.id, course_id: course1.id)
+        create(:articles_course, article_id: article.id, course_id: course2.id)
+        ArticlesCourses.update_from_course_revisions(course1, array_revisions)
+        ArticlesCourses.update_from_course_revisions(course2, array_revisions)
+        TimesliceManager.new(course1).create_timeslices_for_new_course_wiki_records(course1.wikis)
+        TimesliceManager.new(course2).create_timeslices_for_new_course_wiki_records(course2.wikis)
+
+        revision_data = { start:, end: start + 1.day - 1.second,
+                          revisions: array_revisions }
+        CourseUserWikiTimeslice.update_course_user_wiki_timeslices(course1, user.id,
+                                                                   course1.wikis.first,
+                                                                   revision_data)
+        CourseUserWikiTimeslice.update_course_user_wiki_timeslices(course2, user.id,
+                                                                   course2.wikis.first,
+                                                                   revision_data)
+        CoursesUsers.update_all_caches_from_timeslices(CoursesUsers.all)
+
+        ArticleCourseTimeslice.update_article_course_timeslices(course1, article.id,
+                                                                revision_data)
+        ArticleCourseTimeslice.update_article_course_timeslices(course2, article.id,
+                                                                revision_data)
+        ArticlesCourses.update_all_caches_from_timeslices(ArticlesCourses.all)
+        course1.update_cache_from_timeslices
+        course2.update_cache_from_timeslices
+      end
+
+      it 'does\'t double count the same articles in multiple courses' do
+        expect(course1.articles_courses.count).to eq(1)
+        expect(course2.articles_courses.count).to eq(1)
+
+        # double count character count and references
+        expect(subject.individual_character_count).to eq(200)
+        expect(subject.individual_references_count).to eq(44)
+
+        # does not double count article count
+        expect(subject.individual_article_count).to eq(1)
+      end
+
+      it 'does not double count upload stats' do
+        expect(course1.uploads.count).to eq(1)
+        expect(course2.uploads.count).to eq(1)
+        expect(subject.individual_upload_count).to eq(1)
+        expect(subject.individual_upload_usage_count).to eq(1)
+      end
+    end
+  end
+end