Adds support for File selector matcher (#273)

* Adds support for file matcher in docs site

* update deps

Co-authored-by: Emily Rockman <emily.rockman@dbtlabs.com>

CHANGELOG.md

@@ -2,6 +2,7 @@
 - [Snyk] Upgrade prismjs from 1.27.0 to 1.28.0 ([#271](https://github.com/dbt-labs/dbt-docs/issues/271))
 - Fixed sample SQL Code for sources when no database is defined ([docs#272](https://github.com/dbt-labs/dbt-docs/pull/272))
 - Run build and tests in CI checks ([docs#274](https://github.com/dbt-labs/dbt-docs/pull/274))
+- Add support for `file:` selector in DAG viz ([docs#273](https://github.com/dbt-labs/dbt-docs/pull/273))
 - Improve metrics DAG viz and documentation page ([docs#285](https://github.com/dbt-labs/dbt-docs/pull/285))
 
 Contributors:

src/app/services/selector_integration.test.js

@@ -23,7 +23,8 @@ dag.setNode("a", {
  source_name: 'event',
  unique_id: 'a',
  name: 'a',
- tags: ['pii']
+ tags: ['pii'],
+ original_file_path: "models/schema.yml",
 });
 
 dag.setNode("b", {
@@ -33,6 +34,7 @@ dag.setNode("b", {
  name: 'b',
  fqn: ['my_package', 'b'],
  tags: ['nightly'],
+ original_file_path: "models/b.sql",
 });
 
 dag.setNode("c", {
@@ -42,6 +44,7 @@ dag.setNode("c", {
  name: 'c',
  fqn: ['my_package', 'dir', 'c'],
  tags: ['nightly'],
+ original_file_path: "models/dir/c.sql",
 });
 
 dag.setNode("d", {
@@ -51,6 +54,7 @@ dag.setNode("d", {
  name: 'd',
  fqn: ['my_package', 'dir', 'd'],
  tags: ['daily', 'nightly'],
+ original_file_path: "models/dir/d.sql",
 });
 
 dag.setNode("e", {
@@ -60,6 +64,7 @@ dag.setNode("e", {
  name: 'e',
  fqn: ['my_package', 'dir', 'e'],
  tags: ['nightly'],
+ original_file_path: "models/dir/e.sql",
 });
 
 dag.setNode("f", {
@@ -69,6 +74,7 @@ dag.setNode("f", {
  name: 'f',
  fqn: ['other_package', 'dir', 'f'],
  tags: ['imported'],
+ original_file_path: "models/dir/f.sql",
 });
 
 
@@ -327,6 +333,31 @@ test("Test getting nodes by tag with no edges", () => {
 })
 
 
+test("Test getting nodes by file name", () => {
+ var matched = matcher.getNodesFromSpec(
+ dag,
+ pristine_nodes,
+ undefined,
+ {
+ select_at: false,
+ select_parents: false,
+ parents_depth: null,
+ children_depth: null,
+ select_children: false,
+ selector_type: 'file',
+ selector_value: 'd.sql',
+ raw: 'd.sql'
+ }
+ )
+ matched.selected = matched.selected.sort()
+
+ expect(matched).toStrictEqual({
+ matched: ['d'],
+ selected: ['d'],
+ })
+})
+
+
 /*
  * Test root-level selectNodes method
  */

src/app/services/selector_matcher.js

@@ -10,6 +10,7 @@ var SELECTOR_TYPE = {
  EXPOSURE: 'exposure',
  METRIC: 'metric',
  PATH: 'path',
+ FILE: 'file',
  PACKAGE: 'package',
  CONFIG: 'config',
  TEST_NAME: 'test_name',
@@ -24,6 +25,7 @@ NODE_MATCHERS[SELECTOR_TYPE.SOURCE] = getNodesBySource;
 NODE_MATCHERS[SELECTOR_TYPE.EXPOSURE] = getNodesByExposure;
 NODE_MATCHERS[SELECTOR_TYPE.METRIC] = getNodesByMetric;
 NODE_MATCHERS[SELECTOR_TYPE.PATH] = getNodesByPath;
+NODE_MATCHERS[SELECTOR_TYPE.FILE] = getNodesByFile;
 NODE_MATCHERS[SELECTOR_TYPE.PACKAGE] = getNodesByPackage;
 NODE_MATCHERS[SELECTOR_TYPE.CONFIG] = getNodesByConfig;
 NODE_MATCHERS[SELECTOR_TYPE.TEST_NAME] = getNodesByTestName;
@@ -125,14 +127,33 @@ function getNodesByPath(elements, path) {
  return nodes;
 }
 
+function getNodesByFile(elements, path) {
+ var nodes = [];
+
+ _.each(elements, function(node) {
+ var path_parts = node.data.original_file_path.split("/");
+ var fname = _.last(path_parts);
+ if (fname == path) {
+ nodes.push(node.data);
+ }
+ })
+ return nodes;
+}
+
 function getNodesByImplicitSelection(elements, selector) {
  var fqn_matched = getNodesByFQN(elements, selector);
  var path_matched = getNodesByPath(elements, selector);
 
+ var file_matched = [];
+ if (selector.toLowerCase().endsWith('.sql')) {
+ file_matched = getNodesByFile(elements, selector);
+ }
+
  var node_ids = _.uniq(
- _.map(fqn_matched, 'unique_id')
- .concat(
- _.map(path_matched, 'unique_id')
+ [].concat(
+ _.map(fqn_matched, 'unique_id'),
+ _.map(path_matched, 'unique_id'),
+ _.map(file_matched, 'unique_id'),
  )
  )