Source code
Revision control
Copy as Markdown
Other Tools
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
import {
debuggerToSourceMapLocation,
sourceMapToDebuggerLocation,
} from "./location";
import { waitForSourceToBeRegisteredInStore } from "../client/firefox/create";
/**
* For any location, return the matching generated location.
* If this is already a generated location, returns the same location.
*
* In additional to `SourceMapLoader.getGeneratedLocation`,
* this asserts that the related source is still registered in the reducer current state.
*
* @param {Object} location
* @param {Object} thunkArgs
* Redux action thunk arguments
* @param {Object}
* The matching generated location.
*/
export async function getGeneratedLocation(location, thunkArgs) {
if (!location.source.isOriginal) {
return location;
}
const { sourceMapLoader, getState } = thunkArgs;
const generatedLocation = await sourceMapLoader.getGeneratedLocation(
debuggerToSourceMapLocation(location)
);
if (!generatedLocation) {
return location;
}
return sourceMapToDebuggerLocation(getState(), generatedLocation);
}
/**
* For any location, return the matching original location.
* If this is already an original location, returns the same location.
*
* In additional to `SourceMapLoader.getOriginalLocation`,
* this automatically fetches the original source object in order to build
* the original location object.
*
* @param {Object} location
* @param {Object} thunkArgs
* Redux action thunk arguments
* @param {Object} options
* @param {boolean} options.waitForSource
* Default to false. If true is passed, this function will
* ensure waiting, possibly asynchronously for the related original source
* to be registered in the redux store.
* @param {boolean} options.looseSearch
* Default to false. If true, this won't query an exact mapping,
* but will also lookup for a loose match at the first column and next lines.
*
* @param {Object}
* The matching original location.
*/
export async function getOriginalLocation(
location,
thunkArgs,
{ waitForSource = false, looseSearch = false } = {}
) {
if (location.source.isOriginal) {
return location;
}
const { getState, sourceMapLoader } = thunkArgs;
const originalLocation = await sourceMapLoader.getOriginalLocation(
debuggerToSourceMapLocation(location),
{ looseSearch }
);
if (!originalLocation) {
return location;
}
// When we are mapping frames while being paused,
// the original source may not be registered yet in the reducer.
if (waitForSource) {
await waitForSourceToBeRegisteredInStore(originalLocation.sourceId);
}
return sourceMapToDebuggerLocation(getState(), originalLocation);
}
export async function getMappedLocation(location, thunkArgs) {
if (location.source.isOriginal) {
const generatedLocation = await getGeneratedLocation(location, thunkArgs);
return { location, generatedLocation };
}
const generatedLocation = location;
const originalLocation = await getOriginalLocation(
generatedLocation,
thunkArgs
);
return { location: originalLocation, generatedLocation };
}
/**
* Gets the "mapped location".
*
* If the passed location is on a generated source, it gets the
* related location in the original source.
* If the passed location is on an original source, it gets the
* related location in the generated source.
*/
export async function getRelatedMapLocation(location, thunkArgs) {
if (!location.source) {
return location;
}
if (location.source.isOriginal) {
return getGeneratedLocation(location, thunkArgs);
}
return getOriginalLocation(location, thunkArgs);
}