Skip to content
This repository was archived by the owner on Apr 3, 2024. It is now read-only.

Commit 594aa68

Browse files
author
Matt Loring
committed
Change language to use snapshot instead of breakpoint
1 parent b1027d2 commit 594aa68

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This module provides Cloud Debug support for Node.js applications. [Google Cloud
1414

1515
## Prerequisites
1616
* Your application will need to be using Node.js version 0.12 or greater. Node.js v5+ is recommended.
17-
* The source of your application is uploaded to a [cloud source repository](https://cloud.google.com/tools/cloud-repositories/docs/). The Debugger UI needs the source to be available in order to set breakpoints.
17+
* The source of your application is uploaded to a [cloud source repository](https://cloud.google.com/tools/cloud-repositories/docs/). The Debugger UI needs the source to be available in order to set snapshots.
1818

1919
## Quick Start (Node.js v4.x+)
2020
```shell
@@ -24,7 +24,7 @@ npm install --save @google/cloud-debug
2424
# Require the agent at the top of your main script.
2525
require('@google/cloud-debug');
2626
```
27-
Deploy your application, and navigate to the [Debug tab][debug-tab] within the [Google Developers Console][dev-console] to set breakpoints and start debugging.
27+
Deploy your application, and navigate to the [Debug tab][debug-tab] within the [Google Developers Console][dev-console] to set snapshots and start debugging.
2828

2929
## Running on Google Cloud Platform
3030

@@ -82,10 +82,10 @@ As soon as that line of code is reached in any of the running instances of your
8282

8383
## Limitations and Requirements
8484
* The root directory of your application needs to contain a `package.json` file.
85-
* You can set breakpoint conditions and watch expressions to be evaluated in the context of your application. This leads to some issues you should be aware of
85+
* You can set snapshot conditions and watch expressions to be evaluated in the context of your application. This leads to some issues you should be aware of
8686
* You may be able to view sensitive data of your own users by looking at the values of the variables.
8787
* The debug agent tries to ensure that all conditions and watchpoints you add are read-only and have no side effects. It catches, and disallows, all expressions that may have static side effects to prevent accidental state change. However, it presently does not catch expressions that have dynamic side-effects. For example, `o.f` looks like a property access, but dynamically, it may end up calling a getter function. We presently do NOT detect such dynamic-side effects.
88-
* With Node.js 4.x and older, your application may experience a performance impact when there are breakpoint active. There should be no impact to performance when no breakpoints are active. Node.js v5.x does not have this issue.
88+
* With Node.js 4.x and older, your application may experience a performance impact when there are snapshots active. There should be no impact to performance when no snapshots are active. Node.js v5.x does not have this issue.
8989
* Node.js v0.10.x or older are not supported as they lack some necessary APIs to avoid a permanent (life of the application) performance hit.
9090

9191

lib/v8debugapi.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
/** @const */ var StatusMessage = apiclasses.StatusMessage;
2727

2828
/** @const */ var messages = {
29-
INVALID_BREAKPOINT: 'invalid breakpoint - id or location missing',
29+
INVALID_BREAKPOINT: 'invalid snapshot - id or location missing',
3030
BREAKPOINT_ONLY_SUPPORTS_JAVASCRIPT:
3131
'Only files with .js extensions or source maps are supported',
3232
SOURCE_FILE_NOT_FOUND:
@@ -41,8 +41,8 @@
4141
SOURCE_MAP_READ_ERROR: 'The source map could not be read or was incorrectly formatted',
4242
V8_BREAKPOINT_MISSING: 'Internal error: V8 breakpoint missing',
4343
V8_BREAKPOINT_DISABLED: 'Internal error: V8 breakpoint externally disabled',
44-
CAPTURE_BREAKPOINT_DATA: 'Error trying to capture breakpoint data: ',
45-
INVALID_LINE_NUMBER: 'Invalid breakpoint position: '
44+
CAPTURE_BREAKPOINT_DATA: 'Error trying to capture snapshot data: ',
45+
INVALID_LINE_NUMBER: 'Invalid snapshot position: '
4646
};
4747

4848
/** @const */ var MODULE_WRAP_PREFIX_LENGTH = require('module').wrap('☃')
@@ -270,7 +270,7 @@ module.exports.create = function(logger_, config_, fileStats_) {
270270
messages.INVALID_LINE_NUMBER + matchingScript + ':' +
271271
breakpoint.location.line + '. Loaded script contained ' +
272272
fileStats[matchingScript].lines + ' lines. Please ensure' +
273-
' that the breakpoint was set in the same code version as the' +
273+
' that the snapshot was set in the same code version as the' +
274274
' deployed source.');
275275
}
276276

0 commit comments

Comments
 (0)