BetterDesk/web-nodejs/tests/updateService.docker.test.js

'use strict';

const fs = require('fs');
const os = require('os');
const path = require('path');

function loadUpdateService({ dataDir, imageSha, dockerLayout }) {
    jest.resetModules();
    if (imageSha) process.env.BETTERDESK_IMAGE_SHA = imageSha;
    process.env.BETTERDESK_UPDATE_MODE = 'image';
    if (dockerLayout) {
        process.env.BETTERDESK_DOCKER_LAYOUT = dockerLayout;
    } else {
        delete process.env.BETTERDESK_DOCKER_LAYOUT;
    }

    jest.doMock('../config/config', () => ({
        isDocker: true,
        dataDir,
        appVersion: '3.0.0-test'
    }));

    // eslint-disable-next-line global-require
    return require('../services/updateService');
}

describe('updateService docker image deployment', () => {
    let tmpRoot;
    let dataDir;

    beforeEach(() => {
        tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), 'bd-docker-update-'));
        dataDir = path.join(tmpRoot, 'data');
        fs.mkdirSync(dataDir, { recursive: true });
        delete process.env.BETTERDESK_IMAGE_SHA;
    });

    afterEach(() => {
        jest.resetModules();
        jest.dontMock('../config/config');
        delete process.env.BETTERDESK_DOCKER_LAYOUT;
        fs.rmSync(tmpRoot, { recursive: true, force: true });
    });

    test('uses embedded image SHA and disables stale-binary warnings', () => {
        const imageSha = 'abc123def4567890abcdef1234567890abcdef';
        fs.writeFileSync(path.join(dataDir, '.update_sha'), 'deadbeefdeadbeefdeadbeefdeadbeefdeadbeef\n');
        fs.writeFileSync(path.join(dataDir, '.server_binary_stale'), JSON.stringify({ stale: true }));

        const updateService = loadUpdateService({ dataDir, imageSha });

        expect(updateService.isImageBasedDockerDeployment()).toBe(true);
        expect(updateService.getImageEmbeddedSHA()).toBe(imageSha);
        expect(updateService.getLocalSHA()).toBe(imageSha);
        expect(updateService.getServerBinaryStatus()).toEqual({ stale: false, dockerMode: true });
        expect(fs.existsSync(path.join(dataDir, '.server_binary_stale'))).toBe(false);
    });

    test('bootstrap clears stale panel update result after image pull (#192)', () => {
        const imageSha = 'abc123def4567890abcdef1234567890abcdef';
        fs.writeFileSync(
            path.join(dataDir, '.last_update_result.json'),
            JSON.stringify({
                sha: imageSha,
                failed: [{ file: 'betterdesk.sh', error: 'EACCES', nonCritical: true }],
            })
        );

        loadUpdateService({ dataDir, imageSha });

        expect(fs.existsSync(path.join(dataDir, '.last_update_result.json'))).toBe(false);
    });

    test('applyUpdate rejects in-app installs', async () => {
        const updateService = loadUpdateService({
            dataDir,
            imageSha: 'abc123def4567890abcdef1234567890abcdef'
        });

        await expect(updateService.applyUpdate('abc1234', { grouped: {} }))
            .rejects
            .toThrow(/disabled in Docker image deployments/i);
    });

    test('rebuildServerBinary returns docker guidance', async () => {
        const updateService = loadUpdateService({
            dataDir,
            imageSha: 'abc123def4567890abcdef1234567890abcdef'
        });

        const result = await updateService.rebuildServerBinary();
        expect(result.success).toBe(false);
        expect(result.dockerMode).toBe(true);
        expect(result.error).toMatch(/not available in Docker/i);
    });

    test('getDockerUpdateInstructions returns split images by default', () => {
        const updateService = loadUpdateService({
            dataDir,
            imageSha: 'abc123def4567890abcdef1234567890abcdef'
        });

        const instructions = updateService.getDockerUpdateInstructions();
        expect(instructions.layout).toBe('split');
        expect(instructions.images).toHaveLength(2);
        expect(instructions.composeHint).toBe('docker-compose.quick.yml');
    });

    test('getDockerUpdateInstructions returns single all-in-one image', () => {
        const updateService = loadUpdateService({
            dataDir,
            imageSha: 'abc123def4567890abcdef1234567890abcdef',
            dockerLayout: 'single'
        });

        const instructions = updateService.getDockerUpdateInstructions();
        expect(instructions.layout).toBe('single');
        expect(instructions.images).toEqual(['ghcr.io/unitronix/betterdesk:latest']);
        expect(instructions.composeHint).toBe('docker-compose.quick.single.yml');
    });

    test('setUpdateChannel is rejected in Docker image mode (#299)', () => {
        const updateService = loadUpdateService({
            dataDir,
            imageSha: 'abc123def4567890abcdef1234567890abcdef',
            dockerLayout: 'single'
        });

        expect(() => updateService.setUpdateChannel('development')).toThrow(/BETTERDESK_IMAGE_TAG/);
        try {
            updateService.setUpdateChannel('development');
        } catch (err) {
            expect(err.code).toBe('DOCKER_IMAGE_CHANNEL');
        }

        const instructions = updateService.getDockerUpdateInstructions();
        expect(instructions.suggestedTags).toEqual({ stable: 'latest', development: 'dev' });
        expect(instructions.channelNote).toMatch(/BETTERDESK_IMAGE_TAG/);
    });
});