add generic typings for SavedObjectMigrationFn #63943
There are no files selected for viewing
This file contains 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 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 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 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 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,43 @@ | ||
| /* | ||
| * Licensed to Elasticsearch B.V. under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch B.V. licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| import { SavedObjectMigrationContext } from './types'; | ||
| import { SavedObjectsMigrationLogger } from './core'; | ||
|
|
||
| const createLoggerMock = (): jest.Mocked<SavedObjectsMigrationLogger> => { | ||
| const mock = { | ||
| debug: jest.fn(), | ||
| info: jest.fn(), | ||
| warning: jest.fn(), | ||
| warn: jest.fn(), | ||
| }; | ||
|
|
||
| return mock; | ||
| }; | ||
|
|
||
| const createContextMock = (): jest.Mocked<SavedObjectMigrationContext> => { | ||
| const mock = { | ||
| log: createLoggerMock(), | ||
| }; | ||
| return mock; | ||
| }; | ||
|
|
||
| export const migrationMocks = { | ||
| createContext: createContextMock, | ||
| }; |
This file contains 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 |
|---|---|---|
|
|
@@ -26,7 +26,7 @@ import { SavedObjectsMigrationLogger } from './core/migration_logger'; | |
| * | ||
| * @example | ||
| * ```typescript | ||
| * const migrateProperty: SavedObjectMigrationFn<MyUnmigratedAttributes, MyMigratedAttributes> = (doc, { log }) => { | ||
| * if(doc.attributes.someProp === null) { | ||
| * log.warn('Skipping migration'); | ||
| * } else { | ||
|
|
@@ -39,10 +39,10 @@ import { SavedObjectsMigrationLogger } from './core/migration_logger'; | |
| * | ||
| * @public | ||
| */ | ||
| export type SavedObjectMigrationFn<InputAttributes = unknown, MigratedAttributes = unknown> = ( | ||
| doc: SavedObjectUnsanitizedDoc<InputAttributes>, | ||
| context: SavedObjectMigrationContext | ||
| ) => SavedObjectUnsanitizedDoc<MigratedAttributes>; | ||
|
Comment on lines
+56
to
+59
There was a problem hiding this comment. So, my only interrogation around that is that atm migrations are all mutating and returning the input I.E export const migrateToKibana660: SavedObjectMigrationFn<any, any> = doc => {
if (!doc.attributes.hasOwnProperty('disabledFeatures')) {
doc.attributes.disabledFeatures = [];
}
return doc;
};Meaning that type InputAttrs = {
}
type OutputAttrs = {
disabledFeatures: SomeType[];
}
export const migrateToKibana660: SavedObjectMigrationFn<InputAttrs, OutputAttrs> = doc => {
if (!doc.attributes.hasOwnProperty('disabledFeatures')) {
doc.attributes.disabledFeatures = [];
}
return doc;
};Would fail to compile with something like Which is why I'm wondering if we should add the output properties on the input export type SavedObjectMigrationFn<InputAttributes = unknown, MigratedAttributes = unknown> = (
doc: SavedObjectUnsanitizedDoc<InputAttributes & MigratedAttributes>,
context: SavedObjectMigrationContext
) => SavedObjectUnsanitizedDoc<MigratedAttributes>;Ideally I would have been using Partial, The other option being to decide that migration function should properly spread / construct the resulting migrated object without returning directly the input There was a problem hiding this comment.
Given the high impact of even a small We can leave existing migrations with There was a problem hiding this comment. As a slightly more type-safe solution than There was a problem hiding this comment. SGTM, I'll keep the definition as it is right now then. |
||
|
|
||
| /** | ||
| * Migration context provided when invoking a {@link SavedObjectMigrationFn | migration handler} | ||
|
|
||
This file contains 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 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 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 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 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 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 |
|---|---|---|
|
|
@@ -21,7 +21,7 @@ import { SavedObjectMigrationFn } from 'kibana/server'; | |
| import { get } from 'lodash'; | ||
| import { DEFAULT_QUERY_LANGUAGE } from '../../../data/common'; | ||
|
|
||
| export const migrateMatchAllQuery: SavedObjectMigrationFn<any, any> = doc => { | ||
| const searchSourceJSON = get<string>(doc, 'attributes.kibanaSavedObjectMeta.searchSourceJSON'); | ||
|
|
||
| if (searchSourceJSON) { | ||
|
|
||
This file contains 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 |
|---|---|---|
|
|
@@ -17,19 +17,13 @@ | |
| * under the License. | ||
| */ | ||
|
|
||
| import { savedObjectsServiceMock } from '../../../../core/server/mocks'; | ||
| import { dashboardSavedObjectTypeMigrations as migrations } from './dashboard_migrations'; | ||
| import { migrations730 } from './migrations_730'; | ||
| import { DashboardDoc700To720, DashboardDoc730ToLatest, DashboardDocPre700 } from '../../common'; | ||
| import { RawSavedDashboardPanel730ToLatest } from '../../common'; | ||
|
|
||
| const mockContext = savedObjectsServiceMock.createMigrationContext(); | ||
|
|
||
| test('dashboard migration 7.3.0 migrates filters to query on search source', () => { | ||
| const doc: DashboardDoc700To720 = { | ||
|
|
@@ -95,7 +89,7 @@ test('dashboard migration 7.3.0 migrates filters to query on search source when | |
| }, | ||
| }; | ||
|
|
||
| const doc700 = migrations['7.0.0'](doc, mockContext); | ||
|
Comment on lines
-98
to
+92
There was a problem hiding this comment. This migration is now an explicit |
||
| const newDoc = migrations['7.3.0'](doc700, mockContext); | ||
|
|
||
| const parsedSearchSource = JSON.parse(newDoc.attributes.kibanaSavedObjectMeta.searchSourceJSON); | ||
|
|
@@ -127,7 +121,7 @@ test('dashboard migration works when panelsJSON is missing panelIndex', () => { | |
| }, | ||
| }; | ||
|
|
||
| const doc700 = migrations['7.0.0'](doc, mockContext); | ||
| const newDoc = migrations['7.3.0'](doc700, mockContext); | ||
|
|
||
| const parsedSearchSource = JSON.parse(newDoc.attributes.kibanaSavedObjectMeta.searchSourceJSON); | ||
|
|
||
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.
we should update the example to show how to construct a copy so that the output is typed different to the input. Since this is only for type safety we don't need to make a deep copy, so it might be worth adding a comment to the example to highlight this.