/** * This test ensures that the VM gracefully handles a sprite3 file with * a missing bitmap costume. The VM should handle this safely by displaying * a Gray Question Mark, but keeping track of the original costume data * and serializing the original costume data back out. The saved project.json * should not reflect that the costume is broken and should therefore re-attempt * to load the costume if the saved project is re-loaded. */ const path = require('path'); const {test, beforeEach} = require('node:test'); const assert = require('node:assert'); const makeTestStorage = require('../fixtures/make-test-storage'); const FakeRenderer = require('../fixtures/fake-renderer'); const FakeBitmapAdapter = require('../fixtures/fake-bitmap-adapter'); const readFileToBuffer = require('../fixtures/readProjectFile').readFileToBuffer; const VirtualMachine = require('../../src/index'); const {serializeCostumes} = require('../../src/serialization/serialize-assets'); // The particular project that we're loading doesn't matter for this test const projectUri = path.resolve(__dirname, '../fixtures/default.sb3'); const project = readFileToBuffer(projectUri); const spriteUri = path.resolve(__dirname, '../fixtures/missing_png.sprite3'); const sprite = readFileToBuffer(spriteUri); const missingCostumeAssetId = 'e1320c21995dcf6de10119be7f08c26b'; global.Image = function () { const image = { width: 1, height: 1 }; setTimeout(() => image.onload(), 100); return image; }; global.document = { createElement: () => ({ // Create mock canvas getContext: () => ({ drawImage: () => ({}) }) }) }; let vm; beforeEach(async () => { const storage = makeTestStorage(); vm = new VirtualMachine(); vm.attachStorage(storage); vm.attachRenderer(new FakeRenderer()); vm.attachV2BitmapAdapter(new FakeBitmapAdapter()); await vm.loadProject(project); return vm.addSprite(sprite); }); test('loading sprite3 with missing bitmap costume file', () => { assert.strictEqual(vm.runtime.targets.length, 3); const stage = vm.runtime.targets[0]; assert.ok(stage.isStage); const greenGuySprite = vm.runtime.targets[2]; assert.strictEqual(greenGuySprite.getName(), 'Green Guy'); assert.strictEqual(greenGuySprite.getCostumes().length, 1); const missingCostume = greenGuySprite.getCostumes()[0]; assert.strictEqual(missingCostume.name, 'Green Guy'); // Costume should have both default cosutme (e.g. Gray Question Mark) data and original data const defaultBitmapAssetId = vm.runtime.storage.defaultAssetId.ImageBitmap; assert.strictEqual(missingCostume.assetId, defaultBitmapAssetId); assert.strictEqual(missingCostume.dataFormat, 'png'); // Runtime should have info about broken asset assert.ok(missingCostume.broken); assert.strictEqual(missingCostume.broken.assetId, missingCostumeAssetId); }); test('load and then save sprite3 with missing bitmap costume file', () => { const resavedSprite = JSON.parse(vm.toJSON(vm.runtime.targets[2].id)); assert.strictEqual(resavedSprite.name, 'Green Guy'); assert.strictEqual(resavedSprite.costumes.length, 1); const missingCostume = resavedSprite.costumes[0]; assert.strictEqual(missingCostume.name, 'Green Guy'); // Costume should have both default cosutme (e.g. Gray Question Mark) data and original data assert.strictEqual(missingCostume.assetId, missingCostumeAssetId); assert.strictEqual(missingCostume.dataFormat, 'png'); // Test that we didn't save any data about the costume being broken assert.ok(!missingCostume.broken); }); test('serializeCostume does not save data for missing costume', () => { const costumeDescs = serializeCostumes(vm.runtime, vm.runtime.targets[2].id); assert.strictEqual(costumeDescs.length, 0); });