Add SOCKET_CLI_API_TIMEOUT env var

Author: jdalton

README.md

@@ -92,9 +92,10 @@ npm exec socket
 
 - `SOCKET_CLI_API_BASE_URL` - Change the base URL for Socket API calls<br>
   *Defaults:* The "apiBaseUrl" value of socket/settings local app data if present, else `https://api.socket.dev/v0/`<br>
-- `SOCKET_CLI_API_PROXY` - Set the proxy all requests are routed through, e.g. if set to<br>
+- `SOCKET_CLI_API_PROXY` - Set the proxy Socket API requests are routed through, e.g. if set to<br>
   [`http://127.0.0.1:9090`](https://docs.proxyman.io/troubleshooting/couldnt-see-any-requests-from-3rd-party-network-libraries), then all request are passed through that proxy<br>
   *Aliases:* `HTTPS_PROXY`, `https_proxy`, `HTTP_PROXY`, and `http_proxy`<br>
+- `SOCKET_CLI_API_TIMEOUT` - Set the timeout in milliseconds for Socket API requests
 - `SOCKET_CLI_DEBUG` - Enable debug logging in Socket CLI
 - `DEBUG` - Enable debug logging based on the [`debug`](https://socket.dev/npm/package/debug) package
 

package-lock.json

@@ -112,8 +112,8 @@
     "@socketregistry/is-interactive": "1.0.6",
     "@socketregistry/packageurl-js": "1.0.9",
     "@socketsecurity/config": "3.0.1",
-    "@socketsecurity/registry": "1.0.273",
-    "@socketsecurity/sdk": "1.4.76",
+    "@socketsecurity/registry": "1.0.274",
+    "@socketsecurity/sdk": "1.4.77",
     "@types/blessed": "0.1.25",
     "@types/cmd-shim": "5.0.2",
     "@types/js-yaml": "4.0.9",

package.json

@@ -82,9 +82,10 @@ describe('socket root command', async () => {
           SOCKET_CLI_API_BASE_URL     Change the base URL for Socket API calls
                                       Defaults: The "apiBaseUrl" value of socket/settings local app data
                                       if present, else https://api.socket.dev/v0/
-          SOCKET_CLI_API_PROXY        Set the proxy all requests are routed through, e.g. if set to
+          SOCKET_CLI_API_PROXY        Set the proxy Socket API requests are routed through, e.g. if set to
                                       http://127.0.0.1:9090 (\\u200bhttps://docs.proxyman.io/troubleshooting/couldnt-see-any-requests-from-3rd-party-network-libraries\\u200b) then all request are passed through that proxy
                                       Aliases: HTTPS_PROXY, https_proxy, HTTP_PROXY, and http_proxy
+          SOCKET_CLI_API_TIMEOUT      Set the timeout in milliseconds for Socket API requests
           SOCKET_CLI_DEBUG            Enable debug logging in Socket CLI
           DEBUG                       Enable debug logging based on the debug (\\u200bhttps://socket.dev/npm/package/debug\\u200b) package"
     `)

src/commands/cli.test.mts

@@ -73,6 +73,7 @@ type ENV = Remap<
       SOCKET_CLI_ACCEPT_RISKS: boolean
       SOCKET_CLI_API_BASE_URL: string
       SOCKET_CLI_API_PROXY: string
+      SOCKET_CLI_API_TIMEOUT: number
       SOCKET_CLI_API_TOKEN: string
       SOCKET_CLI_CONFIG: string
       SOCKET_CLI_GIT_USER_EMAIL: string
@@ -229,6 +230,7 @@ const LAZY_ENV = () => {
     path.join(constants.rootPath, 'dist/utils.js'),
   )
   const envAsBoolean = envHelpers.envAsBoolean
+  const envAsNumber = envHelpers.envAsNumber
   const envAsString = envHelpers.envAsString
   const getConfigValueOrUndef = utils.getConfigValueOrUndef
   const readOrDefaultSocketJson = utils.readOrDefaultSocketJson
@@ -363,6 +365,9 @@ const LAZY_ENV = () => {
       envAsString(processEnv['https_proxy']) ||
       envAsString(processEnv['HTTP_PROXY']) ||
       envAsString(processEnv['http_proxy']),
+    // Set the timeout in milliseconds for Socket API requests.
+    // https://nodejs.org/api/http.html#httprequesturl-options-callback
+    SOCKET_CLI_API_TIMEOUT: envAsNumber(processEnv['SOCKET_CLI_API_TOKEN']),
     // Set the Socket API token.
     // https://github.com/SocketDev/socket-cli?tab=readme-ov-file#environment-variables
     SOCKET_CLI_API_TOKEN:

src/constants.mts

@@ -488,9 +488,10 @@ export async function meowWithSubcommands(
       '  SOCKET_CLI_API_BASE_URL     Change the base URL for Socket API calls',
       `                              ${colors.italic('Defaults:')} The "apiBaseUrl" value of socket/settings local app data`,
       '                              if present, else https://api.socket.dev/v0/',
-      '  SOCKET_CLI_API_PROXY        Set the proxy all requests are routed through, e.g. if set to',
+      '  SOCKET_CLI_API_PROXY        Set the proxy Socket API requests are routed through, e.g. if set to',
       `                              ${terminalLink('http://127.0.0.1:9090', 'https://docs.proxyman.io/troubleshooting/couldnt-see-any-requests-from-3rd-party-network-libraries')} then all request are passed through that proxy`,
       `                              ${colors.italic('Aliases:')} HTTPS_PROXY, https_proxy, HTTP_PROXY, and http_proxy`,
+      '  SOCKET_CLI_API_TIMEOUT      Set the timeout in milliseconds for Socket API requests',
       '  SOCKET_CLI_DEBUG            Enable debug logging in Socket CLI',
       `  DEBUG                       Enable debug logging based on the ${terminalLink('debug', 'https://socket.dev/npm/package/debug')} package`,
     )

src/utils/meow-with-subcommands.mts

@@ -122,6 +122,8 @@ export async function setupSdk(
     data: new SocketSdk(apiToken, {
       agent: apiProxy ? new ProxyAgent({ proxy: apiProxy }) : undefined,
       baseUrl: apiBaseUrl,
+      // Lazily access constants.ENV.SOCKET_CLI_API_TIMEOUT.
+      timeout: constants.ENV.SOCKET_CLI_API_TIMEOUT,
       userAgent: createUserAgentFromPkgJson({
         // Lazily access constants.ENV.INLINED_SOCKET_CLI_NAME.
         name: constants.ENV.INLINED_SOCKET_CLI_NAME,