Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fix-app-env-pull-absolute-path.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@shopify/app': patch
---

Fix `app env pull --env-file` with absolute paths.
61 changes: 61 additions & 0 deletions packages/app/src/cli/commands/app/env/pull.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
import EnvPull from './pull.js'
import {linkedAppContext} from '../../../services/app-context.js'
import {pullEnv} from '../../../services/app/env/pull.js'
import {testAppLinked, testOrganization, testOrganizationApp} from '../../../models/app/app.test-data.js'
import {outputResult} from '@shopify/cli-kit/node/output'
import {joinPath, resolvePath} from '@shopify/cli-kit/node/path'
import {describe, expect, test, vi} from 'vitest'

vi.mock('../../../services/app-context.js')
vi.mock('../../../services/app/env/pull.js')
vi.mock('@shopify/cli-kit/node/output', async (importOriginal) => {
const actual = await importOriginal<typeof import('@shopify/cli-kit/node/output')>()
return {...actual, outputResult: vi.fn()}
})

describe('app env pull command', () => {
test('uses absolute --env-file paths as-is', async () => {
const app = testAppLinked({
directory: joinPath('F:', 'Project', 'cherhomeliving.shopify', 'shopify-app'),
configPath: joinPath('F:', 'Project', 'cherhomeliving.shopify', 'shopify-app', 'shopify.app.toml'),
})
const remoteApp = testOrganizationApp()
const organization = testOrganization()
const envFile = joinPath(app.directory, '.env')

vi.mocked(linkedAppContext).mockResolvedValue({app, remoteApp, organization} as Awaited<
ReturnType<typeof linkedAppContext>
>)
vi.mocked(pullEnv).mockResolvedValue('Created env file')

await EnvPull.run(['--path', app.directory, '--env-file', envFile], import.meta.url)

expect(pullEnv).toHaveBeenCalledWith({
app,
remoteApp,
organization,
envFile,
})
expect(outputResult).toHaveBeenCalledWith('Created env file')
})

test('resolves relative --env-file paths from the app directory', async () => {
const app = testAppLinked({directory: '/tmp/my-app', configPath: '/tmp/my-app/shopify.app.toml'})
const remoteApp = testOrganizationApp()
const organization = testOrganization()

vi.mocked(linkedAppContext).mockResolvedValue({app, remoteApp, organization} as Awaited<
ReturnType<typeof linkedAppContext>
>)
vi.mocked(pullEnv).mockResolvedValue('Created env file')

await EnvPull.run(['--path', app.directory, '--env-file', 'config/.env'], import.meta.url)

expect(pullEnv).toHaveBeenCalledWith({
app,
remoteApp,
organization,
envFile: resolvePath(app.directory, 'config/.env'),
})
})
})
4 changes: 2 additions & 2 deletions packages/app/src/cli/commands/app/env/pull.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {linkedAppContext} from '../../../services/app-context.js'
import {Flags} from '@oclif/core'
import {globalFlags} from '@shopify/cli-kit/node/cli'
import {outputResult} from '@shopify/cli-kit/node/output'
import {joinPath} from '@shopify/cli-kit/node/path'
import {resolvePath} from '@shopify/cli-kit/node/path'

export default class EnvPull extends AppLinkedCommand {
static summary = 'Pull app and extensions environment variables.'
Expand Down Expand Up @@ -36,7 +36,7 @@ export default class EnvPull extends AppLinkedCommand {
forceRelink: flags.reset,
userProvidedConfigName: flags.config,
})
const envFile = joinPath(app.directory, flags['env-file'] ?? getDotEnvFileName(app.configPath))
const envFile = resolvePath(app.directory, flags['env-file'] ?? getDotEnvFileName(app.configPath))
outputResult(await pullEnv({app, remoteApp, organization, envFile}))
return {app}
}
Expand Down
Loading