Skip to content
Open
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
27 changes: 27 additions & 0 deletions packages/liquid-html-parser/src/tags/block.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,33 @@ describe('blockTag', () => {
);
});

it('parses a canonical app block path', () => {
const path =
'shopify://apps/example_app/blocks/example-block/00000000-0000-4000-8000-000000000000';
const result = blockTag.parse('block', parser(`'${path}'`), stubParser);
expect(result.name.value).toBe(path);
});

it('rejects malformed app block paths', () => {
const uuid = '00000000-0000-4000-8000-000000000000';
const invalidPaths = [
`shopify://apps/example_app/snippets/example-block/${uuid}`,
`shopify://apps//blocks/example-block/${uuid}`,
`shopify://apps/example_app/blocks//${uuid}`,
'shopify://apps/example_app/blocks/example-block/not-a-uuid',
'shopify://apps/example_app/blocks/example-block/deadbeef',
`shopify://apps/example_app/blocks/example-block/${uuid}/extra`,
`shopify://apps-evil/example_app/blocks/example-block/${uuid}`,
`shopify://apps/example_app/blocks/example-block/${uuid}\n`,
];

for (const path of invalidPaths) {
expect(() => blockTag.parse('block', parser(`'${path}'`), stubParser)).toThrow(
`in 'block' - '${path}' is not a valid block type`,
);
}
});

it('rejects markup without a comma before args', () => {
expect(() => blockTag.parse('block', parser("'name' key: value"), stubParser)).toThrow(
"Unexpected token in 'block' tag: key",
Expand Down
5 changes: 4 additions & 1 deletion packages/liquid-html-parser/src/tags/block.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ import { NodeTypes } from '../types';
import { TagKind, type TagDefinitionBlock, type Parser } from '../tag-definitions';

const BLOCK_TYPE_REGEX = /^_?[a-zA-Z0-9][\w-]*$/;
// Canonical app block paths include app and block handles followed by a UUID.
const APP_BLOCK_TYPE_REGEX =
/^shopify:\/\/apps\/[A-Za-z0-9][A-Za-z0-9_-]*\/blocks\/[A-Za-z0-9][A-Za-z0-9_-]*\/[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$/;

export const blockTag: TagDefinitionBlock<BlockMarkup> = {
kind: TagKind.Block,
Expand All @@ -18,7 +21,7 @@ export const blockTag: TagDefinitionBlock<BlockMarkup> = {
if (name.type !== NodeTypes.String) {
throw new Error("in 'block' - file name must be a string literal");
}
if (!BLOCK_TYPE_REGEX.test(name.value)) {
if (!BLOCK_TYPE_REGEX.test(name.value) && !APP_BLOCK_TYPE_REGEX.test(name.value)) {
throw new Error(`in 'block' - '${name.value}' is not a valid block type`);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,14 @@ describe('Module: LiquidHTMLSyntaxError', () => {
expect(offenses).to.be.empty;
});

it('should not report canonical inline app block paths', async () => {
const sourceCode =
"{% block 'shopify://apps/example_app/blocks/example-block/00000000-0000-4000-8000-000000000000' %}{% endblock %}";

const offenses = await runLiquidCheck(LiquidHTMLSyntaxError, sourceCode);
expect(offenses).to.be.empty;
});

it('should highligh the error', async () => {
let offenses: Offense[];
let highlights: string[];
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,6 @@ export function checkBlockTag(node: LiquidTag, context: Context): void {

const markup = node.markup as BlockMarkup;

if (hasInvalidBlockName(markup.name.value)) {
report(node, context, "Liquid syntax error: in 'block' - Valid syntax: block '[file_name]'");
return;
}

if (hasInvalidBlockArguments(markup)) {
report(node, context, SYNTAX_ERROR);
return;
Expand Down Expand Up @@ -75,10 +70,6 @@ export function checkBlockParserError(error: Error, context: Context, source: st
});
}

function hasInvalidBlockName(value: string): boolean {
return value.includes('/') || value.includes('.');
}

function hasInvalidBlockArguments(markup: BlockMarkup): boolean {
return markup.args.some((arg) => {
if (arg.name === 'block.content') return false;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -802,6 +802,34 @@ describe('LiquidSyntaxError', () => {
});
});

describe('block tags', () => {
it('produces no diagnostics for canonical app block paths', async () => {
const offenses = await runLiquidCheck(
LiquidSyntaxError,
"{% block 'shopify://apps/example_app/blocks/example-block/00000000-0000-4000-8000-000000000000' %}{% endblock %}",
'snippets/test.liquid',
NO_DOCSET,
);

expect(offenses).toEqual([]);
});

it('reports LiquidSyntaxError for malformed app block paths', async () => {
const offenses = await runLiquidCheck(
LiquidSyntaxError,
"{% block 'shopify://apps/example_app/snippets/example-block/00000000-0000-4000-8000-000000000000' %}{% endblock %}",
'snippets/test.liquid',
NO_DOCSET,
);

expect(offenses).toHaveLength(1);
expect(offenses[0]).toMatchObject({
check: 'LiquidSyntaxError',
message: "Syntax error in 'block' tag",
});
});
});

describe('block and partial parser errors', () => {
it('locates line-mode block tags inside liquid blocks', () => {
expect(liquidLineTagLocation("{% liquid\n block 'hero'\n%}", 'block')).toEqual([12, 24]);
Expand Down
Loading