Skip to content

[Upgrade Assistant] Critical Kibana API deprecations should not block upgrades #209128

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.

Sign up for GitHub

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
jloleysens merged 2 commits into from
Feb 3, 2025
Merged

[Upgrade Assistant] Critical Kibana API deprecations should not block upgrades #209128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee09814
filter out critical Kibana api deprecations from readiness status
jloleysens Jan 31, 2025
760cefe
Merge branch 'main' into ua/ignore-kibana-critical-api-deprecations-f…
jloleysens Feb 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 97 additions & 3 deletions x-pack/platform/plugins/private/upgrade_assistant/server/lib/kibana_status.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import type { DomainDeprecationDetails } from '@kbn/core/server';

import { getKibanaUpgradeStatus } from './kibana_status';

const mockKibanaDeprecations: DomainDeprecationDetails[] = [
const mockKibanaDeprecations = (): DomainDeprecationDetails[] => [
{
title: 'mock-deprecation-title',
correctiveActions: {
Expand All @@ -31,15 +31,15 @@ const mockKibanaDeprecations: DomainDeprecationDetails[] = [
describe('getKibanaUpgradeStatus', () => {
const deprecationsClient = deprecationsServiceMock.createClient();

deprecationsClient.getAllDeprecations.mockResolvedValue(mockKibanaDeprecations);
deprecationsClient.getAllDeprecations.mockResolvedValue(mockKibanaDeprecations());

it('returns the correct shape of data', async () => {
const resp = await getKibanaUpgradeStatus(deprecationsClient);
expect(resp).toMatchSnapshot();
});

it('returns totalCriticalDeprecations > 0 when critical issues found', async () => {
deprecationsClient.getAllDeprecations.mockResolvedValue(mockKibanaDeprecations);
deprecationsClient.getAllDeprecations.mockResolvedValue(mockKibanaDeprecations());

await expect(getKibanaUpgradeStatus(deprecationsClient)).resolves.toHaveProperty(
'totalCriticalDeprecations',
Expand All @@ -55,4 +55,98 @@ describe('getKibanaUpgradeStatus', () => {
0
);
});

it('returns totalCriticalDeprecations > 0, but ignores API deprecations', async () => {
deprecationsClient.getAllDeprecations.mockResolvedValue([
...mockKibanaDeprecations(),
...mockKibanaDeprecations(),
{
title: 'mock-deprecation-title',
correctiveActions: {
manualSteps: [],
},
apiId: 'foo',
deprecationType: 'api',
documentationUrl: 'testDocUrl',
level: 'warning',
message: 'testMessage',
domainId: 'security',
},
{
title: 'mock-deprecation-title',
correctiveActions: {
manualSteps: [],
},
apiId: 'foo',
deprecationType: 'api',
documentationUrl: 'testDocUrl',
level: 'critical',
message: 'testMessage',
domainId: 'security',
},
{
title: 'mock-deprecation-title',
correctiveActions: {
manualSteps: [],
},
apiId: 'foo',
deprecationType: 'api',
documentationUrl: 'testDocUrl',
level: 'critical',
message: 'testMessage',
domainId: 'security',
},
]);

await expect(getKibanaUpgradeStatus(deprecationsClient)).resolves.toHaveProperty(
'totalCriticalDeprecations',
2
);
});

it('returns totalCriticalDeprecations === 0 when only critical API deprecations', async () => {
deprecationsClient.getAllDeprecations.mockResolvedValue([
{
title: 'mock-deprecation-title',
correctiveActions: {
manualSteps: [],
},
apiId: 'foo',
deprecationType: 'api',
documentationUrl: 'testDocUrl',
level: 'warning',
message: 'testMessage',
domainId: 'security',
},
{
title: 'mock-deprecation-title',
correctiveActions: {
manualSteps: [],
},
apiId: 'foo',
deprecationType: 'api',
documentationUrl: 'testDocUrl',
level: 'critical',
message: 'testMessage',
domainId: 'security',
},
{
title: 'mock-deprecation-title',
correctiveActions: {
manualSteps: [],
},
apiId: 'foo',
deprecationType: 'api',
documentationUrl: 'testDocUrl',
level: 'critical',
message: 'testMessage',
domainId: 'security',
},
]);

await expect(getKibanaUpgradeStatus(deprecationsClient)).resolves.toHaveProperty(
'totalCriticalDeprecations',
0
);
});
});
4 changes: 3 additions & 1 deletion x-pack/platform/plugins/private/upgrade_assistant/server/lib/kibana_status.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ export const getKibanaUpgradeStatus = async (deprecationsClient: DeprecationsCli
const kibanaDeprecations: DomainDeprecationDetails[] =
await deprecationsClient.getAllDeprecations();

const totalCriticalDeprecations = kibanaDeprecations.filter((d) => d.level === 'critical').length;
const totalCriticalDeprecations = kibanaDeprecations.filter(
(d) => d.deprecationType !== 'api' && d.level === 'critical'
Copy link
Contributor Author

@jloleysens jloleysens Jan 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "critical" change

).length;

return {
totalCriticalDeprecations,
Expand Down
23 changes: 21 additions & 2 deletions x-pack/test/upgrade_assistant_integration/upgrade_assistant/api_deprecations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ export default function ({ getService }: FtrProviderContext) {
// await kibanaServer.savedObjects.cleanStandardList();
await esArchiver.emptyKibanaIndex();
});
it('returns does not return api deprecations if the routes are not called', async () => {
it('does not return api deprecations if deprecated routes are not called', async () => {
const { deprecations } = (await supertest.get(`/api/deprecations/`).expect(200)).body;
const apiDeprecations = getApiDeprecations(deprecations);
expect(apiDeprecations.length).to.equal(0);
});

it('returns deprecated APIs when the api is called', async () => {
it('returns deprecated APIs when a deprecated api is called', async () => {
await supertest
.get(`/internal/routing_example/d/internal_versioned_route?apiVersion=1`)
.expect(200);
Expand Down Expand Up @@ -206,6 +206,25 @@ export default function ({ getService }: FtrProviderContext) {
);
});
});
it('GET /api/upgrade_assistant/status does not return { readyForUpgrade: false } if there are only critical API deprecations', async () => {
/** Throw in another critical deprecation... */
await supertest.get(`/api/routing_example/d/removed_route`).expect(200);
// sleep a little until the usage counter is synced into ES
await setTimeoutAsync(3000);
await retry.tryForTime(
15 * 1000,
async () => {
const { deprecations } = (await supertest.get(`/api/deprecations/`).expect(200)).body;
const apiDeprecations = getApiDeprecations(deprecations);
// confirm there is at least one CRITICAL deprecated API usage present
expect(apiDeprecations.some(({ level }) => level === 'critical')).to.be(true);
},
undefined,
2000
);
const { body } = await supertest.get(`/api/upgrade_assistant/status`).expect(200);
expect(body.readyForUpgrade).to.be(true);
});
});
}

Expand Down
6 changes: 3 additions & 3 deletions x-pack/test/upgrade_assistant_integration/upgrade_assistant/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
import { FtrProviderContext } from '../../common/ftr_provider_context';

export default function ({ loadTestFile }: FtrProviderContext) {
// FAILING VERSION BUMP: https://github.com/elastic/kibana/issues/209048
describe.skip('upgrade assistant', function () {
loadTestFile(require.resolve('./reindexing'));
describe('upgrade assistant', function () {
// FAILING VERSION BUMP: https://github.com/elastic/kibana/issues/209048
// loadTestFile(require.resolve('./reindexing'));
Copy link
Contributor Author

@jloleysens jloleysens Jan 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we only want to skip the reindexing for now...

loadTestFile(require.resolve('./api_deprecations'));
});
}