Breaking Changes to Frontend Plugin API

158 views
Skip to first unread message

Ben Rohlfs

unread,
Mar 9, 2021, 3:50:47 PMMar 9
to Repo and Gerrit Discussion
tl;dr 23 API methods are scheduled for deletion and plugins must migrate to Polymer 3 for the 3.4 release in May

Hi plugin developers,

We are currently in the middle of a spring cleaning effort with the Gerrit Frontend team, so we are tackling TODOs, leftovers, migrations and are generally getting rid of tech debt.

As part of this effort we also want to clean up the Frontend Plugin API, which has grown over time to expose 77(!) methods [1]. We have thoroughly analyzed all 22 active frontend plugins [3] that are hosted on gerrit-review and found out that 23 of 77 API methods are unused, so we are planning to delete them before the 3.4 release in May. If you are a maintainer of a plugin, then please check this list [1], and let us know if you would like us to keep some of those methods around.

Furthermore we would like to stop supporting Polymer 2 plugins with the 3.4 release and have prepared a change [2] for that on the master branch. Migrating a plugin from Polymer 2 to 3 means that you just have to stop using HTML imports. According to this list [3] there are 7 plugins on gerrit-review that require action:

imagare
lfs
messageoftheday
serviceuser
task
verify-status
zuul-status

We recommend using the build rules polygerrit_plugin and rollup_bundle. 9 examples that you can copy from are mentioned in [3], and for 4 of them I am providing a link here for your convenience [4-7]. We strongly recommend using the Dev Helper extension for developing and testing your plugins against your regular Gerrit deployment. Please let us know when you run into problems. We are happy to help.

We would appreciate comments being added to [3], if you are planning to do the migration for one of the plugins, or if you can provide helpful background.

Thanks for your cooperation! With frontend plugins getting in good shape we are also happy to invest into updating the outdated documentation. :-)

-Ben





Luca Milanesio

unread,
Mar 9, 2021, 4:39:42 PMMar 9
to Repo and Gerrit Discussion, Luca Milanesio, gerritcodereview-maintainers

On 9 Mar 2021, at 20:50, 'Ben Rohlfs' via gerritcodereview-maintainers <gerritcoderevi...@googlegroups.com> wrote:

tl;dr 23 API methods are scheduled for deletion and plugins must migrate to Polymer 3 for the 3.4 release in May

Hi plugin developers,

We are currently in the middle of a spring cleaning effort with the Gerrit Frontend team, so we are tackling TODOs, leftovers, migrations and are generally getting rid of tech debt.

As part of this effort we also want to clean up the Frontend Plugin API, which has grown over time to expose 77(!) methods [1]. We have thoroughly analyzed all 22 active frontend plugins [3] that are hosted on gerrit-review and found out that 23 of 77 API methods are unused, so we are planning to delete them before the 3.4 release in May. If you are a maintainer of a plugin, then please check this list [1], and let us know if you would like us to keep some of those methods around.

Thanks, Ben, for sharing this beforehand :-)
Are you also planning a “spring cleanup” of some backend API that would be left unused?

Luca.


Furthermore we would like to stop supporting Polymer 2 plugins with the 3.4 release and have prepared a change [2] for that on the master branch. Migrating a plugin from Polymer 2 to 3 means that you just have to stop using HTML imports. According to this list [3] there are 7 plugins on gerrit-review that require action:

imagare
lfs
messageoftheday
serviceuser
task
verify-status
zuul-status

We recommend using the build rules polygerrit_plugin and rollup_bundle. 9 examples that you can copy from are mentioned in [3], and for 4 of them I am providing a link here for your convenience [4-7]. We strongly recommend using the Dev Helper extension for developing and testing your plugins against your regular Gerrit deployment. Please let us know when you run into problems. We are happy to help.

We would appreciate comments being added to [3], if you are planning to do the migration for one of the plugins, or if you can provide helpful background.

Thanks for your cooperation! With frontend plugins getting in good shape we are also happy to invest into updating the outdated documentation. :-)

-Ben






--

---
You received this message because you are subscribed to the Google Groups "gerritcodereview-maintainers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to gerritcodereview-mai...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/gerritcodereview-maintainers/CAEWS%2BaOL2g%2B6obH%3D0GtX8yTJ7U-WYcbK_UkTMSfmdST63kjp8w%40mail.gmail.com.

Nasser Grainawi

unread,
Mar 9, 2021, 4:55:37 PMMar 9
to gerritcodereview-maintainers, Repo and Gerrit Discussion
On Mar 9, 2021, at 1:50 PM, 'Ben Rohlfs' via gerritcodereview-maintainers <gerritcoderevi...@googlegroups.com> wrote:

tl;dr 23 API methods are scheduled for deletion and plugins must migrate to Polymer 3 for the 3.4 release in May

Hi plugin developers,

We are currently in the middle of a spring cleaning effort with the Gerrit Frontend team, so we are tackling TODOs, leftovers, migrations and are generally getting rid of tech debt.

As part of this effort we also want to clean up the Frontend Plugin API, which has grown over time to expose 77(!) methods [1]. We have thoroughly analyzed all 22 active frontend plugins [3] that are hosted on gerrit-review and found out that 23 of 77 API methods are unused, so we are planning to delete them before the 3.4 release in May. If you are a maintainer of a plugin, then please check this list [1], and let us know if you would like us to keep some of those methods around.

Furthermore we would like to stop supporting Polymer 2 plugins with the 3.4 release and have prepared a change [2] for that on the master branch. Migrating a plugin from Polymer 2 to 3 means that you just have to stop using HTML imports. According to this list [3] there are 7 plugins on gerrit-review that require action:

imagare
lfs
messageoftheday
serviceuser
task
verify-status
zuul-status

We recommend using the build rules polygerrit_plugin and rollup_bundle. 9 examples that you can copy from are mentioned in [3], and for 4 of them I am providing a link here for your convenience [4-7]. We strongly recommend using the Dev Helper extension for developing and testing your plugins against your regular Gerrit deployment. Please let us know when you run into problems. We are happy to help.

We would appreciate comments being added to [3], if you are planning to do the migration for one of the plugins, or if you can provide helpful background.

Thanks Ben for the info. I’ll be looking at updating task. Do you have what you’d consider a good example change that does a Polymer 2->3 update for one of those 9 plugins that have already been converted?

Ben Rohlfs

unread,
Mar 10, 2021, 3:01:33 AMMar 10
to Nasser Grainawi, gerritcodereview-maintainers, Repo and Gerrit Discussion, דוד אוסטרובסקי‎

Nasser Grainawi

unread,
Mar 10, 2021, 11:17:15 AMMar 10
to Ben Rohlfs, gerritcodereview-maintainers, Repo and Gerrit Discussion, דוד אוסטרובסקי‎
On Mar 10, 2021, at 1:01 AM, Ben Rohlfs <bro...@google.com> wrote:

Hi Nasser,

maybe start with looking at these changes. Kudos to David!

Perfect, thanks!
Reply all
Reply to author
Forward
0 new messages