[har] Correctly preserve port information.

This aligns our HAR import/export with Firefox, and stores the remote
port into the "connection" field of the HAR entry, and the Chrome
specific connectionId into a custom "_connectionId" field. The spec[^1]
doesn't strictly require this, but hints that the "connection" field
is a good place to store the (server) port, and since Firefox already
does it this way, we can just as well follow suit.

[^1]: http://www.softwareishard.com/blog/har-12-spec/

Bug: 369859833
Change-Id: Ib2cfe8e30da745ce91e88fbc5768b68cef2e5403
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/5938877
Reviewed-by: Philip Pfaffe <[email protected]>
Commit-Queue: Benedikt Meurer <[email protected]>
Auto-Submit: Benedikt Meurer <[email protected]>

Author: bmeurer

front_end/models/har/HARFormat.ts

@@ -168,6 +168,7 @@ export class HAREntry extends HARBase {
     this.comment = HARBase.optionalString(data['comment']);
 
     // Chrome specific.
+    this.custom.set('connectionId', HARBase.optionalString(data['_connectionId']));
     this.custom.set('fromCache', HARBase.optionalString(data['_fromCache']));
     this.custom.set('initiator', this.importInitiator(data['_initiator']));
     this.custom.set('priority', HARBase.optionalString(data['_priority']));

front_end/models/har/Importer.test.ts

@@ -25,6 +25,7 @@ const exampleLog = new HAR.HARFormat.HARLog({
   }],
   entries: [
     {
+      _connectionId: '1',
       _initiator: {
         type: 'script',
         requestId: '12',
@@ -59,7 +60,7 @@ const exampleLog = new HAR.HARFormat.HARLog({
       _priority: 'High',
       _resourceType: 'xhr',
       cache: {},
-      connection: '1',
+      connection: '6789',
       request: {
         method: 'POST',
         url: 'https://example.com/api/testEndpoint?param1=test',
@@ -118,6 +119,7 @@ const exampleLog = new HAR.HARFormat.HARLog({
     },
     {
       pageref: 'page_0',
+      _connectionId: '1',
       _initiator: {
         type: 'script',
         stack: {
@@ -133,7 +135,7 @@ const exampleLog = new HAR.HARFormat.HARLog({
         },
       },
       cache: {},
-      connection: '1',
+      connection: '6789',
       request: {
         method: 'POST',
         url: 'https://example.com/api/testEndpoint?param2=test2',
@@ -286,4 +288,16 @@ describe('HAR Importer', () => {
       workerStart: 30,
     });
   });
+
+  it('Parses the remote address correctly', () => {
+    for (const request of requests) {
+      assert.strictEqual(request.remoteAddress(), '127.0.0.1:6789');
+    }
+  });
+
+  it('Parses the Chrome-specific connection ID', () => {
+    for (const request of requests) {
+      assert.strictEqual(request.connectionId, '1');
+    }
+  });
 });

front_end/models/har/Importer.ts

@@ -70,7 +70,7 @@ export class Importer {
     } else {
       request.setRequestFormData(false, null);
     }
-    request.connectionId = entry.connection || '';
+    request.connectionId = entry.customAsString('connectionId') || '';
     request.requestMethod = entry.request.method;
     request.setRequestHeaders(entry.request.headers);
 
@@ -121,7 +121,7 @@ export class Importer {
     Importer.setupTiming(request, issueTime, entry.time, entry.timings);
 
     // Meta data.
-    request.setRemoteAddress(entry.serverIPAddress || '', 80);  // Har does not support port numbers.
+    request.setRemoteAddress(entry.serverIPAddress || '', Number(entry.connection) || 80);
     request.setResourceType(Importer.getResourceType(request, entry, pageLoad));
 
     const priority = entry.customAsString('priority');

front_end/models/har/Log.test.ts

@@ -116,6 +116,29 @@ describe('HAR', () => {
           assert.strictEqual(entry._initiator?.requestId, requestId);
         });
 
+        it('exports remote address', async () => {
+          const request = SDK.NetworkRequest.NetworkRequest.create(
+              requestId, url, Platform.DevToolsPath.EmptyUrlString, null, null,
+              {requestId, type: Protocol.Network.InitiatorType.Script});
+          request.setRemoteAddress('127.0.0.1', 6789);
+
+          const entry = await build(request, {sanitize: false});
+
+          assert.strictEqual(entry.serverIPAddress, '127.0.0.1');
+          assert.strictEqual(entry.connection, '6789');
+        });
+
+        it('exports Chrome-specific connection ID', async () => {
+          const request = SDK.NetworkRequest.NetworkRequest.create(
+              requestId, url, Platform.DevToolsPath.EmptyUrlString, null, null,
+              {requestId, type: Protocol.Network.InitiatorType.Script});
+          request.connectionId = 'foobar';
+
+          const entry = await build(request, {sanitize: false});
+
+          assert.strictEqual(entry._connectionId, 'foobar');
+        });
+
         it('exports Service Worker info', async () => {
           const request = SDK.NetworkRequest.NetworkRequest.create(
               requestId, url, Platform.DevToolsPath.EmptyUrlString, null, null,

front_end/models/har/Log.ts

@@ -114,10 +114,10 @@ export class Entry {
     const harEntry = new Entry(request);
     let ipAddress = harEntry.request.remoteAddress();
     const portPositionInString = ipAddress.lastIndexOf(':');
+    const connection = portPositionInString !== -1 ? ipAddress.substring(portPositionInString + 1) : undefined;
     if (portPositionInString !== -1) {
       ipAddress = ipAddress.substr(0, portPositionInString);
     }
-
     const timings = harEntry.buildTimings();
     let time = 0;
     // "ssl" is included in the connect field, so do not double count it.
@@ -146,13 +146,14 @@ export class Entry {
     }
 
     const entry: EntryDTO = {
+      _connectionId: undefined,
       _fromCache: undefined,
       _initiator: exportedInitiator,
       _priority: harEntry.request.priority(),
       _resourceType: harEntry.request.resourceType().name(),
       _webSocketMessages: undefined,
       cache: {},
-      connection: undefined,
+      connection,
       pageref: undefined,
       request: await harEntry.buildRequest(),
       response: harEntry.buildResponse(),
@@ -183,9 +184,9 @@ export class Entry {
     }
 
     if (harEntry.request.connectionId !== '0') {
-      entry.connection = harEntry.request.connectionId;
+      entry._connectionId = harEntry.request.connectionId;
     } else {
-      delete entry.connection;
+      delete entry._connectionId;
     }
 
     const page = SDK.PageLoad.PageLoad.forRequest(harEntry.request);
@@ -507,6 +508,7 @@ export interface Response {
 }
 
 export interface EntryDTO {
+  _connectionId?: string;
   _fromCache?: string;
   _initiator: Protocol.Network.Initiator|null;
   _priority: Protocol.Network.ResourcePriority|null;