Chore: CI/CD assets tests

.github/workflows/tests.yml

@@ -77,3 +77,27 @@ jobs:
                   APPWRITE_API_KEY_INIT: ${{ secrets.APPWRITE_API_KEY_INIT }}
                   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
               run: bun run build
+    assets:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  ref: ${{ github.event.pull_request.head.sha }}
+            - uses: oven-sh/setup-bun@v2
+              with:
+                  bun-version: 1.3
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+            - name: Optimize assets
+              run: CI=true bun run optimize
+            - name: Check for uncommitted changes
+              run: |
+                  if ! git diff --exit-code; then
+                    echo "Assets are not optimized! The following changes were detected:"
+                    echo ""
+                    git diff
+                    echo ""
+                    echo "Please run 'bun run optimize' locally and commit the changes."
+                    exit 1
+                  fi
+                  echo "✅ All assets are properly optimized."

.gitignore

@@ -1,3 +1,4 @@
+assets/**/*.optimized
 .DS_Store
 node_modules
 /build

scripts/optimize-assets.js

@@ -59,23 +59,84 @@ function get_relative_path(file) {
 }
 
 async function main() {
+    console.log(
+        'This script runs for ~5 mins. It runs silently if all files are already optimized.'
+    );
+
     for (const file of walk_directory(join(__dirname, '../static'))) {
         const relative_path = get_relative_path(file);
         if (!is_image(file)) continue;
         if (exceptions.some((exception) => relative_path.startsWith(exception))) continue;
 
-        console.log(relative_path);
         const image = sharp(file);
-        const size_before = (await image.toBuffer()).length;
-        const meta = await image.metadata();
+
+        let meta;
+        try {
+            meta = await image.metadata();
+        } catch (err) {
+            const msg = `${relative_path} failed: ${err.message}`;
+            if (Bun.env.CI) {
+                throw new Error(msg);
+            }
+
+            console.log(msg);
+            continue;
+        }
+
+        if (Bun.env.CI && (meta.width > 1980 || meta.height > 1980)) {
+            const msg = `${relative_path} is too large: ${meta.width}x${meta.height}`;
+            throw new Error(msg);
+        }
+
         const buffer = await image[meta.format](config[meta.format])
             .resize(resize_config)
             .toBuffer();
-        const size_after = buffer.length;
 
-        if (size_after >= size_before) continue;
+        await sharp(buffer).toFile(file + '.optimized');
+
+        const file_before = Bun.file(file);
+        await file_before.arrayBuffer();
+        const size_before = file_before.size;
+
+        const file_after = Bun.file(file + '.optimized');
+        const file_after_contents = await file_after.arrayBuffer();
+        const size_after = file_after.size;
 
-        await sharp(buffer).toFile(file);
+        const size_diff = size_before - size_after;
+        if (size_diff <= 0) {
+            await Bun.file(file + '.optimized').delete();
+            continue;
+        }
+
+        const size_diff_percent = size_diff / size_before;
+        if (size_diff_percent < 0.2) {
+            await Bun.file(file + '.optimized').delete();
+            continue;
+        }
+
+        // Atomic rewrite
+        try {
+            await Bun.write(file, file_after_contents);
+            await Bun.file(file + '.optimized').delete();
+        } catch (error) {
+            try {
+                await Bun.file(file + '.optimized').delete();
+            } catch {
+                // Silenced
+            }
+
+            throw new Error(`Failed to replace ${relative_path}: ${error.message}`);
+        }
+
+        const diff_verbose = Math.round(size_diff_percent * 100);
+        console.log(`✅ ${relative_path} has been optimized (-${diff_verbose}%)`);
+
+        if (Bun.env.CI) {
+            console.log(
+                `Stopping optimization in CI/CD env, as one diff is enough to make test fail`
+            );
+            break;
+        }
     }
 }