Migrate from StartupActivity (obsolete) -> VcsRepositoryMappingListener

Fixes #445

Author: ChrisCarini

CHANGELOG.md

@@ -8,6 +8,7 @@
 
 ### Changed
 - Upgrading IntelliJ from 2025.1 to 2025.1.1
+- Migrate from `StartupActivity` (obsolete) -> `VcsRepositoryMappingListener`
 
 ### Deprecated
 

src/main/java/com/chriscarini/jetbrains/github/issue/navigation/GitHubIssueNavigationStartupActivity.java

@@ -0,0 +1,93 @@
+package com.chriscarini.jetbrains.github.issue.navigation;
+
+import com.chriscarini.jetbrains.github.utils.GitHubUri;
+import com.chriscarini.jetbrains.github.utils.GitHubUtils;
+import com.intellij.dvcs.repo.VcsRepositoryManager;
+import com.intellij.dvcs.repo.VcsRepositoryMappingListener;
+import com.intellij.openapi.application.ApplicationManager;
+import com.intellij.openapi.diagnostic.Logger;
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.vcs.IssueNavigationConfiguration;
+import com.intellij.openapi.vcs.IssueNavigationLink;
+import git4idea.repo.GitRemote;
+import git4idea.repo.GitRepositoryImpl;
+import org.jetbrains.annotations.NonNls;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Collection;
+import java.util.List;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+
+public class GitHubIssueNavigationVcsRepositoryMappingListener implements VcsRepositoryMappingListener {
+
+    private static final @NonNls Logger LOG = Logger.getInstance(GitHubIssueNavigationVcsRepositoryMappingListener.class);
+    private final @NotNull Project project;
+
+    public GitHubIssueNavigationVcsRepositoryMappingListener(@NotNull final Project project) {
+        this.project = project;
+    }
+
+    @Override
+    public void mappingChanged() {
+
+        if (ApplicationManager.getApplication().isUnitTestMode()) {
+            LOG.debug("Unit test mode; will not attempt to add GitHub Issue Navigation to project");
+            return;
+        }
+        VcsRepositoryManager.getInstance(project).getRepositories().forEach(repository -> {
+            final Collection<GitRemote> repoRemotes = ((GitRepositoryImpl) repository).getRemotes();
+            repoRemotes.forEach(
+                    gitRemote -> {
+                        final String url = gitRemote.getFirstUrl();
+
+                        if (url == null) {
+                            LOG.debug(String.format("Null Git remote URL: %s", gitRemote));
+                            return;
+                        }
+
+                        if (!GitHubUtils.isKnownGitHubDomain(url)) {
+                            LOG.debug(String.format(
+                                    "Git remote URL (%s) not from a known GitHub domain: %s",
+                                    gitRemote,
+                                    GitHubUtils.knownGitHubDomains().collect(Collectors.joining(", "))
+                            ));
+                            return;
+                        }
+
+                        final String cleanedUrl = GitHubUri.parseUrl(url).asHttpsFormatUrl();
+
+                        if (existsInIssueNavConfig(project, cleanedUrl)) {
+                            LOG.debug(String.format("%s is already registered.", cleanedUrl));
+                            return;
+                        }
+
+                        LOG.debug(String.format("Registering [%s].", cleanedUrl));
+                        addNewIssueNavigationConfiguration(project, cleanedUrl);
+                    }
+            );
+        });
+    }
+
+    protected static boolean existsInIssueNavConfig(@NotNull final Project project, @NotNull final String url) {
+        final List<IssueNavigationLink> matching = IssueNavigationConfiguration.getInstance(project).getLinks()
+                .stream()
+                .filter(issueNavigationLink -> issueNavigationLink.getLinkRegexp().contains(url))
+                .toList();
+
+        return !matching.isEmpty();
+    }
+
+    protected static void addNewIssueNavigationConfiguration(@NotNull final Project project, @NotNull final String url) {
+        final IssueNavigationConfiguration issueNavigationConfiguration = IssueNavigationConfiguration.getInstance(project);
+
+        final IssueNavigationLink newLink = new IssueNavigationLink("\\(#(\\d+)\\)", String.format("%s/issues/$1", url));
+
+        issueNavigationConfiguration.setLinks(
+                Stream.concat(
+                        issueNavigationConfiguration.getLinks().stream(),
+                        Stream.of(newLink)
+                ).collect(Collectors.toList()));
+    }
+}

src/main/java/com/chriscarini/jetbrains/github/issue/navigation/GitHubIssueNavigationVcsRepositoryMappingListener.java

@@ -19,8 +19,8 @@ public static Stream<String> knownGitHubDomains() {
     public static boolean isKnownGitHubDomain(@NotNull final String url) {
         final List<String> result = knownGitHubDomains()
             .filter(url::contains)
-            .collect(Collectors.toList());
+            .toList();
 
-        return result.size() > 0;
+        return !result.isEmpty();
     }
 }

src/main/java/com/chriscarini/jetbrains/github/utils/GitHubUtils.java

@@ -12,10 +12,11 @@
     <depends>com.intellij.modules.platform</depends>
     <depends>Git4Idea</depends>
 
-    <extensions defaultExtensionNs="com.intellij">
-
-        <postStartupActivity
-                implementation="com.chriscarini.jetbrains.github.issue.navigation.GitHubIssueNavigationStartupActivity"/>
-
-    </extensions>
+    <projectListeners>
+        <listener
+                class="com.chriscarini.jetbrains.github.issue.navigation.GitHubIssueNavigationVcsRepositoryMappingListener"
+                topic="com.intellij.dvcs.repo.VcsRepositoryMappingListener"
+                activeInHeadlessMode="false"
+                activeInTestMode="false"/>
+    </projectListeners>
 </idea-plugin>

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

@@ -10,7 +10,7 @@
 import java.util.stream.Collectors;
 
 
-public class TestGitHubIssueNavigationStartupActivityTest extends LightPlatformTestCase {
+public class TestGitHubIssueNavigationVcsRepositoryMappingListenerTest extends LightPlatformTestCase {
     @Override
     public void setUp() throws Exception {
         super.setUp();
@@ -26,25 +26,25 @@ public void testExistsInIssueNavConfig() {
         IssueNavigationConfiguration.getInstance(getProject()).setLinks(List.of(myIssueNavigationLink));
 
         // expect
-        assert GitHubIssueNavigationStartupActivity.existsInIssueNavConfig(getProject(), expectedUrl);
-        assert !GitHubIssueNavigationStartupActivity.existsInIssueNavConfig(getProject(), unexpectedUrl);
+        assert GitHubIssueNavigationVcsRepositoryMappingListener.existsInIssueNavConfig(getProject(), expectedUrl);
+        assert !GitHubIssueNavigationVcsRepositoryMappingListener.existsInIssueNavConfig(getProject(), unexpectedUrl);
     }
 
     @Test
     public void testAddNewIssueNavigationConfiguration() {
         // given
         final String expectedUrl = "MY_FAKE_URL";
-        assert IssueNavigationConfiguration.getInstance(getProject()).getLinks().size() == 0;
+        assert IssueNavigationConfiguration.getInstance(getProject()).getLinks().isEmpty();
 
         // when
-        GitHubIssueNavigationStartupActivity.addNewIssueNavigationConfiguration(getProject(), expectedUrl);
+        GitHubIssueNavigationVcsRepositoryMappingListener.addNewIssueNavigationConfiguration(getProject(), expectedUrl);
 
         // then
         final List<IssueNavigationLink> issues = IssueNavigationConfiguration.getInstance(getProject())
             .getLinks()
             .stream()
             .filter(issueNavigationLink -> issueNavigationLink.getLinkRegexp().contains(expectedUrl))
-            .collect(Collectors.toList());
+            .toList();
         assertEquals(1, issues.size());
     }
 }