Skip to content

OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub

Extract work package activity tab pagination

Kabiru Mwenja790f9a44d6ef
diff --git a/app/controllers/work_packages/activities_tab_controller.rb b/app/controllers/work_packages/activities_tab_controller.rb
index 963ec51c616..d92dbf5b384 100644
--- a/app/controllers/work_packages/activities_tab_controller.rb
+++ b/app/controllers/work_packages/activities_tab_controller.rb
@@ -29,7 +29,6 @@
# ++
class WorkPackages::ActivitiesTabController < ApplicationController
- include Pagy::Backend
include OpTurbo::ComponentStream
include FlashMessagesOutputSafetyHelper
include WorkPackages::ActivitiesTab::JournalSortingInquirable
@@ -192,83 +191,7 @@ class WorkPackages::ActivitiesTabController < ApplicationController
private
def initialize_pagination
- anchor_type, target_journal_id = extract_target_journal_id
-
- @paginator, @paginated_journals =
- if anchor_type && target_journal_id
- pagy_array_for_target_journal(anchor_type, target_journal_id)
- else
- pagy_array(base_journals)
- end
-
- # For UI display: if user wants "oldest first" UI, reverse the array
- @paginated_journals = @paginated_journals.reverse if journal_sorting.asc?
- end
-
- def extract_target_journal_id
- anchor = params[:anchor] # e.g., "comment-78758" (without #)
- return nil unless anchor
-
- match = anchor.match(/^(comment|activity)-(\d+)$/)
- match && match.length == 3 ? [match[1].inquiry, match[2].to_i] : []
- end
-
- def pagy_array_for_target_journal(anchor_type, target_journal_id)
- journals = base_journals
-
- target_index = journals.find_index do |record|
- if anchor_type.comment?
- record.id == target_journal_id
- elsif anchor_type.activity?
- record.sequence_version == target_journal_id
- else
- false
- end
- end
-
- if target_index
- target_page = (target_index / Pagy::DEFAULT[:limit]) + 1
- pagy_array(journals, page: target_page)
- else
- # Journal might be filtered out or deleted - fallback to page 1
- pagy_array(journals, page: 1)
- end
- end
-
- def base_journals
- combine_and_sort_records(fetch_journals, fetch_revisions)
- end
-
- def fetch_journals
- API::V3::Activities::ActivityEagerLoadingWrapper.wrap(fetch_ar_journals)
- end
-
- def fetch_ar_journals
- @work_package
- .journals
- .internal_visible
- .includes(:user, :customizable_journals, :attachable_journals, :storable_journals, :notifications)
- .reorder(version: :desc) # Always fetch newest first for pagination
- .with_sequence_version
- end
-
- def fetch_revisions
- @work_package.changesets.includes(:user, :repository)
- end
-
- def combine_and_sort_records(journals, revisions)
- (journals + revisions).sort_by do |record|
- timestamp = record_timestamp(record)
- [-timestamp, -record.id] # Always sort DESC (newest first)
- end
- end
-
- def record_timestamp(record)
- if record.is_a?(API::V3::Activities::ActivityEagerLoadingWrapper)
- record.created_at&.to_i
- elsif record.is_a?(Changeset)
- record.committed_on.to_i
- end
+ @paginator, @paginated_journals = WorkPackages::ActivitiesTab::Paginator.paginate(@work_package, params)
end
def respond_with_error(error_message)
diff --git a/app/services/work_packages/activities_tab/paginator.rb b/app/services/work_packages/activities_tab/paginator.rb
new file mode 100644
index 00000000000..eccb65d2dec
--- /dev/null
+++ b/app/services/work_packages/activities_tab/paginator.rb
@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+# Copyright (C) 2006-2013 Jean-Philippe Lang
+# Copyright (C) 2010-2013 the ChiliProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+# See COPYRIGHT and LICENSE files for more details.
+#++
+
+class WorkPackages::ActivitiesTab::Paginator
+ include Pagy::Backend
+ include WorkPackages::ActivitiesTab::JournalSortingInquirable
+
+ def self.paginate(work_package, params = {})
+ new(work_package, params).call
+ end
+
+ def initialize(work_package, params = {})
+ @work_package = work_package
+ @params = params
+ end
+
+ def call
+ anchor_type, target_record_id = extract_target_record_id
+
+ pagy, records =
+ if anchor_type && target_record_id
+ pagy_array_for_target_journal(anchor_type, target_record_id)
+ else
+ pagy_array(base_journals)
+ end
+
+ # For UI display: if user wants "oldest first" UI, reverse the array
+ records = records.reverse if journal_sorting.asc?
+
+ [pagy, records]
+ end
+
+ private
+
+ attr_reader :work_package, :params
+
+ def extract_target_record_id
+ anchor = params[:anchor] # e.g., "comment-78758" (without #)
+ return nil unless anchor
+
+ match = anchor.match(/^(comment|activity)-(\d+)$/)
+ match && match.length == 3 ? [match[1].inquiry, match[2].to_i] : []
+ end
+
+ def pagy_array_for_target_journal(anchor_type, target_record_id)
+ journals = base_journals
+
+ target_index = journals.find_index do |record|
+ if anchor_type.comment?
+ record.id == target_record_id
+ elsif anchor_type.activity?
+ record.sequence_version == target_record_id
+ else
+ false
+ end
+ end
+
+ if target_index
+ target_page = (target_index / Pagy::DEFAULT[:limit]) + 1
+ pagy_array(journals, page: target_page)
+ else
+ # Journal might be filtered out or deleted - fallback to page 1
+ pagy_array(journals, page: 1)
+ end
+ end
+
+ def base_journals
+ combine_and_sort_records(fetch_journals, fetch_revisions)
+ end
+
+ def fetch_journals
+ API::V3::Activities::ActivityEagerLoadingWrapper.wrap(fetch_ar_journals)
+ end
+
+ def fetch_ar_journals
+ work_package
+ .journals
+ .internal_visible
+ .includes(:user, :customizable_journals, :attachable_journals, :storable_journals, :notifications)
+ .reorder(version: :desc) # Always fetch newest first for pagination
+ .with_sequence_version
+ end
+
+ def fetch_revisions
+ work_package.changesets.includes(:user, :repository)
+ end
+
+ def combine_and_sort_records(journals, revisions)
+ (journals + revisions).sort_by do |record|
+ timestamp = record_timestamp(record)
+ [-timestamp, -record.id] # Always sort DESC (newest first)
+ end
+ end
+
+ def record_timestamp(record)
+ if record.is_a?(API::V3::Activities::ActivityEagerLoadingWrapper)
+ record.created_at&.to_i
+ elsif record.is_a?(Changeset)
+ record.committed_on.to_i
+ end
+ end
+end
diff --git a/spec/factories/work_package_factory.rb b/spec/factories/work_package_factory.rb
index 0eb609fabd7..2dcafac0ce9 100644
--- a/spec/factories/work_package_factory.rb
+++ b/spec/factories/work_package_factory.rb
@@ -146,7 +146,6 @@ FactoryBot.define do
end
end
-
# force done_ratio in status-based mode if given done_ratio is different from status default
callback(:after_create) do |work_package, evaluator|
next unless WorkPackage.status_based_mode?
diff --git a/spec/services/work_packages/activities_tab/paginator_spec.rb b/spec/services/work_packages/activities_tab/paginator_spec.rb
new file mode 100644
index 00000000000..583a7697c3e
--- /dev/null
+++ b/spec/services/work_packages/activities_tab/paginator_spec.rb
@@ -0,0 +1,253 @@
+# frozen_string_literal: true
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+# Copyright (C) 2006-2013 Jean-Philippe Lang
+# Copyright (C) 2010-2013 the ChiliProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+# See COPYRIGHT and LICENSE files for more details.
+#++
+
+require "spec_helper"
+
+RSpec.describe WorkPackages::ActivitiesTab::Paginator do
+ shared_let(:user) { create(:admin) }
+ shared_let(:project) { create(:project) }
+ shared_let(:work_package) { create(:work_package, :created_in_past, project:, author: user, created_at: 4.days.ago) }
+
+ let(:params) { {} }
+ let(:paginator) { described_class.new(work_package, params) }
+
+ before do
+ allow(User).to receive(:current).and_return(user)
+ end
+
+ describe "#call" do
+ context "with no additional journals" do
+ let(:work_package) { create(:work_package, project:, author: user) }
+
+ it "returns paginated results with the initial journal" do
+ pagy, records = paginator.call
+
+ expect(pagy).to be_a(Pagy)
+ expect(pagy.page).to eq(1)
+ expect(pagy.count).to eq(1)
+ expect(records).to have_attributes(size: 1)
+ expect(records.first).to be_a(API::V3::Activities::ActivityEagerLoadingWrapper)
+ end
+ end
+
+ context "with multiple journals" do
+ 3.times do |i|
+ let!(:"journal_#{i + 1}") do
+ create(:work_package_journal, user:, notes: "Comment #{i + 1}", journable: work_package, version: i + 2)
+ end
+ end
+
+ context "when user preference is set to asc sorting" do
+ before do
+ user.pref.update!(comments_sorting: :asc)
+ end
+
+ it "returns journals reversed (oldest first)" do
+ _pagy, records = paginator.call
+
+ expect(records.map(&:notes)).to eq(["", journal_1.notes, journal_2.notes, journal_3.notes])
+ end
+ end
+
+ context "when user preference is set to desc sorting" do
+ before do
+ user.pref.update!(comments_sorting: :desc)
+ end
+
+ it "returns journals in DESC order (newest first)" do
+ _pagy, records = paginator.call
+
+ expect(records.map(&:notes)).to eq([journal_3.notes, journal_2.notes, journal_1.notes, ""])
+ end
+ end
+ end
+
+ context "with changesets" do
+ let(:repository) { create(:repository_subversion, project:) }
+
+ 2.times do |i|
+ let!(:"changeset_#{i + 1}") do
+ create(:changeset,
+ repository:,
+ committed_on: (2 - i).days.ago, # yesterday and today
+ revision: "rev#{i + 1}")
+ end
+ end
+
+ before do
+ work_package.changesets << [changeset_1, changeset_2]
+ end
+
+ it "includes changesets in the sorted results" do
+ _pagy, records = paginator.call
+
+ expect(records.size).to eq(3) # 1 initial journal + 2 changesets
+ expect(records).to include(changeset_1, changeset_2)
+ end
+
+ it "sorts changesets along with journals by timestamp" do
+ user.pref.update!(comments_sorting: :desc)
+ journal = create(:work_package_journal,
+ user:,
+ notes: "Comment between changesets",
+ journable: work_package,
+ version: work_package.journals.last.version + 1,
+ created_at: 1.5.days.ago)
+
+ _pagy, records = paginator.call
+ expect(records).to eq([changeset_2, journal, changeset_1, work_package.journals.first])
+ end
+ end
+
+ context "with pagination" do
+ # Create enough journals to span multiple pages (default limit is 20)
+ 25.times do |i|
+ let!(:"journal_#{i + 1}") do
+ create(:work_package_journal, user:, notes: "Comment #{i + 1}", journable: work_package, version: i + 2)
+ end
+ end
+
+ it "returns the first page with default limit" do
+ pagy, records = paginator.call
+
+ expect(pagy.page).to eq(1)
+ expect(pagy.count).to eq(26) # 25 journals + 1 initial
+ expect(pagy.pages).to eq(2)
+ expect(records.size).to eq(20) # Default Pagy limit
+ end
+
+ it "returns the second page when requested" do
+ params[:page] = 2
+ pagy, records = paginator.call
+
+ expect(pagy.page).to eq(2)
+ expect(records.size).to eq(6) # Remaining items
+ end
+
+ context "with anchor to target journal" do
+ context "with comment anchor" do
+ it "returns the page containing the target journal" do
+ params[:anchor] = "comment-#{journal_1.id}"
+ pagy, records = paginator.call
+
+ # journal_1 is old, so it should be on page 2
+ expect(pagy.page).to eq(2)
+ expect(records.map(&:id)).to include(journal_1.id)
+ end
+
+ it "handles invalid anchor format gracefully" do
+ params[:anchor] = "invalid-anchor"
+ pagy, _records = paginator.call
+
+ expect(pagy.page).to eq(1)
+ end
+
+ it "falls back to page 1 if journal not found" do
+ params[:anchor] = "comment-999999"
+ pagy, _records = paginator.call
+
+ expect(pagy.page).to eq(1)
+ end
+ end
+
+ context "with activity anchor" do
+ it "returns the page containing the target activity by sequence_version" do
+ params[:anchor] = "activity-2"
+ pagy, records = paginator.call
+
+ # activity-2 corresponds to journal with sequence_version 2
+ # which should be journal_1
+ expect(pagy.page).to eq(2)
+ wrapped_journal = records.find { it.is_a?(API::V3::Activities::ActivityEagerLoadingWrapper) && it.id == journal_1.id }
+ expect(wrapped_journal.sequence_version).to eq(2)
+ end
+
+ it "handles activity anchor for initial journal" do
+ params[:anchor] = "activity-1"
+ _pagy, records = paginator.call
+
+ # activity-1 should be on the last page (oldest)
+ expect(records.any? { it.respond_to?(:sequence_version) && it.sequence_version == 1 }).to be(true)
+ end
+ end
+ end
+ end
+
+ context "with internal comments filtering" do
+ let!(:internal_journal) do
+ create(:work_package_journal,
+ user:,
+ notes: "Internal comment",
+ journable: work_package,
+ internal: true,
+ version: 2)
+ end
+ let!(:public_journal) do
+ create(:work_package_journal,
+ user:,
+ notes: "Public comment",
+ journable: work_package,
+ internal: false,
+ version: 3)
+ end
+
+ before do
+ work_package.project.enabled_internal_comments = true
+ work_package.project.save!
+ end
+
+ context "when user can see internal comments" do
+ it "includes internal journals" do
+ _pagy, records = paginator.call
+
+ journal_notes = records.map(&:notes)
+ expect(journal_notes).to include("Internal comment", "Public comment")
+ end
+ end
+
+ context "when user cannot see internal comments" do
+ let(:member_role) { create(:project_role, permissions: %i[view_work_packages]) }
+ let(:member_user) { create(:user, member_with_roles: { project => member_role }) }
+
+ before do
+ allow(User).to receive(:current).and_return(member_user)
+ end
+
+ it "excludes internal journals" do
+ _pagy, records = described_class.new(work_package, params).call
+
+ journal_notes = records.map(&:notes)
+ expect(journal_notes).not_to include("Internal comment")
+ expect(journal_notes).to include("Public comment")
+ end
+ end
+ end
+ end
+end