[5.3] [fieldFormat] make formatted output non-bindable (#11911) (#11917)

* [fieldFormat] make formatted output non-bindable (#11911)

* [fieldFormat] make formatted output non-bindable

* [aggTable] totals are consumed as text, produce text

* [tests] fix existing tests

* [fieldFormat/contentType] add tests for non-bindable wrapper

(cherry picked from commit 1d2341fc2b)
(cherry picked from commit f85570d506)

* fix import statement

* [metricVis] Fix html support (#11008)

* [metricVis] Fix html support

* [metric_vis] add test to verify 42d11b021

* [ui/vis] fix import

(cherry picked from commit 34c33f3895)
(cherry picked from commit eea76221ba)

* fix import statement

(cherry picked from commit 07d9a3b0bc)

src/core_plugins/metric_vis/public/__tests__/metric_vis.js

@@ -0,0 +1,60 @@
+import $ from 'jquery';
+import ngMock from 'ng_mock';
+import expect from 'expect.js';
+
+import VisProvider from 'ui/vis';
+import LogstashIndexPatternStubProvider from 'fixtures/stubbed_logstash_index_pattern';
+import MetricVisProvider from '../metric_vis';
+
+describe('metric_vis', () => {
+  let setup = null;
+
+  beforeEach(ngMock.module('kibana'));
+  beforeEach(ngMock.inject((Private, $rootScope) => {
+    setup = () => {
+      const Vis = Private(VisProvider);
+      const metricVisType = Private(MetricVisProvider);
+      const indexPattern = Private(LogstashIndexPatternStubProvider);
+
+      indexPattern.stubSetFieldFormat('ip', 'url', {
+        urlTemplate: 'http://ip.info?address={{value}}',
+        labelTemplate: 'ip[{{value}}]'
+      });
+
+      const vis = new Vis(indexPattern, {
+        type: 'metric',
+        aggs: [{ id: '1', type: 'top_hits', schema: 'metric', params: { field: 'ip' } }],
+      });
+
+      const $el = $('<div>');
+      const renderbot = metricVisType.createRenderbot(vis, $el);
+      const render = (esResponse) => {
+        renderbot.render(esResponse);
+        $rootScope.$digest();
+      };
+
+      return { $el, render };
+    };
+  }));
+
+  it('renders html value from field formatter', () => {
+    const { $el, render } = setup();
+
+    const ip = '235.195.237.208';
+    render({
+      hits: { total: 0, hits: [] },
+      aggregations: {
+        '1': {
+          hits: { total: 1, hits: [{ _source: { ip } }] }
+        }
+      }
+    });
+
+    const $link = $el
+      .find('a[href]')
+      .filter(function () { return this.href.includes('ip.info'); });
+
+    expect($link).to.have.length(1);
+    expect($link.text()).to.be(`ip[${ip}]`);
+  });
+});

src/core_plugins/metric_vis/public/metric_vis.html

@@ -1,6 +1,6 @@
 <div ng-controller="KbnMetricVisController" class="metric-vis">
   <div class="metric-container" ng-repeat="metric in metrics">
-      <div class="metric-value" ng-style="{'font-size': vis.params.fontSize+'pt'}">{{metric.value}}</div>
+      <div class="metric-value" ng-bind-html="metric.value" ng-style="{'font-size': vis.params.fontSize+'pt'}"></div>
       <div>{{metric.label}}</div>
   </div>
 </div>

src/test_utils/stub_index_pattern.js

@@ -1,19 +1,17 @@
 import _ from 'lodash';
 import sinon from 'sinon';
 import Promise from 'bluebird';
-import IndexedArray from 'ui/indexed_array';
 import IndexPattern from 'ui/index_patterns/_index_pattern';
 import formatHit from 'ui/index_patterns/_format_hit';
 import getComputedFields from 'ui/index_patterns/_get_computed_fields';
 import RegistryFieldFormatsProvider from 'ui/registry/field_formats';
 import IndexPatternsFlattenHitProvider from 'ui/index_patterns/_flatten_hit';
-import IndexPatternsFieldProvider from 'ui/index_patterns/_field';
+import IndexPatternsFieldListProvider from 'ui/index_patterns/_field_list';
 
 export default function (Private) {
   const fieldFormats = Private(RegistryFieldFormatsProvider);
   const flattenHit = Private(IndexPatternsFlattenHitProvider);
-
-  const Field = Private(IndexPatternsFieldProvider);
+  const FieldList = Private(IndexPatternsFieldListProvider);
 
   function StubIndexPattern(pattern, timeField, fields) {
     this.id = pattern;
@@ -39,17 +37,17 @@ export default function (Private) {
     this.formatHit = formatHit(this, fieldFormats.getDefaultInstance('string'));
     this.formatField = this.formatHit.formatField;
 
-    this._indexFields = function () {
-      this.fields = new IndexedArray({
-        index: ['name'],
-        group: ['type'],
-        initialSet: fields.map(function (field) {
-          return new Field(this, field);
-        }, this)
-      });
+    this._reindexFields = function () {
+      this.fields = new FieldList(this, this.fields || fields);
     };
 
-    this._indexFields();
+    this.stubSetFieldFormat = function (fieldName, id, params) {
+      const FieldFormat = fieldFormats.byId[id];
+      this.fieldFormatMap[fieldName] = new FieldFormat(params);
+      this._reindexFields();
+    };
+
+    this._reindexFields();
   }
 
   return StubIndexPattern;

src/ui/public/agg_types/__tests__/buckets/_range.js

@@ -6,7 +6,7 @@ import resp from 'fixtures/agg_resp/range';
 import AggTypesIndexProvider from 'ui/agg_types/index';
 import VisProvider from 'ui/vis';
 import FixturesStubbedLogstashIndexPatternProvider from 'fixtures/stubbed_logstash_index_pattern';
-import RegistryFieldFormatsProvider from 'ui/registry/field_formats';
+
 describe('Range Agg', function () {
 
   const buckets = values(resp.aggregations[1].buckets);
@@ -20,14 +20,9 @@ describe('Range Agg', function () {
     range = Private(AggTypesIndexProvider).byName.range;
     Vis = Private(VisProvider);
     indexPattern = Private(FixturesStubbedLogstashIndexPatternProvider);
-
-    const BytesFormat = Private(RegistryFieldFormatsProvider).byId.bytes;
-
-    indexPattern.fieldFormatMap.bytes = new BytesFormat({
+    indexPattern.stubSetFieldFormat('bytes', 'bytes', {
       pattern: '0,0.[000] b'
     });
-
-    indexPattern._indexFields();
   }));
 
   describe('formating', function () {

src/ui/public/field_editor/__tests__/field_editor.js

@@ -2,14 +2,13 @@ import $ from 'jquery';
 import ngMock from 'ng_mock';
 import expect from 'expect.js';
 import IndexPatternsFieldProvider from 'ui/index_patterns/_field';
-import RegistryFieldFormatsProvider from 'ui/registry/field_formats';
+
 import FixturesStubbedLogstashIndexPatternProvider from 'fixtures/stubbed_logstash_index_pattern';
 import _ from 'lodash';
 
 describe('FieldEditor directive', function () {
 
   let Field;
-  let StringFormat;
   let $rootScope;
 
   let compile;
@@ -27,12 +26,9 @@ describe('FieldEditor directive', function () {
 
     $rootScope = $injector.get('$rootScope');
     Field = Private(IndexPatternsFieldProvider);
-    StringFormat = Private(RegistryFieldFormatsProvider).getType('string');
 
     $rootScope.indexPattern = Private(FixturesStubbedLogstashIndexPatternProvider);
-    // set the field format for this field
-    $rootScope.indexPattern.fieldFormatMap.time = new StringFormat({ foo: 1, bar: 2 });
-    $rootScope.indexPattern._indexFields();
+    $rootScope.indexPattern.stubSetFieldFormat('time', 'string', { foo: 1, bar: 2 });
     $rootScope.field = $rootScope.indexPattern.fields.byName.time;
 
     compile = function () {

src/ui/public/index_patterns/__tests__/_field_format.js

@@ -2,6 +2,7 @@ import _ from 'lodash';
 import expect from 'expect.js';
 import ngMock from 'ng_mock';
 import IndexPatternsFieldFormatFieldFormatProvider from 'ui/index_patterns/_field_format/field_format';
+
 describe('FieldFormat class', function () {
 
   let FieldFormat;
@@ -86,7 +87,7 @@ describe('FieldFormat class', function () {
         const html = f.getConverterFor('html');
         expect(text).to.not.be(html);
         expect(text('formatted')).to.be('formatted');
-        expect(html('formatted')).to.be('formatted');
+        expect(html('formatted')).to.be('<span ng-non-bindable>formatted</span>');
       });
 
       it('can be an object, with seperate text and html converter', function () {
@@ -100,7 +101,7 @@ describe('FieldFormat class', function () {
         const html = f.getConverterFor('html');
         expect(text).to.not.be(html);
         expect(text('formatted text')).to.be('formatted text');
-        expect(html('formatted html')).to.be('formatted html');
+        expect(html('formatted html')).to.be('<span ng-non-bindable>formatted html</span>');
       });
 
       it('does not escape the output of the text converter', function () {
@@ -112,7 +113,8 @@ describe('FieldFormat class', function () {
       it('does escape the output of the text converter if used in an html context', function () {
         TestFormat.prototype._convert = _.constant('<script>alert("xxs");</script>');
         const f = new TestFormat();
-        expect(f.convert('', 'html')).to.not.contain('<');
+        expect(_.trimRight(_.trimLeft(f.convert('', 'html'), '<span ng-non-bindable>'), '</span>'))
+          .to.not.contain('<');
       });
 
       it('does not escape the output of an html specific converter', function () {
@@ -123,7 +125,7 @@ describe('FieldFormat class', function () {
 
         const f = new TestFormat();
         expect(f.convert('', 'text')).to.be('<img>');
-        expect(f.convert('', 'html')).to.be('<img>');
+        expect(f.convert('', 'html')).to.be('<span ng-non-bindable><img></span>');
       });
     });
 
@@ -145,7 +147,7 @@ describe('FieldFormat class', function () {
         };
 
         const f = new TestFormat();
-        expect(f.convert('val', 'html')).to.be('html');
+        expect(f.convert('val', 'html')).to.be('<span ng-non-bindable>html</span>');
       });
 
       it('formats a value as " - " when no value is specified', function () {

src/ui/public/index_patterns/_field_format/__tests__/content_types.js

@@ -0,0 +1,99 @@
+import angular from 'angular';
+import $ from 'jquery';
+import ngMock from 'ng_mock';
+import sinon from 'sinon';
+import expect from 'expect.js';
+import { escape } from 'lodash';
+
+import IndexPatternsFieldFormatContentTypesProvider from '../content_types';
+
+describe('index_patterns/_field_format/content_types', () => {
+
+  let render;
+  const callMe = sinon.stub();
+  afterEach(() => callMe.reset());
+
+  function getAllContents(node) {
+    return [...node.childNodes].reduce((acc, child) => {
+      return acc.concat(child, getAllContents(child));
+    }, []);
+  }
+
+  angular.module('testApp', [])
+    .directive('testDirective', () => ({
+      restrict: 'EACM',
+      link: callMe
+    }));
+
+  beforeEach(ngMock.module('testApp'));
+  beforeEach(ngMock.inject(($injector) => {
+    const contentTypes = new IndexPatternsFieldFormatContentTypesProvider();
+    const $rootScope = $injector.get('$rootScope');
+    const $compile = $injector.get('$compile');
+
+    $rootScope.callMe = callMe;
+
+    render = (convert) => {
+      const $el = $('<div>');
+      const { html } = contentTypes.setup({ _convert: { html: convert } });
+      $compile($el.html(html(`
+        <!-- directive: test-directive -->
+        <div></div>
+        <test-directive>{{callMe()}}</test-directive>
+        <span test-directive></span>
+        <marquee class="test-directive"></marquee>
+      `)))($rootScope);
+      return $el;
+    };
+  }));
+
+  it('no element directive', () => {
+    const $el = render(value => `
+      <test-directive>${escape(value)}</test-directive>
+    `);
+
+    expect($el.find('test-directive')).to.have.length(1);
+    sinon.assert.notCalled(callMe);
+  });
+
+  it('no attribute directive', () => {
+    const $el = render(value => `
+      <div test-directive>${escape(value)}</div>
+    `);
+
+    expect($el.find('[test-directive]')).to.have.length(1);
+    sinon.assert.notCalled(callMe);
+  });
+
+  it('no comment directive', () => {
+    const $el = render(value => `
+      <!-- directive: test-directive -->
+      <div>${escape(value)}</div>
+    `);
+
+    const comments = getAllContents($el.get(0))
+      .filter(node => node.nodeType === 8);
+
+    expect(comments).to.have.length(1);
+    expect(comments[0].textContent).to.contain('test-directive');
+    sinon.assert.notCalled(callMe);
+  });
+
+  it('no class directive', () => {
+    const $el = render(value => `
+      <div class="test-directive">${escape(value)}</div>
+    `);
+
+    expect($el.find('.test-directive')).to.have.length(1);
+    sinon.assert.notCalled(callMe);
+  });
+
+  it('no interpolation', () => {
+    const $el = render(value => `
+      <div class="foo {{callMe()}}">${escape(value)}</div>
+    `);
+
+    expect($el.find('.foo')).to.have.length(1);
+    sinon.assert.notCalled(callMe);
+  });
+});

src/ui/public/index_patterns/_field_format/content_types.js

@@ -5,7 +5,7 @@ export default function contentTypesProvider() {
 
   const types = {
     html: function (format, convert) {
-      return function recurse(value, field, hit) {
+      function recurse(value, field, hit) {
         if (value == null) {
           return _.asPrettyString(value);
         }
@@ -22,6 +22,10 @@ export default function contentTypesProvider() {
         });
 
         return subVals.join(',' + (useMultiLine ? '\n' : ' '));
+      }
+
+      return function (...args) {
+        return `<span ng-non-bindable>${recurse(...args)}</span>`;
       };
     },
 

src/ui/public/stringify/__tests__/_color.js

@@ -21,10 +21,14 @@ describe('Color Format', function () {
           background: 'yellow'
         }]
       });
-      expect(colorer.convert(99, 'html')).to.eql('99');
-      expect(colorer.convert(100, 'html')).to.eql('<span style="color: blue;background-color: yellow;">100</span>');
-      expect(colorer.convert(150, 'html')).to.eql('<span style="color: blue;background-color: yellow;">150</span>');
-      expect(colorer.convert(151, 'html')).to.eql('151');
+      expect(colorer.convert(99, 'html')).to.eql('<span ng-non-bindable>99</span>');
+      expect(colorer.convert(100, 'html')).to.eql(
+        '<span ng-non-bindable><span style="color: blue;background-color: yellow;">100</span></span>'
+      );
+      expect(colorer.convert(150, 'html')).to.eql(
+        '<span ng-non-bindable><span style="color: blue;background-color: yellow;">150</span></span>'
+      );
+      expect(colorer.convert(151, 'html')).to.eql('<span ng-non-bindable>151</span>');
     });
 
     it('should not convert invalid ranges', function () {
@@ -36,7 +40,7 @@ describe('Color Format', function () {
           background: 'yellow'
         }]
       });
-      expect(colorer.convert(99, 'html')).to.eql('99');
+      expect(colorer.convert(99, 'html')).to.eql('<span ng-non-bindable>99</span>');
     });
   });
 
@@ -52,15 +56,23 @@ describe('Color Format', function () {
       });
 
       const converter = colorer.getConverterFor('html');
-      expect(converter('B', 'html')).to.eql('B');
-      expect(converter('AAA', 'html')).to.eql('<span style="color: blue;background-color: yellow;">AAA</span>');
-      expect(converter('AB', 'html')).to.eql('<span style="color: blue;background-color: yellow;">AB</span>');
-      expect(converter('a', 'html')).to.eql('a');
+      expect(converter('B', 'html')).to.eql('<span ng-non-bindable>B</span>');
+      expect(converter('AAA', 'html')).to.eql(
+        '<span ng-non-bindable><span style="color: blue;background-color: yellow;">AAA</span></span>'
+      );
+      expect(converter('AB', 'html')).to.eql(
+        '<span ng-non-bindable><span style="color: blue;background-color: yellow;">AB</span></span>'
+      );
+      expect(converter('a', 'html')).to.eql('<span ng-non-bindable>a</span>');
 
-      expect(converter('B', 'html')).to.eql('B');
-      expect(converter('AAA', 'html')).to.eql('<span style="color: blue;background-color: yellow;">AAA</span>');
-      expect(converter('AB', 'html')).to.eql('<span style="color: blue;background-color: yellow;">AB</span>');
-      expect(converter('a', 'html')).to.eql('a');
+      expect(converter('B', 'html')).to.eql('<span ng-non-bindable>B</span>');
+      expect(converter('AAA', 'html')).to.eql(
+        '<span ng-non-bindable><span style="color: blue;background-color: yellow;">AAA</span></span>'
+      );
+      expect(converter('AB', 'html')).to.eql(
+        '<span ng-non-bindable><span style="color: blue;background-color: yellow;">AB</span></span>'
+      );
+      expect(converter('a', 'html')).to.eql('<span ng-non-bindable>a</span>');
     });
   });
 });

src/ui/public/stringify/__tests__/_source.js

@@ -29,12 +29,14 @@ describe('_source formatting', function () {
 
     it('should use the text content type if a field is not passed', function () {
       const hit = _.first(hits);
-      expect(convertHtml(hit._source)).to.be(JSON.stringify(hit._source));
+      expect(convertHtml(hit._source)).to.be(`<span ng-non-bindable>${JSON.stringify(hit._source)}</span>`);
     });
 
     it('uses the _source, field, and hit to create a <dl>', function () {
       const hit = _.first(hits);
-      const $dl = $(convertHtml(hit._source, indexPattern.fields.byName._source, hit));
+      const $nonBindable = $(convertHtml(hit._source, indexPattern.fields.byName._source, hit));
+      expect($nonBindable.is('span[ng-non-bindable]')).to.be.ok();
+      const $dl = $nonBindable.children();
       expect($dl.is('dl')).to.be.ok();
       expect($dl.find('dt')).to.have.length(_.keys(indexPattern.flattenHit(hit)).length);
     });

src/ui/public/stringify/__tests__/_url.js

@@ -11,6 +11,11 @@ describe('Url Format', function () {
     fieldFormats = Private(RegistryFieldFormatsProvider);
   }));
 
+  const unwrap = $el => {
+    expect($el.is('span[ng-non-bindable]')).to.be.ok();
+    return $el.children();
+  };
+
   describe('Url Format', function () {
     let Url;
 
@@ -21,7 +26,7 @@ describe('Url Format', function () {
     it('ouputs a simple <a> tab by default', function () {
       const url = new Url();
 
-      const $a = $(url.convert('http://elastic.co', 'html'));
+      const $a = unwrap($(url.convert('http://elastic.co', 'html')));
       expect($a.is('a')).to.be(true);
       expect($a.size()).to.be(1);
       expect($a.attr('href')).to.be('http://elastic.co');
@@ -32,7 +37,7 @@ describe('Url Format', function () {
     it('outputs an <image> if type === "img"', function () {
       const url = new Url({ type: 'img' });
 
-      const $img = $(url.convert('http://elastic.co', 'html'));
+      const $img = unwrap($(url.convert('http://elastic.co', 'html')));
       expect($img.is('img')).to.be(true);
       expect($img.attr('src')).to.be('http://elastic.co');
     });
@@ -40,7 +45,7 @@ describe('Url Format', function () {
     describe('url template', function () {
       it('accepts a template', function () {
         const url = new Url({ urlTemplate: 'url: {{ value }}' });
-        const $a = $(url.convert('url', 'html'));
+        const $a = unwrap($(url.convert('url', 'html')));
         expect($a.is('a')).to.be(true);
         expect($a.size()).to.be(1);
         expect($a.attr('href')).to.be('url: url');
@@ -57,7 +62,7 @@ describe('Url Format', function () {
     describe('label template', function () {
       it('accepts a template', function () {
         const url = new Url({ labelTemplate: 'extension: {{ value }}' });
-        const $a = $(url.convert('php', 'html'));
+        const $a = unwrap($(url.convert('php', 'html')));
         expect($a.is('a')).to.be(true);
         expect($a.size()).to.be(1);
         expect($a.attr('href')).to.be('php');