Add hook for mapr or other app to extend webclient main page #425

will-moore · 2022-12-09T11:58:51Z

As noted in #423 (comment)
changes to the webclient templates/webclient/data/includes/mapr_extension.html file are completely overwritten by mapr, so any changes to that file must previously be duplicated in the corresponding file in omero-mapr.
Mapr needed to overwrite update_metadata_general_tab() to provide custom URL loading when custom items are selected.

This PR provides a function OME.getCustomRightPanelUrl() which can be overwritten, instead of replacing the whole of update_metadata_general_tab().

This change is used by mapr in https://github.com/ome/omero-mapr/pull/74/files

To test:

with mapr installed (no config needed) with the branch above, the right panel should work as before (including the creation of custom right-panel links) E.g. https://merge-ci.openmicroscopy.org/web/webclient/?show=image-18188
Right panel should show the fading-in loading spinner (previously overwritten by mapr)

sbesson · 2022-12-12T11:17:31Z

omeroweb/webclient/templates/webclient/base/base_container.html

-
-
+    <!-- allow omero-mapr OR another app to include custom code -->
+    {% include "webclient/data/includes/mapr_extension.html" %}


In general 👍 for adding extension points rather than having apps fully overwriting the templates (which quickly turns into a maintenance hell)

I am a bit concerned about the introduction of an extension point explicitly named after a specific app though as introducing this type of circular dependency will eventually cause issues. Is it not possible to override the templates using extends and block as defined in https://docs.djangoproject.com/en/3.2/howto/overriding-templates/#extending-an-overridden-template?

mapr is not extending an existing template to create it's own page (which is what those docs refer to).
It is "hijacking" the template that is included in the "host" webclient page, so change the "host" app behaviour.

When Django looks up a template, e.g. to {% include "webclient/data/includes/right_plugin.general.js.html" %} in the main webclient page, it goes through all the apps in it's installed apps list until it finds a match.

We deliberately install the omero-web apps after any user-installed apps (

omero-web/omeroweb/settings.py

Line 1542 in 93f89ed

INSTALLED_APPS += (

) to allow user-installed apps to overwrite a template. mapr has a template at the matching path: webclient/data/includes/right_plugin.general.js.html so this is chosen instead of the webclient one.

I don't think that Django provides a mechanism for this kind of behaviour.

However, we could add a mechanism in webclient to allow other apps to inject their code with a configuration (similar to the addition of code for centre / right panels in webclient).
This would just mean that we need to add an additional setting for mapr when installing, but I guess this is easy enough.

joshmoore · 2022-12-12T16:07:45Z

omeroweb/webclient/templates/webclient/data/includes/mapr_extension.html

+
+<!-- 
+This is a hook for use by omero-mapr OR another omero-web app to add custom
+code to the <head> of the webclient main page.


would head_extension.html be a reasonable name then?

@joshmoore @sbesson Was the naming of mapr_extension.html main problem with this PR in it's original form, or was it the fact that this extension point could only be used by 1 app at a time?

If it's only the naming that's the issue, I'm happy to re-name that extension point (e.g. to head_extension.html) and we could avoid the config that's needed to allow multiple apps to extend (which @sbesson is concerned about the config at ome/omero-mapr#74 (comment)).

Do we need to chat about this to discuss the various options?

I don't think the naming is the main problem as much as having a good name helps us to understand what the costs/benefits of this strategy actually are. Happy to jump on a call next week Monday or Tuesday if you're still around.

Same here, available till Tuesday EOB if you want to schedule a call.

I'm away next week I'm afraid.
The name mapr_extension.html was meant to warn that this is being used by mapr, so you should only use it if you don't have mapr installed (which is explained in the mapr_extension.html file itself).

for more information, see https://pre-commit.ci

will-moore · 2022-12-12T17:55:22Z

Used a config approach - Description above and at ome/omero-mapr#74 updated.
Also, config added to merge-ci OMERO.web job (under mapr install).

snoopycrimecop · 2022-12-14T09:55:17Z

Conflicting PR. Removed from build OMERO-python-superbuild-push#1286. See the console output for more details.
Possible conflicts:

PR Query string ids #225 will-moore 'Query string ids'
- omeroweb/webclient/templates/webclient/data/includes/right_plugin.general.js.html
PR Right panel spinner #423 will-moore 'Right panel spinner'
- omeroweb/webclient/templates/webclient/data/includes/right_plugin.general.js.html

~~--conflicts~~ Conflict resolved in build OMERO-python-superbuild-push#1287. See the console output for more details.

will-moore · 2022-12-21T23:21:16Z

One other option that could allow a single template to be included from each app without configuration:

For each app in INSTALLED_APPS, look for e.g. /app/templates/app/includes/webclient_head.html and if found, then include it in the webclient main page.

will-moore · 2023-01-04T17:13:45Z

That option is now implemented in the last 2 commits above.

will-moore · 2023-01-05T09:34:41Z

I updated the description above to match the current behaviour. cc @sbesson

sbesson · 2023-01-05T16:08:09Z

omeroweb/webclient/templates/webclient/data/includes/mapr_extension.html

+code to the <head> of the webclient main page.
+
+Simply add a file with the same path under the app/templates directory:
+/app/templates/webclient/data/includes/mapr_extension.html


Is this still correct with the latest version of this PR? This is what this file and the description suggest but from the util.py changes, I would expect the file should be called webclient_head ?

Apologies, I forgot to delete that file. It's not needed any more.

sbesson · 2023-01-05T16:11:48Z

omeroweb/webgateway/util.py

+    """For each installed app, try to load AppConfig and return label"""
+
+    labels = []
+    for app in settings.INSTALLED_APPS:


Out of curiosity, what is the contract for the order in which these apps are resolved? Alphabetical order? Order in the configuration?

And assuming several apps would try to overwrite the same variable, would the last app win?

Apps are ordered as in the omero.web.apps config, but order is not important as app labels are unique.

jburel · 2023-01-17T12:07:38Z

Excluding ahead of dependencies upgrade work

EDIT: (Will): removing exclude flag - 21st March 2023

for more information, see https://pre-commit.ci

knabar · 2023-04-28T11:12:39Z

I might not have fully wrapped my head around all changes, but I'm not yet convinced we need an additional way to include custom plugin files, versus just utilizing the Django template inheritance mechanism.

For example, if right_plugin.general.js.html introduced a block in the new function, even multiple plugins could override/extend it:

// This can be overwritten by plugins to provide custom URL for right panel
// NB: The returned html should have an element <div id="object-id">oid</div>
// where the oid matches the oid from this function
{% block custom-right-panel-url %}
OME.getCustomRightPanelUrl = function getCustomRightPanelUrl(oid) {
    return;
}
{% endblock %}

A plugin (or multiple plugins) would have its own right_plugin.general.js.html:

{% extends "right_plugin.general.js.html" %}
{% block custom-right-panel-url %}
{{ block.super }}
(function () {
  var old = OME.getCustomRightPanelUrl;
  OME.getCustomRightPanelUrl = function getCustomRightPanelUrl(oid) {
      return old(oid) || some_new_value;
  }
})();
{% endblock %}

Similarly other template blocks in right_plugin.general.js.html could be added at the top level or at crucial points in the logic.

Again, there may be a limitation here that I'm not seeing, but right now a whole new way to include plugin functionality seems overkill to me.

will-moore · 2023-05-02T12:09:45Z

@knabar Thanks - yes you are right that I don't need all that complexity!
I didn't realise that it was possible for a template to extend itself:

"This technique works because the template loader does not consider the already loaded override template (at templates/admin/base_site.html) when resolving the extends tag."
https://docs.djangoproject.com/en/3.2/howto/overriding-templates/#extending-an-overridden-template

pwalczysko · 2023-05-29T14:29:19Z

tested on merge-ci, I can see both the fading-in spinner and a correct Mapr behaviour, with the custom external and internal links working.

lgtm

will-moore

Just confirmed the expected behaviour of this PR on merge-ci without mapr change (excluded ome/omero-mapr#74 (comment)).
Mapr works as expected but with the existing behaviour of overwriting the right panel (no loading spinner etc).

Add hook for mapr or other app to extend webclient main page

56a84af

This was referenced Dec 9, 2022

mapr extension of webclient ome/omero-mapr#74

Open

Right panel spinner #423

Merged

sbesson reviewed Dec 12, 2022

View reviewed changes

joshmoore reviewed Dec 12, 2022

View reviewed changes

will-moore and others added 2 commits December 12, 2022 17:44

Add configurable omero.web.html_head_includes

c93b537

[pre-commit.ci] auto fixes from pre-commit.com hooks

1723d3a

for more information, see https://pre-commit.ci

Add OME.getCustomRightPanelUrl() which can be overwritten by plugins

ce6a9a4

will-moore modified the milestone: 5.17.0 Dec 15, 2022

Merge remote-tracking branch 'origin/master' into mapr_extension_hook

5166612

will-moore force-pushed the mapr_extension_hook branch from 50858ec to 5166612 Compare December 16, 2022 10:39

will-moore added 2 commits January 4, 2023 15:06

Load app_label/includes/webclient_head.html for each app

809f0a3

Fix bare except

0286b73

sbesson reviewed Jan 5, 2023

View reviewed changes

Delete mapr_extension.html

fed3c7e

will-moore and others added 6 commits March 21, 2023 12:46

Merge remote-tracking branch 'origin/master' into mapr_extension_hook

33a1bbf

Add hook for app/includes/right_panel.html

b43f903

[pre-commit.ci] auto fixes from pre-commit.com hooks

01f9625

for more information, see https://pre-commit.ci

Right panel loads html from app/includes/ right_panel_title()

87c7e14

[pre-commit.ci] auto fixes from pre-commit.com hooks

083fb9b

for more information, see https://pre-commit.ci

flake8 fix

9a686e7

Revert custom extension hooks

56cef3a

will-moore added 2 commits May 1, 2023 07:50

Revert whitespace change

0412b6d

Move block right_panel_title to another PR

02cd825

knabar added this to the 5.21.0 milestone May 12, 2023

pwalczysko approved these changes May 29, 2023

View reviewed changes

will-moore commented May 31, 2023

View reviewed changes

knabar merged commit c0d5de5 into ome:master May 31, 2023

sbesson mentioned this pull request Nov 10, 2023

OMERO.web UI customization support #510

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add hook for mapr or other app to extend webclient main page #425

Add hook for mapr or other app to extend webclient main page #425

will-moore commented Dec 9, 2022 •

edited

Loading

sbesson Dec 12, 2022

will-moore Dec 12, 2022

joshmoore Dec 12, 2022

will-moore Dec 16, 2022

joshmoore Dec 16, 2022

sbesson Dec 16, 2022

will-moore Dec 16, 2022

will-moore commented Dec 12, 2022

snoopycrimecop commented Dec 14, 2022 •

edited

Loading

will-moore commented Dec 21, 2022 •

edited

Loading

will-moore commented Jan 4, 2023

will-moore commented Jan 5, 2023

sbesson Jan 5, 2023

will-moore Jan 5, 2023

sbesson Jan 5, 2023

will-moore Jan 5, 2023

jburel commented Jan 17, 2023 •

edited by will-moore

Loading

knabar commented Apr 28, 2023

will-moore commented May 2, 2023

pwalczysko commented May 29, 2023

will-moore left a comment



		<!-- allow omero-mapr OR another app to include custom code -->
		{% include "webclient/data/includes/mapr_extension.html" %}

Add hook for mapr or other app to extend webclient main page #425

Add hook for mapr or other app to extend webclient main page #425

Conversation

will-moore commented Dec 9, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

will-moore commented Dec 12, 2022

snoopycrimecop commented Dec 14, 2022 • edited Loading

will-moore commented Dec 21, 2022 • edited Loading

will-moore commented Jan 4, 2023

will-moore commented Jan 5, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jburel commented Jan 17, 2023 • edited by will-moore Loading

knabar commented Apr 28, 2023

will-moore commented May 2, 2023

pwalczysko commented May 29, 2023

will-moore left a comment

Choose a reason for hiding this comment

will-moore commented Dec 9, 2022 •

edited

Loading

snoopycrimecop commented Dec 14, 2022 •

edited

Loading

will-moore commented Dec 21, 2022 •

edited

Loading

jburel commented Jan 17, 2023 •

edited by will-moore

Loading