Explain various non-exportable body cases explicitly in snippets

Author: pimterry

src/components/view/http/http-export-card.tsx

@@ -14,7 +14,7 @@ import { reportError } from '../../../errors';
 
 import { AccountStore } from '../../../model/account/account-store';
 import { UiStore } from '../../../model/ui-store';
-import { generateHarRequest, generateHar } from '../../../model/http/har';
+import { generateHarRequest, generateHar, ExtendedHarRequest } from '../../../model/http/har';
 
 import { ProHeaderPill, CardSalesPitch } from '../../account/pro-placeholders';
 import {
@@ -84,13 +84,33 @@ const snippetEditorOptions = {
     hover: { enabled: false }
 };
 
-const simplifyHarForSnippetExport = (harRequest: HarFormat.Request) => {
+const simplifyHarForSnippetExport = (harRequest: ExtendedHarRequest) => {
+    const postData = !!harRequest.postData
+            ? harRequest.postData
+        : harRequest._requestBodyStatus === 'discarded:not-representable'
+            ? {
+                mimeType: 'text/plain',
+                text: "!!! UNREPRESENTABLE BINARY REQUEST BODY - BODY MUST BE EXPORTED SEPARATELY !!!"
+            }
+        : harRequest._requestBodyStatus === 'discarded:too-large'
+            ? {
+                mimeType: 'text/plain',
+                text: "!!! VERY LARGE REQUEST BODY - BODY MUST BE EXPORTED & INCLUDED SEPARATELY !!!"
+            }
+        : harRequest._requestBodyStatus === 'discarded:not-decodable'
+            ? {
+                mimeType: 'text/plain',
+                text: "!!! REQUEST BODY COULD NOT BE DECODED !!!"
+            }
+        : undefined;
+
     // When exporting code snippets the primary goal is to generate convenient code to send the
     // request that's *sematantically* equivalent to the original request, not to force every
     // tool to produce byte-for-byte identical requests (that's effectively impossible). To do
     // this, we drop headers that tools can produce automatically for themselves:
     return {
         ...harRequest,
+        postData,
         headers: _.filter(harRequest.headers, (header) => {
             // All clients should be able to automatically generate the correct content-length
             // headers as required for a request where it's unspecified. If we override this,

src/model/http/har.ts

@@ -41,8 +41,11 @@ export type RequestContentData = {
     comment?: string;
 };
 
-interface ExtendedHarRequest extends HarFormat.Request {
-    _postDataDiscarded?: boolean;
+export interface ExtendedHarRequest extends HarFormat.Request {
+    _requestBodyStatus?:
+        | 'discarded:too-large'
+        | 'discarded:not-representable'
+        | 'discarded:not-decodable';
     _content?: RequestContentData;
 }
 
@@ -136,7 +139,7 @@ export function generateHarRequest(
 
     if (request.body.decoded) {
         if (request.body.decoded.byteLength > HAR_BODY_SIZE_LIMIT) {
-            requestEntry._postDataDiscarded = true;
+            requestEntry._requestBodyStatus = 'discarded:too-large';
             requestEntry.comment = `Body discarded during HAR generation: longer than limit of ${HAR_BODY_SIZE_LIMIT} bytes`;
         } else {
             try {
@@ -146,6 +149,7 @@ export function generateHarRequest(
                 );
             } catch (e) {
                 if (e instanceof TypeError) {
+                    requestEntry._requestBodyStatus = 'discarded:not-representable';
                     requestEntry._content = {
                         text: request.body.decoded.toString('base64'),
                         size: request.body.decoded.byteLength,
@@ -156,6 +160,8 @@ export function generateHarRequest(
                 }
             }
         }
+    } else {
+        requestEntry._requestBodyStatus = 'discarded:not-decodable';
     }
 
     return requestEntry;