Merge pull request #3833 from joshuataylor/feature/requires-read-lock

Add @RequiresReadLock annotations to PSI-accessing methods

Author: joshuataylor

.github/actions/setup-env/action.yml

@@ -49,12 +49,14 @@ runs:
         large-packages: false
         docker-images: ${{ inputs.free-docker-images == 'true' }}
 
-    - name: Cache JetBrains JDK
-      id: cache-jdk
-      uses: actions/cache@v5
+    - name: Restore JetBrains Runtime cache
+      id: cache-jbr
+      uses: actions/cache/restore@v5
       with:
-        path: /opt/hostedtoolcache/Java_JetBrains_*
-        key: jdk-${{ runner.os }}-${{ runner.arch }}-jetbrains-21
+        path: ${{ runner.tool_cache }}/Java_JetBrains_*
+        key: jbr-${{ runner.os }}-${{ runner.arch }}-21
+        restore-keys: |
+          jbr-${{ runner.os }}-${{ runner.arch }}-
 
     - name: Setup JBR 21
       id: setup-java
@@ -67,6 +69,14 @@ runs:
       env:
         GITHUB_TOKEN: ${{ inputs.github-token }}
 
+    - name: Save JetBrains Runtime cache
+      id: cache-jbr-save
+      if: always() && steps.cache-jbr.outputs.cache-hit != 'true' && steps.setup-java.outcome == 'success'
+      uses: actions/cache/save@v5
+      with:
+        path: ${{ runner.tool_cache }}/Java_JetBrains_*
+        key: jbr-${{ runner.os }}-${{ runner.arch }}-${{ steps.setup-java.outputs.version }}
+
     # This sets project properties, allowing us to override gradle.properties via environment variables,
     # applying to all Gradle tasks. Means we don't need to do like `./gradlew -PplatformVersion=xxx`
     # Needed because we can't just use env, as we're in a composite action, and env set here won't propagate to
@@ -133,7 +143,7 @@ runs:
 
     - name: Save Elixir cache
       id: cache-elixir-save
-      if: always() && steps.cache-elixir-restore.outputs.cache-hit != 'true' && inputs.setup-elixir == 'true'
+      if: always() && steps.cache-elixir-restore.outputs.cache-hit != 'true' && inputs.setup-elixir == 'true' && steps.setup-elixir.outcome == 'success'
       uses: actions/cache/save@v5
       with:
         path: |

.github/workflows/shared-test.yml

@@ -43,7 +43,7 @@ jobs:
         os: [ ubuntu-22.04, windows-2025 ]
         idea-version:
             - '2026.1.2'
-            - '2025.3.2'
+            - '2025.3.5'
             # 2026.2 upgrades to Java 25, won't work in CI until we resolve issues. https://github.com/JetBrains/intellij-community/commit/aa1cfa9632ab
             # - 'LATEST-EAP-SNAPSHOT'
 
@@ -146,6 +146,12 @@ jobs:
           - 'rubymine:2026.1.2'
 
     steps:
+      - name: Sanitise IDE version for artifact names
+        id: sanitise
+        run: echo "ide-version=${IDE_VERSION//:/-}" >> "$GITHUB_OUTPUT"
+        env:
+          IDE_VERSION: ${{ matrix.ide-version }}
+
       - name: Download Plugin Zip
         id: download-plugin-zip
         uses: actions/download-artifact@v6
@@ -192,7 +198,7 @@ jobs:
         uses: actions/upload-artifact@v6
         if: ${{ always() && inputs.upload-reports }}
         with:
-          name: verify-plugin-reports-${{ matrix.ide-version }}
+          name: verify-plugin-reports-${{ steps.sanitise.outputs.ide-version }}
           path: |
             ${{ steps.verify-plugin.outputs.verification-output-log-filename }}
             ${{ steps.verify-plugin.outputs.verification-reports-dir }}
@@ -202,6 +208,6 @@ jobs:
         id: upload-plugin
         uses: actions/upload-artifact@v6
         with:
-          name: plugin-artifact
+          name: plugin-artifact-${{ steps.sanitise.outputs.ide-version }}
           path: build/distributions/*.zip
           retention-days: 1

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## v23.8.2
+
+### Enhancements
+* Added `@RequiresReadLock` annotations to PSI-accessing methods across 10 files (`CallDefinitionClause`, `Definition`, `Implementation`, `Module`, `Protocol`, `ElixirPsiImplUtil`, `PsiElementImpl`, `PsiNamedElementImpl`, `CallImpl`, `CanonicallyNamedImpl`). Enables the `ThreadingConcurrency` inspection to statically detect callers that don't hold the read lock. - [@joshuataylor](https://github.com/joshuataylor)
+
+### Build
+* [#3830](https://github.com/KronicDeth/intellij-elixir/pull/3830) - [@joshuataylor](https://github.com/joshuataylor)
+  * Bumped IntelliJ 2026.1.x target to 2026.1.2.
+* Bumped Gradle to 9.5.1. - [@joshuataylor](https://github.com/joshuataylor)
+* Bumped intellij-platform plugin to 2.16.0. - [@joshuataylor](https://github.com/joshuataylor)
+
 ## v23.8.1
 
 ### Bug Fixes

gradle.properties

@@ -6,7 +6,7 @@
 # --- Plugin Metadata ---
 pluginGroup=org.elixir_lang
 pluginName=Elixir
-pluginVersion=23.8.1
+pluginVersion=23.8.2
 pluginRepositoryUrl=https://github.com/KronicDeth/intellij-elixir/
 vendorName=Elle Imhoff
 vendorEmail=Kronic.Deth@gmail.com

resources/META-INF/changelog.html

@@ -1,6 +1,22 @@
 <html>
 <body>
 
+<h1>v23.8.2</h1>
+<ul>
+    <li>
+        <p>Enhancements</p>
+        <ul>
+            <li>Added static threading annotations to PSI-accessing methods, enabling compile-time detection of missing read locks via the <code>ThreadingConcurrency</code> inspection.</li>
+        </ul>
+    </li>
+    <li>
+        <p>Build</p>
+        <ul>
+            <li>Bumped IntelliJ 2026.1.x target to 2026.1.2, Gradle to 9.5.1, and intellij-platform plugin to 2.16.0.</li>
+        </ul>
+    </li>
+</ul>
+
 <h1>v23.8.1</h1>
 <ul>
     <li>

src/org/elixir_lang/psi/CallDefinitionClause.kt

@@ -4,6 +4,7 @@ import com.intellij.psi.ElementDescriptionLocation
 import com.intellij.psi.PsiElement
 import com.intellij.psi.ResolveState
 import com.intellij.usageView.UsageViewTypeLocation
+import com.intellij.util.concurrency.annotations.RequiresReadLock
 import org.elixir_lang.NameArityInterval
 import org.elixir_lang.find_usages.Provider
 import org.elixir_lang.psi.call.Call
@@ -19,6 +20,7 @@ object CallDefinitionClause {
      *
      * @param call a def(macro)?p?
      */
+    @RequiresReadLock
     @JvmStatic
     fun enclosingModularMacroCall(call: Call): Call? {
         var enclosedCall = call
@@ -60,30 +62,42 @@ object CallDefinitionClause {
      * @param call a call that [.is].
      * @return element for `name(arg, ...) when ...` in `def* name(arg, ...) when ...`
      */
+    @RequiresReadLock
     @JvmStatic
     fun head(call: Call): PsiElement? = call.primaryArguments()?.firstOrNull()
 
+    @RequiresReadLock
     @JvmStatic
     fun `is`(call: Call): Boolean = isFunction(call) || isMacro(call) || isGuard(call)
 
+    @RequiresReadLock
     @JvmStatic
     fun isFunction(call: Call): Boolean = isPrivateFunction(call) || isPublicFunction(call)
+    @RequiresReadLock
     @JvmStatic
     fun isPublicFunction(call: Call): Boolean =
             isCallingKernelMacroOrHead(call, DEF) || isCallingKernelMacroOrHead(call, DEFMEMO)
+    @RequiresReadLock
     fun isPrivateFunction(call: Call): Boolean =
             isCallingKernelMacroOrHead(call, DEFP) || isCallingKernelMacroOrHead(call, DEFMEMOP)
 
+    @RequiresReadLock
     @JvmStatic
     fun isMacro(call: Call): Boolean = isPrivateMacro(call) || isPublicMacro(call)
+    @RequiresReadLock
     @JvmStatic
     fun isPublicMacro(call: Call): Boolean = isCallingKernelMacroOrHead(call, DEFMACRO)
+    @RequiresReadLock
     fun isPrivateMacro(call: Call): Boolean = isCallingKernelMacroOrHead(call, DEFMACROP)
 
+    @RequiresReadLock
     fun isGuard(call: Call): Boolean = isPrivateGuard(call) || isPublicGuard(call)
+    @RequiresReadLock
     fun isPublicGuard(call: Call): Boolean = isCallingKernelMacroOrHead(call, DEFGUARD)
+    @RequiresReadLock
     fun isPrivateGuard(call: Call): Boolean = isCallingKernelMacroOrHead(call, DEFGUARDP)
 
+    @RequiresReadLock
     fun isPublic(call: Call): Boolean = isPublicFunction(call) || isPublicMacro(call) || isPublicGuard(call)
 
     /**
@@ -94,10 +108,12 @@ object CallDefinitionClause {
      * default arguments are used, which produces an arity for each default argument that is turned on and off.
      * @see Call.resolvedFinalArityInterval
      */
+    @RequiresReadLock
     @JvmStatic
     fun nameArityInterval(call: Call, state: ResolveState): NameArityInterval? =
             head(call)?.let { CallDefinitionHead.nameArityInterval(it, state) }
 
+    @RequiresReadLock
     fun nameIdentifier(call: Call): PsiElement? = head(call)?.let { CallDefinitionHead.nameIdentifier(it) }
 
     private fun functionElementDescription(

src/org/elixir_lang/psi/Definition.kt

@@ -1,5 +1,6 @@
 package org.elixir_lang.psi
 
+import com.intellij.util.concurrency.annotations.RequiresReadLock
 import org.elixir_lang.psi.call.Call
 import org.elixir_lang.psi.call.name.Function.*
 import org.elixir_lang.psi.call.name.Module.KERNEL
@@ -27,6 +28,7 @@ enum class Definition(val type: Type) {
 /**
  * What kind of definition is defined by the [call]
  */
+@RequiresReadLock
 fun definition(call: Call): Definition? =
         definition(call.resolvedModuleName(), call.functionName(), call.resolvedFinalArity(), call.hasDoBlockOrKeyword())
 

src/org/elixir_lang/psi/Implementation.kt

@@ -7,6 +7,7 @@ import com.intellij.psi.search.GlobalSearchScope
 import com.intellij.psi.stubs.StubIndex
 import com.intellij.usageView.UsageViewTypeLocation
 import com.intellij.util.Processor
+import com.intellij.util.concurrency.annotations.RequiresReadLock
 import org.elixir_lang.psi.call.Call
 import org.elixir_lang.psi.call.name.Function
 import org.elixir_lang.psi.impl.call.finalArguments
@@ -17,6 +18,7 @@ import org.elixir_lang.structure_view.element.CallDefinitionClause
 import org.elixir_lang.structure_view.element.modular.Modular
 
 object Implementation {
+    @RequiresReadLock
     @JvmStatic
     fun `is`(call: Call): Boolean {
         return call.isCallingMacro(org.elixir_lang.psi.call.name.Module.KERNEL, Function.DEFIMPL, 2) ||
@@ -27,6 +29,7 @@ object Implementation {
      * @return `null` if protocol or module for the implementation cannot be derived or if the `for` argument is a
      * list.
      */
+    @RequiresReadLock
     fun name(call: Call): String? = nameCollection(CallDefinitionClause.enclosingModular(call), call)?.singleOrNull()
 
     private fun nameCollection(enclosingModular: Modular?, call: Call): Collection<String>? {
@@ -53,6 +56,7 @@ object Implementation {
     private fun forNameCollection(forNameElement: ElixirList): Collection<String> =
         forNameCollection(forNameElement.children)
 
+    @RequiresReadLock
     fun forNameCollection(forNameElement: PsiElement): Collection<String>? = when (forNameElement) {
         is ElixirAccessExpression -> forNameCollection(forNameElement)
         is ElixirList -> forNameCollection(forNameElement)
@@ -70,6 +74,7 @@ object Implementation {
     private fun forNameCollection(forNameElement: QualifiableAlias): Collection<String>? =
         forNameElement.name?.let { listOf(it) }
 
+    @RequiresReadLock
     fun forNameCollection(enclosingModular: Modular?, call: Call): Collection<String>? {
         val forNameElement = forNameElement(call)
         return when {
@@ -85,6 +90,7 @@ object Implementation {
         }
     }
 
+    @RequiresReadLock
     fun forNameElement(call: Call): PsiElement? =
         call.finalArguments()?.lastOrNull()?.let { it as? QuotableKeywordList }?.keywordValue(Function.FOR)
 
@@ -105,9 +111,11 @@ object Implementation {
         }
     }
 
+    @RequiresReadLock
     @JvmStatic
     fun protocolName(call: Call): String? = protocolNameElement(call)?.let { protocolName(it) }
 
+    @RequiresReadLock
     fun protocolNameElement(call: Call): QualifiableAlias? {
         val finalArguments = call.finalArguments()
 

src/org/elixir_lang/psi/Module.kt

@@ -5,9 +5,11 @@ import com.intellij.openapi.util.Computable
 import org.elixir_lang.psi.call.Call
 import org.elixir_lang.psi.call.name.Function
 import org.elixir_lang.psi.call.name.Module
+import com.intellij.util.concurrency.annotations.RequiresReadLock
 import org.jetbrains.annotations.Contract
 
 object Module {
+    @RequiresReadLock
     @JvmStatic
     fun `is`(call: Call): Boolean =
             (call.isCallingMacro(Module.KERNEL, Function.DEFMODULE, 2) &&
@@ -25,6 +27,7 @@ object Module {
                             }) != true) ||
                     call.isCalling(Module.MODULE, Function.CREATE, 3)
 
+    @RequiresReadLock
     @Contract(pure = true)
     fun name(call: Call): String = call.primaryArguments()!!.first()!!.text
 }

src/org/elixir_lang/psi/Protocol.kt

@@ -6,6 +6,7 @@ import com.intellij.psi.ResolveState
 import com.intellij.psi.search.GlobalSearchScope
 import com.intellij.psi.stubs.StubIndex
 import com.intellij.util.Processor
+import com.intellij.util.concurrency.annotations.RequiresReadLock
 import org.elixir_lang.beam.psi.impl.CallDefinitionImpl
 import org.elixir_lang.beam.psi.impl.ModuleImpl
 import org.elixir_lang.beam.psi.stubs.ModuleStub
@@ -15,6 +16,7 @@ import org.elixir_lang.psi.call.name.Function
 import org.elixir_lang.psi.stub.index.ImplementedProtocolName
 
 object Protocol {
+    @RequiresReadLock
     @JvmStatic
     fun `is`(call: Call): Boolean =
         call.isCallingMacro(org.elixir_lang.psi.call.name.Module.KERNEL, Function.DEFPROTOCOL, 2)