fix: avoid sending empty runtime images payloads

Author: jonnyowenpowell

src/data-scraper/index.ts

@@ -101,8 +101,10 @@ export async function scrapeData(): Promise<void> {
         2,
       );
 
-      logger.info({}, 'sending runtime data upstream');
-      await sendRuntimeData(runtimeDataPayload);
+      if (runtimeDataPayload) {
+        logger.info({}, 'sending runtime data upstream');
+        await sendRuntimeData(runtimeDataPayload);
+      }
 
       cursor = responseBody?.page.next || '';
       if (!cursor) {

src/data-scraper/scraping-v1.ts

@@ -91,8 +91,10 @@ export async function scrapeDataV1(): Promise<void> {
         1,
       );
 
-      logger.info({}, 'sending runtime data upstream');
-      await sendRuntimeData(runtimeDataPayload);
+      if (runtimeDataPayload) {
+        logger.info({}, 'sending runtime data upstream');
+        await sendRuntimeData(runtimeDataPayload);
+      }
 
       cursor = responseBody?.page.next || '';
       if (!cursor) {

src/transmitter/payload.ts

@@ -152,10 +152,11 @@ const workloadKindMap = {
   pod: 'Pod',
   rollout: 'Rollout',
 };
+
 export function constructRuntimeData(
   runtimeResults: IRuntimeImage[],
   sysdigVersion: number,
-): IRuntimeDataPayload {
+): IRuntimeDataPayload | undefined {
   const filteredRuntimeResults = runtimeResults.reduce((acc, runtimeResult) => {
     if (!isExcludedNamespace(runtimeResult.namespace)) {
       const mappedWorkloadKind =
@@ -178,6 +179,10 @@ export function constructRuntimeData(
     return acc;
   }, [] as IRuntimeImage[]);
 
+  if (filteredRuntimeResults.length === 0) {
+    return;
+  }
+
   const dataFact: IRuntimeDataFact = {
     type: 'loadedPackages',
     data: filteredRuntimeResults,

test/unit/data-scraper/scrape-data.spec.ts

@@ -132,6 +132,78 @@ describe('dataScraper()', () => {
         throw err;
       }
     });
+
+    it('correctly skips pages of data without relevant runtime images', async () => {
+      const runtimeImageTemplate = {
+        imageID: 'something',
+        namespace: 'sysdig',
+        workloadName: 'workload',
+        workloadKind: 'Deployment',
+        container: 'box',
+        packages: [],
+      };
+      const page1 = {
+        data: Array(10).fill({
+          ...runtimeImageTemplate,
+          namespace: 'kube-system',
+        }),
+        page: {
+          returned: 10,
+          next: 'xxx',
+        },
+      };
+      const page2 = {
+        data: [runtimeImageTemplate],
+        page: {
+          returned: 1,
+        },
+      };
+      nock('https://sysdig')
+        .get(
+          '/api/scanning/eveintegration/v2/runtimeimages?clusterName=test-sysdig-cluster&limit=10',
+        )
+        .times(1)
+        .reply(200, page1)
+        .get(
+          '/api/scanning/eveintegration/v2/runtimeimages?clusterName=test-sysdig-cluster&limit=10&cursor=xxx',
+        )
+        .times(1)
+        .reply(200, page2);
+
+      nock('https://api.snyk.io')
+        .post(
+          '/v2/kubernetes-upstream/api/v1/runtime-results?version=2023-02-10',
+        )
+        .times(1)
+        .reply(200, (_, requestBody: transmitterTypes.IRuntimeDataPayload) => {
+          expect(requestBody).toEqual<transmitterTypes.IRuntimeDataPayload>({
+            identity: {
+              type: 'sysdig',
+              sysdigVersion: 2,
+            },
+            target: {
+              userLocator: expect.any(String),
+              cluster: expect.any(String),
+              agentId: expect.any(String),
+            },
+            facts: [
+              {
+                type: 'loadedPackages',
+                data: page2.data,
+              },
+            ],
+          });
+        });
+
+      await scrapeData();
+
+      try {
+        expect(nock.isDone()).toBeTruthy();
+      } catch (err) {
+        console.error(`nock pending mocks: ${nock.pendingMocks()}`);
+        throw err;
+      }
+    });
   });
   describe('when sysdig v1 and v2 env vars configured, should use v2', () => {
     beforeAll(() => {