preserve api env during login

Author: bmeck

lib/commands/login/index.js

@@ -7,26 +7,45 @@ import terminalLink from 'terminal-link'
 import { AuthError, InputError } from '../../utils/errors.js'
 import { FREE_API_KEY, setupSdk } from '../../utils/sdk.js'
 import { getSetting, updateSetting } from '../../utils/settings.js'
+import { prepareFlags } from '../../utils/flags.js'
+import { printFlagList } from '../../utils/formatting.js'
 
 const description = 'Socket API login'
 
 /** @type {import('../../utils/meow-with-subcommands').CliSubcommand} */
 export const login = {
   description,
   run: async (argv, importMeta, { parentName }) => {
+    const flags = prepareFlags({
+      apiBaseUrl: {
+        type: 'string',
+        description: 'API server to connect to for login',
+      },
+      apiProxy: {
+        type: 'string',
+        description: 'Proxy to use when making connection to API server'
+      }
+    })
     const name = parentName + ' login'
     const cli = meow(`
       Usage
         $ ${name}
 
       Logs into the Socket API by prompting for an API key
 
+      Options
+        ${printFlagList({
+          'api-base-url': flags.apiBaseUrl.description,
+          'api-proxy': flags.apiProxy.description
+        }, 8)}
+
       Examples
         $ ${name}
     `, {
       argv,
       description,
       importMeta,
+      flags
     })
 
     /**
@@ -58,13 +77,27 @@ export const login = {
 
     const apiKey = result.apiKey || FREE_API_KEY
 
+    /**
+     * @type {string | null | undefined}
+     */
+    let apiBaseUrl = cli.flags.apiBaseUrl
+    apiBaseUrl ??= getSetting('apiBaseUrl') ??
+      undefined
+
+    /**
+     * @type {string | null | undefined}
+     */
+    let apiProxy = cli.flags.apiProxy
+    apiProxy ??= getSetting('apiProxy') ??
+      undefined
+
     const spinner = ora('Verifying API key...').start()
 
     /** @type {import('@socketsecurity/sdk').SocketSdkReturnType<'getOrganizations'>['data']} */
     let orgs
 
     try {
-      const sdk = await setupSdk(apiKey)
+      const sdk = await setupSdk(apiKey, apiBaseUrl, apiProxy)
       const result = await sdk.getOrganizations()
       if (!result.success) throw new AuthError()
       orgs = result.data
@@ -131,6 +164,7 @@ export const login = {
     updateSetting('enforcedOrgs', enforcedOrgs)
     const oldKey = getSetting('apiKey')
     updateSetting('apiKey', apiKey)
+    updateSetting('apiBaseUrl', apiBaseUrl)
     spinner.succeed(`API credentials ${oldKey ? 'updated' : 'set'}`)
   }
 }

lib/commands/report/create.js

@@ -179,7 +179,6 @@ async function setupCommand (name, description, argv, importMeta) {
       }
     })
 
-  // TODO: setupSdk(getDefaultKey() || FREE_API_KEY)
   const socketSdk = await setupSdk()
   const supportedFiles = await socketSdk.getReportSupportedFiles()
     .then(res => {

lib/utils/sdk.js

@@ -24,11 +24,43 @@ export function getDefaultKey () {
   return defaultKey
 }
 
+/**
+ * The API server that should be used for operations
+ *
+ * @type {string | undefined}
+ */
+let defaultAPIBaseUrl
+
+/**
+ * @returns {string | undefined}
+ */
+export function getDefaultAPIBaseUrl () {
+  defaultAPIBaseUrl = process.env['SOCKET_SECURITY_API_BASE_URL'] || getSetting('apiBaseUrl') || undefined
+  return defaultAPIBaseUrl
+}
+
+/**
+ * The API server that should be used for operations
+ *
+ * @type {string | undefined}
+ */
+let defaultApiProxy
+
+/**
+ * @returns {string | undefined}
+ */
+export function getDefaultHTTPProxy () {
+  defaultApiProxy = process.env['SOCKET_SECURITY_API_PROXY'] || getSetting('apiProxy') || undefined
+  return defaultApiProxy
+}
+
 /**
  * @param {string} [apiKey]
+ * @param {string} [apiBaseUrl]
+ * @param {string} [proxy]
  * @returns {Promise<import('@socketsecurity/sdk').SocketSdk>}
  */
-export async function setupSdk (apiKey = getDefaultKey()) {
+export async function setupSdk (apiKey = getDefaultKey(), apiBaseUrl = getDefaultAPIBaseUrl(), proxy = getDefaultHTTPProxy()) {
   if (apiKey == null && isInteractive()) {
     /**
      * @type {{ apiKey: string }}
@@ -49,11 +81,11 @@ export async function setupSdk (apiKey = getDefaultKey()) {
   /** @type {import('@socketsecurity/sdk').SocketSdkOptions["agent"]} */
   let agent
 
-  if (process.env['SOCKET_SECURITY_API_PROXY']) {
+  if (proxy) {
     const { HttpProxyAgent, HttpsProxyAgent } = await import('hpagent')
     agent = {
-      http: new HttpProxyAgent({ proxy: process.env['SOCKET_SECURITY_API_PROXY'] }),
-      https: new HttpsProxyAgent({ proxy: process.env['SOCKET_SECURITY_API_PROXY'] }),
+      http: new HttpProxyAgent({ proxy }),
+      https: new HttpsProxyAgent({ proxy }),
     }
   }
   const packageJsonPath = join(dirname(fileURLToPath(import.meta.url)), '../../package.json')
@@ -62,7 +94,7 @@ export async function setupSdk (apiKey = getDefaultKey()) {
   /** @type {import('@socketsecurity/sdk').SocketSdkOptions} */
   const sdkOptions = {
     agent,
-    baseUrl: process.env['SOCKET_SECURITY_API_BASE_URL'],
+    baseUrl: apiBaseUrl,
     userAgent: createUserAgentFromPkgJson(JSON.parse(packageJson))
   }
 

lib/utils/settings.js

@@ -23,7 +23,7 @@ const settingsPath = path.join(dataHome, 'socket', 'settings')
  * @typedef {Record<string, boolean | {action: 'error' | 'warn' | 'ignore' | 'defer'}>} IssueRules
  */
 
-/** @type {{apiKey?: string | null, enforcedOrgs?: string[] | null}} */
+/** @type {{apiKey?: string | null, enforcedOrgs?: string[] | null, apiBaseUrl?: string | null, apiProxy?: string | null}} */
 let settings = {}
 
 if (fs.existsSync(settingsPath)) {

tsconfig.json

@@ -9,14 +9,14 @@
     "test/**/*"
   ],
   "exclude": [
-    "alib/shadow/**"
+    "lib/shadow/**"
   ],
   "compilerOptions": {
     "allowJs": true,
     "checkJs": true,
     "noEmit": true,
     "resolveJsonModule": true,
-    "module": "NodeNext",
+    "module": "ESNext",
     "moduleResolution": "node",
     "lib": ["ES2022"],
     "target": "es2022",