feat: update skipNetworkIdleEvent default value

cherfia · Oct 1, 2024 · 9f5a53d · 9f5a53d
1 parent 2eb91cf
commit 9f5a53d
Show file tree

Hide file tree

Showing 11 changed files with 19 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -269,7 +269,7 @@ type ConversionOptions = {
   extraHttpHeaders?: Record<string, string>; // Include additional HTTP headers in the request
   failOnHttpStatusCodes?: number[]; // List of HTTP status codes triggering a 409 Conflict response (default [499, 599])
   failOnConsoleExceptions?: boolean; // Return a 409 Conflict response if there are exceptions in the Chromium console (default false)
-  skipNetworkIdleEvent?: boolean; // Do not wait for Chromium network to be idle (default false)
+  skipNetworkIdleEvent?: boolean; // Do not wait for Chromium network to be idle (default true)
   metadata?: Metadata; // Metadata to be written.
   cookies?: Cookie[]; // Cookies to be written.
   downloadFrom?: DownloadFrom; //Download a file from a URL. It must return a Content-Disposition header with a filename parameter.
@@ -304,7 +304,7 @@ type ScreenshotOptions = {
   extraHttpHeaders?: Record<string, string>;
   failOnHttpStatusCodes?: number[]; // Return a 409 Conflict response if the HTTP status code is in the list (default [499,599])
   failOnConsoleExceptions?: boolean; // Return a 409 Conflict response if there are exceptions in the Chromium console (default false)
-  skipNetworkIdleEvent?: boolean; // Do not wait for Chromium network to be idle (default false)
+  skipNetworkIdleEvent?: boolean; // Do not wait for Chromium network to be idle (default true)
   optimizeForSpeed?: boolean; // Define whether to optimize image encoding for speed, not for resulting size.
   cookies?: Cookie[]; // Cookies to be written.
   downloadFrom?: DownloadFrom; // Download the file from a specific URL. It must return a Content-Disposition header with a filename parameter.

diff --git a/src/chromium/converters/tests/html.converter.test.ts b/src/chromium/converters/tests/html.converter.test.ts
@@ -139,7 +139,7 @@ describe('HtmlConverter', () => {
                 mockFetch.mockResolvedValue(new Response('content'));
                 const buffer = await converter.convert({
                     html: Buffer.from('data'),
-                    skipNetworkIdleEvent: true
+                    skipNetworkIdleEvent: false
                 });
                 expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
                 expect(buffer).toEqual(Buffer.from('content'));

diff --git a/src/chromium/converters/tests/markdown.converter.test.ts b/src/chromium/converters/tests/markdown.converter.test.ts
@@ -130,7 +130,7 @@ describe('MarkdownConverter', () => {
                 const buffer = await converter.convert({
                     html: Buffer.from('data'),
                     markdown: Buffer.from('markdown'),
-                    skipNetworkIdleEvent: true
+                    skipNetworkIdleEvent: false
                 });
                 expect(mockFormDataAppend).toHaveBeenCalledTimes(3);
                 expect(buffer).toEqual(Buffer.from('content'));

diff --git a/src/chromium/converters/tests/url.converter.test.ts b/src/chromium/converters/tests/url.converter.test.ts
@@ -119,7 +119,7 @@ describe('HtmlConverter', () => {
                 mockFetch.mockResolvedValue(new Response('content'));
                 const buffer = await converter.convert({
                     url: 'http://www.example.com/',
-                    skipNetworkIdleEvent: true
+                    skipNetworkIdleEvent: false
                 });
                 expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
                 expect(buffer).toEqual(Buffer.from('content'));

diff --git a/src/chromium/screenshots/tests/html.screenshot.test.ts b/src/chromium/screenshots/tests/html.screenshot.test.ts
@@ -84,7 +84,7 @@ describe('HtmlScreenshot', () => {
                 mockFetch.mockResolvedValue(new Response('content'));
                 const buffer = await screenshot.capture({
                     html: Buffer.from('data'),
-                    skipNetworkIdleEvent: true
+                    skipNetworkIdleEvent: false
                 });
                 expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
                 expect(buffer).toEqual(Buffer.from('content'));
@@ -111,7 +111,7 @@ describe('HtmlScreenshot', () => {
                     html: Buffer.from('data'),
                     emulatedMediaType: 'screen',
                     failOnHttpStatusCodes: [499, 599],
-                    skipNetworkIdleEvent: true,
+                    skipNetworkIdleEvent: false,
                     failOnConsoleExceptions: true,
                     properties: { format: 'jpeg', quality: 50 },
                     optimizeForSpeed: true,

diff --git a/src/chromium/screenshots/tests/markdown.screenshot.test.ts b/src/chromium/screenshots/tests/markdown.screenshot.test.ts
@@ -90,7 +90,7 @@ describe('MarkdownScreenshot', () => {
                 const buffer = await screenshot.capture({
                     html: Buffer.from('data'),
                     markdown: Buffer.from('markdown'),
-                    skipNetworkIdleEvent: true
+                    skipNetworkIdleEvent: false
                 });
                 expect(mockFormDataAppend).toHaveBeenCalledTimes(3);
                 expect(buffer).toEqual(Buffer.from('content'));
@@ -105,7 +105,7 @@ describe('MarkdownScreenshot', () => {
                     markdown: Buffer.from('markdown'),
                     emulatedMediaType: 'screen',
                     failOnHttpStatusCodes: [499, 599],
-                    skipNetworkIdleEvent: true,
+                    skipNetworkIdleEvent: false,
                     failOnConsoleExceptions: true,
                     properties: { format: 'jpeg', quality: 50 },
                     optimizeForSpeed: true,

diff --git a/src/chromium/screenshots/tests/url.screenshot.test.ts b/src/chromium/screenshots/tests/url.screenshot.test.ts
@@ -82,7 +82,7 @@ describe('URLScreenshot', () => {
                 mockFetch.mockResolvedValue(new Response('content'));
                 const buffer = await screenshot.capture({
                     url: 'http://www.example.com/',
-                    skipNetworkIdleEvent: true
+                    skipNetworkIdleEvent: false
                 });
                 expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
                 expect(buffer).toEqual(Buffer.from('content'));
@@ -108,7 +108,7 @@ describe('URLScreenshot', () => {
                     url: 'http://www.example.com/',
                     emulatedMediaType: 'screen',
                     failOnHttpStatusCodes: [499, 599],
-                    skipNetworkIdleEvent: true,
+                    skipNetworkIdleEvent: false,
                     failOnConsoleExceptions: true,
                     properties: { format: 'jpeg', quality: 50 },
                     optimizeForSpeed: true,

diff --git a/src/chromium/utils/converter.utils.ts b/src/chromium/utils/converter.utils.ts
@@ -170,7 +170,7 @@ export class ConverterUtils {
             );
         }
 
-        if (options.skipNetworkIdleEvent) {
+        if (options.skipNetworkIdleEvent === false) {
             data.append(
                 'skipNetworkIdleEvent',
                 String(options.skipNetworkIdleEvent)

diff --git a/src/chromium/utils/screenshot.utils.ts b/src/chromium/utils/screenshot.utils.ts
@@ -103,7 +103,7 @@ export class ScreenshotUtils {
             );
         }
 
-        if (options.skipNetworkIdleEvent) {
+        if (options.skipNetworkIdleEvent === false) {
             data.append(
                 'skipNetworkIdleEvent',
                 String(options.skipNetworkIdleEvent)

diff --git a/src/chromium/utils/tests/converter.utils.test.ts b/src/chromium/utils/tests/converter.utils.test.ts
@@ -431,7 +431,7 @@ describe('ConverterUtils', () => {
                         'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36',
                     extraHttpHeaders: { 'X-Custom-Header': 'value' },
                     failOnHttpStatusCodes: [499, 599],
-                    skipNetworkIdleEvent: true,
+                    skipNetworkIdleEvent: false,
                     failOnConsoleExceptions: true,
                     metadata: { Author: 'John Doe' },
                     downloadFrom: {
@@ -506,7 +506,7 @@ describe('ConverterUtils', () => {
                 expect(data.append).toHaveBeenNthCalledWith(
                     14,
                     'skipNetworkIdleEvent',
-                    'true'
+                    'false'
                 );
                 expect(data.append).toHaveBeenNthCalledWith(
                     15,

diff --git a/src/chromium/utils/tests/screenshot.utils.test.ts b/src/chromium/utils/tests/screenshot.utils.test.ts
@@ -204,12 +204,12 @@ describe('ScreenshotUtils', () => {
         describe('when skipNetworkIdleEvent parameter is passed', () => {
             it('should append skipNetworkIdleEvent', async () => {
                 await ScreenshotUtils.customize(data, {
-                    skipNetworkIdleEvent: true
+                    skipNetworkIdleEvent: false
                 });
                 expect(mockFormDataAppend).toHaveBeenCalledTimes(1);
                 expect(data.append).toHaveBeenCalledWith(
                     'skipNetworkIdleEvent',
-                    'true'
+                    'false'
                 );
             });
         });
@@ -251,7 +251,7 @@ describe('ScreenshotUtils', () => {
                 await ScreenshotUtils.customize(data, {
                     emulatedMediaType: 'screen',
                     failOnHttpStatusCodes: [499, 599],
-                    skipNetworkIdleEvent: true,
+                    skipNetworkIdleEvent: false,
                     failOnConsoleExceptions: true,
                     properties: {
                         format: 'jpeg',
@@ -306,7 +306,7 @@ describe('ScreenshotUtils', () => {
                 expect(data.append).toHaveBeenNthCalledWith(
                     9,
                     'skipNetworkIdleEvent',
-                    'true'
+                    'false'
                 );
                 expect(data.append).toHaveBeenNthCalledWith(
                     10,