You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openwhisk.apache.org by al...@apache.org on 2020/04/14 20:56:02 UTC
[openwhisk-wskdebug] branch master updated (5d42407 -> 295ddad)
This is an automated email from the ASF dual-hosted git repository.
alexkli pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/openwhisk-wskdebug.git.
from 5d42407 log api host and namespace
new 373b5a3 [nodejs] pass through DEBUG, NODE_DEBUG environment variables #43
new 295ddad document DEBUG, WSK_NODE_DEBUG vars
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
README.md | 39 ++++++++++++++++++++++++++++++++++++---
src/kinds/nodejs/nodejs.js | 12 +++++++++++-
test/nodejs.test.js | 30 ++++++++++++++++++++++++++++--
3 files changed, 75 insertions(+), 6 deletions(-)
[openwhisk-wskdebug] 01/02: [nodejs] pass through DEBUG,
NODE_DEBUG environment variables #43
Posted by al...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
alexkli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/openwhisk-wskdebug.git
commit 373b5a34ffe8721da4c8465f8469677ea8634dec
Author: Alexander Klimetschek <ak...@adobe.com>
AuthorDate: Tue Apr 14 01:19:57 2020 -0700
[nodejs] pass through DEBUG, NODE_DEBUG environment variables #43
set WSK_NODE_DEBUG to control NODE_DEBUG in the container, to avoid
affecting it wskdebug itself
---
src/kinds/nodejs/nodejs.js | 12 +++++++++++-
test/nodejs.test.js | 30 ++++++++++++++++++++++++++++--
2 files changed, 39 insertions(+), 3 deletions(-)
diff --git a/src/kinds/nodejs/nodejs.js b/src/kinds/nodejs/nodejs.js
index 08f0c9f..38d6396 100644
--- a/src/kinds/nodejs/nodejs.js
+++ b/src/kinds/nodejs/nodejs.js
@@ -36,13 +36,23 @@ module.exports = {
// return extra docker arguments such as mounting the source path
dockerArgs: function(invoker) {
+ let args = "";
if (invoker.sourceDir) {
if (!invoker.sourceFile) {
throw new Error("[source-path] or --build-path must point to the action javascript source file, it cannot be a folder.");
}
- return `-v "${invoker.sourceDir}:${CODE_MOUNT}"`;
+ args += ` -v "${invoker.sourceDir}:${CODE_MOUNT}"`;
}
+
+ if (process.env.WSK_NODE_DEBUG) {
+ args += ` -e NODE_DEBUG='${process.env.WSK_NODE_DEBUG}'`;
+ }
+ if (process.env.DEBUG) {
+ args += ` -e DEBUG='${process.env.DEBUG}'`;
+ }
+
+ return args;
},
// return action for /init that mounts the sources specified by invoker.sourcePath
diff --git a/test/nodejs.test.js b/test/nodejs.test.js
index 9eb2f54..625e276 100644
--- a/test/nodejs.test.js
+++ b/test/nodejs.test.js
@@ -61,6 +61,9 @@ describe('nodejs', function() {
afterEach(function() {
test.afterEach();
+
+ delete process.env.DEBUG;
+ delete process.env.WSK_NODE_DEBUG;
});
it("should run an action without local sources", async function() {
@@ -548,14 +551,37 @@ describe('nodejs', function() {
test.assertAllNocksInvoked();
});
+ it("should pass through DEBUG and NODE_DEBUG env vars", async function() {
+ test.mockActionAndInvocation(
+ "myaction",
+ `function main(params) {
+ return {
+ msg: 'CORRECT',
+ debug: process.env.DEBUG,
+ nodeDebug: process.env.NODE_DEBUG,
+ }
+ }`,
+ { },
+ {
+ msg: "CORRECT",
+ debug: "debug",
+ nodeDebug: "node_debug"
+ }
+ );
+
+ process.env.DEBUG = "debug";
+ process.env.WSK_NODE_DEBUG = "node_debug";
+ await wskdebug(`myaction -p ${test.port}`);
+
+ test.assertAllNocksInvoked();
+ });
+
// TODO: test -l livereload connection
// TODO: test agents - conditions (unit test agent code locally)
- // TODO: test agent already installed (debugger.getAction())
// TODO: test breakpoint debugging
// TODO: test action options
// TODO: test debugger options
- // TODO: test non-concurrent openwhisk
});
[openwhisk-wskdebug] 02/02: document DEBUG, WSK_NODE_DEBUG vars
Posted by al...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
alexkli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/openwhisk-wskdebug.git
commit 295ddadb4e9b8df5296e1687a1f6bf78a9cc5faf
Author: Alexander Klimetschek <ak...@adobe.com>
AuthorDate: Tue Apr 14 12:29:20 2020 -0700
document DEBUG, WSK_NODE_DEBUG vars
---
README.md | 39 ++++++++++++++++++++++++++++++++++++---
1 file changed, 36 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 7d4373a..0d40687 100644
--- a/README.md
+++ b/README.md
@@ -110,6 +110,7 @@ The action to debug (e.g. `myaction`) must already be deployed.
+ [Node.js: Plain usage](#nodejs-plain-usage)
+ [Node.js: Chrome DevTools](#nodejs-chrome-devtools)
+ [Node.js: node-inspect command line](#nodejs-node-inspect-command-line)
++ [Enable debug logging](#enable-debug-logging)
+ [Unsupported action kinds](#unsupported-action-kinds)
+ [Source mounting](#source-mounting)
+ [Live reloading](#live-reloading)
@@ -158,7 +159,7 @@ To use custom credentials from a custom `.wskprops` and/or use a developer-speci
2. Make sure to not commit this file into source control, by e.g. adding `.env` to a `.gitignore` file.
-2. Add an `envFile` setting to the `.vscode/launch.json`, which you can share with co-workers and commit to source control:
+3. Add an `envFile` setting to the `.vscode/launch.json`, which you can share with co-workers and commit to source control:
```json
"configurations": [
@@ -176,8 +177,6 @@ To use custom credentials from a custom `.wskprops` and/or use a developer-speci
]
```
-
-
<a name="nodejs-multiple-actions"></a>
### Node.js: Multiple actions
@@ -286,6 +285,40 @@ Use the command line Node debugger [node-inspect](https://github.com/nodejs/node
node-inspect 127.0.0.1:9229
```
+<a name="enable-debug-logging"></a>
+### Enable debug logging
+
+To enable debug logs in your action, you can set environment variables:
+
+1. (nodejs) `DEBUG` environment variable from the popular [debug](https://www.npmjs.com/package/debug) library is passed through to the action. Options:
+ - Run wskdebug using
+
+ ```
+ DEBUG=xyz wskdebug myaction
+ ```
+ - Alternatively put it in the `.env` file (see [above](#nodejs-visual-studio-code))
+
+ ```
+ DEBUG=xyz
+ ```
+2. (nodejs) To control the`NODE_DEBUG` [used](https://nodejs.org/api/util.html#util_util_debuglog_section) by built-in node modules, just set the `WSK_NODE_DEBUG` variable. (It is a separate one in order to not affect `wskdebug` itself which is written in nodejs.) Options:
+ - Run wskdebug using
+
+ ```
+ WSK_NODE_DEBUG=NET wskdebug myaction
+ ```
+ - Alternatively put it in the `.env` file (see above)
+
+ ```
+ WSK_NODE_DEBUG=NET
+ ```
+3. Any other custom environment variables that enable debugging or logging features in your action can be set by controlling the docker run arguments using `--docker-args` (note the leading space before `-e`, which is required):
+
+ ```
+ wskdebug --docker-args " -e DEBUG_VAR=something" myaction
+ ```
+
+
<a name="unsupported-action-kinds"></a>
### Unsupported action kinds