Merge pull request #10 from rust-lang/set-user-agent

set user agent

Author: marcoieni

dist/main.js

@@ -27313,6 +27313,18 @@ async function throwHttpErrorMessage(operation, response) {
 function getTokensEndpoint(registryUrl) {
     return `${registryUrl}/api/v1/trusted_publishing/tokens`;
 }
+function userAgentValue() {
+    const version = "v1";
+    // TODO: read the package name and version from package.json
+    return `crates-io-auth-action/${version}`;
+}
+function getUserAgent() {
+    const userAgent = userAgentValue();
+    return {
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        "User-Agent": userAgent,
+    };
+}
 function runAction(fn) {
     fn().catch((error) => {
         const errorMessage = error instanceof Error ? error.message : String(error);
@@ -27353,12 +27365,14 @@ async function getJwtToken(audience) {
 }
 async function requestTrustedPublishingToken(registryUrl, jwtToken) {
     const tokenUrl = getTokensEndpoint(registryUrl);
-    coreExports.info(`Requesting token from: ${tokenUrl}`);
+    const userAgent = getUserAgent();
+    coreExports.info(`Requesting token from: ${tokenUrl}. User agent: ${userAgent["User-Agent"]}`);
     const response = await fetch(tokenUrl, {
         method: "POST",
         headers: {
             /* eslint-disable  @typescript-eslint/naming-convention */
             "Content-Type": "application/json",
+            ...userAgent,
         },
         body: JSON.stringify({ jwt: jwtToken }),
     });

dist/post.js

@@ -27296,6 +27296,18 @@ async function throwHttpErrorMessage(operation, response) {
 function getTokensEndpoint(registryUrl) {
     return `${registryUrl}/api/v1/trusted_publishing/tokens`;
 }
+function userAgentValue() {
+    const version = "v1";
+    // TODO: read the package name and version from package.json
+    return `crates-io-auth-action/${version}`;
+}
+function getUserAgent() {
+    const userAgent = userAgentValue();
+    return {
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        "User-Agent": userAgent,
+    };
+}
 function runAction(fn) {
     fn().catch((error) => {
         const errorMessage = error instanceof Error ? error.message : String(error);
@@ -27326,6 +27338,7 @@ async function revokeToken(registryUrl, token) {
         headers: {
             /* eslint-disable  @typescript-eslint/naming-convention */
             Authorization: `Bearer ${token}`,
+            ...getUserAgent(),
         },
     });
     if (!response.ok) {

package.json

@@ -1,6 +1,6 @@
 {
-    "name": "trusted-publishing-action-draft",
-    "version": "0.0.0",
+    "name": "crates-io-auth-action",
+    "version": "1.0.0",
     "description": "Get a temporary access token that you can use to interact with crates.io.",
     "private": true,
     "scripts": {

src/main.ts

@@ -6,6 +6,7 @@ import {
     throwHttpErrorMessage,
     TOKEN_KEY,
     REGISTRY_URL_KEY,
+    getUserAgent,
 } from "./utils.js";
 
 runAction(run);
@@ -61,13 +62,17 @@ async function requestTrustedPublishingToken(
     jwtToken: string,
 ): Promise<string> {
     const tokenUrl = getTokensEndpoint(registryUrl);
-    core.info(`Requesting token from: ${tokenUrl}`);
+    const userAgent = getUserAgent();
+    core.info(
+        `Requesting token from: ${tokenUrl}. User agent: ${userAgent["User-Agent"]}`,
+    );
 
     const response = await fetch(tokenUrl, {
         method: "POST",
         headers: {
             /* eslint-disable  @typescript-eslint/naming-convention */
             "Content-Type": "application/json",
+            ...userAgent,
         },
         body: JSON.stringify({ jwt: jwtToken }),
     });

src/post.ts

@@ -5,6 +5,7 @@ import {
     TOKEN_KEY,
     REGISTRY_URL_KEY,
     throwHttpErrorMessage,
+    getUserAgent,
 } from "./utils.js";
 
 runAction(cleanup);
@@ -37,6 +38,7 @@ async function revokeToken(registryUrl: string, token: string): Promise<void> {
         headers: {
             /* eslint-disable  @typescript-eslint/naming-convention */
             Authorization: `Bearer ${token}`,
+            ...getUserAgent(),
         },
     });
 

src/utils.ts

@@ -8,6 +8,11 @@ interface ErrorResponse {
     errors: Array<{ detail: string }>;
 }
 
+type UserAgent = {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    "User-Agent": string;
+};
+
 /** If true, the compiler considers `value` of type ErrorResponse */
 function isErrorResponse(value: unknown): value is ErrorResponse {
     if (typeof value !== "object" || value === null) {
@@ -71,6 +76,22 @@ export function getTokensEndpoint(registryUrl: string): string {
     return `${registryUrl}/api/v1/trusted_publishing/tokens`;
 }
 
+function userAgentValue(): string {
+    const version = "v1";
+
+    // TODO: read the package name and version from package.json
+
+    return `crates-io-auth-action/${version}`;
+}
+
+export function getUserAgent(): UserAgent {
+    const userAgent = userAgentValue();
+    return {
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        "User-Agent": userAgent,
+    };
+}
+
 export function runAction(fn: () => Promise<void>): void {
     fn().catch((error: unknown) => {
         const errorMessage =