Skip to content

Fix theme dev shortcut to editor tracking non page requests #6924

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EvilGenius13 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix theme dev shortcut to editor tracking non page requests #6924

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/eighty-papers-hunt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@shopify/theme': patch
---

Fix theme editor shortcut tracking fetch requests instead of page navigation
22 changes: 20 additions & 2 deletions packages/theme/src/cli/utilities/theme-environment/html.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ describe('getHtmlHandler', async () => {
lastRequestedPath: '',
} as unknown as DevServerContext

test('sets lastRequestedPath to the rendering URL', async () => {
test('sets lastRequestedPath when Sec-Fetch-Mode is navigate', async () => {
const handler = getHtmlHandler(theme, ctx)

expect(ctx.lastRequestedPath).toStrictEqual('')

const event = createH3Event('GET', '/search?q=foo&options%5Bprefix%5D=last')
const event = createH3Event('GET', '/search?q=foo&options%5Bprefix%5D=last', {'sec-fetch-mode': 'navigate'})

vi.mocked(render).mockResolvedValueOnce(
new Response('', {
Expand All @@ -60,6 +60,24 @@ describe('getHtmlHandler', async () => {
expect(ctx.lastRequestedPath).toStrictEqual('/search?q=foo&options%5Bprefix%5D=last')
})

test('does not update lastRequestedPath when Sec-Fetch-Mode is not navigate', async () => {
const handler = getHtmlHandler(theme, ctx)
ctx.lastRequestedPath = '/previous-page'

const event = createH3Event('GET', '/search/suggest?q=foo&resources[type]=product', {'sec-fetch-mode': 'cors'})

vi.mocked(render).mockResolvedValueOnce(
new Response('', {
status: 200,
headers: {'x-request-id': 'test-request-id'},
}),
)

await handler(event)

expect(ctx.lastRequestedPath).toStrictEqual('/previous-page')
})

test('the development server session recovers when a theme id mismatch occurs', async () => {
// Given
const handler = getHtmlHandler(theme, ctx)
Expand Down
9 changes: 8 additions & 1 deletion packages/theme/src/cli/utilities/theme-environment/html.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ export function getHtmlHandler(theme: Theme, ctx: DevServerContext): EventHandle
return defineEventHandler((event) => {
const [browserPathname = '/', browserSearch = ''] = event.path.split('?')

ctx.lastRequestedPath = event.path
if (isNavigationRequest(event)) {
ctx.lastRequestedPath = event.path
}

const shouldRenderUploadErrorPage =
ctx.options.errorOverlay !== 'silent' && ctx.localThemeFileSystem.uploadErrors.size > 0
Expand Down Expand Up @@ -160,6 +162,11 @@ function isKnownRenderingRequest(event: H3Event) {
return ['section_id', 'sections', 'app_block_id'].some((key) => searchParams.has(key))
}

/** Determines if a request is a user navigation type via sec-fetch-mode header. */
function isNavigationRequest(event: H3Event): boolean {
return event.headers.get('sec-fetch-mode') === 'navigate'
}

async function tryProxyRequest(event: H3Event, ctx: DevServerContext, response: Response) {
outputDebug(
`Render failed for ${event.path} with ${response.status} (x-request-id: ${response.headers.get(
Expand Down
Loading