@adguard/filters-compiler 3.2.12 → 3.3.0-beta.1

package/README.md

@@ -467,7 +467,8 @@ always fetched remotely, even when using the local cache.
 1. Call `download(basePath, includedFilterIds, excludedFilterIds)` to save
    `stats.json` for filters listed in the remote `percent.json`.
    `includedFilterIds` limits processing to those IDs (default `[]` = all).
-   `excludedFilterIds` skips those IDs (default `[]` = none). The two cannot use both.
+   `excludedFilterIds` skips those IDs (default `[]` = none). When both are
+   given, a filter is processed only if it is included and not excluded.
 2. Call `use(basePath)` before `compile()` to tell
    `getOptimizationStatistics` to read stats from local files under
    `basePath` instead of fetching from the remote server.

package/dist/index.cjs

@@ -1187,43 +1187,50 @@ function assertValidStats(filterId, stats) {
 const localOptimizationStatistics = {
     /**
      * Downloads `stats.json` files for filters listed in the remote
-     * `percent.json` and saves them to disk.
-     * Existing `stats.json` files will be overwritten.
+     * `percent.json` and saves them to disk. Downloads into a staged
+     * directory first and swaps it in only after all downloads succeed,
+     * so a failed refresh leaves any previously cached stats intact.
      *
-     * `includedFilterIds` and `excludedFilterIds` cannot both be non-empty.
+     * When both `includedFilterIds` and `excludedFilterIds` are non-empty,
+     * a filter is processed only if it is in `includedFilterIds` and not in
+     * `excludedFilterIds`.
      *
      * @param basePath - Directory to save `filters/<filterId>/stats.json` into.
      * @param includedFilterIds - Filter IDs to process; empty (default) processes all.
      * @param excludedFilterIds - Filter IDs to exclude; empty (default) excludes none.
-     * @throws {Error} When both `includedFilterIds` and `excludedFilterIds` are non-empty.
      */
     download: async (basePath, includedFilterIds = [], excludedFilterIds = []) => {
-        if (includedFilterIds.length > 0 && excludedFilterIds.length > 0) {
-            throw new Error('includedFilterIds and excludedFilterIds cannot both be non-empty');
-        }
         const percent = JSON.parse(await downloadOptimizationPercent());
-        const configs = percent.config.filter(({ filterId }) => {
-            if (includedFilterIds.length > 0) {
-                return includedFilterIds.includes(filterId);
-            }
-            if (excludedFilterIds.length > 0) {
-                return !excludedFilterIds.includes(filterId);
-            }
-            return true;
-        });
+        const configs = percent.config.filter(({ filterId }) => (includedFilterIds.length === 0 || includedFilterIds.includes(filterId))
+            && (excludedFilterIds.length === 0 || !excludedFilterIds.includes(filterId)));
         const FILTERS_PATH = path$1.join(basePath, FILTERS_DIR_NAME);
+        const STAGED_PREFIX = `${process.pid}_${Date.now()}`;
+        const STAGED_FILTERS_PATH = path$1.join(basePath, `${STAGED_PREFIX}_${FILTERS_DIR_NAME}`);
         /**
          * Bounds concurrency so a large `percent.json` cannot fan out into unbounded
          * parallel requests if the underlying transport ever becomes truly async.
          */
         const DOWNLOAD_CONCURRENCY = 8;
-        await mapWithConcurrency(configs, DOWNLOAD_CONCURRENCY, async ({ filterId }) => {
-            const dir = path$1.join(FILTERS_PATH, String(filterId));
-            const statsPath = path$1.join(dir, STATS_JSON);
-            const content = await downloadOptimizationStats(filterId);
-            await fs$1.mkdir(dir, { recursive: true });
-            await fs$1.writeFile(statsPath, content, 'utf-8');
-        });
+        try {
+            await fs$1.mkdir(STAGED_FILTERS_PATH, { recursive: true });
+            await mapWithConcurrency(configs, DOWNLOAD_CONCURRENCY, async ({ filterId }) => {
+                const dir = path$1.join(STAGED_FILTERS_PATH, String(filterId));
+                const statsPath = path$1.join(dir, STATS_JSON);
+                const content = await downloadOptimizationStats(filterId);
+                await fs$1.mkdir(dir, { recursive: true });
+                await fs$1.writeFile(statsPath, content, 'utf-8');
+            });
+        }
+        catch (error) {
+            // Downloads incomplete: staged dir is garbage, safe to discard.
+            await fs$1.rm(STAGED_FILTERS_PATH, { recursive: true, force: true });
+            throw error;
+        }
+        // Swap only after every fetch succeeded. From here on, staged dir is
+        // a complete cache — never rm it on failure, that'd destroy the only
+        // remaining valid copy once the old FILTERS_PATH is gone.
+        await fs$1.rm(FILTERS_PATH, { recursive: true, force: true });
+        await fs$1.rename(STAGED_FILTERS_PATH, FILTERS_PATH);
     },
     /**
      * Configures `getOptimizationStatistics` to read stats from local files under

package/dist/index.js

@@ -1184,43 +1184,50 @@ function assertValidStats(filterId, stats) {
 const localOptimizationStatistics = {
     /**
      * Downloads `stats.json` files for filters listed in the remote
-     * `percent.json` and saves them to disk.
-     * Existing `stats.json` files will be overwritten.
+     * `percent.json` and saves them to disk. Downloads into a staged
+     * directory first and swaps it in only after all downloads succeed,
+     * so a failed refresh leaves any previously cached stats intact.
      *
-     * `includedFilterIds` and `excludedFilterIds` cannot both be non-empty.
+     * When both `includedFilterIds` and `excludedFilterIds` are non-empty,
+     * a filter is processed only if it is in `includedFilterIds` and not in
+     * `excludedFilterIds`.
      *
      * @param basePath - Directory to save `filters/<filterId>/stats.json` into.
      * @param includedFilterIds - Filter IDs to process; empty (default) processes all.
      * @param excludedFilterIds - Filter IDs to exclude; empty (default) excludes none.
-     * @throws {Error} When both `includedFilterIds` and `excludedFilterIds` are non-empty.
      */
     download: async (basePath, includedFilterIds = [], excludedFilterIds = []) => {
-        if (includedFilterIds.length > 0 && excludedFilterIds.length > 0) {
-            throw new Error('includedFilterIds and excludedFilterIds cannot both be non-empty');
-        }
         const percent = JSON.parse(await downloadOptimizationPercent());
-        const configs = percent.config.filter(({ filterId }) => {
-            if (includedFilterIds.length > 0) {
-                return includedFilterIds.includes(filterId);
-            }
-            if (excludedFilterIds.length > 0) {
-                return !excludedFilterIds.includes(filterId);
-            }
-            return true;
-        });
+        const configs = percent.config.filter(({ filterId }) => (includedFilterIds.length === 0 || includedFilterIds.includes(filterId))
+            && (excludedFilterIds.length === 0 || !excludedFilterIds.includes(filterId)));
         const FILTERS_PATH = path$1.join(basePath, FILTERS_DIR_NAME);
+        const STAGED_PREFIX = `${process.pid}_${Date.now()}`;
+        const STAGED_FILTERS_PATH = path$1.join(basePath, `${STAGED_PREFIX}_${FILTERS_DIR_NAME}`);
         /**
          * Bounds concurrency so a large `percent.json` cannot fan out into unbounded
          * parallel requests if the underlying transport ever becomes truly async.
          */
         const DOWNLOAD_CONCURRENCY = 8;
-        await mapWithConcurrency(configs, DOWNLOAD_CONCURRENCY, async ({ filterId }) => {
-            const dir = path$1.join(FILTERS_PATH, String(filterId));
-            const statsPath = path$1.join(dir, STATS_JSON);
-            const content = await downloadOptimizationStats(filterId);
-            await fs$1.mkdir(dir, { recursive: true });
-            await fs$1.writeFile(statsPath, content, 'utf-8');
-        });
+        try {
+            await fs$1.mkdir(STAGED_FILTERS_PATH, { recursive: true });
+            await mapWithConcurrency(configs, DOWNLOAD_CONCURRENCY, async ({ filterId }) => {
+                const dir = path$1.join(STAGED_FILTERS_PATH, String(filterId));
+                const statsPath = path$1.join(dir, STATS_JSON);
+                const content = await downloadOptimizationStats(filterId);
+                await fs$1.mkdir(dir, { recursive: true });
+                await fs$1.writeFile(statsPath, content, 'utf-8');
+            });
+        }
+        catch (error) {
+            // Downloads incomplete: staged dir is garbage, safe to discard.
+            await fs$1.rm(STAGED_FILTERS_PATH, { recursive: true, force: true });
+            throw error;
+        }
+        // Swap only after every fetch succeeded. From here on, staged dir is
+        // a complete cache — never rm it on failure, that'd destroy the only
+        // remaining valid copy once the old FILTERS_PATH is gone.
+        await fs$1.rm(FILTERS_PATH, { recursive: true, force: true });
+        await fs$1.rename(STAGED_FILTERS_PATH, FILTERS_PATH);
     },
     /**
      * Configures `getOptimizationStatistics` to read stats from local files under

package/dist/main/optimization.d.ts

@@ -52,15 +52,17 @@ export declare function assertValidStats(filterId: number, stats: unknown): asse
 export declare const localOptimizationStatistics: {
     /**
      * Downloads `stats.json` files for filters listed in the remote
-     * `percent.json` and saves them to disk.
-     * Existing `stats.json` files will be overwritten.
+     * `percent.json` and saves them to disk. Downloads into a staged
+     * directory first and swaps it in only after all downloads succeed,
+     * so a failed refresh leaves any previously cached stats intact.
      *
-     * `includedFilterIds` and `excludedFilterIds` cannot both be non-empty.
+     * When both `includedFilterIds` and `excludedFilterIds` are non-empty,
+     * a filter is processed only if it is in `includedFilterIds` and not in
+     * `excludedFilterIds`.
      *
      * @param basePath - Directory to save `filters/<filterId>/stats.json` into.
      * @param includedFilterIds - Filter IDs to process; empty (default) processes all.
      * @param excludedFilterIds - Filter IDs to exclude; empty (default) excludes none.
-     * @throws {Error} When both `includedFilterIds` and `excludedFilterIds` are non-empty.
      */
     download: (basePath: string, includedFilterIds?: number[], excludedFilterIds?: number[]) => Promise<void>;
     /**

package/dist/types/src/main/optimization.d.ts

@@ -52,15 +52,17 @@ export declare function assertValidStats(filterId: number, stats: unknown): asse
 export declare const localOptimizationStatistics: {
     /**
      * Downloads `stats.json` files for filters listed in the remote
-     * `percent.json` and saves them to disk.
-     * Existing `stats.json` files will be overwritten.
+     * `percent.json` and saves them to disk. Downloads into a staged
+     * directory first and swaps it in only after all downloads succeed,
+     * so a failed refresh leaves any previously cached stats intact.
      *
-     * `includedFilterIds` and `excludedFilterIds` cannot both be non-empty.
+     * When both `includedFilterIds` and `excludedFilterIds` are non-empty,
+     * a filter is processed only if it is in `includedFilterIds` and not in
+     * `excludedFilterIds`.
      *
      * @param basePath - Directory to save `filters/<filterId>/stats.json` into.
      * @param includedFilterIds - Filter IDs to process; empty (default) processes all.
      * @param excludedFilterIds - Filter IDs to exclude; empty (default) excludes none.
-     * @throws {Error} When both `includedFilterIds` and `excludedFilterIds` are non-empty.
      */
     download: (basePath: string, includedFilterIds?: number[], excludedFilterIds?: number[]) => Promise<void>;
     /**

package/package.json

@@ -58,7 +58,7 @@
     "typescript": "6.0.3",
     "vitest": "3.0.5"
   },
-  "version": "3.2.12",
+  "version": "3.3.0-beta.1",
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "rollup --config rollup.config.js --silent",