LDEV-1402 switch env var prefix to LUCEE_DAP_ ( was LUCEE_DEBUGGER_ )

zspitzer · zspitzer · commit 5515d3bbda33 · 2026-02-09T08:50:18.000+11:00
diff --git a/core/src/main/java/lucee/runtime/PageContextImpl.java b/core/src/main/java/lucee/runtime/PageContextImpl.java
@@ -3433,7 +3433,7 @@ public void _setCatch(PageException pe, String name, boolean caught, boolean sto
 				FDSignal.signal(pe, caught);
 			}
 			// External debugger (luceedebug) - frames are still intact at this point
-			if (ConfigImpl.DEBUGGER_BREAKPOINT) {
+			if (ConfigImpl.DEBUGGER) {
 				DebuggerListener listener = DebuggerRegistry.getListener();
 				if (listener != null && listener.isClientConnected() && listener.onException( this, pe, caught )) {
 					// Get file/line from exception for debugger display
@@ -3553,10 +3553,10 @@ public static final class DebuggerFrame {
 		public String getFile() { return pageSource != null ? pageSource.getDisplayPath() : null; }
 	}
 
-	private final LinkedList<DebuggerFrame> debuggerFrames = ConfigImpl.DEBUGGER_BREAKPOINT ? new LinkedList<DebuggerFrame>() : null;
+	private final LinkedList<DebuggerFrame> debuggerFrames = ConfigImpl.DEBUGGER ? new LinkedList<DebuggerFrame>() : null;
 
 	/**
-	 * Push a new debugger frame onto the stack. Called on UDF entry when DEBUGGER_BREAKPOINT is enabled.
+	 * Push a new debugger frame onto the stack. Called on UDF entry when DEBUGGER is enabled.
 	 */
 	public void pushDebuggerFrame(lucee.runtime.type.scope.Local local, lucee.runtime.type.scope.Argument arguments,
 								lucee.runtime.type.scope.Variables variables, PageSource pageSource, String functionName, int startLine) {
@@ -3578,7 +3578,7 @@ public void pushDebuggerFrame(lucee.runtime.type.scope.Local local, lucee.runtim
 	}
 
 	/**
-	 * Pop the topmost debugger frame. Called on UDF exit when DEBUGGER_BREAKPOINT is enabled.
+	 * Pop the topmost debugger frame. Called on UDF exit when DEBUGGER is enabled.
 	 */
 	public void popDebuggerFrame() {
 		if (debuggerFrames != null && !debuggerFrames.isEmpty()) {
@@ -3626,7 +3626,7 @@ public DebuggerFrame getTopmostDebuggerFrame() {
 	 * @param label Optional label to identify the breakpoint in debugger UI
 	 */
 	public void debuggerSuspend(String label) {
-		if (!ConfigImpl.DEBUGGER_BREAKPOINT) return;
+		if (!ConfigImpl.DEBUGGER) return;
 
 		// Get current file/line for listener callback
 		DebuggerFrame frame = getTopmostDebuggerFrame();
@@ -3664,7 +3664,7 @@ public void debuggerSuspend(String label) {
 	 * @param label Optional label to identify the breakpoint in debugger UI
 	 */
 	public void debuggerSuspend(String file, int line, String label) {
-		if (!ConfigImpl.DEBUGGER_BREAKPOINT) return;
+		if (!ConfigImpl.DEBUGGER) return;
 		debuggerSuspendImpl(file, line, label);
 	}
 
diff --git a/core/src/main/java/lucee/runtime/config/ConfigFactoryImpl.java b/core/src/main/java/lucee/runtime/config/ConfigFactoryImpl.java
@@ -1569,7 +1569,7 @@ public static ExecutionLogFactory loadExeLog(ConfigImpl config, Struct root) {
 			Map<String, String> args = null;
 
 			// If debugger breakpoint support enabled and no explicit class configured, use DebuggerExecutionLog
-			if (StringUtil.isEmpty(strClass) && ConfigImpl.DEBUGGER_BREAKPOINT) {
+			if (StringUtil.isEmpty(strClass) && ConfigImpl.DEBUGGER) {
 				LogUtil.log(config, Log.LEVEL_INFO, "application", "Debugger breakpoint support enabled");
 				clazz = DebuggerExecutionLog.class;
 				args = new HashMap<String, String>();
diff --git a/core/src/main/java/lucee/runtime/config/ConfigImpl.java b/core/src/main/java/lucee/runtime/config/ConfigImpl.java
@@ -179,25 +179,25 @@ public abstract class ConfigImpl extends ConfigBase implements ConfigPro {
 
 	private static final RHExtension[] RHEXTENSIONS_EMPTY = new RHExtension[0];
 
-	// Debugger secret - required to register a debugger listener. If not set, debugger is disabled.
+	// DAP secret - required to register a debugger listener. If not set, DAP debugger is disabled.
 	public static final String DEBUGGER_SECRET;
-	// Debugger enabled if secret is set (non-empty) - enables listener registration and console capture
+	// DAP enabled if secret is set (non-empty) - enables listener registration and console capture
 	public static final boolean DEBUGGER_ENABLED;
-	// Breakpoint support - controls bytecode instrumentation for stepping/breakpoints (default true when debugger enabled)
-	public static final boolean DEBUGGER_BREAKPOINT;
+	// DAP debugger active - controls bytecode instrumentation for stepping/breakpoints (default true when secret set)
+	public static final boolean DEBUGGER;
 	static {
-		String secret = SystemUtil.getSystemPropOrEnvVar("lucee.debugger.secret", null);
+		String secret = SystemUtil.getSystemPropOrEnvVar("lucee.dap.secret", null);
 		if (secret != null && !secret.trim().isEmpty()) {
 			DEBUGGER_SECRET = secret.trim();
 			DEBUGGER_ENABLED = true;
 			// Breakpoint support defaults to true, can be disabled for console-only mode
-			String bp = SystemUtil.getSystemPropOrEnvVar("lucee.debugger.breakpoint", "true");
-			DEBUGGER_BREAKPOINT = "true".equalsIgnoreCase(bp.trim());
+			String bp = SystemUtil.getSystemPropOrEnvVar("lucee.dap.breakpoint", "true");
+			DEBUGGER = "true".equalsIgnoreCase(bp.trim());
 		}
 		else {
 			DEBUGGER_SECRET = null;
 			DEBUGGER_ENABLED = false;
-			DEBUGGER_BREAKPOINT = false;
+			DEBUGGER = false;
 		}
 	}
 
@@ -4635,7 +4635,7 @@ public ConfigImpl resetCacheAll() {
 
 	@Override
 	public boolean getExecutionLogEnabled() {
-		if (DEBUGGER_BREAKPOINT) return true;
+		if (DEBUGGER) return true;
 
 		if (executionLogEnabled == null) {
 			synchronized (SystemUtil.createToken("ConfigImpl", "getExecutionLogEnabled")) {
diff --git a/core/src/main/java/lucee/runtime/debug/DebuggerListener.java b/core/src/main/java/lucee/runtime/debug/DebuggerListener.java
@@ -98,7 +98,7 @@ default int[] getExecutableLines(String absolutePath) {
 	/**
 	 * Called when a UDF/method is entered.
 	 * Allows debuggers to implement function breakpoints (break on function name).
-	 * Must be fast - called on every function invocation when DEBUGGER_BREAKPOINT is enabled.
+	 * Must be fast - called on every function invocation when DEBUGGER is enabled.
 	 *
 	 * @param pc The PageContext executing
 	 * @param functionName The function name (case as defined in source)
diff --git a/core/src/main/java/lucee/runtime/debug/DebuggerRegistry.java b/core/src/main/java/lucee/runtime/debug/DebuggerRegistry.java
@@ -23,11 +23,11 @@ private DebuggerRegistry() {
 	}
 
 	/**
-	 * Set the debugger listener. Requires the correct secret from LUCEE_DEBUGGER_SECRET.
+	 * Set the debugger listener. Requires the correct secret from LUCEE_DAP_SECRET.
 	 * Only one listener is supported - setting a new one replaces the old.
 	 *
 	 * @param l The listener to register, or null to unregister
-	 * @param secret The secret that must match LUCEE_DEBUGGER_SECRET
+	 * @param secret The secret that must match LUCEE_DAP_SECRET
 	 * @return true if registration succeeded, false if secret is invalid
 	 */
 	public static boolean setListener(DebuggerListener l, String secret) {
diff --git a/core/src/main/java/lucee/runtime/engine/DebuggerExecutionLog.java b/core/src/main/java/lucee/runtime/engine/DebuggerExecutionLog.java
@@ -12,7 +12,7 @@
  * Updates the current debugger frame's line number on each block start.
  * Also checks for breakpoints and suspends execution if needed.
  *
- * This is used when DEBUGGER_BREAKPOINT=true to provide line tracking
+ * This is used when DEBUGGER=true to provide line tracking
  * without requiring bytecode instrumentation in the debugger extension.
  */
 public final class DebuggerExecutionLog implements ExecutionLogPro {
diff --git a/core/src/main/java/lucee/runtime/functions/decision/IsDebuggerEnabled.java b/core/src/main/java/lucee/runtime/functions/decision/IsDebuggerEnabled.java
@@ -7,6 +7,6 @@
 public final class IsDebuggerEnabled implements Function {
 
 	public static boolean call(PageContext pc) {
-		return ConfigImpl.DEBUGGER_ENABLED;
+		return ConfigImpl.DEBUGGER;
 	}
 }
diff --git a/core/src/main/java/lucee/runtime/functions/system/Breakpoint.java b/core/src/main/java/lucee/runtime/functions/system/Breakpoint.java
@@ -17,7 +17,7 @@ public static boolean call(PageContext pc, String label) {
 
 	public static boolean call(PageContext pc, String label, boolean condition) {
 		// Only suspend if debugger breakpoint support is enabled AND a debugger client is connected
-		if (condition && ConfigImpl.DEBUGGER_BREAKPOINT && DebuggerRegistry.isClientConnected()) {
+		if (condition && ConfigImpl.DEBUGGER && DebuggerRegistry.isClientConnected()) {
 			((PageContextImpl) pc).debuggerSuspend(label);
 			return true;
 		}
diff --git a/core/src/main/java/lucee/runtime/type/UDFImpl.java b/core/src/main/java/lucee/runtime/type/UDFImpl.java
@@ -363,7 +363,7 @@ private Object _call(PageContext pc, Collection.Key calledName, Object[] args, S
 
 				// Debugger frame support - capture scopes for external debuggers
 				// Must be AFTER defineArguments so function arguments are accessible for conditional breakpoints
-				if (ConfigImpl.DEBUGGER_BREAKPOINT) {
+				if (ConfigImpl.DEBUGGER) {
 					pci.pushDebuggerFrame(newLocal, newArgs, pc.variablesScope(), ps, getFunctionName(), properties.getStartLine());
 				}
 
@@ -398,7 +398,7 @@ private Object _call(PageContext pc, Collection.Key calledName, Object[] args, S
 		finally {
 			if (ps != null) pc.removeLastPageSource(psInc != null);
 			// Debugger frame support - pop before removeUDF to maintain consistency
-			if (ConfigImpl.DEBUGGER_BREAKPOINT) {
+			if (ConfigImpl.DEBUGGER) {
 				pci.popDebuggerFrame();
 			}
 			pci.removeUDF();
diff --git a/core/src/main/java/resource/fld/core-base.fld b/core/src/main/java/resource/fld/core-base.fld
@@ -8213,7 +8213,7 @@ The following things are considered to be empty:
 		<name>isDebuggerEnabled</name>
 		<class>lucee.runtime.functions.decision.IsDebuggerEnabled</class>
 		<keywords>decision,debug,debugger</keywords>
-		<description>Returns true if native debugger support is enabled (via LUCEE_DEBUGGER_SECRET env var or lucee.debugger.secret system property). Use with breakpoint() BIF.</description>
+		<description>Returns true if DAP debugger support is enabled (via LUCEE_DAP_SECRET env var or lucee.dap.secret system property). Use with breakpoint() BIF.</description>
 		<return>
 			<type>boolean</type>
 		</return>
diff --git a/core/src/main/java/resource/setting/sysprop-envvar.json b/core/src/main/java/resource/setting/sysprop-envvar.json
@@ -232,17 +232,17 @@
 		"default": null
 	},
 	{
-		"sysprop": "lucee.debugger.secret",
-		"envvar": "LUCEE_DEBUGGER_SECRET",
-		"desc": "Secret token required to enable and authenticate the debugger. When set, enables debugger listener registration and console capture for external debuggers (e.g., VS Code DAP). The secret must be provided when registering a debugger listener and when connecting via DAP. If not set, debugger is disabled. Requires JVM restart to take effect.",
+		"sysprop": "lucee.dap.secret",
+		"envvar": "LUCEE_DAP_SECRET",
+		"desc": "Secret token required to enable and authenticate the DAP debugger. When set, enables debugger listener registration and console capture for external debuggers (e.g., VS Code DAP). The secret must be provided when registering a debugger listener and when connecting via DAP. If not set, debugger is disabled. Requires JVM restart to take effect.",
 		"category": "debugging",
 		"type": "string",
 		"default": null
 	},
 	{
-		"sysprop": "lucee.debugger.breakpoint",
-		"envvar": "LUCEE_DEBUGGER_BREAKPOINT",
-		"desc": "Controls whether breakpoint support (stepping, stack frames) is enabled. Requires lucee.debugger.secret to be set. When true (default), enables bytecode instrumentation for line-by-line stepping and breakpoints. Set to false for console-only mode without stepping overhead. Requires JVM restart to take effect.",
+		"sysprop": "lucee.dap.breakpoint",
+		"envvar": "LUCEE_DAP_BREAKPOINT",
+		"desc": "Controls whether DAP breakpoint support (stepping, stack frames) is enabled. Requires lucee.dap.secret to be set. When true (default), enables bytecode instrumentation for line-by-line stepping and breakpoints. Set to false for console-only mode without stepping overhead. Requires JVM restart to take effect.",
 		"category": "debugging",
 		"type": "boolean",
 		"default": true

Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ default int[] getExecutableLines(String absolutePath) {`
`98`	`98`	`/**`
`99`	`99`	`* Called when a UDF/method is entered.`
`100`	`100`	`* Allows debuggers to implement function breakpoints (break on function name).`
`101`		`- * Must be fast - called on every function invocation when DEBUGGER_BREAKPOINT is enabled.`
	`101`	`+ * Must be fast - called on every function invocation when DEBUGGER is enabled.`
`102`	`102`	`*`
`103`	`103`	`* @param pc The PageContext executing`
`104`	`104`	`* @param functionName The function name (case as defined in source)`
Original file line number	Diff line number	Diff line change
`@@ -23,11 +23,11 @@ private DebuggerRegistry() {`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`/**`
`26`		`- * Set the debugger listener. Requires the correct secret from LUCEE_DEBUGGER_SECRET.`
	`26`	`+ * Set the debugger listener. Requires the correct secret from LUCEE_DAP_SECRET.`
`27`	`27`	`* Only one listener is supported - setting a new one replaces the old.`
`28`	`28`	`*`
`29`	`29`	`* @param l The listener to register, or null to unregister`
`30`		`- * @param secret The secret that must match LUCEE_DEBUGGER_SECRET`
	`30`	`+ * @param secret The secret that must match LUCEE_DAP_SECRET`
`31`	`31`	`* @return true if registration succeeded, false if secret is invalid`
`32`	`32`	`*/`
`33`	`33`	`public static boolean setListener(DebuggerListener l, String secret) {`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`* Updates the current debugger frame's line number on each block start.`
`13`	`13`	`* Also checks for breakpoints and suspends execution if needed.`
`14`	`14`	`*`
`15`		`- * This is used when DEBUGGER_BREAKPOINT=true to provide line tracking`
	`15`	`+ * This is used when DEBUGGER=true to provide line tracking`
`16`	`16`	`* without requiring bytecode instrumentation in the debugger extension.`
`17`	`17`	`*/`
`18`	`18`	`public final class DebuggerExecutionLog implements ExecutionLogPro {`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,6 @@`
`7`	`7`	`public final class IsDebuggerEnabled implements Function {`
`8`	`8`
`9`	`9`	`public static boolean call(PageContext pc) {`
`10`		`- return ConfigImpl.DEBUGGER_ENABLED;`
	`10`	`+ return ConfigImpl.DEBUGGER;`
`11`	`11`	`}`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ public static boolean call(PageContext pc, String label) {`
`17`	`17`
`18`	`18`	`public static boolean call(PageContext pc, String label, boolean condition) {`
`19`	`19`	`// Only suspend if debugger breakpoint support is enabled AND a debugger client is connected`
`20`		`- if (condition && ConfigImpl.DEBUGGER_BREAKPOINT && DebuggerRegistry.isClientConnected()) {`
	`20`	`+ if (condition && ConfigImpl.DEBUGGER && DebuggerRegistry.isClientConnected()) {`
`21`	`21`	`((PageContextImpl) pc).debuggerSuspend(label);`
`22`	`22`	`return true;`
`23`	`23`	`}`