Include records on API Order / Product queries

[fastjames]

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.

[jacobherrington]

LGTM! Thanks

[kennyadsl]

Thanks! I just left some code formatting opinions.

On the performance side I've tried the /api/orders endpoint locally (here's a report) and I can't see huge differences. I've done this test with a sandbox and ~250 orders so I imagine the difference is more evident with a lot of records, right?

[kennyadsl]

What about reformatting code as:

orders_includes = [
  :user,
  :payments,
  :adjustments,
  :line_items
]

@orders = paginate(
  Spree::Order
    .includes(orders_includes)
    .ransack(params[:q])
    .result
)
respond_with(@orders)

?

I think this reduces the complexity since:

• we have less variables around;
• I think it's better to rename order_includes into orders_includes since it refers to a query to retrieve a collection of orders;
• having the includes called before ransack and result looks more natural to me, even if I don't have strong opinion here.

With yield_self of Ruby 2.5 we could have simply done:

@orders = Spree::Order
  .includes(orders_includes)
  .ransack(params[:q])
  .result
  .yield_self { |orders| paginate(orders) }

respond_with(@orders)

which is much cleaner IMO but we still need to support older Ruby versions. 😢

Also, what do you think about moving order_includes as a private method in the controller?

[fastjames]

Agreed on maintaining some level of backcompat. I have made this change.

[kennyadsl]

Same here:

# Let's evaluate moving this into a controller's private method
products_includes = [
  :variants,
  :option_types,
  :product_properties,
  { classifications: :taxon }
]

@products = product_scope
  .includes(products_includes)
  .ransack(params[:q])
  .result

WDYT?

[fastjames]

This seems reasonable, done.

[kennyadsl]

Thanks!