@xenon-device-management/xenon 2.13.2 → 2.15.0

package/lib/src/services/network/xenonProxy.js

@@ -0,0 +1,107 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isUnsetProxy = isUnsetProxy;
+exports.parseProxySetting = parseProxySetting;
+exports.localIPv4Addresses = localIPv4Addresses;
+exports.pointsAtThisMachine = pointsAtThisMachine;
+exports.isPortListening = isPortListening;
+exports.isDeadCaptureProxy = isDeadCaptureProxy;
+const net_1 = __importDefault(require("net"));
+const os_1 = __importDefault(require("os"));
+/**
+ * Reading a phone's global HTTP proxy (`settings get global http_proxy`), and
+ * telling one Xenon's network capture left behind from one somebody set on
+ * purpose.
+ */
+/** Android's ways of saying "no proxy": unset (`null`), empty, or `:0`. */
+function isUnsetProxy(value) {
+    const v = (value !== null && value !== void 0 ? value : '').trim();
+    return v === '' || v === 'null' || v === ':0';
+}
+/** `host:port`, or null for no proxy or anything else. */
+function parseProxySetting(value) {
+    if (isUnsetProxy(value))
+        return null;
+    const v = value.trim();
+    const colon = v.lastIndexOf(':');
+    if (colon <= 0)
+        return null;
+    const host = v.slice(0, colon);
+    const portText = v.slice(colon + 1);
+    if (!/^\d+$/.test(portText))
+        return null;
+    const port = Number(portText);
+    if (port < 1 || port > 65535)
+        return null;
+    return { host, port };
+}
+/** This machine's own IPv4 addresses, as a phone on its network reaches it. */
+function localIPv4Addresses() {
+    const out = [];
+    for (const infos of Object.values(os_1.default.networkInterfaces())) {
+        for (const info of infos !== null && infos !== void 0 ? infos : []) {
+            if (info.family === 'IPv4' && !info.internal)
+                out.push(info.address);
+        }
+    }
+    return out;
+}
+/**
+ * Whether a phone that uses `host` as its proxy reaches this machine: through
+ * `adb reverse` (127.0.0.1, the phone itself), an emulator's alias for its
+ * host (10.0.2.2), or this machine's own address (the interceptor's LAN
+ * fallback). These are the only hosts the interceptor ever sets.
+ */
+function pointsAtThisMachine(host, ownAddresses) {
+    const h = host.trim().toLowerCase();
+    return h === '127.0.0.1' || h === 'localhost' || h === '10.0.2.2' || ownAddresses.includes(h);
+}
+/**
+ * Whether something on this machine accepts a TCP connection on `port`.
+ * Anything but a refusal counts as yes (a timeout too): only a port known to be
+ * dead may have a proxy that points at it cleared.
+ */
+function isPortListening(port, timeoutMs = 1000) {
+    return new Promise((resolve) => {
+        const socket = net_1.default.connect({ host: '127.0.0.1', port });
+        const done = (answer) => {
+            socket.removeAllListeners();
+            socket.destroy();
+            resolve(answer);
+        };
+        socket.setTimeout(timeoutMs, () => done(true));
+        socket.once('connect', () => done(true));
+        socket.once('error', (err) => done(err.code !== 'ECONNREFUSED'));
+    });
+}
+/**
+ * Whether `value` is a proxy Xenon's network capture set and nobody serves any
+ * more: it points at this machine, on one of this server's capture ports, and
+ * nothing answers there. A phone with such a proxy has no network at all. A
+ * proxy that points anywhere else, or at a port that answers (a capture that
+ * is running, maybe another Xenon's on this machine), is never one.
+ */
+function isDeadCaptureProxy(value_1, captureRange_1) {
+    return __awaiter(this, arguments, void 0, function* (value, captureRange, probe = isPortListening) {
+        const proxy = parseProxySetting(value);
+        if (!proxy)
+            return false;
+        if (!pointsAtThisMachine(proxy.host, localIPv4Addresses()))
+            return false;
+        if (proxy.port < captureRange[0] || proxy.port > captureRange[1])
+            return false;
+        return !(yield probe(proxy.port));
+    });
+}

package/lib/src/services/ocr/ocrData.js

@@ -0,0 +1,118 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OCR_START_RETRY_MS = exports.OCR_DATA_SHA256 = exports.OCR_DATA_FILE = exports.OCR_DATA_DIR = exports.OCR_LANGUAGE = void 0;
+exports.ocrWorkerOptions = ocrWorkerOptions;
+exports.createOcrWorker = createOcrWorker;
+const crypto_1 = __importDefault(require("crypto"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const tesseract_js_1 = __importDefault(require("tesseract.js"));
+const logger_1 = __importDefault(require("../../logger"));
+/**
+ * The language data every OCR worker reads, shipped with the plugin
+ * (vendor/README.md says where it comes from).
+ *
+ * Left to its defaults, tesseract.js downloads eng.traineddata from
+ * cdn.jsdelivr.net when a worker starts, and caches it in the process's working
+ * directory. So a server with no internet couldn't run OCR at all, and one with
+ * internet left a 5 MB eng.traineddata wherever it was started (the home
+ * directory, ~/.appium). Through 2.14 that was every Xenon server.
+ */
+exports.OCR_LANGUAGE = 'eng';
+exports.OCR_DATA_DIR = path_1.default.join(__dirname, 'vendor');
+exports.OCR_DATA_FILE = path_1.default.join(exports.OCR_DATA_DIR, `${exports.OCR_LANGUAGE}.traineddata.gz`);
+/** The shipped file's SHA-256, as vendor/README.md gives it. */
+exports.OCR_DATA_SHA256 = '45b4cb346724ac1774f1c36f42f182b887bcdb28ebe63e6fff90ac41f3fcff91';
+/**
+ * What a worker is given: read the data from `dataDir` (a directory, never a
+ * URL, so nothing is fetched), and cache it nowhere. A job's own failure
+ * rejects its promise; without an errorHandler tesseract.js also throws it from
+ * the worker's message handler, where nothing can catch it.
+ */
+function ocrWorkerOptions(dataDir = exports.OCR_DATA_DIR) {
+    return {
+        langPath: dataDir,
+        cacheMethod: 'none',
+        gzip: true,
+        errorHandler: (err) => logger_1.default.warn(`OCR: ${err}`),
+    };
+}
+/**
+ * How long a worker that wouldn't start is remembered. tesseract.js hands back
+ * no worker when its start fails, so its thread can't be ended; starting one
+ * per OCR call would leave one more each time.
+ */
+exports.OCR_START_RETRY_MS = 60000;
+const startFailures = new Map();
+/** Files whose data checked out, so each is read and hashed once per process. */
+const checked = new Set();
+/**
+ * The data is the file the plugin ships, whole. tesseract.js 7, given data it
+ * can't load, answers a job it has already refused and throws a TypeError from
+ * its message handler, which ends the server (src/index.ts exits on an
+ * uncaught exception). So a damaged install is refused here, before a worker
+ * sees it.
+ */
+function checkData(file) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (checked.has(file))
+            return;
+        let data;
+        try {
+            data = yield fs_1.default.promises.readFile(file);
+        }
+        catch (_a) {
+            throw new Error(`OCR can't start: its language data is missing (${file})`);
+        }
+        if (crypto_1.default.createHash('sha256').update(data).digest('hex') !== exports.OCR_DATA_SHA256) {
+            throw new Error(`OCR can't start: its language data is damaged (${file})`);
+        }
+        checked.add(file);
+    });
+}
+/**
+ * An OCR worker for English, from the data that ships with the plugin. Fails
+ * with the reason when it can't start: a worker whose data won't load never
+ * settles otherwise, and OmniVisionService's lock would wait on it for ever.
+ */
+function createOcrWorker() {
+    return __awaiter(this, arguments, void 0, function* (dataDir = exports.OCR_DATA_DIR) {
+        const recent = startFailures.get(dataDir);
+        if (recent && Date.now() - recent.at < exports.OCR_START_RETRY_MS)
+            throw recent.error;
+        yield checkData(path_1.default.join(dataDir, `${exports.OCR_LANGUAGE}.traineddata.gz`));
+        let failed;
+        const failure = new Promise((_, reject) => {
+            failed = reject;
+        });
+        const options = ocrWorkerOptions(dataDir);
+        const logError = options.errorHandler;
+        const worker = tesseract_js_1.default.createWorker(exports.OCR_LANGUAGE, tesseract_js_1.default.OEM.LSTM_ONLY, Object.assign(Object.assign({}, options), { errorHandler: (err) => {
+                logError(err);
+                failed(new Error(`OCR can't start: ${err}`));
+            } }));
+        try {
+            // Once the worker has started, a later job's failure is only logged.
+            const started = yield Promise.race([worker, failure]);
+            startFailures.delete(dataDir);
+            return started;
+        }
+        catch (err) {
+            const error = err instanceof Error ? err : new Error(`OCR can't start: ${err}`);
+            startFailures.set(dataDir, { at: Date.now(), error });
+            throw error;
+        }
+    });
+}

package/lib/src/services/ocr/vendor/LICENSE-tessdata.txt

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+