Fix initializeIntelliJPlugin timeout

When developing plugins, the common tasks are Run / Debug / Build gradle tasks, but they always get stuck on the initializeIntelliJPlugin task for a long time.

Locate the problem

Here is the source code of InitializeIntelliJPluginTask.kt file.

1
// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
2

3
package org.jetbrains.intellij.tasks
4

5
import org.gradle.api.DefaultTask
6
import org.gradle.api.provider.Property
7
import org.gradle.api.tasks.Internal
8
import org.gradle.api.tasks.TaskAction
9
import org.gradle.api.tasks.UntrackedTask
10
import org.jetbrains.intellij.*
11
import org.jetbrains.intellij.IntelliJPluginConstants.PLUGIN_GROUP_NAME
12
import org.jetbrains.intellij.utils.LatestVersionResolver
13

14
@UntrackedTask(because = "Should always be run to initialize the plugin")
15
abstract class InitializeIntelliJPluginTask : DefaultTask() {
16

12 collapsed lines
17
    @get:Internal
18
    abstract val offline: Property<Boolean>
19

20
    @get:Internal
21
    abstract val selfUpdateCheck: Property<Boolean>
22

23
    init {
24
        group = PLUGIN_GROUP_NAME
25
        description = "Initializes the Gradle IntelliJ Plugin"
26
    }
27

28
    private val context = logCategory()
29

30
    @TaskAction
31
    fun initialize() {
32
        checkPluginVersion()
33
    }
34

17 collapsed lines
35
    private fun checkPluginVersion() {
36
        if (!selfUpdateCheck.get() || offline.get()) {
37
            return
38
        }
39

40
        try {
41
            val version = getCurrentPluginVersion()
42
                ?.let(Version::parse)
43
                .or { Version() }
44
            val latestVersion = LatestVersionResolver.fromGitHub(IntelliJPluginConstants.PLUGIN_NAME, IntelliJPluginConstants.GITHUB_REPOSITORY)
45
            if (version < Version.parse(latestVersion)) {
46
                warn(context, "${IntelliJPluginConstants.PLUGIN_NAME} is outdated: $version. Update `${IntelliJPluginConstants.PLUGIN_ID}` to: $latestVersion")
47
            }
48
        } catch (e: Exception) {
49
            error(context, e.message.orEmpty(), e)
50
        }
51
    }
52
}

It mainly does one thing: checkPluginVersion(), so it is likely because of the network connection. In other words, if the connection to the server is slow, this problem may occur.

Solve the problem

In the checkPluginVersion() method, there is a judgment condition. As long as selfUpdateCheck is set to false or offline is set to true, it can avoid checking. Now the problem is very easy to solve. As long as one of the above conditions is met.

In the build.gradle.kts file, add the following code to solve the problem.

tasks {
    ...
    initializeIntelliJPlugin {
        selfUpdateCheck.set(false)
    }
    ...
}