Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions DEPRECATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ features:
| Removed | [Using Redis for in-memory cache and queue](#using-redis-for-in-memory-cache-and-queue) | v0.32.0 | v0.36.0 |
| Deprecated | [`SECURITY_CONTEXT`](#security_context) | v0.33.0 | |
| Deprecated | [`running_total` measure type](#running_total-measure-type) | v0.33.39 | |
| Deprecated | [Top-level `includes` parameter in views](#top-level-includes-parameter-in-views) | v0.34.34 | |
| Removed | [Top-level `includes` parameter in views](#top-level-includes-parameter-in-views) | v0.34.34 | v1.3.0 |
| Removed | [Node.js 16](#nodejs-16) | v0.35.0 | v0.36.0 |
| Removed | [MySQL-based SQL API](#mysql-based-sql-api) | v0.35.0 | v0.35.0 |
| Removed | [`initApp` hook](#initapp-hook) | v0.35.0 | v0.35.0 |
Expand Down Expand Up @@ -350,9 +350,9 @@ to calculate running totals instead.

### Top-level `includes` parameter in views

**Deprecated in Release: v0.34.34**
**Removed in Release: v1.3.0**

The top-level `includes` parameter is now deprecated. Please always use the
The top-level `includes` parameter is now removed. Please always use the
`includes` parameter within [`cubes` and `join_path`
parameters](https://cube.dev/docs/reference/data-model/view#cubes) so you can
explicitly control the join path.
Expand Down
34 changes: 4 additions & 30 deletions packages/cubejs-schema-compiler/src/compiler/CubeSymbols.ts
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ export class CubeSymbols {
}

protected prepareIncludes(cube: CubeDefinition, errorReporter: ErrorReporter, splitViews: SplitViews) {
if (!cube.includes && !cube.cubes) {
if (!cube.cubes) {
return;
}

Expand Down Expand Up @@ -324,18 +324,8 @@ export class CubeSymbols {
cubeIncludes = this.membersFromCubes(cube, cubes, type, errorReporter, splitViews, memberSets) || [];
}

// This is the deprecated approach
const includes = cube.includes && this.membersFromIncludeExclude(cube.includes, cube.name, type) || [];
const excludes = cube.excludes && this.membersFromIncludeExclude(cube.excludes, cube.name, type) || [];

// cube includes will take precedence in case of member clash
const finalIncludes = this.diffByMember(
this.diffByMember(includes, cubeIncludes).concat(cubeIncludes),
excludes
);

if (type === 'hierarchies') {
for (const member of finalIncludes) {
for (const member of cubeIncludes) {
const path = member.member.split('.');
const cubeName = path[path.length - 2];
const hierarchyName = path[path.length - 1];
Expand All @@ -350,10 +340,10 @@ export class CubeSymbols {
}
}

const includeMembers = this.generateIncludeMembers(finalIncludes, cube.name, type);
const includeMembers = this.generateIncludeMembers(cubeIncludes, cube.name, type);
this.applyIncludeMembers(includeMembers, cube, type, errorReporter);

cube.includedMembers = [...(cube.includedMembers || []), ...Array.from(new Set(finalIncludes.map((it: any) => {
cube.includedMembers = [...(cube.includedMembers || []), ...Array.from(new Set(cubeIncludes.map((it: any) => {
const split = it.member.split('.');
const memberPath = this.pathFromArray([split[split.length - 2], split[split.length - 1]]);
return {
Expand Down Expand Up @@ -465,22 +455,6 @@ export class CubeSymbols {
return includes.filter(include => !excludesMap.has(include.member));
}

protected membersFromIncludeExclude(referencesFn: (...args: Array<unknown>) => Array<ToString>, cubeName: string, type: string) {
const references = this.evaluateReferences(cubeName, referencesFn);
return R.unnest(references.map((ref: string) => {
const path = ref.split('.');
if (path.length === 1) {
const membersObj = this.symbols[path[0]]?.cubeObj()?.[type] || {};
return Object.keys(membersObj).map(memberName => ({ member: `${ref}.${memberName}` }));
} else if (path.length === 2) {
const resolvedMember = this.getResolvedMember(type, path[0], path[1]);
return resolvedMember ? [{ member: ref }] : undefined;
} else {
throw new Error(`Unexpected path length ${path.length} for ${ref}`);
}
})).filter(Boolean);
}

protected getResolvedMember(type: string, cubeName: string, memberName: string) {
return this.symbols[cubeName]?.cubeObj()?.[type]?.[memberName];
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -779,8 +779,6 @@ const cubeSchema = inherit(baseSchema, {

const viewSchema = inherit(baseSchema, {
isView: Joi.boolean().strict(),
includes: Joi.func(),
excludes: Joi.func(),
cubes: Joi.array().items(
Joi.object().keys({
joinPath: Joi.func().required(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -200,8 +200,19 @@ cube(\`ProductCategories\`, {
});

view(\`OrdersView\`, {
includes: [Orders],
excludes: [Orders.createdAt],
cubes: [{
join_path: Orders,
includes: '*',
excludes: ['createdAt']
}, {
join_path: Orders.Products,
includes: '*',
prefix: true
}, {
join_path: Orders.Products.ProductCategories,
includes: '*',
prefix: true
}],

measures: {
productCategoryCount: {
Expand Down Expand Up @@ -233,10 +244,6 @@ view(\`OrdersView\`, {
}
});

view(\`OrdersView2\`, {
includes: [Orders.count],
});

view(\`OrdersView3\`, {
cubes: [{
join_path: Orders,
Expand Down
36 changes: 0 additions & 36 deletions packages/cubejs-schema-compiler/test/unit/views.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -391,42 +391,6 @@ describe('Views YAML', () => {
});
});

it('includes * (legacy)', async () => {
const { cubeEvaluator } = await schemaCompile([{
name: 'simple_view',
includes: [
'CubeA.id',
// conflict
// 'CubeB.id',
'CubeB.other_id',
]
}]);

expect(cubeEvaluator.getCubeDefinition('simple_view').dimensions).toEqual({
id: dimensionFixtureForCube('CubeA.id'),
other_id: dimensionFixtureForCube('CubeB.other_id'),
});
});

it('includes * (legacy) + exclude b.id', async () => {
const { cubeEvaluator } = await schemaCompile([{
name: 'simple_view',
includes: [
'CubeA.id',
'CubeB.id',
'CubeB.other_id',
],
excludes: [
'CubeB.id'
]
}]);

expect(cubeEvaluator.getCubeDefinition('simple_view').dimensions).toEqual({
id: dimensionFixtureForCube('CubeA.id'),
other_id: dimensionFixtureForCube('CubeB.other_id'),
});
});

it('throws error for unresolved members', async () => {
const { compiler } = prepareYamlCompiler(`
cubes:
Expand Down
Loading