Skip to content

Fix global plugin mappings in HEADLESS mode #7357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bagel786 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix global plugin mappings in HEADLESS mode #7357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/plugins/PluginManager.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,7 @@ var PluginManager = new Class({
start = true;
}

if (!this.game.isBooted)
if (!this.game.isBooted && this.game.config.renderType !== CONST.HEADLESS)
{
this._pendingGlobal.push({ key: key, plugin: plugin, start: start, mapping: mapping, data: data });
}
Expand Down
36 changes: 36 additions & 0 deletions tests/plugins/PluginManager.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ var PluginCache = require('../../src/plugins/PluginCache');
var GameObjectFactory = require('../../src/gameobjects/GameObjectFactory');
var GameObjectCreator = require('../../src/gameobjects/GameObjectCreator');
var FileTypesManager = require('../../src/loader/FileTypesManager');
var CONST = require('../../src/const');

describe('PluginManager', function ()
{
Expand Down Expand Up @@ -98,6 +99,41 @@ describe('PluginManager', function ()

expect(bootSpy).toHaveBeenCalled();
});

it('should install mapped global plugins immediately in HEADLESS mode', function ()
{
var MockPlugin = createMockPluginClass();
var cachedPlugin;
var headlessGame = createMockGame();

headlessGame.config.renderType = CONST.HEADLESS;
headlessGame.config.installGlobalPlugins = [
{ key: 'headlessPlugin', plugin: MockPlugin, mapping: 'headlessPlugin' }
];

vi.spyOn(PluginCache, 'hasCustom').mockImplementation(function ()
{
return cachedPlugin !== undefined;
});
vi.spyOn(PluginCache, 'registerCustom').mockImplementation(function (key, plugin, mapping, data)
{
cachedPlugin = { plugin: plugin, mapping: mapping, data: data };
});
vi.spyOn(PluginCache, 'getCustom').mockImplementation(function ()
{
return cachedPlugin;
});

var headlessManager = new PluginManager(headlessGame);
var mockSys = {
scene: {},
settings: { map: {}, isBooted: false }
};

headlessManager.addToScene(mockSys, [], []);

expect(mockSys.scene.headlessPlugin).toBeInstanceOf(MockPlugin);
});
});

describe('getIndex', function ()
Expand Down