Merge pull request #8407 from Shopify/gonzalo/no-input

Add `--no-input` to all commands

Author: gonzaloriestra

.changeset/no-input.md

@@ -0,0 +1,6 @@
+---
+'@shopify/cli-kit': minor
+'@shopify/cli': minor
+---
+
+Add `--no-input` to commands with global flags to disable interactive prompts and browser authentication.

docs-shopify.dev/generated/generated_docs_data_v2.json

@@ -14,8 +14,7 @@ import {err, ok} from '../../../public/node/result.js'
 import {AbortError, BugError} from '../../../public/node/error.js'
 import {isCI, openURL, sleep} from '../../../public/node/system.js'
 import * as output from '../../../public/node/output.js'
-
-import {beforeEach, describe, expect, test, vi} from 'vitest'
+import {afterEach, beforeEach, describe, expect, test, vi} from 'vitest'
 import {Response} from 'node-fetch'
 
 vi.mock('../../../public/node/context/fqdn.js')
@@ -27,11 +26,14 @@ vi.mock('./exchange.js')
 vi.mock('../../../public/node/system.js')
 
 beforeEach(() => {
+  vi.stubEnv('SHOPIFY_FLAG_NO_INPUT', '')
   vi.mocked(isTTY).mockReturnValue(true)
   vi.mocked(isCI).mockReturnValue(false)
   vi.mocked(openURL).mockResolvedValue(true)
 })
 
+afterEach(() => vi.unstubAllEnvs())
+
 describe('requestDeviceAuthorization', () => {
   const data: any = {
     device_code: 'device_code',
@@ -162,6 +164,19 @@ describe('requestDeviceAuthorization', () => {
     expect(outputInfo).not.toHaveBeenCalledWith('👉 Press any key to open the login page on your browser')
   })
 
+  test('does not open the browser when input is disabled', async () => {
+    const response = new Response(JSON.stringify(data))
+    vi.mocked(shopifyFetch).mockResolvedValue(response)
+    vi.mocked(identityFqdn).mockResolvedValue('fqdn.com')
+    vi.mocked(clientId).mockReturnValue('clientId')
+    vi.stubEnv('SHOPIFY_FLAG_NO_INPUT', 'true')
+
+    await expect(requestDeviceAuthorization(['scope1', 'scope2'])).rejects.toThrow(
+      'Authorization is required to continue, but the current environment does not support interactive prompts.',
+    )
+    expect(openURL).not.toHaveBeenCalled()
+  })
+
   test('when the response is not valid JSON, throw an error with context without retrying', async () => {
     // Given
     const response = new Response('not valid JSON')

packages/cli-kit/src/private/node/session/device-authorization.test.ts

@@ -5,6 +5,7 @@ import {isGatewayErrorStatus} from '../api/status-checks.js'
 import {identityFqdn} from '../../../public/node/context/fqdn.js'
 import {recordRetry} from '../../../public/node/analytics.js'
 import {shopifyFetch} from '../../../public/node/http.js'
+import {isInputDisabled} from '../../../public/node/no-input.js'
 import {outputContent, outputDebug, outputInfo, outputToken} from '../../../public/node/output.js'
 import {AbortError, BugError} from '../../../public/node/error.js'
 import {isCI, openURL, sleep} from '../../../public/node/system.js'
@@ -64,7 +65,7 @@ export async function requestDeviceAuthorization(scopes: string[]): Promise<Devi
 
   outputInfo('\nTo run this command, log in to Shopify.')
 
-  if (isCI()) {
+  if (isInputDisabled() || isCI()) {
     throw new AbortError(
       'Authorization is required to continue, but the current environment does not support interactive prompts.',
       'To resolve this, specify credentials in your environment, or run the command in an interactive environment such as your local terminal.',

packages/cli-kit/src/private/node/session/device-authorization.ts

@@ -346,7 +346,6 @@ describe('applying environments', async () => {
     test(testName, async () => {
       testResult = {}
       testError = undefined
-
       await inTemporaryDirectory(async (tmpDir) => {
         await writeFile(joinPath(tmpDir, 'shopify.environments.toml'), encodeTOML(allEnvironments as any))
         await testFunc(tmpDir)
@@ -603,6 +602,32 @@ describe('applying environments', async () => {
     },
   )
 
+  runTestInTmpDir('provides --no-input to commands through the global flags', async (tmpDir: string) => {
+    // When
+    await MockCommand.run(['--path', tmpDir, '--no-input'])
+
+    // Then
+    expect(testError).toBeUndefined()
+    expect(testResult['no-input']).toBe(true)
+  })
+
+  runTestInTmpDir('treats disabled input as non-interactive in a TTY', async (tmpDir: string) => {
+    // When
+    vi.stubEnv('SHOPIFY_FLAG_NO_INPUT', 'true')
+    await MockCommandWithRequiredFlagInNonTTY.run(['--path', tmpDir, '--no-input'])
+
+    // Then
+    expect(unstyled(testError!.message)).toMatch('Flag not specified:\n\n--nonTTYRequiredFlag')
+  })
+
+  runTestInTmpDir('supports disabling input through the environment', async (tmpDir: string) => {
+    vi.stubEnv('SHOPIFY_FLAG_NO_INPUT', 'true')
+
+    await MockCommandWithRequiredFlagInNonTTY.run(['--path', tmpDir])
+
+    expect(unstyled(testError!.message)).toMatch('Flag not specified:\n\n--nonTTYRequiredFlag')
+  })
+
   runTestInTmpDir('does not throw in TTY mode when a non-TTY required argument is missing', async (tmpDir: string) => {
     // Given — simulate interactive terminal
     Object.defineProperty(process.stdin, 'isTTY', {value: true, configurable: true, writable: true})
@@ -627,6 +652,14 @@ describe('applying environments', async () => {
     expect(unstyled(testError!.message)).toMatch('Flag not specified:\n\n--nonTTYRequiredFlag')
   })
 
+  runTestInTmpDir('treats piped stdin as non-interactive', async (tmpDir: string) => {
+    Object.defineProperty(process.stdin, 'isTTY', {value: false, configurable: true, writable: true})
+
+    await MockCommandWithRequiredFlagInNonTTY.run(['--path', tmpDir])
+
+    expect(unstyled(testError!.message)).toMatch('Flag not specified:\n\n--nonTTYRequiredFlag')
+  })
+
   runTestInTmpDir('reports all missing declarative non-TTY requirements', async (tmpDir: string) => {
     // Given
     vi.stubEnv('CI', 'true')

packages/cli-kit/src/public/node/base-command.test.ts

@@ -1,4 +1,5 @@
 import {isTruthy} from './context/utilities.js'
+import {noInputFlag} from './no-input.js'
 import {launchCLI as defaultLaunchCli} from './cli-launcher.js'
 import {environmentVariables} from '../../private/node/constants.js'
 import {Flags} from '@oclif/core'
@@ -131,6 +132,7 @@ export async function runCreateCLI(
  * are shared across all the commands.
  */
 export const globalFlags = {
+  ...noInputFlag,
   'no-color': Flags.boolean({
     hidden: false,
     description: 'Disable color output.',

packages/cli-kit/src/public/node/cli.ts

@@ -13,7 +13,6 @@ import {
 } from './local.js'
 import {fileExists} from '../fs.js'
 import {exec} from '../system.js'
-
 import {afterEach, expect, describe, vi, test} from 'vitest'
 import * as os from 'os'
 import type {NetworkInterfaceInfo} from 'os'
@@ -34,6 +33,7 @@ describe('isTerminalInteractive', () => {
   const originalEnv = {...process.env}
 
   afterEach(() => {
+    vi.unstubAllEnvs()
     process.stdout.isTTY = originalIsTTY
     process.env.TERM = originalEnv.TERM
     if (originalEnv.CI === undefined) {
@@ -77,6 +77,15 @@ describe('isTerminalInteractive', () => {
     process.env.TERM = 'xterm-256color'
     expect(isTerminalInteractive()).toBe(false)
   })
+
+  test('returns false when user input is disabled', () => {
+    process.stdout.isTTY = true
+    delete process.env.CI
+    process.env.TERM = 'xterm-256color'
+    vi.stubEnv('SHOPIFY_FLAG_NO_INPUT', 'true')
+
+    expect(isTerminalInteractive()).toBe(false)
+  })
 })
 
 describe('isUnitTest', () => {

packages/cli-kit/src/public/node/context/local.test.ts

@@ -1,4 +1,5 @@
 import {isTruthy} from './utilities.js'
+import {isInputDisabled} from '../no-input.js'
 import {getCIMetadata, isSet, Metadata} from '../../../private/node/context/utilities.js'
 import {defaultThemeKitAccessDomain, environmentVariables, pathConstants} from '../../../private/node/constants.js'
 import {randomUUID} from 'crypto'
@@ -22,7 +23,7 @@ async function lazyExec(command: string, args: string[]): Promise<void> {
  * @returns True if the terminal is interactive.
  */
 export function isTerminalInteractive(): boolean {
-  return Boolean(process.stdout.isTTY && process.env.TERM !== 'dumb' && !('CI' in process.env))
+  return Boolean(!isInputDisabled() && process.stdout.isTTY && process.env.TERM !== 'dumb' && !('CI' in process.env))
 }
 
 /**

packages/cli-kit/src/public/node/context/local.ts

@@ -43,7 +43,8 @@ vi.mock('./context/local.js')
 vi.mock('../../public/node/crypto.js')
 vi.mock('../../private/node/context/service.js')
 vi.mock('../../private/node/session.js')
-vi.mock('@oclif/core', () => ({
+vi.mock('@oclif/core', async (importOriginal) => ({
+  ...(await importOriginal<typeof import('@oclif/core')>()),
   settings: {
     debug: false,
   },

packages/cli-kit/src/public/node/error-handler.test.ts

@@ -0,0 +1,16 @@
+import {isInputDisabled} from './no-input.js'
+import {describe, expect, test} from 'vitest'
+
+describe('isInputDisabled', () => {
+  test('returns true when --no-input is present', () => {
+    expect(isInputDisabled(['node', 'shopify', '--no-input'], {})).toBe(true)
+  })
+
+  test('returns true when SHOPIFY_FLAG_NO_INPUT is enabled', () => {
+    expect(isInputDisabled([], {SHOPIFY_FLAG_NO_INPUT: 'true'})).toBe(true)
+  })
+
+  test('returns false when input is not disabled', () => {
+    expect(isInputDisabled([], {})).toBe(false)
+  })
+})