Model include doesn't handle 'hasMany through' correctly

[raymondfeng]

https://groups.google.com/forum/#!topic/loopbackjs/PWB4naSgYZg

[raymondfeng]

This should have been fixed by #86
and #89.

[bajtos]

We should add an integration test to loopback for this: setup models with "hasMany through", perform a REST request with "include" field and verify that the related objects were included.

[bajtos]

I started to write the unit-test and it seems those two pull requests did not fix the issue fully.

Consider the following setup:

 var product = app.model(
   'product',
   { properties: { id: 'string', name: 'string' }, dataSource: 'db' }
);
var category = app.model(
  'category',
  { properties: { id: 'string', name: 'string' }, dataSource: 'db' }
);
product.hasAndBelongsToMany(category);
category.hasAndBelongsToMany(product);
category.create({ name: 'CAT-NAME' }, function(err, cat) {
  // assume cat has id "CAT-ID"
  cat.products.create({ name: 'PROD-NAME' }, function(err, prod) {
    // assume prod has id "PROD-ID"
    // done/next
  });
});

This request works as expected:

GET /api/products?where[categoryId]=CAT-ID
{
  "id": "PROD-ID" 
  "name": "PROD-NAME"
}

These two do not work though:

GET /api/categories/CAT-ID?include=products
{
  "id": "CAT-ID"
}

GET /api/categories/findOne?where[id]=CAT-ID&include=products
{
  "id": "CAT-ID"
}

GET /api/categories?where[id]=CAT-ID&include=products
[
 { "id": "CAT-ID" }
]

@raymondfeng is that expected?

[raymondfeng]

The syntax for the include option is wrong. It should be something like:

?filter[where][id]=CAT-ID&filter[include]=products

[bajtos]

The syntax for the include option is wrong. It should be something like:
?filter[where][id]=CAT-ID&filter[include]=products

Thanks, find/findOne work now.

What's the correct URL for findById with include? Neither of these work:

GET /api/categories/CAT-ID?include=products
GET /api/categories/CAT-ID?filter[include]=products

[bajtos]

I fixed my test for find by categoryId and realised it does not work.

GET /api/products?filter[where][categoryId]=CAT-ID
[]

[bajtos]

Summary:

✅ GET /api/categories/findOne?filter[where][id]=CAT-ID&filter[include]=products

❌ GET /api/products?filter[where][categoryId]=CAT-ID

❌ GET /api/categories/CAT-ID?include=products

[bajtos]

At the moment, LoopBack supports these two use-cases:

• find related models via URL scope:
  GET /api/categories/CAT-ID/products
• include related models in the result of find/findOne:
  GET /api/categories/findOne?filter[where][id]=CAT-ID&filter[include]=products

I have opened two follow-up issues #93 and #94 to implement the other two uses cases mentioned above.

@raymondfeng I suppose we can close the issue once the new version of loopback-datasource-juggler is released.