Pull request #84: AG-15105 Wrong counting of rules in Safari 16

Merge in ADGUARD-IOS/safari-converter from fix/AG-15105 to master

* commit '2388e9847e0531bf700424dc685a74f98c994bba':
  added safari version to error message and updated readme
  refactored api and fixed tests
  fixed safari version handling in converter api

Author: Oleg Labudko

README.md

@@ -46,6 +46,7 @@ The result contains following properties:
 ```
     ConverterTool [--safari-version <safari-version>] [--optimize <optimize>] [--advanced-blocking <advanced-blocking>] [--advanced-blocking-format <advanced-blocking-format>] [<rules>]
 ```
+#### Please note that minimal supported Safari version is 13
 e.g.
 ```
     cat rules.txt | ./ConverterTool --safari-version 13 --optimize false --advanced-blocking true --advanced-blocking-format txt

node-safari-converter/index.js

@@ -1,9 +1,8 @@
-const { jsonFromRules, getConverterVersion, safariVersions } = require('./src/api');
+const { jsonFromRules, getConverterVersion } = require('./src/api');
 
 module.exports = (function () {
     return {
         jsonFromRules,
         getConverterVersion,
-        safariVersions,
     };
 })();

node-safari-converter/src/api.js

@@ -4,15 +4,9 @@ const { version } = require('../../package.json');
 
 const CONVERTER_TOOL_PATH = path.resolve(__dirname, '../../bin/ConverterTool');
 
-module.exports = (function () {
-    const safariVersions = Object.freeze({
-        safari11: 11,
-        safari12: 12,
-        safari13: 13,
-        safari14: 14,
-        safari15: 15,
-    });
+const MINIMAL_SUPPORTED_SAFARI_VERSION = 13;
 
+module.exports = (function () {
     /**
      * Runs shell script
      *
@@ -54,11 +48,13 @@ module.exports = (function () {
      * @param converterToolPath - optional path to converter resolved by Electron
      */
     const jsonFromRules = async (rules, advancedBlocking, safariVersion, converterToolPath) => {
-        let currentSafariVersion = Object.values(safariVersions).includes(safariVersion) ? safariVersion : safariVersions.safari13;
+        if (!Number.isInteger(safariVersion) || safariVersion < MINIMAL_SUPPORTED_SAFARI_VERSION) {
+            throw new Error(`The provided Safari version is not supported: ${safariVersion}`);
+        }
 
         return new Promise((resolve, reject) => {
             const child = runScript(converterToolPath || CONVERTER_TOOL_PATH, [
-                `--safari-version=${currentSafariVersion}`,
+                `--safari-version=${safariVersion}`,
                 '--optimize=false',
                 `--advanced-blocking=${advancedBlocking}`,
             ], (code, stdout, stderr) => {
@@ -91,6 +87,5 @@ module.exports = (function () {
     return {
         jsonFromRules,
         getConverterVersion,
-        safariVersions,
     };
 })();

node-safari-converter/test/api.test.js

@@ -1,10 +1,13 @@
 const { jsonFromRules, getConverterVersion, safariVersions } = require('../index');
 const pJson = require('../../package.json');
 
+const SAFARI_VERSION_12 = 12;
+const SAFARI_VERSION_14 = 14;
+
 describe('API test', () => {
     it('jsonFromRules test', async () => {
         const rules = ['example.com##.ads-banner', '||test.com^$image'];
-        const result = await jsonFromRules(rules, false, safariVersions.safari14);
+        const result = await jsonFromRules(rules, false, SAFARI_VERSION_14);
         const converted = JSON.parse(result.converted);
 
         expect(converted[0].trigger['if-domain']).toStrictEqual(['*example.com']);
@@ -18,8 +21,8 @@ describe('API test', () => {
     it('Unsupported Safari version test', async () => {
         const rules = ['example.com##.ads-banner'];
 
-        await expect(jsonFromRules(rules, false, safariVersions.safari12))
-            .rejects.toThrow('Error: The provided Safari version is not supported');
+        await expect(jsonFromRules(rules, false, SAFARI_VERSION_12))
+            .rejects.toThrow('The provided Safari version is not supported');
     });
 
     it('getConverterVersion test', () => {