Add jest matchers for gzip (#61)

descript-org · Apr 29, 2024 · aae7a2d · aae7a2d
1 parent 46a4701
commit aae7a2d
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 14 deletions.
diff --git a/jest.config.js b/jest.config.js
@@ -1,9 +1,13 @@
 module.exports = {
     coveragePathIgnorePatterns: [
         '/node_modules/',
+        '/tests/expect.js',
         '/tests/server.js',
         '/tests/helpers.js',
     ],
+    setupFilesAfterEnv: [
+        './tests/expect.js',
+    ],
     testEnvironment: 'node',
     testRunner: 'jest-circus/runner',
 };

diff --git a/tests/expect.js b/tests/expect.js
@@ -0,0 +1,19 @@
+const { gunzipSync } = require( 'node:zlib' );
+
+expect.extend( {
+    toBeValidGzip( received ) {
+        //  http://www.zlib.org/rfc-gzip.html#header-trailer
+        //  2.3.1. Member header and trailer
+        //  These have the fixed values ID1 = 31 (0x1f), ID2 = 139 (0x8b), to identify the file as being in gzip format.
+        return {
+            message: () => `incorrect header check for ${ received }`,
+            pass: received.slice( 0, 2 ).equals( Buffer.from( '1f8b', 'hex' ) ),
+        };
+    },
+    toHaveUngzipValue( received, value ) {
+        return {
+            message: () => `expected ${ received } to be ${ value }`,
+            pass: gunzipSync( received ).toString( 'utf-8' ) === value,
+        };
+    },
+} );
diff --git a/tests/http_block.test.js b/tests/http_block.test.js
@@ -9,7 +9,6 @@ const Server = require( './server' );
 const { get_path, get_result_block } = require( './helpers' );
 
 const strip_null_and_undefined_values = require( '../lib/strip_null_and_undefined_values' );
-const { gunzipSync } = require( 'node:zlib' );
 
 //  ---------------------------------------------------------------------------------------------------------------  //
 
@@ -857,9 +856,9 @@ describe( 'http', () => {
 
             expect( spy ).toHaveBeenCalledTimes( 1 );
             const body = spy.mock.calls[ 0 ][ 2 ];
-            expect( body.slice( 0, 2 ).equals( Buffer.from( '1f8b', 'hex' ) ) ).toBe( true );
+            expect( body ).toBeValidGzip();
             expect( body ).toHaveLength( 34 );
-            expect( gunzipSync( body ).toString( 'utf-8' ) ).toBe( 'Привет!' );
+            expect( body ).toHaveUngzipValue( 'Привет!' );
         } );
     } );
 

diff --git a/tests/request.test.js b/tests/request.test.js
@@ -4,7 +4,7 @@ const path_ = require( 'path' );
 const fs_ = require( 'fs' );
 const http_ = require( 'http' );
 const https_ = require( 'https' );
-const { gzipSync, gunzipSync } = require( 'node:zlib' );
+const { gzipSync } = require( 'node:zlib' );
 const { compress } = require( '@fengkx/zstd-napi' );
 const { Duplex } = require( 'stream' );
 
@@ -378,12 +378,9 @@ describe( 'request', () => {
             expect( req.headers ).toHaveProperty( 'transfer-encoding', 'chunked' );
             expect( req.headers ).not.toHaveProperty( 'content-length' );
 
-            //  http://www.zlib.org/rfc-gzip.html#header-trailer
-            //  2.3.1. Member header and trailer
-            //  These have the fixed values ID1 = 31 (0x1f), ID2 = 139 (0x8b), to identify the file as being in gzip format.
-            expect( body.slice( 0, 2 ).equals( Buffer.from( '1f8b', 'hex' ) ) ).toBe( true );
+            expect( body ).toBeValidGzip();
             expect( body ).toHaveLength( 77 );
-            expect( gunzipSync( body ).toString( 'utf-8' ) ).toBe( BODY );
+            expect( body ).toHaveUngzipValue( BODY );
         } );
 
         it.each( [ 'POST' ] )( '%j, body_compress with options', async ( method ) => {
@@ -412,12 +409,9 @@ describe( 'request', () => {
             expect( req.headers ).toHaveProperty( 'transfer-encoding', 'chunked' );
             expect( req.headers ).not.toHaveProperty( 'content-length' );
 
-            //  http://www.zlib.org/rfc-gzip.html#header-trailer
-            //  2.3.1. Member header and trailer
-            //  These have the fixed values ID1 = 31 (0x1f), ID2 = 139 (0x8b), to identify the file as being in gzip format.
-            expect( body.slice( 0, 2 ).equals( Buffer.from( '1f8b', 'hex' ) ) ).toBe( true );
+            expect( body ).toBeValidGzip();
             expect( body ).toHaveLength( 134 );
-            expect( gunzipSync( body ).toString( 'utf-8' ) ).toBe( BODY );
+            expect( body ).toHaveUngzipValue( BODY );
         } );
 
         describe( 'errors', () => {