move pkg version to index and include in program version

saucelabs · Feb 28, 2025 · 9f03d05 · 9f03d05
1 parent 17a3f4e
commit 9f03d05
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 10 deletions.
diff --git a/visual-js/visual-snapshots/src/api/visual-client.ts b/visual-js/visual-snapshots/src/api/visual-client.ts
@@ -1,8 +1,9 @@
 import { getApi, VisualConfig } from "@saucelabs/visual";
 
-const clientVersion = "PKG_VERSION";
-
-export const initializeVisualApi = (params: VisualConfig) =>
+export const initializeVisualApi = (
+  params: VisualConfig,
+  clientVersion: string
+) =>
   getApi(params, {
     userAgent: `visual-snapshots/${clientVersion}`,
   });
diff --git a/visual-js/visual-snapshots/src/app/pdf-handler.ts b/visual-js/visual-snapshots/src/app/pdf-handler.ts
@@ -11,8 +11,14 @@ export interface PdfCommandParams
     CreateVisualSnapshotsParams {}
 
 export class PdfCommandHandler {
+  private clientVersion: string;
+
+  constructor(clientVersion: string) {
+    this.clientVersion = clientVersion;
+  }
+
   public async handle(pdfFilePath: string, params: PdfCommandParams) {
-    const visualApi = initializeVisualApi(params);
+    const visualApi = initializeVisualApi(params, this.clientVersion);
     const visualSnapshots = new VisualSnapshotsApi(visualApi);
     const pdfConverter = new PdfConverter();
 

diff --git a/visual-js/visual-snapshots/src/commands/pdf.ts b/visual-js/visual-snapshots/src/commands/pdf.ts
@@ -12,7 +12,7 @@ import {
 } from "./options.js";
 import { PdfCommandHandler, PdfCommandParams } from "../app/pdf-handler.js";
 
-export const pdfCommand = () => {
+export const pdfCommand = (clientVersion: string) => {
   return new Command()
     .name("pdf")
     .description("Create visual snapshots for each page of a PDF file")
@@ -27,7 +27,7 @@ export const pdfCommand = () => {
     .addOption(buildIdOption)
     .addOption(customIdOption)
     .action((pdfFilePath: string, params: PdfCommandParams) => {
-      new PdfCommandHandler()
+      new PdfCommandHandler(clientVersion)
         .handle(pdfFilePath, params)
         .then(() => {
           console.log("Successfully created PDF snapshots");

diff --git a/visual-js/visual-snapshots/src/index.ts b/visual-js/visual-snapshots/src/index.ts
@@ -3,13 +3,15 @@
 import { Command } from "commander";
 import { pdfCommand } from "./commands/pdf.js";
 
+const clientVersion = "PKG_VERSION";
+
 const program = new Command();
 
 program
   .name("visual-snapshots")
   .description("Create visual snapshots of a document.")
-  .version("0.1.0");
+  .version(clientVersion);
 
-program.addCommand(pdfCommand());
+program.addCommand(pdfCommand(clientVersion));
 
 program.parse();
diff --git a/visual-js/visual-snapshots/test/api/visual-client.spec.ts b/visual-js/visual-snapshots/test/api/visual-client.spec.ts
@@ -11,15 +11,16 @@ describe("visual api client", () => {
   test("initializeVisualApi", async () => {
     const getApiSpy = sauceVisual.getApi;
 
+    const pkgVersion = "0.1.0";
     const params = {
       user: "fake-username",
       key: "fake-access-key",
       region: "us-west-1",
     } as sauceVisual.VisualConfig;
-    initializeVisualApi(params);
+    initializeVisualApi(params, pkgVersion);
 
     expect(getApiSpy).toHaveBeenCalledWith(params, {
-      userAgent: "visual-snapshots/PKG_VERSION",
+      userAgent: `visual-snapshots/${pkgVersion}`,
     });
   });
 });