Add resources to package #138

akesson · 2023-01-13T18:43:07Z

Added a --resource option to the cli which copies resources into the package and adds the appropriate Bundle extension.

chinedufn · 2023-01-13T20:59:23Z

Thanks a lot for working on this!

Can you explain what led you to wanting this feature and how/when you expect to use it?

This way we can evaluate the design and feel confident that we're taking the best approach.

I don't have much Swift experience and I'm not familiar with bundle extensions.
It this a good summary for me to ready -> https://developer.apple.com/documentation/foundation/bundle ?

akesson · 2023-01-14T15:41:07Z

Can you explain what led you to wanting this feature and how/when you expect to use it?

I'm creating a product which uses Leptos for building a server binary & client-side wasm and I want to package that into a Swift package in order to use it in a WebView-based iOS/macOS app. The server binary needs the site data (css, js, wasm etc) accessible, which is where this feature comes in handy.

I don't have much Swift experience and I'm not familiar with bundle extensions.

You make me curious. Why are you creating this (really good) swift-bridge?

See Bundling resources with a Swift package and SPM Resource

chinedufn

This is awesome, thanks so much for contributing this.

I think your work here will close #129 .

I left some questions and a few comments about adding tests. After those are addressed this LGTM and I can merge and cut a new release.

Thanks for your great work!

chinedufn · 2023-01-14T16:51:54Z

crates/swift-bridge-cli/src/clap_app.rs

@@ -100,4 +100,16 @@ fn create_package_command() -> Command<'static> {
                .required(true)
                .help("The name for the Swift Package"),
        )
+        .arg(
+            Arg::new("resource")


How did you land on the : separator approach? Were there any other alternatives considered?

Also, can we leave a TODO comment that whenever clap supports array arguments we should switch to switch to using [PathBuf; 2] instead clap-rs/clap#1682

TBH, it's not a great solution to use :, but I didn't really find any easy and good solution so I went for the easy one :)

Added the TODO

chinedufn · 2023-01-14T17:19:58Z

crates/swift-bridge-build/src/package.rs

@@ -18,6 +18,8 @@ pub struct CreatePackageConfig {
    pub out_dir: PathBuf,
    /// The name for the Swift package
    pub package_name: String,
+    /// Additional resources to copy into the package, first PathBuf is source and second is destination
+    pub resources: Vec<(PathBuf, PathBuf)>,


Can we make the semantics of the destination more clear?
Right now it's hard to tell what the destination is.

Maybe pub resources: Vec<BundleResource>

/// Describes a bundle resource to copy from some source path to some destination. /// /// The source is a path to an existing file or directory that you wish to bundle. /// /// The destination is a relative path that the resource will get copied to within the /// generated Swift package's `Sources/YourLibraryName` directory. /// /// # Examples /// /// ``` /// # use crate::CopyBundleResourceDesc; /// /// // If you are creating a Swift Package called "MyLibrary", this descriptor will /// // lead to the package generator copying the `/path/to/images` directory to the /// // the Swift package's `Sources/MyLibrary/assets/icons` directory. /// let resource = CopyBundleResourceDesc::new("/path/to/images", "assets/icons"); /// ``` pub struct CopyBundleResourceDesc { source: PathBuf, destination: PathBuf, } impl CopyBundleResourceDesc { /// See [`CopyBundleResourceDesc`] for documentation. /// /// # Panics /// Panics if the destination is an absolute path. pub fn new(source: impl Into<PathBuf>, destination: impl Into<PathBuf>) -> Self { let destination = destination.into(); assert!(destination.is_relative()); Self { source: source.into(), destination, } } }

Just a quick idea, open to other approaches.

Ok, refactoring into CopyBundleResourceDesc done.

chinedufn · 2023-01-14T17:26:27Z

SwiftRustIntegrationTestRunner/integration-test-create-swift-package/src/main.rs

@@ -15,5 +15,6 @@ fn main() {
        )]),
        out_dir: PathBuf::from("swift-package-rust-library-fixture/MySwiftPackage"),
        package_name: "MySwiftPackage".to_string(),
+        resources: vec![],


Can we add some resources?

A file resource-test.txt

A directory with 2 files `directory-with-files/{a,b}.txt

A directory that contains a directory that contains a file nested/directory/test.txt

Then right after this create_package call we can call a fn assert_resources_bundled

Which checks the "swift-package-rust-library-fixture/MySwiftPackage" Sources dir to make sure that the resources are in there.

Also, if there's a way to check that the resources are accessible on the Swift side, that would be great. Could check in here

swift-bridge/SwiftRustIntegrationTestRunner/swift-package-test-package/Tests/swift-package-test-packageTests/swift_package_test_packageTests.swift

Lines 5 to 17 in a207c24

final class swift_package_test_packageTests: XCTestCase {

func testPackageRun() throws {

XCTAssertEqual("Hello, From Rust!", hello_rust().toString())

}

func testInstantiateSharedStruct() throws {

XCTAssertEqual(SomeStruct(field: 1).field, 1);

}

func testInstantiateSharedStructUnnamed() throws {

XCTAssertEqual(UnnamedStruct(_0: 1)._0, 1);

}

}

chinedufn · 2023-01-14T17:26:35Z

Cargo.toml

@@ -40,3 +40,4 @@ members = [
  "examples/codegen-visualizer",
  "examples/rust-binary-calls-swift-package",
 ]
+default-members = ["crates/swift-bridge-cli"]


Can we remove this?

chinedufn · 2023-01-14T17:27:08Z

crates/swift-bridge-build/src/package.rs

+
+{bridge_swift}
+
+extension Bundle {{


What does this do?

Added comment in code

chinedufn · 2023-01-14T17:31:08Z

crates/swift-bridge-cli/src/clap_app.rs

+                .takes_value(true)
+                .value_name("SRC_PATH:DEST_PATH")
+                .multiple_values(true)
+                .help(


Can we update the book example to include bundling a resource?

swift-bridge/book/src/building/swift-packages/README.md

Lines 132 to 171 in 2783798

```rust

use std::path::PathBuf;

use std::collections::HashMap;

use swift_bridge_build::{CreatePackageConfig, ApplePlatform};

fn main() {

swift_bridge_build::create_package(CreatePackageConfig {

bridge_dir: PathBuf::from("./generated"),

paths: HashMap::from([

(ApplePlatform::IOS, "target/aarch64-apple-ios/debug/libmy_rust_lib.a".into()),

(ApplePlatform::Simulator, "target/universal-ios/debug/libmy_rust_lib.a".into()),

(ApplePlatform::MacOS, "target/universal-macos/debug/libmy_rust_lib.a".into()),

]),

out_dir: PathBuf::from("MySwiftPackage"),

package_name: PathBuf::from("MySwiftPackage")

});

}

```

#### CLI

You can use the `swift-bridge` CLI's `create-package` command in order to create a Swift Package.

First, install the CLI.

```bash

cargo install -f swift-bridge-cli

swift-bridge-cli --help

```

Then, run the following to package up your generated bridges and your Rust libraries into a Swift Package.

```bash

swift-bridge-cli create-package \

--bridges-dir ./generated \

--out-dir MySwiftPackage \

--ios target/aarch64-apple-ios/debug/libmy_rust_lib.a \

--simulator target/universal-ios/debug/libmy_rust_lib.a \

--macos target/universal-macos/debug/libmy_rust_lib.a \

--name MySwiftPackage

```

I added it to the end as it is not mandatory to add resources.

chinedufn · 2023-01-14T17:34:16Z

crates/swift-bridge-cli/src/clap_exec.rs

+    pairs
+        .into_iter()
+        .map(|pair| {
+            let mut split = pair.split(':');


Can we leave a comment explaining that this breaks for paths that contain :, i.e. "/path/to/my\:file.txt".

Or just assert_eq(pair.split(":").count(), 2) or something like that?

Since I would imagine we'll want to eventually switch to clap-rs/clap#1682 , not fixing this bug is fine.
I'm sure that way fewer than 1% of people would ever run into this in the meantime.

See: #138 (comment)

chinedufn · 2023-01-14T17:39:44Z

crates/swift-bridge-build/src/package.rs

@@ -328,12 +350,46 @@ let package = Package(
 		),
 		.target(
 			name: "{package_name}",
-			dependencies: ["RustXcframework"])
+			dependencies: ["RustXcframework"],
+			resources: [


Can we move the package string generation out into its own function

swift-bridge/crates/swift-bridge-build/src/package.rs

Lines 313 to 335 in 03de7ea

let package_swift = format!(

r#"// swift-tools-version:5.5.0

import PackageDescription

let package = Package(

name: "{package_name}",

products: [

.library(

name: "{package_name}",

targets: ["{package_name}"]),

],

dependencies: [],

targets: [

.binaryTarget(

name: "RustXcframework",

path: "RustXcframework.xcframework"

),

.target(

name: "{package_name}",

dependencies: ["RustXcframework"])

]

)

"#

);

Then add a test to the bottom of this file that generates the package description for the CreatePackageConfig that has resources and asserts on the contents of the generated string?

My main concern here is that right now the writing to disk / process spawning stuff is tightly coupled to things that it doesn't need to be (I know this was here before you, so not saying that you did that!).

So I'm asking to add a test for this resources thing so that we at least begin take a small step in the right direction and make it easier to make our Swift package creation more powerful over time.

I did make an effort to follow your (current) style of programming, imitating how things are done. I think it is better if you, as the owner of this project, set the new precedence instead of me as I will probably not do it as you like it.

Actually all of the package stuff was contributed by a contributor.

However, makes sense to me!

chinedufn · 2023-01-14T17:46:19Z

#138 (comment)

Ok thanks for explaining and thanks for the links. Read them. They were helpful.

You make me curious. Why are you creating this (really good) swift-bridge?

Thanks for the kindness, this made me smile.
I maintain an iOS app that uses SwiftUI for views and Rust for all of the logic. I quickly got tired of passing around pointers, and eventually came across cxx and got inspired to try the "bridge module" approach.

akesson · 2023-01-16T10:07:12Z

I'm afraid that I won't have more time to spend on this. Feel free to reject the PR if it is not up to your standards.

chinedufn · 2023-01-16T14:00:47Z

Ok thanks for the heads up.

It's just missing tests. I can take get them added when I have time. Thanks for your work!

akesson · 2023-01-16T15:12:26Z

Thanks to you and sorry if my previous comments were a bit snappy.

akesson · 2023-07-10T12:32:33Z

Closing this as my focus is now on UniFFI

akesson added 3 commits January 13, 2023 15:22

Update the doc to show how to add to workspace

d3858a2

Improvements of description

9102ced

Merge branch 'chinedufn:master' into master

5cea533

chinedufn mentioned this pull request Jan 13, 2023

Document how to add Swift files to a generated Swift Package #129

Open

chinedufn reviewed Jan 14, 2023

View reviewed changes

akesson added 12 commits February 6, 2023 10:34

Merge branch 'chinedufn:master' into master

11f4d3c

Add --resources cmd line args

699b348

Copy resources & add to Package.swift

0393ff3

Add bundle extension

55219a2

Extract copy_resources function

92bdf07

Add support for resource directories

18476bd

Add todo note for switching to array arg

506f7ed

Add comment about bundle extension

7aa5cb9

Refactor into CopyBundleResourceDesc

5ba2250

Fix doc test

73ae1a6

Remove default-members

8ba43db

Add "Adding resources" doc

29d54eb

akesson force-pushed the add-resources-to-package branch from 4cda9a7 to 29d54eb Compare February 6, 2023 09:36

akesson closed this Jul 10, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add resources to package #138

Add resources to package #138

akesson commented Jan 13, 2023

chinedufn commented Jan 13, 2023

akesson commented Jan 14, 2023

chinedufn left a comment

chinedufn Jan 14, 2023

akesson Jan 14, 2023

akesson Jan 16, 2023

chinedufn Jan 14, 2023

akesson Jan 16, 2023

chinedufn Jan 14, 2023

chinedufn Jan 14, 2023

akesson Jan 16, 2023

chinedufn Jan 14, 2023

akesson Jan 16, 2023

chinedufn Jan 14, 2023

akesson Jan 16, 2023

chinedufn Jan 14, 2023 •

edited

akesson Jan 16, 2023

chinedufn Jan 14, 2023

akesson Jan 16, 2023

chinedufn Jan 16, 2023

chinedufn commented Jan 14, 2023

akesson commented Jan 16, 2023

chinedufn commented Jan 16, 2023

akesson commented Jan 16, 2023

akesson commented Jul 10, 2023

	final class swift_package_test_packageTests: XCTestCase {
	func testPackageRun() throws {
	XCTAssertEqual("Hello, From Rust!", hello_rust().toString())
	}

	func testInstantiateSharedStruct() throws {
	XCTAssertEqual(SomeStruct(field: 1).field, 1);
	}

	func testInstantiateSharedStructUnnamed() throws {
	XCTAssertEqual(UnnamedStruct(_0: 1)._0, 1);
	}
	}

	```rust
	use std::path::PathBuf;
	use std::collections::HashMap;
	use swift_bridge_build::{CreatePackageConfig, ApplePlatform};
	fn main() {
	swift_bridge_build::create_package(CreatePackageConfig {
	bridge_dir: PathBuf::from("./generated"),
	paths: HashMap::from([
	(ApplePlatform::IOS, "target/aarch64-apple-ios/debug/libmy_rust_lib.a".into()),
	(ApplePlatform::Simulator, "target/universal-ios/debug/libmy_rust_lib.a".into()),
	(ApplePlatform::MacOS, "target/universal-macos/debug/libmy_rust_lib.a".into()),
	]),
	out_dir: PathBuf::from("MySwiftPackage"),
	package_name: PathBuf::from("MySwiftPackage")
	});
	}
	```

	#### CLI

	You can use the `swift-bridge` CLI's `create-package` command in order to create a Swift Package.

	First, install the CLI.

	```bash
	cargo install -f swift-bridge-cli
	swift-bridge-cli --help
	```

	Then, run the following to package up your generated bridges and your Rust libraries into a Swift Package.

	```bash
	swift-bridge-cli create-package \
	--bridges-dir ./generated \
	--out-dir MySwiftPackage \
	--ios target/aarch64-apple-ios/debug/libmy_rust_lib.a \
	--simulator target/universal-ios/debug/libmy_rust_lib.a \
	--macos target/universal-macos/debug/libmy_rust_lib.a \
	--name MySwiftPackage
	```

	let package_swift = format!(
	r#"// swift-tools-version:5.5.0
	import PackageDescription
	let package = Package(
	name: "{package_name}",
	products: [
	.library(
	name: "{package_name}",
	targets: ["{package_name}"]),
	],
	dependencies: [],
	targets: [
	.binaryTarget(
	name: "RustXcframework",
	path: "RustXcframework.xcframework"
	),
	.target(
	name: "{package_name}",
	dependencies: ["RustXcframework"])
	]
	)
	"#
	);


		{bridge_swift}

		extension Bundle {{

Add resources to package #138

Add resources to package #138

Conversation

akesson commented Jan 13, 2023

chinedufn commented Jan 13, 2023

akesson commented Jan 14, 2023

chinedufn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chinedufn Jan 14, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chinedufn commented Jan 14, 2023

akesson commented Jan 16, 2023

chinedufn commented Jan 16, 2023

akesson commented Jan 16, 2023

akesson commented Jul 10, 2023

chinedufn Jan 14, 2023 •

edited