sample is now generating config from pulled dependency

Author: ktoso

Package.swift

@@ -316,6 +316,7 @@ let package = Package(
         "JavaKitReflection",
         "JavaKitNetwork",
         "JavaTypes",
+        "JavaKitShared",
         "JavaKitConfigurationShared",
         "JavaKitDependencyResolver",
       ],
@@ -338,6 +339,7 @@ let package = Package(
         "JavaKitNetwork",
         "Java2SwiftLib",
         "JavaKitDependencyResolver",
+        "JavaKitShared",
       ],
 
       swiftSettings: [

Samples/JavaDependencySampleApp/Package.swift

@@ -51,10 +51,9 @@ let package = Package(
   ],
 
   products: [
-    .library(
-      name: "JavaKitExample",
-      type: .dynamic,
-      targets: ["JavaKitExample"]
+    .executable(
+      name: "JavaDependencySample",
+      targets: ["JavaDependencySample"]
     ),
   ],
 
@@ -63,11 +62,13 @@ let package = Package(
   ],
 
   targets: [
-    .target(
+    .executableTarget(
       name: "JavaDependencySample",
       dependencies: [
         .product(name: "JavaKit", package: "swift-java"),
+        .product(name: "JavaRuntime", package: "swift-java"),
         .product(name: "JavaKitFunction", package: "swift-java"),
+        "ReactiveStreams"
       ],
       swiftSettings: [
         .unsafeFlags(["-I\(javaIncludePath)", "-I\(javaPlatformIncludePath)"])
@@ -76,5 +77,20 @@ let package = Package(
         .plugin(name: "SwiftJavaPlugin", package: "swift-java"),
       ]
     ),
+
+    .target(
+      name: "ReactiveStreams",
+      dependencies: [
+        .product(name: "JavaKit", package: "swift-java"),
+        .product(name: "JavaRuntime", package: "swift-java"),
+      ],
+      swiftSettings: [
+        .unsafeFlags(["-I\(javaIncludePath)", "-I\(javaPlatformIncludePath)"])
+      ],
+      plugins: [
+        .plugin(name: "SwiftJavaPlugin", package: "swift-java"),
+      ]
+    ),
+
   ]
 )

Samples/JavaDependencySampleApp/Sources/Guava/swift-java.config

@@ -0,0 +1,8 @@
+{
+  "classes" : {
+  },
+  "classpath" : "\/Users\/ktoso\/.gradle\/caches\/modules-2\/files-2.1\/com.google.guava\/guava\/33.3.1-jre\/852f8b363da0111e819460021ca693cacca3e8db\/guava-33.3.1-jre.jar:\/Users\/ktoso\/.gradle\/caches\/modules-2\/files-2.1\/com.google.guava\/failureaccess\/1.0.2\/c4a06a64e650562f30b7bf9aaec1bfed43aca12b\/failureaccess-1.0.2.jar:\/Users\/ktoso\/.gradle\/caches\/modules-2\/files-2.1\/com.google.guava\/listenablefuture\/9999.0-empty-to-avoid-conflict-with-guava\/b421526c5f297295adef1c886e5246c39d4ac629\/listenablefuture-9999.0-empty-to-avoid-conflict-with-guava.jar:\/Users\/ktoso\/.gradle\/caches\/modules-2\/files-2.1\/com.google.code.findbugs\/jsr305\/3.0.2\/25ea2e8b0c338a877313bd4672d3fe056ea78f0d\/jsr305-3.0.2.jar:\/Users\/ktoso\/.gradle\/caches\/modules-2\/files-2.1\/org.checkerframework\/checker-qual\/3.43.0\/9425eee39e56b116d2b998b7c2cebcbd11a3c98b\/checker-qual-3.43.0.jar:\/Users\/ktoso\/.gradle\/caches\/modules-2\/files-2.1\/com.google.errorprone\/error_prone_annotations\/2.28.0\/59fc00087ce372de42e394d2c789295dff2d19f0\/error_prone_annotations-2.28.0.jar:\/Users\/ktoso\/.gradle\/caches\/modules-2\/files-2.1\/com.google.j2objc\/j2objc-annotations\/3.0.0\/7399e65dd7e9ff3404f4535b2f017093bdb134c7\/j2objc-annotations-3.0.0.jar",
+  "dependencies" : [
+    "com.google.guava:guava:33.3.1-jre"
+  ]
+}

Samples/JavaDependencySampleApp/Sources/JavaDependencySample/main.swift

@@ -14,3 +14,9 @@
 
 import JavaKit
 import JavaKitFunction
+import ReactiveStreams
+
+// Just showcasing that we imported the module
+let s: Subscriber<Int>? = nil
+
+print("Done.")

Samples/JavaDependencySampleApp/Sources/JavaDependencySample/swift-java.config

@@ -1,7 +1,7 @@
 {
   "dependencies": [
-    "org.reactivestreams:reactive-streams:1.0.4"
+    "com.google.guava:guava:33.3.1-jre"
   ],
   "__FIXME": "we should not need to express this classpath!",
-  "classPath": "JavaKit/build/classes/java/main:../../JavaKit/build/classes/java/main",
+  "classpath": "JavaKit/build/classes/java/main:../../JavaKit/build/classes/java/main",
 }

Samples/JavaDependencySampleApp/Sources/ReactiveStreams/.gitkeep

@@ -1,11 +1,24 @@
 #!/bin/sh
 
-# TODO:
+JAVASWIFT="../../.build/debug/Java2Swift"
 
-# downloads all the dependencies
-../../.build/debug/Java2Swift --fetch Sources/JavaDependencySample/swift-java.config
+MODULE_NAME=Guava
+MODULE_CONFIG_DIR=$(pwd)/Sources/$MODULE_NAME/
+MODULE_CONFIG_PATH="$MODULE_CONFIG_DIR/swift-java.config"
 
-"$JAVA_HOME/bin/java" \
-    -cp .build/plugins/outputs/javakitsampleapp/JavaKitExample/destination/JavaCompilerPlugin/Java \
-    -Djava.library.path=.build/debug \
-    "com.example.swift.JavaKitSampleMain"
+### 1) downloads all the dependencies
+"$JAVASWIFT" --fetch Sources/JavaDependencySample/swift-java.config \
+    --module-name "$MODULE_NAME" \
+    --output-directory "$MODULE_CONFIG_DIR"
+
+### 2) extract the config for the fetched dependency
+DEP_JAR_CP=$(jq .classpath "$MODULE_CONFIG_PATH")
+DEP_JAR_CP=$(echo "$DEP_JAR_CP" | tr -d '"') # trim the "..."
+# FIXME: "jar" is the wrong word for it
+# shellcheck disable=SC2086
+"$JAVASWIFT" --jar $DEP_JAR_CP \
+    --module-name "$MODULE_NAME" \
+    --existing-config amend
+
+### 3) make wrappers for the module
+"$JAVASWIFT" "$MODULE_CONFIG_PATH" --module-name "$MODULE_NAME"

Samples/JavaDependencySampleApp/Sources/ReactiveStreams/swift-java.config

@@ -22,13 +22,20 @@ import JavaKitDependencyResolver
 import JavaKitConfigurationShared
 
 extension JavaToSwift {
+
+  // TODO: make this perhaps "emit type mappings"
   mutating func emitConfiguration(
     forJarFile jarFileName: String,
-    classPath: String,
+    classpath: String,
     environment: JNIEnvironment
   ) throws {
-    var configuration = Configuration()
-    configuration.classPath = classPath
+    // Get a fresh or existing configuration we'll amend
+    var (amendExistingConfig, configuration) = try getBaseConfigurationForWrite()
+    if amendExistingConfig {
+      print("[java-swift] Amend existing swift-java.config file...")
+    } else {
+      configuration.classpath = classpath // TODO: is this correct?
+    }
 
     let jarFile = try JarFile(jarFileName, false, environment: environment)
     for entry in jarFile.entries()! {
@@ -44,15 +51,26 @@ extension JavaToSwift {
 
       let javaCanonicalName = String(entry.getName().replacing("/", with: ".")
         .dropLast(".class".count))
+
+      if let javaPackageFilter {
+        if !javaCanonicalName.hasPrefix(javaPackageFilter) {
+          // Skip classes which don't match our expected prefix
+          continue
+        }
+      }
+
+      if amendExistingConfig && configuration.classes?[javaCanonicalName] != nil {
+        // If we're amending an existing config, we never overwrite an existing
+        // class configuration. E.g. the user may have configured a custom name
+        // for a type.
+        continue
+      }
       configuration.classes?[javaCanonicalName] =
         javaCanonicalName.defaultSwiftNameForJavaClass
     }
 
     // Encode the configuration.
-    let encoder = JSONEncoder()
-    encoder.outputFormatting = [.prettyPrinted, .sortedKeys]
-    var contents = String(data: try encoder.encode(configuration), encoding: .utf8)!
-    contents.append("\n")
+    let contents = try configuration.renderJSON()
 
     // Write the file.
     try writeContents(

Samples/JavaDependencySampleApp/ci-validate.sh

@@ -12,52 +12,84 @@
 //
 //===----------------------------------------------------------------------===//
 
-import ArgumentParser
+import Foundation
 import Java2SwiftLib
 import JavaKit
 import Foundation
 import JavaKitJar
 import Java2SwiftLib
 import JavaKitDependencyResolver
 import JavaKitConfigurationShared
+import JavaKitShared
 
 extension JavaToSwift {
   func fetchDependencies(moduleName: String,
                          dependencies: [JavaDependencyDescriptor],
-                         baseClasspath: [String]) throws -> JavaClasspath {
+                         baseClasspath: [String],
+                         environment: JNIEnvironment) throws -> ResolvedDependencyClasspath {
     let deps = dependencies.map { $0.descriptionGradleStyle }
-    print("[debug][swift-java] Fetch dependencies: \(deps)")
-
-    let jvm = try JavaVirtualMachine.shared(classPath: baseClasspath)
-    // let jvm = try ensureDependencyResolverDependenciesLoaded(baseClasspath: baseClasspath)
+    print("[debug][swift-java] Resolve and fetch dependencies for: \(deps)")
+    let resolverClass = try JavaClass<DependencyResolver>(environment: environment)
 
-    let resolverClass = try JavaClass<DependencyResolver>(environment: jvm.environment())
-    let classpath = try resolverClass.resolveDependenciesToClasspath(
-      projectBaseDirectory: URL(fileURLWithPath: ".").path,
-      dependencies: deps)
+      let fullClasspath = try resolverClass.resolveDependenciesToClasspath(
+        projectBaseDirectory: URL(fileURLWithPath: ".").path,
+        dependencies: deps)
+        .split(separator: ":")
 
-    let entries = classpath.split(separator: ":")
-    let entryCount = entries.count
+    let classpathEntries = fullClasspath.filter {
+      $0.hasSuffix(".jar")
+    }
+    let classpath = classpathEntries.joined(separator: ":")
 
-    print("[info][swift-java] Resolved classpath for \(deps.count) dependencies of '\(moduleName)': classpath entries: \(entryCount)... ", terminator: "")
+    print("[info][swift-java] Resolved classpath for \(deps.count) dependencies of '\(moduleName)', classpath entries: \(classpathEntries.count), ", terminator: "")
     print("done.".green)
 
-    for entry in entries {
-      print("[debug][swift-java] Classpath entry: \(entry)")
-    }
+    return ResolvedDependencyClasspath(for: dependencies, classpath: classpath)
+  }
+}
 
-    return .init(classpath)
+extension JavaToSwift {
+  mutating func writeFetchDependencies(resolvedClasspath: ResolvedDependencyClasspath) throws {
+    var configuration = Configuration()
+    configuration.dependencies = resolvedClasspath.rootDependencies
+    configuration.classpath = resolvedClasspath.classpath
+
+    // Convert the artifact name to a module name
+    // e.g. reactive-streams -> ReactiveStreams
+    // TODO: Should we prefix them with `Java...`?
+    let targetModule = artifactIDAsModuleID(resolvedClasspath.rootDependencies.first!.artifactID)
+
+    // Encode the configuration.
+    let contents = try configuration.renderJSON()
+
+    // Write the file
+    try writeContents(
+      contents,
+      to: "swift-java.config",
+      description: "swift-java configuration file"
+    )
+  }
+
+  public func artifactIDAsModuleID(_ artifactID: String) -> String {
+    let components = artifactID.split(whereSeparator: { $0 == "-" })
+    let camelCased = components.map { $0.capitalized }.joined()
+    return camelCased
   }
 }
 
-struct JavaClasspath: CustomStringConvertible {
-  let value: String
+struct ResolvedDependencyClasspath: CustomStringConvertible {
+  /// The dependency identifiers this is the classpath for.
+  let rootDependencies: [JavaDependencyDescriptor]
+
+  /// Plain string representation of a Java classpath
+  let classpath: String
 
-  init(_ value: String) {
-    self.value = value
+  init(for rootDependencies: [JavaDependencyDescriptor], classpath: String) {
+    self.rootDependencies = rootDependencies
+    self.classpath = classpath
   }
 
   var description: String {
-    "JavaClasspath(value: \(value))"
+    "JavaClasspath(for: \(rootDependencies), classpath: \(classpath))"
   }
 }