Nuke 13 is an incremental release that takes more advantage of Swift Concurrency and Data Race Safety by introducing a globalImagePipelineActor on which its subsystems are all synchronized. It ensures thread-safety, removes 20 usages of@unchecked Sendable, and makes the framework even leaner with ~5% less code in the main module. The future versions will completely switch to Swift Concurrency, but it will require a couple of more iterations.

Requirement: Xcode 16.

• Increase deployment targets to iOS 14, tvOS 14, macOS 11, watchOS 7
• Add global actorImagePipelineActor.ImagePipeline,ImageTask,ImagePrefetcher, and some other internal types are synchronized on the new actor.
• Soft-deprecate closure-basedImagePipeline APIs
• Soft-deprecateImagePipeline Combine extension and move them toNukeExtensions
• RemoveImagePipeline.Configuration.callbackQueue
• Removequeue parameter fromImagePipelineloadImage andloadData method. The callbacks are now isolated to the@MainActor and are@Sendable.
• AddImageTask.isCancelling to make it easier to transition to Nuke 13 in case you were usingImageTask.state for checking for cancellation invoked by the client (this might change in the upcoming betas)
• RenameImagePipelineDelegate toImagePipeline.Delegate
• RemoveImagePipeline.DelegateimageTaskDidStart and other methods soft-deprecated in Nuke 12.7.
• RemoveImageRequest initializers acceptingdataPublisher (Combine) – use Swift Concurrency instead
• UpdateDataLoading protocol to use Swift Concurrency instead of closures
• DeprecateFetchImage Combine support

What's Changed

• Add Swift 6 compatibility
• Add@MainActor annotation toImageLoadingOptions.shared
• Fix image scale and orientation issue in thumbnail creation by@prabhuamol in#793
• DeprecateImagePipeline.Configuration.callbackQueue – this feature will be removed in Nuke 13
• ImagePrefetcher.didComplete closure is now annotated with@MainActor @Sendable
• Drop Xcode 14 support

New Contributors

• @prabhuamol made their first contribution in#793

Contributors

• DeprecateImagePipeline.Configuration.callbackQueue – this feature will be removed in Nuke 13
• ImagePrefetcher.didComplete closure is now annotated with@MainActor @Sendable
• Add@MainActor annotation toImageLoadingOptions.shared
• Drop Xcode 14 support

• Fix “unrecognized selector sent to instance” crash in NukeExtensions in a cross-dissolve transition on iOS < 17 by@ejensen in#792

Contributors

• Fix#789, an issue withImageProcessors.Resize failing to resize images with packed pixel formats

• Fix fade transition in some scenarios by@ejensen in#786
• RemovetaskDescription from network tasks by@ejensen in#785
• Temporarily revert the change introduced in v12.6 that would skip decompression for some image types – more info in#788

Contributors

This release contains major improvements to the Structured Concurrency support andImagePipeline internals.

• Addpreviews: AsyncStream<ImageResponse>,progress: AsyncStream<Progress>,image: PlatformImage async andresponse: ImageResponse async directly toImageTask and deprecateAsyncImageTask. These APIs have zero cost unless you use them.
• AddImageTask.Event and addevents: AsyncStream<Event> toImageTask for observingall events associated with the image loading.
• Improve the support forAsyncStream: a new stream is created every time you access the respective property to make it easier to have multiple consumers.
• AddImagePipelineDelegate/imageTask(:didReceiveEvent:pipeline:) and deprecate the previous methods it replaced (context: these methods were introduced inNuke 11.0 as the initial and misguided attempt at Structured Concurrency support that tried to borrow from theURLSession API design)
• (Internal) ReworkImagePipeline that accumulated a lot of cruft after the introduction of data tasks, Combine, Async/Await, and AsyncStream support in the previous releases.
• DeprecateImagePipeline/loadData(with:) andImagePipeline/data(with:) methods that acceptURL as parameters – use theImageRequest variants instead (these are rarely used and low-level APIs that don't require convenience variants)
• Remove@discardableResult fromImagePipeline/data(with:) async throws – it was never meant to be there
• RenameImageTask/progress toImageTask/currentProgress (warning: this is a small breaking change in the API)
• Fix some of the Strict Concurrency Checking & Swift 6 warnings preparing for the upcoming Swift releases
• Fix documentation forAsyncImageTask/previews that was previously specifying that it was delivering the previewsand the final image – it's only the previews.
• Fix#782, an issue with grayscale images (8 bpp) not being rendered correctly whenResize processor is used

🐛Call for Testing. This release contains some major internal changes to the core APIs. Please help with testing the newly introduced and the existingImagePipeline APIs, and report any issues before it gets shipped.

This release contains some major improvements to the Structured Concurrency support and introduced a re-engineeredImagePipeline.

• Addpreviews: AsyncStream<ImageResponse>,progress: AsyncStream<Progress>,image: PlatformImage async andreponse: ImageResponse async directly toImageTask and deprecateAsyncImageTask. These APIs have zero cost unless you use them.
• AddImageTask.Event and addevents: AsyncStream<Event> toImageTask for observingall events associated with the image loading.
• Improve the support forAsyncStream: a new stream is created every time you access the respective property to make it easier to have multiple consumers.
• AddImagePipelineDelegate/imageTask(:didReceiveEvent:pipeline:) and deprecate the previous methods it replaced (context: these methods were introduced inNuke 11.0 as the initial and misguided attempt at Structured Concurrency support that tried to borrow from theURLSession API design)
• (Internal) ReworkImagePipeline that accumulated a lot of cruft after the introduction of data tasks, Combine, Async/Await, and AsyncStream support in the previous releases.
• DeprecateImagePipeline/loadData(with:) andImagePipeline/data(with:) methods that acceptURL as parameters – use theImageRequest variants instead (these are rarely used and low-level APIs that don't require convenience variants)
• Remove@discardableResult fromImagePipeline/data(with:) async throws – it was never meant to be there
• RenameImageTask/progress toImageTask/currentProgress (warning: this is a small breaking change in the API)
• Fix some of the Strict Concurrency Checking & Swift 6 warnings preparing for the upcoming Swift releases
• Fix documentation forAsyncImageTask/previews that was previously specifying that it was delivering the previewsand the final image – it's only the previews.

Fixes

• Fix an issue with an optimization that is supposed to skip decompression if one or more processors are applied
• Fix a[Decompressor] Error -17102 decompressing image -- possibly corrupt console error message when usingImagePipeline.Configuration.isUsingPrepareForDisplay (disabled by default). The pipeline will now skip decompression for.png.
• Fix#705 with integration between thumbnail options (link) and original data caching: the original data is now stored without a thumbnail key
• Fix an issue where.storeAll and.automatic cache policies would not store the thumbnail data
• Fix#746 an issue withImageRequest.UserInfoKey.scaleKey not interacting correctly with coalescing
• Fix#763 SwiftUI Warning: Accessing StateObject's object without being installed on a View when usingonStart

Changes

• Add support for initializingImageProcessors.CoreImageFilter withCIFilter instances (fixes#758 )
• Add support for disk cache lookup for intermediate processed images (as opposed to only final and original as before)
• Add an optimization that loads local resources withfile anddata schemes quickly without usingDataLoader andURLSession. If you rely on the existing behavior, this optimization can be turned off using theisLocalResourcesSupportEnabled configuration option.#779
• Update the infrastructure for coalescing image-processing tasks to use the task-dependency used for other operations

Deprecations

• DeprecateImagePipeline.Configuration.dataCachingQueue and perform data cache lookups on the pipeline's queue, reducing the amount of context switching

What's Changed

• Fix Xcode 15.3 concurrency warnings when usingScreen.scale by@jszumski in#766
• AddshowPlaceholderOnFailure parameter to show placeholder in case of image loading failure by@mlight3 in#764
• Fix image loading test on iOS 17 by@woxtu in#768
• Update thumbnail key value forImageRequest by@woxtu in#769
• Remove trailing whitespaces by@woxtu in#767
• Applyif let shorthand syntax by@mlight3 in#762

New Contributors

• @AndrewSB made their first contribution in#755
• @mlight3 made their first contribution in#762
• @jszumski made their first contribution in#766

Full Changelog:12.4.0...12.5.0

Contributors