Skip to content

Commit

Permalink
Clean sourcemaps from static output (#12749)
Browse files Browse the repository at this point in the history
* Clean sourcemaps from static output

* Add changeset

* Update test to look at frontend sourcemaps
  • Loading branch information
matthewp authored Dec 16, 2024
1 parent d891d5d commit 039d022
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 13 deletions.
5 changes: 5 additions & 0 deletions .changeset/tame-spoons-shop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'astro': patch
---

Clean server sourcemaps from static output
5 changes: 3 additions & 2 deletions packages/astro/src/core/build/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -205,15 +205,16 @@ class AstroBuilder {
key: keyPromise,
};

const { internals, ssrOutputChunkNames, contentFileNames } = await viteBuild(opts);
const { internals, ssrOutputChunkNames } =
await viteBuild(opts);

const hasServerIslands = this.settings.serverIslandNameMap.size > 0;
// Error if there are server islands but no adapter provided.
if (hasServerIslands && this.settings.buildOutput !== 'server') {
throw new AstroError(AstroErrorData.NoAdapterInstalledServerIslands);
}

await staticBuild(opts, internals, ssrOutputChunkNames, contentFileNames);
await staticBuild(opts, internals, ssrOutputChunkNames);

// Write any additionally generated assets to disk.
this.timer.assetsStart = performance.now();
Expand Down
18 changes: 10 additions & 8 deletions packages/astro/src/core/build/static-build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,6 @@ export async function viteBuild(opts: StaticBuildOptions) {
const ssrOutputs = viteBuildReturnToRollupOutputs(ssrOutput);
const clientOutputs = viteBuildReturnToRollupOutputs(clientOutput ?? []);
await runPostBuildHooks(container, ssrOutputs, clientOutputs);
let contentFileNames: string[] | undefined = undefined;
settings.timer.end('Client build');

// Free up memory
Expand All @@ -112,20 +111,19 @@ export async function viteBuild(opts: StaticBuildOptions) {
}
}

return { internals, ssrOutputChunkNames, contentFileNames };
return { internals, ssrOutputChunkNames };
}

export async function staticBuild(
opts: StaticBuildOptions,
internals: BuildInternals,
ssrOutputChunkNames: string[],
contentFileNames?: string[],
) {
const { settings } = opts;
if (settings.buildOutput === 'static') {
settings.timer.start('Static generate');
await generatePages(opts, internals);
await cleanServerOutput(opts, ssrOutputChunkNames, contentFileNames, internals);
await cleanServerOutput(opts, ssrOutputChunkNames, internals);
settings.timer.end('Static generate');
} else if (settings.buildOutput === 'server') {
settings.timer.start('Server generate');
Expand Down Expand Up @@ -354,14 +352,12 @@ async function cleanStaticOutput(opts: StaticBuildOptions, internals: BuildInter
async function cleanServerOutput(
opts: StaticBuildOptions,
ssrOutputChunkNames: string[],
contentFileNames: string[] | undefined,
internals: BuildInternals,
) {
const out = getOutDirWithinCwd(opts.settings.config.outDir);
// The SSR output chunks for Astro are all .mjs files
const files = ssrOutputChunkNames
.filter((f) => f.endsWith('.mjs'))
.concat(contentFileNames ?? []);
.filter((f) => f.endsWith('.mjs'));
if (internals.manifestFileName) {
files.push(internals.manifestFileName);
}
Expand All @@ -370,7 +366,11 @@ async function cleanServerOutput(
await Promise.all(
files.map(async (filename) => {
const url = new URL(filename, out);
await fs.promises.rm(url);
const map = new URL(url + '.map');
await Promise.all([
fs.promises.rm(url),
fs.promises.rm(new URL(map)).catch((e) => {})
]);
}),
);

Expand Down Expand Up @@ -426,6 +426,8 @@ async function ssrMoveAssets(opts: StaticBuildOptions) {
cwd: fileURLToPath(serverAssets),
});

console.log("FILES2", files);

if (files.length > 0) {
await Promise.all(
files.map(async function moveAsset(filename) {
Expand Down
8 changes: 8 additions & 0 deletions packages/astro/test/astro-basic.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,14 @@ describe('Astro basic build', () => {
assert.doesNotMatch(otherHtml, /<style/);
});

it('server sourcemaps not included in output', async () => {
const files = await fixture.readdir('/');
const hasSourcemaps = files.some(fileName => {
return fileName.endsWith('.map');
});
assert.equal(hasSourcemaps, false, 'no sourcemap files in output');
});

describe('preview', () => {
it('returns 200 for valid URLs', async () => {
const result = await fixture.fetch('/');
Expand Down
7 changes: 6 additions & 1 deletion packages/astro/test/fixtures/astro-basic/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,10 @@ import { defineConfig } from 'astro/config';
export default defineConfig({
integrations: [preact(), mdx()],
// make sure CLI flags have precedence
server: () => ({ port: 4321 })
server: () => ({ port: 4321 }),
vite: {
build: {
sourcemap: true,
}
}
});
10 changes: 8 additions & 2 deletions packages/astro/test/sourcemap.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,13 @@ describe('Sourcemap', async () => {
});

it('Builds non-empty sourcemap', async () => {
const map = await fixture.readFile('renderers.mjs.map');
assert.equal(map.includes('"sources":[]'), false);
const assets = await fixture.readdir('/_astro');
const maps = assets.filter(file => file.endsWith('.map'));
assert.ok(maps.length > 0, 'got source maps');
for(const mapName of maps) {
const filename = `/_astro/${mapName}`;
const map = await fixture.readFile(filename);
assert.equal(map.includes('"sources":[]'), false);
}
});
});

0 comments on commit 039d022

Please sign in to comment.