Url service locators #101045

streamich · 2021-06-01T11:57:56Z

Summary

This PR introduces URL locators as part of the URL Service. This PR just introduces the service, the next piece of work will refactor Kibana URL generators to become locators and update documentation.

Checklist

Delete any items that are not applicable to this PR.

Documentation was added for features that require explanation or tutorials
- Partially adjusted existing docs, new documentation will be added in subsequent PR.
Unit or functional tests were updated or added to match the most common scenarios

For maintainers

This was checked for breaking API changes and was labeled appropriately

Plugin API Changes

URL generators are now deprecated, to create a generator for deep links in Kibana use locators in URL Service instead.

Deep link providers

Before you would create a URL generator, like so:

plugins.share.urlGenerators.registerUrlGenerator(/* ... */);

Now, instead, you have to create a "locator", like so:

plugins.share.url.locators.create(/* ... */);

Deep link consumers

Before you would use a URL generator to get a relative deep link in kibana:

plugins.share.urlGenerators.getUrlGenerator('MY_GENERATOR').createUrl(/* ... */);

Now you will create a relative link, or navigate immediately using locators:

plugins.share.locators.get('MY_LOCATOR')!.getLocation(/* ... */);
plugins.share.locators.get('MY_LOCATOR')!.navigate(/* ... */);

elasticmachine · 2021-06-04T13:02:11Z

Pinging @elastic/kibana-app-services (Team:AppServices)

streamich · 2021-06-04T13:04:04Z

@elasticmachine merge upstream

ppisljar

code LGTM

src/plugins/share/common/url_service/url_service.ts

ppisljar · 2021-06-01T13:27:08Z

src/plugins/share/public/plugin.ts

    return {
      ...this.shareMenuRegistry.setup(),
      urlGenerators: this.urlGeneratorsService.setup(core),
+      url: this.url,


we return the same on start and setup contract but we should just allow registering in setup and getting in start

I can harden it if you like, I made it this way as it is cleaner from code perspective and we have other services where we do the same.

streamich · 2021-06-07T09:27:17Z

@elasticmachine merge upstream

kertal

Code LGTM, code owners review, didn't test, just the order on imports was changed and 2 lines were added for consistent styling.

kibanamachine · 2021-06-07T11:13:42Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`share`	47	53	+6

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`share`	3	4	+1

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`share`	67.9KB	71.3KB	+3.3KB

History

💚 Build #129167 succeeded ec0446e
💚 Build #128341 succeeded fefd109
💔 Build #128310 failed 5361362

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

* feat: 🎸 add url service types * refactor: 💡 move locator types into its own folder * feat: 🎸 add abstract locator implementation * feat: 🎸 implement abstract locator client * feat: 🎸 add browser-side locators service * feat: 🎸 implement locator .getLocation() * feat: 🎸 implement navigate function * feat: 🎸 implement locator service in /common folder * feat: 🎸 expose locators client on browser and server * refactor: 💡 make locators async * chore: 🤖 add deprecation notice to URL generators * docs: ✏️ add deprecation notice to readme * test: 💍 make test locator async Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

* master: (90 commits) Fix UI breaks on providing long search keyword in 'Search Box' (elastic#101385) Adds css class to EuiDescriptionListDescription in order to break word on exception details card (elastic#101481) [Lens] Increase timings for drag and drop tests (elastic#101380) [Lens] Fix editor react error on configuration panel (elastic#101367) [Fleet] Move integrations to a separate app (elastic#99848) Fix incorrect message displayed on importing Timeline Templates (elastic#101288) [Cases] RBAC (elastic#95058) [APM] Visual improvements for new APM layout with left navigation (elastic#101360) [master] More precise alerts matching (elastic#99820) [Lens] Value in legend (elastic#101353) Revert "[Reporting] ILM policy for managing reporting indices (elastic#100130)" (elastic#101358) [Discover] Fix header row of data grid in Firefox (elastic#101374) Add link to advanced setting in Discover (elastic#101154) Url service locators (elastic#101045) [Timelion] Update the removal message to mention the exact version (elastic#100994) [Security Solution][Detection Engine] Test cases for alias failure test cases where we don't copy aliases correctly (elastic#101437) [Event Log] Adding `type_id` to saved object array in event log (elastic#100939) [Reporting] Add `location.url` info to console message logs (elastic#101427) [Security Solutions][Detection Engine] Fixes timestamp bugs within source indexes when the formats are not ISO8601 format (elastic#101349) Improve Task Manager instrumentation (elastic#99160) ...

streamich added 14 commits May 14, 2021 17:23

feat: 🎸 add url service types

66e3b42

refactor: 💡 move locator types into its own folder

2fee1cc

feat: 🎸 add abstract locator implementation

26a9cc2

feat: 🎸 implement abstract locator client

306ae7b

Merge remote-tracking branch 'upstream/master' into url-service-locators

8c444bc

feat: 🎸 add browser-side locators service

ed4c671

feat: 🎸 implement locator .getLocation()

d60760b

feat: 🎸 implement navigate function

298530e

feat: 🎸 implement locator service in /common folder

f93859f

feat: 🎸 expose locators client on browser and server

a3f0ecd

Merge remote-tracking branch 'upstream/master' into url-service-locators

4884733

refactor: 💡 make locators async

2993127

chore: 🤖 add deprecation notice to URL generators

9d5cb9d

docs: ✏️ add deprecation notice to readme

5361362

streamich added Feature:SharingURLs Short URLs and Share URL features release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. Team:AppServices v7.14.0 v8.0.0 labels Jun 1, 2021

test: 💍 make test locator async

fefd109

streamich marked this pull request as ready for review June 4, 2021 13:02

streamich requested a review from a team June 4, 2021 13:02

streamich requested a review from a team as a code owner June 4, 2021 13:02

streamich requested a review from ppisljar June 4, 2021 13:02

streamich added the review label Jun 4, 2021

Merge branch 'master' into url-service-locators

ec0446e

ppisljar approved these changes Jun 7, 2021

View reviewed changes

Merge branch 'master' into url-service-locators

3867898

kertal approved these changes Jun 7, 2021

View reviewed changes

streamich merged commit 2a71047 into elastic:master Jun 7, 2021

streamich mentioned this pull request Jun 7, 2021

[7.x] Url service locators (#101045) #101473

Merged

streamich mentioned this pull request Jun 25, 2021

[Meta] URL Service #87304

Closed

13 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Url service locators #101045

Url service locators #101045

streamich commented Jun 1, 2021 •

edited

Loading

elasticmachine commented Jun 4, 2021

streamich commented Jun 4, 2021

ppisljar left a comment

ppisljar Jun 1, 2021

streamich Jun 7, 2021

streamich commented Jun 7, 2021

kertal left a comment

kibanamachine commented Jun 7, 2021

Url service locators #101045

Url service locators #101045

Conversation

streamich commented Jun 1, 2021 • edited Loading

Summary

Checklist

For maintainers

Plugin API Changes

Deep link providers

Deep link consumers

elasticmachine commented Jun 4, 2021

streamich commented Jun 4, 2021

ppisljar left a comment

Choose a reason for hiding this comment

ppisljar Jun 1, 2021

Choose a reason for hiding this comment

streamich Jun 7, 2021

Choose a reason for hiding this comment

streamich commented Jun 7, 2021

kertal left a comment

Choose a reason for hiding this comment

kibanamachine commented Jun 7, 2021

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing exports

Page load bundle

History

streamich commented Jun 1, 2021 •

edited

Loading