opendev/gerrit
Code Issues Proposed changes

Load GWT-compiled plugins in PolyGerrit

Browse Source 
Also install "stepping stone" API to simplify migration.

Feature: Issue 7800
Change-Id: Ib22d2ef4bc2e485228e35e7ca9183a8a984dbbe1
This commit is contained in:
Viktar Donich 2017-12-22 10:23:50 -08:00
parent 17c02269fc
commit 250bf09f5c
2 changed files with 29 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
polygerrit-ui/app/elements/shared/gr-js-api-interface/gr-js-api-interface_test.html
View File

@ -346,19 +346,15 @@ limitations under the License.
test('installGwt calls _pluginInstalled', () => {
sandbox.stub(Gerrit, '_pluginInstalled');
Gerrit.installGwt();
Gerrit.installGwt('http://test.com/plugins/testplugin/static/test.js');
assert.isTrue(Gerrit._pluginInstalled.calledOnce);
});
test('installGwt returns a stub object', () => {
const plugin = Gerrit.installGwt();
sandbox.stub(console, 'warn');
assert.isAbove(Object.keys(plugin).length, 0);
for (const name of Object.keys(plugin)) {
console.warn.reset();
plugin[name]();
assert.isTrue(console.warn.calledOnce);
}
test('installGwt returns a plugin', () => {
const plugin = Gerrit.installGwt(
'http://test.com/plugins/testplugin/static/test.js');
assert.isOk(plugin);
assert.isOk(plugin._loadedGwt);
});
test('attributeHelper', () => {
@ -391,9 +387,8 @@ limitations under the License.
suite('popup', () => {
test('popup(element) is deprecated', () => {
assert.throws(() => {
plugin.popup(document.createElement('div'));
});
plugin.popup(document.createElement('div'));
assert.isTrue(console.error.calledOnce);
});
test('popup(moduleName) creates popup with component', () => {

38
polygerrit-ui/app/elements/shared/gr-js-api-interface/gr-public-js-api.js
View File

@ -14,21 +14,11 @@
(function(window) {
'use strict';
const warnNotSupported = function(opt_name) {
console.warn('Plugin API method ' + (opt_name || '') + ' is not supported');
};
/**
* Hash of loaded and installed plugins, name to Plugin object.
*/
const plugins = {};
const stubbedMethods = ['_loadedGwt'];
const GWT_PLUGIN_STUB = {};
for (const name of stubbedMethods) {
GWT_PLUGIN_STUB[name] = warnNotSupported.bind(null, name);
}
const PANEL_ENDPOINTS_MAPPING = {
CHANGE_SCREEN_BELOW_COMMIT_INFO_BLOCK: 'change-view-integration',
CHANGE_SCREEN_BELOW_CHANGE_INFO_BLOCK: 'change-metadata-item',
@ -113,6 +103,7 @@
return;
}
this.deprecated = {
_loadedGwt: deprecatedAPI._loadedGwt.bind(this),
install: deprecatedAPI.install.bind(this),
onAction: deprecatedAPI.onAction.bind(this),
panel: deprecatedAPI.panel.bind(this),
@ -254,7 +245,8 @@
Plugin.prototype.popup = function(moduleName) {
if (typeof moduleName !== 'string') {
throw new Error('deprecated, use deprecated.popup');
console.error('.popup(element) deprecated, use .popup(moduleName)!');
return;
}
const api = new GrPopupInterface(this, moduleName);
return api.open();
@ -272,7 +264,9 @@
Plugin.prototype.screen = function(screenName, opt_moduleName) {
if (opt_moduleName && typeof opt_moduleName !== 'string') {
throw new Error('deprecated, use deprecated.screen');
console.error('.screen(pattern, callback) deprecated, use ' +
'.screen(screenName, opt_moduleName)!');
return;
}
return this.registerCustomComponent(
Gerrit._getPluginScreenName(this.getPluginName(), screenName),
@ -280,6 +274,8 @@
};
const deprecatedAPI = {
_loadedGwt: ()=> {},
install() {
console.log('Installing deprecated APIs is deprecated!');
for (const method in this.deprecated) {
@ -379,6 +375,7 @@
CHANGE_INFO: el.change,
REVISION_INFO: el.revision,
},
onUnload: () => {},
}));
},
};
@ -481,13 +478,20 @@
};
/**
* Polyfill GWT API dependencies to avoid runtime exceptions when loading
* GWT-compiled plugins.
* @deprecated Not supported in PolyGerrit.
* Install "stepping stones" API for GWT-compiled plugins by default.
* @deprecated best effort support, will be removed with GWT UI.
*/
Gerrit.installGwt = function() {
Gerrit.installGwt = function(url) {
Gerrit._pluginInstalled();
return GWT_PLUGIN_STUB;
const name = getPluginNameFromUrl(new URL(url));
let plugin;
try {
plugin = plugins[name] || new Plugin(url);
plugin.deprecated.install();
} catch (e) {
console.warn(`${name} install failed: ${e.name}: ${e.message}`);
}
return plugin;
};
Gerrit._allPluginsPromise = null;