Merge pull request #2697 from headlamp-k8s/watching-namespaces-fix

frontend: Fix useKubeObjectLists when deselecting namespaces

Author: joaquimrocha

frontend/src/lib/k8s/api/v2/useKubeObjectList.test.tsx

@@ -4,6 +4,7 @@ import {
   kubeObjectListQuery,
   ListResponse,
   makeListRequests,
+  useKubeObjectList,
   useWatchKubeObjectLists,
 } from './useKubeObjectList';
 import * as websocket from './webSocket';
@@ -81,6 +82,16 @@ const mockClass = class {
   static apiVersion = 'v1';
   static apiName = 'pods';
 
+  static apiEndpoint = {
+    apiInfo: [
+      {
+        group: '',
+        resource: 'pods',
+        version: 'v1',
+      },
+    ],
+  };
+
   constructor(public jsonData: any) {}
 } as any;
 
@@ -221,3 +232,42 @@ describe('useWatchKubeObjectLists', () => {
     ).toBe(objectB);
   });
 });
+
+describe('useKubeObjectList', () => {
+  it('should call useKubeObjectList with 1 namespace after reducing amount of namespaces', async () => {
+    const spy = vi.spyOn(websocket, 'useWebSockets');
+    const queryClient = new QueryClient();
+
+    queryClient.setQueryData(['kubeObject', 'list', 'v1', 'pods', 'default', 'a', {}], {
+      list: { items: [], metadata: { resourceVersion: '0' } },
+      cluster: 'default',
+      namespace: 'a',
+    });
+    queryClient.setQueryData(['kubeObject', 'list', 'v1', 'pods', 'default', 'b', {}], {
+      list: { items: [], metadata: { resourceVersion: '0' } },
+      cluster: 'default',
+      namespace: 'b',
+    });
+
+    const result = renderHook(
+      (props: {}) =>
+        useKubeObjectList({
+          kubeObjectClass: mockClass,
+          requests: [{ cluster: 'default', namespaces: ['a', 'b'] }],
+          ...props,
+        }),
+      {
+        wrapper: ({ children }) => (
+          <QueryClientProvider client={queryClient}>{children}</QueryClientProvider>
+        ),
+      }
+    );
+
+    result.rerender({ requests: [{ cluster: 'default', namespaces: ['a'] }] });
+
+    expect(spy.mock.calls[0][0].connections.length).toBe(0); // initial render
+    expect(spy.mock.calls[1][0].connections.length).toBe(2); // new connections with 'a' and 'b' namespaces
+    expect(spy.mock.calls[2][0].connections.length).toBe(2); // rerender with new props
+    expect(spy.mock.calls[3][0].connections.length).toBe(1); // updated connections after we removed namespace 'b'
+  });
+});

frontend/src/lib/k8s/api/v2/useKubeObjectList.ts

@@ -306,6 +306,19 @@ export function useKubeObjectList<K extends KubeObject>({
     setListsToWatch([...listsToWatch, ...listsNotYetWatched]);
   }
 
+  const listsToStopWatching = listsToWatch.filter(
+    watching =>
+      requests.find(request =>
+        watching.cluster === request?.cluster && request.namespaces && watching.namespace
+          ? request.namespaces?.includes(watching.namespace)
+          : true
+      ) === undefined
+  );
+
+  if (listsToStopWatching.length > 0) {
+    setListsToWatch(listsToWatch.filter(it => !listsToStopWatching.includes(it)));
+  }
+
   useWatchKubeObjectLists({
     lists: shouldWatch ? listsToWatch : [],
     endpoint,