Persist pins when exporting/importing to HAR

Author: pimterry

src/model/events/events-store.ts

@@ -562,7 +562,8 @@ export class EventsStore {
             requests,
             responses,
             aborts,
-            tlsErrors
+            tlsErrors,
+            pinnedIds
         } = await parseHar(harContents).catch((harParseError: HarParseError) => {
             // Log all suberrors, for easier reporting & debugging.
             // This does not include HAR data - only schema errors like
@@ -590,6 +591,14 @@ export class EventsStore {
         );
 
         this.queueEventFlush();
+
+        if (pinnedIds.length) {
+            // This rAF will be scheduled after the queued flush, so the event should
+            // always be fully imported by this stage:
+            requestAnimationFrame(action(() => pinnedIds.forEach((id) => {
+                this.events.find(e => e.id === id)!.pinned = true;
+            })));
+        }
     }
 
 }

src/model/http/har.ts

@@ -32,6 +32,9 @@ export interface Har extends HarFormat.Har {
 interface HarLog extends HarFormat.Log {
     // Custom field to expose failed TLS connections
     _tlsErrors: HarTlsErrorEntry[];
+
+    // Our extended version of HAR entries:
+    entries: HarEntry[];
 }
 
 export type RequestContentData = {
@@ -49,7 +52,10 @@ export interface ExtendedHarRequest extends HarFormat.Request {
     _content?: RequestContentData;
 }
 
-export type HarEntry = HarFormat.Entry;
+export interface HarEntry extends HarFormat.Entry {
+    _pinned?: true;
+}
+
 export type HarTlsErrorEntry = {
     startedDateTime: string;
     time: number; // Floating-point high-resolution duration, in ms
@@ -345,7 +351,8 @@ async function generateHarEntry(exchange: HttpExchange): Promise<HarEntry> {
             send: Math.max(sendDuration, 0),
             wait: Math.max(waitDuration, 0),
             receive: Math.max(receiveDuration, 0)
-        }
+        },
+        _pinned: exchange.pinned || undefined
     };
 }
 
@@ -375,6 +382,7 @@ export type ParsedHar = {
     responses: HarResponse[],
     aborts: HarRequest[],
     tlsErrors: InputTLSRequest[]
+    pinnedIds: string[]
 };
 
 const sumTimings = (
@@ -396,6 +404,7 @@ export async function parseHar(harContents: unknown): Promise<ParsedHar> {
     const responses: HarResponse[] = [];
     const aborts: HarRequest[] = [];
     const tlsErrors: InputTLSRequest[] = [];
+    const pinnedIds: string[] = []
 
     har.log.entries.forEach((entry, i) => {
         const id = baseId + i;
@@ -429,6 +438,8 @@ export async function parseHar(harContents: unknown): Promise<ParsedHar> {
         } else {
             aborts.push(request);
         }
+
+        if (entry._pinned) pinnedIds.push(id);
     });
 
     if (har.log._tlsErrors) {
@@ -448,7 +459,7 @@ export async function parseHar(harContents: unknown): Promise<ParsedHar> {
         });
     }
 
-    return { requests, responses, aborts, tlsErrors };
+    return { requests, responses, aborts, tlsErrors, pinnedIds };
 }
 
 // Mutatively cleans & returns the HAR, to tidy up irrelevant but potentially