Add BasePayload type and derive AssessmentPayload from it

src/analyses.ts

@@ -4,7 +4,11 @@ import {
   getRequiredInput,
 } from "./actions-util";
 import { Logger } from "./logging";
-import { AssessmentPayload, UploadPayload } from "./upload-lib/types";
+import {
+  AssessmentPayload,
+  BasePayload,
+  UploadPayload,
+} from "./upload-lib/types";
 import { ConfigurationError, getRequiredEnvParam } from "./util";
 
 export enum AnalysisKind {
@@ -148,7 +152,7 @@ export interface AnalysisConfig {
   /** A prefix for environment variables used to track the uniqueness of SARIF uploads. */
   sentinelPrefix: string;
   /** Transforms the upload payload in an analysis-specific way. */
-  transformPayload: (payload: UploadPayload) => UploadPayload;
+  transformPayload: (payload: UploadPayload) => BasePayload;
 }
 
 // Represents the Code Scanning analysis configuration.
@@ -187,7 +191,7 @@ function addAssessmentId(payload: UploadPayload): AssessmentPayload {
     getRequiredEnvParam("CODEQL_ACTION_CSRA_ASSESSMENT_ID"),
     10,
   );
-  return { ...payload, assessment_id: assessmentId };
+  return { sarif: payload.sarif, assessment_id: assessmentId };
 }
 
 export const CSRA: AnalysisConfig = {

src/upload-lib.ts

@@ -21,7 +21,7 @@ import * as gitUtils from "./git-utils";
 import { initCodeQL } from "./init";
 import { Logger } from "./logging";
 import { getRepositoryNwo, RepositoryNwo } from "./repository";
-import { UploadPayload } from "./upload-lib/types";
+import { BasePayload, UploadPayload } from "./upload-lib/types";
 import * as util from "./util";
 import {
   ConfigurationError,
@@ -327,7 +327,7 @@ function getAutomationID(
  * This is exported for testing purposes only.
  */
 export async function uploadPayload(
-  payload: UploadPayload,
+  payload: BasePayload,
   repositoryNwo: RepositoryNwo,
   logger: Logger,
   analysis: analyses.AnalysisConfig,

src/upload-lib/types.ts

@@ -1,9 +1,12 @@
-export interface UploadPayload {
+export interface BasePayload {
+  sarif: string;
+}
+
+export interface UploadPayload extends BasePayload {
   commit_oid: string;
   ref: string;
   analysis_key?: string;
   analysis_name?: string;
-  sarif: string;
   workflow_run_id: number;
   workflow_run_attempt: number;
   checkout_uri: string;
@@ -14,6 +17,6 @@ export interface UploadPayload {
   base_sha?: string;
 }
 
-export interface AssessmentPayload extends UploadPayload {
+export interface AssessmentPayload extends BasePayload {
   assessment_id: number;
 }