fix: Add protocol level support for extended properties (#566)

* fix: Add protocol level support for extended properties

* Added tests and always enable 'extended_properties' feature.

Author: zobo

CHANGELOG.md

@@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 - Option to start PHP built-in web server without router script.
 - Extended logging with DBGp packets.
+- Extended properties support. Always enable extended properties so fields are decoded in UTF-8.
 
 ### Changed
 

src/phpDebug.ts

@@ -313,6 +313,10 @@ class PhpDebugSession extends vscode.DebugSession {
                         if (feat_no.supported === '1') {
                             await connection.sendFeatureSetCommand('notify_ok', '1')
                         }
+                        let feat_ep = await connection.sendFeatureGetCommand('extended_properties')
+                        if (feat_ep.supported === '1') {
+                            await connection.sendFeatureSetCommand('extended_properties', '1')
+                        }
 
                         // override features from launch.json
                         try {

src/test/adapter.ts

@@ -399,7 +399,7 @@ describe('PHP Debug Adapter', () => {
                 }),
                 client.waitForEvent('initialized'),
             ])
-            await client.setBreakpointsRequest({ source: { path: program }, breakpoints: [{ line: 17 }] })
+            await client.setBreakpointsRequest({ source: { path: program }, breakpoints: [{ line: 19 }] })
             const [, event] = await Promise.all([
                 client.configurationDoneRequest(),
                 client.waitForEvent('stopped') as Promise<DebugProtocol.StoppedEvent>,
@@ -495,6 +495,38 @@ describe('PHP Debug Adapter', () => {
                 assert.propertyVal(arrayWithSpaceKeyItems[0], 'name', 'space key')
                 assert.propertyVal(arrayWithSpaceKeyItems[0], 'value', '1')
             })
+
+            it('should report values with null correctly', async () => {
+                const arrayExtended = localVariables.find(variable => variable.name === '$arrayExtended')
+                assert.isDefined(arrayExtended)
+                assert.propertyVal(arrayExtended!, 'value', 'array(1)')
+                assert.property(arrayExtended!, 'variablesReference')
+                const arrayExtendedItems = (
+                    await client.variablesRequest({
+                        variablesReference: arrayExtended!.variablesReference,
+                    })
+                ).body.variables
+                assert.lengthOf(arrayExtendedItems, 1)
+                assert.propertyVal(arrayExtendedItems[0], 'name', 'a\0b')
+                assert.propertyVal(arrayExtendedItems[0], 'value', '"c\0d"')
+            })
+
+            it('should report values with unicode correctly', async () => {
+                const arrayExtended = localVariables.find(variable => variable.name === '$arrayExtended2')
+                assert.isDefined(arrayExtended)
+                assert.propertyVal(arrayExtended!, 'value', 'array(2)')
+                assert.property(arrayExtended!, 'variablesReference')
+                const arrayExtendedItems = (
+                    await client.variablesRequest({
+                        variablesReference: arrayExtended!.variablesReference,
+                    })
+                ).body.variables
+                assert.lengthOf(arrayExtendedItems, 2)
+                assert.propertyVal(arrayExtendedItems[0], 'name', 'Приветствие')
+                assert.propertyVal(arrayExtendedItems[0], 'value', '"КУ-КУ"')
+                assert.propertyVal(arrayExtendedItems[1], 'name', 'Прощание')
+                assert.propertyVal(arrayExtendedItems[1], 'value', '"Па-Ка"')
+            })
         })
 
         // support for user defined constants was added in 2.3.0

src/test/dbgp.ts

@@ -6,7 +6,7 @@ import { assert } from 'chai'
 describe('DbgpConnection', () => {
     function makePacket(message: string): Buffer {
         const messageBuffer = iconv.encode(message, ENCODING)
-        return Buffer.concat([new Buffer(messageBuffer.length + '\0'), messageBuffer, new Buffer('\0')])
+        return Buffer.concat([Buffer.from(messageBuffer.length + '\0'), messageBuffer, Buffer.from('\0')])
     }
 
     const message =

src/xdebugConnection.ts

@@ -398,7 +398,7 @@ export class SourceResponse extends Response {
     source: string
     constructor(document: XMLDocument, connection: Connection) {
         super(document, connection)
-        this.source = new Buffer(document.documentElement.textContent!, 'base64').toString()
+        this.source = Buffer.from(document.documentElement.textContent!, 'base64').toString()
     }
 }
 
@@ -464,20 +464,28 @@ export abstract class BaseProperty {
     constructor(propertyNode: Element) {
         if (propertyNode.hasAttribute('name')) {
             this.name = propertyNode.getAttribute('name')!
+        } else if (propertyNode.getElementsByTagName('name').length > 0) {
+            this.name = decodeTag(propertyNode, 'name')
         }
         this.type = propertyNode.getAttribute('type')!
         if (propertyNode.hasAttribute('classname')) {
             this.class = propertyNode.getAttribute('classname')!
+        } else if (propertyNode.getElementsByTagName('classname').length > 0) {
+            this.class = decodeTag(propertyNode, 'classname')
         }
         this.hasChildren = !!parseInt(propertyNode.getAttribute('children')!)
         if (this.hasChildren) {
             this.numberOfChildren = parseInt(propertyNode.getAttribute('numchildren')!)
         } else {
-            const encoding = propertyNode.getAttribute('encoding')
-            if (encoding) {
-                this.value = iconv.encode(propertyNode.textContent!, encoding) + ''
+            if (propertyNode.getElementsByTagName('value').length > 0) {
+                this.value = decodeTag(propertyNode, 'value')
             } else {
-                this.value = propertyNode.textContent!
+                const encoding = propertyNode.getAttribute('encoding')
+                if (encoding) {
+                    this.value = iconv.encode(propertyNode.textContent!, encoding) + ''
+                } else {
+                    this.value = propertyNode.textContent!
+                }
             }
         }
     }
@@ -498,7 +506,11 @@ export class Property extends BaseProperty {
      */
     constructor(propertyNode: Element, context: Context) {
         super(propertyNode)
-        this.fullName = propertyNode.getAttribute('fullname')!
+        if (propertyNode.hasAttribute('fullname')) {
+            this.fullName = propertyNode.getAttribute('fullname')!
+        } else if (propertyNode.getElementsByTagName('fullname').length > 0) {
+            this.fullName = decodeTag(propertyNode, 'fullname')
+        }
         this.context = context
         if (this.hasChildren) {
             this.children = Array.from(propertyNode.childNodes).map(
@@ -518,6 +530,16 @@ export class Property extends BaseProperty {
     }
 }
 
+function decodeTag(propertyNode: Element, tagName: string): string {
+    const tag = propertyNode.getElementsByTagName(tagName).item(0)!
+    const encoding = tag.getAttribute('encoding')
+    if (encoding) {
+        return iconv.encode(tag.textContent!, encoding) + ''
+    } else {
+        return tag.textContent!
+    }
+}
+
 /** The response to a context_get command */
 export class ContextGetResponse extends Response {
     /** the available properties inside the context */
@@ -741,7 +763,7 @@ export class Connection extends DbgpConnection {
             commandString += ' ' + command.args
         }
         if (command.data) {
-            commandString += ' -- ' + new Buffer(command.data).toString('base64')
+            commandString += ' -- ' + Buffer.from(command.data).toString('base64')
         }
         commandString += '\0'
         const data = iconv.encode(commandString, ENCODING)

testproject/variables.php

@@ -13,5 +13,7 @@
 $variableThatsNotSet;
 $aLargeArray = array_fill(0, 100, 'test');
 $arrayWithSpaceKey = array('space key' => 1);
+$arrayExtended = array("a\0b" => "c\0d");
+$arrayExtended2 = array("Приветствие" => "КУ-КУ", "Прощание" => "Па-Ка");
 
 exit;