Merge pull request #602 from cwillisf/remember-data-format

Remember data format after image or sound import

src/import/load-costume.js

@@ -32,7 +32,7 @@ const loadCostume = function (md5ext, costume, runtime) {
 
     let promise = runtime.storage.load(assetType, md5, ext).then(costumeAsset => {
         costume.assetId = costumeAsset.assetId;
-        costume.assetType = assetType;
+        costume.dataFormat = ext;
         return costumeAsset;
     });
 

src/import/load-sound.js

@@ -24,7 +24,7 @@ const loadSound = function (sound, runtime) {
     return runtime.storage.load(runtime.storage.AssetType.Sound, md5, ext)
         .then(soundAsset => {
             sound.assetId = soundAsset.assetId;
-            sound.assetType = runtime.storage.AssetType.Sound;
+            sound.dataFormat = ext;
             return runtime.audioEngine.decodeSound(Object.assign(
                 {},
                 sound,

src/serialization/sb3.js

@@ -75,7 +75,11 @@ const parseScratchObject = function (object, runtime) {
             rotationCenterX: costumeSource.rotationCenterX,
             rotationCenterY: costumeSource.rotationCenterY
         };
-        const costumeMd5 = `${costumeSource.assetId}.${costumeSource.dataFormat}`;
+        const dataFormat =
+            costumeSource.dataFormat ||
+            (costumeSource.assetType && costumeSource.assetType.runtimeFormat) || // older format
+            'png'; // if all else fails, guess that it might be a PNG
+        const costumeMd5 = `${costumeSource.assetId}.${dataFormat}`;
         return loadCostume(costumeMd5, costume, runtime);
     });
     // Sounds from JSON

test/fixtures/make-test-storage.js

@@ -33,15 +33,15 @@ const getAssetUrl = function (asset) {
 };
 
 /**
- * Construct a new instance of ScratchStorage, provide it with default web sources, and attach it to the provided VM.
+ * Construct a new instance of ScratchStorage and provide it with default web sources.
- * @param {VirtualMachine} vm - the VM which will own the new ScratchStorage instance.
+ * @returns {ScratchStorage} - an instance of ScratchStorage, ready to be used for tests.
  */
-const attachTestStorage = function (vm) {
+const makeTestStorage = function () {
     const storage = new ScratchStorage();
     const AssetType = storage.AssetType;
     storage.addWebSource([AssetType.Project], getProjectUrl);
     storage.addWebSource([AssetType.ImageVector, AssetType.ImageBitmap, AssetType.Sound], getAssetUrl);
-    vm.attachStorage(storage);
+    return storage;
 };
 
-module.exports = attachTestStorage;
+module.exports = makeTestStorage;

test/integration/clone-cleanup.js

@@ -1,6 +1,6 @@
 const path = require('path');
 const test = require('tap').test;
-const attachTestStorage = require('../fixtures/attach-test-storage');
+const makeTestStorage = require('../fixtures/make-test-storage');
 const extract = require('../fixtures/extract');
 const VirtualMachine = require('../../src/index');
 
@@ -9,7 +9,7 @@ const project = extract(projectUri);
 
 test('clone-cleanup', t => {
     const vm = new VirtualMachine();
-    attachTestStorage(vm);
+    vm.attachStorage(makeTestStorage());
 
     /**
      * Track which step of the project is currently under test.

test/integration/complex.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
 const path = require('path');
 const test = require('tap').test;
-const attachTestStorage = require('../fixtures/attach-test-storage');
+const makeTestStorage = require('../fixtures/make-test-storage');
 const extract = require('../fixtures/extract');
 const VirtualMachine = require('../../src/index');
 
@@ -13,7 +13,7 @@ const sprite = fs.readFileSync(spriteUri, 'utf8');
 
 test('complex', t => {
     const vm = new VirtualMachine();
-    attachTestStorage(vm);
+    vm.attachStorage(makeTestStorage());
 
     // Evaluate playground data and exit
     vm.on('playgroundData', e => {

test/integration/control.js

@@ -1,6 +1,6 @@
 const path = require('path');
 const test = require('tap').test;
-const attachTestStorage = require('../fixtures/attach-test-storage');
+const makeTestStorage = require('../fixtures/make-test-storage');
 const extract = require('../fixtures/extract');
 const VirtualMachine = require('../../src/index');
 
@@ -9,7 +9,7 @@ const project = extract(uri);
 
 test('control', t => {
     const vm = new VirtualMachine();
-    attachTestStorage(vm);
+    vm.attachStorage(makeTestStorage());
 
     // Evaluate playground data and exit
     vm.on('playgroundData', e => {

test/integration/data.js

@@ -1,6 +1,6 @@
 const path = require('path');
 const test = require('tap').test;
-const attachTestStorage = require('../fixtures/attach-test-storage');
+const makeTestStorage = require('../fixtures/make-test-storage');
 const extract = require('../fixtures/extract');
 const VirtualMachine = require('../../src/index');
 
@@ -9,7 +9,7 @@ const project = extract(uri);
 
 test('data', t => {
     const vm = new VirtualMachine();
-    attachTestStorage(vm);
+    vm.attachStorage(makeTestStorage());
 
     // Evaluate playground data and exit
     vm.on('playgroundData', () => {

test/integration/event.js

@@ -1,6 +1,6 @@
 const path = require('path');
 const test = require('tap').test;
-const attachTestStorage = require('../fixtures/attach-test-storage');
+const makeTestStorage = require('../fixtures/make-test-storage');
 const extract = require('../fixtures/extract');
 const VirtualMachine = require('../../src/index');
 
@@ -9,7 +9,7 @@ const project = extract(uri);
 
 test('event', t => {
     const vm = new VirtualMachine();
-    attachTestStorage(vm);
+    vm.attachStorage(makeTestStorage());
 
     // Evaluate playground data and exit
     vm.on('playgroundData', e => {

test/integration/hat-execution-order.js

@@ -1,6 +1,6 @@
 const path = require('path');
 const test = require('tap').test;
-const attachTestStorage = require('../fixtures/attach-test-storage');
+const makeTestStorage = require('../fixtures/make-test-storage');
 const extract = require('../fixtures/extract');
 const VirtualMachine = require('../../src/index');
 
@@ -9,7 +9,7 @@ const project = extract(projectUri);
 
 test('complex', t => {
     const vm = new VirtualMachine();
-    attachTestStorage(vm);
+    vm.attachStorage(makeTestStorage());
 
     // Evaluate playground data and exit
     vm.on('playgroundData', e => {

test/integration/import_sb2.js

@@ -1,6 +1,6 @@
 const path = require('path');
 const test = require('tap').test;
-const attachTestStorage = require('../fixtures/attach-test-storage');
+const makeTestStorage = require('../fixtures/make-test-storage');
 const extract = require('../fixtures/extract');
 
 const renderedTarget = require('../../src/sprites/rendered-target');
@@ -20,7 +20,7 @@ test('default', t => {
 
     // Create runtime instance & load SB2 into it
     const rt = new runtime();
-    attachTestStorage(rt);
+    rt.attachStorage(makeTestStorage());
     sb2.deserialize(json, rt).then(targets => {
         // Test
         t.type(file, 'string');

test/integration/looks.js

@@ -1,6 +1,6 @@
 const path = require('path');
 const test = require('tap').test;
-const attachTestStorage = require('../fixtures/attach-test-storage');
+const makeTestStorage = require('../fixtures/make-test-storage');
 const extract = require('../fixtures/extract');
 const VirtualMachine = require('../../src/index');
 
@@ -9,7 +9,7 @@ const project = extract(uri);
 
 test('looks', t => {
     const vm = new VirtualMachine();
-    attachTestStorage(vm);
+    vm.attachStorage(makeTestStorage());
 
     // Evaluate playground data and exit
     vm.on('playgroundData', e => {

test/integration/motion.js

@@ -1,6 +1,6 @@
 const path = require('path');
 const test = require('tap').test;
-const attachTestStorage = require('../fixtures/attach-test-storage');
+const makeTestStorage = require('../fixtures/make-test-storage');
 const extract = require('../fixtures/extract');
 const VirtualMachine = require('../../src/index');
 
@@ -9,7 +9,7 @@ const project = extract(uri);
 
 test('motion', t => {
     const vm = new VirtualMachine();
-    attachTestStorage(vm);
+    vm.attachStorage(makeTestStorage());
 
     // Evaluate playground data and exit
     vm.on('playgroundData', e => {

test/integration/pen.js

@@ -1,6 +1,6 @@
 const path = require('path');
 const test = require('tap').test;
-const attachTestStorage = require('../fixtures/attach-test-storage');
+const makeTestStorage = require('../fixtures/make-test-storage');
 const extract = require('../fixtures/extract');
 const VirtualMachine = require('../../src/index');
 
@@ -9,7 +9,7 @@ const project = extract(uri);
 
 test('pen', t => {
     const vm = new VirtualMachine();
-    attachTestStorage(vm);
+    vm.attachStorage(makeTestStorage());
 
     // Evaluate playground data and exit
     vm.on('playgroundData', () => {

test/integration/procedure.js

@@ -1,6 +1,6 @@
 const path = require('path');
 const test = require('tap').test;
-const attachTestStorage = require('../fixtures/attach-test-storage');
+const makeTestStorage = require('../fixtures/make-test-storage');
 const extract = require('../fixtures/extract');
 const VirtualMachine = require('../../src/index');
 
@@ -9,7 +9,7 @@ const project = extract(uri);
 
 test('procedure', t => {
     const vm = new VirtualMachine();
-    attachTestStorage(vm);
+    vm.attachStorage(makeTestStorage());
 
     // Evaluate playground data and exit
     vm.on('playgroundData', e => {

test/integration/sb3-roundtrip.js

@@ -0,0 +1,110 @@
+const test = require('tap').test;
+
+const Blocks = require('../../src/engine/blocks');
+const Clone = require('../../src/util/clone');
+const loadCostume = require('../../src/import/load-costume');
+const loadSound = require('../../src/import/load-sound');
+const makeTestStorage = require('../fixtures/make-test-storage');
+const Runtime = require('../../src/engine/runtime');
+const sb3 = require('../../src/serialization/sb3');
+const Sprite = require('../../src/sprites/sprite');
+
+const defaultCostumeInfo = {
+    bitmapResolution: 1,
+    rotationCenterX: 0,
+    rotationCenterY: 0
+};
+
+const defaultSoundInfo = {
+};
+
+test('sb3-roundtrip', t => {
+    const runtime1 = new Runtime();
+    runtime1.attachStorage(makeTestStorage());
+
+    const runtime2 = new Runtime();
+    runtime2.attachStorage(makeTestStorage());
+
+    const testRuntimeState = (label, runtime) => {
+        t.strictEqual(runtime.targets.length, 2, `${label}: target count`);
+        const [stageClone, spriteClone] = runtime.targets;
+
+        t.strictEqual(stageClone.isOriginal, true);
+        t.strictEqual(stageClone.isStage, true);
+
+        const stage = stageClone.sprite;
+        t.strictEqual(stage.name, 'Stage');
+        t.strictEqual(stage.clones.length, 1);
+        t.strictEqual(stage.clones[0], stageClone);
+
+        t.strictEqual(stage.costumes.length, 1);
+        const [building] = stage.costumes;
+        t.strictEqual(building.assetId, 'fe5e3566965f9de793beeffce377d054');
+        t.strictEqual(building.dataFormat, 'jpg');
+
+        t.strictEqual(stage.sounds.length, 0);
+
+        t.strictEqual(spriteClone.isOriginal, true);
+        t.strictEqual(spriteClone.isStage, false);
+
+        const sprite = spriteClone.sprite;
+        t.strictEqual(sprite.name, 'Sprite');
+        t.strictEqual(sprite.clones.length, 1);
+        t.strictEqual(sprite.clones[0], spriteClone);
+
+        t.strictEqual(sprite.costumes.length, 2);
+        const [cat, squirrel] = sprite.costumes;
+        t.strictEqual(cat.assetId, 'f88bf1935daea28f8ca098462a31dbb0');
+        t.strictEqual(cat.dataFormat, 'svg');
+        t.strictEqual(squirrel.assetId, '7e24c99c1b853e52f8e7f9004416fa34');
+        t.strictEqual(squirrel.dataFormat, 'png');
+
+        t.strictEqual(sprite.sounds.length, 1);
+        const [meow] = sprite.sounds;
+        t.strictEqual(meow.md5, '83c36d806dc92327b9e7049a565c6bff.wav');
+    };
+
+    const loadThings = Promise.all([
+        loadCostume('fe5e3566965f9de793beeffce377d054.jpg', Clone.simple(defaultCostumeInfo), runtime1),
+        loadCostume('f88bf1935daea28f8ca098462a31dbb0.svg', Clone.simple(defaultCostumeInfo), runtime1),
+        loadCostume('7e24c99c1b853e52f8e7f9004416fa34.png', Clone.simple(defaultCostumeInfo), runtime1),
+        loadSound(Object.assign({md5: '83c36d806dc92327b9e7049a565c6bff.wav'}, defaultSoundInfo), runtime1)
+    ]);
+
+    const installThings = loadThings.then(results => {
+        const [building, cat, squirrel, meow] = results;
+
+        const stageBlocks = new Blocks();
+        const stage = new Sprite(stageBlocks, runtime1);
+        stage.name = 'Stage';
+        stage.costumes = [building];
+        stage.sounds = [];
+        const stageClone = stage.createClone();
+        stageClone.isStage = true;
+
+        const spriteBlocks = new Blocks();
+        const sprite = new Sprite(spriteBlocks, runtime1);
+        sprite.name = 'Sprite';
+        sprite.costumes = [cat, squirrel];
+        sprite.sounds = [meow];
+        const spriteClone = sprite.createClone();
+
+        runtime1.targets = [stageClone, spriteClone];
+
+        testRuntimeState('original', runtime1);
+    });
+
+    const serializeAndDeserialize = installThings.then(() => {
+        // Doing a JSON `stringify` and `parse` here more accurately simulate a save/load cycle. In particular:
+        // 1. it ensures that any non-serializable data is thrown away, and
+        // 2. `sb3.deserialize` and its helpers do some `hasOwnProperty` checks which fail on the object returned by
+        //    `sb3.serialize` but succeed if that object is "flattened" in this way.
+        const serializedState = JSON.parse(JSON.stringify(sb3.serialize(runtime1)));
+        return sb3.deserialize(serializedState, runtime2);
+    });
+
+    return serializeAndDeserialize.then(targets => {
+        runtime2.targets = targets;
+        testRuntimeState('copy', runtime2);
+    });
+});

test/integration/sensing.js

@@ -1,6 +1,6 @@
 const path = require('path');
 const test = require('tap').test;
-const attachTestStorage = require('../fixtures/attach-test-storage');
+const makeTestStorage = require('../fixtures/make-test-storage');
 const extract = require('../fixtures/extract');
 const VirtualMachine = require('../../src/index');
 
@@ -9,7 +9,7 @@ const project = extract(uri);
 
 test('sensing', t => {
     const vm = new VirtualMachine();
-    attachTestStorage(vm);
+    vm.attachStorage(makeTestStorage());
 
     // Evaluate playground data and exit
     vm.on('playgroundData', e => {

test/integration/sound.js

@@ -1,6 +1,6 @@
 const path = require('path');
 const test = require('tap').test;
-const attachTestStorage = require('../fixtures/attach-test-storage');
+const makeTestStorage = require('../fixtures/make-test-storage');
 const extract = require('../fixtures/extract');
 const VirtualMachine = require('../../src/index');
 
@@ -9,7 +9,7 @@ const project = extract(uri);
 
 test('sound', t => {
     const vm = new VirtualMachine();
-    attachTestStorage(vm);
+    vm.attachStorage(makeTestStorage());
 
     // Evaluate playground data and exit
     vm.on('playgroundData', e => {