From 646ba066dd2d90c2a53d79e5a3d0ba67c192764d Mon Sep 17 00:00:00 2001
From: Joshua Horton <joshua_horton@sil.org>
Date: Fri, 5 Sep 2025 15:18:55 -0500
Subject: [PATCH] change(web): display reversions before keeps

---
 .../src/prediction/predictionContext.ts       | 28 ++++++++++++-------
 .../main/src/headless/inputProcessor.ts       |  4 +--
 2 files changed, 20 insertions(+), 12 deletions(-)

diff --git a/web/src/engine/interfaces/src/prediction/predictionContext.ts b/web/src/engine/interfaces/src/prediction/predictionContext.ts
index 137584b70d..04194971f8 100644
--- a/web/src/engine/interfaces/src/prediction/predictionContext.ts
+++ b/web/src/engine/interfaces/src/prediction/predictionContext.ts
@@ -24,15 +24,16 @@ export default class PredictionContext extends EventEmitter<PredictionContextEve
 
   private _currentSuggestions: Suggestion[] = [];
   private _keepSuggestion: Keep;
+  private _revertSuggestion: Reversion;
 
   public get keepSuggestion(): Keep {
     return this._keepSuggestion;
   }
 
-  private _revertSuggestion: Reversion;
+  private _immediateReversion: Reversion;
 
-  public get revertSuggestion(): Reversion {
-    return this._revertSuggestion;
+  public get immediateReversion(): Reversion {
+    return this._immediateReversion;
   }
 
   // Set to null/undefined if there was no recent acceptance.
@@ -86,7 +87,7 @@ export default class PredictionContext extends EventEmitter<PredictionContextEve
     this.suggestionApplier = (suggestion, ruleBehavior) => {
       if(validSuggestionState()) {
         const results = langProcessor.applySuggestion(suggestion, this.currentTarget, getLayerId, ruleBehavior);
-        results.reversion.then((reversion) => this._revertSuggestion = reversion);
+        results.reversion.then((reversion) => this._immediateReversion = reversion);
         return results.appendedRuleBehavior;
       } else {
         return null;
@@ -129,6 +130,10 @@ export default class PredictionContext extends EventEmitter<PredictionContextEve
     // we need to present the user a way to preserve the current context instead.
     const keepNeeded = this.selected && (this.keepSuggestion != this.selected);
 
+    if(this._revertSuggestion) {
+      suggestions.push(this._revertSuggestion);
+    }
+
     if(mayShowKeep && (keepNeeded || this.keepSuggestion.matchesModel)) {
       suggestions.push(this.keepSuggestion);
     }
@@ -252,9 +257,12 @@ export default class PredictionContext extends EventEmitter<PredictionContextEve
     // and prevent it from being hidden after reversion operations.
     this._keepSuggestion = null;
     this._revertSuggestion = null;
+    this._immediateReversion = null;
     for (const s of suggestions) {
       if(s.tag == 'keep') {
         this._keepSuggestion = s as Keep;
+      } else if(s.tag == 'revert') {
+        this._revertSuggestion = s as Reversion;
       }
 
       if (this.langProcessor.mayAutoCorrect && s.autoAccept && !this.selected) {
@@ -262,12 +270,12 @@ export default class PredictionContext extends EventEmitter<PredictionContextEve
       }
     }
 
-    // Verify that the transition IDs are still valid!
-    this._currentSuggestions = suggestions.filter(s => this.langProcessor.hasState(Math.abs(s.transformId)))
-
-    if(this.keepSuggestion) {
-      this._currentSuggestions.splice(this._currentSuggestions.indexOf(this.keepSuggestion), 1);
-    }
+    // Verify that the transition IDs are still valid and remove special entries.
+    this._currentSuggestions = suggestions.filter(s => {
+      return this.langProcessor.hasState(Math.abs(s.transformId)) &&
+      s != this._keepSuggestion &&
+      s != this._revertSuggestion
+    });
 
     // If we've gotten an update request like this, it's almost always user-triggered and means the context has shifted.
     if(!this.swallowPrediction) {
diff --git a/web/src/engine/main/src/headless/inputProcessor.ts b/web/src/engine/main/src/headless/inputProcessor.ts
index 9e4eb5aaaa..08ea4b2ccb 100644
--- a/web/src/engine/main/src/headless/inputProcessor.ts
+++ b/web/src/engine/main/src/headless/inputProcessor.ts
@@ -328,8 +328,8 @@ export class InputProcessor {
 
     // ...and is this immediately after a Suggestion with an appended Transform was applied?
     // (If not, don't consider reverting an appended transform.)
-    if(predictionContext.revertSuggestion?.appendedTransform && predictionContext.recentAcceptCause == 'banner') {
-      const reversion = predictionContext.revertSuggestion;
+    if(predictionContext.immediateReversion?.appendedTransform && predictionContext.recentAcceptCause == 'banner') {
+      const reversion = predictionContext.immediateReversion;
       // For reversions, the appended transform exists (if it did for the applied suggestion)
       // and has an ID set to the appended transform from the suggestion.
       const base = this.contextCache.get(reversion.appendedTransform.id);