Control socket pause.

Author: zobo

package-lock.json

@@ -46,6 +46,7 @@
     "@vscode/debugadapter": "^1.57.0",
     "@vscode/debugprotocol": "^1.55.1",
     "@xmldom/xmldom": "^0.8.4",
+    "abstract-socket": "^2.1.1",
     "buffer-crc32": "^0.2.13",
     "dotenv": "^16.0.3",
     "file-url": "^3.0.0",

package.json

@@ -0,0 +1,13 @@
+/// <reference types="node" />
+declare module "abstract-socket" {
+    export function createServer(listener: any): AbstractSocketServer;
+    export function connect(name: any, connectListener: any): net.Socket;
+    export function createConnection(name: any, connectListener: any): net.Socket;
+    class AbstractSocketServer extends net.Server {
+        // constructor(listener: any);
+        // listen(path: string, listener: () => void): net.Socket;
+        // listen(path: string, listeningListener?: () => void): this;
+    }
+    import net = require("net");
+    export {};
+}

src/abstract-socket.d.ts

@@ -19,6 +19,7 @@ import { randomUUID } from 'crypto'
 import { getConfiguredEnvironment } from './envfile'
 import { XdebugCloudConnection } from './cloud'
 import { shouldIgnoreException } from './ignore'
+import * as abs from 'abstract-socket'
 
 if (process.env['VSCODE_NLS_CONFIG']) {
     try {
@@ -1382,10 +1383,47 @@ class PhpDebugSession extends vscode.DebugSession {
         }
     }
 
-    protected pauseRequest(
+    protected async pauseRequest(
         response: VSCodeDebugProtocol.PauseResponse,
         args: VSCodeDebugProtocol.PauseArguments
-    ): void {
+    ): Promise<void> {
+        // test
+        let connection: xdebug.Connection | undefined
+        connection = this._connections.get(args.threadId)
+        if (!connection) {
+            return this.sendErrorResponse(response, new Error(`Unknown thread ID ${args.threadId}`))
+        }
+
+        let initPacket = await connection.waitForInitPacket()
+        const supportedControl =
+            process.platform === 'linux' &&
+            initPacket.engineName === 'Xdebug' &&
+            semver.valid(initPacket.engineVersion, { loose: true }) &&
+            (semver.gte(initPacket.engineVersion, '3.4.0', { loose: true }) || initPacket.engineVersion === '3.4.0-dev')
+
+        if (supportedControl) {
+            let cs = `\0xdebug-ctrl.${initPacket.appId}y`.padEnd(108, 'x')
+            try {
+                const sock = abs.connect(cs, () => {
+                    sock.write("pause\0")
+                    if (this._skippingFiles.has(args.threadId)) {
+                        this._skippingFiles.set(args.threadId, false)
+                    }
+                    this.sendResponse(response)
+                })
+                sock.on('data', (data) => {
+                    // todo
+                })
+                sock.on('error', (error) => {
+                    this.sendErrorResponse(response, new Error('Cannot connect to Xdebug control socket'))    
+                })
+                return
+            } catch (error) {
+                this.sendErrorResponse(response, new Error('Cannot connect to Xdebug control socket'))
+                return
+            }
+        }
+        // test
         if (this._skippingFiles.has(args.threadId)) {
             this._skippingFiles.set(args.threadId, false)
             this.sendResponse(response)

src/phpDebug.ts

@@ -18,6 +18,8 @@ export class InitPacket {
     engineVersion: string
     /** the name of the engine */
     engineName: string
+    /** the app id (PID) */
+    appId: string
     /**
      * @param  {XMLDocument} document - An XML document to read from
      * @param  {Connection} connection
@@ -30,6 +32,7 @@ export class InitPacket {
         this.ideKey = documentElement.getAttribute('idekey')!
         this.engineVersion = documentElement.getElementsByTagName('engine').item(0)?.getAttribute('version') ?? ''
         this.engineName = documentElement.getElementsByTagName('engine').item(0)?.textContent ?? ''
+        this.appId = documentElement.getAttribute('appid') ?? ''
         this.connection = connection
     }
 }