fix: refactor informer handlers code to improve readability

Several big changes:
- code branches less now and the cluster monitoring is separate from namespace monitoring
- we ensure we track namespaces in the cluster so we have the annotations for namespace annotated import
- informer configuration is in a separate file, because the object holding the config is now too big
- move any workload-related functions to their respective handler file

Author: ivanstanev

src/state.ts

@@ -2,6 +2,7 @@ import { KubernetesObject, V1Namespace } from '@kubernetes/client-node';
 import LruCache from 'lru-cache';
 
 import { config } from './common/config';
+import { extractNamespaceName } from './supervisor/watchers';
 
 const imagesLruCacheOptions: LruCache.Options<string, string> = {
   // limit cache size so we don't exceed memory limit
@@ -113,6 +114,16 @@ export function kubernetesObjectToWorkloadAlreadyScanned(
   return undefined;
 }
 
+export function storeNamespace(namespace: V1Namespace): void {
+  const namespaceName = extractNamespaceName(namespace);
+  state.watchedNamespaces[namespaceName] = namespace;
+}
+
+export function deleteNamespace(namespace: V1Namespace): void {
+  const namespaceName = extractNamespaceName(namespace);
+  delete state.watchedNamespaces[namespaceName];
+}
+
 export const state = {
   shutdownInProgress: false,
   imagesAlreadyScanned: new LruCache<string, string>(imagesLruCacheOptions),

src/supervisor/watchers/handlers/cron-job.ts

@@ -3,6 +3,8 @@ import {
   V1CronJobList,
   V1beta1CronJob,
   V1beta1CronJobList,
+  BatchV1Api,
+  BatchV1beta1Api,
 } from '@kubernetes/client-node';
 import { deleteWorkload, trimWorkload } from './workload';
 import { WorkloadKind } from '../../types';
@@ -15,6 +17,8 @@ import {
   deleteWorkloadImagesAlreadyScanned,
   kubernetesObjectToWorkloadAlreadyScanned,
 } from '../../../state';
+import { logger } from '../../../common/logger';
+import { retryKubernetesApiRequest } from '../../kuberenetes-api-wrappers';
 
 export async function paginatedNamespacedCronJobList(
   namespace: string,
@@ -128,3 +132,91 @@ export async function cronJobWatchHandler(
     workloadName,
   );
 }
+
+export async function isNamespacedCronJobSupported(
+  workloadKind: WorkloadKind,
+  namespace: string,
+  client: BatchV1Api | BatchV1beta1Api,
+): Promise<boolean> {
+  try {
+    const pretty = undefined;
+    const allowWatchBookmarks = undefined;
+    const continueToken = undefined;
+    const fieldSelector = undefined;
+    const labelSelector = undefined;
+    const limit = 1; // Try to grab only a single object
+    const resourceVersion = undefined; // List anything in the cluster
+    const resourceVersionMatch = undefined;
+    const timeoutSeconds = 10; // Don't block the snyk-monitor indefinitely
+    const attemptedApiCall = await retryKubernetesApiRequest(() =>
+      client.listNamespacedCronJob(
+        namespace,
+        pretty,
+        allowWatchBookmarks,
+        continueToken,
+        fieldSelector,
+        labelSelector,
+        limit,
+        resourceVersion,
+        resourceVersionMatch,
+        timeoutSeconds,
+      ),
+    );
+    return (
+      attemptedApiCall !== undefined &&
+      attemptedApiCall.response !== undefined &&
+      attemptedApiCall.response.statusCode !== undefined &&
+      attemptedApiCall.response.statusCode >= 200 &&
+      attemptedApiCall.response.statusCode < 300
+    );
+  } catch (error) {
+    logger.debug(
+      { error, workloadKind: workloadKind },
+      'Failed on Kubernetes API call to list CronJob or v1beta1 CronJob',
+    );
+    return false;
+  }
+}
+
+export async function isClusterCronJobSupported(
+  workloadKind: WorkloadKind,
+  client: BatchV1Api | BatchV1beta1Api,
+): Promise<boolean> {
+  try {
+    const pretty = undefined;
+    const allowWatchBookmarks = undefined;
+    const continueToken = undefined;
+    const fieldSelector = undefined;
+    const labelSelector = undefined;
+    const limit = 1; // Try to grab only a single object
+    const resourceVersion = undefined; // List anything in the cluster
+    const resourceVersionMatch = undefined;
+    const timeoutSeconds = 10; // Don't block the snyk-monitor indefinitely
+    const attemptedApiCall = await retryKubernetesApiRequest(() =>
+      client.listCronJobForAllNamespaces(
+        allowWatchBookmarks,
+        continueToken,
+        fieldSelector,
+        labelSelector,
+        limit,
+        pretty,
+        resourceVersion,
+        resourceVersionMatch,
+        timeoutSeconds,
+      ),
+    );
+    return (
+      attemptedApiCall !== undefined &&
+      attemptedApiCall.response !== undefined &&
+      attemptedApiCall.response.statusCode !== undefined &&
+      attemptedApiCall.response.statusCode >= 200 &&
+      attemptedApiCall.response.statusCode < 300
+    );
+  } catch (error) {
+    logger.debug(
+      { error, workloadKind: workloadKind },
+      'Failed on Kubernetes API call to list CronJob or v1beta1 CronJob',
+    );
+    return false;
+  }
+}

src/supervisor/watchers/handlers/deployment-config.ts

@@ -13,6 +13,8 @@ import {
   deleteWorkloadImagesAlreadyScanned,
   kubernetesObjectToWorkloadAlreadyScanned,
 } from '../../../state';
+import { retryKubernetesApiRequest } from '../../kuberenetes-api-wrappers';
+import { logger } from '../../../common/logger';
 
 export async function paginatedNamespacedDeploymentConfigList(
   namespace: string,
@@ -47,6 +49,7 @@ export async function paginatedNamespacedDeploymentConfigList(
         fieldSelector,
         labelSelector,
         limit,
+        // TODO: Why any?
       ) as any,
   );
 }
@@ -127,3 +130,84 @@ export async function deploymentConfigWatchHandler(
     workloadName,
   );
 }
+
+export async function isNamespacedDeploymentConfigSupported(
+  namespace: string,
+): Promise<boolean> {
+  try {
+    const pretty = undefined;
+    const continueToken = undefined;
+    const fieldSelector = undefined;
+    const labelSelector = undefined;
+    const limit = 1; // Try to grab only a single object
+    const resourceVersion = undefined; // List anything in the cluster
+    const timeoutSeconds = 10; // Don't block the snyk-monitor indefinitely
+    const attemptedApiCall = await retryKubernetesApiRequest(() =>
+      k8sApi.customObjectsClient.listNamespacedCustomObject(
+        'apps.openshift.io',
+        'v1',
+        namespace,
+        'deploymentconfigs',
+        pretty,
+        continueToken,
+        fieldSelector,
+        labelSelector,
+        limit,
+        resourceVersion,
+        timeoutSeconds,
+      ),
+    );
+    return (
+      attemptedApiCall !== undefined &&
+      attemptedApiCall.response !== undefined &&
+      attemptedApiCall.response.statusCode !== undefined &&
+      attemptedApiCall.response.statusCode >= 200 &&
+      attemptedApiCall.response.statusCode < 300
+    );
+  } catch (error) {
+    logger.debug(
+      { error, workloadKind: WorkloadKind.DeploymentConfig },
+      'Failed on Kubernetes API call to list namespaced DeploymentConfig',
+    );
+    return false;
+  }
+}
+
+export async function isClusterDeploymentConfigSupported(): Promise<boolean> {
+  try {
+    const pretty = undefined;
+    const continueToken = undefined;
+    const fieldSelector = undefined;
+    const labelSelector = undefined;
+    const limit = 1; // Try to grab only a single object
+    const resourceVersion = undefined; // List anything in the cluster
+    const timeoutSeconds = 10; // Don't block the snyk-monitor indefinitely
+    const attemptedApiCall = await retryKubernetesApiRequest(() =>
+      k8sApi.customObjectsClient.listClusterCustomObject(
+        'apps.openshift.io',
+        'v1',
+        'deploymentconfigs',
+        pretty,
+        continueToken,
+        fieldSelector,
+        labelSelector,
+        limit,
+        resourceVersion,
+        timeoutSeconds,
+      ),
+    );
+    return (
+      attemptedApiCall !== undefined &&
+      attemptedApiCall.response !== undefined &&
+      attemptedApiCall.response.statusCode !== undefined &&
+      attemptedApiCall.response.statusCode >= 200 &&
+      attemptedApiCall.response.statusCode < 300
+    );
+  } catch (error) {
+    logger.debug(
+      { error, workloadKind: WorkloadKind.DeploymentConfig },
+      'Failed on Kubernetes API call to list cluster DeploymentConfig',
+    );
+    return false;
+  }
+}