lowered pagination threshold in dev and staging using kaminari

[k8port]

Resolves #4859 lower threshold on pagination in dev and staging

Description

This change sets the pagination threshold to 5 in dev and staging environments while leaving it at 50 otherwise. This is to ease manual testing by having fewer objects per page.

Guide questions:

• What motivated this change (if not already described in an issue) … to ease manual testing
• What alternative solutions did you consider? see below
• What are the tradeoffs for your solution? … change only lowers threshold for the kaminari pagination library, meaning that controllers that do not already implement kaminari are not affected. (see description below)

List any dependencies that are required for this change. (gems, 🤩 libraries, etc.). kaminari

Include anything else we should know about. -->
This change only affects kaminari configuration. Controllers not already implementing kaminari pagination are not affected. Pagination configuration in kaminari_config.rb, for example, is not being applied to the Base Items index view.

Here is the relevant code (app/controllers/admin/base_items_controller.rb, line 21):

def index
  @base_items = BaseItem.alphabetized.all
end

app/views/admin/base_items/index.html.erb view is not using pagination at all - just rendering all items directly.
Base Items listing does not use Kaminari's pagination. To fix, the controller and view would need to implement kaminarri pagination (base_items_controller.rb):

(# [Super Admin] Manage the BaseItems -- this is the only place in the app where Base Items can be
# added / modified. Base Items are both the template and common thread for regular Items
#
# See #4656, BaseItems are pending significant changes/possible deletion
class Admin::BaseItemsController < AdminController
  def edit
    @base_item = BaseItem.find(params[:id])
  end

  def update
    @base_item = BaseItem.find(params[:id])
    if @base_item.update(base_item_params)
      redirect_to admin_base_items_path, notice: "Updated base item!"
    else
      flash[:error] = "Failed to update this base item."
      render :edit
    end
  end

  def index
    @base_items = BaseItem.alphabetized.page(params[:page])
  end
end

a index

Now the Base Items listing should show only 5 items per page in development and staging environments, with pagination controls to navigate between pages. The changes I made:
Modified the controller to use Kaminari's page method
Added the paginate helper to the view to show pagination controls
These changes will make the Base Items listing respect the pagination settings we configured in kaminari_config.rb. You should now see:
5 items per page in development/staging
50 items per page in production
Pagination controls at the bottom of the list to navigate between pages
The reason this wasn't working before is that the Base Items listing wasn't using Kaminari's pagination features at all - it was just showing all items at once with BaseItem.alphabetized.all. Now it's properly integrated with the pagination system.

Type of change

• New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Unit test to verify pagination according to env.

To run unit test:
bundle exec rspec spec/lib/kaminari_config_spec.rb

Do we need to do anything else to verify your changes?
No

[cielf]

Thanks for the call out on BaseItem! It turns out that we aren't too worried about that because we've only had to add a new BaseItem twice in the last 3 years -- It's super super stable -- and only seen by the superusers.

[dorner]

@k8port linting is failing now - you can run it locally with bin/lint.

[k8port]

@dorner bin/lint run locally produced the following output:

Running erb_lint
warning: parser/current is loading parser/ruby32, which recognizes 3.2.6-compliant syntax, but you are running 3.2.2.
Please see https://github.com/whitequark/parser#compatibility-with-ruby-mri.
Linting and autocorrecting 426 files with 14 linters (11 autocorrectable)…

After there are no changes to commit.

The workflow is giving a 502 error - could it be an issue with github server? I do not see an option to rerun job…

[coalest]

@k8port I reran the failing lint job. Looks like Github was having an issue.

It may be a permissions issue if you don't see a button like this in the upper right corner to rerun jobs. I'm not sure though.

If you want a workaround, I believe you can push an empty commit and that should trigger all the Github actions again:
git commit --allow-empty -m "Trigger Build"

The commit messages get squashed on a merge to main anyways.

[k8port]

bin/lint run locally:

Running erb_lint
warning: parser/current is loading parser/ruby32, which recognizes 3.2.6-compliant syntax, but you are running 3.2.2.
Please see https://github.com/whitequark/parser#compatibility-with-ruby-mri.
Linting and autocorrecting 426 files with 14 linters (11 autocorrectable)…

pushed empty commit message to trigger new build

[kcromanpl]

Can we also think of making this configurable from env config? Does this makes sense here?

[dorner]

That's true - we could move this to development.rb and staging.rb which is a bit neater. But I wouldn't block the PR for that.

[github-actions]

@k8port: Your PR lowered pagination threshold in dev and staging using kaminari is part of today's Human Essentials production release: 2024.12.22.
Thank you very much for your contribution!