A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.
TypeScript 2d-game-engine3d3d-game-engineandroidcppecsgame-editorgame-enginegamedeviostypescriptwebassemblywebglwebgpuwechat-minigame
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
/**
* @file Export progress events — the pipeline emits a phase per major step so the
* Package Project dialog can show a live build log.
*/
import { describe, it, expect, beforeAll, afterAll } from 'vitest';
import { mkdtempSync, mkdirSync, writeFileSync, rmSync } from 'node:fs';
import { tmpdir } from 'node:os';
import path from 'node:path';
import { fileURLToPath } from 'node:url';
import { exportGame } from '../src/export/exportGame';
import type { ExportProgress } from '../src/export/exportProgress';
import { writeFakeSdkDist } from './fixtures/fakeSdkDist';
import { OFFICIAL_PACKAGES } from './officialPackagesDir';
const HERE = path.dirname(fileURLToPath(import.meta.url));
const HOSTS = path.join(HERE, '..', '..', 'pipeline', 'src', 'runtime');
let root: string;
const TEX = 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa';
const SCN = 'bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb';
const meta = (uuid: string, type: string) => JSON.stringify({ uuid, version: '2.0', type, importer: {} });
beforeAll(() => {
root = mkdtempSync(path.join(tmpdir(), 'estella-export-progress-'));
mkdirSync(path.join(root, 'assets'), { recursive: true });
writeFileSync(path.join(root, 'assets', 'hero.png'), 'PNGDATA');
writeFileSync(path.join(root, 'assets', 'hero.png.meta'), meta(TEX, 'texture'));
mkdirSync(path.join(root, 'scenes'), { recursive: true });
writeFileSync(path.join(root, 'scenes', 'main.esscene'),
JSON.stringify({ version: '1.0', name: 'Main', entities: [{ id: 0, components: [{ type: 'Sprite', data: { texture: `@uuid:${TEX}` } }] }] }));
writeFileSync(path.join(root, 'scenes', 'main.esscene.meta'), meta(SCN, 'scene'));
mkdirSync(path.join(root, 'src'), { recursive: true });
writeFileSync(path.join(root, 'src', 'main.ts'), `import { defineComponent } from 'esengine';\ndefineComponent('M', { n: 1 });\n`);
writeFakeSdkDist(path.join(root, '_sdk'));
mkdirSync(path.join(root, '_wasm'), { recursive: true });
writeFileSync(path.join(root, '_wasm', 'esengine.js'), 'export default () => {};');
writeFileSync(path.join(root, '_wasm', 'esengine.wasm'), 'wasmbytes');
}, 60_000);
afterAll(() => rmSync(root, { recursive: true, force: true, maxRetries: 10, retryDelay: 50 }));
describe('export progress', () => {
it('emits a phase per major step (web)', async () => {
const phases: string[] = [];
const res = await exportGame({
root,
entryScene: 'scenes/main.esscene',
hostsDir: HOSTS, packagesDir: OFFICIAL_PACKAGES,
scriptsEntry: 'src/main.ts',
sdkDistDir: path.join(root, '_sdk'),
wasmDir: path.join(root, '_wasm'),
outDir: path.join(root, 'out'),
platform: 'web',
onProgress: (p: ExportProgress) => phases.push(p.phase),
});
expect(res.ok).toBe(true);
for (const expected of ['Cooking assets', 'Bundling game host', 'Bundling project scripts', 'Copying SDK + runtime', 'Writing host page']) {
expect(phases).toContain(expected);
}
// Cooking is first; writing the host page is among the last.
expect(phases.indexOf('Cooking assets')).toBeLessThan(phases.indexOf('Writing host page'));
}, 60_000);
it('does not claim a step a native target never takes', async () => {
// A progress line is a report of work. Desktop writes no host page — there is
// no browser to boot the game — and a log that says it did is one a developer
// reads while looking for what actually happened.
const phases: string[] = [];
const res = await exportGame({
root,
entryScene: 'scenes/main.esscene',
hostsDir: HOSTS, packagesDir: OFFICIAL_PACKAGES,
scriptsEntry: 'src/main.ts',
sdkDistDir: path.join(root, '_sdk'),
wasmDir: path.join(root, '_wasm'),
outDir: path.join(root, 'out-desktop'),
platform: 'desktop',
onProgress: (p: ExportProgress) => phases.push(p.phase),
});
expect(res.ok).toBe(true);
expect(phases).toContain('Cooking assets');
expect(phases).not.toContain('Writing host page');
}, 60_000);
});