Starter App - Partie 3 - Faker, Bullet et requêtes N+1

Vers la partie précédente
Vers la partie suivante

Dans cette partie nous allons découvrir les gems :
- Faker : qui nous permettra de créer facilement un bon nombre de données
- Bullet : qui facilitera la détection des requêtes N+1 vers notre base de données.

Nous continuons toujours à intégrer ces gems dans notre application "StarterApp".

Définissons quelques associations

# -*- encoding : utf-8 -*-

# fichier client_page.rb

class ClientPage < ActiveRecord::Base

  # Associations

  has_many :contents, :inverse_of => :page,

           :foreign_key => "page_id", :class_name => "ClientPageContent" #, :dependent => :destroy

  has_one  :menu_button, :inverse_of => :page,

           :foreign_key => "page_id", :class_name => "ClientMenuButton"

  

  # Attributs accessibles

  attr_accessible :home, :name, :published, :title, :webdescription, :webtitle

end

# -*- encoding : utf-8 -*-

# Fichier client_page_content.rb

class ClientPageContent < ActiveRecord::Base

  # Associations

  belongs_to :page, :inverse_of => :contents, 

      :foreign_key => "page_id", :class_name => "ClientPage"

  

  # Attributs accessibles

  attr_accessible :body, :css_class, :priority, :title

end

# -*- encoding : utf-8 -*-

# client_menu_button.rb

class ClientMenuButton < ActiveRecord::Base

  # Associations

  belongs_to :page, :inverse_of => :menu_button, 

      :foreign_key => "page_id", :class_name => "ClientPage"



  # Attributs accessibles

  attr_accessible :name, :priority

end

Gem Faker

group :development do

  # ...

  gem "faker" # https://github.com/stympy/faker

end

$ bundle install

# -*- encoding : utf-8 -*-

# Nous devons inclure Faker pour pouvoir l'utiliser ensuite

require 'faker'



namespace :db do 



  desc "Insère un bon paquet de données dans notre base de données pour nos pages"

  task :sample_datas => :environment do 

    # On arrête cette tâche si nous ne sommes pas en environnement de développement

    unless Rails.env == "development"

      puts "Vous n'êtes pas en environnement de développement"

      return

    end

    

    # Facultatif, si vous souhaitez supprimer toutes les données précédemment créées

    # Le problème c'est que toutes les données d etoutes les tables seront supprimées

    # Rake::Task['db:reset'].invoke 

    

    # Moi je préfère cibler les tables en particulier : 

    ClientPage.delete_all

    ClientPageContent.delete_all

    ClientMenuButton.delete_all

    

    # On précise à Faker que l'on souhaite des données françaises. 

    # Dans notre cas, cela ne va rien changer, mais pour la création d'utilisateur, ça change le format

    # de l'adresse, du numéro de téléphone, etc. 

    Faker::Config.locale = :fr

    

    # Nous allons exécuter ce bout de code 5 fois histoire de ne pas avoir trop de pages

    5.times do |n|

      # Nous allons commencer par la création d'une page. 

      page_name = Faker::Lorem.word  # Génère un mot aléatoirement

      title = Faker::Lorem.sentence    # Génère une phrase aléatoirement

      webtitle = Faker::Lorem.words # Génère une série de mots aléatoires

      webdescription = Faker::Lorem.paragraph # Génère un paragraphe rempli de mots aléatoires

      published = (n == 1) ? false : true # On ne publie pas la 1ère page

      home = (n == 4) ? true : false # La 4ème page sera notre page d'accueil

      

      # On crée la page avec ces données :

      client_page = ClientPage.create(

        :title => title,

        :webtitle => webtitle,

        :webdescription => webdescription,

        :name => page_name, 

        :published => published,

        :home => home)

      

      # Si la page a une erreur, on l'affiche et on arrête la boucle

      if client_page.errors.any?

        puts client_page.errors.full_messages

        return

      else

        # Ca ne fait jamais de mal de savoir ce qu'il se passe : 

        puts "Page créée : nom = #{client_page.name}"

      end

      

      # Maintenant qu'on a notre page, on peut continuer avec les autres éléments : 

      # Continuons avec le bouton : 

      button_priority = n # Le bouton aura la priorité égale à la valeur actuelle de n, on ne se casse pas la tête

      button_name = page_name # Ou un nouveau mot aléatoire, mais bon, autant que le bouton ait le même nom que la page

      

      # Et on crée le bouton : 

      page_button = client_page.build_menu_button(

        :priority => button_priority,

        :name => button_name

      ) 

      

      unless page_button.save

        # Si la sauvegarde échoue, idem, on affiche les erreurs et on quitte

        puts page_button.errors.full_messages

        return

      else

        puts "Bouton de la page #{client_page.name} créé : nom = #{page_button.name}" 

      end

      

      # Enfin on va ajouter du contenu aléatoire à nos pages

      # Pour cela on va tirer un nombre aléatoire qui déterminera le nombre de 'contenus' que notre page contiendra

      nb_content = rand(1..6)

      

      nb_content.times do |c|

        content_title = Faker::Lorem.sentence

        content_priority = c

        content_body = Faker::Lorem.paragraphs # Génère un nombre de paragraphes aléatoires remplis de mots aléatoires

        # On laisse css_class vide

        

        page_content = client_page.contents.new(

          :title => content_title,

          :priority => content_priority,

          :body => content_body

        )

        

        # Idem que précédemment, en cas d'erreur, on quitte

        unless page_content.save

          puts page_content.errors.full_messages

          return

        else

          puts "Contenu de la page #{client_page.name} créé : titre = #{page_content.title}"

        end

      end

    end

    # And voila ! Avec ça nous avons créé 5 pages remplies de contenu aléatoire !

  end 



end 

Concernant les méthodes Faker utilisées. Je vous rassure, je ne les ai pas devinées ni sorties de derrière mon chapeau. Je vous l'accorde, il y a peu de documentation concernant cette gem. Il nous faut donc explorer les sources sur GitHub. Fort heureusement, il n'y a pas 36000 méthodes non plus et toutes celles qui nous intéressent se trouvent dans le dossier lib/faker. Explorez les différents fichiers de ce dossier pour voir toutes les méthodes fournies par Faker.

$ rake db:sample_datas

Gem Bullet

<nav>

	<ul>

		<% ClientMenuButton.order("priority DESC").all.each do |button| %>

			<li><%= link_to button.name, client_page_path(button.page.id) %></li>

                        <%# le .id est facultatif %>

		<% end %>

	</ul>

</nav>

# fichier routes.rb

#...

get "pages/:page_id" => "client_pages#show", :as => :client_page

#...

# -*- encoding : utf-8 -*-

class ClientPagesController < ApplicationController

  

  # route_path, on récupère la page d'accueil et on l'affiche si elle existe. Sinon on affiche une page d'accueil par défaut. 

  def home

    @page = ClientPage.where(:home => true).first

    

    respond_to do |format|

      if @page.nil?

        format.html { render :home }

      else

        format.html { render :show }

      end

    end

  end

  

  # GET "pages/:page_id" 

  def show

    @page = ClientPage.find(params[:page_id].to_i)

    

    respond_to do |format|

      format.html

    end

  end

end

<% ClientMenuButton.order("priority DESC").all.each do |button| %>

	<li><%= link_to button.name, client_page_path(button.page.id) %></li>

<% end %>

  Rendered client_pages/show.html.erb within layouts/application (0.1ms)

  ClientMenuButton Load (0.2ms)  SELECT `client_menu_buttons`.* FROM `client_menu_buttons` ORDER BY priority DESC

  ClientPage Load (0.3ms)  SELECT `client_pages`.* FROM `client_pages` WHERE `client_pages`.`id` = 6 LIMIT 1

  ClientPage Load (0.3ms)  SELECT `client_pages`.* FROM `client_pages` WHERE `client_pages`.`id` = 5 LIMIT 1

  ClientPage Load (0.2ms)  SELECT `client_pages`.* FROM `client_pages` WHERE `client_pages`.`id` = 4 LIMIT 1

  ClientPage Load (0.2ms)  SELECT `client_pages`.* FROM `client_pages` WHERE `client_pages`.`id` = 3 LIMIT 1

  ClientPage Load (0.1ms)  SELECT `client_pages`.* FROM `client_pages` WHERE `client_pages`.`id` = 2 LIMIT 1

Completed 200 OK in 61ms (Views: 38.2ms | ActiveRecord: 5.6ms)

<% ClientMenuButton.includes(:page).order("priority DESC").all.each do |button| %>

	<li><%= link_to button.name, client_page_path(button.page.id) %></li>

<% end %>

  Rendered client_pages/show.html.erb within layouts/application (0.0ms)

  ClientMenuButton Load (0.2ms)  SELECT `client_menu_buttons`.* FROM `client_menu_buttons` ORDER BY priority DESC

  ClientPage Load (0.2ms)  SELECT `client_pages`.* FROM `client_pages` WHERE `client_pages`.`id` IN (6, 5, 4, 3, 2)

Completed 200 OK in 13ms (Views: 11.2ms | ActiveRecord: 0.7ms)

Quelques explications Comme vous pouvez le constater le mécanisme est tout simple. En utilisant includes(:page), Ruby On Rails sait qu'il doit récupérer toutes les pages dont les ids correspondent aux valeurs de la clé de l'association (dans notre cas :page_id). Pour ce faire, comme Rails a déjà chargé la table des boutons, il ne fait que sélectionner toutes les valeurs de la colonne page_id. Il réinjecte ensuite ces valeurs dans une condition WHERE dès que nous souhaitons récupérer la première association. Pour l'association suivante, plus besoin de requête vers la base de données, Rails a déjà récupéré la donnée et l'a stocké dans sa mémoire cache, il la récupère donc de là et c'est beaucoup plus rapide !

<% ClientMenuButton.includes(:page).where("client_pages.published = ? ", true).order("priority DESC").all.each do |button| %>

	<li><%= link_to button.name, client_page_path(button.page.id) %></li>

<% end %>

Pour aller un peu plus loin. Comment faire pour pré-sélectionner de la même façon l'association d'une association ? Par exemple, nous souhaiterions afficher les contenus de toutes les pages ainsi que leurs illustrations, qui sont stockées dans une autre table avec les associations suivantes: page :has_many => :contents et content :has_many => :pictures.

Et bien c'est tout à fait possible, lorsque nous récupérons les pages, il suffit de préciser à Ruby On Rails d'inclure également la deuxième association. (On parle de nested association car c'est une association dans une autre) :

@pages = Page.includes(:contents => [ :pictures])

Category.includes(:posts => [{:comments => :users}, :tags], :articles).all

 has_many :comments, :include => [:users] 

group :development do

  # ...

  gem "bullet" # https://github.com/flyerhzm/bullet

end

# Configuration de bullet

config.after_initialize do

  Bullet.enable = true # Active bullet

  Bullet.alert = false # Active un pop up javascript lorsqu'une requête N+1 est détectée

  Bullet.bullet_logger = true # Crée un fichier log/bullet.log et y store l'historique des requêtes N+1 détectées, c'est mon option favorite

  Bullet.console = true # Affiche une notification javascript dans la console de votre navigateur (via la commande javascript console.log)

  Bullet.growl = false # Affiche une notification dans Growl, si vous êtes sur Mac. Cf dépôt github

  # Bullet.xmpp # envoie des notifications xmpp / jabber au compte spécifié, cf dépôt github

  Bullet.rails_logger = false # Ajoute des notifications dans les journaux du serveur. Pas vraiment nécessaire si vous avez activé bullet_logger.

  Bullet.airbrake = false # Ajoute des notifications à airbrake

  Bullet.disable_browser_cache = false # Désactive le cache du browser. Mettez 'true' si vous faites face à des évènements bizarres au niveau de votre navigateur (javascript non chargé en totalité par exemple)

end

Uniform Notifier 192.168.1.5:33

user: machin

N+1 Query detected

  ClientMenuButton => [:page]  Add to your finder: :include => [:page]N+1 Query method call stack

  path_to_your_app/StarterApp/app/views/layouts/application.html.erb:14:in `block in _app_views_layouts_application_html_erb__598491937_76627910'

  path_to_your_app//StarterApp/app/views/layouts/application.html.erb:13:in `each'

  path_to_your_app//StarterApp/app/views/layouts/application.html.erb:13:in `_app_views_layouts_application_html_erb__598491937_76627910'

  path_to_your_app//StarterApp/app/controllers/client_pages_controller.rb:12:in `block (2 levels) in home'

  path_to_your_app//StarterApp/app/controllers/client_pages_controller.rb:8:in `home' 

<% ClientMenuButton.includes(:page).where("client_pages.published = ? ", true).order("priority DESC").all.each do |button| %>

	<li><%= link_to button.name, client_page_path(button.page.id) %></li>

<% end %>

Bullet indique également lorsqu'une instruction includes est superflue. Attention toutefois, car dans ce cas là, il n'indique pas où il l'a détectée dans votre code (malheureusement). De plus, il peut vous afficher cette notification même si l'include est nécessaire. Cela arriverait notamment si nous affichions un bouton auquel aucune page n'est associée. En effet, dans ce cas là, Bullet détecterait qu'il n'y a pas de page associée et donc que l'includes ne serait pas nécessaire. Oui... mais il l'est pour tous les autres boutons.

Bullet indique également lorsque vous auriez besoin d'ajouter un counter_cache. Pour faire bref, un counter_cache est nécessaire chaque fois que vous utilisez la méthode count pour compter des données, par exemple : page.contents.count. En Ruby On Rails, il serait alors nécessaire de créer une nouvelle colonne dans la table pages nommée : contents_count puis de préciser l'option :counter_cache => true au niveau de l'association belongs_to du model Content. Ce qui donnerait :

belongs_to :page, :counter_cache => true

Ceci étant fait, cela permettrait de s'affranchir de la requête vers la base de données pour effectuer le comptage.

Oui mais ! Il existe de nombreux bugs dans Ruby On Rails 3. La colonne censée tenir le compte du nombre d'objets associés n'est pas toujours correctement mise à jour, notamment lors de la destruction d'objets... Comme l'en atteste la création de cette gem : counter_culture nous ne pouvons pas réellement nous fier à Rails pour ce qui concerne du counter_cache. D'ailleurs, je vous conseille vivement l'utilisation de la gem counter_culture si vous souhaitez utiliser cette méthode de counter_cache. Mais même là, les développeurs de la gem précisent qu'il faut faire un petit rafraîchissement de tous les compteurs chaque semaine... Bref, du coup, moi je préfère garder mon instruction count.

Petits bonus de fin

<% @page.contents.each do |content| %>

	<h1><%= content.title %></h1>

	<%= simple_format content.body %>

<% end %>

<% ClientMenuButton.includes(:page).where("client_pages.published = ? ", true).order("priority DESC").all.each do |button| %>

	<li>

		<%= link_to button.name, client_page_path(button.page.id) %>

		<%= "- Actuel" if @page == button.page %>

	</li>

<% end %>

group :development do

  # ...

  gem 'meta_request', '0.2.1' # https://github.com/dejan/rails_panel

end

Index -- Article précédent: Un Kip à Munich... Ca donne quoi au juste ? -- Article suivant: 3 conseils pour étoffer les descriptions de ses produits

• 
• ruby on rails
• starter app
• tutoriel