Optimize factory usage for job artifact report entity (!229069) · Merge requests · GitLab.org / GitLab

What does this MR do and why?

This MR replaces create with build_stubbed in spec/serializers/job_artifact_report_entity_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/serializers/job_artifact_report_entity_spec.rb.

Factory Usage Optimization Results

Before optimization:

Factory time: 2.7800000000000002s (14.16% of total time)

After optimization:

Factory time: 0.077s (0.48% of total time)

🚀 Improvement:

Factory time reduced by: 2.703s
Factory time percentage reduced by: 13.68%
Overall factory usage improvement: 97.2%

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.2444390000018757 seconds
....[TEST PROF INFO] FactoryDoctor report

Total (potentially) bad examples: 4
Total wasted time: 00:02.606

JobArtifactReportEntity (./spec/serializers/job_artifact_report_entity_spec.rb:5) (24 records created, 00:02.606)
  exposes file_type (./spec/serializers/job_artifact_report_entity_spec.rb:12) – 6 records created, 00:01.752
  exposes file_format (./spec/serializers/job_artifact_report_entity_spec.rb:16) – 6 records created, 00:00.291
  exposes size (./spec/serializers/job_artifact_report_entity_spec.rb:20) – 6 records created, 00:00.280
  exposes download path (./spec/serializers/job_artifact_report_entity_spec.rb:24) – 6 records created, 00:00.282




Finished in 14.41 seconds (files took 16.04 seconds to load)
4 examples, 0 failures

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

Factory time before the update

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

Factory time after update

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

This MR also adds the missing feature category in this spec.

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 job artifact report entity