fix(Sync): Do not show conflicts for empty keys (#7556)

* Remove keys that have empty values and can be undefined in a model

* only scripts can be undefined for now

* New fields are now initialized as undefined

* update tests

Author: gatzjames

packages/insomnia/src/common/__tests__/export.test.ts

@@ -268,7 +268,7 @@ describe('export', () => {
     const exportWorkspacesDataJson = JSON.parse(exportedWorkspacesJson);
     const exportWorkspacesDataYaml = YAML.parse(exportedWorkspacesYaml);
     // Ensure JSON is the same as YAML
-    expect(exportWorkspacesDataJson.resources).toEqual(exportWorkspacesDataYaml.resources);
+    expect(exportWorkspacesDataYaml.resources).toMatchObject(exportWorkspacesDataJson.resources);
     expect(exportWorkspacesDataJson).toMatchObject({
       _type: 'export',
       __export_format: 4,

packages/insomnia/src/common/export.tsx

@@ -268,10 +268,11 @@ export async function exportRequestsData(
       return d;
     });
 
+  const stringifiedData = JSON.stringify(data);
   if (format.toLowerCase() === 'yaml') {
-    return YAML.stringify(data);
+    return YAML.stringify(JSON.parse(stringifiedData));
   } else if (format.toLowerCase() === 'json') {
-    return JSON.stringify(data);
+    return stringifiedData;
   } else {
     throw new Error(`Invalid export format ${format}. Must be "json" or "yaml"`);
   }

packages/insomnia/src/models/__tests__/request.test.ts

@@ -20,9 +20,9 @@ describe('init()', () => {
       name: 'New Request',
       description: '',
       parameters: [],
-      pathParameters: [],
-      preRequestScript: '',
-      afterResponseScript: '',
+      pathParameters: undefined,
+      preRequestScript: undefined,
+      afterResponseScript: undefined,
       url: '',
       settingStoreCookies: true,
       settingSendCookies: true,
@@ -59,9 +59,9 @@ describe('create()', () => {
       method: 'GET',
       name: 'Test Request',
       parameters: [],
-      pathParameters: [],
-      preRequestScript: '',
-      afterResponseScript: '',
+      pathParameters: undefined,
+      preRequestScript: undefined,
+      afterResponseScript: undefined,
       url: '',
       settingStoreCookies: true,
       settingSendCookies: true,
@@ -394,9 +394,9 @@ describe('migrate()', () => {
       headers: [],
       authentication: {},
       parameters: [],
-      pathParameters: [],
-      preRequestScript: '',
-      afterResponseScript: '',
+      pathParameters: undefined,
+      preRequestScript: undefined,
+      afterResponseScript: undefined,
       parentId: null,
       body: {
         mimeType: '',

packages/insomnia/src/models/request-group.ts

@@ -17,8 +17,8 @@ interface BaseRequestGroup {
   environment: Record<string, any>;
   environmentPropertyOrder: Record<string, any> | null;
   metaSortKey: number;
-  preRequestScript: string;
-  afterResponseScript: string;
+  preRequestScript?: string;
+  afterResponseScript?: string;
   authentication?: RequestAuthentication | {};
   headers?: RequestHeader[];
 }
@@ -36,10 +36,10 @@ export function init(): BaseRequestGroup {
     environment: {},
     environmentPropertyOrder: null,
     metaSortKey: -1 * Date.now(),
-    preRequestScript: '',
-    afterResponseScript: '',
-    authentication: {},
-    headers: [],
+    preRequestScript: undefined,
+    afterResponseScript: undefined,
+    authentication: undefined,
+    headers: undefined,
   };
 }
 

packages/insomnia/src/models/request.ts

@@ -251,10 +251,10 @@ export interface BaseRequest {
   description: string;
   method: string;
   body: RequestBody;
-  preRequestScript: string;
-  afterResponseScript: string;
+  preRequestScript?: string;
+  afterResponseScript?: string;
   parameters: RequestParameter[];
-  pathParameters: RequestPathParameter[];
+  pathParameters?: RequestPathParameter[];
   headers: RequestHeader[];
   authentication: RequestAuthentication | {};
   metaSortKey: number;
@@ -289,14 +289,14 @@ export function init(): BaseRequest {
     description: '',
     method: METHOD_GET,
     body: {},
-    preRequestScript: '',
-    afterResponseScript: '',
     parameters: [],
     headers: [],
     authentication: {},
+    preRequestScript: undefined,
     metaSortKey: -1 * Date.now(),
     isPrivate: false,
-    pathParameters: [],
+    pathParameters: undefined,
+    afterResponseScript: undefined,
     // Settings
     settingStoreCookies: true,
     settingSendCookies: true,

packages/insomnia/src/models/websocket-request.ts

@@ -20,7 +20,7 @@ export interface BaseWebSocketRequest {
   headers: RequestHeader[];
   authentication: RequestAuthentication | {};
   parameters: RequestParameter[];
-  pathParameters: RequestPathParameter[];
+  pathParameters?: RequestPathParameter[];
   settingEncodeUrl: boolean;
   settingStoreCookies: boolean;
   settingSendCookies: boolean;
@@ -44,7 +44,7 @@ export const init = (): BaseWebSocketRequest => ({
   headers: [],
   authentication: {},
   parameters: [],
-  pathParameters: [],
+  pathParameters: undefined,
   settingEncodeUrl: true,
   settingStoreCookies: true,
   settingSendCookies: true,

packages/insomnia/src/plugins/context/__tests__/data.test.ts

@@ -195,9 +195,9 @@ describe('app.export.*', () => {
           modified: 222,
           name: 'New Request',
           parameters: [],
-          pathParameters: [],
-          preRequestScript: '',
-          afterResponseScript: '',
+          pathParameters: undefined,
+          preRequestScript: undefined,
+          afterResponseScript: undefined,
           parentId: 'wrk_1',
           settingDisableRenderRequestBody: false,
           settingEncodeUrl: true,

packages/insomnia/src/ui/components/panes/request-pane.tsx

@@ -80,7 +80,7 @@ export const RequestPane: FC<Props> = ({
   if (!activeRequest) {
     return <PlaceholderRequestPane />;
   }
-  const pathParameters = getCombinedPathParametersFromUrl(activeRequest.url, activeRequest.pathParameters);
+  const pathParameters = getCombinedPathParametersFromUrl(activeRequest.url, activeRequest.pathParameters || []);
 
   const onPathParameterChange = (pathParameters: RequestParameter[]) => {
     patchRequest(requestId, { pathParameters });

packages/insomnia/src/ui/components/websockets/websocket-request-pane.tsx

@@ -227,7 +227,7 @@ export const WebSocketRequestPane: FC<Props> = ({ environment }) => {
   };
 
   // Path parameters are path segments that start with a colon (:)
-  const pathParameters = getCombinedPathParametersFromUrl(activeRequest.url, activeRequest.pathParameters);
+  const pathParameters = getCombinedPathParametersFromUrl(activeRequest.url, activeRequest.pathParameters || []);
 
   const onPathParameterChange = (pathParameters: RequestPathParameter[]) => {
     patchRequest(requestId, { pathParameters });