From c47b7de77f35d8684096646af2ff8f2e48cee32f Mon Sep 17 00:00:00 2001
From: peter <peter@jetbrains.com>
Date: Tue, 18 Sep 2018 14:19:13 +0200
Subject: [PATCH] add motivating "Try to avoid processing PSI events at all
 cost!" javadocs

---
 .../com/intellij/psi/PsiTreeChangeEvent.java    | 17 ++++++++++++++++-
 .../com/intellij/psi/PsiTreeChangeListener.java |  4 +++-
 .../psi/impl/PsiTreeChangePreprocessor.java     |  4 ++++
 3 files changed, 23 insertions(+), 2 deletions(-)

diff --git a/platform/core-api/src/com/intellij/psi/PsiTreeChangeEvent.java b/platform/core-api/src/com/intellij/psi/PsiTreeChangeEvent.java
index 8f5946a42bc2..efddc5484f87 100644
--- a/platform/core-api/src/com/intellij/psi/PsiTreeChangeEvent.java
+++ b/platform/core-api/src/com/intellij/psi/PsiTreeChangeEvent.java
@@ -21,7 +21,22 @@ import org.jetbrains.annotations.Nullable;
 import java.util.EventObject;
 
 /**
- * Provides information about a change in the PSI tree of a project.
+ * Provides information about a change in the PSI tree of a project.<p/>
+ *
+ * Try to avoid processing PSI events at all cost! It's very hard to do this correctly and handle all edge cases.
+ * Please use {@link com.intellij.psi.util.CachedValue} with {@link com.intellij.psi.util.PsiModificationTracker#MODIFICATION_COUNT}
+ * or VFS events where possible. Here are just some of the complications with PSI events:
+ * <ul>
+ *   <li>Don't hope that if you replaced just one letter in an identifier, you'll get a "replaced" event about that identifier.
+ *   You might as well get anything, e.g. a "replaced" event for the whole FileElement.</li>
+ *   <li>Or not even that: you might get "propertyChanged" with {@link #PROP_UNLOADED_PSI}, not mentioning your file at all.</li>
+ *   <li>Before-/after-events aren't necessarily paired: you could get several "beforeChildDeletion" and then only "childrenChanged".</li>
+ *   <li>In event handler, you should be very careful to avoid traversing invalid PSI or expanding lazy-parseable elements.</li>
+ *   <li>There's no specification, and the precise events you get can be changed in future
+ *   as the infrastructure algorithms are improved or bugs are fixed.</li>
+ *   <li>To say nothing of the fact that the precise already depend on file size and the unpredictable activity of garbage collector,
+ *   so events in production might differ from the ones you've seen in test environment.</li>
+ * </ul>
  *
  * @see PsiTreeChangeListener
  */
diff --git a/platform/core-api/src/com/intellij/psi/PsiTreeChangeListener.java b/platform/core-api/src/com/intellij/psi/PsiTreeChangeListener.java
index b0b5979c1c82..47db1fff5234 100644
--- a/platform/core-api/src/com/intellij/psi/PsiTreeChangeListener.java
+++ b/platform/core-api/src/com/intellij/psi/PsiTreeChangeListener.java
@@ -20,7 +20,9 @@ import org.jetbrains.annotations.NotNull;
 import java.util.EventListener;
 
 /**
- * Listener for receiving notifications about all changes in the PSI tree of a project.
+ * Listener for receiving notifications about all changes in the PSI tree of a project.<p></p>
+ *
+ * Try to avoid processing PSI events at all cost! See {@link PsiTreeChangeEvent} documentation for more details.
  *
  * @see PsiManager#addPsiTreeChangeListener(PsiTreeChangeListener)
  * @see PsiManager#removePsiTreeChangeListener(PsiTreeChangeListener)
diff --git a/platform/core-impl/src/com/intellij/psi/impl/PsiTreeChangePreprocessor.java b/platform/core-impl/src/com/intellij/psi/impl/PsiTreeChangePreprocessor.java
index 7eaac7f30076..eba9c1191b9a 100644
--- a/platform/core-impl/src/com/intellij/psi/impl/PsiTreeChangePreprocessor.java
+++ b/platform/core-impl/src/com/intellij/psi/impl/PsiTreeChangePreprocessor.java
@@ -20,6 +20,10 @@ import com.intellij.openapi.extensions.ExtensionPointName;
 import org.jetbrains.annotations.NotNull;
 
 /**
+ * An extension called before notifying {@link com.intellij.psi.PsiTreeChangeListener}s of events.<p></p>
+ *
+ * Try to avoid processing PSI events at all cost! See {@link com.intellij.psi.PsiTreeChangeEvent} documentation for more details.
+ *
  * @author yole
  */
 public interface PsiTreeChangePreprocessor {