-
Notifications
You must be signed in to change notification settings - Fork 125
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4183 from Shopify/jmeng/themeconsole
[Themes] - Shopify Theme Console
- Loading branch information
Showing
22 changed files
with
1,195 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@shopify/theme': minor | ||
| --- | ||
|
|
||
| Release the developer preview for the Theme Console command |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| import {ensureReplEnv} from './console.js' | ||
| import { | ||
| isStorefrontPasswordCorrect, | ||
| isStorefrontPasswordProtected, | ||
| } from '../utilities/theme-environment/storefront-session.js' | ||
| import {ensureValidPassword} from '../utilities/repl/storefront-password-prompt.js' | ||
| import {beforeEach, describe, expect, test, vi} from 'vitest' | ||
| import {AdminSession} from '@shopify/cli-kit/node/session' | ||
|
|
||
| vi.mock('../utilities/theme-environment/storefront-session.js') | ||
| vi.mock('../utilities/repl/storefront-password-prompt.js') | ||
| vi.mock('../utilities/repl/repl-theme-manager.js', () => { | ||
| const REPLThemeManager = vi.fn() | ||
| REPLThemeManager.prototype.findOrCreate = () => ({ | ||
| id: 1, | ||
| name: 'theme', | ||
| role: 'development', | ||
| createdAtRuntime: true, | ||
| processing: true, | ||
| }) | ||
| return {REPLThemeManager} | ||
| }) | ||
|
|
||
| describe('ensureReplEnv', () => { | ||
| beforeEach(() => { | ||
| vi.mocked(ensureValidPassword).mockResolvedValue('testPassword') | ||
| }) | ||
|
|
||
| const adminSession: AdminSession = {storeFqdn: 'test-store.myshopify.com', token: 'token'} | ||
|
|
||
| test('should prompt for password when storefront is password protected', async () => { | ||
| // Given | ||
| vi.mocked(isStorefrontPasswordProtected).mockResolvedValue(true) | ||
| vi.mocked(isStorefrontPasswordCorrect).mockResolvedValue(true) | ||
|
|
||
| // When | ||
| const {storePassword} = await ensureReplEnv(adminSession) | ||
|
|
||
| // Then | ||
| expect(ensureValidPassword).toHaveBeenCalled() | ||
| expect(storePassword).toBe('testPassword') | ||
| }) | ||
|
|
||
| test('should skip prompt and return undefined for password when storefront is not password protected', async () => { | ||
| // Given | ||
| vi.mocked(isStorefrontPasswordProtected).mockResolvedValue(false) | ||
| vi.mocked(isStorefrontPasswordCorrect).mockResolvedValue(true) | ||
|
|
||
| // When | ||
| const {storePassword} = await ensureReplEnv(adminSession) | ||
|
|
||
| // Then | ||
| expect(ensureValidPassword).not.toHaveBeenCalled() | ||
| expect(storePassword).toBeUndefined() | ||
| }) | ||
|
|
||
| test('should return undefined for storePassword when password is provided but storefront is not password protected', async () => { | ||
| // Given | ||
| vi.mocked(isStorefrontPasswordProtected).mockResolvedValue(false) | ||
| vi.mocked(isStorefrontPasswordCorrect).mockResolvedValue(true) | ||
|
|
||
| // When | ||
| const {storePassword} = await ensureReplEnv(adminSession, 'testPassword') | ||
|
|
||
| // Then | ||
| expect(ensureValidPassword).not.toHaveBeenCalled() | ||
| expect(storePassword).toBeUndefined() | ||
| }) | ||
| }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| import {isStorefrontPasswordProtected} from '../utilities/theme-environment/storefront-session.js' | ||
| import {REPLThemeManager} from '../utilities/repl/repl-theme-manager.js' | ||
| import {DevServerSession} from '../utilities/theme-environment/types.js' | ||
| import {ensureValidPassword} from '../utilities/repl/storefront-password-prompt.js' | ||
| import {replLoop} from '../utilities/repl/repl.js' | ||
| import {AdminSession} from '@shopify/cli-kit/node/session' | ||
| import {consoleLog} from '@shopify/cli-kit/node/output' | ||
|
|
||
| export async function ensureReplEnv(adminSession: AdminSession, storePasswordFlag?: string) { | ||
| const themeId = await findOrCreateReplTheme(adminSession) | ||
|
|
||
| const storePassword = (await isStorefrontPasswordProtected(adminSession.storeFqdn)) | ||
| ? await ensureValidPassword(storePasswordFlag, adminSession.storeFqdn) | ||
| : undefined | ||
|
|
||
| return { | ||
| themeId, | ||
| storePassword, | ||
| } | ||
| } | ||
|
|
||
| async function findOrCreateReplTheme(adminSession: AdminSession): Promise<string> { | ||
| const themeManager = new REPLThemeManager(adminSession) | ||
| const replTheme = await themeManager.findOrCreate() | ||
|
|
||
| return replTheme.id.toString() | ||
| } | ||
|
|
||
| export async function initializeRepl( | ||
| adminSession: AdminSession, | ||
| storefrontToken: string, | ||
| themeId: string, | ||
| url: string, | ||
| password: string | undefined, | ||
| ) { | ||
| consoleLog('Welcome to Shopify Liquid console\n(press Ctrl + C to exit)') | ||
| const themeSession: DevServerSession = { | ||
| ...adminSession, | ||
| storefrontToken, | ||
| storefrontPassword: password, | ||
| expiresAt: new Date(), | ||
| } | ||
| return replLoop(themeSession, themeId, url) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.