sentry-cli 2.46.0__tar.gz → 2.47.0__tar.gz

{sentry_cli-2.46.0 → sentry_cli-2.47.0}/Cargo.lock

@@ -1,6 +1,6 @@
 # This file is automatically @generated by Cargo.
 # It is not intended for manual editing.
-version = 3
+version = 4
 
 [[package]]
 name = "addr2line"
@@ -144,6 +144,13 @@ dependencies = [
  "regex",
 ]
 
+[[package]]
+name = "apple-catalog-parsing"
+version = "0.0.0"
+dependencies = [
+ "thiserror 2.0.12",
+]
+
 [[package]]
 name = "arbitrary"
 version = "1.4.1"
@@ -2685,10 +2692,11 @@ dependencies = [
 
 [[package]]
 name = "sentry-cli"
-version = "2.46.0"
+version = "2.47.0"
 dependencies = [
  "anyhow",
  "anylog",
+ "apple-catalog-parsing",
  "assert_cmd",
  "backoff",
  "brotli2",

{sentry_cli-2.46.0 → sentry_cli-2.47.0}/Cargo.toml

@@ -2,13 +2,16 @@
 authors = ["Armin Ronacher <armin.ronacher@active-4.com>"]
 build = "build.rs"
 name = "sentry-cli"
-version = "2.46.0"
+version = "2.47.0"
 edition = "2021"
-rust-version = "1.80"
+rust-version = "1.86"
+
+[workspace]
 
 [dependencies]
 anylog = "0.6.3"
 anyhow = { version = "1.0.69", features = ["backtrace"] }
+apple-catalog-parsing = { path = "apple-catalog-parsing", optional = true }
 backoff = "0.4.0"
 brotli2 = "0.3.2"
 bytecount = "0.6.3"
@@ -91,12 +94,25 @@ default = []
 managed = []
 with_crash_reporting = []
 
+# Feature flag for the mobile-app command, as it is still under development.
+# CI tests run against this flag, but we don't include it in release builds.
+unstable-mobile-app = ["apple-catalog-parsing"]
+
+[workspace.lints.clippy]
+allow-attributes = "warn"
+unnecessary-wraps = "warn"
+unwrap-used = "warn"
+
+[lints]
+workspace = true
+
 [target]
 
 [target."cfg(target_os = \"macos\")"]
 
 [target."cfg(target_os = \"macos\")".dependencies]
 mac-process-info = "0.2.0"
+apple-catalog-parsing = { path = "apple-catalog-parsing" }
 
 [target."cfg(unix)"]
 

{sentry_cli-2.46.0 → sentry_cli-2.47.0}/MANIFEST.in

@@ -1,2 +1,3 @@
 include build.rs Cargo.toml Cargo.lock
 recursive-include src *
+recursive-include apple-catalog-parsing *

{sentry_cli-2.46.0 → sentry_cli-2.47.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sentry_cli
-Version: 2.46.0
+Version: 2.47.0
 Summary: A command line utility to work with Sentry.
 Home-page: https://github.com/getsentry/sentry-cli
 Author: Sentry
@@ -43,7 +43,7 @@ Fastlane tools.
 
 ## Installation
 
-If you are on OS X or Linux, you can use the automated downloader which will fetch the latest release version for you and install it:
+If you are on macOS or Linux, you can use the automated downloader which will fetch the latest release version for you and install it:
 
     curl -sL https://sentry.io/get-cli/ | bash
 

{sentry_cli-2.46.0 → sentry_cli-2.47.0}/README.md

@@ -25,7 +25,7 @@ Fastlane tools.
 
 ## Installation
 
-If you are on OS X or Linux, you can use the automated downloader which will fetch the latest release version for you and install it:
+If you are on macOS or Linux, you can use the automated downloader which will fetch the latest release version for you and install it:
 
     curl -sL https://sentry.io/get-cli/ | bash
 

sentry_cli-2.47.0/apple-catalog-parsing/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "apple-catalog-parsing"
+edition = "2021"
+build = "build.rs"
+
+[dependencies]
+thiserror = "2.0.12"
+
+[lints]
+workspace = true

sentry_cli-2.47.0/apple-catalog-parsing/build.rs

@@ -0,0 +1,81 @@
+use std::env;
+use std::process::Command;
+
+fn main() {
+    let target = env::var("TARGET").expect("TARGET is set for build scripts");
+    let mut target_bits = target.split('-');
+
+    // https://rust-lang.github.io/rfcs/0131-target-specification.html#detailed-design
+    let mut arch = target_bits.next().expect("TARGET triple has an arch");
+    let _vendor = target_bits.next();
+    let platform = target_bits.next().expect("TARGET triple has a platform");
+
+    if platform != "darwin" {
+        return;
+    }
+
+    if arch == "aarch64" {
+        arch = "arm64"; // enforce Darwin naming conventions
+    }
+
+    println!("cargo:rerun-if-changed=native/swift/AssetCatalogParser");
+
+    let out_dir = env::var("OUT_DIR").expect("OUT_DIR is set for build scripts");
+
+    // Compile Swift code
+    let status = Command::new("swift")
+        .args([
+            "build",
+            "-c",
+            "release",
+            "--package-path",
+            "native/swift/AssetCatalogParser",
+            "--scratch-path",
+            &format!("{out_dir}/swift-scratch"),
+            "--triple",
+            &format!("{arch}-apple-macosx10.12"),
+        ])
+        .status()
+        .expect("Failed to compile SPM");
+
+    assert!(status.success(), "swift build failed");
+
+    // Create a static library of the Swift and Objective-C code
+    let status = Command::new("ar")
+        .args([
+            "crus",
+            &format!("{out_dir}/libswiftbridge.a"),
+            &format!(
+                "{out_dir}/swift-scratch/release/AssetCatalogParser.build/AssetCatalogReader.swift.o"
+            ),
+            &format!(
+                "{out_dir}/swift-scratch/release/ObjcSupport.build/safeValueForKey.m.o",
+            ),
+        ])
+        .status()
+        .expect("Failed to create static library");
+
+    assert!(status.success(), "ar failed");
+
+    // Add the new static library to search paths and link to it
+    println!("cargo:rustc-link-search=native={out_dir}");
+    println!("cargo:rustc-link-lib=static=swiftbridge");
+
+    // Link to CoreUI framework
+    println!("cargo:rustc-link-search=framework=/System/Library/PrivateFrameworks");
+    println!("cargo:rustc-link-lib=framework=CoreUI");
+
+    // Link to swift macOS support libraries for Swift runtime support on older macOS versions
+    let developer_dir = Command::new("xcode-select")
+        .args(["-p"])
+        .output()
+        .expect("Failed to get developer directory, please ensure Xcode is installed.");
+    let developer_dir_path = String::from_utf8(developer_dir.stdout)
+        .expect("Failed to convert developer directory to UTF-8")
+        .trim()
+        .to_string();
+
+    println!(
+        "cargo:rustc-link-search={developer_dir_path}/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/macosx"
+    );
+}

sentry_cli-2.47.0/apple-catalog-parsing/native/swift/AssetCatalogParser/Package.swift

@@ -0,0 +1,33 @@
+// swift-tools-version: 5.10
+
+import PackageDescription
+
+let package = Package(
+    name: "AssetCatalogParser",
+    platforms: [
+        .macOS(.v11),
+    ],
+    products: [
+        .library(
+            name: "AssetCatalogParser",
+            targets: ["AssetCatalogParser"]),
+    ],
+    targets: [
+        .target(
+            name: "AssetCatalogParser",
+            dependencies: ["ObjcSupport"],
+            linkerSettings: [
+              .unsafeFlags([
+                "-F", "/System/Library/PrivateFrameworks",
+                "-framework", "CoreUI",
+              ])
+            ]),
+        .target(name: "ObjcSupport"),
+        .testTarget(
+          name: "AssetCatalogParserTests",
+          dependencies: ["AssetCatalogParser"],
+          resources: [
+            .copy("Resources")
+          ])
+    ]
+)

sentry_cli-2.47.0/apple-catalog-parsing/native/swift/AssetCatalogParser/Sources/AssetCatalogParser/AssetCatalogReader.swift

@@ -0,0 +1,301 @@
+import CoreGraphics
+import Foundation
+import ImageIO
+import UniformTypeIdentifiers
+import ObjcSupport
+
+@_cdecl("swift_inspect_asset_catalog")
+// Insepects the asset catalog and writes the results to a JSON file
+// in the xcarchive containing the asset catalog.
+public func swift_inspect_asset_catalog(_ path: UnsafePointer<CChar>) {
+    let pathString = String(cString: path)
+    if #available(macOS 13.0, *) {
+        let supportedVersions = [13, 14, 15]
+        let version = ProcessInfo.processInfo.operatingSystemVersion
+        if supportedVersions.contains(version.majorVersion) {
+            AssetUtil.disect(file: URL(filePath: pathString))
+        } else {
+            print("Skipping asset catalog inspection on unsupported macOS version \(version)")
+        }
+    } else {
+        print("Skipping asset catalog inspection on macOS earlier than 13.0")
+    }
+}
+
+enum AssetType: Int, Encodable {
+    case image
+    case icon
+    case imageSet
+}
+
+struct AssetCatalogEntry: Encodable {
+    let imageId: String
+    let size: UInt
+    let name: String
+    let vector: Bool
+    let width: Int?
+    let height: Int?
+    let filename: String?
+    let type: AssetType?
+}
+
+enum Error: Swift.Error {
+  case pathError
+}
+
+typealias objectiveCMethodImp = @convention(c) (AnyObject, Selector, UnsafeRawPointer) -> Unmanaged<
+    AnyObject
+>?
+
+enum AssetUtil {
+    private static func createResultsPath(assetPath: URL) throws -> URL {
+        var archiveURL = assetPath
+        var tailComponents: [String] = []
+        while archiveURL.pathExtension != "xcarchive" && archiveURL.pathComponents.count > 1 {
+            tailComponents.insert(archiveURL.lastPathComponent, at: 0)
+            archiveURL.deleteLastPathComponent()
+        }
+        if archiveURL.pathExtension != "xcarchive" {
+            throw Error.pathError
+        }
+        let parsedRoot = archiveURL.appendingPathComponent("ParsedAssets",
+                                                           isDirectory: true)
+        let destDir = tailComponents
+            .dropLast()
+            .reduce(parsedRoot) { partial, next in
+                partial.appendingPathComponent(next, isDirectory: true)
+            }
+        try! FileManager.default.createDirectory(at: destDir,
+                                                 withIntermediateDirectories: true)
+        return destDir
+    }
+
+    @discardableResult static func disect(file: URL) -> [AssetCatalogEntry] {
+        var assets: [AssetCatalogEntry] = []
+        var colorLength: UInt = 0
+        var colorCount = 0
+
+        let (structuredThemeStore, assetKeys) = initializeCatalog(from: file)
+
+        var images: [String: CGImage] = [:]
+
+        for key in assetKeys {
+            let keyList = unsafeBitCast(
+                key.perform(Selector(("keyList"))),
+                to: UnsafeMutableRawPointer.self
+            )
+            let rendition = createRendition(from: structuredThemeStore, keyList)
+
+            let data = rendition.value(forKey: "_srcData") as! Data
+            let length = UInt(data.count)
+            let className = rendition.perform(Selector(("className"))).takeUnretainedValue() as! String
+            let renditionTypeName =
+                rendition.perform(Selector(("name"))).takeUnretainedValue() as! String
+
+            var packedAssetSize: UInt = 0
+            if renditionTypeName.hasPrefix("ZZZZPacked") {
+                packedAssetSize += length
+                continue
+            }
+
+            if handleReferenceKey(
+                rendition,
+                structuredThemeStore,
+                Selector(("renditionWithKey:")),
+                &packedAssetSize,
+                renditionTypeName,
+                length
+            ) {
+                continue
+            }
+
+            if className == "_CUIThemeColorRendition" {
+                colorCount += 1
+                colorLength += length
+                continue
+            }
+
+            let name = resolveRenditionName(
+                structuredThemeStore,
+                keyList,
+                renditionTypeName
+            )
+
+            let type = rendition.getUInt(forKey: "type") ?? 0
+
+            let isVector = type == 9
+            let (width, height, unslicedImage) = resolveImageDimensions(rendition, isVector)
+            let assetType = determineAssetType(key)
+            let imageId = UUID().uuidString
+            images[imageId] = unslicedImage
+
+            let asset = AssetCatalogEntry(
+                imageId: imageId,
+                size: length,
+                name: name,
+                vector: isVector,
+                width: width,
+                height: height,
+                filename: renditionTypeName,
+                type: assetType
+            )
+            assets.append(asset)
+        }
+
+        assets.append(AssetCatalogEntry(
+            imageId: "",
+            size: colorLength,
+            name: "\(colorCount) Color\(colorCount > 1 ? "s" : "")",
+            vector: false,
+            width: nil,
+            height: nil,
+            filename: nil,
+            type: nil
+        ))
+
+        let data = try! JSONEncoder().encode(assets)
+        let folder = try! createResultsPath(assetPath: file)
+        let url = folder
+            .appendingPathComponent("Assets")
+            .appendingPathExtension("json")
+        try! data.write(to: url, options: [])
+        for (id, cgImage) in images {
+            let fileURL = folder.appendingPathComponent(id)
+                .appendingPathExtension("png")
+
+            guard let dest = CGImageDestinationCreateWithURL(
+                fileURL as CFURL,
+                UTType.png.identifier as CFString,
+                1,
+                nil
+            )
+            else {
+                print("⚠️  Could not create destination for \(fileURL.path)")
+                continue
+            }
+
+            CGImageDestinationAddImage(dest, cgImage, nil)
+            CGImageDestinationFinalize(dest)
+        }
+        return assets
+    }
+
+    private static func initializeCatalog(from file: URL) -> (
+        themeStore: NSObject, assetKeys: [NSObject]
+    ) {
+        let catalogClass: NSObject.Type = NSClassFromString("CUICatalog")! as! NSObject.Type
+        var catalog: NSObject =
+            catalogClass.perform(Selector(("alloc"))).takeRetainedValue() as! NSObject
+        catalog =
+            catalog.perform(Selector(("initWithURL:error:")), with: file as NSURL, with: nil)
+                .takeUnretainedValue() as! NSObject
+        let structuredThemeStore =
+            catalog.perform(Selector(("_themeStore"))).takeUnretainedValue() as! NSObject
+        let assetStorage = structuredThemeStore.perform(Selector(("themeStore"))).takeUnretainedValue()
+        let assetKeys =
+            assetStorage.perform(Selector(("allAssetKeys"))).takeUnretainedValue() as! [NSObject]
+        return (structuredThemeStore, assetKeys)
+    }
+
+    private static func createRendition(from themeStore: NSObject, _ keyList: UnsafeMutableRawPointer)
+        -> NSObject
+    {
+        let renditionWithKeySelector = Selector(("renditionWithKey:"))
+        let renditionWithKeyMethod = themeStore.method(for: renditionWithKeySelector)!
+        let renditionWithKeyImp = unsafeBitCast(renditionWithKeyMethod, to: objectiveCMethodImp.self)
+        return renditionWithKeyImp(themeStore, renditionWithKeySelector, keyList)!.takeUnretainedValue()
+            as! NSObject
+    }
+
+    private static func handleReferenceKey(
+        _ rendition: NSObject,
+        _ themeStore: NSObject,
+        _: Selector,
+        _ packedAssetSize: inout UInt,
+        _: String,
+        _ length: UInt
+    ) -> Bool {
+        let referenceKey = safeValueForKey(rendition, "_referenceKey")
+        guard let referenceKey = referenceKey as? NSObject else { return false }
+
+        let referenceKeyList = unsafeBitCast(
+            referenceKey.perform(Selector(("keyList"))),
+            to: UnsafeMutableRawPointer.self
+        )
+        let referenceRendition = createRendition(from: themeStore, referenceKeyList)
+
+        if let result = referenceRendition.perform(Selector(("unslicedImage"))) {
+            let image = result.takeUnretainedValue() as! CGImage
+            if image.dataProvider?.data as? Data != nil {
+                packedAssetSize += length
+            }
+        }
+        return true
+    }
+
+    private static func determineAssetType(_ key: NSObject) -> AssetType {
+        let themeElement = key.getUInt(forKey: "themeElement") ?? 0
+        let themePart = key.getUInt(forKey: "themePart") ?? 0
+
+        if themeElement == 85, themePart == 220 {
+            return .icon
+        } else if themeElement == 9 {
+            return .imageSet
+        }
+        return .image
+    }
+
+    private static func resolveRenditionName(
+        _ structuredThemeStore: NSObject,
+        _ keyList: UnsafeMutableRawPointer,
+        _ renditionTypeName: String
+    ) -> String {
+        let renditionNameForKeyListSelector = Selector(("renditionNameForKeyList:"))
+        let renditionNameForKeyListMethod = structuredThemeStore.method(
+            for: renditionNameForKeyListSelector
+        )!
+        let renditionNameForKeyList = unsafeBitCast(
+            renditionNameForKeyListMethod,
+            to: objectiveCMethodImp.self
+        )
+
+        var renditionName: String?
+        if let result = renditionNameForKeyList(
+            structuredThemeStore,
+            renditionNameForKeyListSelector,
+            keyList
+        ) {
+            renditionName = result.takeUnretainedValue() as? String
+        }
+
+        let name = renditionTypeName == "CoreStructuredImage" ? renditionName : renditionTypeName
+        return name!
+    }
+
+    private static func resolveImageDimensions(_ rendition: NSObject, _ isVector: Bool) -> (
+        width: Int?, height: Int?, image: CGImage?
+    ) {
+        var unslicedImage: CGImage?
+        if let result = rendition.perform(Selector(("unslicedImage"))) {
+            unslicedImage = (result.takeUnretainedValue() as! CGImage)
+        }
+
+        var width: Int?
+        var height: Int?
+        if !isVector {
+            width = unslicedImage?.width
+            height = unslicedImage?.height
+        }
+
+        return (width, height, unslicedImage)
+    }
+}
+
+private extension NSObject {
+    func getUInt(forKey key: String) -> UInt? {
+        if let result = perform(Selector(key)) {
+            return UInt(bitPattern: result.toOpaque())
+        }
+        return nil
+    }
+}

sentry_cli-2.47.0/apple-catalog-parsing/native/swift/AssetCatalogParser/Sources/ObjcSupport/include/safeValueForKey.h

@@ -0,0 +1,10 @@
+//
+//  safeValueForKey.h
+//  AppSizeAnalyzer
+//
+//  Created by Itay Brenner on 29/4/25.
+//
+
+#import <Foundation/Foundation.h>
+
+id safeValueForKey(id object, NSString *key);

sentry_cli-2.47.0/apple-catalog-parsing/native/swift/AssetCatalogParser/Sources/ObjcSupport/safeValueForKey.m

@@ -0,0 +1,11 @@
+#import <Foundation/Foundation.h>
+#import "safeValueForKey.h"
+
+// Helper to call `valueForKey` without swift crashing
+id safeValueForKey(id object, NSString *key) {
+  @try {
+    return [object valueForKey:key];
+  } @catch (NSException *exception) {
+    return nil;
+  }
+}

sentry_cli-2.47.0/apple-catalog-parsing/native/swift/AssetCatalogParser/Tests/AssetCatalogParserTests/AssetCatalogParserTests.swift

@@ -0,0 +1,12 @@
+@testable import AssetCatalogParser
+import Testing
+import Foundation
+
+struct AssetCatalogParserTests {
+  @Test func testParseAssets() throws {
+    let archivePath = try #require(Bundle.module.path(forResource: "test", ofType: "xcarchive"))
+    let url = URL(filePath: "\(archivePath)/Products/Applications/DemoApp.app/Assets.car")
+    let results = AssetUtil.disect(file: url)
+    #expect(results.count == 2)
+  }
+}

sentry_cli-2.47.0/apple-catalog-parsing/native/swift/AssetCatalogParser/Tests/AssetCatalogParserTests/Resources/test.xcarchive/Info.plist

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>ApplicationProperties</key>
+	<dict>
+		<key>ApplicationPath</key>
+		<string>Applications/DemoApp.app</string>
+		<key>Architectures</key>
+		<array>
+			<string>arm64</string>
+		</array>
+		<key>CFBundleIdentifier</key>
+		<string>com.emerge.PreviewsDemoApp</string>
+		<key>CFBundleShortVersionString</key>
+		<string>1.0</string>
+		<key>CFBundleVersion</key>
+		<string>1</string>
+		<key>SigningIdentity</key>
+		<string>Apple Development: Noah Martin (5TV9RX846L)</string>
+		<key>Team</key>
+		<string>62J2XHNK9T</string>
+	</dict>
+	<key>ArchiveVersion</key>
+	<integer>2</integer>
+	<key>CreationDate</key>
+	<date>2024-03-02T16:16:02Z</date>
+	<key>Name</key>
+	<string>DemoApp</string>
+	<key>SchemeName</key>
+	<string>DemoApp</string>
+</dict>
+</plist>

sentry_cli-2.47.0/apple-catalog-parsing/src/asset_catalog.rs

@@ -0,0 +1,36 @@
+use std::ffi::CString;
+use std::os::unix::ffi::OsStrExt;
+use std::path::Path;
+use thiserror::Error;
+
+#[derive(Error, Debug)]
+#[non_exhaustive]
+pub enum Error {
+    #[error("Failed to convert path to C string: {0}")]
+    PathConversion(#[from] std::ffi::NulError),
+}
+
+extern "C" {
+    fn swift_inspect_asset_catalog(msg: *const std::os::raw::c_char);
+}
+
+/// This calls out to Swift code that uses Apple APIs to convert the contents
+/// of an asset catalog into a format that can be parsed by the
+/// size analysis backend. It enables main size analysis features such
+/// as duplicate image detection, xray, and image optimization insights.
+/// The path should be in an xcarchive file, results are written
+/// to a JSON file in the xcarchive’s ParsedAssets directory.
+pub fn inspect_asset_catalog<P>(path: P) -> Result<(), Error>
+where
+    P: AsRef<Path>,
+{
+    let c_string = CString::new(path.as_ref().as_os_str().as_bytes())?;
+    let string_ptr = c_string.as_ptr();
+    unsafe {
+        // The string pointed to is immutable, in Swift we cannot change it.
+        // We ensure this by using "UnsafePointer<CChar>" in Swift which is
+        // immutable (as opposed to "UnsafeMutablePointer<CChar>").
+        swift_inspect_asset_catalog(string_ptr);
+    }
+    Ok(())
+}

sentry_cli-2.47.0/apple-catalog-parsing/src/lib.rs

@@ -0,0 +1,5 @@
+#![cfg(target_os = "macos")]
+
+mod asset_catalog;
+
+pub use asset_catalog::inspect_asset_catalog;