typescript indexPatterns service by ppisljar · Pull Request #39247 · elastic/kibana

ppisljar · 2019-06-19T11:29:01Z

Summary

closes #39087 be removing config from this.

Typescript for index patterns service

Some minor changes to API were done:

cache is no longer exposed on indexPatterns, rather there is clearCache() method
delete method no longer exists on indexPatterns, rather there you should call indexPattern.destroy()

Follow-up items to investigate:

remove deprecated methods from src/legacy/ui/public/index_patterns/_field.ts
snapshots in create_index_pattern_wizard/components/step_time_field/__jest__/__snapshots__/step_time_field.test.js.snap were changed to isLoading=false. this feels like the correct behavior but need to confirm it isn't a problem.
error handling for src/legacy/ui/public/index_patterns/index_patterns.ts, specifically if savedObject.find encounters an error

Checklist

Use ~~strikethroughs~~ to remove checklist items you don't feel are applicable to this PR.

This was checked for cross-browser compatibility, including a check against IE11
Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
~~[ ] Documentation was added for features that require explanation or tutorials~~
Unit or functional tests were updated or added to match the most common scenarios
~~[ ] This was checked for keyboard-only and screenreader accessibility~~

For maintainers

This was checked for breaking API changes and was labeled appropriately
~~[ ] This includes a feature addition or change that requires a release note and was labeled appropriately~~

Dev Docs

Minor changes to Index Patterns API

During our efforts to rewrite the index patterns service in TypeScript, we made a few minor changes to the API:

IndexPatterns.cache has been deprecated in favor of the new IndexPatterns.clearCache method.
IndexPatterns.delete has been deprecated. Instead, use the IndexPattern.destroy method on the specific index pattern you which to remove.

import { IndexPatterns, IndexPattern } from 'ui/index_patterns';
const indexPatterns = new IndexPatterns(config, savedObjectsClient);
const indexPattern = new IndexPattern('some-id', config, savedObjectsClient, ...etc);

// old
indexPatterns.cache.clear('some-id');
indexPatterns.delete(indexPattern);

// new
indexPatterns.clearCache('some-id'); // clears pattern matching specific ID from cache
indexPatterns.clearCache(); // clears everything
indexPattern.destroy(); // destroys pattern it is called on

elasticmachine · 2019-06-19T11:29:04Z

Pinging @elastic/kibana-app-arch

elasticmachine · 2019-06-19T11:50:10Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-19T13:13:35Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-19T16:04:15Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-20T11:55:27Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-21T12:51:32Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

lukeelmers

Still reviewing, but I pushed a couple updates to fix some of the issues, including that one with formatHits. Still seeing weirdness in the jest tests, related to mocking the TS files. Didn't have time to do a thorough investigation on that yet.

lukeelmers · 2019-06-21T22:37:21Z

src/legacy/ui/public/index_patterns/_format_hit.ts

hit can be made slightly more restrictive here with Record<string, any>, so I'll update this too.

lukeelmers · 2019-06-21T23:08:48Z

src/legacy/ui/public/index_patterns/_field_list.ts

It's because these should really be in the IndexedArray interface. I'll update this.

elasticmachine · 2019-06-22T00:45:16Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-24T10:50:06Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-24T11:09:50Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-26T12:05:17Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-26T13:50:32Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-26T14:25:16Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-27T08:11:48Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-27T11:57:41Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-27T14:36:10Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-27T15:59:11Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-28T05:14:45Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-28T07:36:48Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-27T00:57:39Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

lizozom

Still lots of work ahead of us, but looks good.
I would put a list of open, unaddressed issues \ questions in the issue's description.

Otherwise, LGTM.

jasonrhodes

LG(E)TM will revert my change in a follow up PR but this isn't broken so we're all good from my perspective for now

# Conflicts: # x-pack/legacy/plugins/ml/public/data_frame/pages/data_frame_new_pivot/components/source_index_preview/use_source_index_data.ts

elasticmachine · 2019-07-29T20:41:56Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-29T22:43:48Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

peteharverson

ML edits LGTM.
One quick question - does the type field in the StaticIndexPattern indicate if the index patten is a rollup type? We need this for the new ML job wizards.

ppisljar · 2019-07-30T09:52:00Z

retest

elasticmachine · 2019-07-30T10:49:16Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-30T17:08:41Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

lukeelmers · 2019-07-30T19:34:03Z

does the type field in the StaticIndexPattern indicate if the index patten is a rollup type?

@peteharverson Exactly, for rollups you should be able to check indexPattern.type === 'rollup'

lukeelmers · 2019-07-30T19:36:23Z

@peteharverson This also may be useful for reference:

kibana/x-pack/legacy/plugins/rollup/public/index_pattern_list/rollup_index_pattern_list_config.js

Lines 8 to 10 in 7ac8e4d

    
           function isRollup(indexPattern) { 
        
             return indexPattern.type === 'rollup' || (indexPattern.get && indexPattern.get('type') === 'rollup'); 
        
           }

…9247) (#42288)

ppisljar added v8.0.0 Team:AppArch release_note:skip Skip the PR/issue when compiling release notes v7.3.0 labels Jun 19, 2019

ppisljar requested review from lukeelmers and streamich June 19, 2019 11:29

ppisljar force-pushed the ts/indexPatterns branch from 6056a39 to 6a003f3 Compare June 19, 2019 12:48

ppisljar force-pushed the ts/indexPatterns branch from 6a003f3 to a64988c Compare June 19, 2019 15:27

ppisljar force-pushed the ts/indexPatterns branch from a64988c to 4db7f3d Compare June 20, 2019 11:29

ppisljar force-pushed the ts/indexPatterns branch from 4db7f3d to 9cab8f2 Compare June 21, 2019 12:23

lukeelmers reviewed Jun 21, 2019

View reviewed changes

nreese mentioned this pull request Jun 26, 2019

[Maps] angular RangeError: Maximum call stack size exceeded warning in console #39087

Closed

jasonrhodes and others added 5 commits July 26, 2019 13:30

Uses core FieldType instead of custom type

f1466d5

Fix tests.

fb5ee15

Address feedback.

24326f7

Fix kbn-es-query types

3004ab0

Finish cleanup and feedback.

d7d39e3

lukeelmers force-pushed the ts/indexPatterns branch from 7b18cc2 to d7d39e3 Compare July 26, 2019 23:56

lizozom approved these changes Jul 28, 2019

View reviewed changes

jasonrhodes approved these changes Jul 29, 2019

View reviewed changes

Merge branch 'master' of github.com:elastic/kibana into ts/indexPatterns

5e45264

# Conflicts: # x-pack/legacy/plugins/ml/public/data_frame/pages/data_frame_new_pivot/components/source_index_preview/use_source_index_data.ts

lukeelmers approved these changes Jul 29, 2019

View reviewed changes

Updates to ML tests.

9221606

peteharverson approved these changes Jul 30, 2019

View reviewed changes

lukeelmers merged commit ba8a453 into elastic:master Jul 30, 2019

lukeelmers mentioned this pull request Jul 30, 2019

[7.x] Initial conversion of Index Patterns service to TypeScript. (#39247) #42288

Merged

lukeelmers added release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. backport pending and removed release_note:skip Skip the PR/issue when compiling release notes labels Jul 30, 2019

walterra mentioned this pull request Aug 2, 2019

Adjustments to IndexPatterns.getTitles #42511

Closed

lukeelmers added a commit that referenced this pull request Aug 3, 2019

[7.x] Initial conversion of Index Patterns service to TypeScript. (#3…

ee3b21f

…9247) (#42288)

lukeelmers mentioned this pull request Aug 5, 2019

Address feedback on new IndexPatterns implementation. #42646

Merged

lukeelmers added backported and removed backport pending labels Aug 20, 2019

Conversation

ppisljar commented Jun 19, 2019 • edited by lukeelmers Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

For maintainers

Dev Docs

Minor changes to Index Patterns API

Uh oh!

elasticmachine commented Jun 19, 2019

Uh oh!

elasticmachine commented Jun 19, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 19, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 19, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 20, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 21, 2019

💔 Build Failed

Uh oh!

lukeelmers left a comment

Choose a reason for hiding this comment

Uh oh!

lukeelmers Jun 21, 2019

Choose a reason for hiding this comment

Uh oh!

lukeelmers Jun 21, 2019

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Jun 22, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 24, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 24, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 26, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 26, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 26, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 27, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 27, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 27, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 27, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 28, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 28, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jul 27, 2019

💚 Build Succeeded

Uh oh!

lizozom left a comment

Choose a reason for hiding this comment

Uh oh!

jasonrhodes left a comment

Choose a reason for hiding this comment

Uh oh!

ppisljar commented Jun 19, 2019 •

edited by lukeelmers

Loading