EVG-20677 & EVG-20868: Make type.ts validation more robust

scripts/check-schema-and-codegen/index.test.ts

@@ -1,10 +1,6 @@
 import fs from "fs";
 import { checkSchemaAndCodegenCore } from ".";
-import {
-  canResolveDNS,
-  checkIsAncestor,
-  getLatestCommitFromRemote,
-} from "./utils";
+import { checkIsAncestor, getLatestCommitFromRemote } from "./utils";
 
 jest.mock("fs", () => ({
   readFileSync: jest.fn().mockReturnValue(Buffer.from("file-contents")),
@@ -20,23 +16,22 @@ jest.mock("./utils.ts", () => ({
 }));
 
 describe("checkSchemaAndCodegen", () => {
-  let consoleInfoSpy;
   let consoleErrorSpy;
   beforeEach(() => {
-    consoleInfoSpy = jest.spyOn(console, "info").mockImplementation(() => {});
     consoleErrorSpy = jest.spyOn(console, "error").mockImplementation(() => {});
-    (canResolveDNS as jest.Mock).mockResolvedValue(true);
     (checkIsAncestor as jest.Mock).mockResolvedValue(true);
     (getLatestCommitFromRemote as jest.Mock).mockResolvedValue(
       "{getLatestCommitFromRemote()}"
     );
   });
 
   it("returns 0 when offline", async () => {
-    (canResolveDNS as jest.Mock).mockResolvedValue(false);
+    (getLatestCommitFromRemote as jest.Mock).mockRejectedValueOnce(
+      new Error("TypeError: fetch failed")
+    );
     await expect(checkSchemaAndCodegenCore()).resolves.toBe(0);
-    expect(consoleInfoSpy).toHaveBeenCalledWith(
-      "Skipping GQL codegen validation because I can't connect to github.com."
+    expect(consoleErrorSpy).toHaveBeenCalledWith(
+      "An error occured during GQL types validation: Error: TypeError: fetch failed"
     );
   });
 
@@ -72,12 +67,4 @@ describe("checkSchemaAndCodegen", () => {
       "GQL types validation failed: Your GQL types file ({path.resolve()}) is outdated. Run 'yarn codegen'."
     );
   });
-
-  it("handle error and exit with 0", async () => {
-    (canResolveDNS as jest.Mock).mockRejectedValue(new Error("Test Error"));
-    await expect(checkSchemaAndCodegenCore()).resolves.toBe(0);
-    expect(consoleErrorSpy).toHaveBeenCalledWith(
-      "An error occured during GQL types validation: Error: Test Error"
-    );
-  });
 });

scripts/check-schema-and-codegen/index.ts

@@ -2,7 +2,6 @@ import fs from "fs";
 import process from "process";
 import { generatedFileName as existingTypesFileName } from "../../codegen";
 import {
-  canResolveDNS,
   checkIsAncestor,
   generateTypes,
   getLatestCommitFromRemote,
@@ -16,14 +15,6 @@ const failCopy = "GQL types validation failed:";
  */
 export const checkSchemaAndCodegenCore = async (): Promise<number> => {
   try {
-    // First check to see if all remote GQL commits exist locally.
-    const hasInternetAccess = await canResolveDNS("github.com");
-    if (!hasInternetAccess) {
-      console.info(
-        "Skipping GQL codegen validation because I can't connect to github.com."
-      );
-      return 0;
-    }
     const commit = await getLatestCommitFromRemote();
     const hasLatestCommit = await checkIsAncestor(commit);
     if (!hasLatestCommit) {

scripts/check-schema-and-codegen/utils.ts

@@ -11,29 +11,12 @@ const GQL_DIR = "graphql/schema";
 const LOCAL_SCHEMA = "sdlschema";
 const REPO = "/repos/evergreen-ci/evergreen";
 
-/**
- * Checks if a given domain can be resolved.
- * @async
- * @param domain - The domain name to check.
- * @returns - Resolves to `true` if the domain can be resolved, `false` otherwise.
- */
-export const canResolveDNS = (domain: string) =>
-  new Promise((resolve) => {
-    dns.lookup(domain, (err) => {
-      if (err) {
-        resolve(false);
-      } else {
-        resolve(true);
-      }
-    });
-  });
-
 /**
  * Get the latest commit that was made to the GQL folder of the remote Evergreen repository.
  * @returns A Promise that resolves to the SHA of the latest commit.
  * @throws {Error} When failed to fetch commits.
  */
-export async function getLatestCommitFromRemote(): Promise<string> {
+export const getLatestCommitFromRemote = async (): Promise<string> => {
   const url = `${GITHUB_API}${REPO}/commits?path=${GQL_DIR}&sha=main`;
   const response = await fetch(url);
   if (!response.ok) {
@@ -46,7 +29,7 @@ export async function getLatestCommitFromRemote(): Promise<string> {
     return commits[0].sha;
   }
   throw new Error(`No commits found for this path: ${url}`);
-}
+};
 
 /**
  * Check if the local Evergreen repo contains a given commit.
@@ -64,6 +47,7 @@ export const checkIsAncestor = async (commit: string): Promise<boolean> => {
     return true;
   } catch (error) {
     process.chdir(originalDir);
+    // Error status 1 and 128 means that the commit is not an anecestor and the user must fetch.
     if (error.status === 1 || error.status === 128) {
       return false;
     }