-
Notifications
You must be signed in to change notification settings - Fork 917
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into feature/redirection-modal
Signed-off-by: Ashwin P Chandran <[email protected]>
- Loading branch information
Showing
92 changed files
with
2,769 additions
and
401 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
18.16.0 | ||
18.19.0 |
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 |
---|---|---|
@@ -1 +1 @@ | ||
18.16.0 | ||
18.19.0 |
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 |
---|---|---|
@@ -1,4 +1,4 @@ | ||
ARG NODE_VERSION=18.16.0 | ||
ARG NODE_VERSION=18.19.0 | ||
FROM node:${NODE_VERSION} AS base | ||
|
||
ENV HOME '.' | ||
|
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 |
---|---|---|
|
@@ -52,4 +52,3 @@ | |
"webpack": "npm:@amoo-miki/[email protected]" | ||
} | ||
} | ||
|
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
150 changes: 150 additions & 0 deletions
150
src/core/server/saved_objects/import/check_conflict_for_data_source.test.ts
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,150 @@ | ||
/* | ||
* Copyright OpenSearch Contributors | ||
* SPDX-License-Identifier: Apache-2.0 | ||
*/ | ||
|
||
import { mockUuidv4 } from './__mocks__'; | ||
import { SavedObjectReference, SavedObjectsImportRetry } from 'opensearch-dashboards/public'; | ||
import { SavedObject } from '../types'; | ||
import { SavedObjectsErrorHelpers } from '..'; | ||
import { | ||
checkConflictsForDataSource, | ||
ConflictsForDataSourceParams, | ||
} from './check_conflict_for_data_source'; | ||
|
||
type SavedObjectType = SavedObject<{ title?: string }>; | ||
|
||
/** | ||
* Function to create a realistic-looking import object given a type and ID | ||
*/ | ||
const createObject = (type: string, id: string): SavedObjectType => ({ | ||
type, | ||
id, | ||
attributes: { title: 'some-title' }, | ||
references: (Symbol() as unknown) as SavedObjectReference[], | ||
}); | ||
|
||
const getResultMock = { | ||
conflict: (type: string, id: string) => { | ||
const error = SavedObjectsErrorHelpers.createConflictError(type, id).output.payload; | ||
return { type, id, error }; | ||
}, | ||
unresolvableConflict: (type: string, id: string) => { | ||
const conflictMock = getResultMock.conflict(type, id); | ||
const metadata = { isNotOverwritable: true }; | ||
return { ...conflictMock, error: { ...conflictMock.error, metadata } }; | ||
}, | ||
invalidType: (type: string, id: string) => { | ||
const error = SavedObjectsErrorHelpers.createUnsupportedTypeError(type).output.payload; | ||
return { type, id, error }; | ||
}, | ||
}; | ||
|
||
/** | ||
* Create a variety of different objects to exercise different import / result scenarios | ||
*/ | ||
const dataSourceObj = createObject('data-source', 'data-source-id-1'); // -> data-source type, no need to add in the filteredObjects | ||
const dataSourceObj1 = createObject('type-1', 'ds_id-1'); // -> object with data source id | ||
const dataSourceObj2 = createObject('type-2', 'ds_id-2'); // -> object with data source id | ||
const objectsWithDataSource = [dataSourceObj, dataSourceObj1, dataSourceObj2]; | ||
const dataSourceObj1Error = getResultMock.conflict(dataSourceObj1.type, dataSourceObj1.id); | ||
|
||
describe('#checkConflictsForDataSource', () => { | ||
const setupParams = (partial: { | ||
objects: SavedObjectType[]; | ||
ignoreRegularConflicts?: boolean; | ||
retries?: SavedObjectsImportRetry[]; | ||
createNewCopies?: boolean; | ||
dataSourceId?: string; | ||
}): ConflictsForDataSourceParams => { | ||
return { ...partial }; | ||
}; | ||
|
||
beforeEach(() => { | ||
mockUuidv4.mockReset(); | ||
mockUuidv4.mockReturnValueOnce(`new-object-id`); | ||
}); | ||
|
||
it('exits early if there are no objects to check', async () => { | ||
const params = setupParams({ objects: [] }); | ||
const checkConflictsForDataSourceResult = await checkConflictsForDataSource(params); | ||
expect(checkConflictsForDataSourceResult).toEqual({ | ||
filteredObjects: [], | ||
errors: [], | ||
importIdMap: new Map(), | ||
pendingOverwrites: new Set(), | ||
}); | ||
}); | ||
|
||
it('return obj if it is not data source obj and there is no conflict of the data source id', async () => { | ||
const params = setupParams({ objects: objectsWithDataSource, dataSourceId: 'ds' }); | ||
const checkConflictsForDataSourceResult = await checkConflictsForDataSource(params); | ||
expect(checkConflictsForDataSourceResult).toEqual({ | ||
filteredObjects: [dataSourceObj1, dataSourceObj2], | ||
errors: [], | ||
importIdMap: new Map(), | ||
pendingOverwrites: new Set(), | ||
}); | ||
}); | ||
|
||
it('can resolve the data source id conflict when the ds it not match when ignoreRegularConflicts=true', async () => { | ||
const params = setupParams({ | ||
objects: objectsWithDataSource, | ||
ignoreRegularConflicts: true, | ||
dataSourceId: 'currentDsId', | ||
}); | ||
const checkConflictsForDataSourceResult = await checkConflictsForDataSource(params); | ||
|
||
expect(checkConflictsForDataSourceResult).toEqual( | ||
expect.objectContaining({ | ||
filteredObjects: [ | ||
{ | ||
...dataSourceObj1, | ||
id: 'currentDsId_id-1', | ||
}, | ||
{ | ||
...dataSourceObj2, | ||
id: 'currentDsId_id-2', | ||
}, | ||
], | ||
errors: [], | ||
importIdMap: new Map([ | ||
[ | ||
`${dataSourceObj1.type}:${dataSourceObj1.id}`, | ||
{ id: 'currentDsId_id-1', omitOriginId: true }, | ||
], | ||
[ | ||
`${dataSourceObj2.type}:${dataSourceObj2.id}`, | ||
{ id: 'currentDsId_id-2', omitOriginId: true }, | ||
], | ||
]), | ||
pendingOverwrites: new Set([ | ||
`${dataSourceObj1.type}:${dataSourceObj1.id}`, | ||
`${dataSourceObj2.type}:${dataSourceObj2.id}`, | ||
]), | ||
}) | ||
); | ||
}); | ||
|
||
it('can push error when do not override with data source conflict', async () => { | ||
const params = setupParams({ | ||
objects: [dataSourceObj1], | ||
ignoreRegularConflicts: false, | ||
dataSourceId: 'currentDs', | ||
}); | ||
const checkConflictsForDataSourceResult = await checkConflictsForDataSource(params); | ||
expect(checkConflictsForDataSourceResult).toEqual({ | ||
filteredObjects: [], | ||
errors: [ | ||
{ | ||
...dataSourceObj1Error, | ||
title: dataSourceObj1.attributes.title, | ||
meta: { title: dataSourceObj1.attributes.title }, | ||
error: { type: 'conflict' }, | ||
}, | ||
], | ||
importIdMap: new Map(), | ||
pendingOverwrites: new Set(), | ||
}); | ||
}); | ||
}); |
85 changes: 85 additions & 0 deletions
85
src/core/server/saved_objects/import/check_conflict_for_data_source.ts
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,85 @@ | ||
/* | ||
* Copyright OpenSearch Contributors | ||
* SPDX-License-Identifier: Apache-2.0 | ||
*/ | ||
|
||
import { SavedObject, SavedObjectsImportError, SavedObjectsImportRetry } from '../types'; | ||
|
||
export interface ConflictsForDataSourceParams { | ||
objects: Array<SavedObject<{ title?: string }>>; | ||
ignoreRegularConflicts?: boolean; | ||
retries?: SavedObjectsImportRetry[]; | ||
dataSourceId?: string; | ||
} | ||
|
||
interface ImportIdMapEntry { | ||
id?: string; | ||
omitOriginId?: boolean; | ||
} | ||
|
||
/** | ||
* function to check the conflict when multiple data sources are enabled. | ||
* the purpose of this function is to check the conflict of the imported saved objects and data source | ||
* @param objects, this the array of saved objects to be verified whether contains the data source conflict | ||
* @param ignoreRegularConflicts whether to override | ||
* @param retries import operations list | ||
* @param dataSourceId the id to identify the data source | ||
* @returns {filteredObjects, errors, importIdMap, pendingOverwrites } | ||
*/ | ||
export async function checkConflictsForDataSource({ | ||
objects, | ||
ignoreRegularConflicts, | ||
retries = [], | ||
dataSourceId, | ||
}: ConflictsForDataSourceParams) { | ||
const filteredObjects: Array<SavedObject<{ title?: string }>> = []; | ||
const errors: SavedObjectsImportError[] = []; | ||
const importIdMap = new Map<string, ImportIdMapEntry>(); | ||
const pendingOverwrites = new Set<string>(); | ||
|
||
// exit early if there are no objects to check | ||
if (objects.length === 0) { | ||
return { filteredObjects, errors, importIdMap, pendingOverwrites }; | ||
} | ||
const retryMap = retries.reduce( | ||
(acc, cur) => acc.set(`${cur.type}:${cur.id}`, cur), | ||
new Map<string, SavedObjectsImportRetry>() | ||
); | ||
objects.forEach((object) => { | ||
const { | ||
type, | ||
id, | ||
attributes: { title }, | ||
} = object; | ||
const { destinationId } = retryMap.get(`${type}:${id}`) || {}; | ||
|
||
if (object.type !== 'data-source') { | ||
const parts = id.split('_'); // this is the array to host the split results of the id | ||
const previoudDataSourceId = parts.length > 1 ? parts[0] : undefined; | ||
const rawId = previoudDataSourceId ? parts[1] : parts[0]; | ||
|
||
/** | ||
* for import saved object from osd exported | ||
* when the imported saved objects with the different dataSourceId comparing to the current dataSourceId | ||
*/ | ||
|
||
if ( | ||
previoudDataSourceId && | ||
previoudDataSourceId !== dataSourceId && | ||
!ignoreRegularConflicts | ||
) { | ||
const error = { type: 'conflict' as 'conflict', ...(destinationId && { destinationId }) }; | ||
errors.push({ type, id, title, meta: { title }, error }); | ||
} else if (previoudDataSourceId && previoudDataSourceId === dataSourceId) { | ||
filteredObjects.push(object); | ||
} else { | ||
const omitOriginId = ignoreRegularConflicts; | ||
importIdMap.set(`${type}:${id}`, { id: `${dataSourceId}_${rawId}`, omitOriginId }); | ||
pendingOverwrites.add(`${type}:${id}`); | ||
filteredObjects.push({ ...object, id: `${dataSourceId}_${rawId}` }); | ||
} | ||
} | ||
}); | ||
|
||
return { filteredObjects, errors, importIdMap, pendingOverwrites }; | ||
} |
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
Oops, something went wrong.