Add the presence of the client file to diagnose

The diagnose report now checks on the presence of the `appsignal.cjs`
file we require customers to initialize the AppSignal client when
starting their apps.

.changesets/report-client-file-presence-in-diagnose-result.md

@@ -0,0 +1,6 @@
+---
+bump: "patch"
+type: "add"
+---
+
+The diagnose CLI command now reports on the presence of the `appsignal.cjs` file.

src/__tests__/config.test.ts

@@ -216,6 +216,42 @@ describe("Configuration", () => {
     })
   })
 
+  describe("clientFilePath", () => {
+    describe("when the client file exists in the root path", () => {
+      it("returns the path to the client file", () => {
+        jest.spyOn(fs, "existsSync").mockImplementation(givenPath => {
+          return givenPath === path.join(process.cwd(), "appsignal.cjs")
+        })
+        config = new Configuration({ name, pushApiKey })
+
+        expect(config.clientFilePath).toEqual(
+          path.join(process.cwd(), "appsignal.cjs")
+        )
+      })
+    })
+
+    describe("when the client file exists in the src path", () => {
+      it("returns the path to the client file", () => {
+        jest.spyOn(fs, "existsSync").mockImplementation(givenPath => {
+          return givenPath === path.join(process.cwd(), "src", "appsignal.cjs")
+        })
+        config = new Configuration({ name, pushApiKey })
+
+        expect(config.clientFilePath).toEqual(
+          path.join(process.cwd(), "src", "appsignal.cjs")
+        )
+      })
+    })
+
+    describe("when the client file does not exist", () => {
+      it("returns undefined", () => {
+        config = new Configuration({ name, pushApiKey })
+
+        expect(config.clientFilePath).toBeUndefined()
+      })
+    })
+  })
+
   describe("private environment variables", () => {
     beforeEach(() => {
       new Configuration({})

src/cli/diagnose.ts

@@ -181,6 +181,13 @@ export class Diagnose {
 
     this.print_newline()
 
+    console.log(`  AppSignal client file`)
+    console.log(
+      `    Path: ${format_value(data["paths"]["appsignal.cjs"]["path"])}`
+    )
+
+    this.print_newline()
+
     console.log(`  AppSignal log`)
     console.log(
       `    Path: ${format_value(data["paths"]["appsignal.log"]["path"])}`

src/config.ts

@@ -1,5 +1,6 @@
 import path from "path"
 import os from "os"
+import fs from "fs"
 
 import { VERSION } from "./version"
 import { isWritable } from "./utils"
@@ -74,6 +75,18 @@ export class Configuration {
     }
   }
 
+  public get clientFilePath(): string | undefined {
+    const filename = "appsignal.cjs"
+
+    if (fs.existsSync(path.join(process.cwd(), filename))) {
+      return path.join(process.cwd(), filename)
+    } else if (fs.existsSync(path.join(process.cwd(), "src", filename))) {
+      return path.join(process.cwd(), "src", filename)
+    } else {
+      return undefined
+    }
+  }
+
   /**
    * Returns default OS tmp dir. Uses OS package for Windows. Linux and macOS
    * have `/tmp` hardcoded as a default

src/diagnose.ts

@@ -147,7 +147,6 @@ export class DiagnoseTool {
 
   private getPathsData() {
     const paths: { [key: string]: FileMetadata } = {}
-
     const logFilePath = this.#config.logFilePath
 
     const pathsToCheck = {
@@ -157,6 +156,9 @@ export class DiagnoseTool {
       log_dir_path: {
         path: logFilePath ? path.dirname(logFilePath) : ""
       },
+      "appsignal.cjs": {
+        path: this.#config.clientFilePath || ""
+      },
       "appsignal.log": {
         path: logFilePath || "",
         content: logFilePath