Skip to content

Allow static theme asset script URLs in app doctor #8502

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
francisbeaudoin wants to merge 1 commit into
base: main
Choose a base branch
from
+23 −1
Open

Allow static theme asset script URLs in app doctor #8502

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/quiet-assets-repair.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@shopify/app': patch
---

Avoid flagging static theme asset script tags in app doctor.
9 changes: 9 additions & 0 deletions packages/app/src/cli/services/app-doctor-engine/rules/liquid-rules.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ function liquidExecutableContextVisitor(file: SourceFile) {
const context = liquidOutputContext(ancestors)
if (context !== 'javascript' && context !== 'executable_attribute') return undefined
if (context === 'javascript' && filterNames(node).includes('json')) return undefined
if (isStaticScriptAssetUrl(node, ancestors)) return undefined
return [
makeLiquidIssue(
'UNSAFE_INNERHTML',
Expand Down Expand Up @@ -118,6 +119,14 @@ function attributeName(attribute: AttributeNode): string {
return attribute.name.map((part) => ('value' in part && typeof part.value === 'string' ? part.value : '')).join('')
}

function isStaticScriptAssetUrl(node: LiquidVariableOutput, ancestors: LiquidHtmlNode[]): boolean {
const script = ancestors.find((ancestor) => ancestor.type === 'HtmlRawNode' && ancestor.name === 'script')
const attribute = ancestors.find((ancestor): ancestor is AttributeNode => ancestor.type.startsWith('Attr'))
if (!script || !attribute || attributeName(attribute).toLowerCase() !== 'src') return false

return /^(['"])(?:\\.|(?!\1)[^\\\n])+\1\s*\|\s*asset_url\s*$/.test(outputSource(node).trim())
}

function outputSource(node: LiquidVariableOutput): string {
return typeof node.markup === 'string' ? node.markup : node.markup.rawSource
}
Expand Down
10 changes: 9 additions & 1 deletion packages/app/src/cli/services/app-doctor-engine/tests/rule-analysis.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -707,8 +707,16 @@ describe('Liquid public AST analysis', () => {
])
expect(ordinary.issues).toEqual([])

const staticAsset = scanLiquidSecurity([
source('<script src="{{ \'chat.js\' | asset_url }}" defer></script>', 'extensions/theme/blocks/chat.liquid'),
])
expect(staticAsset.issues).toEqual([])

const script = scanLiquidSecurity([
source('<script src="{{ block.settings.script | escape }}"></script>', 'extensions/theme/blocks/script.liquid'),
source(
'<script src="{{ block.settings.script | asset_url }}"></script>',
'extensions/theme/blocks/script.liquid',
),
])
expect(script.issues.map((finding) => finding.id)).toEqual(['LIQUID_UNSAFE_RENDER', 'UNSAFE_INNERHTML'])
})
Expand Down
Loading