Files
gerrit/polygerrit-ui/app/elements/plugins/gr-plugin-host/gr-plugin-host.js
Viktar Donich 8b3455518a Support for GWT to PolyGerrit integration plugin migration
Detect migration scenario based on UI script files to have same name and
different extensions (.html and .js).

Allow for multiple `Gerrit.install()` calls, reusing `plugin` instance
for purposes of migration.

Cleanup plugin interface between tests.

Change-Id: I1a98a2b8660ce4a1700766dc722d587817ede884
2018-01-10 23:41:23 +00:00

96 lines
2.8 KiB
JavaScript

// Copyright (C) 2017 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
(function() {
'use strict';
Polymer({
is: 'gr-plugin-host',
properties: {
config: {
type: Object,
observer: '_configChanged',
},
},
behaviors: [
Gerrit.BaseUrlBehavior,
],
_configChanged(config) {
const plugins = config.plugin;
const htmlPlugins = plugins.html_resource_paths || [];
const jsPlugins = this._handleMigrations(plugins.js_resource_paths || [],
htmlPlugins);
const defaultTheme = config.default_theme;
if (defaultTheme) {
// Make theme first to be first to load.
htmlPlugins.unshift(defaultTheme);
}
Gerrit._setPluginsCount(jsPlugins.length + htmlPlugins.length);
this._loadJsPlugins(jsPlugins);
this._importHtmlPlugins(htmlPlugins);
},
/**
* Omit .js plugins that have .html counterparts.
* For example, if plugin provides foo.js and foo.html, skip foo.js.
*/
_handleMigrations(jsPlugins, htmlPlugins) {
return jsPlugins.filter(url => {
const counterpart = url.replace(/\.js$/, '.html');
return !htmlPlugins.includes(counterpart);
});
},
/**
* @suppress {checkTypes}
* States that it expects no more than 3 parameters, but that's not true.
* @todo (beckysiegel) check Polymer annotations and submit change.
*/
_importHtmlPlugins(plugins) {
for (const url of plugins) {
// onload (second param) needs to be a function. When null or undefined
// were passed, plugins were not loaded correctly.
this.importHref(
this._urlFor(url), () => {}, Gerrit._pluginInstalled, true);
}
},
_loadJsPlugins(plugins) {
for (const url of plugins) {
this._createScriptTag(this._urlFor(url));
}
},
_createScriptTag(url) {
const el = document.createElement('script');
el.defer = true;
el.src = url;
el.onerror = Gerrit._pluginInstalled;
return document.body.appendChild(el);
},
_urlFor(pathOrUrl) {
if (pathOrUrl.startsWith('http')) {
return pathOrUrl;
}
if (!pathOrUrl.startsWith('/')) {
pathOrUrl = '/' + pathOrUrl;
}
return this.getBaseUrl() + pathOrUrl;
},
});
})();