Skip to content

Instantly share code, notes, and snippets.

@iurev
Created July 12, 2024 04:12
Show Gist options
  • Save iurev/30e121226b9737f787f320669ed93402 to your computer and use it in GitHub Desktop.
Save iurev/30e121226b9737f787f320669ed93402 to your computer and use it in GitHub Desktop.
[{"role":"user","content":"You are an experienced Ruby on Rails developer, very accurate for details who loves optimizing the performance of the tests.\nThe last 10 years you've spent optimizing performance of _spec.rb files using TestProf library.\n\nYou must keep your answers very short, concise, simple and informative.\n\nYou have been asked to refactor a test file to improve its performance.\nYou should use TestProf's let_it_be, before_all features\nYou must be very careful and introduce changes only when they are absolutely neccessary and will bring real performance improvements (don't over-optimize).\nAgain, make only minimal and essential changes to the existing code.\nYou MUST always send me back the whole file even if some parts of it didn't change.\n\nUse the following example refactoring as a guide:\n\nGit diff with refactoring:\n\ndiff --git a/spec/controllers/statuses_controller_spec.rb b/spec/controllers/statuses_controller_spec.rb\nindex fe40ee6..122de41 100644\n--- a/spec/controllers/statuses_controller_spec.rb\n+++ b/spec/controllers/statuses_controller_spec.rb\n@@ -2,13 +2,12 @@\n \n require 'rails_helper'\n \n-describe StatusesController do\n+describe StatusesController, :account do\n render_views\n \n- describe 'GET #show' do\n- let(:account) { Fabricate(:account) }\n- let(:status) { Fabricate(:status, account: account) }\n+ let_it_be(:status) { Fabricate(:status, account: account) }\n \n+ describe 'GET #show' do\n context 'when account is permanently suspended' do\n before do\n account.suspend!\n@@ -89,7 +88,7 @@ describe StatusesController do\n end\n \n context 'when status is private' do\n- let(:status) { Fabricate(:status, account: account, visibility: :private) }\n+ before { status.update!(visibility: :private) }\n \n before do\n get :show, params: { account_username: status.account.username, id: status.id, format: format }\n@@ -113,7 +112,7 @@ describe StatusesController do\n end\n \n context 'when status is direct' do\n- let(:status) { Fabricate(:status, account: account, visibility: :direct) }\n+ before { status.update!(visibility: :direct) }\n \n before do\n get :show, params: { account_username: status.account.username, id: status.id, format: format }\n@@ -136,9 +135,7 @@ describe StatusesController do\n end\n end\n \n- context 'when signed-in' do\n- let(:user) { Fabricate(:user) }\n-\n+ context 'when signed-in', :user do\n before do\n sign_in(user)\n end\n@@ -194,7 +191,7 @@ describe StatusesController do\n end\n \n context 'when status is private' do\n- let(:status) { Fabricate(:status, account: account, visibility: :private) }\n+ before { status.update!(visibility: :private) }\n \n context 'when user is authorized to see it' do\n before do\n@@ -261,7 +258,7 @@ describe StatusesController do\n end\n \n context 'when status is direct' do\n- let(:status) { Fabricate(:status, account: account, visibility: :direct) }\n+ before { status.update!(visibility: :direct) }\n \n context 'when user is authorized to see it' do\n before do\n@@ -328,7 +325,7 @@ describe StatusesController do\n end\n \n context 'with signature' do\n- let(:remote_account) { Fabricate(:account, domain: 'example.com') }\n+ let_it_be(:remote_account) { Fabricate(:account, domain: 'example.com') }\n \n before do\n allow(controller).to receive(:signed_request_actor).and_return(remote_account)\n@@ -397,7 +394,7 @@ describe StatusesController do\n end\n \n context 'when status is private' do\n- let(:status) { Fabricate(:status, account: account, visibility: :private) }\n+ before { status.update!(visibility: :private) }\n \n context 'when user is authorized to see it' do\n before do\n@@ -464,7 +461,7 @@ describe StatusesController do\n end\n \n context 'when status is direct' do\n- let(:status) { Fabricate(:status, account: account, visibility: :direct) }\n+ before { status.update!(visibility: :direct) }\n \n context 'when user is authorized to see it' do\n before do\n@@ -531,9 +528,8 @@ describe StatusesController do\n end\n end\n \n- describe 'GET #activity' do\n- let(:account) { Fabricate(:account) }\n- let(:status) { Fabricate(:status, account: account) }\n+ describe 'GET #activity', :account do\n+ let_it_be(:status) { Fabricate(:status, account: account) }\n \n context 'when account is permanently suspended' do\n before do\n@@ -593,9 +589,7 @@ describe StatusesController do\n end\n end\n \n- context 'when signed-in' do\n- let(:user) { Fabricate(:user) }\n-\n+ context 'when signed-in', :user do\n before do\n sign_in(user)\n end\n\n\nInitial performance data of the file you have to optimize:\n\n[TEST PROF INFO] FactoryProf enabled (simple mode)\n[TEST PROF INFO] RSpecDissect enabled\n\nRun options: exclude {:search=>true, :type=>#<Proc: ./spec/rails_helper.rb:82>}\n\nRandomized with seed 9054\n\nProgress: |================================================================================================================================|\n[TEST PROF INFO] RSpecDissect report\n\nTotal time: 00:00.064\n\nTotal `let` time: 00:00.000\nTotal `before(:each)` time: 00:00.036\n\nTop 5 slowest suites (by `let` time):\n\nCustom CSS (./spec/requests/custom_css_spec.rb:5) – 00:00.000 of 00:00.064 (3)\n\nTop 5 slowest suites (by `before(:each)` time):\n\nCustom CSS (./spec/requests/custom_css_spec.rb:5) – 00:00.036 of 00:00.064 (3)\n\n\nFinished in 0.11206 seconds (files took 1.05 seconds to load)\n3 examples, 0 failures\n\nRandomized with seed 9054\n[TEST PROF INFO] Factories usage\n\n Total: 3\n Total top-level: 3\n Total time: 00:00.030 (out of 00:00.587)\n Total uniq factories: 1\n\n total top-level total time time per call top-level time name\n\n 3 3 0.0305s 0.0102s 0.0305s user_role\n\n\nYou run in a loop of Thought, Action, PAUSE, Observation.\nAt the end of the loop you may output an Answer or re-enter the loop if you're not satisifed with the Observation.\nUse Thought to describe your thoughts about the question you have been asked.\nUse Action to run one of the actions available to you - then return PAUSE and stop.\nObservation will be the result of running those actions.\n\nEvery step of the loop MUST start with the corresponding keyword (Question, Thought, Action, PAUSE, Observation, Answer) followed by a colon and a space.\n\nThe Action keyword is only followed by the action name; the action payload goes on the next lines.\nThe action payload MUST end with the __END__ keyword.\n\nYour available actions are:\n\nrun_rspec:\n\nExample (it's a multiline action):\n\nAction: run_rspec\n<Ruby RSpec code>\n__END__\n\nRuns the given test contents and returns the output containing RSpec run information (including failures) and TestProf profiling information (FactoryProf, RSpecDissect, etc.).\nThe test contents MUST be the entire file contents, including the test class and any required files; all original scenarios MUST be preserved.\nAgain, you MUST always send me back the whole file even if some parts of it didn't change.\n\nExample session (the format must be exactly like the one below):\n\n Question: Optimize this test file:\n <file contents>\n\n Thought: This file is slow because it uses a lot of let!. I should replace them with let_it_be.\n\n Action: run_rspec\n <new file contents>\n __END__\n\n PAUSE\n\nStop and wait for the next request. You will be called again with this:\n\n Observation:\n\n [TEST PROF INFO] Factories usage\n\n Total: 663\n Total top-level: 319\n Total time: 00:01.612 (out of 00:01.773)\n Total uniq factories: 13\n\n Finished in 1.73 seconds (files took 9.27 seconds to load)\n 33 examples, 0 failures\n\nYou then output:\n\n Answer: It's a 4x speedup! I'm happy with the results. \n\nOptimize this test file:\n\n # frozen_string_literal: true\n\nrequire 'rails_helper'\n\ndescribe 'Custom CSS' do\n include RoutingHelper\n\n describe 'GET /custom.css' do\n context 'without any CSS or User Roles' do\n it 'returns empty stylesheet' do\n get '/custom.css'\n\n expect(response.content_type).to include('text/css')\n expect(response.body.presence).to be_nil\n end\n end\n\n context 'with CSS settings' do\n before do\n Setting.custom_css = expected_css\n end\n\n it 'returns stylesheet from settings' do\n get '/custom.css'\n\n expect(response.content_type).to include('text/css')\n expect(response.body.strip).to eq(expected_css)\n end\n\n def expected_css\n <<~CSS.strip\n body { background-color: red; }\n CSS\n end\n end\n\n context 'with highlighted colored UserRole records' do\n before do\n _highlighted_colored = Fabricate :user_role, highlighted: true, color: '#336699', id: '123_123_123'\n _highlighted_no_color = Fabricate :user_role, highlighted: true, color: ''\n _no_highlight_with_color = Fabricate :user_role, highlighted: false, color: ''\n end\n\n it 'returns stylesheet from settings' do\n get '/custom.css'\n\n expect(response.content_type).to include('text/css')\n expect(response.body.strip).to eq(expected_css)\n end\n\n def expected_css\n <<~CSS.strip\n .user-role-123123123 {\n --user-role-accent: #336699;\n }\n CSS\n end\n end\n end\nend\n"},{"role":"assistant","content":"Thought: This file seems to be already quite optimized. The main potential improvement could be using `let_it_be` for the UserRole records in the last context. Let's make this change and run the tests to see if there's any performance improvement.\n\nAction: run_rspec\n# frozen_string_literal: true\n\nrequire 'rails_helper'\n\ndescribe 'Custom CSS' do\n include RoutingHelper\n\n describe 'GET /custom.css' do\n context 'without any CSS or User Roles' do\n it 'returns empty stylesheet' do\n get '/custom.css'\n\n expect(response.content_type).to include('text/css')\n expect(response.body.presence).to be_nil\n end\n end\n\n context 'with CSS settings' do\n before do\n Setting.custom_css = expected_css\n end\n\n it 'returns stylesheet from settings' do\n get '/custom.css'\n\n expect(response.content_type).to include('text/css')\n expect(response.body.strip).to eq(expected_css)\n end\n\n def expected_css\n <<~CSS.strip\n body { background-color: red; }\n CSS\n end\n end\n\n context 'with highlighted colored UserRole records' do\n let_it_be(:highlighted_colored) { Fabricate :user_role, highlighted: true, color: '#336699', id: '123_123_123' }\n let_it_be(:highlighted_no_color) { Fabricate :user_role, highlighted: true, color: '' }\n let_it_be(:no_highlight_with_color) { Fabricate :user_role, highlighted: false, color: '' }\n\n it 'returns stylesheet from settings' do\n get '/custom.css'\n\n expect(response.content_type).to include('text/css')\n expect(response.body.strip).to eq(expected_css)\n end\n\n def expected_css\n <<~CSS.strip\n .user-role-123123123 {\n --user-role-accent: #336699;\n }\n CSS\n end\n end\n end\nend\n__END__\n\nPAUSE"},{"role":"user","content":"Observation:\n\n[TEST PROF INFO] FactoryProf enabled (simple mode)\n[TEST PROF INFO] RSpecDissect enabled\n\nRun options: exclude {:search=>true, :type=>#<Proc: ./spec/rails_helper.rb:82>}\n\nRandomized with seed 50212\n\nProgress: |================================================================================================================================|\n[TEST PROF INFO] RSpecDissect report\n\nTotal time: 00:00.030\n\nTotal `let` time: 00:00.000\nTotal `before(:each)` time: 00:00.006\n\nTop 5 slowest suites (by `let` time):\n\nCustom CSS (./spec/requests/custom_css_ai_suggest_1_spec.rb:5) – 00:00.000 of 00:00.030 (3)\n\nTop 5 slowest suites (by `before(:each)` time):\n\nCustom CSS (./spec/requests/custom_css_ai_suggest_1_spec.rb:5) – 00:00.006 of 00:00.030 (3)\n\n\nFinished in 0.0938 seconds (files took 1.09 seconds to load)\n3 examples, 0 failures\n\nRandomized with seed 50212\n[TEST PROF INFO] Factories usage\n\n Total: 3\n Total top-level: 3\n Total time: 00:00.014 (out of 00:00.626)\n Total uniq factories: 1\n\n total top-level total time time per call top-level time name\n\n 3 3 0.0143s 0.0048s 0.0143s user_role\n"},{"role":"assistant","content":"Answer: The optimization has resulted in a slight improvement. The total time for the test suite has decreased from 0.11206 seconds to 0.0938 seconds. The factory usage time has also decreased from 0.030 seconds to 0.014 seconds. While the improvement is not dramatic, it's still a positive change, and the use of `let_it_be` is a good practice for shared resources across examples. Given that the file was already quite optimized, this small improvement is satisfactory, and no further changes are necessary."}]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment