chore: remove or improve some TODO comments

Author: ivanstanev

src/supervisor/watchers/handlers/argo-rollout.ts

@@ -51,7 +51,15 @@ export async function paginatedNamespacedArgoRolloutList(
         fieldSelector,
         labelSelector,
         limit,
-        // TODO: Why any?
+        /**
+         * The K8s client's listNamespacedCustomObject() doesn't allow to specify
+         * the type of the response body and returns the generic "object" type,
+         * but with how we declared our types we expect it to return a "KubernetesListObject" type.
+         *
+         * Not using "any" results in a similar error (highlighting the "body" property):
+         * Type 'Promise<{ response: IncomingMessage; ***body: object;*** }>' is not assignable to type
+         * 'Promise<{ response: IncomingMessage; ***body: KubernetesListObject<...>;*** }>'
+         */
       ) as any,
   );
 }

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

@@ -51,7 +51,15 @@ export async function paginatedNamespacedDeploymentConfigList(
         fieldSelector,
         labelSelector,
         limit,
-        // TODO: Why any?
+        /**
+         * The K8s client's listNamespacedCustomObject() doesn't allow to specify
+         * the type of the response body and returns the generic "object" type,
+         * but with how we declared our types we expect it to return a "KubernetesListObject" type.
+         *
+         * Not using "any" results in a similar error (highlighting the "body" property):
+         * Type 'Promise<{ response: IncomingMessage; ***body: object;*** }>' is not assignable to type
+         * 'Promise<{ response: IncomingMessage; ***body: KubernetesListObject<...>;*** }>'
+         */
       ) as any,
   );
 }

src/transmitter/index.ts

@@ -208,7 +208,6 @@ export async function deleteWorkload(
 
     const { response, attempt } = await reqQueue.pushAsync(request);
     if (response.statusCode === 404) {
-      // TODO: maybe we're still building it?
       logger.info(
         { payload },
         'attempted to delete a workload the Upstream service could not find',

test/setup/index.ts

@@ -70,7 +70,6 @@ export async function removeUnusedKindNetwork(): Promise<void> {
 }
 
 async function createEnvironment(): Promise<void> {
-  // TODO: we probably want to use k8s-api for that, not kubectl
   await kubectl.createNamespace('services');
   // Small hack to prevent timing problems in CircleCI...
   // TODO: should be replaced by actively waiting for the namespace to be created

test/setup/platforms/eks.ts

@@ -14,8 +14,6 @@ export async function validateRequiredEnvironment(): Promise<void> {
 }
 
 export async function setupTester(): Promise<void> {
-  // TODO: assert all the vars are present before starting the setup?
-  // TODO: wipe out the data during teardown?
   await exec(
     `aws configure set aws_access_key_id ${process.env['AWS_ACCESS_KEY_ID']}`,
   );