vm: deprecate vm.runInDebugContext

joshgav · addaleax · commit 09d80f25a304 · 2017-12-07T17:33:55.000+01:00
PR-URL: nodejs/node#12815 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michaël Zasso <targos@protonmail.com>
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md
@@ -598,7 +598,7 @@ a V8-inspector based CLI debugger available through `node inspect`.
 <a id="DEP0069"></a>
 ### DEP0069: vm.runInDebugContext(string)
 
-Type: Documentation-only
+Type: Runtime
 
 The DebugContext will be removed in V8 soon and will not be available in Node
 10+.
diff --git a/doc/api/vm.md b/doc/api/vm.md
@@ -331,6 +331,11 @@ or receiving further messages.
 ## vm.runInDebugContext(code)
 <!-- YAML
 added: v0.11.14
+deprecated: v8.0.0
+changes:
+    - version: REPLACEME
+      pr-url: https://github.com/nodejs/node/pull/12815
+      description: Calling this function now emits a deprecation warning.
 -->
 
 > Stability: 0 - Deprecated. An alternative is in development.
diff --git a/lib/util.js b/lib/util.js
@@ -385,7 +385,11 @@ function stylizeNoColor(str, styleType) {
 function ensureDebugIsInitialized() {
   if (Debug === undefined) {
     const runInDebugContext = require('vm').runInDebugContext;
+    // a workaround till this entire method is removed
+    const originalValue = process.noDeprecation;
+    process.noDeprecation = true;
     Debug = runInDebugContext('Debug');
+    process.noDeprecation = originalValue;
   }
 }
 
diff --git a/lib/vm.js b/lib/vm.js
@@ -27,7 +27,7 @@ const {
 
   makeContext,
   isContext,
-  runInDebugContext
+  runInDebugContext: runInDebugContext_
 } = process.binding('contextify');
 
 const { moveMessagePortToContext } = internalBinding('messaging');
@@ -107,6 +107,19 @@ function sigintHandlersWrap(fn, thisArg, argsArray) {
   }
 }
 
+let runInDebugContextWarned = false;
+function runInDebugContext(code) {
+  if (runInDebugContextWarned === false) {
+    runInDebugContextWarned = true;
+    process.emitWarning(
+      'DebugContext has been deprecated and will be removed in a ' +
+      'future version.',
+      'DeprecationWarning',
+      'DEP0069');
+  }
+  return runInDebugContext_(code);
+}
+
 function runInContext(code, contextifiedSandbox, options) {
   if (typeof options === 'string') {
     options = {
diff --git a/test/parallel/test-vm-debug-context.js b/test/parallel/test-vm-debug-context.js
@@ -27,6 +27,11 @@ const vm = require('vm');
 const { spawn } = require('child_process');
 const fixtures = require('../common/fixtures');
 
+const msg = 'DebugContext has been deprecated and will be removed in ' +
+            'a future version.';
+common.expectWarning('DeprecationWarning', msg);
+vm.runInDebugContext();
+
 assert.throws(function() {
   vm.runInDebugContext('*');
 }, /SyntaxError/);

Original file line number	Diff line number	Diff line change
`@@ -385,7 +385,11 @@ function stylizeNoColor(str, styleType) {`
`385`	`385`	`function ensureDebugIsInitialized() {`
`386`	`386`	`if (Debug === undefined) {`
`387`	`387`	`const runInDebugContext = require('vm').runInDebugContext;`
	`388`	`+ // a workaround till this entire method is removed`
	`389`	`+ const originalValue = process.noDeprecation;`
	`390`	`+ process.noDeprecation = true;`
`388`	`391`	`Debug = runInDebugContext('Debug');`
	`392`	`+ process.noDeprecation = originalValue;`
`389`	`393`	`}`
`390`	`394`	`}`
`391`	`395`