Filter getEnvs response for schema request

Signed-off-by: Mirjam Aulbach <[email protected]>
Aiven-Open · Oct 6, 2023 · 51caeed · 51caeed
1 parent 042ca27
commit 51caeed
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 42 deletions.
diff --git a/coral/src/app/features/topics/schema-request/TopicSchemaRequest.test.tsx b/coral/src/app/features/topics/schema-request/TopicSchemaRequest.test.tsx
@@ -19,7 +19,7 @@ jest.mock("src/domain/schema-request/schema-request-api.ts");
 jest.mock("src/domain/environment/environment-api.ts");
 jest.mock("src/domain/topic/topic-api.ts");
 
-const mockgetAllEnvironmentsForTopicAndAcl =
+const mockGetAllEnvironmentsForTopicAndAcl =
   getAllEnvironmentsForTopicAndAcl as jest.MockedFunction<
     typeof getAllEnvironmentsForTopicAndAcl
   >;
@@ -47,15 +47,17 @@ const useQuerySpy = jest.spyOn(ReactQuery, "useQuery");
 const testTopicName = "my-awesome-topic";
 
 const mockedEnvironments = [
-  { name: "DEV", id: "1" },
-  { name: "TST", id: "2" },
-  { name: "INFRA", id: "3" },
+  { name: "DEV", id: "1", associatedEnv: { id: "3", name: "DEV_SCH" } },
+  { name: "TST", id: "2", associatedEnv: { id: "9", name: "TST_SCH" } },
+  { name: "INFRA", id: "3", associatedEnv: { id: "9", name: "INFRA_SCH" } },
+  { name: "SOME", id: "3", associatedEnv: undefined },
 ];
-const mockedGetSchemaRegistryEnvironments = transformEnvironmentApiResponse(
-  mockedEnvironments.map((entry) => {
-    return createMockEnvironmentDTO(entry);
-  })
-);
+const mockedGetAllEnvironmentsForTopicAndAclResponse =
+  transformEnvironmentApiResponse(
+    mockedEnvironments.map((entry) => {
+      return createMockEnvironmentDTO(entry);
+    })
+  );
 
 const fileName = "my-awesome-schema.avsc";
 const testFile: File = new File(["{}"], fileName, {
@@ -75,8 +77,8 @@ describe("TopicSchemaRequest", () => {
 
   describe("checks if topicName passed from url is part of topics user can request schemas for", () => {
     beforeEach(() => {
-      mockgetAllEnvironmentsForTopicAndAcl.mockResolvedValue(
-        mockedGetSchemaRegistryEnvironments
+      mockGetAllEnvironmentsForTopicAndAcl.mockResolvedValue(
+        mockedGetAllEnvironmentsForTopicAndAclResponse
       );
       mockCreateSchemaRequest.mockImplementation(jest.fn());
     });
@@ -145,8 +147,8 @@ describe("TopicSchemaRequest", () => {
     });
 
     it("does not redirect user if env ID query is part of list of environments", async () => {
-      mockgetAllEnvironmentsForTopicAndAcl.mockResolvedValue([
-        ...mockedGetSchemaRegistryEnvironments,
+      mockGetAllEnvironmentsForTopicAndAcl.mockResolvedValue([
+        ...mockedGetAllEnvironmentsForTopicAndAclResponse,
       ]);
 
       customRender(
@@ -184,8 +186,8 @@ describe("TopicSchemaRequest", () => {
     });
 
     it("does not redirect user if env name query is part of list of environments", async () => {
-      mockgetAllEnvironmentsForTopicAndAcl.mockResolvedValue([
-        ...mockedGetSchemaRegistryEnvironments,
+      mockGetAllEnvironmentsForTopicAndAcl.mockResolvedValue([
+        ...mockedGetAllEnvironmentsForTopicAndAclResponse,
       ]);
 
       customRender(
@@ -223,8 +225,8 @@ describe("TopicSchemaRequest", () => {
     });
 
     it("redirects user if env id query does not exist in list of environments", async () => {
-      mockgetAllEnvironmentsForTopicAndAcl.mockResolvedValue([
-        ...mockedGetSchemaRegistryEnvironments,
+      mockGetAllEnvironmentsForTopicAndAcl.mockResolvedValue([
+        ...mockedGetAllEnvironmentsForTopicAndAclResponse,
       ]);
 
       customRender(
@@ -244,8 +246,8 @@ describe("TopicSchemaRequest", () => {
     });
 
     it("redirects user if env name query does not exist in list of environments", async () => {
-      mockgetAllEnvironmentsForTopicAndAcl.mockResolvedValue([
-        ...mockedGetSchemaRegistryEnvironments,
+      mockGetAllEnvironmentsForTopicAndAcl.mockResolvedValue([
+        ...mockedGetAllEnvironmentsForTopicAndAclResponse,
       ]);
 
       customRender(
@@ -270,7 +272,7 @@ describe("TopicSchemaRequest", () => {
       // eslint-disable-next-line @typescript-eslint/ban-ts-comment
       //@ts-ignore
       useQuerySpy.mockReturnValue({ data: [], isLoading: true });
-      mockgetAllEnvironmentsForTopicAndAcl.mockResolvedValue([]);
+      mockGetAllEnvironmentsForTopicAndAcl.mockResolvedValue([]);
       mockCreateSchemaRequest.mockImplementation(jest.fn());
       mockGetTopicNames.mockResolvedValue([testTopicName]);
 
@@ -308,8 +310,8 @@ describe("TopicSchemaRequest", () => {
 
   describe("renders all necessary elements", () => {
     beforeAll(async () => {
-      mockgetAllEnvironmentsForTopicAndAcl.mockResolvedValue(
-        mockedGetSchemaRegistryEnvironments
+      mockGetAllEnvironmentsForTopicAndAcl.mockResolvedValue(
+        mockedGetAllEnvironmentsForTopicAndAclResponse
       );
       mockCreateSchemaRequest.mockImplementation(jest.fn());
       mockGetTopicNames.mockResolvedValue([testTopicName]);
@@ -348,27 +350,34 @@ describe("TopicSchemaRequest", () => {
       expect(select).toBeRequired();
     });
 
-    it("renders all options for Environment based on api data", () => {
+    it("renders all options for Environment with associated env based on api data", () => {
+      const environmentsWithAssociatedEnvs = mockedEnvironments.filter(
+        (env) => env.associatedEnv
+      );
+
       const form = getForm();
       const select = within(form).getByRole("combobox", {
         name: /Environment/i,
       });
       const options = within(select).getAllByRole("option");
 
-      expect(options).toHaveLength(mockedEnvironments.length + 1);
+      expect(options).toHaveLength(environmentsWithAssociatedEnvs.length + 1);
     });
 
     test.each(mockedEnvironments)(
-      `renders a option $name with the Environments id set as value $id`,
-      ({ name, id }) => {
-        const form = getForm();
-        const select = within(form).getByRole("combobox", {
-          name: /Environment/i,
-        });
-        const option = within(select).getByRole("option", { name: name });
-
-        expect(option).toBeVisible();
-        expect(option).toHaveValue(id);
+      `renders a option $name with the Environments id set as value $id when Environment has an associated env`,
+      (environment) => {
+        if (environment.associatedEnv) {
+          const { name, id } = environment;
+          const form = getForm();
+          const select = within(form).getByRole("combobox", {
+            name: /Environment/i,
+          });
+          const option = within(select).getByRole("option", { name: name });
+
+          expect(option).toBeVisible();
+          expect(option).toHaveValue(id);
+        }
       }
     );
 
@@ -441,8 +450,8 @@ describe("TopicSchemaRequest", () => {
 
   describe("shows errors when user does not fill out correctly", () => {
     beforeEach(async () => {
-      mockgetAllEnvironmentsForTopicAndAcl.mockResolvedValue(
-        mockedGetSchemaRegistryEnvironments
+      mockGetAllEnvironmentsForTopicAndAcl.mockResolvedValue(
+        mockedGetAllEnvironmentsForTopicAndAclResponse
       );
       mockCreateSchemaRequest.mockImplementation(jest.fn());
       mockGetTopicNames.mockResolvedValue([testTopicName]);
@@ -519,8 +528,8 @@ describe("TopicSchemaRequest", () => {
 
   describe("enables user to cancel the form input", () => {
     beforeEach(async () => {
-      mockgetAllEnvironmentsForTopicAndAcl.mockResolvedValue(
-        mockedGetSchemaRegistryEnvironments
+      mockGetAllEnvironmentsForTopicAndAcl.mockResolvedValue(
+        mockedGetAllEnvironmentsForTopicAndAclResponse
       );
       mockCreateSchemaRequest.mockImplementation(jest.fn());
       mockGetTopicNames.mockResolvedValue([testTopicName]);
@@ -635,8 +644,8 @@ describe("TopicSchemaRequest", () => {
 
     beforeEach(async () => {
       console.error = jest.fn();
-      mockgetAllEnvironmentsForTopicAndAcl.mockResolvedValue(
-        mockedGetSchemaRegistryEnvironments
+      mockGetAllEnvironmentsForTopicAndAcl.mockResolvedValue(
+        mockedGetAllEnvironmentsForTopicAndAclResponse
       );
       mockCreateSchemaRequest.mockRejectedValue({
         status: "400 BAD_REQUEST",
@@ -740,8 +749,8 @@ describe("TopicSchemaRequest", () => {
 
   describe("enables user to send a schema request", () => {
     beforeEach(async () => {
-      mockgetAllEnvironmentsForTopicAndAcl.mockResolvedValue(
-        mockedGetSchemaRegistryEnvironments
+      mockGetAllEnvironmentsForTopicAndAcl.mockResolvedValue(
+        mockedGetAllEnvironmentsForTopicAndAclResponse
       );
       mockCreateSchemaRequest.mockResolvedValue({
         success: true,

diff --git a/coral/src/app/features/topics/schema-request/TopicSchemaRequest.tsx b/coral/src/app/features/topics/schema-request/TopicSchemaRequest.tsx
@@ -88,6 +88,11 @@ function TopicSchemaRequest(props: TopicSchemaRequestProps) {
   >({
     queryKey: ["getEnvs"],
     queryFn: () => getAllEnvironmentsForTopicAndAcl(),
+    // not every Kafka Environment has an associated env for schemas,
+    // so we only want to show those who do.
+    // We use name and ID related to the Kafka Environment in form and mutation.
+    select: (kafkaEnvironments) =>
+      kafkaEnvironments.filter((env) => env.associatedEnv),
     onSuccess: (environments) => {
       if (presetEnvironment) {
         const validEnv = environments.find(