rules_nodejs/docs/debugging.html at stable · software-engineering/rules_nodejs

History

executable file

328 lines (236 loc) · 12.1 KB

Raw

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

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

<!DOCTYPE html>

<head>

<title>rules_nodejs - Debugging</title>

integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" rel="stylesheet">

<!--[if lt IE 9]>

<![endif]-->

</head>

<body>

<button class="navbar-toggle collapsed" data-target="#bs-example-navbar-collapse-1" data-toggle="collapse"

type="button">

<span class="sr-only">Toggle navigation</span>

</button>

</a>

</div>

</div>

</form>

<li><a href="https://github.com/bazelbuild/rules_nodejs">GitHub</a></li>

</ul>

</div>

</div>

</nav>

<a aria-controls="sidebar-nav"

aria-expanded="false" class="btn btn-default btn-lg btn-block sidebar-toggle" data-toggle="collapse"

href="#sidebar-nav">

<i class="glyphicon glyphicon-menu-hamburger"></i> Navigation

</a>

<h3>rules_nodejs</h3>

<li><a href="/rules_nodejs/">Introduction</a></li>

<li><a href="install.html">Installation</a></li>

<li><a href="repositories.html">Repositories</a></li>

<li><a href="dependencies.html">Dependencies</a></li>

<li><a href="debugging.html">Debugging</a></li>

<li><a href="stamping.html">Stamping</a></li>

<li><a href="changing-rules.html">Making changes to rules_nodejs</a></li>

<li><a href="examples.html">Examples</a></li>

</ul>

<h3>Rules</h3>

<li><a href="/rules_nodejs/Built-ins.html">Built-ins</a></li>

<li><a href="/rules_nodejs/Cypress.html">Cypress</a></li>

<li><a href="/rules_nodejs/Jasmine.html">Jasmine</a></li>

<li><a href="/rules_nodejs/Karma.html">Karma</a></li>

<li><a href="/rules_nodejs/Protractor.html">Protractor</a></li>

<li><a href="/rules_nodejs/Rollup.html">Rollup</a></li>

<li><a href="/rules_nodejs/Terser.html">Terser</a></li>

<li><a href="/rules_nodejs/TypeScript.html">TypeScript</a></li>

</ul>

<h3>Community</h3>

<li><a href="https://github.com/bazelbuild/rules_nodejs/blob/master/CONTRIBUTING.md">Contribute to

rules_nodejs</a></li>

<li><a href="https://slack.bazel.build">Join #javascript on Slack</a></li>

<li><a href="https://github.com/bazelbuild/rules_nodejs/issues">Issue Tracker</a></li>

<li><a href="https://github.com/bazelbuild/rules_nodejs">Github</a></li>

</ul>

</nav>

</div>

<h1 id="debugging">Debugging</h1>

<p>Add the options in the <code class="language-plaintext highlighter-rouge">Support for debugging NodeJS tests</code> section from https://github.com/bazelbuild/rules_nodejs/blob/master/common.bazelrc to your project’s <code class="language-plaintext highlighter-rouge">.bazelrc</code> file to add support for debugging NodeJS programs.</p>

<p>Using the <code class="language-plaintext highlighter-rouge">--config=debug</code> command line option with bazel will set a number of flags that are specified there are useful for debugging. See the comments under <code class="language-plaintext highlighter-rouge">Support for debugging NodeJS tests</code> for details on the flags that are set.</p>

<p>Use <code class="language-plaintext highlighter-rouge">--config=debug</code> with <code class="language-plaintext highlighter-rouge">bazel test</code> as follow,</p>

<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>bazel test --config=debug //test:...

</code></pre></div></div>

<p>or with <code class="language-plaintext highlighter-rouge">bazel run</code>,</p>

<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>bazel run --config=debug //test:test1

</code></pre></div></div>

<p>to also turn on the NodeJS inspector agent which will break before any user code starts. You should then see,</p>

<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>Executing tests from //test:test1

-----------------------------------------------------------------------------

Debugger listening on ws://127.0.0.1:9229/3f20777a-242c-4d18-b88b-5ed4b3fed61c

For help, see: https://nodejs.org/en/docs/inspector

</code></pre></div></div>

<p>To inspect with Chrome DevTools 55+, open <code class="language-plaintext highlighter-rouge">chrome://inspect</code> in a Chromium-based browser and attach to the waiting process.

A Chrome DevTools window should open and you should see <code class="language-plaintext highlighter-rouge">Debugger attached.</code> in the console.</p>

<p>See https://nodejs.org/en/docs/guides/debugging-getting-started/ for more details.</p>

<h2 id="debugging-with-vs-code">Debugging with VS Code</h2>

<p>With the above configuration you can use VS Code as your debugger.

You will first need to configure your <code class="language-plaintext highlighter-rouge">.vscode/launch.json</code>:</p>

<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>{

"type": "node",

"request": "attach",

"name": "Attach nodejs_binary",

"internalConsoleOptions": "neverOpen",

"sourceMapPathOverrides": {

"../*": "${workspaceRoot}/*",

"../../*": "${workspaceRoot}/*",

"../../../*": "${workspaceRoot}/*",

"../../../../*": "${workspaceRoot}/*",

"../../../../../*": "${workspaceRoot}/*",

// do as many levels here as needed for your project

}

</code></pre></div></div>

<p>We use <code class="language-plaintext highlighter-rouge">sourceMapPathOverrides</code> here to rewrite the source maps produced by <code class="language-plaintext highlighter-rouge">ts_library</code> so that breakpoints line up with the source maps.

Once configured start your process with</p>

<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>bazel run --config=debug //test:test1

</code></pre></div></div>

<p>Then hit <code class="language-plaintext highlighter-rouge">F5</code> which will start the VS Code debugger with the <code class="language-plaintext highlighter-rouge">Attach nodejs_binary</code> configuration.

VS Code will immediatenly hit a breakpoint to which you can continue and debug using all the normal debug features provided.</p>

</div>

<li>

<a href="https://github.com/bazelbuild/rules_nodejs/issues/new?title=Documentation issue: Debugging&labels=question/docs">Create

issue</a>

</li>

<li>

<a class="gh-edit" href="https://github.com/bazelbuild/rules_nodejs/tree/stable/docs/debugging.md">Edit

this page</a>

</li>

</ul>

<li class="toc-entry toc-h2"><a href="#debugging-with-vs-code">Debugging with VS Code</a></li>

</ul>

</div>

</div>

</footer>

integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa"

src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script>

// Automatically add anchors and links to all header elements that don't already have them.

anchors.add();

</script>

var shiftWindow = function () {

if (location.hash.length !== 0) {

window.scrollBy(0, -50);

}

};

window.addEventListener("hashchange", shiftWindow);

var highlightCurrentSidebarNav = function () {

var href = location.pathname;

var item = $('#sidebar-nav [href$="' + href + '"]');

if (item) {

var li = item.parent();

li.addClass("active");

if (li.parent() && li.parent().is("ul")) {

do {

var ul = li.parent();

if (ul.hasClass("collapse")) {

ul.collapse("show");

}

li = ul.parent();

} while (li && li.is("li"));

}

};

$(document).ready(function () {

// Scroll to anchor of location hash, adjusted for fixed navbar.

window.setTimeout(function () {

shiftWindow();

}, 1);

// Flip the caret when submenu toggles are clicked.

$(".sidebar-submenu").on("show.bs.collapse", function () {

var toggle = $('[href$="#' + $(this).attr('id') + '"]');

if (toggle) {

toggle.addClass("dropup");

}

});

$(".sidebar-submenu").on("hide.bs.collapse", function () {

var toggle = $('[href$="#' + $(this).attr('id') + '"]');

if (toggle) {

toggle.removeClass("dropup");

}

});

// Highlight the current page on the sidebar nav.

highlightCurrentSidebarNav();

});

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

debugging.html

Latest commit

History

debugging.html

File metadata and controls