summaryrefslogtreecommitdiffstats
path: root/devtools/client/debugger/src/actions/pause/mapScopes.js
blob: 8cb096c0a83e376f25b4380bcf671938d9b3195d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
/* 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
 * file, You can obtain one at <http://mozilla.org/MPL/2.0/>. */

import {
  getSettledSourceTextContent,
  isMapScopesEnabled,
  getSelectedFrame,
  getGeneratedFrameScope,
  getOriginalFrameScope,
  getFirstSourceActorForGeneratedSource,
  getCurrentThread,
} from "../../selectors/index";
import {
  loadOriginalSourceText,
  loadGeneratedSourceText,
} from "../sources/loadSourceText";
import { validateSelectedFrame } from "../../utils/context";
import { PROMISE } from "../utils/middleware/promise";

import { log } from "../../utils/log";

import { buildMappedScopes } from "../../utils/pause/mapScopes/index";
import { isFulfilled } from "../../utils/async-value";

import { getMappedLocation } from "../../utils/source-maps";

const expressionRegex = /\bfp\(\)/g;

export async function buildOriginalScopes(
  selectedFrame,
  client,
  generatedScopes
) {
  if (!selectedFrame.originalVariables) {
    throw new TypeError("(frame.originalVariables: XScopeVariables)");
  }
  const originalVariables = selectedFrame.originalVariables;
  const frameBase = originalVariables.frameBase || "";

  const inputs = [];
  for (let i = 0; i < originalVariables.vars.length; i++) {
    const { expr } = originalVariables.vars[i];
    const expression = expr
      ? expr.replace(expressionRegex, frameBase)
      : "void 0";

    inputs[i] = expression;
  }

  const results = await client.evaluateExpressions(inputs, {
    frameId: selectedFrame.id,
  });

  const variables = {};
  for (let i = 0; i < originalVariables.vars.length; i++) {
    const { name } = originalVariables.vars[i];
    variables[name] = { value: results[i].result };
  }

  const bindings = {
    arguments: [],
    variables,
  };

  const { actor } = await generatedScopes;
  const scope = {
    type: "function",
    scopeKind: "",
    actor,
    bindings,
    parent: null,
    function: null,
    block: null,
  };
  return {
    mappings: {},
    scope,
  };
}

export function toggleMapScopes() {
  return async function ({ dispatch, getState }) {
    if (isMapScopesEnabled(getState())) {
      dispatch({ type: "TOGGLE_MAP_SCOPES", mapScopes: false });
      return;
    }

    dispatch({ type: "TOGGLE_MAP_SCOPES", mapScopes: true });

    // Ignore the call if there is no selected frame (we are not paused?)
    const state = getState();
    const selectedFrame = getSelectedFrame(state, getCurrentThread(state));
    if (!selectedFrame) {
      return;
    }

    if (getOriginalFrameScope(getState(), selectedFrame)) {
      return;
    }

    // Also ignore the call if we didn't fetch the scopes for the selected frame
    const scopes = getGeneratedFrameScope(getState(), selectedFrame);
    if (!scopes) {
      return;
    }

    dispatch(mapScopes(selectedFrame, Promise.resolve(scopes.scope)));
  };
}

export function mapScopes(selectedFrame, scopes) {
  return async function (thunkArgs) {
    const { getState, dispatch, client } = thunkArgs;

    await dispatch({
      type: "MAP_SCOPES",
      selectedFrame,
      [PROMISE]: (async function () {
        if (selectedFrame.isOriginal && selectedFrame.originalVariables) {
          return buildOriginalScopes(selectedFrame, client, scopes);
        }

        // getMappedScopes is only specific to the sources where we map the variables
        // in scope and so only need a thread context. Assert that we are on the same thread
        // before retrieving a thread context.
        validateSelectedFrame(getState(), selectedFrame);

        return dispatch(getMappedScopes(scopes, selectedFrame));
      })(),
    });
  };
}

/**
 * Get scopes mapped for a precise location.
 *
 * @param {Promise} scopes
 *        Can be null. Result of Commands.js's client.getFrameScopes
 * @param {Objects locations
 *        Frame object, or custom object with 'location' and 'generatedLocation' attributes.
 */
export function getMappedScopes(scopes, locations) {
  return async function (thunkArgs) {
    const { getState, dispatch } = thunkArgs;
    const generatedSource = locations.generatedLocation.source;
    const source = locations.location.source;

    if (
      !isMapScopesEnabled(getState()) ||
      !source ||
      !generatedSource ||
      generatedSource.isWasm ||
      source.isPrettyPrinted ||
      !source.isOriginal
    ) {
      return null;
    }

    // Load source text for the original source
    await dispatch(loadOriginalSourceText(source));

    const generatedSourceActor = getFirstSourceActorForGeneratedSource(
      getState(),
      generatedSource.id
    );

    // Also load source text for its corresponding generated source
    await dispatch(loadGeneratedSourceText(generatedSourceActor));

    try {
      const content =
        // load original source text content
        getSettledSourceTextContent(getState(), locations.location);

      return await buildMappedScopes(
        source,
        content && isFulfilled(content)
          ? content.value
          : { type: "text", value: "", contentType: undefined },
        locations,
        await scopes,
        thunkArgs
      );
    } catch (e) {
      log(e);
      return null;
    }
  };
}

/**
 * Used to map variables used within conditional and log breakpoints.
 */
export function getMappedScopesForLocation(location) {
  return async function (thunkArgs) {
    const { dispatch } = thunkArgs;
    const mappedLocation = await getMappedLocation(location, thunkArgs);
    return dispatch(getMappedScopes(null, mappedLocation));
  };
}