[*] Smart Segments - Prevent includes from queryBuilder to overwrite include from segment scope

[louisremi]

Considering three models City, Region, Country, their associations, and the scope and collection defined as follows:

const City = sequelize.define('City', { … });
const Region = sequelize.define('Region', { … });
const Country = sequelize.define('Country', { … });

City.hasOne(Region);
Region.hasOne(Country);

City.addScope('region+country', {
  include: [{
    model: Region,
    include: [Country]
  }]
});

Liana.collection('City', {
  segments: [{
    name: 'with country',
    scope: 'region+country'
  }]
});

When requesting the segment with country, the current implementation of resources-getter.js would return the city and the associated region, but not the country associated to that region. This is because Region is added automatically to the .include list of the request, and overwrites the Region included in the scope.
This patch prevents includes returned by queryBuilder.getIncludes to overwrite the includes of the scope.

[arnaudbesnier]

Thanks for the refactoring ;)
I applied it on the latest code version here: a1cc888

[arnaudbesnier]

Hi @louisremi, the current segment feature has been implemented to filter the records to retrieve and not to customize the aggregation done on the retrieved data.

I am not sure to understand your use case here.
What do you do with the aggregated country sent with the city records?
Do you use this information in a Smart View?
Or is it because you use the Forest generated API for other purposes?

Thanks for your help.

[louisremi]

@arnaudbesnier We use this patch to display aggregated info from different tables in list views. The only alternative is to use a "View as Model", (e.g. https://github.com/chez-nestor/backoffice/blob/master/src/models/AmountView.js ) but this is often overkill.
I'll recreate this patch on top of master.

[louisremi]

@arnaudbesnier done! Looking forward to your review, as this is the last patch we have to backport everytime we want to update our Liana :-)