fix(core): provided image source can be unintentionally disposed (NativeScript#10654)

CatchABus · web-flow · commit a883a79e3bdf · 2025-01-12T18:12:06.000-08:00
diff --git a/packages/core/image-source/index.android.ts b/packages/core/image-source/index.android.ts
@@ -69,7 +69,7 @@ export class ImageSource implements ImageSourceDefinition {
 		this._rotationAngle = value;
 	}
 
-	constructor(nativeSource?: any) {
+	constructor(nativeSource?: android.graphics.Bitmap | android.graphics.drawable.Drawable) {
 		if (nativeSource) {
 			this.setNativeSource(nativeSource);
 		}
@@ -301,16 +301,20 @@ export class ImageSource implements ImageSourceDefinition {
 		return !!this.android;
 	}
 
-	public setNativeSource(source: any): void {
-		if (source && !(source instanceof android.graphics.Bitmap)) {
-			if (source instanceof android.graphics.drawable.Drawable) {
-				this.android = org.nativescript.widgets.Utils.getBitmapFromDrawable(source);
-				return;
-			}
+	public getNativeSource(): android.graphics.Bitmap | android.graphics.drawable.Drawable {
+		return this.android;
+	}
+
+	public setNativeSource(source: android.graphics.Bitmap | android.graphics.drawable.Drawable): void {
+		if (!source) {
+			this.android = null;
+		} else if (source instanceof android.graphics.Bitmap) {
+			this.android = source;
+		} else if (source instanceof android.graphics.drawable.Drawable) {
+			this.android = org.nativescript.widgets.Utils.getBitmapFromDrawable(source);
+		} else {
 			throw new Error('The method setNativeSource() expects an android.graphics.Bitmap or android.graphics.drawable.Drawable instance.');
 		}
-
-		this.android = source;
 	}
 
 	public saveToFile(path: string, format: 'png' | 'jpeg' | 'jpg', quality = 100): boolean {
diff --git a/packages/core/image-source/index.d.ts b/packages/core/image-source/index.d.ts
@@ -201,6 +201,11 @@ export class ImageSource {
 	 */
 	loadFromFontIconCode(source: string, font: Font, color: Color): boolean;
 
+	/**
+	 * Gets the native source object (typically a Bitmap or a UIImage).
+	 */
+	getNativeSource(): any;
+
 	/**
 	 * Sets the provided native source object (typically a Bitmap or a UIImage).
 	 * This will update either the android or ios properties, depending on the target os.
diff --git a/packages/core/image-source/index.ios.ts b/packages/core/image-source/index.ios.ts
@@ -49,7 +49,7 @@ export class ImageSource implements ImageSourceDefinition {
 		// compatibility with Android
 	}
 
-	constructor(nativeSource?: any) {
+	constructor(nativeSource?: UIImage) {
 		if (nativeSource) {
 			this.setNativeSource(nativeSource);
 		}
@@ -343,14 +343,20 @@ export class ImageSource implements ImageSourceDefinition {
 		return !!this.ios;
 	}
 
-	public setNativeSource(source: any): void {
-		if (source && !(source instanceof UIImage)) {
+	public getNativeSource(): UIImage {
+		return this.ios;
+	}
+
+	public setNativeSource(source: UIImage): void {
+		if (!source) {
+			this.ios = null;
+		} else if (source instanceof UIImage) {
+			this.ios = source;
+		} else {
 			if (Trace.isEnabled()) {
 				Trace.write('The method setNativeSource() expects UIImage instance.', Trace.categories.Binding, Trace.messageType.error);
 			}
-			return;
 		}
-		this.ios = source;
 	}
 
 	public saveToFile(path: string, format: 'png' | 'jpeg' | 'jpg', quality?: number): boolean {
diff --git a/packages/core/ui/image/image-common.ts b/packages/core/ui/image/image-common.ts
@@ -125,7 +125,9 @@ export abstract class ImageBase extends View implements ImageDefinition {
 			}
 		} else if (value instanceof ImageSource) {
 			// Support binding the imageSource trough the src property
-			this.imageSource = value;
+
+			// This will help avoid cleanup on the actual provided image source in case view gets disposed
+			this.imageSource = new ImageSource(value.getNativeSource());
 			this.isLoading = false;
 		} else if (value instanceof ImageAsset) {
 			ImageSource.fromAsset(value).then((result) => {

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ export class ImageSource implements ImageSourceDefinition {`
`49`	`49`	`// compatibility with Android`
`50`	`50`	`}`
`51`	`51`
`52`		`- constructor(nativeSource?: any) {`
	`52`	`+ constructor(nativeSource?: UIImage) {`
`53`	`53`	`if (nativeSource) {`
`54`	`54`	`this.setNativeSource(nativeSource);`
`55`	`55`	`}`
`@@ -343,14 +343,20 @@ export class ImageSource implements ImageSourceDefinition {`
`343`	`343`	`return !!this.ios;`
`344`	`344`	`}`
`345`	`345`
`346`		`- public setNativeSource(source: any): void {`
`347`		`- if (source && !(source instanceof UIImage)) {`
	`346`	`+ public getNativeSource(): UIImage {`
	`347`	`+ return this.ios;`
	`348`	`+ }`
	`349`	`+`
	`350`	`+ public setNativeSource(source: UIImage): void {`
	`351`	`+ if (!source) {`
	`352`	`+ this.ios = null;`
	`353`	`+ } else if (source instanceof UIImage) {`
	`354`	`+ this.ios = source;`
	`355`	`+ } else {`
`348`	`356`	`if (Trace.isEnabled()) {`
`349`	`357`	`Trace.write('The method setNativeSource() expects UIImage instance.', Trace.categories.Binding, Trace.messageType.error);`
`350`	`358`	`}`
`351`		`- return;`
`352`	`359`	`}`
`353`		`- this.ios = source;`
`354`	`360`	`}`
`355`	`361`
`356`	`362`	`public saveToFile(path: string, format: 'png' \| 'jpeg' \| 'jpg', quality?: number): boolean {`