mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 09:48:58 -04:00
[uiActions] Catch errors in isCompatible (#200261)
## Summary Related to https://github.com/elastic/kibana/issues/197870. The bug reported in #197870 was a side effect of unhandled errors in the `isCompatible` check on the edit drilldown `uiAction`. When errors are throw in the `isCompatible` check on an `Action`, we should return `false` instead of throwing to unblock the rest of the compatibility checks. <img width="1800" alt="Screenshot 2024-11-14 at 3 30 20 PM" src="https://github.com/user-attachments/assets/6189c2dc-2a9d-4c81-be1e-b5f94ba43123"> ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] The PR description includes the appropriate Release Notes section, and the correct `release_node:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. - [ ] [See some risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) - [ ] ...
This commit is contained in:
parent
20749d05d0
commit
d697a67a05
1 changed files with 12 additions and 1 deletions
|
@ -29,6 +29,7 @@ export class ActionInternal<Context extends object = object>
|
|||
|
||||
public readonly subscribeToCompatibilityChanges?: Action<Context>['subscribeToCompatibilityChanges'];
|
||||
public readonly couldBecomeCompatible?: Action<Context>['couldBecomeCompatible'];
|
||||
public errorLogged?: boolean;
|
||||
|
||||
constructor(public readonly definition: ActionDefinition<Context>) {
|
||||
this.id = this.definition.id;
|
||||
|
@ -38,6 +39,7 @@ export class ActionInternal<Context extends object = object>
|
|||
this.grouping = this.definition.grouping;
|
||||
this.showNotification = this.definition.showNotification;
|
||||
this.disabled = this.definition.disabled;
|
||||
this.errorLogged = false;
|
||||
|
||||
if (this.definition.subscribeToCompatibilityChanges) {
|
||||
this.subscribeToCompatibilityChanges = definition.subscribeToCompatibilityChanges;
|
||||
|
@ -77,7 +79,16 @@ export class ActionInternal<Context extends object = object>
|
|||
|
||||
public async isCompatible(context: Context): Promise<boolean> {
|
||||
if (!this.definition.isCompatible) return true;
|
||||
return await this.definition.isCompatible(context);
|
||||
try {
|
||||
return await this.definition.isCompatible(context);
|
||||
} catch (e) {
|
||||
if (!this.errorLogged) {
|
||||
// eslint-disable-next-line no-console
|
||||
console.error(e);
|
||||
this.errorLogged = true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
public async getHref(context: Context): Promise<string | undefined> {
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue