snowtransfer 0.18.1 → 0.19.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
+# 0.19.0
+Idk why I didn't make 0.18.1 this version number. Anyways, the StateMachine now queues doTransition calls so that ones pushed on the same tick dont go in a confusing order.
+i.e. doTransition from inside of a transition callback.
+
 # 0.18.1
-A few bugs I failed to catch last round. Sorry about that.
+Another really big update which started out as some simple bug fixes, but surprisingly non breaking.
 
 - Fixed request retries with retryRequests/retryFailed deadlocking the route's rate limit bucket.
 	- The retry was enqueued into the same bucket that was blocked waiting for the retry to finish, so the request promise never settled and every later request on that route hung forever. Retries now free the bucket before re-queueing.

package/dist/StateMachine.d.ts

@@ -13,6 +13,10 @@ declare class StateMachine extends EventEmitter<StateMachineEvents> {
     private editable;
     private readonly deferredTransitionCreators;
     private readonly history;
+    /** Transitions requested while another transition was still running. Drained in order once the running transition completes. */
+    private readonly pendingTransitions;
+    /** Whether a transition is currently being executed, making new transition requests queue instead of nesting. */
+    private transitioning;
     /**
      * Create a new StateMachine
      * @param currentStateName The state this state machine is currently in. When constructing the StateMachine, this is the entry state.
@@ -65,11 +69,22 @@ declare class StateMachine extends EventEmitter<StateMachineEvents> {
      * Trigger an event to do a transition from the current state to another as defined previously.
      *
      * Will throw an Error if there is no transition from the current state to another based off the event.
+     *
+     * If called while another transition is still running (from an onLeave/onTransition/onEnter callback or
+     * something those callbacks synchronously invoke), the transition is queued and runs once the current one
+     * has fully completed, instead of nesting. Nested execution used to corrupt the enter sequence: the outer
+     * transition would re-emit "enter" for whatever state the nested transition landed in, re-running that
+     * state's onEnter callbacks and cancelling doTransitionLater timers that were still supposed to be pending.
      * @since 0.16.0
      * @param event The event that occurred.
      * @param args Arguments to pass to the callback of the transition's onTransition functions if any.
      */
     doTransition(event: string, ...args: any[]): void;
+    /**
+     * Runs a single transition to completion: onLeave, state change, onTransition, "enter", onEnter.
+     * Only ever called from doTransition's drain loop so transitions cannot nest.
+     */
+    private _transition;
     /**
      * Trigger an event to do a transition from the current state to another as defined previously at a later point in time.
      *

package/dist/StateMachine.js

@@ -10,6 +10,10 @@ class StateMachine extends node_events_1.EventEmitter {
     editable = true;
     deferredTransitionCreators = [];
     history = [];
+    /** Transitions requested while another transition was still running. Drained in order once the running transition completes. */
+    pendingTransitions = [];
+    /** Whether a transition is currently being executed, making new transition requests queue instead of nesting. */
+    transitioning = false;
     /**
      * Create a new StateMachine
      * @param currentStateName The state this state machine is currently in. When constructing the StateMachine, this is the entry state.
@@ -122,12 +126,38 @@ class StateMachine extends node_events_1.EventEmitter {
      * Trigger an event to do a transition from the current state to another as defined previously.
      *
      * Will throw an Error if there is no transition from the current state to another based off the event.
+     *
+     * If called while another transition is still running (from an onLeave/onTransition/onEnter callback or
+     * something those callbacks synchronously invoke), the transition is queued and runs once the current one
+     * has fully completed, instead of nesting. Nested execution used to corrupt the enter sequence: the outer
+     * transition would re-emit "enter" for whatever state the nested transition landed in, re-running that
+     * state's onEnter callbacks and cancelling doTransitionLater timers that were still supposed to be pending.
      * @since 0.16.0
      * @param event The event that occurred.
      * @param args Arguments to pass to the callback of the transition's onTransition functions if any.
      */
     doTransition(event, ...args) {
         this.guardNotEditable();
+        this.pendingTransitions.push({ event, args });
+        if (this.transitioning)
+            return; // the drain loop below picks it up once the current transition has fully completed
+        this.transitioning = true;
+        try {
+            while (this.pendingTransitions.length) {
+                const next = this.pendingTransitions.shift();
+                this._transition(next.event, next.args);
+            }
+        }
+        finally {
+            this.transitioning = false;
+            this.pendingTransitions.length = 0; // if a transition threw, queued followers must not leak into an unrelated later call
+        }
+    }
+    /**
+     * Runs a single transition to completion: onLeave, state change, onTransition, "enter", onEnter.
+     * Only ever called from doTransition's drain loop so transitions cannot nest.
+     */
+    _transition(event, args) {
         const from = this.currentStateName;
         const currentState = this.states.get(this.currentStateName);
         const transition = currentState.transitions.get(event);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "snowtransfer",
-  "version": "0.18.1",
+  "version": "0.19.0",
   "description": "Minimalistic Rest client for the Discord Api",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -37,8 +37,8 @@
   "devDependencies": {
     "@eslint/js": "^10.0.1",
     "@types/node": "^26.1.0",
-    "@typescript-eslint/eslint-plugin": "^8.62.1",
-    "@typescript-eslint/parser": "^8.62.1",
+    "@typescript-eslint/eslint-plugin": "^8.63.0",
+    "@typescript-eslint/parser": "^8.63.0",
     "eslint": "^10.6.0",
     "globals": "^17.7.0",
     "typedoc": "^0.28.20",