[Intellij plugin] Prompt user to update plugin when installed version is lower than minVersion #410

crogoz · 2024-09-11T15:01:54Z

Before this PR

Users would only get a notification in Intellij when the minVersion specified in externalDependencies.xml file is lower than the installed plugin version.

After this PR

For the palantir-gradle-jdks plugin only, we will check first (before running the gradle jdks setup) if the plugin meets the required minimum version. If not, then it will show a notification and it will show the Settings > Plugins window
Note: the check will run when sync'ing the gradle projects or when running gradle tasks (similar to the gradle jdk setup).

Screen.Recording.2024-09-12.at.12.56.19.PM.mov

Notes:
intellij provides a plugin checker: https://github.com/JetBrains/intellij-community/blob/master/platform/platform-impl/src/com/intellij/externalDependencies/impl/CheckRequiredPluginsActivity.java but it doesn't seem to have the option to update plugins (it just prints the error message).

==COMMIT_MSG==
[Intellij plugin] Prompt user to update plugin when installed version is lower than minVersion
==COMMIT_MSG==

Possible downsides?

changelog-app · 2024-09-11T15:01:59Z

Generate changelog in `changelog/@unreleased`

What do the change types mean?

feature: A new feature of the service.
improvement: An incremental improvement in the functionality or operation of the service.
fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
and external consumers of the service's API (e.g. customer-written software or integrations).
deprecation: Advertises the intention to remove service functionality without any change to the
operation of the service itself.
manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
performing database surgery, ...) at the time of upgrade for it to succeed.
migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?

❗The break and manual task changelog types will result in a major release!
🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
✨ All others will result in a minor version release.

Type

Description

[Intellij plugin] Prompt user to update plugin when installed version is lower than minVersion

Check the box to generate changelog(s)

Generate changelog entry

…o cr/show-plugins

crogoz · 2024-09-12T11:48:38Z

idea-plugin/src/main/java/com/palantir/gradle/jdks/PluginUpdateCheckerService.java

+                                    maybeMinVersion.get()),
+                            NotificationType.ERROR);
+            notification.notify(project);
+            PluginsAdvertiser.installAndEnablePlugins(Set.of(PLUGIN_ID), notification::expire);


unfortunately I couldn't test this properly when running ./gradlew runIde since the new Intellij instance has already the latest versions of all the plugins installed. I do expect to see a similar window to (see below the "Update" button) if there is a newer version of the plugin available.

crogoz · 2024-09-12T11:54:31Z

idea-plugin/src/main/resources/META-INF/plugin.xml

@@ -1,4 +1,4 @@
-<idea-plugin url="https://github.com/palantir/gradle-jdks">
+<idea-plugin url="https://github.com/palantir/gradle-jdks" require-restart="false">


following: https://plugins.jetbrains.com/docs/intellij/dynamic-plugins.html

Ran: Plugin DevKit | Plugin descriptor | Plugin.xml dynamic plugin verification from https://plugins.jetbrains.com/docs/intellij/dynamic-plugins.html#restrictions

CRogers · 2024-09-12T11:56:56Z

idea-plugin/src/main/java/com/palantir/gradle/jdks/PluginUpdateCheckerService.java

+                                    "Please update the plugin in the Settings window to a version higher than '%s'",
+                                    maybeMinVersion.get()),
+                            NotificationType.ERROR);
+            notification.notify(project);


From the video it looks like if you click the notification it takes you to the update page. But I don't think that's super obvious it's going to do that. Can we add a link or button like the install extra plugins button?

From the video it looks like if you click the notification it takes you to the update page.

It opens up both the notification and the window to install the plugins. In the video I was just trying to highlight that there is also a pop-up that shows up, but I didn't click on it.

Do you think it is better to just have the pop-up with an "Update" button and if the user clicks on it to actually open the Installation window ?

I think it's just best to put the update settings screen in people's faces - I think what you've done here is probably best, I just didn't fully understand from the video.

CRogers · 2024-09-12T11:57:27Z

idea-plugin/src/main/java/com/palantir/gradle/jdks/PluginUpdateCheckerService.java

+                .map(minVersion -> VersionComparatorUtil.compare(pluginDescriptor.getVersion(), minVersion) > 0)
+                .orElse(true);
+
+        if (!isPluginUpToDate) {


Would probably just invert this if to return early.

CRogers · 2024-09-12T12:02:03Z

idea-plugin/src/main/java/com/palantir/gradle/jdks/PluginUpdateCheckerService.java

+            PluginsAdvertiser.installAndEnablePlugins(Set.of(PLUGIN_ID), notification::expire);
+        }
+    }
+}


Do we still get the other not so useful (see below) notification? Or is it suppressed somehow.

Yes, we still get it, we'd get both. I can remove my notification, but I thought it might be nice to actually tell you that the you need to use the pop-up window to update the plugin.

CRogers · 2024-09-12T12:57:51Z

...src/main/java/com/palantir/gradle/jdks/GradleJdksExternalSystemTaskNotificationListener.java

@@ -33,6 +33,7 @@ public void onStart(@NotNull ExternalSystemTaskId id, String _workingDir) {
                        || id.getType() == ExternalSystemTaskType.EXECUTE_TASK)) {
            Project project = id.findProject();
            if (project != null) {
+                project.getService(PluginUpdateCheckerService.class).checkPluginVersion();


I guess when projects are being refreshed is the place to do this as that's when the .idea/external-dependencies.xml is being changed.

CRogers · 2024-09-12T12:59:05Z

changelog/@unreleased/pr-410.v2.yml

@@ -0,0 +1,6 @@
+type: improvement
+improvement:
+  description: '[Intellij plugin] Prompt user to update plugin when installed version


I guess this is fine to try out in the this project for now; maybe eventually we can either make it a library each plugin uses (might be bad if they all try to open the update window at once though?) or a separate plugin that updates all the other plugins?

CRogers · 2024-09-12T12:59:27Z

👍

CRogers · 2024-09-12T13:47:52Z

idea-plugin/src/main/java/com/palantir/gradle/jdks/PluginUpdateCheckerService.java

+                ExternalDependenciesManager.getInstance(project).getDependencies(DependencyOnPlugin.class).stream()
+                        .filter(dependencyOnPlugin ->
+                                dependencyOnPlugin.getPluginId().equals(pluginId.getIdString()))
+                        .map(DependencyOnPlugin::getMinVersion)


Just thought of a possible complication:

We release a new version of a gradle + intellij plugin, set the min-version of intellij plugin to "force" people to upgrade.

The Gradle plugin update immediately gets picked up by excavator, applied to people's repos

Jetbrains takes two business days to approve our intellij plugin.

Every single time Gradle is refreshed, people get the popup to update to the new IntelliJ version that is not available yet.

that's a good point, I'll see if I can check that the version exists before opening the popup.
But that means we cannot really rely on the minVersion. Probably the best would be if the plugin will always maintain backwards compatibility with the intellij plugin and I can add a test for the logic here that we won't update the min-version of a plugin if that version doesn't already exist.

added a test that checks that the min-version intellij plugin: https://github.com/palantir/gradle-jdks/pull/410/files#diff-1d01bc54a43b33238be402e57110068b45d10d5b2c7f88104b1c1e67080c1a53R36. This should stop us from bumping the required min-version in externalDependencies.xml file.

I could add the check (probably cached + expiration) here in case we are going to "recall"(delete) a version, but I am not sure if we need it atm.

crogoz added 3 commits September 11, 2024 09:07

working when opening

7480030

checkplugin as service

45e0af3

update gradle jdks

f96bac6

svc-changelog and others added 6 commits September 11, 2024 15:23

Add generated changelog entries

715146e

showPlugin

7fde2ae

Merge branch 'develop' into cr/show-plugins

2561dbe

Merge branch 'cr/show-plugins' of github.com:palantir/gradle-jdks int…

567e174

…o cr/show-plugins

fixes

6bc3b5a

compile

b023536

crogoz commented Sep 12, 2024

View reviewed changes

crogoz requested review from CRogers, esword and felixdesouza September 12, 2024 11:48

crogoz commented Sep 12, 2024

View reviewed changes

crogoz force-pushed the cr/show-plugins branch from 98b0084 to b023536 Compare September 12, 2024 11:56

CRogers reviewed Sep 12, 2024

View reviewed changes

change order

4cc93f6

CRogers reviewed Sep 12, 2024

View reviewed changes

CRogers added the do not merge label Sep 12, 2024

CRogers reviewed Sep 12, 2024

View reviewed changes

crogoz added 3 commits September 13, 2024 15:51

can update version

5286499

add test that checks intellij min version existance

9913e15

use gradle version comparison

96085de

crogoz mentioned this pull request Sep 17, 2024

Intellij plugin doesn't need IDE restart anymore #416

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Intellij plugin] Prompt user to update plugin when installed version is lower than minVersion #410

[Intellij plugin] Prompt user to update plugin when installed version is lower than minVersion #410

crogoz commented Sep 11, 2024 •

edited

Loading

changelog-app bot commented Sep 11, 2024 •

edited by crogoz

Loading

crogoz Sep 12, 2024

crogoz Sep 12, 2024

CRogers Sep 12, 2024

crogoz Sep 12, 2024

CRogers Sep 12, 2024

CRogers Sep 12, 2024

CRogers Sep 12, 2024

crogoz Sep 12, 2024

CRogers Sep 12, 2024

CRogers Sep 12, 2024

CRogers commented Sep 12, 2024

CRogers Sep 12, 2024

crogoz Sep 12, 2024 •

edited

Loading

crogoz Sep 13, 2024 •

edited

Loading

		@@ -1,4 +1,4 @@
		<idea-plugin url="https://github.com/palantir/gradle-jdks">
		<idea-plugin url="https://github.com/palantir/gradle-jdks" require-restart="false">

[Intellij plugin] Prompt user to update plugin when installed version is lower than minVersion #410

Are you sure you want to change the base?

[Intellij plugin] Prompt user to update plugin when installed version is lower than minVersion #410

Conversation

crogoz commented Sep 11, 2024 • edited Loading

Before this PR

After this PR

Possible downsides?

changelog-app bot commented Sep 11, 2024 • edited by crogoz Loading

Generate changelog in changelog/@unreleased

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CRogers commented Sep 12, 2024

Choose a reason for hiding this comment

crogoz Sep 12, 2024 • edited Loading

Choose a reason for hiding this comment

crogoz Sep 13, 2024 • edited Loading

Choose a reason for hiding this comment

crogoz commented Sep 11, 2024 •

edited

Loading

changelog-app bot commented Sep 11, 2024 •

edited by crogoz

Loading

Generate changelog in `changelog/@unreleased`

crogoz Sep 12, 2024 •

edited

Loading

crogoz Sep 13, 2024 •

edited

Loading