Pull request: AG-5628 Create a node module wrapping Safari Converter

Merge in ADGUARD-IOS/safari-converter from feature/AG-5628 to master

Squashed commit of the following:

commit 13a0643
Merge: 83c2d3c 8ab80af
Author: tvinzz <[email protected]>
Date:   Mon Dec 21 15:20:09 2020 +0300

    Merge branch 'master' into feature/AG-5628

commit 83c2d3c
Author: tvinzz <[email protected]>
Date:   Thu Dec 17 14:24:07 2020 +0300

    moved converter tool path to constant

commit 7f5e9cd
Author: tvinzz <[email protected]>
Date:   Wed Dec 16 15:42:05 2020 +0300

    moved to node-safari-converter

commit 10a5a7b
Author: tvinzz <[email protected]>
Date:   Wed Dec 16 04:59:10 2020 +0300

    added jest tests

commit 0d0b7c5
Author: tvinzz <[email protected]>
Date:   Wed Dec 16 04:15:42 2020 +0300

    fixes

commit 0a0e96f
Author: tvinzz <[email protected]>
Date:   Wed Dec 16 03:07:01 2020 +0300

    added getConverterVersion

commit c569f7a
Author: tvinzz <[email protected]>
Date:   Tue Dec 15 17:53:22 2020 +0300

    fixes

commit a6fc757
Author: tvinzz <[email protected]>
Date:   Tue Dec 15 04:08:22 2020 +0300

    updated README

commit d6fbeea
Author: tvinzz <[email protected]>
Date:   Tue Dec 15 03:47:10 2020 +0300

    added ConverterTool.json

commit f5d307f
Author: tvinzz <[email protected]>
Date:   Tue Dec 15 03:36:18 2020 +0300

    exported jsonFromRules

commit 90aeb4a
Author: tvinzz <[email protected]>
Date:   Tue Dec 15 02:17:42 2020 +0300

    build after installation

commit 61e4e69
Author: tvinzz <[email protected]>
Date:   Mon Dec 14 22:46:36 2020 +0300

    fixed description

commit 9f56cf7
Author: tvinzz <[email protected]>
Date:   Mon Dec 14 22:32:13 2020 +0300

    added ci:increment to scripts

commit 49f56d4
Author: tvinzz <[email protected]>
Date:   Mon Dec 14 22:16:09 2020 +0300

    fixed build command

commit 40995b5
Author: tvinzz <[email protected]>
Date:   Mon Dec 14 22:05:11 2020 +0300

    added test to scripts

commit 2bb7ad5
Author: tvinzz <[email protected]>
Date:   Mon Dec 14 21:58:53 2020 +0300

    cleaning

commit 3fa099e
Author: tvinzz <[email protected]>
Date:   Mon Dec 14 21:57:42 2020 +0300

    wrapped safari converter into node module

Author: Oleg Labudko

.gitignore

@@ -4,3 +4,5 @@
 /*.xcodeproj
 xcuserdata/
 /.idea
+/node_modules
+/bin/ConverterTool

README.md

@@ -68,3 +68,18 @@ Push a new tag in `v*.*.*` format, then provided github action is intended to bu
 
 ### Third-party dependencies
 - Punycode (https://github.com/gumob/PunycodeSwift.git)
+
+### Use as node module
+
+##### Requirements:
+* Swift 4 or higher
+
+After installation the build process occurs and binary file will be copied to bin directory
+
+#### API
+`jsonFromRules(rules, advancedBlocking, log)` - method to convert rules into JSON
+* rules - array of rules
+* advancedBlocking - if we need advanced blocking content (boolean)
+* logger
+
+`getConverterVersion` - returns Safari Converter Lib version

node-safari-converter/index.js

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

node-safari-converter/script/build.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+swift build -v -c release
+mkdir -p bin
+cp .build/release/ConverterTool bin

node-safari-converter/src/api.js

@@ -0,0 +1,85 @@
+const path = require('path');
+const { spawn } = require('child_process');
+const { version } = require('../../package.json');
+
+const CONVERTER_TOOL_PATH = path.resolve(__dirname, '../../bin/ConverterTool');
+
+module.exports = (function () {
+    /**
+     * Runs shell script
+     *
+     * @param command
+     * @param args
+     * @param callback
+     */
+    const runScript = (command, args, callback) => {
+        const child = spawn(command, args);
+
+        let stdout = '';
+        let stderr = '';
+
+        child.stdout.setEncoding('utf8');
+        child.stdout.on('data', (data) => {
+            data = data.toString();
+            stdout += data;
+        });
+
+        child.stderr.setEncoding('utf8');
+        child.stderr.on('data', (data) => {
+            data = data.toString();
+            stderr += data;
+        });
+
+        child.on('close', (code) => {
+            callback(code, stdout, stderr);
+        });
+
+        return child;
+    };
+
+    /**
+     * Runs converter method for rules
+     *
+     * @param rules array of rules
+     * @param advancedBlocking if we need advanced blocking content
+     * @param rulesLimit
+     */
+    const jsonFromRules = async (rules, advancedBlocking, rulesLimit) => {
+        return new Promise((resolve, reject) => {
+            const child = runScript(CONVERTER_TOOL_PATH, [
+                `-limit=${rulesLimit}`,
+                '-optimize=false',
+                `-advancedBlocking=${advancedBlocking}`,
+            ], (code, stdout, stderr) => {
+                if (code !== 0) {
+                    reject(stderr);
+                    return;
+                }
+
+                const result = JSON.parse(stdout);
+
+                resolve(result);
+            });
+
+            child.stdin.setEncoding('utf8');
+            for (const r of rules) {
+                child.stdin.write(r);
+                child.stdin.write('\n');
+            }
+
+            child.stdin.end();
+        });
+    };
+
+    /**
+     * Returns Safari Converter Lib version
+     */
+    const getConverterVersion = () => {
+        return version;
+    }
+
+    return {
+        jsonFromRules,
+        getConverterVersion,
+    };
+})();

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

@@ -0,0 +1,22 @@
+const { jsonFromRules, getConverterVersion } = require('../index');
+const pJson = require('../../package.json');
+
+describe('API test', () => {
+    it('jsonFromRules test', async () => {
+        const rules = ['example.com##.ads-banner', '||test.com^$image'];
+        const result = await jsonFromRules(rules, false, 50000);
+        const converted = JSON.parse(result.converted);
+
+        expect(converted[0].trigger['if-domain']).toStrictEqual(['*example.com']);
+        expect(converted[0].action.type).toBe('css-display-none');
+        expect(converted[0].action.selector).toBe('.ads-banner');
+
+        expect(converted[1].trigger['resource-type']).toStrictEqual(['image']);
+        expect(converted[1].action.type).toBe('block');
+    });
+
+    it('getConverterVersion test', () => {
+        let version = getConverterVersion();
+        expect(version).toBe(pJson.version);
+    });
+});

package.json

@@ -0,0 +1,17 @@
+{
+  "name": "safari-converter-lib",
+  "version": "1.1.5",
+  "description": "Wrapper with version for Swift Safari Converter to use it as node module",
+  "repository": "github:AdguardTeam/SafariConverterLib",
+  "main": "node-safari-converter/index.js",
+  "scripts": {
+    "build": "swift build -v -c release",
+    "test": "swift test",
+    "api-test": "yarn jest",
+    "ci:increment": "yarn version --patch --no-git-tag-version",
+    "postinstall": "node-safari-converter/script/build.sh"
+  },
+  "devDependencies": {
+    "jest": "^26.6.3"
+  }
+}