[telemetry] expose getIsOptedIn function in plugin start contract #75143

Bamieh · 2020-08-17T10:59:57Z

Add getIsOptedIn to the start contract. We cannot expose this function to the setup function since SO savedObjects.createInternalRepository() is not exposed in setup.
Add getTelemetryUrl to the setup contract.
Add server plugin jest mocks

elasticmachine · 2020-08-17T11:00:00Z

Pinging @elastic/kibana-telemetry (Team:KibanaTelemetry)

afharo

I'm not sure we want to publicly expose the null behaviour. It seems very explicit to our own usage, doesn't it?.
Also, NIT: can we add some tests for this new piece of logic?

src/plugins/telemetry/server/plugin.ts

…ose_start_contract_opt_in_status

afharo

LGTM!

NIT: It'd be great if we had some coverage for this API

TinaHeiligers

We need unit tests for the new logic and also need to expose the plugin mock. Security will be using this new API and will most likely add tests for the implementation thereof.

TinaHeiligers · 2020-08-17T14:51:17Z

@Bamieh There's an additional request to expose the telemetry url that came in through an email:

In addition to the opt-in status, I think we'll also need the telemetry URL. We'll ship to a v3 as in {telemetry_url}/v3/events, or similar.

If we can add it to this PR, let's do that. Otherwise we'll explicitly as for a new issue.

TinaHeiligers

Looks good thus far.

…ose_start_contract_opt_in_status

Addressed requested changes. exposed url and added plugin mocks

afharo

The implementation looks great to me and I love it that we have a mock as well 🚀

I'm missing some unit tests to cover these new methods though (I'm happy to help on implementing them if you want 🙂).

I also added a comment in regards to the docs: Should we make it clear in some way that we'll only return false in the change of major/minor versions if the previous response was to opt-out?

src/plugins/telemetry/README.md

afharo · 2020-09-07T11:46:55Z

src/plugins/telemetry/server/plugin.ts

+        const telemetrySavedObject = await getTelemetrySavedObject(internalRepository!);
+        const config = await this.config$.pipe(take(1)).toPromise();
+        const allowChangingOptInStatus = config.allowChangingOptInStatus;
+        const configTelemetryOptIn = typeof config.optIn === 'undefined' ? null : config.optIn;


NIT: I recently learned this can be also written as:

Suggested change

const configTelemetryOptIn = typeof config.optIn === 'undefined' ? null : config.optIn;

const configTelemetryOptIn = config.optIn ?? null;

🤯 https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Nullish_coalescing_operator

src/plugins/telemetry/server/plugin.ts

Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com>

kibanamachine · 2020-09-07T14:20:22Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: bbd9c07

Build metrics

✅ unchanged

History

💚 Build #72912 succeeded b84dc7f
💚 Build #68442 succeeded 19fac21
💚 Build #68393 succeeded 64739fd

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

…ct (#75143) (#76882) Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com> Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com>

…' of github.com:jloleysens/kibana into ilm/fix/pre-existing-policy-with-no-existing-repository * 'ilm/fix/pre-existing-policy-with-no-existing-repository' of github.com:jloleysens/kibana: fix empty string in selected indices (elastic#76855) [Security Solution] Refactor OverviewHost and OverviewNetwork to use Search Strategy (elastic#76409) Use Search API in Timelion (sync) (elastic#75115) [telemetry] expose getIsOptedIn function in plugin start contract (elastic#75143) [ILM] Clean up remaining js files and any typings (elastic#76803) [Logs UI] Shared `<LogStream />` component (elastic#76262) [Security Solution] Add unit test for all hosts (elastic#76752) [Security Solution] Add unit test for authentications search strategy (elastic#76665) Do not apply search source data for tsvb (elastic#75137) [Security Solution] Refactor NetworkDns to use Search Strategy (elastic#76250) [SECURITY SOLUTION] Adds 'cypress:open-as-ci' command (elastic#76125) [Logs UI] Update alert executor tests (elastic#75764) [Functional] Unskip vega tests and fix flakiness (elastic#76600) [Data] Query String Input accepts classname prop (elastic#76848) [ML] Swim lane pagination for viewing by job id (elastic#76847) [Security Solution] Refactor MatrixHistogram to use Search Strategy (elastic#76603) [APM] Use the outcome field to calculate the transaction error rate chart (elastic#75528) [APM] Use observer.hostname instead of observer.name (elastic#76074) Legacy logging: fix remoteAddress being duplicated in userAgent field (elastic#76751)

…s-for-710 * 'master' of github.com:elastic/kibana: [Search] Use async es client endpoints (elastic#76872) fix empty string in selected indices (elastic#76855) [Security Solution] Refactor OverviewHost and OverviewNetwork to use Search Strategy (elastic#76409) Use Search API in Timelion (sync) (elastic#75115) [telemetry] expose getIsOptedIn function in plugin start contract (elastic#75143) [ILM] Clean up remaining js files and any typings (elastic#76803) [Logs UI] Shared `<LogStream />` component (elastic#76262) [Security Solution] Add unit test for all hosts (elastic#76752) [Security Solution] Add unit test for authentications search strategy (elastic#76665) Do not apply search source data for tsvb (elastic#75137) [Security Solution] Refactor NetworkDns to use Search Strategy (elastic#76250) [SECURITY SOLUTION] Adds 'cypress:open-as-ci' command (elastic#76125) [Logs UI] Update alert executor tests (elastic#75764) [Functional] Unskip vega tests and fix flakiness (elastic#76600) [Data] Query String Input accepts classname prop (elastic#76848) [ML] Swim lane pagination for viewing by job id (elastic#76847) [Security Solution] Refactor MatrixHistogram to use Search Strategy (elastic#76603) [APM] Use the outcome field to calculate the transaction error rate chart (elastic#75528) [APM] Use observer.hostname instead of observer.name (elastic#76074) Legacy logging: fix remoteAddress being duplicated in userAgent field (elastic#76751) # Conflicts: # x-pack/plugins/index_lifecycle_management/__jest__/components/edit_policy.test.tsx # x-pack/plugins/index_lifecycle_management/common/types/index.ts # x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/components/node_allocation.tsx # x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/edit_policy.tsx # x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/phases/warm_phase.tsx # x-pack/plugins/index_lifecycle_management/public/application/services/api.ts

elasticmachine · 2021-10-01T21:38:31Z

Pinging @elastic/kibana-core (Team:Core)

expose getIsOptedIn function in plugin start contract

64739fd

Bamieh added Feature:Telemetry v8.0.0 release_note:skip Skip the PR/issue when compiling release notes Team:KibanaTelemetry v7.10.0 labels Aug 17, 2020

Bamieh requested review from afharo and TinaHeiligers August 17, 2020 10:59

Bamieh requested a review from a team as a code owner August 17, 2020 10:59

afharo reviewed Aug 17, 2020

View reviewed changes

src/plugins/telemetry/server/plugin.ts Outdated Show resolved Hide resolved

src/plugins/telemetry/server/plugin.ts Outdated Show resolved Hide resolved

Bamieh added 2 commits August 17, 2020 16:31

Merge branch 'master' of github.com:elastic/kibana into telemetry/exp…

6826c59

…ose_start_contract_opt_in_status

add documentation and remove null value from public api

9b362f2

Bamieh requested a review from afharo August 17, 2020 13:48

typo

19fac21

afharo approved these changes Aug 17, 2020

View reviewed changes

TinaHeiligers previously requested changes Aug 17, 2020

View reviewed changes

TinaHeiligers self-requested a review August 17, 2020 18:13

TinaHeiligers reviewed Aug 17, 2020

View reviewed changes

Bamieh added 3 commits September 3, 2020 15:52

Merge branch 'master' of github.com:elastic/kibana into telemetry/exp…

f461d8c

…ose_start_contract_opt_in_status

Merge branch 'master' of github.com:elastic/kibana into telemetry/exp…

5acc4b8

…ose_start_contract_opt_in_status

add mocks and expose telemetry url

b84dc7f

Bamieh requested a review from afharo September 7, 2020 11:24

afharo reviewed Sep 7, 2020

View reviewed changes

Apply suggestions from code review

bbd9c07

Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com>

Bamieh merged commit 992f5cc into elastic:master Sep 7, 2020

Bamieh deleted the telemetry/expose_start_contract_opt_in_status branch September 7, 2020 14:28

Bamieh mentioned this pull request Sep 7, 2020

[7.x] [telemetry] expose getIsOptedIn function in plugin start contract (#75143) #76882

Merged

lukeelmers added the Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc label Oct 1, 2021

lukeelmers removed the Team:KibanaTelemetry label Oct 1, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[telemetry] expose getIsOptedIn function in plugin start contract #75143

[telemetry] expose getIsOptedIn function in plugin start contract #75143

Bamieh commented Aug 17, 2020 •

edited

Loading

elasticmachine commented Aug 17, 2020

afharo left a comment

afharo left a comment

TinaHeiligers left a comment

TinaHeiligers commented Aug 17, 2020

TinaHeiligers left a comment

afharo left a comment •

edited

Loading

afharo Sep 7, 2020

kibanamachine commented Sep 7, 2020

elasticmachine commented Oct 1, 2021

	const configTelemetryOptIn = typeof config.optIn === 'undefined' ? null : config.optIn;
	const configTelemetryOptIn = config.optIn ?? null;

[telemetry] expose getIsOptedIn function in plugin start contract #75143

[telemetry] expose getIsOptedIn function in plugin start contract #75143

Conversation

Bamieh commented Aug 17, 2020 • edited Loading

elasticmachine commented Aug 17, 2020

afharo left a comment

Choose a reason for hiding this comment

afharo left a comment

Choose a reason for hiding this comment

TinaHeiligers left a comment

Choose a reason for hiding this comment

TinaHeiligers commented Aug 17, 2020

TinaHeiligers left a comment

Choose a reason for hiding this comment

afharo left a comment • edited Loading

Choose a reason for hiding this comment

afharo Sep 7, 2020

Choose a reason for hiding this comment

kibanamachine commented Sep 7, 2020

💚 Build Succeeded

Build metrics

History

elasticmachine commented Oct 1, 2021

Bamieh commented Aug 17, 2020 •

edited

Loading

afharo left a comment •

edited

Loading