achilles 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d860cd0be6faa8af39117c4dc6feadb2445f48ccfd687963a3a8eeddbe1c3b95
-  data.tar.gz: '09cdfabdfa0895b1a3c7a92726baf49cb234a9a716b8a1e3a65c7eb6e578904e'
+  metadata.gz: b4d4c63799a2a26d7d7a819ec2e17559de59d80be593e5b28d2cc6445864ccda
+  data.tar.gz: 8fe623f377d068436dc08beed221ad293ed85159a46930aa5868e24aece5a1ca
 SHA512:
-  metadata.gz: 7899f56529ad2a867a289b546241023e235a1d848d3a22ceb1a396fb92a515c9edeb3b50decdec7d37e952f9c5fc524326c8d1fc3456e78f5e1c7db5be53c10d
-  data.tar.gz: 7d43d1c196f608be65a27d42840cdd0a3f3bac7bb86870dec876b89bdbfdf63408465dabd265986322638300ab0d8287c3a747e2b2830ccc3c824bf74217318e
+  metadata.gz: 5a1b4835b8cc60697ac3eb8d44e23c8799f76fa0d82f9a481b6a1a8cbdfe77373b91e1443dfcb62b6d733430bae427cd5bf624b3390f8a4f59ce5c632e223292
+  data.tar.gz: f6eed0197de6d71b6c74f4dfedf63920207f798fd4260a1d22076d7459587624fa2aa3d6fa88dc51d90fbe3be2735b687265122eb1222a67cfe25d9a94960f66

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to Achilles will be documented in this file.
 
+## 1.1.2
+
+### Fixed
+
+- Fixed Turbo Frame rendering so registered components in the outgoing frame are
+  torn down and deregistered immediately before Turbo invokes the frame renderer.
+
 ## 1.1.1
 
 ### Fixed

data/README.md

@@ -8,9 +8,10 @@ Achilles scans the page for elements with `data-component-class`, instantiates
 the matching JavaScript class, and calls `setup` and `teardown` as Turbo renders
 new pages or new component markup is inserted.
 
-Current applications should use Achilles `1.1.1`. If you are upgrading an
+Current applications should use Achilles `1.1.2`. If you are upgrading an
 existing app, start with the [1.1.0 upgrade guide](docs/upgrading-to-1.1.0.md)
-and then read the [1.1.1 release note](docs/releases/v1.1.1.md).
+and then read the [1.1.1](docs/releases/v1.1.1.md) and
+[1.1.2](docs/releases/v1.1.2.md) release notes.
 
 ## Why Achilles?
 
@@ -185,6 +186,9 @@ The dummy Rails app includes a working counter component. See
 
 - `setup()` runs after `turbo:load` and after new matching DOM nodes are inserted.
 - `teardown()` runs before Turbo renders a new page.
+- Before Turbo renders replacement content in a frame, Achilles tears down and
+  deregisters registered components in the outgoing frame from children to
+  parents.
 - `setup()` and `teardown()` are called once per registered component instance.
 - Parent components are set up before their children.
 - Child components are torn down before their parents.
@@ -276,8 +280,8 @@ If no timezone is present, Achilles falls back to `Etc/UTC`.
 
 Applications upgrading to `1.1.0` should read the
 [1.1.0 upgrade guide](docs/upgrading-to-1.1.0.md). The complete upgrade index
-lives in [docs/upgrading.md](docs/upgrading.md), and the GitHub release draft is
-available at [docs/releases/v1.1.1.md](docs/releases/v1.1.1.md).
+lives in [docs/upgrading.md](docs/upgrading.md), and the current release note is
+available at [docs/releases/v1.1.2.md](docs/releases/v1.1.2.md).
 
 ## Upgrading From 0.1.3
 

data/app/javascript/achilles/application/hooks-manager/turbo.js

@@ -4,6 +4,7 @@ class Turbo {
   _teardownCallback;
   _setupHandler;
   _teardownHandler;
+  _frameRenderHandler;
   _started = false;
 
   constructor(application, setupCallback, teardownCallback) {
@@ -27,8 +28,24 @@ class Turbo {
       this._teardownCallback();
     };
 
+    this._frameRenderHandler = (event) => {
+      const frame = event.target;
+      const originalRender = event.detail?.render;
+
+      if (!frame || typeof originalRender !== "function") {
+        return;
+      }
+
+      const componentRegistry = this._application.componentRegistry;
+      event.detail.render = function(...args) {
+        componentRegistry.teardownAndDeregisterWithin(frame);
+        return Reflect.apply(originalRender, this, args);
+      };
+    };
+
     document.addEventListener("turbo:load", this._setupHandler);
     document.addEventListener("turbo:before-render", this._teardownHandler);
+    document.addEventListener("turbo:before-frame-render", this._frameRenderHandler);
     this._started = true;
   }
 
@@ -39,8 +56,10 @@ class Turbo {
 
     document.removeEventListener("turbo:load", this._setupHandler);
     document.removeEventListener("turbo:before-render", this._teardownHandler);
+    document.removeEventListener("turbo:before-frame-render", this._frameRenderHandler);
     this._setupHandler = null;
     this._teardownHandler = null;
+    this._frameRenderHandler = null;
     this._started = false;
   }
 }

data/app/javascript/achilles/components/components_registry.js

@@ -130,6 +130,39 @@ class ComponentsRegistry {
         this.deregisterComponent(id);
     }
 
+    teardownAndDeregisterWithin(rootElement) {
+        if(!rootElement || typeof rootElement.contains !== 'function')
+            return;
+
+        Object.values(this._registeredComponents)
+            .filter((component) => {
+                if(component.id === AppConstants.PageComponentId)
+                    return false;
+
+                let element = this.elementForId(component.id);
+                return element && rootElement.contains(element);
+            })
+            .sort((firstComponent, secondComponent) => {
+                return this.elementDepth(secondComponent.id) - this.elementDepth(firstComponent.id);
+            })
+            .forEach((component) => {
+                if(this.getRegisteredComponent(component.id))
+                    this.teardownAndDeregister(component.id);
+            });
+    }
+
+    elementDepth(id) {
+        let depth = 0;
+        let element = this.elementForId(id);
+
+        while(element?.parentElement) {
+            depth += 1;
+            element = element.parentElement;
+        }
+
+        return depth;
+    }
+
     elementNotFound(id) {
         console.error('Cannot find element while setup, so teardown & deregister. id: ' + id);
         this.teardownAndDeregister(id);

data/docs/releases/v1.1.2.md

@@ -0,0 +1,58 @@
+# Achilles 1.1.2
+
+Achilles `1.1.2` is a patch release for Rails + Turbo applications using Turbo
+Frames. It fixes late component cleanup when Turbo replaces frame content.
+
+## Who Should Upgrade
+
+Upgrade from `1.1.0` or `1.1.1` if your application registers
+Achilles-managed components inside a Turbo Frame or on the frame root itself.
+
+There are no new application setup requirements in this patch release. Apps
+upgrading from versions before `1.1.0` should still read the
+[1.1.0 upgrade guide](../upgrading-to-1.1.0.md).
+
+## Fixed
+
+- Registered components in an outgoing Turbo Frame are now torn down and
+  deregistered immediately before Turbo invokes the frame renderer.
+- Cleanup runs from children to parents and includes the frame root when it is
+  registered as a component.
+- The original Turbo renderer keeps its receiver, arguments, return value, and
+  error behavior.
+- Incoming components continue to register through the existing DOM observer,
+  while ordinary non-Turbo removal behavior remains unchanged.
+- Starting and stopping an Achilles application manages the frame-render
+  listener without creating duplicates.
+
+## Compatibility
+
+This backward-compatible `1.1.x` patch intentionally moves frame-contained
+teardown earlier, while the outgoing component elements are still present,
+instead of relying on missing-element recovery after replacement.
+
+Achilles continues to require Turbo Rails `2.0.11` or newer. This release does
+not add dependencies or require an application migration.
+
+## Verification
+
+This release was verified with:
+
+```bash
+bin/rails test
+node --test test/javascript/*_test.mjs
+for file in $(rg --files app/javascript/achilles test/dummy/app/javascript test/javascript | rg "\.(js|mjs)$"); do node --input-type=module --check < "$file" || exit 1; done
+bin/rails test:system
+RAILS_ENV=test bin/rails app:assets:precompile
+gem build achilles.gemspec
+```
+
+The system suite covers a native Turbo Frame replacement with a registered
+frame root, nested outgoing components, incoming component registration and
+interaction, and browser-console error checks.
+
+## Links
+
+- [Changelog](../../CHANGELOG.md)
+- [Upgrade index](../upgrading.md)
+- [1.1.0 upgrade guide](../upgrading-to-1.1.0.md)

data/docs/upgrading.md

@@ -12,6 +12,7 @@ setup, component markup, lifecycle behavior, or public APIs.
 
 ## Release Notes
 
+- [Achilles 1.1.2](releases/v1.1.2.md)
 - [Achilles 1.1.1](releases/v1.1.1.md)
 - [Achilles 1.1.0](releases/v1.1.0.md)
 

data/lib/achilles/version.rb

@@ -1,3 +1,3 @@
 module Achilles
-  VERSION = "1.1.1"
+  VERSION = "1.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: achilles
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Jey Geethan
@@ -92,6 +92,7 @@ files:
 - docs/release-checklist.md
 - docs/releases/v1.1.0.md
 - docs/releases/v1.1.1.md
+- docs/releases/v1.1.2.md
 - docs/upgrading-to-1.1.0.md
 - docs/upgrading.md
 - docs/v1-roadmap.md