feat: remove FinalizationRegistry functionality

isaac-mason · Sep 26, 2023 · 257e988 · 257e988
1 parent 6723287
commit 257e988
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 64 deletions.
diff --git a/.changeset/wild-files-juggle.md b/.changeset/wild-files-juggle.md
@@ -0,0 +1,8 @@
+---
+'@recast-navigation/core': minor
+'recast-navigation': minor
+---
+
+feat: remove FinalizationRegistry functionality
+
+This was added to catch situations where `destroy()` is not called to free memory. It's current implementation isn't ideal and it adds a fair amount of complexity to the library, so it's being removed for now.
diff --git a/packages/recast-navigation-core/src/crowd.ts b/packages/recast-navigation-core/src/crowd.ts
@@ -1,4 +1,3 @@
-import { finalizer } from './finalizer';
 import type { NavMesh } from './nav-mesh';
 import { NavMeshQuery } from './nav-mesh-query';
 import { Raw } from './raw';
@@ -335,8 +334,6 @@ export class Crowd {
     this.navMeshQuery = new NavMeshQuery(
       new Raw.Module.NavMeshQuery(this.raw.getNavMeshQuery())
     );
-
-    finalizer.register(this);
   }
 
   /**
@@ -453,7 +450,6 @@ export class Crowd {
   }
 
   destroy(): void {
-    finalizer.unregister(this);
     Raw.Detour.freeCrowd(this.raw);
   }
 }
diff --git a/packages/recast-navigation-core/src/finalizer.ts b/packages/recast-navigation-core/src/finalizer.ts
diff --git a/packages/recast-navigation-core/src/nav-mesh-query.ts b/packages/recast-navigation-core/src/nav-mesh-query.ts
@@ -1,4 +1,3 @@
-import { finalizer } from './finalizer';
 import { NavMesh } from './nav-mesh';
 import { Arrays, Raw } from './raw';
 import type R from './raw-module';
@@ -26,7 +25,6 @@ export class NavMeshQuery {
     } else {
       this.raw = new Raw.Module.NavMeshQuery();
       this.raw.init(value.navMesh.raw, value.maxNodes ?? 2048);
-      finalizer.register(this);
     }
 
     this.defaultFilter = new Raw.Module.dtQueryFilter();
@@ -264,7 +262,6 @@ export class NavMeshQuery {
    * Destroys the NavMeshQuery instance
    */
   destroy(): void {
-    finalizer.unregister(this);
     this.raw.destroy();
   }
 }
diff --git a/packages/recast-navigation-core/src/nav-mesh.ts b/packages/recast-navigation-core/src/nav-mesh.ts
@@ -1,5 +1,4 @@
 import { DetourMeshTile, DetourOffMeshConnection, DetourPoly } from './detour';
-import { finalizer } from './finalizer';
 import { Raw } from './raw';
 import type R from './raw-module';
 import { Vector3, array, vec3 } from './utils';
@@ -9,8 +8,6 @@ export class NavMeshGetTilesAtResult {
 
   constructor(raw: R.NavMeshGetTilesAtResult) {
     this.raw = raw;
-
-    finalizer.register(this);
   }
 
   tiles(index: number): DetourMeshTile {
@@ -22,7 +19,6 @@ export class NavMeshGetTilesAtResult {
   }
 
   destroy(): void {
-    finalizer.unregister(this);
     Raw.Module.destroy(this.raw);
   }
 }
@@ -32,8 +28,6 @@ export class NavMeshRemoveTileResult {
 
   constructor(raw: R.NavMeshRemoveTileResult) {
     this.raw = raw;
-
-    finalizer.register(this);
   }
 
   data(): number[] {
@@ -45,7 +39,6 @@ export class NavMeshRemoveTileResult {
   }
 
   destroy(): void {
-    finalizer.unregister(this);
     Raw.Module.destroy(this.raw);
   }
 }
@@ -55,8 +48,6 @@ export class NavMeshCalcTileLocResult {
 
   constructor(raw: R.NavMeshCalcTileLocResult) {
     this.raw = raw;
-
-    finalizer.register(this);
   }
 
   tileX(): number {
@@ -68,7 +59,6 @@ export class NavMeshCalcTileLocResult {
   }
 
   destroy(): void {
-    finalizer.unregister(this);
     Raw.Module.destroy(this.raw);
   }
 }
@@ -78,8 +68,6 @@ export class NavMeshGetTileAndPolyByRefResult {
 
   constructor(raw: R.NavMeshGetTileAndPolyByRefResult) {
     this.raw = raw;
-
-    finalizer.register(this);
   }
 
   tile(): DetourMeshTile {
@@ -95,7 +83,6 @@ export class NavMeshGetTileAndPolyByRefResult {
   }
 
   destroy(): void {
-    finalizer.unregister(this);
     Raw.Module.destroy(this.raw);
   }
 }
@@ -105,8 +92,6 @@ export class NavMeshStoreTileStateResult {
 
   constructor(raw: R.NavMeshStoreTileStateResult) {
     this.raw = raw;
-
-    finalizer.register(this);
   }
 
   data(): number[] {
@@ -118,7 +103,6 @@ export class NavMeshStoreTileStateResult {
   }
 
   destroy(): void {
-    finalizer.unregister(this);
     Raw.Module.destroy(this.raw);
   }
 }
@@ -169,7 +153,6 @@ export class NavMesh {
 
   constructor(raw?: R.NavMesh) {
     this.raw = raw ?? new Raw.Module.NavMesh();
-    finalizer.register(this);
   }
 
   /**
@@ -543,7 +526,6 @@ export class NavMesh {
    */
   destroy(): void {
     this.raw.destroy();
-    finalizer.unregister(this);
     Raw.Module.destroy(this.raw);
   }
 }
diff --git a/packages/recast-navigation-core/src/tile-cache.ts b/packages/recast-navigation-core/src/tile-cache.ts
@@ -1,5 +1,4 @@
 import { NavMeshCreateParams } from './detour';
-import { finalizer } from './finalizer';
 import { NavMesh } from './nav-mesh';
 import { Raw } from './raw';
 import type R from './raw-module';
@@ -76,8 +75,6 @@ export class TileCache {
 
   constructor(raw?: R.TileCache) {
     this.raw = raw ?? new Raw.Module.TileCache();
-
-    finalizer.register(this);
   }
 
   /**
@@ -192,7 +189,6 @@ export class TileCache {
   }
 
   destroy(): void {
-    finalizer.unregister(this);
     this.raw.destroy();
   }
 }