Skip to content
Merged
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
6 changes: 3 additions & 3 deletions packages/angular/build/src/utils/normalize-asset-patterns.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,11 @@ export function normalizeAssetPatterns(
let root: string;

// Check if the string asset is within sourceRoot.
if (resolvedAssetPath.startsWith(resolvedSourceRoot)) {
if (isSubDirectory(resolvedSourceRoot, resolvedAssetPath)) {
root = resolvedSourceRoot;
} else if (resolvedAssetPath.startsWith(resolvedProjectRoot)) {
} else if (isSubDirectory(resolvedProjectRoot, resolvedAssetPath)) {
root = resolvedProjectRoot;
} else if (resolvedAssetPath.startsWith(resolvedWorkspaceRoot)) {
} else if (isSubDirectory(resolvedWorkspaceRoot, resolvedAssetPath)) {
root = resolvedWorkspaceRoot;
} else {
throw new Error(`The ${assetPattern} asset path must be within the workspace root.`);
Expand Down
169 changes: 169 additions & 0 deletions packages/angular/build/src/utils/normalize-asset-patterns_spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.dev/license
*/

import assert from 'node:assert';
import { mkdir, mkdtemp, rm, writeFile } from 'node:fs/promises';
import path, { join } from 'node:path';
import { normalizeAssetPatterns } from './normalize-asset-patterns';
import { resolveAssets } from './resolve-assets';

describe('normalizeAssetPatterns', () => {
let tempRoot: string;

beforeEach(async () => {
const baseTmpDir = process.env['TEST_TMPDIR'];
assert(baseTmpDir, 'TEST_TMPDIR is not set');
tempRoot = await mkdtemp(join(baseTmpDir, 'angular-cli-assets-test-'));
});

afterEach(async () => {
if (tempRoot) {
await rm(tempRoot, { recursive: true, force: true });
}
});

it('should return an empty array when given no asset patterns', () => {
expect(normalizeAssetPatterns([], tempRoot, '', 'src')).toEqual([]);
});

it('should normalize a string asset within sourceRoot relative to sourceRoot', async () => {
await mkdir(join(tempRoot, 'src/assets'), { recursive: true });
await writeFile(join(tempRoot, 'src/assets/logo.png'), 'PNG');

const result = normalizeAssetPatterns(
['src/assets', 'src/assets/logo.png'],
tempRoot,
'',
'src',
);

expect(result).toEqual([
{ glob: '**/*', input: 'src/assets', output: 'assets' },
{ glob: 'logo.png', input: 'src/assets', output: 'assets' },
]);
});

it('should normalize a string asset in a sibling directory sharing a prefix with sourceRoot (e.g. src-assets)', async () => {
await mkdir(join(tempRoot, 'src-assets'), { recursive: true });
await writeFile(join(tempRoot, 'src-assets/logo.png'), 'PNG');

const result = normalizeAssetPatterns(
['src-assets', 'src-assets/logo.png'],
tempRoot,
'',
'src',
);

expect(result).toEqual([
{ glob: '**/*', input: 'src-assets', output: 'src-assets' },
{ glob: 'logo.png', input: 'src-assets', output: 'src-assets' },
]);
});

it('should normalize a library string asset in a sibling directory sharing a prefix with projectSourceRoot', async () => {
await mkdir(join(tempRoot, 'projects/lib/src-assets'), { recursive: true });
await writeFile(join(tempRoot, 'projects/lib/src-assets/logo.png'), 'PNG');

const result = normalizeAssetPatterns(
['projects/lib/src-assets', 'projects/lib/src-assets/logo.png'],
tempRoot,
'projects/lib',
'projects/lib/src',
);

expect(result).toEqual([
{
glob: '**/*',
input: path.normalize('projects/lib/src-assets'),
output: 'src-assets',
},
{
glob: 'logo.png',
input: path.normalize('projects/lib/src-assets'),
output: 'src-assets',
},
]);
});

it('should normalize a string asset in a sibling directory sharing a prefix with projectRoot relative to workspaceRoot', async () => {
await mkdir(join(tempRoot, 'projects/lib-shared'), { recursive: true });
await writeFile(join(tempRoot, 'projects/lib-shared/logo.png'), 'PNG');

const result = normalizeAssetPatterns(
['projects/lib-shared/logo.png'],
tempRoot,
'projects/lib',
'projects/lib/src',
);

expect(result).toEqual([
{
glob: 'logo.png',
input: path.normalize('projects/lib-shared'),
output: path.normalize('projects/lib-shared'),
},
]);
});

it('should throw when a string asset is in a sibling directory sharing a prefix with workspaceRoot', () => {
const siblingDir = `../${path.basename(tempRoot)}-outside/logo.png`;

expect(() => normalizeAssetPatterns([siblingDir], tempRoot, '', 'src')).toThrowError(
/asset path must be within the workspace root/,
);
});
});

describe('resolveAssets', () => {
let tempRoot: string;

beforeEach(async () => {
const baseTmpDir = process.env['TEST_TMPDIR'];
assert(baseTmpDir, 'TEST_TMPDIR is not set');
tempRoot = await mkdtemp(join(baseTmpDir, 'angular-cli-resolve-assets-test-'));
});

afterEach(async () => {
if (tempRoot) {
await rm(tempRoot, { recursive: true, force: true });
}
});

it('should ignore both root and nested .gitkeep files by default', async () => {
await mkdir(join(tempRoot, 'src/assets/nested/deep'), { recursive: true });
await writeFile(join(tempRoot, 'src/assets/.gitkeep'), '');
await writeFile(join(tempRoot, 'src/assets/nested/.gitkeep'), '');
await writeFile(join(tempRoot, 'src/assets/nested/deep/.gitkeep'), '');
await writeFile(join(tempRoot, 'src/assets/nested/deep/logo.png'), 'PNG');

const resolved = await resolveAssets(
[{ glob: '**/*', input: 'src/assets', output: 'assets' }],
tempRoot,
);

expect(resolved).toEqual([
{
source: join(tempRoot, 'src/assets/nested/deep/logo.png'),
destination: join('assets', 'nested/deep/logo.png'),
},
]);
});

it('should throw when a resolved destination escapes the output root via ".." in glob', async () => {
await mkdir(join(tempRoot, 'src'), { recursive: true });
await writeFile(join(tempRoot, 'outside.txt'), 'secret');

await expectAsync(
resolveAssets([{ glob: '../outside.txt', input: 'src', output: '.' }], tempRoot),
).toBeRejectedWithError('An asset cannot be written to a location outside of the output path.');

await expectAsync(
resolveAssets([{ glob: '../*.txt', input: 'src', output: '.' }], tempRoot),
).toBeRejectedWithError('An asset cannot be written to a location outside of the output path.');
});
});
17 changes: 12 additions & 5 deletions packages/angular/build/src/utils/resolve-assets.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import { isSubDirectory } from './path';
/**
* Default glob ignore patterns for assets.
*/
export const DEFAULT_ASSET_IGNORE = ['.gitkeep', '**/.DS_Store', '**/Thumbs.db'] as const;
export const DEFAULT_ASSET_IGNORE = ['**/.gitkeep', '**/.DS_Store', '**/Thumbs.db'] as const;

export async function resolveAssets(
entries: {
Expand Down Expand Up @@ -63,10 +63,17 @@ export async function resolveAssets(
followSymbolicLinks: entry.followSymlinks ?? false,
});

return files.map((file) => ({
source: path.join(cwd, file),
destination: path.join(entry.output, entry.flatten ? path.basename(file) : file),
}));
return files.map((file) => {
const destination = path.join(entry.output, entry.flatten ? path.basename(file) : file);
if (destination === '..' || destination.startsWith(`..${path.sep}`)) {
throw new Error('An asset cannot be written to a location outside of the output path.');
}

return {
source: path.join(cwd, file),
destination,
};
});
});

return resolvedEntries.flat();
Expand Down
Loading