Merge pull request #240 from snyk/feat/add-tags-to-report-options

feat(report): add tags support to report options

Author: apzuk3

src/http.ts

@@ -539,6 +539,7 @@ export async function initReport(options: UploadReportOptions): Promise<Result<s
         targetName: options.report.targetName,
         targetRef: options.report.targetRef,
         remoteRepoUrl: options.report.remoteRepoUrl,
+        tags: options.report.tags,
       },
       key: {
         type: 'file',

src/interfaces/analysis-options.interface.ts

@@ -63,6 +63,7 @@ export interface ReportOptions {
   targetName?: string;
   targetRef?: string;
   remoteRepoUrl?: string;
+  tags?: Array<{ key: string; value: string }>;
 }
 
 export interface ScmReportOptions {

tests/http.spec.ts

@@ -251,6 +251,66 @@ describe('HTTP', () => {
 
       expect(spy).toHaveBeenCalledWith(jsonApiError, 422, 'initReport');
     });
+
+    it('should include tags in workflowData when provided', async () => {
+      const makeRequestSpy = jest
+        .spyOn(needle, 'makeRequest')
+        .mockResolvedValue({ success: true, body: { reportId: 'test-report-id' } });
+
+      const tags = [
+        { key: 'env', value: 'prod' },
+        { key: 'team', value: 'security' },
+      ];
+
+      const optionsWithTags = {
+        ...options,
+        report: {
+          enabled: true,
+          projectName: 'test-project',
+          tags,
+        },
+      };
+
+      await initReport(optionsWithTags);
+
+      expect(makeRequestSpy).toHaveBeenCalledWith(
+        expect.objectContaining({
+          body: expect.objectContaining({
+            workflowData: expect.objectContaining({
+              projectName: 'test-project',
+              tags,
+            }),
+          }),
+        }),
+      );
+    });
+
+    it('should include undefined tags in workflowData when not provided', async () => {
+      const makeRequestSpy = jest
+        .spyOn(needle, 'makeRequest')
+        .mockResolvedValue({ success: true, body: { reportId: 'test-report-id' } });
+
+      const optionsWithoutTags = {
+        ...options,
+        report: {
+          enabled: true,
+          projectName: 'test-project',
+        },
+      };
+
+      await initReport(optionsWithoutTags);
+
+      expect(makeRequestSpy).toHaveBeenCalledWith(
+        expect.objectContaining({
+          body: expect.objectContaining({
+            workflowData: expect.objectContaining({
+              projectName: 'test-project',
+              tags: undefined,
+            }),
+          }),
+        }),
+      );
+    });
   });
 
   describe('getReport', () => {

tests/report.spec.ts

@@ -54,6 +54,39 @@ describe('Functional test for report', () => {
       expect(result).toHaveProperty('analysisResult');
     });
 
+    it('should pass tags through to initReport when provided', async () => {
+      const tags = [
+        { key: 'env', value: 'production' },
+        { key: 'team', value: 'platform' },
+      ];
+
+      const reportConfig = {
+        enabled: true,
+        projectName: 'test-project',
+        targetName: 'test-target',
+        targetRef: 'test-ref',
+        remoteRepoUrl: 'https://github.com/owner/repo',
+        tags,
+      };
+
+      const result = await reportBundle({
+        bundleHash: 'dummy-bundle',
+        ...baseConfig,
+        report: reportConfig,
+      });
+
+      expect(mockInitReport).toHaveBeenCalledWith(
+        expect.objectContaining({
+          report: expect.objectContaining({
+            tags,
+          }),
+        }),
+      );
+
+      expect(result).not.toBeNull();
+      expect(result.status).toBe('COMPLETE');
+    });
+
     it('should fail report if no project name was given', async () => {
       const reportConfig = {
         enabled: true,