Optimize factory usage for kubernetes_error_entity (!229055) · Merge requests · GitLab.org / GitLab

What does this MR do and why?

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

Factory Usage Optimization Results

Before optimization:

Factory time: 3.066s (14.5% of total time)

After optimization:

Factory time: 0.044s (0.31% of total time)

🚀 Improvement:

Factory time reduced by: 3.022s
Factory time percentage reduced by: 14.19%
Overall factory usage improvement: 98.6%

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

Total (potentially) bad examples: 3
Total wasted time: 00:02.900

Clusters::KubernetesErrorEntity (./spec/serializers/clusters/kubernetes_error_entity_spec.rb:5) (42 records created, 00:02.900)
  is expected to eq {:connection_error=>:connection_error, :metrics_connection_error=>nil, :node_connection_error=>nil} (./spec/serializers/clusters/kubernetes_error_entity_spec.rb:16) – 14 records created, 00:01.806
  is expected to eq {:connection_error=>nil, :metrics_connection_error=>:http_error, :node_connection_error=>nil} (./spec/serializers/clusters/kubernetes_error_entity_spec.rb:24) – 14 records created, 00:00.662
  is expected to eq {:connection_error=>nil, :metrics_connection_error=>nil, :node_connection_error=>:unknown_error} (./spec/serializers/clusters/kubernetes_error_entity_spec.rb:32) – 14 records created, 00:00.432




Finished in 13.47 seconds (files took 16.27 seconds to load)
3 examples, 0 failures

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

Factory time before the update

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

Factory time after update

[TEST PROF INFO] Time spent in factories: 00:00.044 (0.31% 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 kubernetes_error_entity