-
Notifications
You must be signed in to change notification settings - Fork 8.6k
[Response Ops][Task Manager] Skip API Key Tasks If Security is Disabled #221732
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
JiaweiWu
merged 4 commits into
elastic:main
from
JiaweiWu:issue-216810-skip-api-key-tasks-if-security-disabled
Jun 25, 2025
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
7284a7c
Only schedule API key if security is enabled
JiaweiWu c11d4c1
Merge conflicts
JiaweiWu f4a7cb6
Add logger to scheduling tasks if security is disabled
JiaweiWu fbd5444
Merge branch 'main' into issue-216810-skip-api-key-tasks-if-security-…
JiaweiWu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
52 changes: 52 additions & 0 deletions
52
x-pack/platform/plugins/shared/task_manager/server/license_subscriber.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import { LicenseSubscriber } from './license_subscriber'; | ||
| import { Subject } from 'rxjs'; | ||
| import { licensingMock } from '@kbn/licensing-plugin/server/mocks'; | ||
| import type { ILicense } from '@kbn/licensing-plugin/server'; | ||
|
|
||
| describe('LicenseSubscriber', () => { | ||
| afterEach(() => { | ||
| jest.resetAllMocks(); | ||
| }); | ||
|
|
||
| describe('getIsSecurityEnabled', () => { | ||
| test('should return true if security is enabled', () => { | ||
| const license: Subject<ILicense> = new Subject(); | ||
| const licenseSubscriber = new LicenseSubscriber(license); | ||
|
|
||
| const basicLicense = licensingMock.createLicense({ | ||
| license: { status: 'active', type: 'basic' }, | ||
| features: { security: { isEnabled: true, isAvailable: true } }, | ||
| }); | ||
|
|
||
| license.next(basicLicense); | ||
| expect(licenseSubscriber.getIsSecurityEnabled()).toEqual(true); | ||
| }); | ||
|
|
||
| test('should return false if security doesnt exist', () => { | ||
| const license: Subject<ILicense> = new Subject(); | ||
| const licenseSubscriber = new LicenseSubscriber(license); | ||
|
|
||
| expect(licenseSubscriber.getIsSecurityEnabled()).toEqual(false); | ||
| }); | ||
|
|
||
| test('should return false if security is disabled', () => { | ||
| const license: Subject<ILicense> = new Subject(); | ||
| const licenseSubscriber = new LicenseSubscriber(license); | ||
|
|
||
| const basicLicense = licensingMock.createLicense({ | ||
| license: { status: 'active', type: 'basic' }, | ||
| features: { security: { isEnabled: false, isAvailable: true } }, | ||
| }); | ||
|
|
||
| license.next(basicLicense); | ||
| expect(licenseSubscriber.getIsSecurityEnabled()).toEqual(false); | ||
| }); | ||
| }); | ||
| }); |
38 changes: 38 additions & 0 deletions
38
x-pack/platform/plugins/shared/task_manager/server/license_subscriber.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import type { ILicense } from '@kbn/licensing-plugin/server'; | ||
| import type { Observable, Subscription } from 'rxjs'; | ||
|
|
||
| export class LicenseSubscriber { | ||
| private subscription: Subscription; | ||
|
|
||
| private licenseState?: ILicense; | ||
|
|
||
| constructor(license: Observable<ILicense>) { | ||
| this.getIsSecurityEnabled = this.getIsSecurityEnabled.bind(this); | ||
| this.updateState = this.updateState.bind(this); | ||
|
|
||
| this.subscription = license.subscribe(this.updateState); | ||
| } | ||
|
|
||
| private updateState(license: ILicense | undefined) { | ||
| this.licenseState = license; | ||
| } | ||
|
|
||
| public getIsSecurityEnabled() { | ||
| if (!this.licenseState || !this.licenseState.isAvailable) { | ||
| return false; | ||
| } | ||
|
|
||
| return this.licenseState.getFeature('security').isEnabled; | ||
| } | ||
|
|
||
| public cleanup() { | ||
| this.subscription.unsubscribe(); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For this check, could
licensingbe an optional dependency?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm following a similar pattern as the alerting plugin to check for if security is enabled: https://github.com/elastic/kibana/blob/main/x-pack/platform/plugins/shared/alerting/kibana.jsonc
Here we have added the licensing plugin a a require plugin, I feel like it's important we determine if security is enabled, is there a downside to adding the licensing plugin to
requiredPlugins? ThanksUh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think so per se, but it does keep the task manager plugin a bit less coupled should licensing ever be disabled. Making it an
optionalPluginalso means task manager can work without it which I think is a nice property to maintain.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Usage would just look more like:
kibana/src/platform/plugins/private/maps_ems/server/plugin.ts
Line 43 in 94b1174