fix: go-mod-validator changed files bug (#1312)

* fix: diff endpoint for go-mod-validator

* docs: update README, delete outdated example workflow

* chore: update test payload

* add changesetf

Author: erikburt

.changeset/silent-hornets-change.md

@@ -0,0 +1,5 @@
+---
+"go-mod-validator": minor
+---
+
+fix: changed files endpoint bug

apps/go-mod-validator/README.md

@@ -23,19 +23,32 @@ Requirements:
    upstream repositories.
 2. Exits 1, if a _dependency is not on the default branch_
 
-## Example usage
+## Usage
+
+### Org-wide Workflow
+
+To integrate this into your repository, it is best to use the org-wide workflow.
+Ask in `#team-releng` to have it enabled for you. If your repository has private
+dependencies, then you will have to configurate the workflow yourself.
+
+Here is the org-wide workflow:
+https://github.com/smartcontractkit/gha-org-workflows/blob/main/.github/workflows/go-mod-validation.yml
+
+### Workflow Excerpt
 
 ```yaml
 steps:
   - name: Check out the repository
-    uses: actions/checkout
+    uses: actions/checkout@<version>
+
   - name: Setup go
-    uses: actions/setup-go
+    uses: actions/setup-go@<version>
+
   - name: Validate go.mod
-    uses: smartcontractkit/.github/apps/go-mod-validator@<commit> # go-mod-validator@x.y.z
+    uses: smartcontractkit/.github/apps/go-mod-validator@go-mod-validator/<version>
 ```
 
-## Running locally
+### Running locally
 
 1. Update `scripts/test.sh` and `scripts/payload.json`
 2. Make sure to check out your local repo to the proper commit as per

apps/go-mod-validator/dist/index.js

@@ -24,8 +24,8 @@
     "typescript": "^5.4.5"
   },
   "dependencies": {
-    "@actions/core": "^1.10.1",
-    "@actions/github": "^6.0.0",
+    "@actions/core": "^1.11.1",
+    "@actions/github": "^6.0.1",
     "@actions/glob": "^0.4.0",
     "@octokit/plugin-throttling": "^11.0.1",
     "@octokit/types": "^13.5.0",

apps/go-mod-validator/package.json

@@ -1,5 +1,5 @@
 {
-  "pull_request": {
+  "//pull_request": {
     "base": { "sha": "1f5fbda7ae76d5494b9864db90a8bfe7183db5fb" },
     "head": { "sha": "04c256fe307ced678afbebb5cf87abab747ccb8b" },
     "number": 773

apps/go-mod-validator/scripts/payload.json

@@ -9,16 +9,16 @@ pnpm nx build go-mod-validator
 
 export GITHUB_TOKEN=$(gh auth token)
 export GITHUB_ACTOR=$(gh api user --jq .login)
-export GITHUB_REPOSITORY="smartcontractkit/chainlink-common"
-export GITHUB_EVENT_NAME="pull_request"
+export GITHUB_REPOSITORY="smartcontractkit/billing-platform-service"
+export GITHUB_EVENT_NAME="push"
 export GITHUB_EVENT_PATH="apps/go-mod-validator/scripts/payload.json"
 
 
 tmp_file=$(mktemp)
 export GITHUB_STEP_SUMMARY="$tmp_file"
 
 export INPUT_GITHUB_TOKEN="$GITHUB_TOKEN"
-export INPUT_GO_MOD_DIR="${INPUT_GO_MOD_DIR:-$(abspath "${REPO_ROOT}/../chainlink-common")}"
+export INPUT_GO_MOD_DIR="${INPUT_GO_MOD_DIR:-$(abspath "${REPO_ROOT}/../billing-platform-service")}"
 export INPUT_DEP_PREFIX="github.com/smartcontractkit"
 export CL_LOCAL_DEBUG="true"
 

apps/go-mod-validator/scripts/test.sh

@@ -8,13 +8,12 @@ export type GithubFiles = CompareResponse["data"]["files"];
 
 export async function getChangedGoModFiles(
   gh: Octokit,
-  base: string,
-  head: string,
+  prNumber: number,
   owner: string,
   repo: string,
   depPrefix: string,
 ): Promise<ParsedFile[]> {
-  const files = await getComparison(gh, owner, repo, base, head);
+  const files = await getChangedFilesForPR(gh, owner, repo, prNumber);
   const relevantFiles = filterForRelevantChanges(files);
   return parseAllAdditions(relevantFiles, depPrefix);
 }
@@ -23,23 +22,22 @@ function filterForRelevantChanges(files: GithubFiles): GithubFiles {
   return files?.filter(({ filename }) => filename.endsWith("go.mod"));
 }
 
-async function getComparison(
+export async function getChangedFilesForPR(
   octokit: Octokit,
   owner: string,
   repo: string,
-  base: string,
-  head: string,
+  prNumber: number,
 ): Promise<GithubFiles> {
-  core.debug(`Comparing ${owner}/${repo} commits ${base}...${head}`);
+  core.debug(`Comparing ${owner}/${repo} for PR ${prNumber}`);
 
-  const diff = await octokit.rest.repos.compareCommitsWithBasehead({
+  const prFiles = await octokit.paginate(octokit.rest.pulls.listFiles, {
     owner,
     repo,
-    basehead: `${base}...${head}`,
-    // <before>...<after> or <earlier>...<later>
+    pull_number: prNumber,
+    per_page: 100,
   });
 
-  return diff.data.files;
+  return prFiles;
 }
 
 // Taken from https://github.com/smartcontractkit/.github/blob/dc8b1a0b478151119d86ac1bf121ea7eb3c1c88c/actions/gha-workflow-validator/src/utils.ts#L59C1-L97C2

apps/go-mod-validator/src/diff.ts

@@ -64,39 +64,40 @@ function getContext() {
 export async function run(): Promise<string> {
   const { goModDir, octokit, depPrefix, isPullRequest } = getContext();
 
+  core.debug(`Go module directory: ${goModDir}`);
+  core.debug(`Dependency prefix filter: ${depPrefix || "none"}`);
+  core.debug(`Pull request mode: ${isPullRequest}`);
+
   let depsToValidate = await getDeps(goModDir, depPrefix);
   if (isPullRequest) {
     core.info(
       "Running in pull request mode, filtering dependencies to validate based on changed files and only checking for pseudo-versions.",
     );
     const pr = github.context.payload.pull_request;
-    if (!pr) {
+    if (!pr || !pr.number) {
       throw new Error("Expected pull request context to be present");
     }
-    const base: string = pr.base.sha;
-    const head: string = pr.head.sha;
-    const { owner, repo } = github.context.repo;
 
+    const { owner, repo } = github.context.repo;
     const changedFiles = await getChangedGoModFiles(
       octokit,
-      base,
-      head,
+      pr.number,
       owner,
       repo,
       depPrefix,
     );
 
     core.debug(
-      `Changed files: ${JSON.stringify(changedFiles.map((f) => f.filename))}`,
+      `Filtered changed files: ${JSON.stringify(changedFiles.map((f) => f.filename))}`,
     );
     core.debug(
       `Deps to validate: ${JSON.stringify(depsToValidate.map((d) => d.path))}`,
     );
     depsToValidate = depsToValidate.filter((d) => {
       return changedFiles.some(
-        (f) =>
-          d.goModFilePath.includes(f.filename) &&
-          f.addedLines.some((l) => l.content.includes(d.path)),
+        (changedFile) =>
+          d.goModFilePath.includes(changedFile.filename) &&
+          changedFile.addedLines.some((l) => l.content.includes(d.path)),
       );
     });