msb-public
/
svelte
mirror of https://github.com/sveltejs/svelte
1
0
Code Issues Projects Releases Wiki Activity

Convert src/compiler/utils/mapped_code.ts to JavaScript

Browse Source
pull/8569/head
Simon Holthausen 3 years ago
parent e86fb16402
commit b684833126
1 changed files with 352 additions and 329 deletions
Show Stats Download Patch File Download Diff File

271
src/compiler/utils/mapped_code.ts
Unescape View File

@ -1,25 +1,22 @@
import type { DecodedSourceMap, RawSourceMap, SourceMapLoader } from '@ampproject/remapping';
import remapping from '@ampproject/remapping'; import remapping from '@ampproject/remapping';
import { SourceMap } from 'magic-string'; import { push_array } from './push_array.js';
import { Source, Processed } from '../preprocess/types';
import { push_array } from './push_array';
export type SourceLocation = { /**
line: number; * @param {string} s
column: number; */
}; function last_line_length(s) {
function last_line_length(s: string) {
return s.length - s.lastIndexOf('\n') - 1; return s.length - s.lastIndexOf('\n') - 1;
} }
// mutate map in-place // mutate map in-place
export function sourcemap_add_offset(
map: DecodedSourceMap, /**
offset: SourceLocation, * @param {DecodedSourceMap} map
source_index: number * @param {SourceLocation} offset
) { * @param {number} source_index
if (map.mappings.length == 0) return; */
export function sourcemap_add_offset(map, offset, source_index) {
if (map.mappings.length == 0)
return;
for (let line = 0; line < map.mappings.length; line++) { for (let line = 0; line < map.mappings.length; line++) {
const segment_list = map.mappings[line]; const segment_list = map.mappings[line];
for (let segment = 0; segment < segment_list.length; segment++) { for (let segment = 0; segment < segment_list.length; segment++) {
@ -38,7 +35,12 @@ export function sourcemap_add_offset(
} }
} }
function merge_tables<T>(this_table: T[], other_table: T[]): [T[], number[], boolean, boolean] { /**
* @param {T[]} this_table
* @param {T[]} other_table
* @returns {[T[], number[], boolean, boolean]}
*/
function merge_tables(this_table, other_table) {
const new_table = this_table.slice(); const new_table = this_table.slice();
const idx_map = []; const idx_map = [];
other_table = other_table || []; other_table = other_table || [];
@ -47,7 +49,8 @@ function merge_tables<T>(this_table: T[], other_table: T[]): [T[], number[], boo
const this_idx = this_table.indexOf(other_val); const this_idx = this_table.indexOf(other_val);
if (this_idx >= 0) { if (this_idx >= 0) {
idx_map[other_idx] = this_idx; idx_map[other_idx] = this_idx;
} else { }
else {
const new_idx = new_table.length; const new_idx = new_table.length;
new_table[new_idx] = other_val; new_table[new_idx] = other_val;
idx_map[other_idx] = new_idx; idx_map[other_idx] = new_idx;
@ -63,18 +66,25 @@ function merge_tables<T>(this_table: T[], other_table: T[]): [T[], number[], boo
} }
return [new_table, idx_map, val_changed, idx_changed]; return [new_table, idx_map, val_changed, idx_changed];
} }
const regex_line_token = /([^\d\w\s]|\s+)/g; const regex_line_token = /([^\d\w\s]|\s+)/g;
/** */
export class MappedCode { export class MappedCode {
string: string;
map: DecodedSourceMap;
constructor(string = '', map: DecodedSourceMap = null) { /**
* @type {string}
*/
string = undefined;
/**
* @type {DecodedSourceMap}
*/
map = undefined;
constructor(string = '', map = null) {
this.string = string; this.string = string;
if (map) { if (map) {
this.map = map as DecodedSourceMap; this.map = map;
} else { }
else {
this.map = { this.map = {
version: 3, version: 3,
mappings: [], mappings: [],
@ -83,97 +93,94 @@ export class MappedCode {
}; };
} }
} }
/** /**
* concat in-place (mutable), return this (chainable) * concat in-place (mutable), return this (chainable)
* will also mutate the `other` object * will also mutate the `other` object
* @param {MappedCode} other
* @returns {import("C:/repos/svelte/svelte/mapped_code.ts-to-jsdoc").MappedCode}
*/ */
concat(other: MappedCode): MappedCode { concat(other) {
// noop: if one is empty, return the other // noop: if one is empty, return the other
if (other.string == '') return this; if (other.string == '')
return this;
if (this.string == '') { if (this.string == '') {
this.string = other.string; this.string = other.string;
this.map = other.map; this.map = other.map;
return this; return this;
} }
// compute last line length before mutating // compute last line length before mutating
const column_offset = last_line_length(this.string); const column_offset = last_line_length(this.string);
this.string += other.string; this.string += other.string;
const m1 = this.map; const m1 = this.map;
const m2 = other.map; const m2 = other.map;
if (m2.mappings.length == 0)
if (m2.mappings.length == 0) return this; return this;
// combine sources and names // combine sources and names
const [sources, new_source_idx, sources_changed, sources_idx_changed] = merge_tables( const [sources, new_source_idx, sources_changed, sources_idx_changed] = merge_tables(m1.sources, m2.sources);
m1.sources, const [names, new_name_idx, names_changed, names_idx_changed] = merge_tables(m1.names, m2.names);
m2.sources if (sources_changed)
); m1.sources = sources;
const [names, new_name_idx, names_changed, names_idx_changed] = merge_tables( if (names_changed)
m1.names, m1.names = names;
m2.names
);
if (sources_changed) m1.sources = sources;
if (names_changed) m1.names = names;
// unswitched loops are faster // unswitched loops are faster
if (sources_idx_changed && names_idx_changed) { if (sources_idx_changed && names_idx_changed) {
for (let line = 0; line < m2.mappings.length; line++) { for (let line = 0; line < m2.mappings.length; line++) {
const segment_list = m2.mappings[line]; const segment_list = m2.mappings[line];
for (let segment = 0; segment < segment_list.length; segment++) { for (let segment = 0; segment < segment_list.length; segment++) {
const seg = segment_list[segment]; const seg = segment_list[segment];
if (seg[1] >= 0) seg[1] = new_source_idx[seg[1]]; if (seg[1] >= 0)
if (seg[4] >= 0) seg[4] = new_name_idx[seg[4]]; seg[1] = new_source_idx[seg[1]];
if (seg[4] >= 0)
seg[4] = new_name_idx[seg[4]];
}
} }
} }
} else if (sources_idx_changed) { else if (sources_idx_changed) {
for (let line = 0; line < m2.mappings.length; line++) { for (let line = 0; line < m2.mappings.length; line++) {
const segment_list = m2.mappings[line]; const segment_list = m2.mappings[line];
for (let segment = 0; segment < segment_list.length; segment++) { for (let segment = 0; segment < segment_list.length; segment++) {
const seg = segment_list[segment]; const seg = segment_list[segment];
if (seg[1] >= 0) seg[1] = new_source_idx[seg[1]]; if (seg[1] >= 0)
seg[1] = new_source_idx[seg[1]];
} }
} }
} else if (names_idx_changed) { }
else if (names_idx_changed) {
for (let line = 0; line < m2.mappings.length; line++) { for (let line = 0; line < m2.mappings.length; line++) {
const segment_list = m2.mappings[line]; const segment_list = m2.mappings[line];
for (let segment = 0; segment < segment_list.length; segment++) { for (let segment = 0; segment < segment_list.length; segment++) {
const seg = segment_list[segment]; const seg = segment_list[segment];
if (seg[4] >= 0) seg[4] = new_name_idx[seg[4]]; if (seg[4] >= 0)
seg[4] = new_name_idx[seg[4]];
} }
} }
} }
// combine the mappings // combine the mappings
// combine // combine
// 1. last line of first map // 1. last line of first map
// 2. first line of second map // 2. first line of second map
// columns of 2 must be shifted // columns of 2 must be shifted
if (m2.mappings.length > 0 && column_offset > 0) { if (m2.mappings.length > 0 && column_offset > 0) {
const first_line = m2.mappings[0]; const first_line = m2.mappings[0];
for (let i = 0; i < first_line.length; i++) { for (let i = 0; i < first_line.length; i++) {
first_line[i][0] += column_offset; first_line[i][0] += column_offset;
} }
} }
// combine last line + first line // combine last line + first line
push_array(m1.mappings[m1.mappings.length - 1], m2.mappings.shift()); push_array(m1.mappings[m1.mappings.length - 1], m2.mappings.shift());
// append other lines // append other lines
push_array(m1.mappings, m2.mappings); push_array(m1.mappings, m2.mappings);
return this; return this;
} }
static from_processed(string: string, map?: DecodedSourceMap): MappedCode { /**
* @static
* @param {string} string
* @param {DecodedSourceMap} [map]
* @returns {import("C:/repos/svelte/svelte/mapped_code.ts-to-jsdoc").MappedCode}
*/
static from_processed(string, map) {
const line_count = string.split('\n').length; const line_count = string.split('\n').length;
if (map) { if (map) {
// ensure that count of source map mappings lines // ensure that count of source map mappings lines
// is equal to count of generated code lines // is equal to count of generated code lines
@ -184,22 +191,35 @@ export class MappedCode {
} }
return new MappedCode(string, map); return new MappedCode(string, map);
} }
if (string == '')
if (string == '') return new MappedCode(); return new MappedCode();
map = { version: 3, names: [], sources: [], mappings: [] }; map = { version: 3, names: [], sources: [], mappings: [] };
// add empty SourceMapSegment[] for every line // add empty SourceMapSegment[] for every line
for (let i = 0; i < line_count; i++) map.mappings.push([]); for (let i = 0; i < line_count; i++)
map.mappings.push([]);
return new MappedCode(string, map); return new MappedCode(string, map);
} }
static from_source({ source, file_basename, get_location }: Source): MappedCode { /**
let offset: SourceLocation = get_location(0); * @static
* @param {Source}
* @returns {import("C:/repos/svelte/svelte/mapped_code.ts-to-jsdoc").MappedCode}
*/
static from_source({ source, file_basename, get_location }) {
if (!offset) offset = { line: 0, column: 0 }; /**
const map: DecodedSourceMap = { version: 3, names: [], sources: [file_basename], mappings: [] }; * @type {SourceLocation}
if (source == '') return new MappedCode(source, map); */
let offset = get_location(0);
if (!offset)
offset = { line: 0, column: 0 };
/**
* @type {DecodedSourceMap}
*/
const map = { version: 3, names: [], sources: [file_basename], mappings: [] };
if (source == '')
return new MappedCode(source, map);
// we create a high resolution identity map here, // we create a high resolution identity map here,
// we know that it will eventually be merged with svelte's map, // we know that it will eventually be merged with svelte's map,
// at which stage the resolution will decrease. // at which stage the resolution will decrease.
@ -208,7 +228,8 @@ export class MappedCode {
map.mappings.push([]); map.mappings.push([]);
const token_list = line_list[line].split(regex_line_token); const token_list = line_list[line].split(regex_line_token);
for (let token = 0, column = 0; token < token_list.length; token++) { for (let token = 0, column = 0; token < token_list.length; token++) {
if (token_list[token] == '') continue; if (token_list[token] == '')
continue;
map.mappings[line].push([column, 0, offset.line + line, column]); map.mappings[line].push([column, 0, offset.line + line, column]);
column += token_list[token].length; column += token_list[token].length;
} }
@ -222,21 +243,19 @@ export class MappedCode {
} }
} }
export function combine_sourcemaps( /**
filename: string, * @param {string} filename
sourcemap_list: Array<DecodedSourceMap | RawSourceMap> * @param {Array<DecodedSourceMap | RawSourceMap>} sourcemap_list
) { */
if (sourcemap_list.length == 0) return null; export function combine_sourcemaps(filename, sourcemap_list) {
if (sourcemap_list.length == 0)
return null;
let map_idx = 1; let map_idx = 1;
const map = const map = sourcemap_list.slice(0, -1).find((m) => m.sources.length !== 1) === undefined
sourcemap_list.slice(0, -1).find((m) => m.sources.length !== 1) === undefined
? remapping( ? remapping(
// use array interface // use array interface
// only the oldest sourcemap can have multiple sources // only the oldest sourcemap can have multiple sources
sourcemap_list, sourcemap_list, () => null, true // skip optional field `sourcesContent`
() => null,
true // skip optional field `sourcesContent`
) )
: remapping( : remapping(
// use loader interface // use loader interface
@ -245,44 +264,40 @@ export function combine_sourcemaps(
if (sourcefile === filename && sourcemap_list[map_idx]) { if (sourcefile === filename && sourcemap_list[map_idx]) {
return sourcemap_list[map_idx++]; // idx 1, 2, ... return sourcemap_list[map_idx++]; // idx 1, 2, ...
// bundle file = branch node // bundle file = branch node
} else { }
else {
return null; // source file = leaf node return null; // source file = leaf node
} }
} as SourceMapLoader, }, true);
true if (!map.file)
); delete map.file; // skip optional field `file`
if (!map.file) delete map.file; // skip optional field `file`
// When source maps are combined and the leading map is empty, sources is not set. // When source maps are combined and the leading map is empty, sources is not set.
// Add the filename to the empty array in this case. // Add the filename to the empty array in this case.
// Further improvements to remapping may help address this as well https://github.com/ampproject/remapping/issues/116 // Further improvements to remapping may help address this as well https://github.com/ampproject/remapping/issues/116
if (!map.sources.length) map.sources = [filename]; if (!map.sources.length)
map.sources = [filename];
return map; return map;
} }
// browser vs node.js // browser vs node.js
const b64enc = typeof btoa == 'function' ? btoa : (b) => Buffer.from(b).toString('base64'); const b64enc = typeof btoa == 'function' ? btoa : (b) => Buffer.from(b).toString('base64');
const b64dec = typeof atob == 'function' ? atob : (a) => Buffer.from(a, 'base64').toString(); const b64dec = typeof atob == 'function' ? atob : (a) => Buffer.from(a, 'base64').toString();
export function apply_preprocessor_sourcemap( /**
filename: string, * @param {string} filename
svelte_map: SourceMap, * @param {SourceMap} svelte_map
preprocessor_map_input: string | DecodedSourceMap | RawSourceMap * @param {string | DecodedSourceMap | RawSourceMap} preprocessor_map_input
): SourceMap { * @returns {SourceMap}
if (!svelte_map || !preprocessor_map_input) return svelte_map; */
export function apply_preprocessor_sourcemap(filename, svelte_map, preprocessor_map_input) {
const preprocessor_map = if (!svelte_map || !preprocessor_map_input)
typeof preprocessor_map_input === 'string' return svelte_map;
const preprocessor_map = typeof preprocessor_map_input === 'string'
? JSON.parse(preprocessor_map_input) ? JSON.parse(preprocessor_map_input)
: preprocessor_map_input; : preprocessor_map_input;
const result_map = combine_sourcemaps(filename, [ const result_map = combine_sourcemaps(filename, [
svelte_map as RawSourceMap, svelte_map,
preprocessor_map preprocessor_map
]) as RawSourceMap; ]);
// Svelte expects a SourceMap which includes toUrl and toString. Instead of wrapping our output in a class, // Svelte expects a SourceMap which includes toUrl and toString. Instead of wrapping our output in a class,
// we just tack on the extra properties. // we just tack on the extra properties.
Object.defineProperties(result_map, { Object.defineProperties(result_map, {
@ -299,23 +314,28 @@ export function apply_preprocessor_sourcemap(
} }
} }
}); });
return result_map;
return result_map as SourceMap;
} }
const regex_data_uri = /data:(?:application|text)\/json;(?:charset[:=]\S+?;)?base64,(\S*)/; const regex_data_uri = /data:(?:application|text)\/json;(?:charset[:=]\S+?;)?base64,(\S*)/;
// parse attached sourcemap in processed.code // parse attached sourcemap in processed.code
export function parse_attached_sourcemap(processed: Processed, tag_name: 'script' | 'style'): void {
/**
* @param {Processed} processed
* @param {'script' | 'style'} tag_name
* @returns {void}
*/
export function parse_attached_sourcemap(processed, tag_name) {
const r_in = '[#@]\\s*sourceMappingURL\\s*=\\s*(\\S*)'; const r_in = '[#@]\\s*sourceMappingURL\\s*=\\s*(\\S*)';
const regex = const regex = tag_name == 'script'
tag_name == 'script'
? new RegExp('(?://' + r_in + ')|(?:/\\*' + r_in + '\\s*\\*/)$') ? new RegExp('(?://' + r_in + ')|(?:/\\*' + r_in + '\\s*\\*/)$')
: new RegExp('/\\*' + r_in + '\\s*\\*/$'); : new RegExp('/\\*' + r_in + '\\s*\\*/$');
/**
* @param {any} message
*/
function log_warning(message) { function log_warning(message) {
// code_start: help to find preprocessor // code_start: help to find preprocessor
const code_start = const code_start = processed.code.length < 100 ? processed.code : processed.code.slice(0, 100) + ' [...]';
processed.code.length < 100 ? processed.code : processed.code.slice(0, 100) + ' [...]';
console.warn(`warning: ${message}. processed.code = ${JSON.stringify(code_start)}`); console.warn(`warning: ${message}. processed.code = ${JSON.stringify(code_start)}`);
} }
processed.code = processed.code.replace(regex, (_, match1, match2) => { processed.code = processed.code.replace(regex, (_, match1, match2) => {
@ -324,11 +344,9 @@ export function parse_attached_sourcemap(processed: Processed, tag_name: 'script
if (map_data) { if (map_data) {
// sourceMappingURL is data URL // sourceMappingURL is data URL
if (processed.map) { if (processed.map) {
log_warning( log_warning('Not implemented. ' +
'Not implemented. ' +
'Found sourcemap in both processed.code and processed.map. ' + 'Found sourcemap in both processed.code and processed.map. ' +
'Please update your preprocessor to return only one sourcemap.' 'Please update your preprocessor to return only one sourcemap.');
);
// ignore attached sourcemap // ignore attached sourcemap
return ''; return '';
} }
@ -337,14 +355,19 @@ export function parse_attached_sourcemap(processed: Processed, tag_name: 'script
} }
// sourceMappingURL is path or URL // sourceMappingURL is path or URL
if (!processed.map) { if (!processed.map) {
log_warning( log_warning(`Found sourcemap path ${JSON.stringify(map_url)} in processed.code, but no sourcemap data. ` +
`Found sourcemap path ${JSON.stringify( 'Please update your preprocessor to return sourcemap data directly.');
map_url
)} in processed.code, but no sourcemap data. ` +
'Please update your preprocessor to return sourcemap data directly.'
);
} }
// ignore sourcemap path // ignore sourcemap path
return ''; // remove from processed.code return ''; // remove from processed.code
}); });
} }
/**
* @typedef {{
* line: number;
* column: number;
* }} SourceLocation
*/

Write Preview
Loading…
Cancel
Save