+ This demonstrates a single endpoint with streaming support that sends Redux inspired + actions from server to client. The server and client share types of the data to be + received. The client uses a custom hook that receives stream chunks and passes them on to + `useReducer()` that acts on the Redux type actions it receives. The custom hook includes + code to buffer actions and is able to apply them in bulk so the DOM does not get hammered + with updates. Hit "Start development" to trigger the bar chart race! +
+{getStatusMessage(isRunning, isCancelled, data.progress)}
++ This demonstrates a single endpoint with streaming support that sends just chunks of a + string from server to client. The client uses a custom hook that receives stream chunks + and passes them on to `useReducer()` that acts on the string chunks it receives. The + custom hook includes code to buffer chunks and is able to apply them in bulk so the DOM + does not get hammered with updates. Hit "Start" to trigger the stream! +
+{data}
+{error}
+{{name}}
{{#link}}Hello{{/link}}{{/form}}' +< ) +--- +> it('nested block helpers', () => { +> expectTemplate('{{#form yehuda}}{{name}}
{{#link}}Hello{{/link}}{{/form}}') +235c218 +< yehuda: { name: 'Yehuda' } +--- +> yehuda: { name: 'Yehuda' }, +237c220 +< .withHelper('link', function(options) { +--- +> .withHelper('link', function (this: any, options) { +240c223 +< .withHelper('form', function(context, options) { +--- +> .withHelper('form', function (context, options) { +243d225 +< .withMessage('Both blocks executed') +247,249c229,231 +< it('block helper inverted sections', function() { +< var string = "{{#list people}}{{name}}{{^}}Nobody's here{{/list}}"; +< function list(context, options) { +--- +> it('block helper inverted sections', () => { +> const string = "{{#list people}}{{name}}{{^}}Nobody's here{{/list}}"; +> function list(this: any, context: any, options: Handlebars.HelperOptions) { +251,252c233,234 +< var out = '{{name}}
{{/form}}') + .withInput({ name: 'Yehuda' }) + .withHelper('form', function (this: any, options) { + return ''; + }) + .toCompileTo(''); + }); + + it('block helper should have context in this', () => { + function link(this: any, options: Handlebars.HelperOptions) { + return '' + options.fn(this) + ''; + } + + expectTemplate('{{name}}
{{/form}}') + .withInput({ yehuda: { name: 'Yehuda' } }) + .withHelper('form', function (context, options) { + return ''; + }) + .toCompileTo(''); + }); + + it('block helper passing a complex path context', () => { + expectTemplate('{{#form yehuda/cat}}{{name}}
{{/form}}') + .withInput({ yehuda: { name: 'Yehuda', cat: { name: 'Harold' } } }) + .withHelper('form', function (context, options) { + return ''; + }) + .toCompileTo(''); + }); + + it('nested block helpers', () => { + expectTemplate('{{#form yehuda}}{{name}}
{{#link}}Hello{{/link}}{{/form}}') + .withInput({ + yehuda: { name: 'Yehuda' }, + }) + .withHelper('link', function (this: any, options) { + return '' + options.fn(this) + ''; + }) + .withHelper('form', function (context, options) { + return ''; + }) + .toCompileTo(''); + }); + + it('block helper inverted sections', () => { + const string = "{{#list people}}{{name}}{{^}}Nobody's here{{/list}}"; + function list(this: any, context: any, options: Handlebars.HelperOptions) { + if (context.length > 0) { + let out = '' + options.inverse(this) + '
'; + } + } + + // the meaning here may be kind of hard to catch, but list.not is always called, + // so we should see the output of both + expectTemplate(string) + .withInput({ people: [{ name: 'Alan' }, { name: 'Yehuda' }] }) + .withHelpers({ list }) + .toCompileTo('Nobody's here
"); + + expectTemplate('{{#list people}}Hello{{^}}{{message}}{{/list}}') + .withInput({ + people: [], + message: "Nobody's here", + }) + .withHelpers({ list }) + .toCompileTo('Nobody's here
'); + }); + + it('pathed lambas with parameters', () => { + const hash = { + helper: () => 'winning', + }; + // @ts-expect-error + hash.hash = hash; + + const helpers = { + './helper': () => 'fail', + }; + + expectTemplate('{{./helper 1}}').withInput(hash).withHelpers(helpers).toCompileTo('winning'); + expectTemplate('{{hash/helper 1}}').withInput(hash).withHelpers(helpers).toCompileTo('winning'); + }); + + describe('helpers hash', () => { + it('providing a helpers hash', () => { + expectTemplate('Goodbye {{cruel}} {{world}}!') + .withInput({ cruel: 'cruel' }) + .withHelpers({ + world() { + return 'world'; + }, + }) + .toCompileTo('Goodbye cruel world!'); + + expectTemplate('Goodbye {{#iter}}{{cruel}} {{world}}{{/iter}}!') + .withInput({ iter: [{ cruel: 'cruel' }] }) + .withHelpers({ + world() { + return 'world'; + }, + }) + .toCompileTo('Goodbye cruel world!'); + }); + + it('in cases of conflict, helpers win', () => { + expectTemplate('{{{lookup}}}') + .withInput({ lookup: 'Explicit' }) + .withHelpers({ + lookup() { + return 'helpers'; + }, + }) + .toCompileTo('helpers'); + + expectTemplate('{{lookup}}') + .withInput({ lookup: 'Explicit' }) + .withHelpers({ + lookup() { + return 'helpers'; + }, + }) + .toCompileTo('helpers'); + }); + + it('the helpers hash is available is nested contexts', () => { + expectTemplate('{{#outer}}{{#inner}}{{helper}}{{/inner}}{{/outer}}') + .withInput({ outer: { inner: { unused: [] } } }) + .withHelpers({ + helper() { + return 'helper'; + }, + }) + .toCompileTo('helper'); + }); + + it('the helper hash should augment the global hash', () => { + kbnHandlebarsEnv!.registerHelper('test_helper', function () { + return 'found it!'; + }); + + expectTemplate('{{test_helper}} {{#if cruel}}Goodbye {{cruel}} {{world}}!{{/if}}') + .withInput({ cruel: 'cruel' }) + .withHelpers({ + world() { + return 'world!'; + }, + }) + .toCompileTo('found it! Goodbye cruel world!!'); + }); + }); + + describe('registration', () => { + it('unregisters', () => { + deleteAllKeys(kbnHandlebarsEnv!.helpers); + + kbnHandlebarsEnv!.registerHelper('foo', function () { + return 'fail'; + }); + expect(kbnHandlebarsEnv!.helpers.foo).toBeDefined(); + kbnHandlebarsEnv!.unregisterHelper('foo'); + expect(kbnHandlebarsEnv!.helpers.foo).toBeUndefined(); + }); + + it('allows multiple globals', () => { + const ifHelper = kbnHandlebarsEnv!.helpers.if; + deleteAllKeys(kbnHandlebarsEnv!.helpers); + + kbnHandlebarsEnv!.registerHelper({ + if: ifHelper, + world() { + return 'world!'; + }, + testHelper() { + return 'found it!'; + }, + }); + + expectTemplate('{{testHelper}} {{#if cruel}}Goodbye {{cruel}} {{world}}!{{/if}}') + .withInput({ cruel: 'cruel' }) + .toCompileTo('found it! Goodbye cruel world!!'); + }); + + it('fails with multiple and args', () => { + expect(() => { + kbnHandlebarsEnv!.registerHelper( + // @ts-expect-error TypeScript is complaining about the invalid input just as the thrown error + { + world() { + return 'world!'; + }, + testHelper() { + return 'found it!'; + }, + }, + {} + ); + }).toThrow('Arg not supported with multiple helpers'); + }); + }); + + it('decimal number literals work', () => { + expectTemplate('Message: {{hello -1.2 1.2}}') + .withHelper('hello', function (times, times2) { + if (typeof times !== 'number') { + times = 'NaN'; + } + if (typeof times2 !== 'number') { + times2 = 'NaN'; + } + return 'Hello ' + times + ' ' + times2 + ' times'; + }) + .toCompileTo('Message: Hello -1.2 1.2 times'); + }); + + it('negative number literals work', () => { + expectTemplate('Message: {{hello -12}}') + .withHelper('hello', function (times) { + if (typeof times !== 'number') { + times = 'NaN'; + } + return 'Hello ' + times + ' times'; + }) + .toCompileTo('Message: Hello -12 times'); + }); + + describe('String literal parameters', () => { + it('simple literals work', () => { + expectTemplate('Message: {{hello "world" 12 true false}}') + .withHelper('hello', function (param, times, bool1, bool2) { + if (typeof times !== 'number') { + times = 'NaN'; + } + if (typeof bool1 !== 'boolean') { + bool1 = 'NaB'; + } + if (typeof bool2 !== 'boolean') { + bool2 = 'NaB'; + } + return 'Hello ' + param + ' ' + times + ' times: ' + bool1 + ' ' + bool2; + }) + .toCompileTo('Message: Hello world 12 times: true false'); + }); + + it('using a quote in the middle of a parameter raises an error', () => { + expectTemplate('Message: {{hello wo"rld"}}').toThrow(Error); + }); + + it('escaping a String is possible', () => { + expectTemplate('Message: {{{hello "\\"world\\""}}}') + .withHelper('hello', function (param) { + return 'Hello ' + param; + }) + .toCompileTo('Message: Hello "world"'); + }); + + it("it works with ' marks", () => { + expectTemplate('Message: {{{hello "Alan\'s world"}}}') + .withHelper('hello', function (param) { + return 'Hello ' + param; + }) + .toCompileTo("Message: Hello Alan's world"); + }); + }); + + describe('multiple parameters', () => { + it('simple multi-params work', () => { + expectTemplate('Message: {{goodbye cruel world}}') + .withInput({ cruel: 'cruel', world: 'world' }) + .withHelper('goodbye', function (cruel, world) { + return 'Goodbye ' + cruel + ' ' + world; + }) + .toCompileTo('Message: Goodbye cruel world'); + }); + + it('block multi-params work', () => { + expectTemplate('Message: {{#goodbye cruel world}}{{greeting}} {{adj}} {{noun}}{{/goodbye}}') + .withInput({ cruel: 'cruel', world: 'world' }) + .withHelper('goodbye', function (cruel, world, options) { + return options.fn({ greeting: 'Goodbye', adj: cruel, noun: world }); + }) + .toCompileTo('Message: Goodbye cruel world'); + }); + }); + + describe('hash', () => { + it('helpers can take an optional hash', () => { + expectTemplate('{{goodbye cruel="CRUEL" world="WORLD" times=12}}') + .withHelper('goodbye', function (options) { + return ( + 'GOODBYE ' + + options.hash.cruel + + ' ' + + options.hash.world + + ' ' + + options.hash.times + + ' TIMES' + ); + }) + .toCompileTo('GOODBYE CRUEL WORLD 12 TIMES'); + }); + + it('helpers can take an optional hash with booleans', () => { + function goodbye(options: Handlebars.HelperOptions) { + if (options.hash.print === true) { + return 'GOODBYE ' + options.hash.cruel + ' ' + options.hash.world; + } else if (options.hash.print === false) { + return 'NOT PRINTING'; + } else { + return 'THIS SHOULD NOT HAPPEN'; + } + } + + expectTemplate('{{goodbye cruel="CRUEL" world="WORLD" print=true}}') + .withHelper('goodbye', goodbye) + .toCompileTo('GOODBYE CRUEL WORLD'); + + expectTemplate('{{goodbye cruel="CRUEL" world="WORLD" print=false}}') + .withHelper('goodbye', goodbye) + .toCompileTo('NOT PRINTING'); + }); + + it('block helpers can take an optional hash', () => { + expectTemplate('{{#goodbye cruel="CRUEL" times=12}}world{{/goodbye}}') + .withHelper('goodbye', function (this: any, options) { + return ( + 'GOODBYE ' + + options.hash.cruel + + ' ' + + options.fn(this) + + ' ' + + options.hash.times + + ' TIMES' + ); + }) + .toCompileTo('GOODBYE CRUEL world 12 TIMES'); + }); + + it('block helpers can take an optional hash with single quoted stings', () => { + expectTemplate('{{#goodbye cruel="CRUEL" times=12}}world{{/goodbye}}') + .withHelper('goodbye', function (this: any, options) { + return ( + 'GOODBYE ' + + options.hash.cruel + + ' ' + + options.fn(this) + + ' ' + + options.hash.times + + ' TIMES' + ); + }) + .toCompileTo('GOODBYE CRUEL world 12 TIMES'); + }); + + it('block helpers can take an optional hash with booleans', () => { + function goodbye(this: any, options: Handlebars.HelperOptions) { + if (options.hash.print === true) { + return 'GOODBYE ' + options.hash.cruel + ' ' + options.fn(this); + } else if (options.hash.print === false) { + return 'NOT PRINTING'; + } else { + return 'THIS SHOULD NOT HAPPEN'; + } + } + + expectTemplate('{{#goodbye cruel="CRUEL" print=true}}world{{/goodbye}}') + .withHelper('goodbye', goodbye) + .toCompileTo('GOODBYE CRUEL world'); + + expectTemplate('{{#goodbye cruel="CRUEL" print=false}}world{{/goodbye}}') + .withHelper('goodbye', goodbye) + .toCompileTo('NOT PRINTING'); + }); + }); + + describe('helperMissing', () => { + it('if a context is not found, helperMissing is used', () => { + expectTemplate('{{hello}} {{link_to world}}').toThrow(/Missing helper: "link_to"/); + }); + + it('if a context is not found, custom helperMissing is used', () => { + expectTemplate('{{hello}} {{link_to world}}') + .withInput({ hello: 'Hello', world: 'world' }) + .withHelper('helperMissing', function (mesg, options) { + if (options.name === 'link_to') { + return new Handlebars.SafeString('' + mesg + ''); + } + }) + .toCompileTo('Hello world'); + }); + + it('if a value is not found, custom helperMissing is used', () => { + expectTemplate('{{hello}} {{link_to}}') + .withInput({ hello: 'Hello', world: 'world' }) + .withHelper('helperMissing', function (options) { + if (options.name === 'link_to') { + return new Handlebars.SafeString('winning'); + } + }) + .toCompileTo('Hello winning'); + }); + }); + + describe('knownHelpers', () => { + it('Known helper should render helper', () => { + expectTemplate('{{hello}}') + .withCompileOptions({ + knownHelpers: { hello: true }, + }) + .withHelper('hello', function () { + return 'foo'; + }) + .toCompileTo('foo'); + }); + + it('Unknown helper in knownHelpers only mode should be passed as undefined', () => { + expectTemplate('{{typeof hello}}') + .withCompileOptions({ + knownHelpers: { typeof: true }, + knownHelpersOnly: true, + }) + .withHelper('typeof', function (arg) { + return typeof arg; + }) + .withHelper('hello', function () { + return 'foo'; + }) + .toCompileTo('undefined'); + }); + + it('Builtin helpers available in knownHelpers only mode', () => { + expectTemplate('{{#unless foo}}bar{{/unless}}') + .withCompileOptions({ + knownHelpersOnly: true, + }) + .toCompileTo('bar'); + }); + + it('Field lookup works in knownHelpers only mode', () => { + expectTemplate('{{foo}}') + .withCompileOptions({ + knownHelpersOnly: true, + }) + .withInput({ foo: 'bar' }) + .toCompileTo('bar'); + }); + + it('Conditional blocks work in knownHelpers only mode', () => { + expectTemplate('{{#foo}}bar{{/foo}}') + .withCompileOptions({ + knownHelpersOnly: true, + }) + .withInput({ foo: 'baz' }) + .toCompileTo('bar'); + }); + + it('Invert blocks work in knownHelpers only mode', () => { + expectTemplate('{{^foo}}bar{{/foo}}') + .withCompileOptions({ + knownHelpersOnly: true, + }) + .withInput({ foo: false }) + .toCompileTo('bar'); + }); + + it('Functions are bound to the context in knownHelpers only mode', () => { + expectTemplate('{{foo}}') + .withCompileOptions({ + knownHelpersOnly: true, + }) + .withInput({ + foo() { + return this.bar; + }, + bar: 'bar', + }) + .toCompileTo('bar'); + }); + + it('Unknown helper call in knownHelpers only mode should throw', () => { + expectTemplate('{{typeof hello}}') + .withCompileOptions({ knownHelpersOnly: true }) + .toThrow(Error); + }); + }); + + describe('blockHelperMissing', () => { + it('lambdas are resolved by blockHelperMissing, not handlebars proper', () => { + expectTemplate('{{#truthy}}yep{{/truthy}}') + .withInput({ + truthy() { + return true; + }, + }) + .toCompileTo('yep'); + }); + + it('lambdas resolved by blockHelperMissing are bound to the context', () => { + expectTemplate('{{#truthy}}yep{{/truthy}}') + .withInput({ + truthy() { + return this.truthiness(); + }, + truthiness() { + return false; + }, + }) + .toCompileTo(''); + }); + }); + + describe('name field', () => { + const helpers = { + blockHelperMissing(...args: any[]) { + return 'missing: ' + args[args.length - 1].name; + }, + helperMissing(...args: any[]) { + return 'helper missing: ' + args[args.length - 1].name; + }, + helper(...args: any[]) { + return 'ran: ' + args[args.length - 1].name; + }, + }; + + it('should include in ambiguous mustache calls', () => { + expectTemplate('{{helper}}').withHelpers(helpers).toCompileTo('ran: helper'); + }); + + it('should include in helper mustache calls', () => { + expectTemplate('{{helper 1}}').withHelpers(helpers).toCompileTo('ran: helper'); + }); + + it('should include in ambiguous block calls', () => { + expectTemplate('{{#helper}}{{/helper}}').withHelpers(helpers).toCompileTo('ran: helper'); + }); + + it('should include in simple block calls', () => { + expectTemplate('{{#./helper}}{{/./helper}}') + .withHelpers(helpers) + .toCompileTo('missing: ./helper'); + }); + + it('should include in helper block calls', () => { + expectTemplate('{{#helper 1}}{{/helper}}').withHelpers(helpers).toCompileTo('ran: helper'); + }); + + it('should include in known helper calls', () => { + expectTemplate('{{helper}}') + .withCompileOptions({ + knownHelpers: { helper: true }, + knownHelpersOnly: true, + }) + .withHelpers(helpers) + .toCompileTo('ran: helper'); + }); + + it('should include full id', () => { + expectTemplate('{{#foo.helper}}{{/foo.helper}}') + .withInput({ foo: {} }) + .withHelpers(helpers) + .toCompileTo('missing: foo.helper'); + }); + + it('should include full id if a hash is passed', () => { + expectTemplate('{{#foo.helper bar=baz}}{{/foo.helper}}') + .withInput({ foo: {} }) + .withHelpers(helpers) + .toCompileTo('helper missing: foo.helper'); + }); + }); + + describe('name conflicts', () => { + it('helpers take precedence over same-named context properties', () => { + expectTemplate('{{goodbye}} {{cruel world}}') + .withHelper('goodbye', function (this: any) { + return this.goodbye.toUpperCase(); + }) + .withHelper('cruel', function (world) { + return 'cruel ' + world.toUpperCase(); + }) + .withInput({ + goodbye: 'goodbye', + world: 'world', + }) + .toCompileTo('GOODBYE cruel WORLD'); + }); + + it('helpers take precedence over same-named context properties$', () => { + expectTemplate('{{#goodbye}} {{cruel world}}{{/goodbye}}') + .withHelper('goodbye', function (this: any, options) { + return this.goodbye.toUpperCase() + options.fn(this); + }) + .withHelper('cruel', function (world) { + return 'cruel ' + world.toUpperCase(); + }) + .withInput({ + goodbye: 'goodbye', + world: 'world', + }) + .toCompileTo('GOODBYE cruel WORLD'); + }); + + it('Scoped names take precedence over helpers', () => { + expectTemplate('{{this.goodbye}} {{cruel world}} {{cruel this.goodbye}}') + .withHelper('goodbye', function (this: any) { + return this.goodbye.toUpperCase(); + }) + .withHelper('cruel', function (world) { + return 'cruel ' + world.toUpperCase(); + }) + .withInput({ + goodbye: 'goodbye', + world: 'world', + }) + .toCompileTo('goodbye cruel WORLD cruel GOODBYE'); + }); + + it('Scoped names take precedence over block helpers', () => { + expectTemplate('{{#goodbye}} {{cruel world}}{{/goodbye}} {{this.goodbye}}') + .withHelper('goodbye', function (this: any, options) { + return this.goodbye.toUpperCase() + options.fn(this); + }) + .withHelper('cruel', function (world) { + return 'cruel ' + world.toUpperCase(); + }) + .withInput({ + goodbye: 'goodbye', + world: 'world', + }) + .toCompileTo('GOODBYE cruel WORLD goodbye'); + }); + }); + + describe('block params', () => { + it('should take presedence over context values', () => { + expectTemplate('{{#goodbyes as |value|}}{{value}}{{/goodbyes}}{{value}}') + .withInput({ value: 'foo' }) + .withHelper('goodbyes', function (options) { + expect(options.fn.blockParams).toEqual(1); + return options.fn({ value: 'bar' }, { blockParams: [1, 2] }); + }) + .toCompileTo('1foo'); + }); + + it('should take presedence over helper values', () => { + expectTemplate('{{#goodbyes as |value|}}{{value}}{{/goodbyes}}{{value}}') + .withHelper('value', function () { + return 'foo'; + }) + .withHelper('goodbyes', function (options) { + expect(options.fn.blockParams).toEqual(1); + return options.fn({}, { blockParams: [1, 2] }); + }) + .toCompileTo('1foo'); + }); + + it('should not take presedence over pathed values', () => { + expectTemplate('{{#goodbyes as |value|}}{{./value}}{{/goodbyes}}{{value}}') + .withInput({ value: 'bar' }) + .withHelper('value', function () { + return 'foo'; + }) + .withHelper('goodbyes', function (this: any, options) { + expect(options.fn.blockParams).toEqual(1); + return options.fn(this, { blockParams: [1, 2] }); + }) + .toCompileTo('barfoo'); + }); + + it('should take presednece over parent block params', () => { + let value: number; + expectTemplate( + '{{#goodbyes as |value|}}{{#goodbyes}}{{value}}{{#goodbyes as |value|}}{{value}}{{/goodbyes}}{{/goodbyes}}{{/goodbyes}}{{value}}', + { + beforeEach() { + value = 1; + }, + } + ) + .withInput({ value: 'foo' }) + .withHelper('goodbyes', function (options) { + return options.fn( + { value: 'bar' }, + { + blockParams: options.fn.blockParams === 1 ? [value++, value++] : undefined, + } + ); + }) + .toCompileTo('13foo'); + }); + + it('should allow block params on chained helpers', () => { + expectTemplate('{{#if bar}}{{else goodbyes as |value|}}{{value}}{{/if}}{{value}}') + .withInput({ value: 'foo' }) + .withHelper('goodbyes', function (options) { + expect(options.fn.blockParams).toEqual(1); + return options.fn({ value: 'bar' }, { blockParams: [1, 2] }); + }) + .toCompileTo('1foo'); + }); + }); + + describe('built-in helpers malformed arguments ', () => { + it('if helper - too few arguments', () => { + expectTemplate('{{#if}}{{/if}}').toThrow(/#if requires exactly one argument/); + }); + + it('if helper - too many arguments, string', () => { + expectTemplate('{{#if test "string"}}{{/if}}').toThrow(/#if requires exactly one argument/); + }); + + it('if helper - too many arguments, undefined', () => { + expectTemplate('{{#if test undefined}}{{/if}}').toThrow(/#if requires exactly one argument/); + }); + + it('if helper - too many arguments, null', () => { + expectTemplate('{{#if test null}}{{/if}}').toThrow(/#if requires exactly one argument/); + }); + + it('unless helper - too few arguments', () => { + expectTemplate('{{#unless}}{{/unless}}').toThrow(/#unless requires exactly one argument/); + }); + + it('unless helper - too many arguments', () => { + expectTemplate('{{#unless test null}}{{/unless}}').toThrow( + /#unless requires exactly one argument/ + ); + }); + + it('with helper - too few arguments', () => { + expectTemplate('{{#with}}{{/with}}').toThrow(/#with requires exactly one argument/); + }); + + it('with helper - too many arguments', () => { + expectTemplate('{{#with test "string"}}{{/with}}').toThrow( + /#with requires exactly one argument/ + ); + }); + }); + + describe('the lookupProperty-option', () => { + it('should be passed to custom helpers', () => { + expectTemplate('{{testHelper}}') + .withHelper('testHelper', function testHelper(this: any, options) { + return options.lookupProperty(this, 'testProperty'); + }) + .withInput({ testProperty: 'abc' }) + .toCompileTo('abc'); + }); + }); +}); + +function deleteAllKeys(obj: { [key: string]: any }) { + for (const key of Object.keys(obj)) { + delete obj[key]; + } +} diff --git a/packages/kbn-handlebars/src/upstream/index.regressions.test.ts b/packages/kbn-handlebars/src/upstream/index.regressions.test.ts new file mode 100644 index 0000000000000..fab86d99767eb --- /dev/null +++ b/packages/kbn-handlebars/src/upstream/index.regressions.test.ts @@ -0,0 +1,279 @@ +/* + * This file is forked from the handlebars project (https://github.com/handlebars-lang/handlebars.js), + * and may include modifications made by Elasticsearch B.V. + * Elasticsearch B.V. licenses this file to you under the MIT License. + * See `packages/kbn-handlebars/LICENSE` for more information. + */ + +import { expectTemplate } from '../__jest__/test_bench'; + +describe('Regressions', () => { + it('GH-94: Cannot read property of undefined', () => { + expectTemplate('{{#books}}{{title}}{{author.name}}{{/books}}') + .withInput({ + books: [ + { + title: 'The origin of species', + author: { + name: 'Charles Darwin', + }, + }, + { + title: 'Lazarillo de Tormes', + }, + ], + }) + .toCompileTo('The origin of speciesCharles DarwinLazarillo de Tormes'); + }); + + it("GH-150: Inverted sections print when they shouldn't", () => { + const string = '{{^set}}not set{{/set}} :: {{#set}}set{{/set}}'; + expectTemplate(string).toCompileTo('not set :: '); + expectTemplate(string).withInput({ set: undefined }).toCompileTo('not set :: '); + expectTemplate(string).withInput({ set: false }).toCompileTo('not set :: '); + expectTemplate(string).withInput({ set: true }).toCompileTo(' :: set'); + }); + + it('GH-158: Using array index twice, breaks the template', () => { + expectTemplate('{{arr.[0]}}, {{arr.[1]}}') + .withInput({ arr: [1, 2] }) + .toCompileTo('1, 2'); + }); + + it("bug reported by @fat where lambdas weren't being properly resolved", () => { + const string = + 'This is a slightly more complicated {{thing}}..\n' + + '{{! Just ignore this business. }}\n' + + 'Check this out:\n' + + '{{#hasThings}}\n' + + '+ {i18n.translate('visualizations.missedDataView.errorMessage', { + defaultMessage: `Could not find the data view: {id}`, + values: { + id: error.savedObjectId, + }, + })} +
+ {viewMode === 'edit' && renderMode !== 'edit' && isEditVisEnabled ? ( ++ {i18n.translate('visualizations.missedDataView.editInVisualizeEditor', { + defaultMessage: `Edit in Visualize editor to fix the error`, + })} +
+ ) : null} + + } + /> + ); +}; diff --git a/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts b/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts index 744537b534f95..8fb107f827cd6 100644 --- a/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts +++ b/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts @@ -50,7 +50,11 @@ export const createVisEmbeddableFromObject = let indexPatterns: DataView[] = []; if (vis.type.getUsedIndexPattern) { - indexPatterns = await vis.type.getUsedIndexPattern(vis.params); + try { + indexPatterns = await vis.type.getUsedIndexPattern(vis.params); + } catch (e) { + // nothing to be here + } } else if (vis.data.indexPattern) { indexPatterns = [vis.data.indexPattern]; } diff --git a/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx b/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx index 1ef9eb1153d9e..f3eaa57c74505 100644 --- a/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx +++ b/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx @@ -13,34 +13,45 @@ import React from 'react'; import { render } from 'react-dom'; import { EuiLoadingChart } from '@elastic/eui'; import { Filter, onlyDisabledFiltersChanged } from '@kbn/es-query'; -import type { SavedObjectAttributes, KibanaExecutionContext } from '@kbn/core/public'; +import type { KibanaExecutionContext, SavedObjectAttributes } from '@kbn/core/public'; import { KibanaThemeProvider } from '@kbn/kibana-react-plugin/public'; -import { TimeRange, Query, TimefilterContract } from '@kbn/data-plugin/public'; +import { Query, TimefilterContract, TimeRange } from '@kbn/data-plugin/public'; import type { DataView } from '@kbn/data-views-plugin/public'; import { + Adapters, + AttributeService, + Embeddable, EmbeddableInput, EmbeddableOutput, - Embeddable, IContainer, - Adapters, - SavedObjectEmbeddableInput, ReferenceOrValueEmbeddable, - AttributeService, + SavedObjectEmbeddableInput, + ViewMode, } from '@kbn/embeddable-plugin/public'; import { - IExpressionLoaderParams, + ExpressionAstExpression, ExpressionLoader, ExpressionRenderError, - ExpressionAstExpression, + IExpressionLoaderParams, } from '@kbn/expressions-plugin/public'; import type { RenderMode } from '@kbn/expressions-plugin'; +import { VisualizationMissedDataViewError } from '../components/visualization_missed_data_view_error'; import VisualizationError from '../components/visualization_error'; import { VISUALIZE_EMBEDDABLE_TYPE } from './constants'; -import { Vis, SerializedVis } from '../vis'; -import { getExecutionContext, getExpressions, getTheme, getUiActions } from '../services'; +import { SerializedVis, Vis } from '../vis'; +import { + getApplication, + getExecutionContext, + getExpressions, + getTheme, + getUiActions, +} from '../services'; import { VIS_EVENT_TO_TRIGGER } from './events'; import { VisualizeEmbeddableFactoryDeps } from './visualize_embeddable_factory'; -import { getSavedVisualization } from '../utils/saved_visualize_utils'; +import { + getSavedVisualization, + shouldShowMissedDataViewError, +} from '../utils/saved_visualize_utils'; import { VisSavedObject } from '../types'; import { toExpressionAst } from './to_ast'; @@ -383,9 +394,23 @@ export class VisualizeEmbeddable this.subscriptions.push(this.handler.render$.subscribe(this.onContainerRender)); this.subscriptions.push( - this.getOutput$().subscribe( - ({ error }) => error && render({getStatusMessage(isRunning, isCancelled, data.progress)}
-