ATLAS-5322: Fix glossary bulk import relation parsing and error reporting. #712
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
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." | ||
| ); | ||
| }); | ||
| }); | ||
|
Contributor
There was a problem hiding this comment. Missing negative / edge cases: Only remarks (no names) suggestion: |
||
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.`; | ||
|
Contributor
There was a problem hiding this comment. Summary string is hardcoded glossary-specific ("Glossary import completed...")
|
||
| }; | ||
|
|
||
| /** 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.
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.
Blocker:
Test Suites: 1 failed, 2 passed, 3 total
Tests: 1 failed, 48 passed, 49 total
Failure: ImportDialog.test.tsx — expectations not updated for new behavior:
Suggestion: (ImportDialog.test.tsx line ~103–122):
Tests must be updated to match new toast summary and formatted error lines. Also add a Business Metadata failure test to ensure glossary formatting is not applied there.