Api reference docs for state_containers and state_sync #67354

Dosant · 2020-05-26T15:19:27Z

Summary

Adds state_containers and state_sync to api_extractor
improves TSDoc definitions for those plugins
adds changes to api_extractor script to support common/ folder and runs docs generation sequentially to not get OOM.

Review

Dev Docs

Api reference for state_sync and state_containers available here:

…agement-docs

Dosant · 2020-06-18T12:51:27Z

src/dev/run_check_published_api_changes.ts


  if (opts.help) {
    process.stdout.write(
      dedent(chalk`
        {dim usage:} node scripts/check_published_api_changes [...options]

-        Checks for any changes to the Kibana Core API


I removed Core mentions from API Extractor, because we now use it for plugins also.

Dosant · 2020-06-18T12:52:01Z

src/dev/run_check_published_api_changes.ts

+      return 'public';
+    case folder.includes('server'):
+      return 'server';
+    case folder.includes('common'):


state_containers are used on server also. so them are in common and we need API Extractor to support common

Dosant · 2020-06-18T12:53:28Z

src/dev/run_check_published_api_changes.ts

  );
+  const results = [];
+  for (const folder of filteredFolders) {
+    results.push(await run(folder, { log, opts }));


instead of running all in parallel now it runs seq.
it is longer, but not crushes with OOM. (with plugin number growth, it would outgrow 10-16-32gb pretty fast)
maybe should be improved to batch multiple in parallel.

It would be a bit more work, but since this is CPU and memory heavy and we're adding more and more plugins, maybe you could execute a child process for each folder? https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback

I played around with node worker threads in #69615 Although it reduces the memory consumption (no need for extra heap) the speed up isn't enormous (1m50 vs 3m04s) so I think it's fine to leave this synchronous until we have Node12.

That's awesome!

Dosant · 2020-06-18T12:56:55Z

src/plugins/kibana_utils/common/state_containers/types.ts

 export type EnsurePureSelector<T> = Ensure<T, PureSelector<any, any, any>>;
+/**
+ * @public
+ */


I am pretty happy with generated docs for state_sync, but for state_containers it is not that great... mostly due how complicate type system of state_containers is.. There are a lot of helper types which are exposed publicly and I am not sure if we should try to document them. don't see much usefulness for documenting all of that and is not a quick effort..

@streamich let me know if you have ideas or suggestions.

elasticmachine · 2020-06-18T13:10:08Z

Pinging @elastic/kibana-app-arch (Team:AppArch)

rudolf

+1 For platform changes

Dosant · 2020-06-25T12:14:17Z

@elasticmachine merge upstream

streamich

LGTM

src/plugins/kibana_utils/common/state_containers/create_state_container.ts

src/plugins/kibana_utils/common/state_containers/types.ts

...gins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts

src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/types.ts

src/plugins/kibana_utils/public/state_sync/types.ts

…agement-docs

Dosant · 2020-06-26T10:07:40Z

@streamich, thanks for suggestions!

…into dev/state-management-docs

Adds state_containers and state_sync to api_extractor improves TSDoc definitions for those plugins adds changes to api_extractor script to support common/ folder and runs docs generation sequentially to not get OOM. Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Adds state_containers and state_sync to api_extractor improves TSDoc definitions for those plugins adds changes to api_extractor script to support common/ folder and runs docs generation sequentially to not get OOM. Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

kibanamachine · 2020-06-26T13:52:24Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 3df63f2

Build metrics

✅ unchanged

History

💚 Build #56616 succeeded 3df63f2
💚 Build #56264 succeeded 8c60632
💚 Build #54995 succeeded 8607a27
💚 Build #54986 succeeded cd9163b
💚 Build #50330 succeeded e693561

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

* master: (34 commits) Upgrade `elliptic` dependency (`6.5.2` → `6.5.3`). (elastic#70054) [License Management] Do not break when `telemetry.enabled:false` (elastic#69711) [SECURITY] Redirect app/security to app/security/overview (elastic#70005) "Explore underlying data" in-chart action (elastic#69494) Api reference docs for state_containers and state_sync (elastic#67354) prep state transfer for passing embeddables by value to editor and back (elastic#69991) move Metrics API to start (elastic#69787) refactor: 💡 fix typo in embeddable (elastic#69417) [alerting] migrates the old `alerting` consumer to be `alerts` (elastic#69982) [APM]Create API to return data to be used on the Overview page (elastic#69137) [Lens] Fix delete button position in dimension panel for long labels (elastic#69495) [Lens] Add toolbar api (elastic#69263) Fixes bug on color picker defaults on TSVB (elastic#69889) [DOCS] Fixes wording in Upload a CSV section (elastic#69969) [Discover] Validate timerange before submitting query to ES (elastic#69363) [Maps] avoid using MAP_SAVED_OBJECT_TYPE constant when defining URL paths (elastic#69723) [Maps] Fix icon palettes are not working (elastic#69937) [Ingest Manager] Fix typo in constant name (elastic#69919) [test] skip status.allowAnonymous tests on cloud (elastic#69017) Fix backport (elastic#70003) ...

Dosant added 6 commits May 26, 2020 17:18

state management docs draft

e962368

Merge branch 'master' of github.com:elastic/kibana into dev/state-man…

c0cbd0e

…agement-docs

wip

e693561

Merge branch 'master' of github.com:elastic/kibana into dev/state-man…

55c054d

…agement-docs

improve

cd9163b

improve

8607a27

Dosant commented Jun 18, 2020

View reviewed changes

Dosant changed the title ~~[draft] kibana_utils docs trying api extractor~~ Api reference docs for state_containers and state_sync Jun 18, 2020

Dosant added Feature:StateManagement release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. Team:AppArch v7.9.0 v8.0.0 labels Jun 18, 2020

Dosant marked this pull request as ready for review June 18, 2020 13:10

Dosant requested review from a team as code owners June 18, 2020 13:10

Dosant requested a review from streamich June 18, 2020 13:10

rudolf approved these changes Jun 19, 2020

View reviewed changes

Merge branch 'master' into dev/state-management-docs

8c60632

streamich approved these changes Jun 25, 2020

View reviewed changes

Dosant added 2 commits June 26, 2020 12:01

Merge branch 'master' of github.com:elastic/kibana into dev/state-man…

919f4d8

…agement-docs

type fixes

c1e518a

Merge branch 'dev/state-management-docs' of github.com:Dosant/kibana …

3df63f2

…into dev/state-management-docs

Dosant merged commit b3b5dab into elastic:master Jun 26, 2020

Dosant mentioned this pull request Jun 26, 2020

[7.x] Api reference docs for state_containers and state_sync (#67354) #70058

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Api reference docs for state_containers and state_sync #67354

Api reference docs for state_containers and state_sync #67354

Dosant commented May 26, 2020 •

edited

Loading

Dosant Jun 18, 2020 •

edited

Loading

Dosant Jun 18, 2020

Dosant Jun 18, 2020 •

edited

Loading

rudolf Jun 18, 2020

rudolf Jun 19, 2020

Dosant Jun 25, 2020

Dosant Jun 18, 2020

elasticmachine commented Jun 18, 2020

rudolf left a comment

Dosant commented Jun 25, 2020

streamich left a comment

Dosant commented Jun 26, 2020

kibanamachine commented Jun 26, 2020

Api reference docs for state_containers and state_sync #67354

Api reference docs for state_containers and state_sync #67354

Conversation

Dosant commented May 26, 2020 • edited Loading

Summary

Review

Dev Docs

Dosant Jun 18, 2020 • edited Loading

Choose a reason for hiding this comment

Dosant Jun 18, 2020

Choose a reason for hiding this comment

Dosant Jun 18, 2020 • edited Loading

Choose a reason for hiding this comment

rudolf Jun 18, 2020

Choose a reason for hiding this comment

rudolf Jun 19, 2020

Choose a reason for hiding this comment

Dosant Jun 25, 2020

Choose a reason for hiding this comment

Dosant Jun 18, 2020

Choose a reason for hiding this comment

elasticmachine commented Jun 18, 2020

rudolf left a comment

Choose a reason for hiding this comment

Dosant commented Jun 25, 2020

streamich left a comment

Choose a reason for hiding this comment

Dosant commented Jun 26, 2020

kibanamachine commented Jun 26, 2020

💚 Build Succeeded

Build metrics

History

Dosant commented May 26, 2020 •

edited

Loading

Dosant Jun 18, 2020 •

edited

Loading

Dosant Jun 18, 2020 •

edited

Loading