perf(bundle): lazy-load the nunjucks template engine (#2535)
Closes #2531. ## Summary The full `nunjucks` templating engine (~226KB) plus `ha-nunjucks` (~46KB) — roughly **272KB, ~13% of the eager entry chunk** — was statically imported and downloaded by every card on initial load, even though templates only apply when a config value contains a `{{ … }}` / `{% … %}` delimiter. Most cards use no templates and never need the engine. This defers the engine behind a dynamic `import('ha-nunjucks/dist')` so it ships in a separate, on-demand chunk instead of the eager `card-*.js`. ## Approach The render path (`TemplateRenderer.renderRecursively`) is **kept synchronous** — it is called from many synchronous hot paths (condition/trigger evaluators, picture-elements rendering, actions, folder matchers), and making it async would be a large, high-risk refactor of the evaluation core. Instead: - **New `src/card-controller/templates/engine.ts`** — a module-level singleton lazy loader (`loadTemplateEngine()` / `getTemplateEngine()`) shared across all `TemplateRenderer` instances, plus a `containsTemplate()` delimiter helper. - **Delimiter gating** — strings without a delimiter never touch the engine (the overwhelming majority of renders). - **Pre-warm at config time** — because every template string originates in the config, a new mandatory `TEMPLATE_ENGINE` initialization aspect loads the engine before first render whenever the config contains a delimiter. This **guarantees no raw `{{ … }}` flash**: content/condition rendering is blocked until the engine is present for template-using cards. Cards without templates never load it. ## Result - nunjucks + ha-nunjucks move out of the eager chunk into a separate chunk fetched only when a card actually uses templates. - No change to the synchronous public render API; condition/trigger evaluation core untouched. ## Tests - New `engine.ts` loader coverage (concurrent load, cached reuse, not-loaded fallback). - The 11 existing test files that render real (delimiter-bearing) templates declare their dependency explicitly via `beforeAll(loadTemplateEngine)` — no global/implicit setup hook. - Full suite green (4764 tests), lint and ts-prune clean, per-file 100% coverage maintained for the affected directories. 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_016ykWemdkZrgywvC71pHc6c --- _Generated by [Claude Code](https://claude.ai/code/session_016ykWemdkZrgywvC71pHc6c)_
This commit is contained in:
Dermot Duffy
committed by
dermotduffy
dermotduffy
parent
b33c034810
commit
ea251ca988
@@ -4,6 +4,7 @@ import { mock } from 'vitest-mock-extended';
|
||||
import { FoldersExecutor } from '../../../src/card-controller/folders/executor';
|
||||
import type { HAFoldersEngine } from '../../../src/card-controller/folders/ha/engine';
|
||||
import type { FolderQuery } from '../../../src/card-controller/folders/types';
|
||||
import { TemplateManager } from '../../../src/card-controller/templates';
|
||||
import type { FolderConfig } from '../../../src/config/schema/folders';
|
||||
import { QuerySource } from '../../../src/query-source';
|
||||
import type { Endpoint } from '../../../src/types';
|
||||
@@ -14,6 +15,8 @@ vi.mock('../../../src/card-controller/folders/ha/engine');
|
||||
vi.mock('../../../../src/utils/ha/download');
|
||||
|
||||
describe('FoldersExecutor', () => {
|
||||
const templateManager = new TemplateManager();
|
||||
|
||||
afterEach(() => {
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
@@ -21,7 +24,7 @@ describe('FoldersExecutor', () => {
|
||||
describe('getItemCapabilities', () => {
|
||||
it('should not get capabilities for non-folder media', () => {
|
||||
const item = new TestViewMedia({ folder: null });
|
||||
const executor = new FoldersExecutor();
|
||||
const executor = new FoldersExecutor(templateManager);
|
||||
|
||||
expect(executor.getItemCapabilities(item)).toBeNull();
|
||||
});
|
||||
@@ -31,7 +34,7 @@ describe('FoldersExecutor', () => {
|
||||
type: 'UNKNOWN',
|
||||
} as unknown as FolderConfig;
|
||||
const item = new TestViewMedia({ folder });
|
||||
const executor = new FoldersExecutor();
|
||||
const executor = new FoldersExecutor(templateManager);
|
||||
|
||||
expect(executor.getItemCapabilities(item)).toBeNull();
|
||||
});
|
||||
@@ -47,7 +50,7 @@ describe('FoldersExecutor', () => {
|
||||
const haFolderEngine = mock<HAFoldersEngine>();
|
||||
haFolderEngine.getItemCapabilities.mockReturnValue(capabilities);
|
||||
|
||||
const executor = new FoldersExecutor({
|
||||
const executor = new FoldersExecutor(templateManager, {
|
||||
ha: haFolderEngine,
|
||||
});
|
||||
|
||||
@@ -60,7 +63,7 @@ describe('FoldersExecutor', () => {
|
||||
const folder: FolderConfig = {
|
||||
type: 'UNKNOWN',
|
||||
} as unknown as FolderConfig;
|
||||
const executor = new FoldersExecutor();
|
||||
const executor = new FoldersExecutor(templateManager);
|
||||
|
||||
expect(executor.getDefaultQueryParameters(folder)).toBeNull();
|
||||
});
|
||||
@@ -75,7 +78,7 @@ describe('FoldersExecutor', () => {
|
||||
};
|
||||
haFolderEngine.getDefaultQueryParameters.mockReturnValue(expectedQuery);
|
||||
|
||||
const executor = new FoldersExecutor({
|
||||
const executor = new FoldersExecutor(templateManager, {
|
||||
ha: haFolderEngine,
|
||||
});
|
||||
|
||||
@@ -89,7 +92,7 @@ describe('FoldersExecutor', () => {
|
||||
type: 'UNKNOWN',
|
||||
} as unknown as FolderConfig;
|
||||
const item = new TestViewMedia({ folder });
|
||||
const executor = new FoldersExecutor();
|
||||
const executor = new FoldersExecutor(templateManager);
|
||||
|
||||
expect(await executor.getDownloadPath(createHASS(), item)).toBeNull();
|
||||
});
|
||||
@@ -99,7 +102,7 @@ describe('FoldersExecutor', () => {
|
||||
const haFolderEngine = mock<HAFoldersEngine>();
|
||||
haFolderEngine.getDownloadPath.mockResolvedValue(endpoint);
|
||||
|
||||
const executor = new FoldersExecutor({
|
||||
const executor = new FoldersExecutor(templateManager, {
|
||||
ha: haFolderEngine,
|
||||
});
|
||||
const item = new TestViewMedia({ folder: createFolder() });
|
||||
@@ -113,7 +116,7 @@ describe('FoldersExecutor', () => {
|
||||
type: 'UNKNOWN',
|
||||
} as unknown as FolderConfig;
|
||||
const item = new TestViewMedia({ folder });
|
||||
const executor = new FoldersExecutor();
|
||||
const executor = new FoldersExecutor(templateManager);
|
||||
|
||||
await executor.favorite(createHASS(), item, true);
|
||||
|
||||
@@ -122,7 +125,7 @@ describe('FoldersExecutor', () => {
|
||||
|
||||
it('should favorite', async () => {
|
||||
const haFolderEngine = mock<HAFoldersEngine>();
|
||||
const executor = new FoldersExecutor({
|
||||
const executor = new FoldersExecutor(templateManager, {
|
||||
ha: haFolderEngine,
|
||||
});
|
||||
|
||||
@@ -147,7 +150,7 @@ describe('FoldersExecutor', () => {
|
||||
|
||||
const haFolderEngine = mock<HAFoldersEngine>();
|
||||
haFolderEngine.generateChildFolderQuery.mockReturnValue(query);
|
||||
const executor = new FoldersExecutor({ ha: haFolderEngine });
|
||||
const executor = new FoldersExecutor(templateManager, { ha: haFolderEngine });
|
||||
|
||||
expect(executor.generateChildFolderQuery(query, viewFolder)).toEqual(query);
|
||||
expect(haFolderEngine.generateChildFolderQuery).toBeCalledWith(query, viewFolder);
|
||||
@@ -163,7 +166,7 @@ describe('FoldersExecutor', () => {
|
||||
path: [{ ha: { id: 'media-source://' } }],
|
||||
};
|
||||
const viewFolder = new ViewFolder(folder, []);
|
||||
const executor = new FoldersExecutor();
|
||||
const executor = new FoldersExecutor(templateManager);
|
||||
|
||||
expect(executor.generateChildFolderQuery(query, viewFolder)).toBeNull();
|
||||
});
|
||||
@@ -175,7 +178,7 @@ describe('FoldersExecutor', () => {
|
||||
folder: { type: 'UNKNOWN' },
|
||||
} as unknown as FolderQuery;
|
||||
|
||||
const executor = new FoldersExecutor();
|
||||
const executor = new FoldersExecutor(templateManager);
|
||||
|
||||
expect(await executor.expandFolder(createHASS(), query)).toBeNull();
|
||||
});
|
||||
@@ -197,7 +200,7 @@ describe('FoldersExecutor', () => {
|
||||
const haFolderEngine = mock<HAFoldersEngine>();
|
||||
haFolderEngine.expandFolder.mockResolvedValue([folderItem, mediaItem, folderItem]);
|
||||
|
||||
const executor = new FoldersExecutor({
|
||||
const executor = new FoldersExecutor(templateManager, {
|
||||
ha: haFolderEngine,
|
||||
});
|
||||
const hass = createHASS();
|
||||
@@ -216,7 +219,7 @@ describe('FoldersExecutor', () => {
|
||||
type: 'UNKNOWN',
|
||||
} as unknown as FolderConfig;
|
||||
const query: FolderQuery = { source: QuerySource.Folder, folder, path: [{}] };
|
||||
const executor = new FoldersExecutor();
|
||||
const executor = new FoldersExecutor(templateManager);
|
||||
|
||||
expect(executor.areResultsFresh(new Date(), query)).toBe(true);
|
||||
});
|
||||
@@ -227,7 +230,7 @@ describe('FoldersExecutor', () => {
|
||||
const haFolderEngine = mock<HAFoldersEngine>();
|
||||
haFolderEngine.areResultsFresh.mockReturnValue(false);
|
||||
|
||||
const executor = new FoldersExecutor({
|
||||
const executor = new FoldersExecutor(templateManager, {
|
||||
ha: haFolderEngine,
|
||||
});
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@ import { afterAll, afterEach, beforeAll, describe, expect, it, vi } from 'vitest
|
||||
|
||||
import { HAFoldersEngine } from '../../../../src/card-controller/folders/ha/engine';
|
||||
import type { FolderQuery } from '../../../../src/card-controller/folders/types';
|
||||
import { TemplateManager } from '../../../../src/card-controller/templates';
|
||||
import type { FolderConfig, Matcher } from '../../../../src/config/schema/folders';
|
||||
import { BrowseMediaViewFolder } from '../../../../src/ha/browse-media/item';
|
||||
import { browseMediaSchema } from '../../../../src/ha/browse-media/types';
|
||||
@@ -21,6 +22,8 @@ vi.mock('../../../../src/ha/download');
|
||||
vi.mock('../../../../src/ha/ws-request');
|
||||
|
||||
describe('HAFoldersEngine', () => {
|
||||
const templateManager = new TemplateManager();
|
||||
|
||||
afterEach(() => {
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
@@ -28,7 +31,7 @@ describe('HAFoldersEngine', () => {
|
||||
describe('getItemCapabilities', () => {
|
||||
it('should not be able to download a folder', () => {
|
||||
const item = new ViewFolder(createFolder(), []);
|
||||
const engine = new HAFoldersEngine();
|
||||
const engine = new HAFoldersEngine(templateManager);
|
||||
|
||||
expect(engine.getItemCapabilities(item)).toEqual({
|
||||
canFavorite: false,
|
||||
@@ -38,7 +41,7 @@ describe('HAFoldersEngine', () => {
|
||||
|
||||
it('should be able to download a media item', () => {
|
||||
const item = new TestViewMedia({ folder: createFolder() });
|
||||
const engine = new HAFoldersEngine();
|
||||
const engine = new HAFoldersEngine(templateManager);
|
||||
|
||||
expect(engine.getItemCapabilities(item)).toEqual({
|
||||
canFavorite: false,
|
||||
@@ -50,13 +53,13 @@ describe('HAFoldersEngine', () => {
|
||||
describe('getDownloadPath', () => {
|
||||
it('should return null if item is not a media item', async () => {
|
||||
const item = new ViewFolder(createFolder(), []);
|
||||
const engine = new HAFoldersEngine();
|
||||
const engine = new HAFoldersEngine(templateManager);
|
||||
expect(await engine.getDownloadPath(createHASS(), item)).toBeNull();
|
||||
});
|
||||
|
||||
it('should return a download path for a media item', async () => {
|
||||
const item = new TestViewMedia({ folder: createFolder() });
|
||||
const engine = new HAFoldersEngine();
|
||||
const engine = new HAFoldersEngine(templateManager);
|
||||
|
||||
const endpoint: Endpoint = { endpoint: '/media', sign: false };
|
||||
vi.mocked(getMediaDownloadPath).mockResolvedValue(endpoint);
|
||||
@@ -67,7 +70,7 @@ describe('HAFoldersEngine', () => {
|
||||
|
||||
describe('favorite', () => {
|
||||
it('should favorite', async () => {
|
||||
const engine = new HAFoldersEngine();
|
||||
const engine = new HAFoldersEngine(templateManager);
|
||||
const item = new TestViewMedia({ folder: createFolder() });
|
||||
|
||||
await engine.favorite(createHASS(), item, true);
|
||||
@@ -81,14 +84,14 @@ describe('HAFoldersEngine', () => {
|
||||
const folder: FolderConfig = {
|
||||
type: 'UNKNOWN',
|
||||
} as unknown as FolderConfig;
|
||||
const engine = new HAFoldersEngine();
|
||||
const engine = new HAFoldersEngine(templateManager);
|
||||
|
||||
expect(engine.getDefaultQueryParameters(folder)).toBeNull();
|
||||
});
|
||||
|
||||
it('should return default query parameters for ha folder config', () => {
|
||||
const folder = createFolder();
|
||||
const engine = new HAFoldersEngine();
|
||||
const engine = new HAFoldersEngine(templateManager);
|
||||
|
||||
expect(engine.getDefaultQueryParameters(folder)).toEqual({
|
||||
source: QuerySource.Folder,
|
||||
@@ -104,7 +107,7 @@ describe('HAFoldersEngine', () => {
|
||||
source: QuerySource.Folder,
|
||||
folder: { type: 'UNKNOWN' },
|
||||
} as unknown as FolderQuery;
|
||||
const engine = new HAFoldersEngine();
|
||||
const engine = new HAFoldersEngine(templateManager);
|
||||
|
||||
expect(await engine.expandFolder(createHASS(), query)).toBeNull();
|
||||
});
|
||||
@@ -134,7 +137,7 @@ describe('HAFoldersEngine', () => {
|
||||
}),
|
||||
);
|
||||
|
||||
const engine = new HAFoldersEngine();
|
||||
const engine = new HAFoldersEngine(templateManager);
|
||||
const results = await engine.expandFolder(createHASS(), query);
|
||||
expect(results?.length).toBe(2);
|
||||
expect(results?.[0]).toBeInstanceOf(ViewMedia);
|
||||
@@ -174,7 +177,7 @@ describe('HAFoldersEngine', () => {
|
||||
)
|
||||
.mockResolvedValueOnce([]);
|
||||
|
||||
const engine = new HAFoldersEngine();
|
||||
const engine = new HAFoldersEngine(templateManager);
|
||||
const results = await engine.expandFolder(
|
||||
createHASS(),
|
||||
query,
|
||||
@@ -219,7 +222,7 @@ describe('HAFoldersEngine', () => {
|
||||
);
|
||||
|
||||
const hass = createHASS();
|
||||
const engine = new HAFoldersEngine();
|
||||
const engine = new HAFoldersEngine(templateManager);
|
||||
await engine.expandFolder(hass, query);
|
||||
|
||||
expect(homeAssistantWSRequest).toBeCalledWith(hass, browseMediaSchema, {
|
||||
@@ -235,7 +238,7 @@ describe('HAFoldersEngine', () => {
|
||||
// There's no component in the query with an id to start from.
|
||||
path: [{ ha: {} }],
|
||||
};
|
||||
const engine = new HAFoldersEngine();
|
||||
const engine = new HAFoldersEngine(templateManager);
|
||||
expect(await engine.expandFolder(createHASS(), query)).toBeNull();
|
||||
});
|
||||
|
||||
@@ -264,7 +267,7 @@ describe('HAFoldersEngine', () => {
|
||||
}),
|
||||
);
|
||||
|
||||
const engine = new HAFoldersEngine();
|
||||
const engine = new HAFoldersEngine(templateManager);
|
||||
const results = await engine.expandFolder(createHASS(), query);
|
||||
|
||||
// Even though there are 2 children, the limit of 1 should trigger earlyExit.
|
||||
@@ -329,7 +332,7 @@ describe('HAFoldersEngine', () => {
|
||||
}),
|
||||
);
|
||||
|
||||
const engine = new HAFoldersEngine();
|
||||
const engine = new HAFoldersEngine(templateManager);
|
||||
const results = await engine.expandFolder(createHASS(), query);
|
||||
expect(results?.length).toBe(expectedMatches);
|
||||
});
|
||||
@@ -338,7 +341,7 @@ describe('HAFoldersEngine', () => {
|
||||
|
||||
describe('generateChildFolderQuery', () => {
|
||||
it('should return null if folder type is not ha', () => {
|
||||
const engine = new HAFoldersEngine();
|
||||
const engine = new HAFoldersEngine(templateManager);
|
||||
const query: FolderQuery = {
|
||||
source: QuerySource.Folder,
|
||||
folder: { type: 'other' } as unknown as FolderConfig,
|
||||
@@ -350,7 +353,7 @@ describe('HAFoldersEngine', () => {
|
||||
});
|
||||
|
||||
it('should return null if folder has no id', () => {
|
||||
const engine = new HAFoldersEngine();
|
||||
const engine = new HAFoldersEngine(templateManager);
|
||||
const query: FolderQuery = {
|
||||
source: QuerySource.Folder,
|
||||
folder: { type: 'ha', id: 'test' },
|
||||
@@ -362,7 +365,7 @@ describe('HAFoldersEngine', () => {
|
||||
});
|
||||
|
||||
it('should extend query with configured component', () => {
|
||||
const engine = new HAFoldersEngine();
|
||||
const engine = new HAFoldersEngine(templateManager);
|
||||
const folderConfig: FolderConfig = {
|
||||
type: 'ha',
|
||||
id: 'test',
|
||||
@@ -393,7 +396,7 @@ describe('HAFoldersEngine', () => {
|
||||
});
|
||||
|
||||
it('should extend query with default component when no configuration exists', () => {
|
||||
const engine = new HAFoldersEngine();
|
||||
const engine = new HAFoldersEngine(templateManager);
|
||||
const folderConfig: FolderConfig = { type: 'ha', id: 'test' };
|
||||
const query: FolderQuery = {
|
||||
source: QuerySource.Folder,
|
||||
@@ -431,7 +434,7 @@ describe('HAFoldersEngine', () => {
|
||||
const now = new Date('2026-01-02T07:54:32Z');
|
||||
vi.setSystemTime(now);
|
||||
|
||||
const engine = new HAFoldersEngine();
|
||||
const engine = new HAFoldersEngine(templateManager);
|
||||
const query = { folder: { type: 'ha' } } as FolderQuery;
|
||||
const resultsTimestamp = new Date('2026-01-02T07:54:30Z');
|
||||
|
||||
@@ -442,7 +445,7 @@ describe('HAFoldersEngine', () => {
|
||||
const now = new Date('2026-01-02T07:54:32Z');
|
||||
vi.setSystemTime(now);
|
||||
|
||||
const engine = new HAFoldersEngine();
|
||||
const engine = new HAFoldersEngine(templateManager);
|
||||
const query = { folder: { type: 'ha' } } as FolderQuery;
|
||||
const resultsTimestamp = new Date('2026-01-02T07:53:30Z');
|
||||
|
||||
|
||||
@@ -1,18 +1,20 @@
|
||||
import { sub } from 'date-fns';
|
||||
import { renderTemplate } from 'ha-nunjucks';
|
||||
import { describe, expect, it, vi } from 'vitest';
|
||||
import { beforeAll, describe, expect, it } from 'vitest';
|
||||
|
||||
import { MediaMatcher } from '../../../../src/card-controller/folders/ha/media-matcher';
|
||||
import { TemplateManager } from '../../../../src/card-controller/templates';
|
||||
import type { Matcher } from '../../../../src/config/schema/folders';
|
||||
import type {
|
||||
BrowseMediaMetadata,
|
||||
RichBrowseMedia,
|
||||
} from '../../../../src/ha/browse-media/types';
|
||||
import { createHASS } from '../../../test-utils';
|
||||
|
||||
vi.mock('ha-nunjucks');
|
||||
import { createHASS, createMockTemplateRenderer } from '../../../test-utils';
|
||||
|
||||
describe('MediaMatcher', () => {
|
||||
// A mock renderer for the matcher plumbing, which never renders templates.
|
||||
// The `value_template` suite below uses its own real, loaded engine.
|
||||
const templateManager = createMockTemplateRenderer();
|
||||
|
||||
describe('match', () => {
|
||||
const createMediaItem = (
|
||||
title: string,
|
||||
@@ -29,7 +31,7 @@ describe('MediaMatcher', () => {
|
||||
});
|
||||
|
||||
it('should return false if foldersOnly is true and media.can_expand is false', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Test File');
|
||||
expect(
|
||||
mediaMatcher.match(createHASS(), media, { matchers: [], foldersOnly: true }),
|
||||
@@ -37,7 +39,7 @@ describe('MediaMatcher', () => {
|
||||
});
|
||||
|
||||
it('should return true if foldersOnly is true and media.can_expand is true', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Test Folder', true, 'directory');
|
||||
expect(
|
||||
mediaMatcher.match(createHASS(), media, { matchers: [], foldersOnly: true }),
|
||||
@@ -45,13 +47,13 @@ describe('MediaMatcher', () => {
|
||||
});
|
||||
|
||||
it('should return true if matchers array is empty', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Test Media');
|
||||
expect(mediaMatcher.match(createHASS(), media, { matchers: [] })).toBe(true);
|
||||
});
|
||||
|
||||
it('should return true if matchers array is undefined', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Test Media');
|
||||
expect(mediaMatcher.match(createHASS(), media, { matchers: undefined })).toBe(
|
||||
true,
|
||||
@@ -60,21 +62,21 @@ describe('MediaMatcher', () => {
|
||||
|
||||
describe('with title matcher', () => {
|
||||
it('should return true when title matches exactly', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Exact Title');
|
||||
const matchers: Matcher[] = [{ type: 'title', title: 'Exact Title' }];
|
||||
expect(mediaMatcher.match(createHASS(), media, { matchers })).toBe(true);
|
||||
});
|
||||
|
||||
it('should return false when title does not match exactly', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('DOES NOT MATCH');
|
||||
const matchers: Matcher[] = [{ type: 'title', title: 'Exact Title' }];
|
||||
expect(mediaMatcher.match(createHASS(), media, { matchers })).toBe(false);
|
||||
});
|
||||
|
||||
it('should return true when title matches regexp and extracted value matches matcher.title', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Prefix-ImportantPart-Suffix');
|
||||
const matchers: Matcher[] = [
|
||||
{
|
||||
@@ -87,7 +89,7 @@ describe('MediaMatcher', () => {
|
||||
});
|
||||
|
||||
it('should return false when title matches regexp but extracted value does not match matcher.title', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Prefix-ImportantPart-Suffix');
|
||||
const matchers: Matcher[] = [
|
||||
{
|
||||
@@ -100,7 +102,7 @@ describe('MediaMatcher', () => {
|
||||
});
|
||||
|
||||
it('should return true when title matches regexp with an explicit title value', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Prefix-ImportantPart-Suffix');
|
||||
const matchers: Matcher[] = [
|
||||
{
|
||||
@@ -113,7 +115,7 @@ describe('MediaMatcher', () => {
|
||||
});
|
||||
|
||||
it('should return false when title does not match regexp', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Unrelated Title');
|
||||
const matchers: Matcher[] = [
|
||||
{
|
||||
@@ -126,7 +128,7 @@ describe('MediaMatcher', () => {
|
||||
});
|
||||
|
||||
it('should return false when regexp is provided but does not extract the required group', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Prefix-ImportantPart-Suffix');
|
||||
const matchers: Matcher[] = [
|
||||
{
|
||||
@@ -139,7 +141,7 @@ describe('MediaMatcher', () => {
|
||||
});
|
||||
|
||||
it('should return true when no regexp and no matcher.title (matches any title)', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Any Title Will Do');
|
||||
const matchers: Matcher[] = [{ type: 'title' }];
|
||||
expect(mediaMatcher.match(createHASS(), media, { matchers })).toBe(true);
|
||||
@@ -147,42 +149,16 @@ describe('MediaMatcher', () => {
|
||||
});
|
||||
|
||||
describe('with template matcher', () => {
|
||||
it('should return true when template value matches', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const title = 'Any Title Will Do';
|
||||
const media = createMediaItem(title);
|
||||
|
||||
vi.mocked(renderTemplate).mockReturnValue(true);
|
||||
|
||||
const matchers: Matcher[] = [
|
||||
{
|
||||
type: 'template',
|
||||
value_template: '{{ acc.media.title == "Any Title Will Do" }}',
|
||||
},
|
||||
];
|
||||
const hass = createHASS();
|
||||
expect(mediaMatcher.match(hass, media, { matchers })).toBe(true);
|
||||
|
||||
expect(renderTemplate).toHaveBeenCalledWith(
|
||||
hass,
|
||||
'{{ acc.media.title == "Any Title Will Do" }}',
|
||||
{
|
||||
acc: {
|
||||
media: {
|
||||
title,
|
||||
is_folder: false,
|
||||
},
|
||||
},
|
||||
},
|
||||
);
|
||||
// These matchers render, so use a real engine loaded for the synchronous
|
||||
// renderer (rather than the shared mock).
|
||||
const templateManager = new TemplateManager();
|
||||
beforeAll(async () => {
|
||||
await templateManager.loadRenderer();
|
||||
});
|
||||
|
||||
it('should return false when template value does not match', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const title = 'Any Title Will Do';
|
||||
const media = createMediaItem(title);
|
||||
|
||||
vi.mocked(renderTemplate).mockReturnValue(false);
|
||||
it('should return true when template value renders to true', () => {
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Any Title Will Do');
|
||||
|
||||
const matchers: Matcher[] = [
|
||||
{
|
||||
@@ -190,27 +166,39 @@ describe('MediaMatcher', () => {
|
||||
value_template: '{{ acc.media.title == "Any Title Will Do" }}',
|
||||
},
|
||||
];
|
||||
const hass = createHASS();
|
||||
expect(mediaMatcher.match(hass, media, { matchers })).toBe(false);
|
||||
expect(mediaMatcher.match(createHASS(), media, { matchers })).toBe(true);
|
||||
});
|
||||
|
||||
expect(renderTemplate).toHaveBeenCalledWith(
|
||||
hass,
|
||||
'{{ acc.media.title == "Any Title Will Do" }}',
|
||||
it('should return true when template reads the is_folder media value', () => {
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Test Folder', true, 'directory');
|
||||
|
||||
const matchers: Matcher[] = [
|
||||
{
|
||||
acc: {
|
||||
media: {
|
||||
title,
|
||||
is_folder: false,
|
||||
},
|
||||
},
|
||||
type: 'template',
|
||||
value_template: '{{ acc.media.is_folder }}',
|
||||
},
|
||||
);
|
||||
];
|
||||
expect(mediaMatcher.match(createHASS(), media, { matchers })).toBe(true);
|
||||
});
|
||||
|
||||
it('should return false when template value renders to false', () => {
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Any Title Will Do');
|
||||
|
||||
const matchers: Matcher[] = [
|
||||
{
|
||||
type: 'template',
|
||||
value_template: '{{ acc.media.title == "Some Other Title" }}',
|
||||
},
|
||||
];
|
||||
expect(mediaMatcher.match(createHASS(), media, { matchers })).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('with or matcher', () => {
|
||||
it('should return true if at least one sub-matcher matches', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Test Media');
|
||||
const matcher: Matcher = {
|
||||
type: 'or',
|
||||
@@ -225,7 +213,7 @@ describe('MediaMatcher', () => {
|
||||
});
|
||||
|
||||
it('should return false if no sub-matcher matches', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Test Media');
|
||||
const matcher: Matcher = {
|
||||
type: 'or',
|
||||
@@ -242,7 +230,7 @@ describe('MediaMatcher', () => {
|
||||
|
||||
describe('with date matcher', () => {
|
||||
it('should not match without metadata', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Test Media');
|
||||
const matcher: Matcher = {
|
||||
type: 'date',
|
||||
@@ -279,7 +267,7 @@ describe('MediaMatcher', () => {
|
||||
},
|
||||
],
|
||||
])('should match with date more recent than matcher %s', (matcher: Matcher) => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Test Media');
|
||||
media._metadata = {
|
||||
startDate: sub(new Date(), { days: 1 }),
|
||||
@@ -290,7 +278,7 @@ describe('MediaMatcher', () => {
|
||||
});
|
||||
|
||||
it('should not match with date less recent than matcher', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Test Media');
|
||||
media._metadata = {
|
||||
startDate: sub(new Date(), { days: 2 }),
|
||||
@@ -306,7 +294,7 @@ describe('MediaMatcher', () => {
|
||||
});
|
||||
|
||||
it('should return false if one of multiple matchers fails', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Test Media One');
|
||||
const matchers: Matcher[] = [
|
||||
{ type: 'title', title: 'Test Media One' }, // Pass
|
||||
@@ -316,7 +304,7 @@ describe('MediaMatcher', () => {
|
||||
});
|
||||
|
||||
it('should return true if all multiple matchers pass', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Test Media One');
|
||||
const matchers: Matcher[] = [
|
||||
{ type: 'title', title: 'Test Media One' },
|
||||
@@ -330,7 +318,7 @@ describe('MediaMatcher', () => {
|
||||
});
|
||||
|
||||
it('should ignore matchers of unknown types', () => {
|
||||
const mediaMatcher = new MediaMatcher();
|
||||
const mediaMatcher = new MediaMatcher(templateManager);
|
||||
const media = createMediaItem('Test Media');
|
||||
|
||||
const matchers: Matcher[] = [{ type: 'unknownMatcherType' as 'title' }];
|
||||
|
||||
Reference in New Issue
Block a user