fix: only save credentials when there are sensitive values (#3394)

Closes: #3394
SwissDataScienceCenter · Nov 15, 2024 · bc0f3de · bc0f3de
1 parent 6a8eadc
commit bc0f3de
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 10 deletions.
diff --git a/.../src/features/dataConnectorsV2/components/DataConnectorModal/DataConnectorModalFooter.tsx b/.../src/features/dataConnectorsV2/components/DataConnectorModal/DataConnectorModalFooter.tsx
@@ -191,18 +191,12 @@ export default function DataConnectorModalFooter({
   useEffect(() => {
     const dataConnectorId = createResult.data?.id;
     if (dataConnectorId == null) return;
-    const shouldSaveCredentials = shouldSaveDataConnectorCredentials(
-      flatDataConnector.options,
-      cloudStorageState.saveCredentials,
-      validationResult?.isSuccess ?? false
-    );
-    if (!shouldSaveCredentials) return;
-
-    const options = flatDataConnector.options as CloudStorageDetailsOptions;
     if (!schemata) return;
     const sensitiveFieldNames = findSensitive(
       schemata.find((s) => s.prefix === flatDataConnector.schema)
     );
+    const options = flatDataConnector.options as CloudStorageDetailsOptions;
+    if (!options) return;
     const dataConnectorSecretPatchList = sensitiveFieldNames
       .map((name) => ({
         name,
@@ -213,6 +207,13 @@ export default function DataConnectorModalFooter({
         name: secret.name,
         value: "" + secret.value,
       }));
+    const shouldSaveCredentials = shouldSaveDataConnectorCredentials(
+      dataConnectorSecretPatchList,
+      cloudStorageState.saveCredentials,
+      validationResult?.isSuccess ?? false
+    );
+    if (!shouldSaveCredentials) return;
+
     saveCredentials({
       dataConnectorId,
       dataConnectorSecretPatchList,
@@ -365,12 +366,12 @@ export default function DataConnectorModalFooter({
 }
 
 function shouldSaveDataConnectorCredentials(
-  flatDataConnectorOptions: CloudStorageDetailsOptions | undefined,
+  dataConnectorSecretPatchList: { name: string; value: string }[],
   stateSaveCredentials: boolean,
   validationSucceeded: boolean
 ) {
   return !!(
-    flatDataConnectorOptions &&
+    dataConnectorSecretPatchList.length > 0 &&
     stateSaveCredentials &&
     validationSucceeded
   );

diff --git a/tests/cypress/e2e/groupV2DataConnectorCredentials.spec.ts b/tests/cypress/e2e/groupV2DataConnectorCredentials.spec.ts
@@ -111,6 +111,50 @@ describe("Set up data connectors with credentials", () => {
     cy.wait("@listDataConnectors");
   });
 
+  it("do not store credentials if there are none", () => {
+    fixtures
+      .listDataConnectors({ namespace: "test-2-group-v2" })
+      .testCloudStorage({ success: true })
+      .postDataConnector({ namespace: "test-2-group-v2" })
+      .dataConnectorSecrets({
+        fixture: "dataConnector/data-connector-secrets-empty.json",
+      })
+      .patchDataConnectorSecrets({
+        content: [],
+        // No call to postCloudStorageSecrets is expected
+        shouldNotBeCalled: true,
+      });
+    cy.visit("/v2/groups/test-2-group-v2");
+    cy.wait("@readGroupV2");
+    // add data connector
+    cy.getDataCy("add-data-connector").should("be.visible").click();
+    cy.wait("@getStorageSchema");
+
+    // Pick a provider
+    cy.getDataCy("data-storage-s3").click();
+    cy.getDataCy("data-provider-Switch").click();
+    cy.getDataCy("data-connector-edit-next-button").click();
+
+    // // Fill out the details
+    cy.get("#sourcePath").type("bucket/my-source");
+    cy.get("#endpoint").clear().type("https://s3-zh.os.switch.ch");
+    cy.getDataCy("test-data-connector-button").click();
+    cy.getDataCy("add-data-connector-continue-button")
+      .contains("Continue")
+      .click();
+    cy.getDataCy("data-connector-edit-mount").within(() => {
+      cy.get("#name").type("example storage without credentials");
+    });
+    cy.getDataCy("data-connector-edit-update-button").click();
+    cy.wait("@postDataConnector");
+    cy.getDataCy("data-connector-edit-body").should(
+      "contain.text",
+      "The data connector test-2-group-v2/example-storage-without-credentials has been successfully added."
+    );
+    cy.getDataCy("data-connector-edit-close-button").click();
+    cy.wait("@listDataConnectors");
+  });
+
   it("resets validation state when content changes", () => {
     fixtures
       .getStorageSchema({ fixture: "cloudStorage/storage-schema-s3.json" })