chrome-devtools-frontend 1.0.1367881 → 1.0.1380117

package/front_end/panels/freestyler/DrJonesNetworkAgent.test.ts

@@ -2,28 +2,51 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-import * as Host from '../../core/host/host.js';
+import type * as Host from '../../core/host/host.js';
 import type * as Platform from '../../core/platform/platform.js';
 import * as SDK from '../../core/sdk/sdk.js';
 import type * as Protocol from '../../generated/protocol.js';
 import * as Logs from '../../models/logs/logs.js';
+import type * as Network from '../../panels/network/network.js';
 import {
-  describeWithEnvironment,
   getGetHostConfigStub,
 } from '../../testing/EnvironmentHelpers.js';
+import {describeWithMockConnection} from '../../testing/MockConnection.js';
+import {createNetworkPanelForMockConnection} from '../../testing/NetworkHelpers.js';
+import * as Coordinator from '../../ui/components/render_coordinator/render_coordinator.js';
 
-import {DrJonesNetworkAgent, ResponseType} from './freestyler.js';
+import {
+  allowHeader,
+  DrJonesNetworkAgent,
+  formatHeaders,
+  formatInitiatorUrl,
+  RequestContext,
+  ResponseType,
+} from './freestyler.js';
+
+const coordinator = Coordinator.RenderCoordinator.RenderCoordinator.instance();
+
+describeWithMockConnection('DrJonesNetworkAgent', () => {
+  let networkPanel: Network.NetworkPanel.NetworkPanel;
 
-describeWithEnvironment('DrJonesNetworkAgent', () => {
   function mockHostConfig(modelId?: string, temperature?: number) {
     getGetHostConfigStub({
-      devToolsExplainThisResourceDogfood: {
+      devToolsAiAssistanceNetworkAgent: {
         modelId,
         temperature,
       },
     });
   }
 
+  beforeEach(async () => {
+    networkPanel = await createNetworkPanelForMockConnection();
+  });
+
+  afterEach(async () => {
+    await coordinator.done();
+    networkPanel.detach();
+  });
+
   describe('buildRequest', () => {
     beforeEach(() => {
       sinon.restore();
@@ -59,20 +82,16 @@ describeWithEnvironment('DrJonesNetworkAgent', () => {
         serverSideLoggingEnabled: true,
       });
       sinon.stub(agent, 'preamble').value('preamble');
-      agent.chatHistoryForTesting = new Map([[
+      agent.chatNewHistoryForTesting = new Map([[
         0,
         [
           {
-            text: 'first',
-            entity: Host.AidaClient.Entity.UNKNOWN,
+            type: ResponseType.QUERYING,
+            query: 'questions',
           },
           {
-            text: 'second',
-            entity: Host.AidaClient.Entity.SYSTEM,
-          },
-          {
-            text: 'third',
-            entity: Host.AidaClient.Entity.USER,
+            type: ResponseType.ANSWER,
+            text: 'answer',
           },
         ],
       ]]);
@@ -86,16 +105,12 @@ describeWithEnvironment('DrJonesNetworkAgent', () => {
             preamble: 'preamble',
             chat_history: [
               {
-                entity: 0,
-                text: 'first',
+                entity: 1,
+                text: 'questions',
               },
               {
                 entity: 2,
-                text: 'second',
-              },
-              {
-                entity: 1,
-                text: 'third',
+                text: 'answer',
               },
             ],
             metadata: {
@@ -138,8 +153,9 @@ describeWithEnvironment('DrJonesNetworkAgent', () => {
           'requestId' as Protocol.Network.RequestId, 'https://www.example.com' as Platform.DevToolsPath.UrlString,
           '' as Platform.DevToolsPath.UrlString, null, null, null);
       selectedNetworkRequest.statusCode = 200;
-      selectedNetworkRequest.setRequestHeaders([{name: 'foo1', value: 'bar1'}]);
-      selectedNetworkRequest.responseHeaders = [{name: 'foo2', value: 'bar2'}, {name: 'foo3', value: 'bar3'}];
+      selectedNetworkRequest.setRequestHeaders([{name: 'content-type', value: 'bar1'}]);
+      selectedNetworkRequest.responseHeaders =
+          [{name: 'content-type', value: 'bar2'}, {name: 'x-forwarded-for', value: 'bar3'}];
       selectedNetworkRequest.timing = timingInfo;
 
       const initiatorNetworkRequest = SDK.NetworkRequest.NetworkRequest.create(
@@ -206,55 +222,48 @@ describeWithEnvironment('DrJonesNetworkAgent', () => {
         aidaClient: mockAidaClient(generateAnswer),
       });
 
-      const responses = await Array.fromAsync(agent.run('test', {selectedNetworkRequest}));
+      const responses =
+          await Array.fromAsync(agent.run('test', {selected: new RequestContext(selectedNetworkRequest)}));
       assert.deepStrictEqual(responses, [
         {
-          type: ResponseType.TITLE,
-          title: 'Inspecting network data',
+          type: ResponseType.USER_QUERY,
+          query: 'test',
         },
         {
-          type: ResponseType.THOUGHT,
-          thought: 'Data used to generate this response',
-          contextDetails: [
+          type: ResponseType.CONTEXT,
+          title: 'Analyzing network data',
+          details: [
             {
               title: 'Request',
-              text: 'Request URL: https://www.example.com\n\nRequest Headers\nfoo1: bar1',
+              text: 'Request URL: https://www.example.com\n\nRequest Headers\ncontent-type: bar1',
             },
             {
               title: 'Response',
-              text: 'Response Status: 200 \n\nResponse Headers\nfoo2: bar2\nfoo3: bar3',
+              text: 'Response Status: 200 \n\nResponse Headers\ncontent-type: bar2\nx-forwarded-for: bar3',
             },
             {
               title: 'Timing',
-              text: `Request start time: 500
-Request end time: -1
-Receiving response headers start time: 1000
-Receiving response headers end time: 0
-Proxy negotiation start time: 0
-Proxy negotiation end time: 0
-DNS lookup start time: 0
-DNS lookup end time: 0
-TCP start time: 0
-TCP end time: 0
-SSL start time: 0
-SSL end time: 0
-Sending start: 800
-Sending end: 900
-`,
+              text:
+                  'Queued at (timestamp): 0 μs\nStarted at (timestamp): 8.4 min\nQueueing (duration): 8.4 min\nConnection start (stalled) (duration): 800.00 ms\nRequest sent (duration): 100.00 ms\nDuration (duration): 8.4 min',
             },
             {
-              title: 'Request Initiator Chain',
-              text: `- URL: https://www.initiator.com
+              title: 'Request initiator chain',
+              text: `- URL: <redacted cross-origin initiator URL>
 \t- URL: https://www.example.com
 \t\t- URL: https://www.example.com/1
-\t\t- URL: https://www.example.com/2
-`,
+\t\t- URL: https://www.example.com/2`,
             },
           ],
         },
+        {
+          type: ResponseType.QUERYING,
+          query:
+              '# Selected network request \nRequest: https://www.example.com\n\nRequest headers:\ncontent-type: bar1\n\nResponse headers:\ncontent-type: bar2\nx-forwarded-for: bar3\n\nResponse status: 200 \n\nRequest timing:\nQueued at (timestamp): 0 μs\nStarted at (timestamp): 8.4 min\nQueueing (duration): 8.4 min\nConnection start (stalled) (duration): 800.00 ms\nRequest sent (duration): 100.00 ms\nDuration (duration): 8.4 min\n\nRequest initiator chain:\n- URL: <redacted cross-origin initiator URL>\n\t- URL: https://www.example.com\n\t\t- URL: https://www.example.com/1\n\t\t- URL: https://www.example.com/2\n\n# User request\n\ntest',
+        },
         {
           type: ResponseType.ANSWER,
           text: 'This is the answer',
+          suggestions: undefined,
           rpcId: 123,
         },
       ]);
@@ -264,37 +273,27 @@ Sending end: 900
           text: `# Selected network request \nRequest: https://www.example.com
 
 Request headers:
-foo1: bar1
+content-type: bar1
 
 Response headers:
-foo2: bar2
-foo3: bar3
+content-type: bar2
+x-forwarded-for: bar3
 
 Response status: 200 \n
-Request Timing:
-Request start time: 500
-Request end time: -1
-Receiving response headers start time: 1000
-Receiving response headers end time: 0
-Proxy negotiation start time: 0
-Proxy negotiation end time: 0
-DNS lookup start time: 0
-DNS lookup end time: 0
-TCP start time: 0
-TCP end time: 0
-SSL start time: 0
-SSL end time: 0
-Sending start: 800
-Sending end: 900
-
+Request timing:
+Queued at (timestamp): 0 μs
+Started at (timestamp): 8.4 min
+Queueing (duration): 8.4 min
+Connection start (stalled) (duration): 800.00 ms
+Request sent (duration): 100.00 ms
+Duration (duration): 8.4 min
 
-Request Initiator Chain:
-- URL: https://www.initiator.com
+Request initiator chain:
+- URL: <redacted cross-origin initiator URL>
 \t- URL: https://www.example.com
 \t\t- URL: https://www.example.com/1
 \t\t- URL: https://www.example.com/2
 
-
 # User request
 
 test`,
@@ -306,4 +305,76 @@ test`,
       ]);
     });
   });
+
+  describe('allowHeader', () => {
+    it('allows a header from the list', () => {
+      assert.isTrue(allowHeader({name: 'content-type', value: 'foo'}));
+    });
+
+    it('disallows headers not on the list', () => {
+      assert.isFalse(allowHeader({name: 'cookie', value: 'foo'}));
+      assert.isFalse(allowHeader({name: 'set-cookie', value: 'foo'}));
+      assert.isFalse(allowHeader({name: 'authorization', value: 'foo'}));
+    });
+  });
+
+  describe('formatInitiatorUrl', () => {
+    const tests = [
+      {
+        allowedResource: 'https://example.test',
+        targetResource: 'https://example.test',
+        shouldBeRedacted: false,
+      },
+      {
+        allowedResource: 'https://example.test',
+        targetResource: 'https://another-example.test',
+        shouldBeRedacted: true,
+      },
+      {
+        allowedResource: 'file://test',
+        targetResource: 'https://another-example.test',
+        shouldBeRedacted: true,
+      },
+      {
+        allowedResource: 'https://another-example.test',
+        targetResource: 'file://test',
+        shouldBeRedacted: true,
+      },
+      {
+        allowedResource: 'https://test.example.test',
+        targetResource: 'https://example.test',
+        shouldBeRedacted: true,
+      },
+      {
+        allowedResource: 'https://test.example.test:9900',
+        targetResource: 'https://test.example.test:9901',
+        shouldBeRedacted: true,
+      },
+    ];
+
+    for (const t of tests) {
+      it(`${t.targetResource} test when allowed resource is ${t.allowedResource}`, () => {
+        const formatted = formatInitiatorUrl(new URL(t.targetResource).origin, new URL(t.allowedResource).origin);
+        if (t.shouldBeRedacted) {
+          assert.strictEqual(
+              formatted, '<redacted cross-origin initiator URL>', `${JSON.stringify(t)} was not redacted`);
+        } else {
+          assert.strictEqual(formatted, t.targetResource, `${JSON.stringify(t)} was redacted`);
+        }
+      });
+    }
+  });
+
+  describe('formatHeaders', () => {
+    it('does not redact a header from the list', () => {
+      assert.strictEqual(formatHeaders('test:', [{name: 'content-type', value: 'foo'}]), 'test:\ncontent-type: foo');
+    });
+
+    it('disallows headers not on the list', () => {
+      assert.strictEqual(formatHeaders('test:', [{name: 'cookie', value: 'foo'}]), 'test:\ncookie: <redacted>');
+      assert.strictEqual(formatHeaders('test:', [{name: 'set-cookie', value: 'foo'}]), 'test:\nset-cookie: <redacted>');
+      assert.strictEqual(
+          formatHeaders('test:', [{name: 'authorization', value: 'foo'}]), 'test:\nauthorization: <redacted>');
+    });
+  });
 });