MAT-7246 QDM - Remove Value Set Versions from CQL and notify user

src/components/editCqlLibrary/EditCqlLibrary.test.tsx

@@ -489,11 +489,16 @@ describe("Edit Cql Library Component", () => {
     ).toBeDisabled();
   });
 
-  it("should update an existing cql library with the synched cql library name, version and display a warning message", async () => {
+  it("should revert change in library statement, using statement and value version if encountered", async () => {
     (synchingEditorCqlContent as jest.Mock)
       .mockClear()
       .mockImplementation(() => {
-        return "library UpdateName version '1.0.000'";
+        return {
+          cql: "library UpdateName version '1.0.000'",
+          isLibraryStatementChanged: true,
+          isUsingStatementChanged: false,
+          isValueSetChanged: false,
+        };
       });
     mockedAxios.put.mockResolvedValue({
       data: {
@@ -541,12 +546,16 @@ describe("Edit Cql Library Component", () => {
     await waitFor(() => {
       const successMessage = screen.getByTestId("generic-success-text-header");
       expect(successMessage.textContent).toEqual(
-        "CQL updated successfully! Library Statement or Using Statement were incorrect. MADiE has overwritten them to ensure proper CQL."
+        "CQL updated successfully but the following issues were found"
       );
     });
+    const warningMessage = screen.getByTestId("library-warning");
+    expect(warningMessage.textContent).toEqual(
+      "Library statement was incorrect. MADiE has overwritten it."
+    );
   });
 
-  it("should update an existing cql library with the synched cql library name, version and warn about blank using", async () => {
+  it("should update an existing cql library with the updated cql library name, version and warn about blank using", async () => {
     (synchingEditorCqlContent as jest.Mock)
       .mockClear()
       .mockImplementation(() => {
@@ -601,7 +610,7 @@ describe("Edit Cql Library Component", () => {
     await waitFor(() => {
       const successMessage = screen.getByTestId("generic-success-text-header");
       expect(successMessage.textContent).toEqual(
-        "CQL updated successfully but was missing a Using statement.  Please add in a valid model and version."
+        "CQL updated successfully but the following issues were found"
       );
     });
   });
@@ -692,9 +701,7 @@ describe("Edit Cql Library Component", () => {
     userEvent.click(updateButton);
     await waitFor(() => {
       const successMessage = screen.getByTestId("generic-success-text-header");
-      expect(successMessage.textContent).toEqual(
-        "CQL Library saved successfully"
-      );
+      expect(successMessage.textContent).toEqual("CQL updated successfully");
       expect(mockedAxios.put).toHaveBeenCalledTimes(1);
     });
     expect(mockedAxios.put.mock.lastCall[0]).toEqual(

src/components/editCqlLibrary/EditCqlLibrary.tsx

@@ -60,7 +60,8 @@
   // StatusHandler utilities
   const [success, setSuccess] = useState({
     status: undefined,
-    message: undefined,
+    primaryMessage: undefined,
+    secondaryMessages: undefined,
   });
   const [error, setError] = useState(false);
   const [errorMessage, setErrorMessage] = useState<string>(null);
@@ -136,7 +137,11 @@
 
   const onChange = (value) => {
     formik.setFieldValue("cql", value);
-    setSuccess({ status: undefined, message: undefined });
+    setSuccess({
+      status: undefined,
+      primaryMessage: undefined,
+      secondaryMessages: undefined,
+    });
     setError(false);
     setErrorMessage(undefined);
     setValuesetMsg(undefined);
@@ -160,7 +165,7 @@
           setErrorMessage("An error occurred while fetching the CQL Library!");
         });
     }
   }, [id, resetForm, loadedCqlLibrary, cqlLibraryServiceApi]);
 
   // fetch organizations DB using measure service and sorts alphabetically
   useEffect(() => {
@@ -176,12 +181,12 @@
         const message = `Error fetching organizations`;
         handleToast("danger", message, true);
       });
   }, []);
 
   async function updateCqlLibrary(cqlLibrary: CqlLibrary) {
     setActiveSpinner(true);
     const using = loadedCqlLibrary?.model.split(" v");
-    const inSyncCql = await synchingEditorCqlContent(
+    const updatedContent = await synchingEditorCqlContent(
       formik.values.cql?.trim() ?? "",
       loadedCqlLibrary?.cql,
       formik.values.cqlLibraryName,
@@ -191,9 +196,7 @@
       using[1],
       "updateCqlLibrary"
     );
-
-    const results = await executeCqlParsingForErrors(inSyncCql);
-
+    const results = await executeCqlParsingForErrors(updatedContent.cql);
     if (results[0].status === "rejected") {
       console.error(
         "An error occurred while translating CQL to ELM",
@@ -223,38 +226,50 @@
         _.filter(validationResult?.errors, { errorSeverity: "Error" })
       ) || !_.isEmpty(validationResult?.externalErrors);
 
-    const cqlErrors = inSyncCql?.trim().length
+    const cqlErrors = updatedContent.cql?.trim().length
       ? parseErrors || cqlElmErrors
       : false;
-    const synchedCqlLibrary = { ...cqlLibrary, cql: inSyncCql, cqlErrors };
+    const updatedLibrary = {
+      ...cqlLibrary,
+      cql: updatedContent.cql,
+      cqlErrors,
+    };
     cqlLibraryServiceApi
-      .updateCqlLibrary(synchedCqlLibrary)
+      .updateCqlLibrary(updatedLibrary)
       .then((response) => {
         cqlLibraryStore.updateLibrary(response.data);
         setLoadedCqlLibrary(response.data);
         resetForm();
-        if (cqlLibrary.cql?.trim() && isUsingEmpty(cqlLibrary.cql.trim())) {
-          setSuccess({
-            status: "success",
-            message:
-              "CQL updated successfully but was missing a Using statement.  Please add in a valid model and version.",
-          });
-        } else {
-          const successMessage =
-            cqlLibrary.cql !== null &&
-            inSyncCql &&
-            inSyncCql?.trim() !== cqlLibrary.cql.trim()
-              ? {
-                  status: "success",
-                  message:
-                    "CQL updated successfully! Library Statement or Using Statement were incorrect. MADiE has overwritten them to ensure proper CQL.",
-                }
-              : {
-                  status: "success",
-                  message: "CQL Library saved successfully",
-                };
-          setSuccess(successMessage);
+        let primaryMessage = "CQL updated successfully";
+        const secondaryMessages = [];
+        if (isUsingEmpty(updatedContent.cql)) {
+          secondaryMessages.push(
+            "Missing a using statement. Please add in a valid model and version."
+          );
         }
+        if (updatedContent.isLibraryStatementChanged) {
+          secondaryMessages.push(
+            "Library statement was incorrect. MADiE has overwritten it."
+          );
+        }
+        if (updatedContent.isUsingStatementChanged) {
+          secondaryMessages.push(
+            "Using statement was incorrect. MADiE has overwritten it."
+          );
+        }
+        if (updatedContent.isValueSetChanged) {
+          secondaryMessages.push(
+            "MADiE does not currently support use of value set version directly in library at this time. Your value set versions have been removed. Please use the relevant manifest for value set expansion for testing."
+          );
+        }
+        if (secondaryMessages.length > 0) {
+          primaryMessage += " but the following issues were found";
+        }
+        setSuccess({
+          status: "success",
+          primaryMessage,
+          secondaryMessages,
+        });
       })
       .catch((error) => {
         setError(true);

src/components/editCqlLibrary/statusHandler/StatusHandler.scss

@@ -10,7 +10,7 @@
       line-height: normal;
     }
     .secondary {
-      margin-bottom: 5px;
+      margin-bottom: 12px;
       ~ ul,
       ~ ol {
         margin-bottom: 0;

src/components/editCqlLibrary/statusHandler/StatusHandler.test.tsx

@@ -22,8 +22,12 @@ describe("StatusHandler Component", () => {
   it("Should display a success message and a library warning if a library warning exists when no error or messages present, also displays a list of annotations", () => {
     const success = {
       status: "success",
-      message:
-        "CQL updated successfully! Library Statement or Using Statement were incorrect. MADiE has overwritten them to ensure proper CQL.",
+      primaryMessage:
+        "CQL updated successfully but the following issues were found",
+      secondaryMessages: [
+        "Library statement was incorrect. MADiE has overwritten it",
+        "Using statement was incorrect. MADiE has overwritten it",
+      ],
     };
     render(
       <StatusHandler
@@ -35,10 +39,10 @@ describe("StatusHandler Component", () => {
     );
 
     expect(getByTestId("generic-success-text-header")).toHaveTextContent(
-      "Changes saved successfully but the following issues were found"
+      success.primaryMessage
     );
     expect(screen.getByTestId("library-warning")).toHaveTextContent(
-      success.message
+      success.secondaryMessages.join("")
     );
     const errorsList = screen.getByTestId("generic-errors-text-list");
     expect(errorsList).toBeInTheDocument();
@@ -55,8 +59,12 @@ describe("StatusHandler Component", () => {
   it("Should display a success message and a using warning if a using warning exists when no error or messages present, also displays a list of annotations", () => {
     const success = {
       status: "success",
-      message:
-        "CQL updated successfully but was missing a Using statement. Please add in a valid model and version.",
+      primaryMessage:
+        "CQL updated successfully but the following issues were found",
+      secondaryMessages: [
+        "Library statement was incorrect. MADiE has overwritten it",
+        "Using statement was incorrect. MADiE has overwritten it",
+      ],
     };
     render(
       <StatusHandler
@@ -68,9 +76,8 @@ describe("StatusHandler Component", () => {
     );
 
     expect(getByTestId("generic-success-text-header")).toHaveTextContent(
-      "Changes saved successfully but the following issues were found"
+      success.primaryMessage
     );
-    expect(screen.queryByTestId("library-warning")).not.toBeInTheDocument();
     const errorsList = screen.getByTestId("generic-errors-text-list");
     expect(errorsList).toBeInTheDocument();
     expect(errorsList).toHaveTextContent(
@@ -86,7 +93,7 @@ describe("StatusHandler Component", () => {
   it("Should display a success message along with annotation", () => {
     const success = {
       status: "success",
-      message: "stuff saved successfully",
+      primaryMessage: "stuff saved successfully",
     };
     render(
       <StatusHandler
@@ -98,7 +105,7 @@ describe("StatusHandler Component", () => {
     );
 
     expect(getByTestId("generic-success-text-header")).toHaveTextContent(
-      "Changes saved successfully but the following issues were found"
+      success.primaryMessage
     );
     expect(screen.queryByTestId("library-warning")).not.toBeInTheDocument();
     const errorsList = screen.getByTestId("generic-errors-text-list");
@@ -116,7 +123,7 @@ describe("StatusHandler Component", () => {
   it("Should display a generic success message when no annotations or messages are present", () => {
     const success = {
       status: "success",
-      message: "stuff saved successfully",
+      primaryMessage: "stuff saved successfully",
     };
     render(
       <StatusHandler
@@ -128,7 +135,7 @@ describe("StatusHandler Component", () => {
     );
 
     expect(getByTestId("generic-success-text-header")).toHaveTextContent(
-      success.message
+      success.primaryMessage
     );
     expect(
       screen.queryByTestId("generic-errors-text-list")
@@ -143,7 +150,7 @@ describe("StatusHandler Component", () => {
   it("Should display an error message with provided errorMessage and annotations", () => {
     const success = {
       status: undefined,
-      message: "",
+      primaryMessage: "",
     };
     const errorMessage = "CQL problem please help";
     render(
@@ -173,7 +180,7 @@ describe("StatusHandler Component", () => {
   it("Should display an error message with provided error message and no annotations", () => {
     const success = {
       status: undefined,
-      message: "",
+      primaryMessage: "",
     };
     const errorMessage = "CQL problem please help";
     render(
@@ -200,7 +207,7 @@ describe("StatusHandler Component", () => {
   it("Should display a generic error message along with annotations provided", () => {
     const success = {
       status: undefined,
-      message: "",
+      primaryMessage: "",
     };
     render(
       <StatusHandler
@@ -229,7 +236,7 @@ describe("StatusHandler Component", () => {
   it("Should display a generic error message when no error message or annotations are provided, but error flag is true", () => {
     const success = {
       status: undefined,
-      message: "",
+      primaryMessage: "",
     };
     render(
       <StatusHandler
@@ -255,7 +262,7 @@ describe("StatusHandler Component", () => {
   it("Should display outbound annotation even when Error flag is false", () => {
     const success = {
       status: undefined,
-      message: "",
+      primaryMessage: "",
     };
     render(
       <StatusHandler

src/components/editCqlLibrary/statusHandler/StatusHandler.tsx

@@ -6,7 +6,7 @@ import * as _ from "lodash";
 const generateMadieAlertWithContent = (
   type,
   header,
-  secondaryMessage,
+  secondaryMessages,
   outboundAnnotations
 ) => {
   const errorAnnotation = _.filter(outboundAnnotations, { type: "error" });
@@ -31,9 +31,13 @@ const generateMadieAlertWithContent = (
           >
             {header}
           </h3>
-          {secondaryMessage && (
+          {secondaryMessages?.length > 0 && (
             <p className="secondary" data-testid="library-warning">
-              {secondaryMessage}
+              <ul style={{ listStyle: "inside" }}>
+                {secondaryMessages.map((message) => (
+                  <li>{message}</li>
+                ))}
+              </ul>
             </p>
           )}
           {errors?.length > 0 && (
@@ -73,31 +77,17 @@ const StatusHandler = ({
 }) => {
   if (success.status === "success") {
     if (outboundAnnotations?.length > 0) {
-      if (
-        success.message ===
-          "CQL updated successfully but was missing a Using statement.  Please add in a valid model and version." ||
-        success.message ===
-          "CQL updated successfully! Library Statement or Using Statement were incorrect. MADiE has overwritten them to ensure proper CQL."
-      ) {
-        return generateMadieAlertWithContent(
-          success.status,
-          "Changes saved successfully but the following issues were found",
-          success.message,
-          outboundAnnotations
-        );
-      } else {
-        return generateMadieAlertWithContent(
-          success.status,
-          "Changes saved successfully but the following issues were found",
-          null,
-          outboundAnnotations
-        );
-      }
+      return generateMadieAlertWithContent(
+        success.status,
+        success.primaryMessage,
+        success.secondaryMessages,
+        outboundAnnotations
+      );
     } else {
       return generateMadieAlertWithContent(
         success.status,
-        success.message,
-        null,
+        success.primaryMessage,
+        success.secondaryMessages,
         null
       );
     }