Add Compression for bluegem.json (#319)

* Add compression for bluegem.json

* omit original JSON in output

* remove experimental flags

* chore: run format

* remove obsolete comment

Author: GODrums

package-lock.json

@@ -31,11 +31,14 @@
         "@eslint/eslintrc": "^3.3.1",
         "@eslint/js": "^9.24.0",
         "@types/chrome": "^0.0.313",
+        "@types/compression-webpack-plugin": "^9.1.4",
         "@types/firefox-webext-browser": "^120.0.4",
         "@types/jquery": "^3.5.32",
         "@types/lodash": "^4.17.16",
+        "@types/pako": "^2.0.3",
         "@typescript-eslint/eslint-plugin": "^8.29.1",
         "@typescript-eslint/parser": "^8.29.1",
+        "compression-webpack-plugin": "^11.1.0",
         "copy-webpack-plugin": "^13.0.0",
         "csgo-fade-percentage-calculator": "^1.1.6",
         "css-loader": "^7.1.2",
@@ -55,6 +58,7 @@
         "lodash": "^4.17.21",
         "lodash-decorators": "^6.0.1",
         "mini-css-extract-plugin": "^2.9.2",
+        "pako": "^2.1.0",
         "prettier": "^3.5.3",
         "rxjs": "^7.8.2",
         "sass-loader": "^16.0.5",

package.json

@@ -1,6 +1,7 @@
 import {ItemInfo} from './fetch_inspect_info';
 import {SimpleHandler} from './main';
 import {RequestType} from './types';
+import {ungzip} from 'pako';
 
 interface BluegemPatternData {
     playside_blue: number;
@@ -39,16 +40,27 @@ export const FetchBluegem = new SimpleHandler<FetchBluegemRequest, FetchBluegemR
         }
 
         if (Object.keys(bluegemCache).length === 0) {
-            const url = chrome.runtime.getURL('data/bluegem.json');
+            // Fetch the compressed data
+            const url = chrome.runtime.getURL('data/bluegem.json.gz');
             try {
                 const resp = await fetch(url);
-                const json = await resp.json();
+                if (!resp.ok) {
+                    throw new Error(`Failed to fetch bluegem data: ${resp.statusText}`);
+                }
+
+                // Get the response as ArrayBuffer
+                const compressedData = await resp.arrayBuffer();
+                // Decompress the data using pako
+                const decompressedData = ungzip(new Uint8Array(compressedData));
+                // Parse the JSON from the decompressed buffer using TextDecoder
+                const jsonString = new TextDecoder('utf-8').decode(decompressedData);
+                const json = JSON.parse(jsonString);
                 if (!json) {
-                    throw Error('Failed to fetch bluegem data');
+                    throw Error('Failed to parse bluegem data');
                 }
                 Object.assign(bluegemCache, json);
             } catch (e) {
-                console.error('Failed to fetch bluegem data', e);
+                console.error('Failed to fetch and process bluegem data', e);
                 return undefined;
             }
         }

src/lib/bridge/handlers/fetch_bluegem.ts

@@ -8,7 +8,6 @@
         "rootDir": "src",
         "outDir": "dist/js",
         "noEmitOnError": true,
-        "typeRoots": ["node_modules/@types", "./src/lib/types"],
         "experimentalDecorators": true,
         "useDefineForClassFields": false,
         "moduleResolution": "Node"

tsconfig.json

@@ -2,6 +2,7 @@ const path = require('path');
 const glob = require('glob');
 const CopyPlugin = require('copy-webpack-plugin');
 const MiniCssExtractPlugin = require('mini-css-extract-plugin');
+const CompressionPlugin = require("compression-webpack-plugin");
 const webpack = require('webpack');
 const resolve = require('path').resolve;
 
@@ -98,7 +99,7 @@ module.exports = (env) => {
             new CopyPlugin({
                 patterns: [
                     {from: 'icons', to: 'icons', context: '.'},
-                    {from: 'data', to: 'data', context: '.'},
+                    {from: 'data', to: 'data', context: '.', globOptions: { ignore: ['bluegem.json'] } },
                     {from: 'src/global.css', to: 'src/', context: '.'},
                     {from: 'src/background_ff.html', to: 'src/', context: '.'},
                     {from: 'src/steamcommunity_ruleset.json', to: 'src/', context: '.'},
@@ -145,6 +146,13 @@ module.exports = (env) => {
                     },
                 ],
             }),
+            // Add Gzip compression for bluegem.json
+            new CompressionPlugin({
+                filename: "[path][base].gz", // Change extension to .gz
+                algorithm: "gzip",
+                test: /bluegem\.json$/,
+                deleteOriginalAssets: true, 
+            }),
         ],
         stats: {
             errorDetails: true,