Skip to content

Commit fe389da

Browse files
gonzaloriestragonzaloriestra
authored
Merge pull request #6805 from Shopify/skip-local-console
[stable] make remote dev console the default case
2 parents ea96a23 + 287a76e commit fe389da

7 files changed

Lines changed: 25 additions & 37 deletions

File tree

‎.changeset/sunny-aliens-mate.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'@shopify/cli-kit': patch
3+
'@shopify/app': patch
4+
---
5+
6+
Skip the local dev console and open Admin instead by default

‎packages/app/src/cli/services/dev/processes/dev-session/dev-session-process.test.ts‎

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {AbortSignal, AbortController} from '@shopify/cli-kit/node/abort'
2020
import {flushPromises} from '@shopify/cli-kit/node/promises'
2121
import * as outputContext from '@shopify/cli-kit/node/ui/components'
2222
import {readdir} from '@shopify/cli-kit/node/fs'
23-
import {firstPartyDev, skipLocalDevConsole} from '@shopify/cli-kit/node/context/local'
23+
import {firstPartyDev} from '@shopify/cli-kit/node/context/local'
2424

2525
vi.mock('@shopify/cli-kit/node/fs')
2626
vi.mock('@shopify/cli-kit/node/archiver')
@@ -33,7 +33,6 @@ vi.mock('@shopify/cli-kit/node/context/local', async (importOriginal) => {
3333
return {
3434
...original,
3535
firstPartyDev: vi.fn().mockReturnValue(false),
36-
skipLocalDevConsole: vi.fn().mockReturnValue(false),
3736
}
3837
})
3938

@@ -219,10 +218,9 @@ describe('pushUpdatesForDevSession', () => {
219218
contextSpy.mockRestore()
220219
})
221220

222-
test('updates preview URL to appLocalProxyURL when extension is previewable (dev console shown by default)', async () => {
223-
// Given - dev console is shown by default when skipLocalDevConsole is false
221+
test('updates preview URL to appPreviewURL by default (local dev console only for 1P devs)', async () => {
222+
// Given - dev console is NOT shown by default (only for 1P devs)
224223
vi.mocked(firstPartyDev).mockReturnValue(false)
225-
vi.mocked(skipLocalDevConsole).mockReturnValue(false)
226224
const extension = await testUIExtension({type: 'ui_extension'})
227225
const newApp = testAppLinked({allExtensions: [extension]})
228226

@@ -234,13 +232,12 @@ describe('pushUpdatesForDevSession', () => {
234232
await flushPromises()
235233

236234
// Then
237-
expect(devSessionStatusManager.status.previewURL).toBe(options.appLocalProxyURL)
235+
expect(devSessionStatusManager.status.previewURL).toBe(options.appPreviewURL)
238236
})
239237

240-
test('updates preview URL to appPreviewURL when both skip conditions are met', async () => {
241-
// Given - dev console is skipped only when !firstPartyDev() AND skipLocalDevConsole()
242-
vi.mocked(firstPartyDev).mockReturnValue(false)
243-
vi.mocked(skipLocalDevConsole).mockReturnValue(true)
238+
test('updates preview URL to appLocalProxyURL when 1P dev has previewable extensions', async () => {
239+
// Given - dev console is shown for 1P devs with previewable extensions
240+
vi.mocked(firstPartyDev).mockReturnValue(true)
244241
const extension = await testUIExtension({type: 'ui_extension'})
245242
const newApp = testAppLinked({allExtensions: [extension]})
246243

@@ -252,8 +249,8 @@ describe('pushUpdatesForDevSession', () => {
252249
await flushPromises()
253250

254251
// Then
255-
expect(devSessionStatusManager.status.previewURL).toBe(options.appPreviewURL)
256-
vi.mocked(skipLocalDevConsole).mockReturnValue(false)
252+
expect(devSessionStatusManager.status.previewURL).toBe(options.appLocalProxyURL)
253+
vi.mocked(firstPartyDev).mockReturnValue(false)
257254
})
258255

259256
test('updates preview URL to appPreviewURL when no previewable extensions', async () => {

‎packages/app/src/cli/services/dev/processes/dev-session/dev-session.ts‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import {endHRTimeInMs, startHRTime} from '@shopify/cli-kit/node/hrtime'
1010
import {ClientError} from 'graphql-request'
1111
import {JsonMapType} from '@shopify/cli-kit/node/toml'
1212
import {AbortError} from '@shopify/cli-kit/node/error'
13-
import {firstPartyDev, isUnitTest, skipLocalDevConsole} from '@shopify/cli-kit/node/context/local'
13+
import {firstPartyDev, isUnitTest} from '@shopify/cli-kit/node/context/local'
1414
import {dirname, joinPath} from '@shopify/cli-kit/node/path'
1515
import {readdir} from '@shopify/cli-kit/node/fs'
1616
import {SerialBatchProcessor} from '@shopify/cli-kit/node/serial-batch-processor'
@@ -240,13 +240,12 @@ export class DevSession {
240240
/**
241241
* Update the preview URL, it only changes if we move between a non-previewable state and a previewable state.
242242
* (i.e. if we go from a state with no extensions to a state with ui-extensions or vice versa)
243-
* Skip the dev console only when BOTH: SHOPIFY_CLI_1P_DEV is NOT enabled AND SHOPIFY_SKIP_LOCAL_DEV_CONSOLE is set.
243+
* Use local dev console only for 1P developers (SHOPIFY_CLI_1P_DEV is enabled).
244244
* @param event - The app event
245245
*/
246246
private updatePreviewURL(event: AppEvent) {
247247
const hasPreview = event.app.allExtensions.filter((ext) => ext.isPreviewable).length > 0
248-
const skipDevConsole = !firstPartyDev() && skipLocalDevConsole()
249-
const useDevConsole = !skipDevConsole && hasPreview
248+
const useDevConsole = firstPartyDev() && hasPreview
250249
const newPreviewURL = useDevConsole ? this.options.appLocalProxyURL : this.options.appPreviewURL
251250
this.statusManager.updateStatus({previewURL: newPreviewURL})
252251
}

‎packages/app/src/cli/services/dev/processes/setup-dev-processes.test.ts‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ import {Config} from '@oclif/core'
3535
import {getEnvironmentVariables} from '@shopify/cli-kit/node/environment'
3636
import {isStorefrontPasswordProtected} from '@shopify/theme'
3737
import {fetchTheme} from '@shopify/cli-kit/node/themes/api'
38-
import {firstPartyDev, skipLocalDevConsole} from '@shopify/cli-kit/node/context/local'
38+
import {firstPartyDev} from '@shopify/cli-kit/node/context/local'
3939

4040
vi.mock('../../context/identifiers.js')
4141
vi.mock('@shopify/cli-kit/node/session.js')
@@ -69,10 +69,8 @@ beforeEach(() => {
6969
role: 'theme',
7070
processing: false,
7171
})
72-
// By default, firstPartyDev is false (dev console URL only used when enabled)
72+
// By default, firstPartyDev is false (local dev console only shown for 1P devs)
7373
vi.mocked(firstPartyDev).mockReturnValue(false)
74-
// By default, skipLocalDevConsole is false
75-
vi.mocked(skipLocalDevConsole).mockReturnValue(false)
7674
})
7775

7876
const appContextResult = {
@@ -168,8 +166,8 @@ describe('setup-dev-processes', () => {
168166
graphiqlKey,
169167
})
170168

171-
// Dev console is shown by default (only skipped when !firstPartyDev() AND skipLocalDevConsole())
172-
expect(res.previewUrl).toBe('https://example.com/proxy/extensions/dev-console')
169+
// Dev console is NOT shown by default (only shown for 1P devs)
170+
expect(res.previewUrl).toBe('https://store.myshopify.io/admin/oauth/redirect_from_cli?client_id=api-key')
173171
expect(res.processes[0]).toMatchObject({
174172
type: 'web',
175173
prefix: 'web-backend-frontend',

‎packages/app/src/cli/services/dev/processes/setup-dev-processes.ts‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import {AppEventWatcher} from '../app-events/app-event-watcher.js'
2222
import {reloadApp} from '../../../models/app/loader.js'
2323
import {getAvailableTCPPort} from '@shopify/cli-kit/node/tcp'
2424
import {isTruthy} from '@shopify/cli-kit/node/context/utilities'
25-
import {firstPartyDev, skipLocalDevConsole} from '@shopify/cli-kit/node/context/local'
25+
import {firstPartyDev} from '@shopify/cli-kit/node/context/local'
2626
import {getEnvironmentVariables} from '@shopify/cli-kit/node/environment'
2727
import {outputInfo} from '@shopify/cli-kit/node/output'
2828

@@ -100,11 +100,10 @@ export async function setupDevProcesses({
100100
const appWatcher = new AppEventWatcher(reloadedApp, network.proxyUrl)
101101

102102
// Decide on the appropriate preview URL for a session with these processes
103-
// Skip the dev console only when BOTH: SHOPIFY_CLI_1P_DEV is NOT enabled AND SHOPIFY_SKIP_LOCAL_DEV_CONSOLE is set
103+
// Use local dev console only for 1P developers (SHOPIFY_CLI_1P_DEV is enabled)
104104
const anyPreviewableExtensions = reloadedApp.allExtensions.some((ext) => ext.isPreviewable)
105105
const devConsoleURL = `${network.proxyUrl}/extensions/dev-console`
106-
const skipDevConsole = !firstPartyDev() && skipLocalDevConsole()
107-
const useDevConsole = !skipDevConsole && anyPreviewableExtensions
106+
const useDevConsole = firstPartyDev() && anyPreviewableExtensions
108107
const previewURL = useDevConsole ? devConsoleURL : appPreviewUrl
109108

110109
const graphiqlURL = shouldRenderGraphiQL

‎packages/cli-kit/src/private/node/constants.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ export const environmentVariables = {
1919
enableCliRedirect: 'SHOPIFY_CLI_ENABLE_CLI_REDIRECT',
2020
env: 'SHOPIFY_CLI_ENV',
2121
firstPartyDev: 'SHOPIFY_CLI_1P_DEV',
22-
skipLocalDevConsole: 'SHOPIFY_SKIP_LOCAL_DEV_CONSOLE',
2322
noAnalytics: 'SHOPIFY_CLI_NO_ANALYTICS',
2423
partnersToken: 'SHOPIFY_CLI_PARTNERS_TOKEN',
2524
runAsUser: 'SHOPIFY_RUN_AS_USER',

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

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -112,16 +112,6 @@ export function firstPartyDev(env = process.env): boolean {
112112
return isTruthy(env[environmentVariables.firstPartyDev])
113113
}
114114

115-
/**
116-
* Returns true if the local dev console should be skipped.
117-
*
118-
* @param env - The environment variables from the environment of the current process.
119-
* @returns True if SHOPIFY_SKIP_LOCAL_DEV_CONSOLE is truthy.
120-
*/
121-
export function skipLocalDevConsole(env = process.env): boolean {
122-
return isTruthy(env[environmentVariables.skipLocalDevConsole])
123-
}
124-
125115
/**
126116
* Return gitpodURL if we are running in gitpod.
127117
* Https://www.gitpod.io/docs/environment-variables#default-environment-variables.

0 commit comments

Comments
 (0)