Include records on API Order / Product queries

When querying for Orders or Products via the API, the significant number of related records needed to render the JSON for each Order / Product can lead to a lot of extra database traffic. By using `includes` we can reduce the query traffic (and thus response time) significantly.
solidusio · Jan 4, 2019 · c2ad54d · c2ad54d
1 parent 942ec5c
commit c2ad54d
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/api/app/controllers/spree/api/orders_controller.rb b/api/app/controllers/spree/api/orders_controller.rb
@@ -51,7 +51,18 @@ def empty
 
       def index
         authorize! :index, Order
-        @orders = paginate(Spree::Order.ransack(params[:q]).result)
+        orders_includes = [
+          :user,
+          :payments,
+          :adjustments,
+          :line_items
+        ]
+        @orders = paginate(
+          Spree::Order
+            .ransack(params[:q])
+            .result
+            .includes(orders_includes)
+        )
         respond_with(@orders)
       end
 

diff --git a/api/app/controllers/spree/api/products_controller.rb b/api/app/controllers/spree/api/products_controller.rb
@@ -8,7 +8,16 @@ def index
           ids = params[:ids].split(",").flatten
           @products = product_scope.where(id: ids)
         else
-          @products = product_scope.ransack(params[:q]).result
+          products_includes = [
+            :variants,
+            :option_types,
+            :product_properties,
+            { classifications: :taxon }
+          ]
+          @products = product_scope
+                        .ransack(params[:q])
+                        .result
+                        .includes(products_includes)
         end
 
         @products = paginate(@products.distinct)