Merge pull request #136 from fishtown-analytics/feature/report-nodes

Adds report node type
dbt-labs · Sep 16, 2020 · 01c6ce2 · 01c6ce2
2 parents 05bda78 + f200403
commit 01c6ce2
Show file tree

Hide file tree

Showing 25 changed files with 267 additions and 52 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 ## dbt 0.19.0 (Release TBD)
 
+## dbt 0.18.1 (Unreleased)
+- Add Report nodes ([docs#135](https://github.com/fishtown-analytics/dbt-docs/issues/135), [docs#136](https://github.com/fishtown-analytics/dbt-docs/pull/136))
+
 ## dbt 0.18.0 (September 2, 2020)
 - Add project level overviews ([docs#127](https://github.com/fishtown-analytics/dbt-docs/issues/127))
 

diff --git a/ci-project/models/export.yml b/ci-project/models/export.yml
@@ -0,0 +1,30 @@
+version: 2
+
+reports:
+  - name: crm_export
+    type: application
+    maturity: medium
+    description: >
+      An export model that is synced to our CRM nightly at 11pm ET
+
+    depends_on:
+      - ref('fct_orders')
+      - ref('dim_customers')
+
+    owner:
+      name: Alice Analyst
+      email: [email protected]
+
+  - name: weekly_metrics
+    type: dashboard
+    maturity: high
+    url: https://www.getdbt.com
+    description: >
+      The Big Numbers, shared in #product every Monday morning. **Cool dashboard**
+
+    depends_on:
+      - ref('dim_customers')
+
+    owner:
+      name: Data Team
+      email: [email protected]
diff --git a/data/catalog.json b/data/catalog.json
diff --git a/data/manifest.json b/data/manifest.json
diff --git a/data/run_results.json b/data/run_results.json
diff --git a/src/app/components/model_tree/model_tree.html b/src/app/components/model_tree/model_tree.html
@@ -48,6 +48,17 @@
                     <br />
                 </div>
 
+                <div ng-show="tree.reports.length > 0">
+                    <strong>Reports</strong>
+                    <ul style="display: block">
+                        <model-tree-line
+                            item="item"
+                            resource-type="report"
+                            ng-repeat="item in tree.reports"></model-tree-line>
+                    </ul>
+                    <br />
+                </div>
+
                 <strong>Projects</strong>
                 <ul>
                     <model-tree-line

diff --git a/src/app/components/references/index.html b/src/app/components/references/index.html
@@ -1,6 +1,6 @@
 <div class="panel">
     <div class="panel-body" ng-if="!has_references">
-        No resources reference this macro
+        No resources reference this {{ node.resource_type }}
     </div>
     <div class="panel-body" ng-if="has_references">
         <ul class="nav nav-tabs">

diff --git a/src/app/components/references/index.js b/src/app/components/references/index.js
@@ -8,6 +8,7 @@ angular
     return {
         scope: {
             references: '=',
+            node: '=',
         },
         restrict: 'E',
         templateUrl: template,
@@ -30,6 +31,8 @@ angular
             scope.mapResourceType = function(type) {
                 if (type == 'model') {
                     return 'Models';
+                } else if (type == 'seed') {
+                    return 'Seeds';
                 } else if (type == 'test') {
                     return 'Tests';
                 } else if (type == 'snapshot') {
@@ -38,6 +41,8 @@ angular
                     return 'Analyses';
                 } else if (type == 'macro') {
                       return 'Macros';
+                } else if (type == 'report') {
+                      return 'Reports';
                 } else {
                     return 'Nodes';
                 }

diff --git a/src/app/components/table_details/table_details.html b/src/app/components/table_details/table_details.html
@@ -15,7 +15,7 @@ <h6>Details</h6>
                     </div>
                     <div class="detail-group">
                         <div class="detail-body">
-                            <dl class='detail' ng-if="model.tags != undefined">
+                            <dl class='detail' ng-if="model.tags != undefined && exclude.indexOf('tags') == -1">
                                 <dt class="detail-label">Tags</dt>
                                 <dd ng-if="model.tags.length > 0" class="detail-value">
                                     <span ng-repeat="tag in model.tags"><code><a ng-click=queryTag(tag)>{{ tag }}</a></code>&nbsp;</span>

diff --git a/src/app/components/table_details/table_details.js b/src/app/components/table_details/table_details.js
@@ -11,13 +11,15 @@ angular
     return {
         scope: {
             model: '=',
-            extras: '='
+            extras: '=',
+            exclude: '<',
         },
         templateUrl: template,
         link: function(scope) {
 
             scope.details = [];
             scope.extended = [];
+            scope.exclude = scope.exclude || [];
             scope.meta = null;
             scope._show_expanded = false;
 
@@ -152,7 +154,10 @@ angular
                 scope.extended = getExtendedStats(nv.stats);
 
                 if (scope.extras) {
-                    scope.details = scope.details.concat(scope.extras);
+                    var extrasToAdd = _.filter(scope.extras, function(extra) {
+                        return extra.value !== undefined && extra.value !== null;
+                    });
+                    scope.details = scope.details.concat(extrasToAdd);
                 }
 
                 scope.show_extended = _.where(scope.extended, {include: true}).length > 0;

diff --git a/src/app/docs/analysis.html b/src/app/docs/analysis.html
@@ -34,7 +34,6 @@ <h1>
         <div class="app-frame app-pad-h">
             <ul class="nav nav-tabs">
                 <li ui-sref-active='active'><a ui-sref="dbt.analysis({'#': 'description'})">Description</a></li>
-                <li ui-sref-active='active' ng-show = "referencesLength != 0"><a ui-sref="dbt.analysis({'#': 'referenced_by'})">Referenced By</a></li>
                 <li ui-sref-active='active' ng-show = "parentsLength != 0"><a ui-sref="dbt.analysis({'#': 'depends_on'})">Depends On</a></li>
                 <li ui-sref-active='active'><a ui-sref="dbt.analysis({'#': 'sql'})">SQL</a></li>
             </ul>
@@ -56,14 +55,6 @@ <h6>Description</h6>
                 </div>
             </section>
 
-            <section class="section" ng-show = "referencesLength != 0">
-                <div class="section-target" id="referenced_by"></div>
-                <div class="section-content">
-                    <h6>Referenced By</h6>
-                    <reference-list references="references" />
-                </div>
-            </section>
-
             <section class="section" ng-show = "parentsLength != 0">
                 <div class="section-target" id="depends_on"></div>
                 <div class="section-content">

diff --git a/src/app/docs/index.js b/src/app/docs/index.js
@@ -6,3 +6,4 @@ require('./snapshot');
 require('./test');
 require('./macro');
 require('./analysis');
+require('./report');
diff --git a/src/app/docs/macro.html b/src/app/docs/macro.html
@@ -63,15 +63,15 @@ <h6>Arguments</h6>
                 <div class="section-target" id="referenced_by"></div>
                 <div class="section-content">
                     <h6>Referenced By</h6>
-                    <reference-list references="references" />
+                    <reference-list references="references" node="macro" />
                 </div>
             </section>
 
             <section class="section" ng-show = "parentsLength != 0">
                 <div class="section-target" id="depends_on"></div>
                 <div class="section-content">
                     <h6>Depends On</h6>
-                    <reference-list references="parents" />
+                    <reference-list references="parents" node="macro" />
                 </div>
             </section>
 

diff --git a/src/app/docs/model.html b/src/app/docs/model.html
@@ -74,15 +74,15 @@ <h6>Columns</h6>
                 <div class="section-target" id="referenced_by"></div>
                 <div class="section-content">
                     <h6>Referenced By</h6>
-                    <reference-list references="references" />
+                    <reference-list references="references" node="model" />
                 </div>
             </section>
 
             <section class="section" ng-show = "parentsLength != 0">
                 <div class="section-target" id="depends_on"></div>
                 <div class="section-content">
                     <h6>Depends On</h6>
-                    <reference-list references="parents" />
+                    <reference-list references="parents" node="model" />
                 </div>
             </section>
 

diff --git a/src/app/docs/report.html b/src/app/docs/report.html
@@ -0,0 +1,75 @@
+<style>
+/* TODO */
+.section-target {
+    top: -8em;
+}
+
+.noflex {
+    flex: 0 0 160px !important;
+}
+
+.highlight {
+    color: #24292e;
+    background-color: white;
+}
+
+</style>
+
+<div class='app-scroll'>
+    <div class="app-links app-sticky">
+        <div class="app-title">
+            <div class="app-frame app-pad app-flush-bottom">
+
+                <h1>
+                    <span class="break">{{ report.name }}</span>
+                    <small>report</small>
+
+                    <div class='pull-right' ng-show="report.url">
+                        <a class='btn text-white btn-primary btn-sm' ng-href="{{ report.url }}" target="_blank">View this report</a>
+                    </div>
+
+                    <div class='clearfix'></div>
+                </h1>
+
+            </div>
+        </div>
+        <div class="app-frame app-pad-h">
+            <ul class="nav nav-tabs">
+                <li ui-sref-active='active'><a ui-sref="dbt.report({'#': 'details'})">Details</a></li>
+                <li ui-sref-active='active'><a ui-sref="dbt.report({'#': 'description'})">Description</a></li>
+                <li ui-sref-active='active' ng-show = "parentsLength != 0"><a ui-sref="dbt.report({'#': 'depends_on'})">Depends On</a></li>
+            </ul>
+        </div>
+    </div>
+    <div class="app-details">
+        <div class="app-frame app-pad">
+
+            <section class="section">
+                <div class="section-target" id="details"></div>
+                <table-details model="report" extras="extra_table_fields" exclude="['tags']" />
+            </section>
+
+            <section class="section">
+                <div class="section-target" id="description"></div>
+                <div class="section-content">
+                    <h6>Description</h6>
+                    <div class="panel">
+                        <div class="panel-body">
+                            <div ng-if="report.description" class="model-markdown" marked="report.description"></div>
+                            <div ng-if="!report.description">This {{ report.resource_type }} is not currently documented</div>
+                        </div>
+                    </div>
+                </div>
+            </section>
+
+            <section class="section" ng-show = "parentsLength != 0">
+                <div class="section-target" id="depends_on"></div>
+                <div class="section-content">
+                    <h6>Depends On</h6>
+                    <reference-list references="parents" node="report" />
+                </div>
+            </section>
+
+        </div>
+    </div>
+</div>
diff --git a/src/app/docs/report.js b/src/app/docs/report.js
@@ -0,0 +1,41 @@
+'use strict';
+
+const angular = require('angular');
+const dag_utils = require('./dag_utils')
+require("./styles.css");
+
+angular
+.module('dbt')
+.controller('ReportCtrl', ['$scope', '$state', 'project', 'code', '$anchorScroll', '$location',
+            function($scope, $state, projectService, codeService, $anchorScroll, $location) {
+
+    $scope.model_uid = $state.params.unique_id;
+    $scope.project = projectService;
+
+    $scope.codeService = codeService;
+    $scope.extra_table_fields = [];
+    $scope.versions = {};
+
+    $scope.report = {};
+    projectService.ready(function(project) {
+        let report = project.nodes[$scope.model_uid];
+        $scope.report = report;
+        $scope.parents = dag_utils.getParents(project, report);
+        $scope.parentsLength = $scope.parents.length;
+
+        $scope.extra_table_fields = [
+            {
+                name: "Maturity",
+                value: $scope.report.maturity,
+            },
+            {
+                name: "Owner",
+                value: $scope.report.owner.name,
+            },
+            {
+                name: "Owner email",
+                value: $scope.report.owner.email,
+            },
+        ]
+    })
+}]);
diff --git a/src/app/docs/seed.html b/src/app/docs/seed.html
@@ -73,15 +73,15 @@ <h6>Columns</h6>
                 <div class="section-target" id="referenced_by"></div>
                 <div class="section-content">
                     <h6>Referenced By</h6>
-                    <reference-list references="references" />
+                    <reference-list references="references" node="model" />
                 </div>
             </section>
 
             <section class="section" ng-show = "parentsLength != 0">
                 <div class="section-target" id="depends_on"></div>
                 <div class="section-content">
                     <h6>Depends On</h6>
-                    <reference-list references="parents" />
+                    <reference-list references="parents" node="model" />
                 </div>
             </section>
 

diff --git a/src/app/docs/snapshot.html b/src/app/docs/snapshot.html
@@ -74,15 +74,15 @@ <h6>Columns</h6>
                 <div class="section-target" id="referenced_by"></div>
                 <div class="section-content">
                     <h6>Referenced By</h6>
-                    <reference-list references="references" />
+                    <reference-list references="references" node="model" />
                 </div>
             </section>
 
             <section class="section" ng-show = "parentsLength != 0">
                 <div class="section-target" id="depends_on"></div>
                 <div class="section-content">
                     <h6>Depends On</h6>
-                    <reference-list references="parents" />
+                    <reference-list references="parents" node="model" />
                 </div>
             </section>
 

diff --git a/src/app/docs/source.html b/src/app/docs/source.html
@@ -31,7 +31,6 @@ <h1>
                 <li ui-sref-active='active'><a ui-sref="dbt.source({'#': 'description'})">Description</a></li>
                 <li ui-sref-active='active'><a ui-sref="dbt.source({'#': 'columns'})">Columns</a></li>
                 <li ui-sref-active='active' ng-show = "referencesLength != 0"><a ui-sref="dbt.source({'#': 'referenced_by'})">Referenced By</a></li>
-                <li ui-sref-active='active' ng-show = "parentsLength != 0"><a ui-sref="dbt.source({'#': 'depends_on'})">Depends On</a></li>
                 <li ui-sref-active='active'><a ui-sref="dbt.source({'#': 'code'})">SQL</a></li>
             </ul>
         </div>
@@ -67,15 +66,7 @@ <h6>Columns</h6>
                 <div class="section-target" id="referenced_by"></div>
                 <div class="section-content">
                     <h6>Referenced By</h6>
-                    <reference-list references="references" />
-                </div>
-            </section>
-
-            <section class="section" ng-show = "parentsLength != 0">
-                <div class="section-target" id="depends_on"></div>
-                <div class="section-content">
-                    <h6>Depends On</h6>
-                    <reference-list references="parents" />
+                    <reference-list references="references" node="model" />
                 </div>
             </section>