Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#1466] Filter intersection of tags #1467

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
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
16 changes: 13 additions & 3 deletions api/commands/prune.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ function computeIncludedActionNames(

const hasActionSelector = runConfig.actions?.length > 0;
const hasTagSelector = runConfig.tags?.length > 0;
const hasIncludeAllTagsSelector = runConfig.includeAllTags?.valueOf();

// If no selectors, return all actions.
if (!hasActionSelector && !hasTagSelector) {
Expand All @@ -64,9 +65,18 @@ function computeIncludedActionNames(

// Determine actions selected with --tag option and update applicable actions
if (hasTagSelector) {
allActions
.filter(action => action.tags.some(tag => runConfig.tags.includes(tag)))
.forEach(action => includedActionNames.add(targetAsReadableString(action.target)));
// Keep actions wich include every tags in --tag option
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Keep actions wich include every tags in --tag option
// Select actions which match the intersection of the set of tags.

if (hasIncludeAllTagsSelector) {
allActions
.filter(action => runConfig.tags.every(tag => action.tags.includes(tag)))
.forEach(action => includedActionNames.add(targetAsReadableString(action.target)));
}
// Keep actions with include at least one tag in --tag option
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Keep actions with include at least one tag in --tag option
// Select actions which match the union of the set of tags.

else {
allActions
.filter(action => action.tags.some(tag => runConfig.tags.includes(tag)))
.forEach(action => includedActionNames.add(targetAsReadableString(action.target)));
}
}

// Compute all transitive dependencies.
Expand Down
13 changes: 12 additions & 1 deletion cli/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,15 @@ const tagsOption: INamedOption<yargs.Options> = {
}
};

const includeAllTagsOption: INamedOption<yargs.Options> = {
name: "include-all-tags",
option: {
describe: "If set, only actions that include every user-specified tags will be run",
type: "boolean",
default: false
}
}

const includeDepsOption: INamedOption<yargs.Options> = {
name: "include-deps",
option: {
Expand Down Expand Up @@ -581,6 +590,7 @@ export function runCli() {
fullRefreshOption,
actionsOption,
tagsOption,
includeAllTagsOption,
includeDepsOption,
includeDependentsOption,
schemaSuffixOverrideOption,
Expand Down Expand Up @@ -628,7 +638,8 @@ export function runCli() {
actions: argv[actionsOption.name],
includeDependencies: argv[includeDepsOption.name],
includeDependents: argv[includeDependentsOption.name],
tags: argv[tagsOption.name]
tags: argv[tagsOption.name],
includeAllTags: argv[includeAllTagsOption.name]
},
dbadapter
);
Expand Down
1 change: 1 addition & 0 deletions protos/execution.proto
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ option go_package = "github.com/dataform-co/dataform/protos/dataform";
message RunConfig {
repeated string actions = 1;
repeated string tags = 5;
bool include_all_tags = 10;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"include all" is ambiguous in semantic meaning - IMO something like filterTagsAsIntersection would be better as it's more explicit.

bool include_dependencies = 3;
bool include_dependents = 11;
bool full_refresh = 2;
Expand Down
22 changes: 22 additions & 0 deletions tests/api/api.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,11 @@ suite("@dataform/api", () => {
target: { schema: "schema", name: "op_d" },
tags: ["tag3"],
queries: ["create or replace view schema.someview as select 1 as test"]
},
{
target: { schema: "schema", name: "op_e" },
tags: ["tag1", "tag2"],
queries: ["create or replace view schema.someview as select 1 as test"]
}
],
tables: [
Expand Down Expand Up @@ -395,6 +400,23 @@ suite("@dataform/api", () => {
expect(actionNames).includes("schema.tab_a");
});

test("prune actions with --tags (with include all tags)", () => {
const prunedGraph = prune(TEST_GRAPH_WITH_TAGS, {
tags: ["tag1", "tag2"],
includeAllTags: true
});
const actionNames = [
...prunedGraph.tables.map(action => targetAsReadableString(action.target)),
...prunedGraph.operations.map(action => targetAsReadableString(action.target))
];
expect(actionNames).includes("schema.op_e");
expect(actionNames).includes("schema.tab_a");
expect(actionNames).not.includes("schema.op_a");
expect(actionNames).not.includes("schema.op_b");
expect(actionNames).not.includes("schema.op_c");
expect(actionNames).not.includes("schema.op_d");
Comment on lines +412 to +417
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would be better as expect(actionNames).deep.equals(["schema.op_e", "schema.op_a"]);

});

test("prune actions with --actions with dependencies", () => {
const prunedGraph = prune(TEST_GRAPH, { actions: ["schema.a"], includeDependencies: true });
const actionNames = [
Expand Down