Merge changes Icb3f83d3,I1c95146f

* changes:
  Plugin popup() api
  Provide plugin DOM hooks for components
This commit is contained in:
Viktar Donich
2017-09-06 23:24:21 +00:00
committed by Gerrit Code Review
21 changed files with 715 additions and 70 deletions

View File

@@ -46,6 +46,7 @@ limitations under the License.
<link rel="import" href="./core/gr-reporting/gr-reporting.html">
<link rel="import" href="./core/gr-router/gr-router.html">
<link rel="import" href="./diff/gr-diff-view/gr-diff-view.html">
<link rel="import" href="./plugins/gr-endpoint-decorator/gr-endpoint-decorator.html">
<link rel="import" href="./plugins/gr-external-style/gr-external-style.html">
<link rel="import" href="./plugins/gr-plugin-host/gr-plugin-host.html">
<link rel="import" href="./settings/gr-cla-view/gr-cla-view.html">
@@ -201,6 +202,7 @@ limitations under the License.
on-close="_handleRegistrationDialogClose">
</gr-registration-dialog>
</gr-overlay>
<gr-endpoint-decorator name="plugin-overlay"></gr-endpoint-decorator>
<gr-error-manager id="errorManager"></gr-error-manager>
<gr-rest-api-interface id="restAPI"></gr-rest-api-interface>
<gr-reporting id="reporting"></gr-reporting>

View File

@@ -14,49 +14,122 @@
(function(window) {
'use strict';
function GrDomHooks(plugin) {
function GrDomHooksManager(plugin) {
this._plugin = plugin;
this._hooks = {};
}
GrDomHooks.prototype._getName = function(endpointName) {
return this._plugin.getPluginName() + '-autogenerated-' + endpointName;
GrDomHooksManager.prototype._getHookName = function(endpointName,
opt_moduleName) {
if (opt_moduleName) {
return endpointName + ' ' + opt_moduleName;
} else {
return this._plugin.getPluginName() + '-autogenerated-' + endpointName;
}
};
GrDomHooks.prototype.getDomHook = function(endpointName) {
const hookName = this._getName(endpointName);
GrDomHooksManager.prototype.getDomHook = function(endpointName,
opt_moduleName) {
const hookName = this._getHookName(endpointName, opt_moduleName);
if (!this._hooks[hookName]) {
this._hooks[hookName] = new GrDomHook(hookName);
this._hooks[hookName] = new GrDomHook(hookName, opt_moduleName);
}
return this._hooks[hookName];
};
function GrDomHook(hookName) {
function GrDomHook(hookName, opt_moduleName) {
this._instances = [];
this._callbacks = [];
// Expose to closure.
const callbacks = this._callbacks;
this._componentClass = Polymer({
if (opt_moduleName) {
this._moduleName = opt_moduleName;
} else {
this._moduleName = hookName;
this._createPlaceholder(hookName);
}
}
GrDomHook.prototype._createPlaceholder = function(hookName) {
Polymer({
is: hookName,
properties: {
plugin: Object,
content: Object,
},
attached() {
callbacks.forEach(callback => {
callback(this);
});
},
});
}
};
GrDomHook.prototype.handleInstanceDetached = function(instance) {
const index = this._instances.indexOf(instance);
if (index !== -1) {
this._instances.splice(index, 1);
}
};
GrDomHook.prototype.handleInstanceAttached = function(instance) {
this._instances.push(instance);
this._callbacks.forEach(callback => callback(instance));
};
/**
* Get instance of last DOM hook element attached into the endpoint.
* Returns a Promise, that's resolved when attachment is done.
* @return {!Promise<!Element>}
*/
GrDomHook.prototype.getLastAttached = function() {
if (this._instances.length) {
return Promise.resolve(this._instances.slice(-1)[0]);
}
if (!this._lastAttachedPromise) {
let resolve;
const promise = new Promise(r => resolve = r);
this._callbacks.push(resolve);
this._lastAttachedPromise = promise.then(element => {
this._lastAttachedPromise = null;
const index = this._callbacks.indexOf(resolve);
if (index !== -1) {
this._callbacks.splice(index, 1);
}
return element;
});
}
return this._lastAttachedPromise;
};
/**
* Get all DOM hook elements.
*/
GrDomHook.prototype.getAllAttached = function() {
return this._instances;
};
/**
* Install a new callback to invoke when a new instance of DOM hook element
* is attached.
* @param {function(Element)} callback
*/
GrDomHook.prototype.onAttached = function(callback) {
this._callbacks.push(callback);
return this;
};
/**
* Name of DOM hook element that will be installed into the endpoint.
*/
GrDomHook.prototype.getModuleName = function() {
return this._componentClass.prototype.is;
return this._moduleName;
};
window.GrDomHooks = GrDomHooks;
GrDomHook.prototype.getPublicAPI = function() {
const result = {};
const exposedMethods = [
'onAttached', 'getLastAttached', 'getAllAttached', 'getModuleName',
];
for (const p of exposedMethods) {
result[p] = this[p].bind(this);
}
return result;
};
window.GrDomHook = GrDomHook;
window.GrDomHooksManager = GrDomHooksManager;
})(window);

View File

@@ -33,28 +33,110 @@ limitations under the License.
<script>
suite('gr-dom-hooks tests', () => {
const PUBLIC_METHODS =
['onAttached', 'getLastAttached', 'getAllAttached', 'getModuleName'];
let instance;
let sandbox;
let hook;
let hookInternal;
setup(() => {
sandbox = sinon.sandbox.create();
let plugin;
Gerrit.install(p => { plugin = p; }, '0.1',
'http://test.com/plugins/testplugin/static/test.js');
instance = new GrDomHooks(plugin);
instance = new GrDomHooksManager(plugin);
});
teardown(() => {
sandbox.restore();
});
test('defines a Polymer components', () => {
const onAttachedSpy = sandbox.spy();
instance.getDomHook('foo-bar').onAttached(onAttachedSpy);
const hookName = Object.keys(instance._hooks).pop();
assert.equal(hookName, 'testplugin-autogenerated-foo-bar');
const el = fixture('basic').appendChild(document.createElement(hookName));
assert.isTrue(onAttachedSpy.calledWithExactly(el));
suite('placeholder', () => {
setup(()=>{
sandbox.stub(GrDomHook.prototype, '_createPlaceholder');
hookInternal = instance.getDomHook('foo-bar');
hook = hookInternal.getPublicAPI();
});
test('public hook API has only public methods', () => {
assert.deepEqual(Object.keys(hook), PUBLIC_METHODS);
});
test('registers placeholder class', () => {
assert.isTrue(hookInternal._createPlaceholder.calledWithExactly(
'testplugin-autogenerated-foo-bar'));
});
test('getModuleName()', () => {
const hookName = Object.keys(instance._hooks).pop();
assert.equal(hookName, 'testplugin-autogenerated-foo-bar');
assert.equal(hook.getModuleName(), 'testplugin-autogenerated-foo-bar');
});
});
suite('custom element', () => {
setup(() => {
hookInternal = instance.getDomHook('foo-bar', 'my-el');
hook = hookInternal.getPublicAPI();
});
test('public hook API has only public methods', () => {
assert.deepEqual(Object.keys(hook), PUBLIC_METHODS);
});
test('getModuleName()', () => {
const hookName = Object.keys(instance._hooks).pop();
assert.equal(hookName, 'foo-bar my-el');
assert.equal(hook.getModuleName(), 'my-el');
});
test('onAttached', () => {
const onAttachedSpy = sandbox.spy();
hook.onAttached(onAttachedSpy);
const [el1, el2] = [
document.createElement(hook.getModuleName()),
document.createElement(hook.getModuleName()),
];
hookInternal.handleInstanceAttached(el1);
hookInternal.handleInstanceAttached(el2);
assert.isTrue(onAttachedSpy.firstCall.calledWithExactly(el1));
assert.isTrue(onAttachedSpy.secondCall.calledWithExactly(el2));
});
test('getAllAttached', () => {
const [el1, el2] = [
document.createElement(hook.getModuleName()),
document.createElement(hook.getModuleName()),
];
el1.textContent = 'one';
el2.textContent = 'two';
hookInternal.handleInstanceAttached(el1);
hookInternal.handleInstanceAttached(el2);
assert.deepEqual([el1, el2], hook.getAllAttached());
hookI.handleInstanceDetached(el1);
assert.deepEqual([el2], hook.getAllAttached());
});
test('getLastAttached', () => {
const beforeAttachedPromise = hook.getLastAttached().then(
el => assert.strictEqual(el1, el));
const [el1, el2] = [
document.createElement(hook.getModuleName()),
document.createElement(hook.getModuleName()),
];
el1.textContent = 'one';
el2.textContent = 'two';
hookInternal.handleInstanceAttached(el1);
hookInternal.handleInstanceAttached(el2);
const afterAttachedPromise = hook.getLastAttached().then(
el => assert.strictEqual(el2, el));
return Promise.all([
beforeAttachedPromise,
afterAttachedPromise,
]);
});
});
});
</script>

View File

@@ -19,6 +19,17 @@
properties: {
name: String,
/** @type {!Map} */
_domHooks: {
type: Map,
value() { return new Map(); },
},
},
detached() {
for (const [el, domHook] of this._domHooks) {
domHook.handleInstanceDetached(el);
}
},
_import(url) {
@@ -31,33 +42,48 @@
const el = document.createElement(name);
el.plugin = plugin;
el.content = this.getContentChildren()[0];
return Polymer.dom(this.root).appendChild(el);
this._appendChild(el);
return el;
},
_initReplacement(name, plugin) {
this.getContentChildren().forEach(node => node.remove());
const el = document.createElement(name);
el.plugin = plugin;
return Polymer.dom(this.root).appendChild(el);
this._appendChild(el);
return el;
},
_appendChild(el) {
Polymer.dom(this.root).appendChild(el);
},
_initModule({moduleName, plugin, type, domHook}) {
let el;
switch (type) {
case 'decorate':
el = this._initDecoration(moduleName, plugin);
break;
case 'replace':
el = this._initReplacement(moduleName, plugin);
break;
}
if (el) {
domHook.handleInstanceAttached(el);
}
this._domHooks.set(el, domHook);
},
ready() {
Gerrit._endpoints.onNewEndpoint(this.name, this._initModule.bind(this));
Gerrit.awaitPluginsLoaded().then(() => Promise.all(
Gerrit._endpoints.getPlugins(this.name).map(
pluginUrl => this._import(pluginUrl)))
).then(() => {
const modulesData = Gerrit._endpoints.getDetails(this.name);
for (const {moduleName, plugin, type} of modulesData) {
switch (type) {
case 'decorate':
this._initDecoration(moduleName, plugin);
break;
case 'replace':
this._initReplacement(moduleName, plugin);
break;
}
}
});
).then(() =>
Gerrit._endpoints
.getDetails(this.name)
.forEach(this._initModule, this)
);
},
});
})();

View File

@@ -34,10 +34,20 @@ limitations under the License.
let sandbox;
let element;
let plugin;
let domHookStub;
setup(done => {
Gerrit._endpoints = new GrPluginEndpoints();
sandbox = sinon.sandbox.create();
domHookStub = {
handleInstanceAttached: sandbox.stub(),
handleInstanceDetached: sandbox.stub(),
};
sandbox.stub(
GrDomHooksManager.prototype, 'getDomHook').returns(domHookStub);
// NB: Order is important.
Gerrit.install(p => {
plugin = p;
@@ -45,11 +55,12 @@ limitations under the License.
plugin.registerCustomComponent('foo', 'other-module', {replace: true});
}, '0.1', 'http://some/plugin/url.html');
sandbox.stub(Gerrit, '_arePluginsLoaded').returns(true);
sandbox.stub(Gerrit, 'awaitPluginsLoaded').returns(Promise.resolve());
element = fixture('basic');
sandbox.stub(element, '_initDecoration');
sandbox.stub(element, '_initReplacement');
sandbox.stub(element, '_initDecoration').returns({});
sandbox.stub(element, '_initReplacement').returns({});
sandbox.stub(element, 'importHref', (url, resolve) => resolve());
flush(done);
@@ -65,13 +76,39 @@ limitations under the License.
});
test('inits decoration dom hook', () => {
assert.isTrue(
element._initDecoration.calledWith('some-module', plugin));
assert.strictEqual(
element._initDecoration.lastCall.args[0], 'some-module');
assert.strictEqual(
element._initDecoration.lastCall.args[1], plugin);
});
test('inits replacement dom hook', () => {
assert.isTrue(
element._initReplacement.calledWith('other-module', plugin));
assert.strictEqual(
element._initReplacement.lastCall.args[0], 'other-module');
assert.strictEqual(
element._initReplacement.lastCall.args[1], plugin);
});
test('calls dom hook handleInstanceAttached', () => {
assert.equal(domHookStub.handleInstanceAttached.callCount, 2);
});
test('calls dom hook handleInstanceDetached', () => {
element.detached();
assert.equal(domHookStub.handleInstanceDetached.callCount, 2);
});
test('installs modules on late registration', done => {
domHookStub.handleInstanceAttached.reset();
plugin.registerCustomComponent('foo', 'noob-noob');
flush(() => {
assert.equal(domHookStub.handleInstanceAttached.callCount, 1);
assert.strictEqual(
element._initDecoration.lastCall.args[0], 'noob-noob');
assert.strictEqual(
element._initDecoration.lastCall.args[1], plugin);
done();
});
});
});
</script>

View File

@@ -0,0 +1,28 @@
<!--
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.
-->
<link rel="import" href="../../../bower_components/polymer/polymer.html">
<link rel="import" href="../../shared/gr-overlay/gr-overlay.html">
<dom-module id="gr-plugin-popup">
<template>
<style include="shared-styles"></style>
<gr-overlay id="overlay" with-backdrop>
<content></content>
</gr-overlay>
</template>
<script src="gr-plugin-popup.js"></script>
</dom-module>

View File

@@ -0,0 +1,28 @@
// 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(window) {
'use strict';
Polymer({
is: 'gr-plugin-popup',
get opened() {
return this.$.overlay.opened;
},
open() {
return this.$.overlay.open();
},
close() {
this.$.overlay.close();
},
});
})(window);

View File

@@ -0,0 +1,67 @@
<!DOCTYPE html>
<!--
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.
-->
<meta name="viewport" content="width=device-width, minimum-scale=1.0, initial-scale=1.0, user-scalable=yes">
<title>gr-plugin-popup</title>
<script src="../../../bower_components/webcomponentsjs/webcomponents-lite.min.js"></script>
<script src="../../../bower_components/web-component-tester/browser.js"></script>
<link rel="import" href="../../../test/common-test-setup.html"/>
<link rel="import" href="gr-plugin-popup.html"/>
<script>void(0);</script>
<test-fixture id="basic">
<template>
<gr-plugin-popup></gr-plugin-popup>
</template>
</test-fixture>
<script>
suite('gr-plugin-popup tests', () => {
let element;
let sandbox;
setup(() => {
sandbox = sinon.sandbox.create();
element = fixture('basic');
stub('gr-overlay', {
open: sandbox.stub().returns(Promise.resolve()),
close: sandbox.stub(),
});
});
teardown(() => {
sandbox.restore();
});
test('exists', () => {
assert.isOk(element);
});
test('open uses open() from gr-overlay', () => {
return element.open().then(() => {
assert.isTrue(element.$.overlay.open.called);
});
});
test('close uses close() from gr-overlay', () => {
element.close();
assert.isTrue(element.$.overlay.close.called);
});
});
</script>

View File

@@ -0,0 +1,23 @@
<!--
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.
-->
<link rel="import" href="../../../bower_components/polymer/polymer.html">
<link rel="import" href="../../shared/gr-js-api-interface/gr-js-api-interface.html">
<link rel="import" href="gr-plugin-popup.html">
<dom-module id="gr-popup-interface">
<script src="gr-popup-interface.js"></script>
</dom-module>

View File

@@ -0,0 +1,71 @@
// 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(window) {
'use strict';
/**
* Plugin popup API.
* Provides method for opening and closing popups from plugin.
* opt_moduleName is a name of custom element that will be automatically
* inserted on popup opening.
* @param {!Object} plugin
* @param {opt_moduleName=} string
*/
function GrPopupInterface(plugin, opt_moduleName) {
this.plugin = plugin;
this._openingPromise = null;
this._popup = null;
this._moduleName = opt_moduleName || null;
}
GrPopupInterface.prototype._getElement = function() {
return Polymer.dom(this._popup);
};
/**
* Opens the popup, inserts it into DOM over current UI.
* Creates the popup if not previously created. Creates popup content element,
* if it was provided with constructor.
* @returns {!Promise<!Object>}
*/
GrPopupInterface.prototype.open = function() {
if (!this._openingPromise) {
this._openingPromise =
this.plugin.hook('plugin-overlay').getLastAttached()
.then(hookEl => {
const popup = document.createElement('gr-plugin-popup');
if (this._moduleName) {
const el = Polymer.dom(popup).appendChild(
document.createElement(this._moduleName));
el.plugin = this.plugin;
}
this._popup = Polymer.dom(hookEl).appendChild(popup);
Polymer.dom.flush();
return this._popup.open().then(() => this);
});
}
return this._openingPromise;
};
/**
* Hides the popup.
*/
GrPopupInterface.prototype.close = function() {
if (!this._popup) { return; }
this._popup.close();
this._openingPromise = null;
};
window.GrPopupInterface = GrPopupInterface;
})(window);

View File

@@ -0,0 +1,112 @@
<!DOCTYPE html>
<!--
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.
-->
<meta name="viewport" content="width=device-width, minimum-scale=1.0, initial-scale=1.0, user-scalable=yes">
<title>gr-popup-interface</title>
<script src="../../../bower_components/webcomponentsjs/webcomponents-lite.min.js"></script>
<script src="../../../bower_components/web-component-tester/browser.js"></script>
<link rel="import" href="../../../test/common-test-setup.html"/>
<link rel="import" href="gr-popup-interface.html"/>
<script>void(0);</script>
<test-fixture id="container">
<template>
<div></div>
</template>
</test-fixture>
<dom-module id="gr-user-test-popup">
<template>
<div id="barfoo">some test module</div>
</template>
<script>Polymer({is: 'gr-user-test-popup'});</script>
</dom-module>
<script>
suite('gr-popup-interface tests', () => {
let container;
let instance;
let plugin;
let sandbox;
setup(() => {
sandbox = sinon.sandbox.create();
Gerrit.install(p => { plugin = p; }, '0.1',
'http://test.com/plugins/testplugin/static/test.js');
container = fixture('container');
sandbox.stub(plugin, 'hook').returns({
getLastAttached() {
return Promise.resolve(container);
},
});
});
teardown(() => {
sandbox.restore();
});
suite('manual', () => {
setup(() => {
instance = new GrPopupInterface(plugin);
});
test('open', () => {
return instance.open().then(api => {
assert.strictEqual(api, instance);
const manual = document.createElement('div');
manual.id = 'foobar';
manual.innerHTML = 'manual content';
api._getElement().appendChild(manual);
flushAsynchronousOperations();
assert.equal(
container.querySelector('#foobar').textContent, 'manual content');
});
});
test('close', () => {
return instance.open().then(api => {
assert.isTrue(api._getElement().node.opened);
api.close();
assert.isFalse(api._getElement().node.opened);
});
});
});
suite('components', () => {
setup(() => {
instance = new GrPopupInterface(plugin, 'gr-user-test-popup');
});
test('open', () => {
return instance.open().then(api => {
assert.isNotNull(
Polymer.dom(container).querySelector('gr-user-test-popup'));
});
});
test('close', () => {
return instance.open().then(api => {
assert.isTrue(api._getElement().node.opened);
api.close();
assert.isFalse(api._getElement().node.opened);
});
});
});
});
</script>

View File

@@ -22,7 +22,7 @@
}
GrThemeApi.prototype.setHeaderLogoAndTitle = function(logoUrl, title) {
this.plugin.getDomHook('header-title', {replace: true}).onAttached(
this.plugin.hook('header-title', {replace: true}).onAttached(
element => {
const customHeader =
document.createElement('gr-custom-plugin-header');

View File

@@ -49,7 +49,7 @@
GrChangeReplyInterface.prototype.addReplyTextChangedCallback =
function(handler) {
this.plugin.getDomHook('reply-text').onAttached(el => {
this.plugin.hook('reply-text').onAttached(el => {
if (!el.content) { return; }
el.content.addEventListener('value-changed', e => {
handler(e.detail.value);

View File

@@ -19,6 +19,7 @@ limitations under the License.
<link rel="import" href="../../core/gr-reporting/gr-reporting.html">
<link rel="import" href="../../plugins/gr-attribute-helper/gr-attribute-helper.html">
<link rel="import" href="../../plugins/gr-dom-hooks/gr-dom-hooks.html">
<link rel="import" href="../../plugins/gr-popup-interface/gr-popup-interface.html">
<link rel="import" href="../../plugins/gr-theme-api/gr-theme-api.html">
<link rel="import" href="../../shared/gr-rest-api-interface/gr-rest-api-interface.html">
<link rel="import" href="../gr-rest-api-interface/gr-rest-api-interface.html">

View File

@@ -358,5 +358,35 @@ limitations under the License.
'http://test.com/r/plugins/testplugin/static/test.js');
});
});
suite('popup', () => {
test('popup(element) is deprecated', () => {
assert.throws(() => {
plugin.popup(document.createElement('div'));
});
});
test('popup(moduleName) creates popup with component', () => {
const openStub = sandbox.stub();
sandbox.stub(window, 'GrPopupInterface').returns({
open: openStub,
});
plugin.popup('some-name');
assert.isTrue(openStub.calledOnce);
assert.isTrue(GrPopupInterface.calledWith(plugin, 'some-name'));
});
test('deprecated.popup(element) creates popup with element', () => {
const el = document.createElement('div');
el.textContent = 'some text here';
const openStub = sandbox.stub(GrPopupInterface.prototype, 'open');
openStub.returns(Promise.resolve({
_getElement() {
return document.createElement('div');
}}));
plugin.deprecated.popup(el);
assert.isTrue(openStub.calledOnce);
});
});
});
</script>

View File

@@ -16,19 +16,32 @@
function GrPluginEndpoints() {
this._endpoints = {};
this._callbacks = {};
}
GrPluginEndpoints.prototype.onNewEndpoint = function(endpoint, callback) {
if (!this._callbacks[endpoint]) {
this._callbacks[endpoint] = [];
}
this._callbacks[endpoint].push(callback);
};
GrPluginEndpoints.prototype.registerModule = function(plugin, endpoint, type,
moduleName) {
moduleName, domHook) {
if (!this._endpoints[endpoint]) {
this._endpoints[endpoint] = [];
}
this._endpoints[endpoint].push({
const moduleInfo = {
moduleName,
plugin,
pluginUrl: plugin._url,
type,
});
domHook,
};
this._endpoints[endpoint].push(moduleInfo);
if (Gerrit._arePluginsLoaded() && this._callbacks[endpoint]) {
this._callbacks[endpoint].forEach(callback => callback(moduleInfo));
}
};
/**
@@ -44,6 +57,7 @@
* plugin: Plugin,
* pluginUrl: String,
* type: EndpointType,
* domHook: !Object
* }>}
*/
GrPluginEndpoints.prototype.getDetails = function(name, opt_options) {

View File

@@ -29,16 +29,21 @@ limitations under the License.
let instance;
let pluginFoo;
let pluginBar;
let domHook;
setup(() => {
sandbox = sinon.sandbox.create();
domHook = {};
instance = new GrPluginEndpoints();
Gerrit.install(p => { pluginFoo = p; }, '0.1',
'http://test.com/plugins/testplugin/static/foo.html');
instance.registerModule(pluginFoo, 'a-place', 'decorate', 'foo-module');
instance.registerModule(
pluginFoo, 'a-place', 'decorate', 'foo-module', domHook);
Gerrit.install(p => { pluginBar = p; }, '0.1',
'http://test.com/plugins/testplugin/static/bar.html');
instance.registerModule(pluginBar, 'a-place', 'style', 'bar-module');
instance.registerModule(
pluginBar, 'a-place', 'style', 'bar-module', domHook);
sandbox.stub(Gerrit, '_arePluginsLoaded').returns(true);
});
teardown(() => {
@@ -52,12 +57,14 @@ limitations under the License.
plugin: pluginFoo,
pluginUrl: pluginFoo._url,
type: 'decorate',
domHook,
},
{
moduleName: 'bar-module',
plugin: pluginBar,
pluginUrl: pluginBar._url,
type: 'style',
domHook,
},
]);
});
@@ -69,6 +76,7 @@ limitations under the License.
plugin: pluginBar,
pluginUrl: pluginBar._url,
type: 'style',
domHook,
},
]);
});
@@ -82,6 +90,7 @@ limitations under the License.
plugin: pluginFoo,
pluginUrl: pluginFoo._url,
type: 'decorate',
domHook,
},
]);
});
@@ -95,5 +104,19 @@ limitations under the License.
assert.deepEqual(
instance.getPlugins('a-place'), [pluginFoo._url, pluginBar._url]);
});
test('onNewEndpoint', () => {
const newModuleStub = sandbox.stub();
instance.onNewEndpoint('a-place', newModuleStub);
instance.registerModule(
pluginFoo, 'a-place', 'replace', 'zaz-module', domHook);
assert.deepEqual(newModuleStub.lastCall.args[0], {
moduleName: 'zaz-module',
plugin: pluginFoo,
pluginUrl: pluginFoo._url,
type: 'replace',
domHook,
});
});
});
</script>

View File

@@ -55,8 +55,7 @@
window.$wnd = window;
function Plugin(opt_url) {
this._generatedHookNames = [];
this._domHooks = new GrDomHooks(this);
this._domHooks = new GrDomHooksManager(this);
if (!opt_url) {
console.warn('Plugin not being loaded from /plugins base path.',
@@ -77,6 +76,10 @@
return;
}
this._name = pathname.split('/')[2];
this.deprecated = {
popup: deprecatedAPI.popup.bind(this),
};
}
Plugin._sharedAPIElement = document.createElement('gr-js-api-interface');
@@ -93,11 +96,22 @@
};
Plugin.prototype.registerCustomComponent = function(
endpointName, moduleName, opt_options) {
endpointName, opt_moduleName, opt_options) {
const type = opt_options && opt_options.replace ?
EndpointType.REPLACE : EndpointType.DECORATE;
const hook = this._domHooks.getDomHook(endpointName, opt_moduleName);
const moduleName = opt_moduleName || hook.getModuleName();
Gerrit._endpoints.registerModule(
this, endpointName, type, moduleName);
this, endpointName, type, moduleName, hook);
return hook.getPublicAPI();
};
/**
* Returns instance of DOM hook API for endpoint. Creates a placeholder
* element for the first call.
*/
Plugin.prototype.hook = function(endpointName, opt_options) {
return this.registerCustomComponent(endpointName, undefined, opt_options);
};
Plugin.prototype.getServerInfo = function() {
@@ -184,12 +198,22 @@
return new GrAttributeHelper(element);
};
Plugin.prototype.getDomHook = function(endpointName, opt_options) {
const hook = this._domHooks.getDomHook(endpointName);
const moduleName = hook.getModuleName();
const type = opt_options && opt_options.type || EndpointType.DECORATE;
Gerrit._endpoints.registerModule(this, endpointName, type, moduleName);
return hook;
Plugin.prototype.popup = function(moduleName) {
if (typeof moduleName !== 'string') {
throw new Error('deprecated, use deprecated.popup');
}
const api = new GrPopupInterface(this, moduleName);
return api.open();
};
const deprecatedAPI = {};
deprecatedAPI.popup = function(el) {
console.warn('plugin.deprecated.popup() is deprecated!');
if (!el) {
throw new Error('Popup contents not found');
}
const api = new GrPopupInterface(this);
api.open().then(api => api._getElement().appendChild(el));
};
const Gerrit = window.Gerrit || {};