Optimise performance with let_it_be and before_all

Author: IgorArkhipov

app/services/exporter/service.rb

@@ -5,8 +5,8 @@ class Service
     attr_reader :user
 
     EXPORTERS = [
-      Articles,
-      Comments,
+      Exporter::Articles,
+      Exporter::Comments,
     ].freeze
 
     def initialize(user)

spec/controllers/internal_users_controller_spec.rb

@@ -1,18 +1,18 @@
 require "rails_helper"
 
 RSpec.describe "internal/users", type: :request do
-  let(:user) { create(:user) }
-  let(:user2) { create(:user) }
-  let(:user3) { create(:user) }
-  let(:super_admin) { create(:user, :super_admin) }
-  let(:article) { create(:article, user: user) }
-  let(:article2) { create(:article, user: user2) }
+  let_it_be(:user) { create(:user) }
+  let_it_be(:user2) { create(:user) }
+  let_it_be(:user3) { create(:user) }
+  let_it_be(:super_admin) { create(:user, :super_admin) }
+  let_it_be(:article) { create(:article, user: user) }
+  let_it_be(:article2) { create(:article, user: user2) }
 
   before do
     sign_in super_admin
-    user
-    user2
-    Delayed::Worker.new(quiet: true).work_off
+  end
+
+  before_all do
     dependents_for_offending_user_article
     offender_activity_on_other_content
   end
@@ -28,7 +28,6 @@ def dependents_for_offending_user_article
     create(:reaction, reactable: comment2, reactable_type: "Comment", user: user2)
     # create user3 reaction to offending article
     create(:reaction, reactable: article, reactable_type: "Article", user: user3, category: "like")
-    Delayed::Worker.new(quiet: true).work_off
   end
 
   def offender_activity_on_other_content
@@ -38,7 +37,6 @@ def offender_activity_on_other_content
     comment = create(:comment, commentable_type: "Article", commentable: article2, user: user)
     # user3 reacts to offender comment
     create(:reaction, reactable: comment, reactable_type: "Comment", user: user3)
-    Delayed::Worker.new(quiet: true).work_off
   end
 
   context "when deleting user" do
@@ -62,7 +60,6 @@ def create_mutual_follows
       create_mutual_follows
       create_mention
       create(:badge_achievement, rewarder_id: 1, rewarding_context_message: "yay", user_id: user.id)
-      Delayed::Worker.new(quiet: true).work_off
     end
 
     it "raises a 'record not found' error after deletion" do
@@ -90,7 +87,6 @@ def create_mutual_follows
   context "when banishing user" do
     def banish_user
       post "/internal/users/#{user.id}/banish"
-      Delayed::Worker.new(quiet: true).work_off
       user.reload
     end
 

spec/models/article_spec.rb

@@ -8,7 +8,7 @@ def build_and_validate_article(*args)
     article
   end
 
-  let(:user) { create(:user) }
+  let_it_be(:user) { create(:user) }
   let(:article) { create(:article, user_id: user.id) }
 
   it { is_expected.to validate_uniqueness_of(:canonical_url).allow_blank }
@@ -40,7 +40,7 @@ def build_and_validate_article(*args)
   end
 
   it "reject future dates" do
-    expect(build(:article, with_date: true, date: "01/01/2020").valid?).to be(false)
+    expect(build(:article, with_date: true, date: DateTime.now + 1.day).valid?).to be(false)
   end
 
   it "has proper username" do
@@ -107,7 +107,7 @@ def build_and_validate_article(*args)
   end
 
   describe "#slug" do
-    let(:title) { "hey This' is$ a SLUG" }
+    let_it_be(:title) { "hey This' is$ a SLUG" }
     let(:article0) { build(:article, title: title, published: false) }
     let(:article1) { build(:article, title: title, published: false) }
 
@@ -142,8 +142,8 @@ def build_and_validate_article(*args)
 
   context "when provided with body_markdown" do
     let(:test_article) { build(:article, title: title) }
-    let(:title) { "Talk About It, Justify It" }
-    let(:slug) { "talk-about-it-justify-it" }
+    let_it_be(:title) { "Talk About It, Justify It" }
+    let_it_be(:slug) { "talk-about-it-justify-it" }
 
     before { test_article.validate }
 
@@ -175,7 +175,7 @@ def build_and_validate_article(*args)
     end
 
     describe "#canonical_url" do
-      let(:article_with_canon_url) { build(:article, with_canonical_url: true) }
+      let_it_be(:article_with_canon_url) { build(:article, with_canonical_url: true) }
 
       before do
         article_with_canon_url.validate
@@ -431,7 +431,7 @@ def build_and_validate_article(*args)
     end
 
     context "when unpublished" do
-      let(:article) { create(:article, published: false) }
+      let_it_be(:article) { create(:article, published: false) }
 
       it "does not update the hotness score" do
         article.save

spec/models/comment_spec.rb

@@ -1,14 +1,14 @@
 require "rails_helper"
 
 RSpec.describe Comment, type: :model do
-  let(:user)                  { create(:user, created_at: 3.weeks.ago) }
-  let(:user2)                 { create(:user) }
-  let(:article)               { create(:article, user_id: user.id, published: true) }
-  let(:article_with_video)    { create(:article, :video, user_id: user.id, published: true) }
-  let(:comment)               { create(:comment, user_id: user2.id, commentable_id: article.id) }
-  let(:video_comment)         { create(:comment, user_id: user2.id, commentable_id: article_with_video.id) }
-  let(:comment_2)             { create(:comment, user_id: user2.id, commentable_id: article.id) }
-  let(:child_comment) do
+  let_it_be(:user)                  { create(:user, created_at: 3.weeks.ago) }
+  let_it_be(:user2)                 { create(:user) }
+  let_it_be(:article)               { create(:article, user_id: user.id, published: true) }
+  let_it_be(:article_with_video)    { create(:article, :video, user_id: user.id, published: true) }
+  let_it_be(:comment)               { create(:comment, user_id: user2.id, commentable_id: article.id) }
+  let_it_be(:video_comment)         { create(:comment, user_id: user2.id, commentable_id: article_with_video.id) }
+  let_it_be(:comment_2)             { create(:comment, user_id: user2.id, commentable_id: article.id) }
+  let_it_be(:child_comment) do
     build(:comment, user_id: user.id, commentable_id: article.id, parent_id: comment.id)
   end
 

spec/rails_helper.rb

@@ -12,6 +12,7 @@
 require "pundit/rspec"
 require "webmock/rspec"
 require "test_prof/recipes/rspec/before_all"
+require "test_prof/recipes/rspec/let_it_be"
 require "test_prof/recipes/rspec/sample"
 
 # Requires supporting ruby files with custom matchers and macros, etc, in

spec/requests/notifications_spec.rb

@@ -1,8 +1,8 @@
 require "rails_helper"
 
 RSpec.describe "NotificationsIndex", type: :request do
-  let(:dev_account) { create(:user) }
-  let(:user) { create(:user) }
+  let_it_be(:dev_account) { create(:user) }
+  let_it_be(:user) { create(:user) }
 
   before do
     allow(User).to receive(:dev_account).and_return(dev_account)
@@ -71,9 +71,9 @@ def mock_follow_notifications(amount)
     end
 
     context "when a user has new reaction notifications" do
-      let(:article1)                   { create(:article, user_id: user.id) }
-      let(:article2)                   { create(:article, user_id: user.id) }
-      let(:special_characters_article) { create(:article, user_id: user.id, title: "What's Become of Waring") }
+      let_it_be(:article1)                   { create(:article, user_id: user.id) }
+      let_it_be(:article2)                   { create(:article, user_id: user.id) }
+      let_it_be(:special_characters_article) { create(:article, user_id: user.id, title: "What's Become of Waring") }
 
       before { sign_in user }
 
@@ -141,29 +141,32 @@ def mock_heart_reaction_notifications(amount, categories, reactable = article1)
     end
 
     context "when a user has a new comment notification" do
-      let(:user2)    { create(:user) }
-      let(:article)  { create(:article, user_id: user.id) }
-      let(:comment)  { create(:comment, user_id: user2.id, commentable_id: article.id, commentable_type: "Article") }
+      let_it_be(:user2)    { create(:user) }
+      let_it_be(:article)  { create(:article, user_id: user.id) }
+      let_it_be(:comment)  { create(:comment, user_id: user2.id, commentable_id: article.id, commentable_type: "Article") }
 
       before do
         sign_in user
         Notification.send_new_comment_notifications_without_delay(comment)
-        get "/notifications"
       end
 
       it "renders the correct message" do
+        get "/notifications"
         expect(response.body).to include "commented on"
       end
 
       it "does not render the moderation message" do
+        get "/notifications"
         expect(response.body).not_to include "As a trusted member"
       end
 
       it "renders the article's path" do
+        get "/notifications"
         expect(response.body).to include article.path
       end
 
       it "renders the comment's processed HTML" do
+        get "/notifications"
         expect(response.body).to include comment.processed_html
       end
 
@@ -174,22 +177,26 @@ def mock_heart_reaction_notifications(amount, categories, reactable = article1)
       end
 
       it "does not render the reaction as reacted if it was not reacted on" do
+        get "/notifications"
         expect(response.body).not_to include "reaction-button reacted"
       end
     end
 
     context "when a user has a new moderation notification" do
-      let(:user2)    { create(:user) }
-      let(:article)  { create(:article, user_id: user.id) }
-      let(:comment)  { create(:comment, user_id: user2.id, commentable_id: article.id, commentable_type: "Article") }
+      let_it_be(:user2)    { create(:user) }
+      let_it_be(:article)  { create(:article, user_id: user.id) }
+      let_it_be(:comment)  { create(:comment, user_id: user2.id, commentable_id: article.id, commentable_type: "Article") }
 
       before do
-        user.add_role :trusted
         sign_in user
         Notification.send_moderation_notification_without_delay(comment)
         get "/notifications"
       end
 
+      before_all do
+        user.add_role :trusted
+      end
+
       it "renders the proper message" do
         expect(response.body).to include "As a trusted member"
       end
@@ -204,23 +211,25 @@ def mock_heart_reaction_notifications(amount, categories, reactable = article1)
     end
 
     context "when a user has a new welcome notification" do
+      let_it_be(:broadcast) { create(:broadcast, :onboarding) }
+
       before do
         sign_in user
+        Notification.send_welcome_notification_without_delay(user.id)
+        get "/notifications"
       end
 
       it "renders the welcome notification" do
-        broadcast = create(:broadcast, :onboarding)
-        Notification.send_welcome_notification_without_delay(user.id)
-        get "/notifications"
         expect(response.body).to include broadcast.processed_html
       end
     end
 
     context "when a user has a new badge notification" do
+      let_it_be(:badge) { create(:badge) }
+      let_it_be(:badge_achievement) { create(:badge_achievement, user: user, badge: badge) }
+
       before do
         sign_in user
-        badge = create(:badge)
-        badge_achievement = create(:badge_achievement, user: user, badge: badge)
         Notification.send_new_badge_notification_without_delay(badge_achievement)
         get "/notifications"
       end
@@ -243,9 +252,9 @@ def mock_heart_reaction_notifications(amount, categories, reactable = article1)
     end
 
     context "when a user has a new mention notification" do
-      let(:user2)    { create(:user) }
-      let(:article)  { create(:article, user_id: user.id) }
-      let(:comment) do
+      let_it_be(:user2)    { create(:user) }
+      let_it_be(:article)  { create(:article, user_id: user.id) }
+      let_it_be(:comment) do
         create(
           :comment,
           user_id: user2.id,
@@ -256,13 +265,15 @@ def mock_heart_reaction_notifications(amount, categories, reactable = article1)
       end
 
       before do
-        comment
-        Mention.create_all_without_delay(comment)
-        Notification.send_mention_notification_without_delay(Mention.first)
         sign_in user
+        Notification.send_mention_notification_without_delay(Mention.first)
         get "/notifications"
       end
 
+      before_all do
+        Mention.create_all_without_delay(comment)
+      end
+
       it "renders the proper message" do
         expect(response.body).to include "mentioned you in a comment"
       end
@@ -273,16 +284,19 @@ def mock_heart_reaction_notifications(amount, categories, reactable = article1)
     end
 
     context "when a user has a new article notification" do
-      let(:user2)    { create(:user) }
-      let(:article)  { create(:article, user_id: user.id) }
+      let_it_be(:user2)    { create(:user) }
+      let_it_be(:article)  { create(:article, user_id: user.id) }
 
       before do
-        user2.follow(user)
-        Notification.send_to_followers_without_delay(article, "Published")
         sign_in user2
+        Notification.send_to_followers_without_delay(article, "Published")
         get "/notifications"
       end
 
+      before_all do
+        user2.follow(user)
+      end
+
       it "renders the proper message" do
         expect(response.body).to include "made a new post:"
       end