Independent Study. Creating use of bullet gem and .includes to speed up db accesses #2171

harshkachhadia · 2021-12-17T20:56:50Z

Project Description

This project focuses on increasing page load speed by reducing number of db queries by solving N+1 problem in rails.
N+1 problem is solved at various places, as seen in files changes in this project, by implementing eager loading with the help of 'includes' method.
'Bullet' gem has been used to detect the location in expertiza code, where eager loading needs to be implemented using 'includes' method in order to reduce the number of queries made to database.

Team
Dr. Edward Gehringer(efg)(mentor)

Harsh Kachhadia (harshkachhadia)
Tirth Patel (tirthpatel7498)

expertiza-travisci-bot · 2021-12-17T20:58:47Z

Hey @harshkachhadia,
Something went wrong with the build.

TravisCI finished with status errored, which means the build failed because of something unrelated to the tests, such as a problem with a dependency or the build process itself.

View build log

expertiza-bot · 2021-12-20T15:28:29Z

	1 Message
💬	Thanks for the pull request, and welcome! 🎉 The Expertiza team is excited to review your changes, and you should hear from us soon. This repository is being automatically checked for code quality issues using `Code Climate`. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a pull request is considered ready to review. If you have any questions, please send email to expertiza-support@lists.ncsu.edu.

UUID		3 Warnings
ecaa	⚠️	There are code changes, but no corresponding tests. Please include tests if this PR introduces any modifications in behavior.
c951	⚠️	You should commit changes to the DB schema (`db/schema.rb`) only if you have created new DB migrations. Please double check your code. If you did not aim to change the DB, please revert the DB schema changes.
c51d	⚠️	You are modifying `Gemfile` or `Gemfile.lock`, please double check whether it is necessary. You are suppose to add a new gem only if you have a very good reason. Try to use existing gems instead. Please revert changes to `Gemfile.lock` made by the IDE.

Generated by expertiza-bot

coveralls · 2021-12-20T15:40:48Z

Coverage remained the same at 39.31% when pulling 8b15480 on harshkachhadia:beta into eecd728 on expertiza:beta.

coveralls · 2021-12-20T15:40:48Z

Coverage decreased (-7.4%) to 31.886% when pulling 5901657 on harshkachhadia:beta into eecd728 on expertiza:beta.

johnbumgardner · 2021-12-20T19:00:35Z

Gemfile.lock

@@ -698,4 +703,4 @@ DEPENDENCIES
  zip-zip

 BUNDLED WITH
-   1.16.6
+   1.17.3


please run bundle with 1.16.6

johnbumgardner · 2021-12-20T19:01:32Z

app/models/instructor.rb

@@ -44,12 +44,14 @@ def self.get_user_list(user)
      participants << course.get_participants
    end
    assignments = Assignment.where(instructor_id: user.id)
-    assignments.each do |assignment|
+    #Line 48 implements eager loading using 'includes' method. For detail, visit: http://tiny.cc/9aomuz
+    assignments.includes([:participants]).each do |assignment|
      participants << assignment.participants
    end
    participants.each do |p_s|


refactor p_s to participant. variable name is unclear

The only change we made in line 5 was to add

.includes([:participants]) + comment

other than this, all the code is as it was before. I am assuming it should be fine as it was already there in the beta branch before we even started working.

johnbumgardner · 2021-12-20T19:02:15Z

app/views/shared/_flash_notifications.html.erb

@@ -1,7 +1,8 @@
 <%# this page will display the notifications as a flash message Randal Myers, 22 March 2017 %>

 <% course_ids = [] %>
-<% current_user.participants.each{|p| course_ids << p.assignment.course.id if p.assignment and p.assignment.course} %>
+<%#Line 5 implements eager loading using 'includes' method. For detail, visit: http://tiny.cc/9aomuz%>
+<% current_user.participants.includes(:assignment, assignment: [:course]).each{|p| course_ids << p.assignment.course.id if p.assignment and p.assignment.course} %>


use && instead of and

The only change we made in line 5 was to add

.includes(:assignment, assignment: [:course]) + comment

other than this, all the code is as it was before. I am assuming it should be fine as it was already there in the beta branch before we even started working.

johnbumgardner · 2021-12-20T19:02:43Z

config/environments/development.rb

+    Bullet.alert = true
+    Bullet.bullet_logger = true
+    Bullet.console = true
+    Bullet.rails_logger = true


do we need to be logging these when we merge this project in?

We won't need logging when we merge. I will turn all these to 'false'. This configuration is for 'bullet gem', which helps in detecting N+1 problems in the application using logging. This can be later turned to 'true' if someone wishes to find and resolve N+1 issues in future codebase.

johnbumgardner

fix gems

johnbumgardner · 2022-02-02T18:36:28Z

Gemfile.lock

    no_proxy_fix (0.1.2)
-    nokogiri (1.9.1)
+    nokogiri (1.10.10)


this needs to be usable with ruby version 2.2.7

Harsh Mansukhlal Kachhadia and others added 3 commits November 16, 2021 19:26

"Initializing beta version with bullet gem"

24f9cd5

N+1 fixes

9f8c72b

Fetching changes from original expertiza beta branch

291c96e

harshkachhadia and others added 11 commits December 17, 2021 16:02

Removing whitespace changes from code

a9a5f9c

Adding newline at end of file

6f8959a

Resolving Gemfile.lock merge conflicts

28adf63

Resolving failing build issues

596a792

Resolving failing build issues

2a70427

Added comments to the code changes

fa867ca

Added comments to the code changes

76eab1f

Trying to fix bullet gem dependency issues

de6c2e7

Trying to fix bullet gem dependency issues

ce41cdc

Trying to fix bullet gem dependency issues

96ab295

Trying to fix bullet gem dependency issues

5901657

harshkachhadia added 2 commits December 20, 2021 11:17

Fixing failing tests

01a5d27

Fixing failing tests

033ad36

johnbumgardner requested changes Dec 20, 2021

View reviewed changes

harshkachhadia and others added 3 commits December 23, 2021 19:20

Added comment in Gemfile and turned bullet gem loggers off

8b15480

Gemfile bundled with bundler version 1.16.6

e0563ef

Merge branch 'beta' into beta

8111a03

johnbumgardner self-assigned this Feb 2, 2022

johnbumgardner added main needs manual testing Needs Review refactor labels Feb 2, 2022

johnbumgardner requested changes Feb 2, 2022

View reviewed changes

Gemfile.lock

no_proxy_fix (0.1.2)

nokogiri (1.9.1)

nokogiri (1.10.10)

Copy link

Collaborator

johnbumgardner Feb 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this needs to be usable with ruby version 2.2.7

johnbumgardner closed this Feb 3, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Independent Study. Creating use of bullet gem and .includes to speed up db accesses #2171

Independent Study. Creating use of bullet gem and .includes to speed up db accesses #2171

harshkachhadia commented Dec 17, 2021 •

edited

expertiza-travisci-bot commented Dec 17, 2021 •

edited

expertiza-bot commented Dec 20, 2021

coveralls commented Dec 20, 2021 •

edited

coveralls commented Dec 20, 2021

johnbumgardner Dec 20, 2021

harshkachhadia Dec 24, 2021

johnbumgardner Dec 20, 2021

harshkachhadia Dec 24, 2021

johnbumgardner Dec 20, 2021

harshkachhadia Dec 24, 2021

johnbumgardner Dec 20, 2021

harshkachhadia Dec 24, 2021

johnbumgardner left a comment

johnbumgardner Feb 2, 2022

Independent Study. Creating use of bullet gem and .includes to speed up db accesses #2171

Independent Study. Creating use of bullet gem and .includes to speed up db accesses #2171

Conversation

harshkachhadia commented Dec 17, 2021 • edited

expertiza-travisci-bot commented Dec 17, 2021 • edited

expertiza-bot commented Dec 20, 2021

coveralls commented Dec 20, 2021 • edited

coveralls commented Dec 20, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

johnbumgardner left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

harshkachhadia commented Dec 17, 2021 •

edited

expertiza-travisci-bot commented Dec 17, 2021 •

edited

coveralls commented Dec 20, 2021 •

edited