[world-vercel] Use custom user-agent for API requests (#297)

Author: VaguelySerious

.changeset/happy-bees-greet.md

@@ -0,0 +1,5 @@
+---
+"@workflow/world-vercel": patch
+---
+
+Add custom user agent

packages/world-vercel/.gitignore

@@ -0,0 +1,3 @@
+# Auto-generated version file
+src/version.ts
+

packages/world-vercel/package.json

@@ -23,21 +23,22 @@
     }
   },
   "scripts": {
-    "build": "tsc",
-    "dev": "tsc --watch",
-    "clean": "tsc --build --clean && rm -rf dist",
+    "build": "genversion --es6 src/version.ts && tsc",
+    "dev": "genversion --es6 src/version.ts && tsc --watch",
+    "clean": "tsc --build --clean && rm -rf dist src/version.ts",
     "test": "echo 'No tests yet'",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "genversion --es6 src/version.ts && tsc --noEmit"
   },
   "dependencies": {
     "@vercel/oidc": "catalog:",
     "@vercel/queue": "0.0.0-alpha.28",
-    "@workflow/world": "workspace:*",
     "@workflow/errors": "workspace:*",
+    "@workflow/world": "workspace:*",
     "zod": "catalog:"
   },
   "devDependencies": {
     "@types/node": "catalog:",
-    "@workflow/tsconfig": "workspace:*"
+    "@workflow/tsconfig": "workspace:*",
+    "genversion": "^3.2.0"
   }
 }

packages/world-vercel/src/utils.ts

@@ -1,6 +1,8 @@
+import os from 'node:os';
 import { getVercelOidcToken } from '@vercel/oidc';
 import { WorkflowAPIError } from '@workflow/errors';
 import { ZodError, type z } from 'zod';
+import { version } from './version.js';
 
 export interface APIConfig {
   baseUrl?: string;
@@ -22,6 +24,10 @@ export function dateToStringReplacer(_key: string, value: unknown): unknown {
   return value;
 }
 
+const getUserAgent = () => {
+  return `@workflow/world-vercel/${version} node-${process.version} ${os.platform()} (${os.arch()})`;
+};
+
 export interface HttpConfig {
   baseUrl: string;
   headers: Headers;
@@ -45,6 +51,7 @@ export const getHttpUrl = (
 export const getHeaders = (config?: APIConfig): Headers => {
   const projectConfig = config?.projectConfig;
   const headers = new Headers(config?.headers);
+  headers.set('User-Agent', getUserAgent());
   if (projectConfig) {
     headers.set(
       'x-vercel-environment',

packages/world-vercel/turbo.json

@@ -0,0 +1,9 @@
+{
+  "extends": ["//"],
+  "tasks": {
+    "build": {
+      "dependsOn": ["^build"],
+      "outputs": ["dist", "src/version.ts"]
+    }
+  }
+}