Commons extension disappears for some users when upgrading to OpenRefine 3.7.8

[trnstlntk]

Some users have told me that the Commons extension disappears for them when upgrading from OpenRefine 3..7.8 to 3.7.9. Uninstalling and reinstalling the extension doesn't fix the issue.

I can't reproduce this myself - in my case the upgrade went well and the Commons extension is still functional. Chrome on a Mac.

[loraxian]

Just confirming that this happened to me - Firefox on Mac. Installing 3.7.9 broke the interface until I uninstalled the Commons extension, and unfortunately reinstalling it breaks it again.

[wetneb]

Just making sure this is on @lokal-profil @sebastian-berlin-wmse's radar, as it sounds like a rather important issue.
@loraxian if you could share a screenshot of how it breaks the interface, it could be useful. For instance to determine if it is the same problem as OpenRefine/OpenRefine#99.

[loraxian]

Not just the same problem but the same user ;) I'm Loraxian here but DrThneed most other places, so that screenshot was mine. Attached again for convenience.

[wetneb]

Right, so it's the same problem indeed! Thanks for confirming. I think this particular bug (#99) is present in all versions and likely only depends on the data in the table. It's worth fixing in any case.

[sebastian-berlin-wmse]

I can reproduce this with both 3.7.8 and 3.7.9. There is no "Wikimedia Commons" in the menu for "Create project". It works with 3.7.7. All using the latest version of the Commons extension.

I can't tell if there's any significant difference in the output. Here is for 3.7.7, which works:

openrefine-3.7.7$ ./refine -p 3337 -v debug
Using refine.ini for configuration
-------------------------------------------------------------------------------------------------
You have 7828M of free memory.
Your current configuration is set to use 1400M of memory.
OpenRefine can run better when given more memory. Read our FAQ on how to allocate more memory here:
https://openrefine.org/docs/manual/installing#increasing-memory-allocation
-------------------------------------------------------------------------------------------------

09:58:13.713 [            refine_server] Starting Server bound to '127.0.0.1:3337' (0ms)
09:58:13.731 [            refine_server] refine.memory size: 1400M JVM Max heap: 1468006400 (18ms)
09:58:13.813 [            refine_server] Initializing context: '/' from '/home/sebastian/install/openrefine-3.7.7/webapp' (82ms)
Gtk-Message: 09:58:14.942: Failed to load module "canberra-gtk-module"
09:58:17.025 [                   refine] Starting OpenRefine 3.7.7 [7b36017]... (3212ms)
09:58:17.026 [                   refine] initializing FileProjectManager with dir (1ms)
09:58:17.026 [                   refine] /home/sebastian/.local/share/openrefine (0ms)
09:58:19.028 [                 velocity] ResourceManager : unable to find resource 'macros.vm' in any resource loader. (2002ms)
09:58:19.029 [                 velocity] Velocimacro : Velocimacro : Error using VM library : macros.vm (1ms)
09:58:41.417 [                   refine] POST /command/core/load-language (22388ms)
09:58:41.731 [                   refine] GET /command/core/get-preference (314ms)
09:58:42.004 [                   refine] POST /command/core/load-language (273ms)
09:58:42.199 [                   refine] POST /command/core/load-language (195ms)
09:58:42.428 [                   refine] POST /command/core/load-language (229ms)
09:58:42.542 [                   refine] POST /command/core/load-language (114ms)
09:58:44.032 [                   refine] GET /command/core/get-importing-configuration (1490ms)
09:58:44.646 [                   refine] GET /command/database/saved-connection (614ms)
09:58:45.161 [                   refine] GET /command/core/get-all-project-tags (515ms)
09:58:45.473 [                   refine] GET /command/core/get-all-project-metadata (312ms)
09:58:45.809 [                   refine] GET /command/core/get-csrf-token (336ms)
09:58:46.092 [                   refine] GET /command/core/get-languages (283ms)
09:58:46.735 [                   refine] GET /command/core/get-version (643ms)

...and for 3.7.8 which doesn't:

openrefine-3.7.8$ ./refine -p 3338 -v debug
Using refine.ini for configuration
-------------------------------------------------------------------------------------------------
You have 7828M of free memory.
Your current configuration is set to use 1400M of memory.
OpenRefine can run better when given more memory. Read our FAQ on how to allocate more memory here:
https://openrefine.org/docs/manual/installing#increasing-memory-allocation
-------------------------------------------------------------------------------------------------

09:58:24.189 [            refine_server] Starting Server bound to '127.0.0.1:3338' (0ms)
09:58:24.251 [            refine_server] refine.memory size: 1400M JVM Max heap: 1468006400 (62ms)
09:58:24.373 [            refine_server] Initializing context: '/' from '/home/sebastian/install/openrefine-3.7.8/webapp' (122ms)
Gtk-Message: 09:58:27.039: Failed to load module "canberra-gtk-module"
09:58:30.601 [                   refine] Starting OpenRefine 3.7.8 [58e1cb4]... (6228ms)
09:58:30.603 [                   refine] initializing FileProjectManager with dir (2ms)
09:58:30.604 [                   refine] /home/sebastian/.local/share/openrefine (1ms)
09:58:53.131 [                   refine] POST /command/core/load-language (22527ms)
09:58:53.211 [                   refine] GET /command/core/get-preference (80ms)
09:58:53.269 [                   refine] POST /command/core/load-language (58ms)
09:58:53.309 [                   refine] POST /command/core/load-language (40ms)
09:58:53.345 [                   refine] POST /command/core/load-language (36ms)
09:58:54.341 [                   refine] GET /command/core/get-importing-configuration (996ms)
09:58:54.392 [                   refine] GET /command/core/get-all-project-tags (51ms)
09:58:54.650 [                   refine] GET /command/database/saved-connection (258ms)
09:58:54.728 [                   refine] GET /command/core/get-all-project-metadata (78ms)
09:58:54.957 [                   refine] GET /command/core/get-csrf-token (229ms)
09:58:55.063 [                   refine] GET /command/core/get-languages (106ms)
09:58:55.246 [                   refine] GET /command/core/get-version (183ms)

This is on Linux (Ubuntu 22.04.1) and Firefox (123.0.1).

[tfmorris]

From #120

It seems that adding an empty macros.vm in the module folder of the extension would solve it.

You can also remove this line:

templating.macros = macros.vm

from commons-extension/MOD-INF/module.properties

Velocity is, probably rightfully, complaining about a file that it was told to use being missing. It looks like perhaps the handling of this case changed between Velocity 1.5 and 2.3 1.6.3.

[tfmorris]

p.s. I was unable to reproduce the problem with OpenRefine 3.7.8 or 3.7.9, but can reproduce it with 3.8.

[vivian-rook]

Will there be a point release to include this change? I'm still seeing 0.1.1 as the latest tag.

[wetneb]

Yes, @sebastian-berlin-wmse is on it, but he was unavailable last week and on holiday this week.

[sebastian-berlin-wmse]

Version 0.1.2 of CommonsExtension is now released: https://github.com/OpenRefine/CommonsExtension/releases/tag/v0.1.2.