Optimize factory usage for nav helper (!228813) · Merge requests · GitLab.org / GitLab

What does this MR do and why?

This MR replaces create with build_stubbed in spec/helpers/nav_helper_spec.rb to optimize the factory usage as recommended in our handbook. This spec is part of the list .rubocop_todo/rspec/factory_bot/avoid_create.yml. It was verified that database persistence is not needed using the factory doctor command FDOC=1 bin/rspec spec/helpers/nav_helper_spec.rb.

Factory Usage Optimization Results

Before optimization:

Factory time: 1.7810000000000001s (2.88% of total time)

After optimization:

Factory time: 0.057s (0.33% of total time)

🚀 Improvement:

Factory time reduced by: 1.724s
Factory time percentage reduced by: 2.55%
Overall factory usage improvement: 96.8%

Factory Doctor Output

[TEST PROF INFO] FactoryDoctor enabled (event: "sql.active_record", threshold: 0.01)
Run options: include {:focus=>true}

All examples were filtered out; ignoring {:focus=>true}
==> Using precompiled Gitaly binaries from cache

Test environment set up in 1.1827479999992647 seconds
..................[TEST PROF INFO] FactoryDoctor report

Total (potentially) bad examples: 2
Total wasted time: 00:00.100

NavHelper (./spec/helpers/nav_helper_spec.rb:5) (4 records created, 00:00.100)
  does not contain the admin mode link by default (./spec/helpers/nav_helper_spec.rb:39) – 2 records created, 00:00.053
  does not contain the admin mode link (./spec/helpers/nav_helper_spec.rb:60) – 2 records created, 00:00.047




Finished in 15.37 seconds (files took 13.87 seconds to load)
18 examples, 0 failures

Randomized with seed 5041

[TEST PROF INFO] Time spent in factories: 00:01.718 (9.03% of total time)

Factory time after update

[TEST PROF INFO] Time spent in factories: 00:00.057 (0.33% of total time)

References

Relates to: #378910.

MR acceptance checklist

Evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Optimize factory usage for nav helper