From cc29e515215970dbcff03eaefa14c5d70e41da19 Mon Sep 17 00:00:00 2001
From: Grace Guo <grace.guo@airbnb.com>
Date: Sat, 23 Sep 2017 11:18:56 -0700
Subject: [PATCH] annotation layers UI

for https://github.com/apache/incubator-superset/issues/3502
---
 .../javascripts/components/AsyncSelect.jsx    |  6 +-
 .../explore/components/Control.jsx            |  4 +-
 .../controls/SelectAsyncControl.jsx           | 62 +++++++++++++++++
 superset/assets/javascripts/explore/main.css  |  5 +-
 .../javascripts/explore/stores/controls.jsx   | 13 +---
 .../javascripts/explore/stores/visTypes.js    |  7 +-
 superset/assets/visualizations/nvd3_vis.js    | 67 ++++++++++++++++++-
 superset/migrations/versions/d39b1e37131d_.py | 22 ++++++
 ...tations.py => ddd6ebdd853b_annotations.py} |  0
 superset/migrations/versions/f959a6652acd_.py | 22 ++++++
 superset/views/annotations.py                 |  2 +-
 superset/viz.py                               |  2 +
 12 files changed, 196 insertions(+), 16 deletions(-)
 create mode 100644 superset/assets/javascripts/explore/components/controls/SelectAsyncControl.jsx
 create mode 100644 superset/migrations/versions/d39b1e37131d_.py
 rename superset/migrations/versions/{483e7ff8b241_annotations.py => ddd6ebdd853b_annotations.py} (100%)
 create mode 100644 superset/migrations/versions/f959a6652acd_.py

diff --git a/superset/assets/javascripts/components/AsyncSelect.jsx b/superset/assets/javascripts/components/AsyncSelect.jsx
index 007281a116a04..69b4216a9c955 100644
--- a/superset/assets/javascripts/components/AsyncSelect.jsx
+++ b/superset/assets/javascripts/components/AsyncSelect.jsx
@@ -10,7 +10,10 @@ const propTypes = {
   onChange: PropTypes.func.isRequired,
   mutator: PropTypes.func.isRequired,
   onAsyncError: PropTypes.func,
-  value: PropTypes.number,
+  value: PropTypes.oneOfType([
+    PropTypes.number,
+    PropTypes.arrayOf(PropTypes.number),
+  ]),
   valueRenderer: PropTypes.func,
   placeholder: PropTypes.string,
   autoSelect: PropTypes.bool,
@@ -63,6 +66,7 @@ class AsyncSelect extends React.PureComponent {
           isLoading={this.state.isLoading}
           onChange={this.onChange.bind(this)}
           valueRenderer={this.props.valueRenderer}
+          {...this.props}
         />
       </div>
     );
diff --git a/superset/assets/javascripts/explore/components/Control.jsx b/superset/assets/javascripts/explore/components/Control.jsx
index 5c644c38f7906..972ff0d3c19d4 100644
--- a/superset/assets/javascripts/explore/components/Control.jsx
+++ b/superset/assets/javascripts/explore/components/Control.jsx
@@ -3,15 +3,16 @@ import PropTypes from 'prop-types';
 
 import BoundsControl from './controls/BoundsControl';
 import CheckboxControl from './controls/CheckboxControl';
+import ColorSchemeControl from './controls/ColorSchemeControl';
 import DatasourceControl from './controls/DatasourceControl';
 import DateFilterControl from './controls/DateFilterControl';
 import FilterControl from './controls/FilterControl';
 import HiddenControl from './controls/HiddenControl';
+import SelectAsyncControl from './controls/SelectAsyncControl';
 import SelectControl from './controls/SelectControl';
 import TextAreaControl from './controls/TextAreaControl';
 import TextControl from './controls/TextControl';
 import VizTypeControl from './controls/VizTypeControl';
-import ColorSchemeControl from './controls/ColorSchemeControl';
 
 const controlMap = {
   BoundsControl,
@@ -25,6 +26,7 @@ const controlMap = {
   TextControl,
   VizTypeControl,
   ColorSchemeControl,
+  SelectAsyncControl,
 };
 const controlTypes = Object.keys(controlMap);
 
diff --git a/superset/assets/javascripts/explore/components/controls/SelectAsyncControl.jsx b/superset/assets/javascripts/explore/components/controls/SelectAsyncControl.jsx
new file mode 100644
index 0000000000000..80eff94daa1f1
--- /dev/null
+++ b/superset/assets/javascripts/explore/components/controls/SelectAsyncControl.jsx
@@ -0,0 +1,62 @@
+/* global notify */
+import React from 'react';
+import PropTypes from 'prop-types';
+import Select from '../../../components/AsyncSelect';
+import { t } from '../../../locales';
+
+const propTypes = {
+  onChange: PropTypes.func,
+  value: PropTypes.oneOfType([
+    PropTypes.string,
+    PropTypes.number,
+    PropTypes.arrayOf(PropTypes.string),
+    PropTypes.arrayOf(PropTypes.number),
+  ]),
+};
+
+const defaultProps = {
+  onChange: () => {},
+};
+
+class SelectAsyncControl extends React.PureComponent {
+  constructor(props) {
+    super(props);
+    this.state = {
+      value: this.props.value,
+    };
+  }
+
+  onChange(options) {
+    const optionValues = options.map(option => option.value);
+    this.setState({ value: optionValues });
+    this.props.onChange(optionValues);
+  }
+
+  mutator(data) {
+    if (!data || !data.result) {
+      return [];
+    }
+
+    return data.result.map(layer => ({ value: layer.id, label: layer.name }));
+  }
+
+  render() {
+    return (
+      <Select
+        dataEndpoint={'/annotationlayermodelview/api/read?'}
+        onChange={this.onChange.bind(this)}
+        onAsyncError={() => notify.error(t('Error while fetching annotation layers'))}
+        mutator={this.mutator}
+        multi
+        value={this.state.value}
+        placeholder={t('Select a annotation layer')}
+        valueRenderer={v => (<div>{v.label}</div>)}
+      />
+    );
+  }
+}
+
+SelectAsyncControl.propTypes = propTypes;
+SelectAsyncControl.defaultProps = defaultProps;
+
+export default SelectAsyncControl;
diff --git a/superset/assets/javascripts/explore/main.css b/superset/assets/javascripts/explore/main.css
index abae1ce562468..827d1da8cfbba 100644
--- a/superset/assets/javascripts/explore/main.css
+++ b/superset/assets/javascripts/explore/main.css
@@ -28,9 +28,12 @@
 }
 
 .control-panel-section {
-  margin-bottom: 0px;
+  margin-bottom: 0;
   box-shadow: none;
 }
+.control-panel-section:last-child {
+  padding-bottom: 40px;
+ }
 
 .control-panel-section .Select-multi-value-wrapper .Select-input > input {
   width: 100px;
diff --git a/superset/assets/javascripts/explore/stores/controls.jsx b/superset/assets/javascripts/explore/stores/controls.jsx
index 1458753a88c9f..6394700d067da 100644
--- a/superset/assets/javascripts/explore/stores/controls.jsx
+++ b/superset/assets/javascripts/explore/stores/controls.jsx
@@ -120,18 +120,11 @@ export const controls = {
   },
 
   annotation_layers: {
-    type: 'SelectControl',
+    type: 'SelectAsyncControl',
     multi: true,
-    label: 'Annotation Layers',
+    label: t('Annotation Layers'),
     default: [],
-    description: 'Annotation layers to overlay on the visualization',
-    // Mocking with hard coded values for now
-    // this should be out of a new SelectAsyncControl who would fetch the
-    // choices on its own
-    choices: [
-      [1, 'Outages'],
-      [2, 'Holidays'],
-    ],
+    description: t('Annotation layers to overlay on the visualization'),
   },
 
   metric: {
diff --git a/superset/assets/javascripts/explore/stores/visTypes.js b/superset/assets/javascripts/explore/stores/visTypes.js
index c55cfb903f58b..e8df11e4b0b48 100644
--- a/superset/assets/javascripts/explore/stores/visTypes.js
+++ b/superset/assets/javascripts/explore/stores/visTypes.js
@@ -45,7 +45,8 @@ export const sections = {
     description: t('This section exposes ways to include snippets of SQL in your query'),
   },
   annotations: {
-    label: 'Annotations',
+    label: t('Annotations'),
+    expanded: true,
     controlSetRows: [
       ['annotation_layers'],
     ],
@@ -216,6 +217,7 @@ export const visTypes = {
           ['metric_2', 'y_axis_2_format'],
         ],
       },
+      sections.annotations,
     ],
     controlOverrides: {
       metric: {
@@ -258,6 +260,7 @@ export const visTypes = {
         ],
       },
       sections.NVD3TimeSeries[1],
+      sections.annotations,
     ],
     controlOverrides: {
       x_axis_format: {
@@ -280,6 +283,7 @@ export const visTypes = {
         ],
       },
       sections.NVD3TimeSeries[1],
+      sections.annotations,
     ],
     controlOverrides: {
       x_axis_format: {
@@ -313,6 +317,7 @@ export const visTypes = {
         ],
       },
       sections.NVD3TimeSeries[1],
+      sections.annotations,
     ],
     controlOverrides: {
       x_axis_format: {
diff --git a/superset/assets/visualizations/nvd3_vis.js b/superset/assets/visualizations/nvd3_vis.js
index 397e5bb336966..8a4e36f30d0c3 100644
--- a/superset/assets/visualizations/nvd3_vis.js
+++ b/superset/assets/visualizations/nvd3_vis.js
@@ -3,6 +3,7 @@ import $ from 'jquery';
 import throttle from 'lodash.throttle';
 import d3 from 'd3';
 import nv from 'nvd3';
+import d3tip from 'd3-tip';
 
 import { getColorFromScheme } from '../javascripts/modules/colors';
 import { customizeToolTip, d3TimeFormatPreset, d3FormatPreset, tryNumify } from '../javascripts/modules/utils';
@@ -74,7 +75,6 @@ function getMaxLabelSize(container, axisClass) {
 }
 
 function nvd3Vis(slice, payload) {
-  console.log("Annotations are here!", payload.annotations);
   let chart;
   let colorKey = 'key';
   const isExplore = $('#explore-container').length === 1;
@@ -477,6 +477,71 @@ function nvd3Vis(slice, payload) {
       .attr('height', height)
       .attr('width', width)
       .call(chart);
+
+      // add annotation_layer
+      if (isTimeSeries && payload.annotations.length) {
+        const tip = d3tip()
+          .attr('class', 'd3-tip')
+          .direction('n')
+          .offset([-5, 0])
+          .html(d => (d && d.layer ? d.layer : ''));
+
+        const hh = chart.yAxis.scale().range()[0];
+
+        let annotationLayer;
+        let xScale;
+        let minStep;
+        if (vizType === 'bar') {
+          const xMax = d3.max(payload.data[0].values, d => (d.x));
+          const xMin = d3.min(payload.data[0].values, d => (d.x));
+          minStep = chart.xAxis.range()[1] - chart.xAxis.range()[0];
+          annotationLayer = svg.select('.nv-barsWrap')
+            .insert('g', ':first-child');
+          xScale = d3.scale.quantile()
+            .domain([xMin, xMax])
+            .range(chart.xAxis.range());
+        } else {
+          minStep = 1;
+          annotationLayer = svg.select('.nv-background')
+            .append('g');
+          xScale = chart.xScale();
+        }
+
+        annotationLayer
+          .attr('class', 'annotation-container')
+          .append('defs')
+          .append('pattern')
+          .attr('id', 'diagonal')
+          .attr('patternUnits', 'userSpaceOnUse')
+          .attr('width', 8)
+          .attr('height', 10)
+          .attr('patternTransform', 'rotate(45 50 50)')
+          .append('line')
+          .attr('stroke', '#00A699')
+          .attr('stroke-width', 7)
+          .attr('y2', 10);
+
+        annotationLayer.selectAll('rect')
+          .data(payload.annotations)
+          .enter()
+          .append('rect')
+          .attr('class', 'annotation')
+          .attr('x', d => (xScale(d.start_dttm)))
+          .attr('y', 0)
+          .attr('width', (d) => {
+            const w = xScale(d.end_dttm) - xScale(d.start_dttm);
+            return w === 0 ? minStep : w;
+          })
+          .attr('height', hh)
+          .attr('fill', 'url(#diagonal)')
+          .attr('fill-opacity', 0.1)
+          .attr('stroke-width', 1)
+          .attr('stroke', '#00A699')
+          .on('mouseover', tip.show)
+          .on('mouseout', tip.hide);
+
+        annotationLayer.selectAll('rect').call(tip);
+      }
     }
 
     // on scroll, hide tooltips. throttle to only 4x/second.
diff --git a/superset/migrations/versions/d39b1e37131d_.py b/superset/migrations/versions/d39b1e37131d_.py
new file mode 100644
index 0000000000000..adcaa7732bcd7
--- /dev/null
+++ b/superset/migrations/versions/d39b1e37131d_.py
@@ -0,0 +1,22 @@
+"""empty message
+
+Revision ID: d39b1e37131d
+Revises: ('a9c47e2c1547', 'ddd6ebdd853b')
+Create Date: 2017-09-19 15:09:14.292633
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = 'd39b1e37131d'
+down_revision = ('a9c47e2c1547', 'ddd6ebdd853b')
+
+from alembic import op
+import sqlalchemy as sa
+
+
+def upgrade():
+    pass
+
+
+def downgrade():
+    pass
diff --git a/superset/migrations/versions/483e7ff8b241_annotations.py b/superset/migrations/versions/ddd6ebdd853b_annotations.py
similarity index 100%
rename from superset/migrations/versions/483e7ff8b241_annotations.py
rename to superset/migrations/versions/ddd6ebdd853b_annotations.py
diff --git a/superset/migrations/versions/f959a6652acd_.py b/superset/migrations/versions/f959a6652acd_.py
new file mode 100644
index 0000000000000..96186a6e3a006
--- /dev/null
+++ b/superset/migrations/versions/f959a6652acd_.py
@@ -0,0 +1,22 @@
+"""empty message
+
+Revision ID: f959a6652acd
+Revises: ('472d2f73dfd4', 'd39b1e37131d')
+Create Date: 2017-09-24 20:18:35.791707
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = 'f959a6652acd'
+down_revision = ('472d2f73dfd4', 'd39b1e37131d')
+
+from alembic import op
+import sqlalchemy as sa
+
+
+def upgrade():
+    pass
+
+
+def downgrade():
+    pass
diff --git a/superset/views/annotations.py b/superset/views/annotations.py
index 938a3fb2e7c60..34ae614782feb 100644
--- a/superset/views/annotations.py
+++ b/superset/views/annotations.py
@@ -21,7 +21,7 @@ class AnnotationModelView(SupersetModelView, DeleteMixin):  # noqa
 
 class AnnotationLayerModelView(SupersetModelView, DeleteMixin):
     datamodel = SQLAInterface(AnnotationLayer)
-    list_columns = ['name']
+    list_columns = ['id', 'name']
     edit_columns = ['name', 'descr']
     add_columns = edit_columns
 
diff --git a/superset/viz.py b/superset/viz.py
index 427cb4e41eb3d..66f470066b41e 100644
--- a/superset/viz.py
+++ b/superset/viz.py
@@ -57,6 +57,7 @@ def __init__(self, datasource, form_data):
             'token', 'token_' + uuid.uuid4().hex[:8])
         self.metrics = self.form_data.get('metrics') or []
         self.groupby = self.form_data.get('groupby') or []
+        self.annotation_layers = []
 
         self.status = None
         self.error_message = None
@@ -111,6 +112,7 @@ def get_extra_filters(self):
 
     def query_obj(self):
         """Building a query object"""
+        print("running query_obj============================")
         form_data = self.form_data
         gb = form_data.get("groupby") or []
         metrics = form_data.get("metrics") or []