-
Notifications
You must be signed in to change notification settings - Fork 902
ATLAS-5322: Fix glossary bulk import relation parsing and error reporting. #712
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.
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
Open
UmeshPatil-1
wants to merge
2
commits into
apache:master
Choose a base branch
from
UmeshPatil-1:ATLAS-5322
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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
134 changes: 134 additions & 0 deletions
134
dashboard/src/utils/__tests__/glossaryImportUtils.test.ts
This file contains hidden or 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,134 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF 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 { | ||
| buildGenericImportFailureSummary, | ||
| buildGlossaryImportFailureSummary, | ||
| formatGenericImportFailure, | ||
| formatGlossaryImportFailure, | ||
| formatImportFailureForDisplay, | ||
| getGlossaryImportTermLabel, | ||
| getImportFailureToastMessage | ||
| } from "../glossaryImportUtils"; | ||
|
|
||
| describe("glossaryImportUtils", () => { | ||
| it("formats failure with glossary term label when both names exist", () => { | ||
| expect( | ||
| formatGlossaryImportFailure({ | ||
| childObjectName: "Patient", | ||
| parentObjectName: "Healthcare Glossary", | ||
| remarks: "Reference not found" | ||
| }) | ||
| ).toBe("Patient@Healthcare Glossary: Reference not found"); | ||
| }); | ||
|
|
||
| it("formats failure with childObjectName only (same-glossary shorthand)", () => { | ||
| expect( | ||
| formatGlossaryImportFailure({ | ||
| childObjectName: "Patient", | ||
| remarks: "Invalid relation" | ||
| }) | ||
| ).toBe("Patient: Invalid relation"); | ||
| expect(getGlossaryImportTermLabel({ childObjectName: "Patient" })).toBe( | ||
| "Patient" | ||
| ); | ||
| }); | ||
|
|
||
| it("formats failure with remarks only (no term names)", () => { | ||
| expect( | ||
| formatGlossaryImportFailure({ | ||
| remarks: "Bad row" | ||
| }) | ||
| ).toBe("Unknown term: Bad row"); | ||
| }); | ||
|
|
||
| it("falls back to Import failed when remarks are empty", () => { | ||
| expect(formatGlossaryImportFailure({ childObjectName: "Patient" })).toBe( | ||
| "Patient: Import failed" | ||
| ); | ||
| expect(formatGenericImportFailure({})).toBe("Import failed"); | ||
| }); | ||
|
|
||
| it("builds import summary with success and failure counts", () => { | ||
| expect( | ||
| buildGlossaryImportFailureSummary({ | ||
| successImportInfoList: [{ childObjectName: "A" }], | ||
| failedImportInfoList: [ | ||
| { | ||
| childObjectName: "Patient", | ||
| parentObjectName: "Healthcare Glossary", | ||
| remarks: "Invalid relation" | ||
| } | ||
| ] | ||
| }) | ||
| ).toBe( | ||
| "Glossary import completed with 1 failure(s) out of 2 term(s). See error details." | ||
| ); | ||
| }); | ||
|
|
||
| it("builds summary with failures only (no successes)", () => { | ||
| expect( | ||
| buildGlossaryImportFailureSummary({ | ||
| failedImportInfoList: [{ remarks: "Bad row" }] | ||
| }) | ||
| ).toBe( | ||
| "Glossary import completed with 1 failure(s) out of 1 term(s). See error details." | ||
| ); | ||
| }); | ||
|
|
||
| it("builds summary with empty success and failure lists", () => { | ||
| expect(buildGlossaryImportFailureSummary({})).toBe( | ||
| "Glossary import completed with 0 failure(s) out of 0 term(s). See error details." | ||
| ); | ||
| }); | ||
|
|
||
| it("uses generic import helpers for business metadata", () => { | ||
| const response = { | ||
| successImportInfoList: [{ remarks: "ok" }], | ||
| failedImportInfoList: [ | ||
| { | ||
| parentObjectName: "guid-123", | ||
| childObjectName: "attr1", | ||
| remarks: "Invalid attribute" | ||
| } | ||
| ] | ||
| }; | ||
|
|
||
| expect(getImportFailureToastMessage(false, response)).toBe( | ||
| "Invalid attribute" | ||
| ); | ||
| expect(formatImportFailureForDisplay(false, response.failedImportInfoList[0])).toBe( | ||
| "Invalid attribute" | ||
| ); | ||
| expect(buildGenericImportFailureSummary(response)).toBe( | ||
| "Import completed with 1 failure(s) out of 2 item(s). See error details." | ||
| ); | ||
| }); | ||
|
|
||
| it("uses generic summary toast for multiple business metadata failures", () => { | ||
| expect( | ||
| getImportFailureToastMessage(false, { | ||
| failedImportInfoList: [ | ||
| { remarks: "First error" }, | ||
| { remarks: "Second error" } | ||
| ] | ||
| }) | ||
| ).toBe( | ||
| "Import completed with 2 failure(s) out of 2 item(s). See error details." | ||
| ); | ||
| }); | ||
| }); | ||
|
UmeshPatil-1 marked this conversation as resolved.
|
||
This file contains hidden or 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,105 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF 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. | ||
| */ | ||
|
|
||
| export interface GlossaryImportFailure { | ||
| childObjectName?: string; | ||
| parentObjectName?: string; | ||
| remarks?: string; | ||
| rowNumber?: number; | ||
| } | ||
|
|
||
| export interface GlossaryImportResponse { | ||
| failedImportInfoList?: GlossaryImportFailure[]; | ||
| successImportInfoList?: GlossaryImportFailure[]; | ||
| } | ||
|
|
||
| /** Glossary-only: term label for TermName@GlossaryName when both names exist. */ | ||
| export const getGlossaryImportTermLabel = ( | ||
| failure: GlossaryImportFailure | ||
| ): string => { | ||
| if (failure.childObjectName && failure.parentObjectName) { | ||
| return `${failure.childObjectName}@${failure.parentObjectName}`; | ||
| } | ||
| if (failure.childObjectName) { | ||
| return failure.childObjectName; | ||
| } | ||
| return "Unknown term"; | ||
| }; | ||
|
|
||
| /** Glossary-only: one formatted failure line (term label + reason). */ | ||
| export const formatGlossaryImportFailure = ( | ||
| failure: GlossaryImportFailure | ||
| ): string => { | ||
| return `${getGlossaryImportTermLabel(failure)}: ${failure.remarks || "Import failed"}`; | ||
| }; | ||
|
|
||
| /** Glossary-only: summary toast for bulk glossary term import failures. */ | ||
| export const buildGlossaryImportFailureSummary = ( | ||
| response: GlossaryImportResponse | ||
| ): string => { | ||
| const failedCount = response.failedImportInfoList?.length || 0; | ||
| const successCount = response.successImportInfoList?.length || 0; | ||
| const totalCount = failedCount + successCount; | ||
|
|
||
| return `Glossary import completed with ${failedCount} failure(s) out of ${totalCount} term(s). See error details.`; | ||
|
UmeshPatil-1 marked this conversation as resolved.
|
||
| }; | ||
|
|
||
| /** Generic import (e.g. Business Metadata): use raw remarks, not glossary @ labels. */ | ||
| export const formatGenericImportFailure = ( | ||
| failure: GlossaryImportFailure | ||
| ): string => { | ||
| return failure.remarks || "Import failed"; | ||
| }; | ||
|
|
||
| /** Generic import summary when multiple failures exist (non-glossary imports). */ | ||
| export const buildGenericImportFailureSummary = ( | ||
| response: GlossaryImportResponse | ||
| ): string => { | ||
| const failedCount = response.failedImportInfoList?.length || 0; | ||
| const successCount = response.successImportInfoList?.length || 0; | ||
| const totalCount = failedCount + successCount; | ||
|
|
||
| return `Import completed with ${failedCount} failure(s) out of ${totalCount} item(s). See error details.`; | ||
| }; | ||
|
|
||
| /** Pick toast message based on import type — glossary vs shared/BM dialog. */ | ||
| export const getImportFailureToastMessage = ( | ||
| isGlossaryImport: boolean, | ||
| response: GlossaryImportResponse | ||
| ): string => { | ||
| if (isGlossaryImport) { | ||
| return buildGlossaryImportFailureSummary(response); | ||
| } | ||
|
|
||
| const failedList = response.failedImportInfoList; | ||
| if (failedList && failedList.length === 1) { | ||
| return failedList[0]?.remarks ?? "Import failed"; | ||
| } | ||
|
|
||
| return buildGenericImportFailureSummary(response); | ||
| }; | ||
|
|
||
| /** Pick error-detail line based on import type. */ | ||
| export const formatImportFailureForDisplay = ( | ||
| isGlossaryImport: boolean, | ||
| failure: GlossaryImportFailure | ||
| ): string => { | ||
| if (isGlossaryImport) { | ||
| return formatGlossaryImportFailure(failure); | ||
| } | ||
| return formatGenericImportFailure(failure); | ||
| }; | ||
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.
Uh oh!
There was an error while loading. Please reload this page.