scratchfoundation/scratch-vm
1
0
Fork 0
mirror of https://github.com/scratchfoundation/scratch-vm.git synced 2024-12-23 06:23:37 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Merge pull request #1727 from paulkaplan/add-ext-on-share

Browse source 
Add unloaded extensions on block sharing
This commit is contained in:
Ray Schamp 2018-11-08 10:15:58 +00:00 committed by GitHub
commit 4f5aba4fe6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 154 additions and 82 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
src/serialization/sb3.js
View file

@ -271,6 +271,19 @@ const compressInputTree = function (block, blocks) {
return block; return block;
}; };
/**
* Get non-core extension ID for a given sb3 opcode.
* @param {!string} opcode The opcode to examine for extension.
* @return {?string} The extension ID, if it exists and is not a core extension.
*/
const getExtensionIdForOpcode = function (opcode) {
const index = opcode.indexOf('_');
const prefix = opcode.substring(0, index);
if (CORE_EXTENSIONS.indexOf(prefix) === -1) {
if (prefix !== '') return prefix;
}
};
/** /**
* Serialize the given blocks object (representing all the blocks for the target * Serialize the given blocks object (representing all the blocks for the target
* currently being serialized.) * currently being serialized.)
@ -285,10 +298,9 @@ const serializeBlocks = function (blocks) {
for (const blockID in blocks) { for (const blockID in blocks) {
if (!blocks.hasOwnProperty(blockID)) continue; if (!blocks.hasOwnProperty(blockID)) continue;
obj[blockID] = serializeBlock(blocks[blockID], blocks); obj[blockID] = serializeBlock(blocks[blockID], blocks);
const index = blocks[blockID].opcode.indexOf('_'); const extensionID = getExtensionIdForOpcode(blocks[blockID].opcode);
const prefix = blocks[blockID].opcode.substring(0, index); if (extensionID) {
if (CORE_EXTENSIONS.indexOf(prefix) === -1) { extensionIDs.add(extensionID);
if (prefix !== '') extensionIDs.add(prefix);
} }
} }
// once we have completed a first pass, do a second pass on block inputs // once we have completed a first pass, do a second pass on block inputs
@ -812,10 +824,9 @@ const parseScratchObject = function (object, runtime, extensions, zip) {
blocks.createBlock(blockJSON); blocks.createBlock(blockJSON);
// If the block is from an extension, record it. // If the block is from an extension, record it.
const index = blockJSON.opcode.indexOf('_'); const extensionID = getExtensionIdForOpcode(blockJSON.opcode);
const prefix = blockJSON.opcode.substring(0, index); if (extensionID) {
if (CORE_EXTENSIONS.indexOf(prefix) === -1) { extensions.extensionIDs.add(extensionID);
if (prefix !== '') extensions.extensionIDs.add(prefix);
} }
} }
} }
@ -1049,5 +1060,6 @@ module.exports = {
serialize: serialize, serialize: serialize,
deserialize: deserialize, deserialize: deserialize,
deserializeBlocks: deserializeBlocks, deserializeBlocks: deserializeBlocks,
serializeBlocks: serializeBlocks serializeBlocks: serializeBlocks,
getExtensionIdForOpcode: getExtensionIdForOpcode
}; };

23
src/virtual-machine.js
View file

@ -1107,6 +1107,7 @@ class VirtualMachine extends EventEmitter {
* @param {!string} targetId Id of target to add blocks to. * @param {!string} targetId Id of target to add blocks to.
* @param {?string} optFromTargetId Optional target id indicating that blocks are being * @param {?string} optFromTargetId Optional target id indicating that blocks are being
* shared from that target. This is needed for resolving any potential variable conflicts. * shared from that target. This is needed for resolving any potential variable conflicts.
* @return {!Promise} Promise that resolves when the extensions and blocks have been added.
*/ */
shareBlocksToTarget (blocks, targetId, optFromTargetId) { shareBlocksToTarget (blocks, targetId, optFromTargetId) {
const copiedBlocks = JSON.parse(JSON.stringify(blocks)); const copiedBlocks = JSON.parse(JSON.stringify(blocks));
@ -1119,10 +1120,24 @@ class VirtualMachine extends EventEmitter {
fromTarget.resolveVariableSharingConflictsWithTarget(copiedBlocks, target); fromTarget.resolveVariableSharingConflictsWithTarget(copiedBlocks, target);
} }
for (let i = 0; i < copiedBlocks.length; i++) { // Create a unique set of extensionIds that are not yet loaded
target.blocks.createBlock(copiedBlocks[i]); const extensionIDs = new Set(copiedBlocks
} .map(b => sb3.getExtensionIdForOpcode(b.opcode))
target.blocks.updateTargetSpecificBlocks(target.isStage); .filter(id => !!id) // Remove ids that do not exist
.filter(id => !this.extensionManager.isExtensionLoaded(id)) // and remove loaded extensions
);
// Create an array promises for extensions to load
const extensionPromises = Array.from(extensionIDs,
id => this.extensionManager.loadExtensionURL(id)
);
return Promise.all(extensionPromises).then(() => {
copiedBlocks.forEach(block => {
target.blocks.createBlock(block);
});
target.blocks.updateTargetSpecificBlocks(target.isStage);
});
} }
/** /**

15
test/unit/serialization_sb3.js
View file

@ -221,3 +221,18 @@ test('deserializeBlocks on already deserialized input', t => {
t.end(); t.end();
}); });
}); });
test('getExtensionIdForOpcode', t => {
t.equal(sb3.getExtensionIdForOpcode('wedo_loopy'), 'wedo');
// does not consider CORE to be extensions
t.false(sb3.getExtensionIdForOpcode('control_loopy'));
// only considers things before the first underscore
t.equal(sb3.getExtensionIdForOpcode('hello_there_loopy'), 'hello');
// does not return anything for opcodes with no extension
t.false(sb3.getExtensionIdForOpcode('hello'));
t.end();
});

168
test/unit/virtual-machine.js
View file

@ -744,28 +744,29 @@ test('shareBlocksToTarget shares global variables without any name changes', t =
t.type(stage.blocks.getBlock('a block'), 'undefined'); t.type(stage.blocks.getBlock('a block'), 'undefined');
// Share the block to the stage // Share the block to the stage
vm.shareBlocksToTarget([target.blocks.getBlock('a block')], stage.id, target.id); vm.shareBlocksToTarget([target.blocks.getBlock('a block')], stage.id, target.id).then(() => {
// Verify that the block now exists on the target as well as the stage // Verify that the block now exists on the target as well as the stage
t.type(target.blocks.getBlock('a block'), 'object'); t.type(target.blocks.getBlock('a block'), 'object');
t.type(target.blocks.getBlock('a block').fields, 'object'); t.type(target.blocks.getBlock('a block').fields, 'object');
t.type(target.blocks.getBlock('a block').fields.VARIABLE, 'object'); t.type(target.blocks.getBlock('a block').fields.VARIABLE, 'object');
t.equal(target.blocks.getBlock('a block').fields.VARIABLE.id, 'mock var id'); t.equal(target.blocks.getBlock('a block').fields.VARIABLE.id, 'mock var id');
t.type(stage.blocks.getBlock('a block'), 'object'); t.type(stage.blocks.getBlock('a block'), 'object');
t.type(stage.blocks.getBlock('a block').fields, 'object'); t.type(stage.blocks.getBlock('a block').fields, 'object');
t.type(stage.blocks.getBlock('a block').fields.VARIABLE, 'object'); t.type(stage.blocks.getBlock('a block').fields.VARIABLE, 'object');
t.equal(stage.blocks.getBlock('a block').fields.VARIABLE.id, 'mock var id'); t.equal(stage.blocks.getBlock('a block').fields.VARIABLE.id, 'mock var id');
// Verify that the variables haven't changed, the variable still exists on the // Verify that the variables haven't changed, the variable still exists on the
// stage, it should still have the same name and value, and there should be // stage, it should still have the same name and value, and there should be
// no variables on the target. // no variables on the target.
t.equal(Object.keys(target.variables).length, 0); t.equal(Object.keys(target.variables).length, 0);
t.equal(Object.keys(stage.variables).length, 1); t.equal(Object.keys(stage.variables).length, 1);
t.equal(stage.variables['mock var id'].name, 'a mock variable'); t.equal(stage.variables['mock var id'].name, 'a mock variable');
t.equal(vm.getVariableValue(stage.id, 'mock var id'), 10); t.equal(vm.getVariableValue(stage.id, 'mock var id'), 10);
t.end(); t.end();
});
}); });
test('shareBlocksToTarget shares a local variable to the stage, creating a global variable with a new name', t => { test('shareBlocksToTarget shares a local variable to the stage, creating a global variable with a new name', t => {
@ -803,36 +804,36 @@ test('shareBlocksToTarget shares a local variable to the stage, creating a globa
t.type(stage.blocks.getBlock('a block'), 'undefined'); t.type(stage.blocks.getBlock('a block'), 'undefined');
// Share the block to the stage // Share the block to the stage
vm.shareBlocksToTarget([target.blocks.getBlock('a block')], stage.id, target.id); vm.shareBlocksToTarget([target.blocks.getBlock('a block')], stage.id, target.id).then(() => {
// Verify that the block still exists on the target and remains unchanged
t.type(target.blocks.getBlock('a block'), 'object');
t.type(target.blocks.getBlock('a block').fields, 'object');
t.type(target.blocks.getBlock('a block').fields.VARIABLE, 'object');
t.equal(target.blocks.getBlock('a block').fields.VARIABLE.id, 'mock var id');
// Verify that the block still exists on the target and remains unchanged t.type(stage.blocks.getBlock('a block'), 'object');
t.type(target.blocks.getBlock('a block'), 'object'); t.type(stage.blocks.getBlock('a block').fields, 'object');
t.type(target.blocks.getBlock('a block').fields, 'object'); t.type(stage.blocks.getBlock('a block').fields.VARIABLE, 'object');
t.type(target.blocks.getBlock('a block').fields.VARIABLE, 'object'); t.equal(stage.blocks.getBlock('a block').fields.VARIABLE.id, 'StageVarFromLocal_mock var id');
t.equal(target.blocks.getBlock('a block').fields.VARIABLE.id, 'mock var id');
t.type(stage.blocks.getBlock('a block'), 'object'); // Verify that a new global variable was created, the old one still exists on
t.type(stage.blocks.getBlock('a block').fields, 'object'); // the target and still has the same name and value, and the new one has
t.type(stage.blocks.getBlock('a block').fields.VARIABLE, 'object'); // a new name and value 0.
t.equal(stage.blocks.getBlock('a block').fields.VARIABLE.id, 'StageVarFromLocal_mock var id'); t.equal(Object.keys(target.variables).length, 1);
t.equal(target.variables['mock var id'].name, 'a mock variable');
t.equal(vm.getVariableValue(target.id, 'mock var id'), 10);
// Verify that a new global variable was created, the old one still exists on // Verify that a new variable was created on the stage, with a new name and new id
// the target and still has the same name and value, and the new one has t.equal(Object.keys(stage.variables).length, 1);
// a new name and value 0. t.type(stage.variables['mock var id'], 'undefined');
t.equal(Object.keys(target.variables).length, 1); const newGlobalVar = Object.values(stage.variables)[0];
t.equal(target.variables['mock var id'].name, 'a mock variable'); t.equal(newGlobalVar.name, 'Stage: a mock variable');
t.equal(vm.getVariableValue(target.id, 'mock var id'), 10); const newId = newGlobalVar.id;
t.notEqual(newId, 'mock var id');
t.equals(vm.getVariableValue(stage.id, newId), 0);
// Verify that a new variable was created on the stage, with a new name and new id t.end();
t.equal(Object.keys(stage.variables).length, 1); });
t.type(stage.variables['mock var id'], 'undefined');
const newGlobalVar = Object.values(stage.variables)[0];
t.equal(newGlobalVar.name, 'Stage: a mock variable');
const newId = newGlobalVar.id;
t.notEqual(newId, 'mock var id');
t.equals(vm.getVariableValue(stage.id, newId), 0);
t.end();
}); });
test('shareBlocksToTarget chooses a fresh name for a new global variable checking for conflicts on all sprites', t => { test('shareBlocksToTarget chooses a fresh name for a new global variable checking for conflicts on all sprites', t => {
@ -877,36 +878,65 @@ test('shareBlocksToTarget chooses a fresh name for a new global variable checkin
otherTarget.createVariable('a different var', 'Stage: a mock variable', Variable.SCALAR_TYPE); otherTarget.createVariable('a different var', 'Stage: a mock variable', Variable.SCALAR_TYPE);
// Share the block to the stage // Share the block to the stage
vm.shareBlocksToTarget([target.blocks.getBlock('a block')], stage.id, target.id); vm.shareBlocksToTarget([target.blocks.getBlock('a block')], stage.id, target.id).then(() => {
// Verify that the block still exists on the target and remains unchanged
t.type(target.blocks.getBlock('a block'), 'object');
t.type(target.blocks.getBlock('a block').fields, 'object');
t.type(target.blocks.getBlock('a block').fields.VARIABLE, 'object');
t.equal(target.blocks.getBlock('a block').fields.VARIABLE.id, 'mock var id');
// Verify that the block still exists on the target and remains unchanged t.type(stage.blocks.getBlock('a block'), 'object');
t.type(target.blocks.getBlock('a block'), 'object'); t.type(stage.blocks.getBlock('a block').fields, 'object');
t.type(target.blocks.getBlock('a block').fields, 'object'); t.type(stage.blocks.getBlock('a block').fields.VARIABLE, 'object');
t.type(target.blocks.getBlock('a block').fields.VARIABLE, 'object'); t.equal(stage.blocks.getBlock('a block').fields.VARIABLE.id, 'StageVarFromLocal_mock var id');
t.equal(target.blocks.getBlock('a block').fields.VARIABLE.id, 'mock var id');
t.type(stage.blocks.getBlock('a block'), 'object'); // Verify that a new global variable was created, the old one still exists on
t.type(stage.blocks.getBlock('a block').fields, 'object'); // the target and still has the same name and value, and the new one has
t.type(stage.blocks.getBlock('a block').fields.VARIABLE, 'object'); // a new name and value 0.
t.equal(stage.blocks.getBlock('a block').fields.VARIABLE.id, 'StageVarFromLocal_mock var id'); t.equal(Object.keys(target.variables).length, 1);
t.equal(target.variables['mock var id'].name, 'a mock variable');
t.equal(vm.getVariableValue(target.id, 'mock var id'), 10);
// Verify that a new global variable was created, the old one still exists on // Verify that a new variable was created on the stage, with a new name and new id
// the target and still has the same name and value, and the new one has t.equal(Object.keys(stage.variables).length, 1);
// a new name and value 0. t.type(stage.variables['mock var id'], 'undefined');
t.equal(Object.keys(target.variables).length, 1); const newGlobalVar = Object.values(stage.variables)[0];
t.equal(target.variables['mock var id'].name, 'a mock variable'); t.equal(newGlobalVar.name, 'Stage: a mock variable2');
t.equal(vm.getVariableValue(target.id, 'mock var id'), 10); const newId = newGlobalVar.id;
t.notEqual(newId, 'mock var id');
t.equals(vm.getVariableValue(stage.id, newId), 0);
// Verify that a new variable was created on the stage, with a new name and new id t.end();
t.equal(Object.keys(stage.variables).length, 1); });
t.type(stage.variables['mock var id'], 'undefined'); });
const newGlobalVar = Object.values(stage.variables)[0];
t.equal(newGlobalVar.name, 'Stage: a mock variable2');
const newId = newGlobalVar.id;
t.notEqual(newId, 'mock var id');
t.equals(vm.getVariableValue(stage.id, newId), 0);
t.end(); test('shareBlocksToTarget loads extensions that have not yet been loaded', t => {
const vm = new VirtualMachine();
const runtime = vm.runtime;
const spr1 = new Sprite(null, runtime);
const stage = spr1.createClone();
runtime.targets = [stage];
const fakeBlocks = [
{opcode: 'loaded_fakeblock'},
{opcode: 'notloaded_fakeblock'}
];
// Stub the extension manager
const loadedIds = [];
vm.extensionManager = {
isExtensionLoaded: id => id === 'loaded',
loadExtensionURL: id => new Promise(resolve => {
loadedIds.push(id);
resolve();
})
};
vm.shareBlocksToTarget(fakeBlocks, stage.id).then(() => {
// Verify that only the not-loaded extension gets loaded
t.deepEqual(loadedIds, ['notloaded']);
t.end();
});
}); });
test('Setting turbo mode emits events', t => { test('Setting turbo mode emits events', t => {