UI-9566 - Ensure a best effort migration of the KPI titles even when some titles could not be successfully migrated. #129
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| import { ContentRecord } from "@activeviam/activeui-sdk-5.1"; | ||
| import { produce } from "immer"; | ||
|
|
||
| /** | ||
| * Returns a new `legacyUIFolder` with the given `legacyBookmarksToAdd` added. | ||
| * Useful for creating legacyUIFolders for tests. | ||
| * Does not mutate `legacyUIFolder`. | ||
| */ | ||
| export function addLegacyBookmarkToUIFolder( | ||
| legacyUIFolder: ContentRecord, | ||
| legacyBookmarksToAdd: { [id: string]: any }, | ||
| ): ContentRecord<any, "response"> { | ||
| const content = legacyUIFolder.children?.bookmarks.children?.content; | ||
| const structure = legacyUIFolder.children?.bookmarks.children?.structure; | ||
|
|
||
| if (!content || !structure) { | ||
| throw new Error( | ||
| "Expected `legacyUIFolder` to contain the `content` and `structure` properties. Please ensure these properties exist", | ||
| ); | ||
| } | ||
|
|
||
| return produce(legacyUIFolder, (draftFolder) => { | ||
| const existingBookmarks = | ||
| draftFolder.children!.bookmarks.children!.content!.children || {}; | ||
|
|
||
| // Add the bookmark content | ||
| draftFolder.children!.bookmarks.children!.content!.children = { | ||
| ...existingBookmarks, | ||
| ...legacyBookmarksToAdd, | ||
| }; | ||
|
|
||
| const keysOfBookmarksToAdd = Object.keys(legacyBookmarksToAdd); | ||
|
|
||
| const bookmarkStructureToAdd = keysOfBookmarksToAdd.reduce( | ||
| (acc: { [key: string]: ContentRecord }, key: string) => { | ||
| acc[key] = { | ||
| entry: { | ||
| isDirectory: true, | ||
| owners: [], | ||
| readers: [], | ||
| timestamp: 1607879735685, | ||
| lastEditor: "admin", | ||
| canRead: true, | ||
| canWrite: true, | ||
| }, | ||
| }; | ||
| return acc; | ||
| }, | ||
| {}, | ||
| ); | ||
|
|
||
| const existingStructure = | ||
| draftFolder.children!.bookmarks.children!.structure!.children || {}; | ||
|
|
||
| // Add the bookmark structure | ||
| draftFolder.children!.bookmarks.children!.structure!.children = { | ||
| ...existingStructure, | ||
| ...bookmarkStructureToAdd, | ||
| }; | ||
| }); | ||
| } |
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,112 @@ | ||
| /** | ||
| * Contains an empty /ui folder of a Content Server, useful for injecting content to be used in unit tests. | ||
| */ | ||
| export const emptyLegacyUIFolder = { | ||
| entry: { | ||
| isDirectory: true, | ||
| owners: ["admin"], | ||
| readers: ["admin"], | ||
| timestamp: 1607879725132, | ||
| lastEditor: "admin", | ||
| canRead: true, | ||
| canWrite: true, | ||
| }, | ||
| children: { | ||
| bookmarks: { | ||
| entry: { | ||
| isDirectory: true, | ||
| owners: ["ROLE_CS_ROOT"], | ||
| readers: ["ROLE_USER"], | ||
| timestamp: 1607879735685, | ||
| lastEditor: "admin", | ||
| canRead: true, | ||
| canWrite: true, | ||
| }, | ||
| children: { | ||
| content: { | ||
| entry: { | ||
| isDirectory: true, | ||
| owners: ["ROLE_USER"], | ||
| readers: ["ROLE_USER"], | ||
| timestamp: 1607879735685, | ||
| lastEditor: "admin", | ||
| canRead: true, | ||
| canWrite: true, | ||
| }, | ||
| children: {}, | ||
| }, | ||
| i18n: { | ||
| entry: { | ||
| isDirectory: true, | ||
| owners: ["ROLE_CS_ROOT"], | ||
| readers: ["ROLE_USER"], | ||
| timestamp: 1607879735685, | ||
| lastEditor: "admin", | ||
| canRead: true, | ||
| canWrite: true, | ||
| }, | ||
| children: { | ||
| "en-US": { | ||
| entry: { | ||
| isDirectory: true, | ||
| owners: ["ROLE_CS_ROOT"], | ||
| readers: ["ROLE_USER"], | ||
| timestamp: 1607879735685, | ||
| lastEditor: "admin", | ||
| canRead: true, | ||
| canWrite: true, | ||
| }, | ||
| }, | ||
| "fr-FR": { | ||
| entry: { | ||
| isDirectory: true, | ||
| owners: ["ROLE_CS_ROOT"], | ||
| readers: ["ROLE_USER"], | ||
| timestamp: 1607879735685, | ||
| lastEditor: "admin", | ||
| canRead: true, | ||
| canWrite: true, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| structure: { | ||
| entry: { | ||
| isDirectory: true, | ||
| owners: ["ROLE_USER"], | ||
| readers: ["ROLE_USER"], | ||
| timestamp: 1607879735685, | ||
| lastEditor: "admin", | ||
| canRead: true, | ||
| canWrite: true, | ||
| }, | ||
| children: {}, | ||
| }, | ||
| }, | ||
| }, | ||
| settings: { | ||
| entry: { | ||
| isDirectory: true, | ||
| owners: ["ROLE_CS_ROOT"], | ||
| readers: ["ROLE_USER"], | ||
| timestamp: 1607879735685, | ||
| lastEditor: "admin", | ||
| canRead: true, | ||
| canWrite: true, | ||
| }, | ||
| children: {}, | ||
| }, | ||
| version: { | ||
| entry: { | ||
| content: '{"package":"4.3.8","contentServerApi":"0.1.0"}', | ||
| isDirectory: false, | ||
| owners: ["ROLE_CS_ROOT"], | ||
| readers: ["ROLE_USER"], | ||
| timestamp: 1607879735685, | ||
| lastEditor: "admin", | ||
| canRead: true, | ||
| canWrite: true, | ||
| }, | ||
| }, | ||
| }, | ||
| }; |
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,37 @@ | ||
| const widgetWithInvalidContainerKey = { | ||
| entry: { | ||
| content: | ||
| '{"description":"Widget with invalid container key","name":"Invalid widget","type":"container","value":{"style":{},"showTitleBar":false,"containerKey":"invalid-container-key","body":{"serverUrl":"","mdx":"SELECT NON EMPTY [Measures].[contributors.COUNT] ON COLUMNS FROM [EquityDerivativesCube] WHERE [Geography].[City].[ALL].[AllMember].[New York] CELL PROPERTIES VALUE, FORMATTED_VALUE, BACK_COLOR, FORE_COLOR, FONT_FLAGS","contextValues":{},"updateMode":"once","ranges":{}}}}', | ||
| isDirectory: false, | ||
| owners: ["admin"], | ||
| readers: ["admin"], | ||
| timestamp: 1607879735685, | ||
| lastEditor: "admin", | ||
| canRead: true, | ||
| canWrite: true, | ||
| }, | ||
| }; | ||
|
|
||
| const widgetWithFilterOnInvalidHierarchy = { | ||
| entry: { | ||
| content: | ||
| '{"description":"Widget with filter on invalid hierarchy","name":"Invalid widget","type":"container","value":{"style":{},"showTitleBar":false,"containerKey":"pivot-table","body":{"serverUrl":"","mdx":"SELECT NON EMPTY [Measures].[contributors.COUNT] ON COLUMNS FROM [EquityDerivativesCube] WHERE [Geography].[InvalidHierarchy].[ALL].[AllMember].[Member] CELL PROPERTIES VALUE, FORMATTED_VALUE, BACK_COLOR, FORE_COLOR, FONT_FLAGS","contextValues":{},"updateMode":"once","ranges":{}}}}', | ||
| isDirectory: false, | ||
| owners: ["admin"], | ||
| readers: ["admin"], | ||
| timestamp: 1607879735685, | ||
| lastEditor: "admin", | ||
| canRead: true, | ||
| canWrite: true, | ||
| }, | ||
| }; | ||
|
|
||
| /** | ||
| * Contains two legacy bookmark widgets. | ||
| * 1. Widget with an invalid container container key. | ||
| * 2. Widget with a filter on an invalid hierarchy. | ||
| */ | ||
| export const invalidLegacyWidgets = { | ||
| "158": widgetWithInvalidContainerKey, | ||
| "1231": widgetWithFilterOnInvalidHierarchy, | ||
| }; |
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,16 @@ | ||
| /** | ||
| * Content entry representing a legacy dashboard containing a single pivot table. | ||
| * Useful for unit tests. | ||
| */ | ||
| export const legacyDashboardBookmark = { | ||
| entry: { | ||
| content: `{"name":"hidden grand totals","type":"container","value":{"style":{},"showTitleBar":false,"body":{"pages":[{"content":[{"key":"1","bookmark":{"name":"Untitled Pivot Table","type":"container","value":{"style":{},"showTitleBar":true,"body":{"serverUrl":"","mdx":"SELECT NON EMPTY Crossjoin(Hierarchize(DrilldownLevel([Geography].[City].[ALL].[AllMember])), Hierarchize(DrilldownLevel([Currency].[Currency].[ALL].[AllMember]))) ON ROWS, NON EMPTY [Measures].[contributors.COUNT] ON COLUMNS FROM [EquityDerivativesCube] CELL PROPERTIES VALUE, FORMATTED_VALUE, BACK_COLOR, FORE_COLOR, FONT_FLAGS","contextValues":{"mdx.hiddengrandtotals":"1"},"updateMode":"once","ranges":{"row":{"chunkSize":2000,"thresholdPercentage":0.1},"column":{"chunkSize":50,"thresholdPercentage":0.2}},"configuration":{"tabular":{"pinnedHeaderSelector":"member","sortingMode":"non-breaking","addButtonFilter":"numeric","cellRenderers":["tree-layout"],"statisticsShown":true,"columnsGroups":[{"captionProducer":"firstColumn","cellFactory":"kpi-status","selector":"kpi-status"},{"captionProducer":"firstColumn","cellFactory":"lookup","selector":"lookup"},{"captionProducer":"expiry","cellFactory":"expiry","selector":"kpi-expiry"},{"captionProducer":"columnMerge","cellFactory":{"args":{},"key":"treeCells"},"selector":"member"}],"hideAddButton":true,"defaultOptions":{},"expansion":{"automaticExpansion":true}}}},"containerKey":"pivot-table"},"writable":true}},{"key":"2","bookmark":{"name":"Untitled Chart","type":"container","value":{"style":{},"showTitleBar":true,"body":{"configuration":{"type":"plotly-line-chart","mapping":{"xAxis":["[Currency].[Currency].[Currency]"],"values":["[Measures].[pnl.FOREX]"],"splitBy":["[Booking].[Desk].[LegalEntity]"],"horizontalSubplots":[],"verticalSubplots":[]},"switchedTo":"plotly-clustered-column-chart"},"query":{"serverUrl":"","mdx":"SELECT NON EMPTY Crossjoin(Hierarchize(DrilldownLevel([Currency].[Currency])), Hierarchize(DrilldownLevel([Booking].[Desk].[ALL].[AllMember]))) ON ROWS, NON EMPTY [Measures].[pnl.FOREX] ON COLUMNS FROM [EquityDerivativesCube]","contextValues":{},"updateMode":"once"}},"containerKey":"chart"},"writable":true}}],"layout":{"children":{"0":{"ck":"2"},"1":{"ck":"1"}},"direction":"row"},"name":"Page 1","filters":{"EquityDerivativesCube":[]}}]},"containerKey":"dashboard"}}`, | ||
| isDirectory: false, | ||
| owners: ["admin"], | ||
| readers: ["admin"], | ||
| timestamp: 1607879735685, | ||
| lastEditor: "admin", | ||
| canRead: true, | ||
| canWrite: true, | ||
| }, | ||
| }; |
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,17 @@ | ||
| /** | ||
| * Legacy content entry representing a bookmark of an invalid dashboard. | ||
NZepeda marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * Useful for unit tests. | ||
| */ | ||
| export const legacyInvalidDashboardBookmark = { | ||
| entry: { | ||
| content: | ||
| '{"name":"hidden grand totals","type":"container","value":{"style":{},"showTitleBar":false,"body":{"pages":[{"content":[{"key":"1","bookmark":{"name":"Untitled Pivot Table","type":"container","value":{"style":{},"showTitleBar":true,"body":{"serverUrl":"","mdx":"SELECT NON EMPTY Crossjoin(Hierarchize(DrilldownLevel([Geography].[City].[ALL].[AllMember])), Hierarchize(DrilldownLevel([Currency].[Currency].[ALL].[AllMember]))) ON ROWS, NON EMPTY [Measures].[contributors.COUNT] ON COLUMNS FROM [foo] CELL PROPERTIES VALUE, FORMATTED_VALUE, BACK_COLOR, FORE_COLOR, FONT_FLAGS","contextValues":{"mdx.hiddengrandtotals":"1"},"updateMode":"once","ranges":{"row":{"chunkSize":2000,"thresholdPercentage":0.1},"column":{"chunkSize":50,"thresholdPercentage":0.2}},"configuration":{"tabular":{"pinnedHeaderSelector":"member","sortingMode":"non-breaking","addButtonFilter":"numeric","cellRenderers":["tree-layout"],"statisticsShown":true,"columnsGroups":[{"captionProducer":"firstColumn","cellFactory":"kpi-status","selector":"kpi-status"},{"captionProducer":"firstColumn","cellFactory":"lookup","selector":"lookup"},{"captionProducer":"expiry","cellFactory":"expiry","selector":"kpi-expiry"},{"captionProducer":"columnMerge","cellFactory":{"args":{},"key":"treeCells"},"selector":"member"}],"hideAddButton":true,"defaultOptions":{},"expansion":{"automaticExpansion":true}}}},"containerKey":"pivot-table"},"writable":true}},{"key":"2","bookmark":{"name":"Untitled Chart","type":"container","value":{"style":{},"showTitleBar":true,"body":{"configuration":{"type":"plotly-line-chart","mapping":{"xAxis":["[Currency].[Currency].[Currency]"],"values":["[Measures].[pnl.FOREX]"],"splitBy":["[Booking].[Desk].[LegalEntity]"],"horizontalSubplots":[],"verticalSubplots":[]},"switchedTo":"plotly-clustered-column-chart"},"query":{"serverUrl":"","mdx":"SELECT NON EMPTY Crossjoin(Hierarchize(DrilldownLevel([Currency].[Currency])), Hierarchize(DrilldownLevel([Booking].[Desk].[ALL].[AllMember]))) ON ROWS, NON EMPTY [Measures].[pnl.FOREX] ON COLUMNS FROM [EquityDerivativesCube]","contextValues":{},"updateMode":"once"}},"containerKey":"chart"},"writable":true}}],"layout":{"children":{"0":{"ck":"2"},"1":{"ck":"1"}},"direction":"row"},"name":"Page 1","filters":{"EquityDerivativesCube":[]}}]},"containerKey":"dashboard"}}', | ||
| isDirectory: false, | ||
| owners: ["admin"], | ||
| readers: ["admin"], | ||
| timestamp: 1607879735685, | ||
| lastEditor: "admin", | ||
| canRead: true, | ||
| canWrite: true, | ||
| }, | ||
| }; | ||
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,17 @@ | ||
| /** | ||
| * Content entry representing a legacy filter containing an invalid property | ||
NZepeda marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * Useful for unit tests. | ||
| */ | ||
| export const legacyInvalidFilterBookmark = { | ||
| entry: { | ||
| content: | ||
| '{"name":"AUI4 filter","type":"mdx","invalidvalue":{"shouldReplace":true,"type":"filter","mdx":"{[Geography].[City].[ALL].[AllMember].[Berlin], [Geography].[City].[ALL].[AllMember].[London]}","cube":"EquityDerivativesCube"}}', | ||
| isDirectory: false, | ||
| owners: ["admin"], | ||
| readers: ["admin"], | ||
| timestamp: 1607879735685, | ||
| lastEditor: "admin", | ||
| canRead: true, | ||
| canWrite: true, | ||
| }, | ||
| }; | ||
Oops, something went wrong.
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.
Here too, it would be nice to not lose this, in order to ensure that the migration script does not erase bookmark permissions.