@xenon-device-management/xenon 2.14.0 → 2.15.0

package/lib/test/integration/users-flow.spec.js

@@ -15,25 +15,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 require("reflect-metadata");
 const chai_1 = require("chai");
 const express_1 = __importDefault(require("express"));
-const supertest_1 = __importDefault(require("supertest"));
+const loopbackRequest_1 = __importDefault(require("../helpers/loopbackRequest"));
 const authMiddleware_1 = require("../../src/middleware/authMiddleware");
 const users_1 = require("../../src/app/routers/users");
-const prisma_1 = require("../../src/prisma");
+const scratch_database_1 = require("../helpers/scratch-database");
 const seedUser_1 = require("../helpers/seedUser");
 describe('users CRUD flow (integration)', function () {
     this.timeout(60000);
+    (0, scratch_database_1.useScratchDatabase)({ wholeSuite: true });
     let sa;
     let admin;
     before(() => __awaiter(this, void 0, void 0, function* () {
         sa = yield (0, seedUser_1.seedUser)('SUPER_ADMIN', { name: 'Flow SA' });
         admin = yield (0, seedUser_1.seedUser)('ADMIN', { name: 'Flow Admin' });
     }));
-    after(() => __awaiter(this, void 0, void 0, function* () {
-        yield sa.cleanup();
-        yield admin.cleanup();
-        // Anything created during the flow with the flow-bob email tag.
-        yield prisma_1.prisma.user.deleteMany({ where: { email: { contains: 'flow-bob' } } });
-    }));
     function buildApp() {
         const app = (0, express_1.default)();
         app.use(express_1.default.json());
@@ -44,27 +39,27 @@ describe('users CRUD flow (integration)', function () {
     it('SA creates an admin -> admin creates a member -> admin lists', () => __awaiter(this, void 0, void 0, function* () {
         const app = buildApp();
         // ADMIN role-create — should fail with 403 (admin can't create admins).
-        const denied = yield (0, supertest_1.default)(app)
+        const denied = yield (0, loopbackRequest_1.default)(app)
             .post('/users')
             .set('Cookie', admin.cookie)
             .send({ email: 'flow-admin2@xenon.local', name: 'Admin 2', role: 'ADMIN' });
         (0, chai_1.expect)(denied.status).to.equal(403);
         // SA creates a member.
         const memberEmail = `flow-bob-${Date.now()}@xenon.local`;
-        const created = yield (0, supertest_1.default)(app)
+        const created = yield (0, loopbackRequest_1.default)(app)
             .post('/users')
             .set('Cookie', sa.cookie)
             .send({ email: memberEmail, name: 'Bob', role: 'MEMBER' });
         (0, chai_1.expect)(created.status).to.equal(201);
         (0, chai_1.expect)(created.body.temporaryPassword).to.match(/^[A-Za-z0-9_-]{12,}$/);
         // Admin lists — sees the new member; does NOT see SA or other admins.
-        const listAdmin = yield (0, supertest_1.default)(app).get('/users').set('Cookie', admin.cookie);
+        const listAdmin = yield (0, loopbackRequest_1.default)(app).get('/users').set('Cookie', admin.cookie);
         (0, chai_1.expect)(listAdmin.status).to.equal(200);
         const emailsAdmin = listAdmin.body.map((u) => u.email);
         (0, chai_1.expect)(emailsAdmin).to.include(memberEmail);
         (0, chai_1.expect)(emailsAdmin).to.not.include(sa.user.email);
         // SA lists — sees everyone.
-        const listSA = yield (0, supertest_1.default)(app).get('/users').set('Cookie', sa.cookie);
+        const listSA = yield (0, loopbackRequest_1.default)(app).get('/users').set('Cookie', sa.cookie);
         const emailsSA = listSA.body.map((u) => u.email);
         (0, chai_1.expect)(emailsSA).to.include(sa.user.email);
         (0, chai_1.expect)(emailsSA).to.include(admin.user.email);

package/lib/test/integration/users-lockout.spec.js

@@ -15,13 +15,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 require("reflect-metadata");
 const chai_1 = require("chai");
 const express_1 = __importDefault(require("express"));
-const supertest_1 = __importDefault(require("supertest"));
+const loopbackRequest_1 = __importDefault(require("../helpers/loopbackRequest"));
 const authMiddleware_1 = require("../../src/middleware/authMiddleware");
 const users_1 = require("../../src/app/routers/users");
 const prisma_1 = require("../../src/prisma");
 const seedUser_1 = require("../helpers/seedUser");
+const scratch_database_1 = require("../helpers/scratch-database");
 describe('users lockout protections (integration)', function () {
     this.timeout(60000);
+    (0, scratch_database_1.useScratchDatabase)({ wholeSuite: true });
     function buildApp() {
         const app = (0, express_1.default)();
         app.use(express_1.default.json());
@@ -32,7 +34,7 @@ describe('users lockout protections (integration)', function () {
     it('SA cannot delete themselves', () => __awaiter(this, void 0, void 0, function* () {
         const me = yield (0, seedUser_1.seedUser)('SUPER_ADMIN', { name: 'Lockout Self' });
         try {
-            const r = yield (0, supertest_1.default)(buildApp()).delete(`/users/${me.user.id}`).set('Cookie', me.cookie);
+            const r = yield (0, loopbackRequest_1.default)(buildApp()).delete(`/users/${me.user.id}`).set('Cookie', me.cookie);
             (0, chai_1.expect)(r.status).to.equal(400);
             (0, chai_1.expect)(r.body.error).to.match(/yourself/);
         }
@@ -43,7 +45,7 @@ describe('users lockout protections (integration)', function () {
     it('SA cannot demote themselves', () => __awaiter(this, void 0, void 0, function* () {
         const me = yield (0, seedUser_1.seedUser)('SUPER_ADMIN', { name: 'Lockout Demote-Self' });
         try {
-            const r = yield (0, supertest_1.default)(buildApp())
+            const r = yield (0, loopbackRequest_1.default)(buildApp())
                 .patch(`/users/${me.user.id}`)
                 .set('Cookie', me.cookie)
                 .send({ role: 'MEMBER' });

package/lib/test/unit/EmailService.test.js

@@ -121,4 +121,70 @@ describe('EmailService', () => {
             }
         });
     });
+    // A reset link Xenon sends points at XENON_PUBLIC_URL, never the request's
+    // Host, so with SMTP but no address set no link is emailed at all. Said once
+    // at startup, so an operator upgrading learns why self-service reset went.
+    describe('warnAboutPublicUrl', () => {
+        it('warns when Xenon could send links but has no XENON_PUBLIC_URL to point them at', () => {
+            const orig = {
+                url: config_1.config.smtpUrl,
+                fb: config_1.config.passwordResetLogFallback,
+                pub: config_1.config.publicUrl,
+            };
+            const svc = new EmailService_1.EmailService();
+            const warn = sinon_1.default.stub(svc, 'warnLog');
+            try {
+                config_1.config.smtpUrl = undefined;
+                config_1.config.passwordResetLogFallback = false;
+                config_1.config.publicUrl = undefined;
+                svc.warnAboutPublicUrl();
+                (0, chai_1.expect)(warn.called, 'nothing could be sent anyway').to.equal(false);
+                config_1.config.smtpUrl = 'smtp://mail.example.com:587';
+                config_1.config.publicUrl = 'https://xenon.example.com';
+                svc.warnAboutPublicUrl();
+                (0, chai_1.expect)(warn.called).to.equal(false);
+                config_1.config.publicUrl = 'not a url';
+                svc.warnAboutPublicUrl();
+                (0, chai_1.expect)(warn.calledOnce).to.equal(true);
+                (0, chai_1.expect)(warn.firstCall.args[0]).to.match(/XENON_PUBLIC_URL/);
+            }
+            finally {
+                config_1.config.smtpUrl = orig.url;
+                config_1.config.passwordResetLogFallback = orig.fb;
+                config_1.config.publicUrl = orig.pub;
+            }
+        });
+        // The variable also drives each device's dashboard_link, so a value
+        // Xenon refuses is said at startup whether or not mail is set up. It was
+        // silent without SMTP. The value itself is not logged: it may carry a
+        // user name and password, one of the reasons it is refused.
+        it('warns, once, when XENON_PUBLIC_URL is set but refused, mail or not', () => {
+            const orig = {
+                url: config_1.config.smtpUrl,
+                fb: config_1.config.passwordResetLogFallback,
+                pub: config_1.config.publicUrl,
+            };
+            const svc = new EmailService_1.EmailService();
+            const warn = sinon_1.default.stub(svc, 'warnLog');
+            try {
+                config_1.config.smtpUrl = undefined;
+                config_1.config.passwordResetLogFallback = false;
+                config_1.config.publicUrl = 'https://user:secret@lab.example.com/qa';
+                svc.warnAboutPublicUrl();
+                (0, chai_1.expect)(warn.calledOnce).to.equal(true);
+                (0, chai_1.expect)(warn.firstCall.args[0]).to.match(/XENON_PUBLIC_URL is set/);
+                (0, chai_1.expect)(warn.firstCall.args[0]).to.match(/dashboard/);
+                (0, chai_1.expect)(warn.firstCall.args[0]).to.not.include('secret');
+                warn.resetHistory();
+                config_1.config.smtpUrl = 'smtp://mail.example.com:587';
+                svc.warnAboutPublicUrl();
+                (0, chai_1.expect)(warn.calledOnce, 'one warning with SMTP too').to.equal(true);
+            }
+            finally {
+                config_1.config.smtpUrl = orig.url;
+                config_1.config.passwordResetLogFallback = orig.fb;
+                config_1.config.publicUrl = orig.pub;
+            }
+        });
+    });
 });

package/lib/test/unit/ResilioTreeHealingProvider.test.js

@@ -13,7 +13,8 @@ require("reflect-metadata");
 const chai_1 = require("chai");
 const types_1 = require("../../src/services/healing/types");
 const ResilioTreeHealingProvider_1 = require("../../src/services/healing/ResilioTreeHealingProvider");
-const { JSDOMParser, Path } = require('resiliotree');
+const xmldom_1 = require("@xmldom/xmldom");
+const resilioPath_1 = require("../../src/services/healing/resilioPath");
 describe('ResilioTreeHealingProvider', () => {
     let provider;
     let mockEtalonService;
@@ -43,32 +44,26 @@ describe('ResilioTreeHealingProvider', () => {
         };
         provider = new ResilioTreeHealingProvider_1.ResilioTreeHealingProvider(mockEtalonService);
     });
-    it('should heal an element when a ResilioTree path exists', () => __awaiter(void 0, void 0, void 0, function* () {
-        const parser = new JSDOMParser();
-        const root = parser.parse(sourceXml);
-        // Find the button in source
-        const bodyNode = root.children[0];
-        const hierarchyNode = bodyNode.children[0];
-        const frameLayout = hierarchyNode.children[0];
-        const linearLayout = frameLayout.children[0];
-        const buttonNode = linearLayout.children[0];
-        const path = new Path([root, bodyNode, hierarchyNode, frameLayout, linearLayout, buttonNode]);
+    // The button's id and text both changed, so it is another element as far as
+    // its path can tell: Resilio leaves it to Fuzzy XML rather than guess. (This
+    // test used to expect a heal, from a path made by an HTML parse and a driver
+    // stub that accepted any XPath, including the lowercase one Resilio wrote,
+    // which no real driver matches. See resilio-path-healing.spec.ts.)
+    it('leaves an element whose id and text changed to the next tier', () => __awaiter(void 0, void 0, void 0, function* () {
+        const doc = new xmldom_1.DOMParser().parseFromString(sourceXml, 'text/xml');
+        const button = doc.getElementsByTagName('android.widget.Button')[0];
         mockEtalonService.getSignature = () => __awaiter(void 0, void 0, void 0, function* () {
             return ({
                 selector: "//android.widget.Button[@text='Submit']",
                 strategy: 'xpath',
                 attributes: { text: 'Submit', 'resource-id': 'com.example:id/submit_btn' },
                 nodeName: 'android.widget.Button',
-                path: path.toJSON(),
+                path: (0, resilioPath_1.resilioPathOf)(button, sourceXml),
                 lastSeen: Date.now(),
             });
         });
         const mockDriver = {
-            findElement: (strategy, selector) => __awaiter(void 0, void 0, void 0, function* () {
-                (0, chai_1.expect)(strategy).to.equal('xpath');
-                (0, chai_1.expect)(selector.toLowerCase()).to.contain('android.widget.button');
-                return { ELEMENT: 'healed-element-123' };
-            }),
+            findElement: () => __awaiter(void 0, void 0, void 0, function* () { return ({ ELEMENT: 'any-element' }); }),
         };
         const context = {
             sessionId: 'test-session',
@@ -77,11 +72,43 @@ describe('ResilioTreeHealingProvider', () => {
             selector: "//android.widget.Button[@text='Submit']",
             pageSource: brokenXml,
         };
-        const result = yield provider.heal(context);
-        (0, chai_1.expect)(result).to.not.be.null;
+        (0, chai_1.expect)(yield provider.heal(context)).to.equal(null);
+    }));
+    it('heals the same element after the page changed around it', () => __awaiter(void 0, void 0, void 0, function* () {
+        const doc = new xmldom_1.DOMParser().parseFromString(sourceXml, 'text/xml');
+        const button = doc.getElementsByTagName('android.widget.Button')[0];
+        mockEtalonService.getSignature = () => __awaiter(void 0, void 0, void 0, function* () {
+            return ({
+                selector: "//android.widget.Button[@text='Submit']",
+                strategy: 'xpath',
+                attributes: {},
+                nodeName: 'android.widget.Button',
+                path: (0, resilioPath_1.resilioPathOf)(button, sourceXml),
+                lastSeen: Date.now(),
+            });
+        });
+        // The button moved into a new row; it is still "Submit".
+        const movedXml = sourceXml
+            .replace('<android.widget.Button index="0"', '<android.widget.LinearLayout index="0"><android.widget.Button index="0"')
+            .replace('resource-id="com.example:id/submit_btn" />', 'resource-id="com.example:id/submit_btn" /></android.widget.LinearLayout>');
+        const asked = [];
+        const result = yield provider.heal({
+            sessionId: 'test-session',
+            driver: {
+                findElement: (_using, selector) => __awaiter(void 0, void 0, void 0, function* () {
+                    asked.push(selector);
+                    return { ELEMENT: 'healed-element-123' };
+                }),
+            },
+            strategy: 'xpath',
+            selector: "//android.widget.Button[@text='Submit']",
+            pageSource: movedXml,
+        });
         (0, chai_1.expect)(result === null || result === void 0 ? void 0 : result.id).to.equal('healed-element-123');
         (0, chai_1.expect)(result === null || result === void 0 ? void 0 : result.tier).to.equal(types_1.HealingTier.TIER_1_RECOVERY);
         (0, chai_1.expect)(result === null || result === void 0 ? void 0 : result.message).to.contain('ResilioTree');
+        // The element's own id, which it kept.
+        (0, chai_1.expect)(asked[0]).to.equal("//*[@resource-id='com.example:id/submit_btn']");
     }));
     it('should return null if no signature/path is found', () => __awaiter(void 0, void 0, void 0, function* () {
         const context = {

package/lib/test/unit/ai-call-time-limit.spec.js

@@ -0,0 +1,130 @@
+"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 });
+require("reflect-metadata");
+const chai_1 = require("chai");
+const sinon_1 = __importDefault(require("sinon"));
+const AIService_1 = require("../../src/services/AIService");
+const CircuitBreaker_1 = require("../../src/services/CircuitBreaker");
+const HealingOrchestrator_1 = require("../../src/services/healing/HealingOrchestrator");
+const fake_ai_provider_1 = require("../helpers/fake-ai-provider");
+/**
+ * An AI call made while a test command runs has a time limit.
+ *
+ * The LLM and visual healing tiers run inside a failing findElement, the
+ * visual assertion and the screen description inside an execute script, and
+ * an ai-icon find inside findElement or device control's Test locator. Only
+ * Ollama had a time limit (30 s). The OpenAI and Anthropic SDKs wait up to 10
+ * minutes a try, with two retries, and Gemini has none, so one provider that
+ * didn't answer held the command, and the test, for as long, past the
+ * client's own timeout.
+ */
+describe('AI calls made during a test command', () => {
+    const ai = (0, fake_ai_provider_1.useFakeAiProviders)();
+    const SCREEN = 'c2NyZWVuc2hvdA==';
+    afterEach(() => sinon_1.default.restore());
+    /** What a call came to: its answer, or its error. */
+    const outcomeOf = (p) => p.then((value) => ({ value, error: undefined }), (error) => ({ value: undefined, error }));
+    const calls = [
+        {
+            name: 'an LLM heal finds nothing',
+            call: (s) => s.healLocator({ selector: '//x', strategy: 'xpath', xml: '<hierarchy/>' }),
+            expectOutcome: ({ value, error }) => {
+                (0, chai_1.expect)(error).to.equal(undefined);
+                (0, chai_1.expect)(value).to.equal(null);
+            },
+        },
+        {
+            name: 'a visual heal or ai-icon find finds nothing',
+            call: (s) => s.visualFind(SCREEN, 'the cart icon'),
+            expectOutcome: ({ value, error }) => {
+                (0, chai_1.expect)(error).to.equal(undefined);
+                (0, chai_1.expect)(value).to.equal(null);
+            },
+        },
+        {
+            name: "Test locator fails, saying the provider didn't answer",
+            call: (s) => s.visualFind(SCREEN, 'the cart icon', { throwOnError: true }),
+            expectOutcome: ({ error }) => {
+                (0, chai_1.expect)(error === null || error === void 0 ? void 0 : error.message).to.equal("The AI provider didn't answer within 30 s");
+            },
+        },
+        {
+            name: "a visual assertion fails, saying the provider didn't answer",
+            call: (s) => s.assertVisual(SCREEN, 'The cart is empty'),
+            expectOutcome: ({ error }) => {
+                (0, chai_1.expect)(error === null || error === void 0 ? void 0 : error.message).to.equal("The AI provider didn't answer within 30 s, so the condition was not checked. Try again later.");
+            },
+        },
+        {
+            name: "a screen description fails, saying the provider didn't answer",
+            call: (s) => s.describeScreen(SCREEN),
+            expectOutcome: ({ error }) => {
+                (0, chai_1.expect)(error === null || error === void 0 ? void 0 : error.message).to.equal("The AI provider didn't answer within 30 s");
+            },
+        },
+    ];
+    for (const { name, call, expectOutcome } of calls) {
+        it(`gives up at the limit, cancelling the request: ${name}`, () => __awaiter(void 0, void 0, void 0, function* () {
+            var _a, _b;
+            const { model } = ai.use('anthropic');
+            ai.answer('hang');
+            const clock = sinon_1.default.useFakeTimers({ toFake: ['setTimeout', 'clearTimeout'] });
+            const service = new AIService_1.AIService();
+            const outcome = outcomeOf(call(service));
+            yield clock.tickAsync(AIService_1.AI_CALL_TIMEOUT_MS - 1);
+            (0, chai_1.expect)(ai.calls).to.have.length(1);
+            (0, chai_1.expect)((_a = ai.calls[0].signal) === null || _a === void 0 ? void 0 : _a.aborted).to.equal(false);
+            yield clock.tickAsync(1);
+            (0, chai_1.expect)((_b = ai.calls[0].signal) === null || _b === void 0 ? void 0 : _b.aborted).to.equal(true);
+            expectOutcome(yield outcome);
+            const breaker = CircuitBreaker_1.CIRCUIT_BREAKERS.snapshot().find((b) => b.key === `ai:anthropic:${model}`);
+            (0, chai_1.expect)(breaker === null || breaker === void 0 ? void 0 : breaker.consecutiveFailures).to.equal(1);
+        }));
+    }
+    it("Test connection fails at the limit, saying the provider didn't answer", () => __awaiter(void 0, void 0, void 0, function* () {
+        var _a;
+        ai.use('openai');
+        ai.answer('hang');
+        const clock = sinon_1.default.useFakeTimers({ toFake: ['setTimeout', 'clearTimeout'] });
+        const result = new AIService_1.AIService().testConnection({});
+        yield clock.tickAsync(AIService_1.AI_CALL_TIMEOUT_MS);
+        (0, chai_1.expect)(yield result).to.deep.equal({
+            success: false,
+            message: "Connection failed: The AI provider didn't answer within 30 s",
+        });
+        (0, chai_1.expect)((_a = ai.calls[0].signal) === null || _a === void 0 ? void 0 : _a.aborted).to.equal(true);
+    }));
+    it('a failing findElement is answered within two time limits, after both AI tiers', () => __awaiter(void 0, void 0, void 0, function* () {
+        ai.use('gemini');
+        ai.answer('hang');
+        const clock = sinon_1.default.useFakeTimers({ toFake: ['setTimeout', 'clearTimeout'] });
+        const driver = {
+            getPageSource: () => __awaiter(void 0, void 0, void 0, function* () { return '<hierarchy/>'; }),
+            getScreenshot: () => __awaiter(void 0, void 0, void 0, function* () { return SCREEN; }),
+            findElement: sinon_1.default.stub().rejects(new Error('no such element')),
+        };
+        let healed = 'not answered';
+        const healing = new HealingOrchestrator_1.HealingOrchestrator({})
+            // The visual tier (4), then the LLM tier (5).
+            .attemptHealing('sess-time-limit', driver, 'id', 'login', [4, 5])
+            .then((result) => (healed = result));
+        yield clock.tickAsync(AIService_1.AI_CALL_TIMEOUT_MS);
+        (0, chai_1.expect)(ai.calls).to.have.length(2);
+        yield clock.tickAsync(AIService_1.AI_CALL_TIMEOUT_MS);
+        yield healing;
+        (0, chai_1.expect)(healed).to.equal(null);
+        (0, chai_1.expect)(ai.calls.map((c) => { var _a; return (_a = c.signal) === null || _a === void 0 ? void 0 : _a.aborted; })).to.deep.equal([true, true]);
+    }));
+});