Add manifest files generated from ksp into final jar #1094

raghulvelusamy · 2023-12-18T21:50:42Z

Fix for issue #991

Ensures to copy all generated files from KSP jar's Manifest folder to the final jar.
Adds tests to verify the same

examples/ksp/CoffeeAppService.java

src/test/kotlin/io/bazel/kotlin/builder/tasks/jvm/KotlinKSPMetaFilesCopyTest.kt

Bencodes · 2023-12-18T22:00:15Z

src/main/kotlin/io/bazel/kotlin/builder/utils/jars/JarExtractor.kt

@@ -42,7 +43,7 @@ open class JarExtractor protected constructor(
                    Files.createDirectories(target)
                  else -> jar.getInputStream(entry).use {
                    Files.createDirectories(target.parent)
-                    Files.copy(it, target)
+                    Files.copy(it, target, StandardCopyOption.REPLACE_EXISTING)


What happened here to need the REPLACE_EXISTING attribute?

since we are using the same generated classes directory for all the jar creation processes during KotlinCompile when its trying to copy there is a java.nio.file.FileAlreadyExistsException. This is to avoid that.

I think one common file that would be a duplicate is META-INF/MANIFEST.MF.

Bencodes · 2023-12-18T22:00:31Z

src/main/kotlin/io/bazel/kotlin/builder/tasks/jvm/CompilationTask.kt

+                val relativePath = srcJarsPath.relativize(path)
+                val destPath = Paths.get(directories.generatedClasses).resolve(relativePath)
+                destPath.parent.toFile().mkdirs()
+                Files.copy(path, destPath, StandardCopyOption.REPLACE_EXISTING)


And same here, is this actually needed?

same as this #1094

src/test/data/jvm/ksp/CoffeeAppService.java

src/test/data/jvm/ksp/CoffeeAppModel.kt

src/test/kotlin/io/bazel/kotlin/builder/tasks/jvm/KotlinKSPMetaFilesCopyTest.kt

MODULE.bazel

src/test/kotlin/io/bazel/kotlin/builder/tasks/BUILD.bazel

zalewskise · 2024-01-22T18:15:42Z

src/main/kotlin/io/bazel/kotlin/builder/tasks/jvm/CompilationTask.kt

    expandWithSources(
      SourceJarExtractor(
-        destDir = Paths.get(directories.temp).resolve("_srcjars"),
-        fileMatcher = IS_JVM_SOURCE_FILE,
+        destDir = Paths.get(directories.temp).resolve(SOURCE_JARS_DIR),
+        fileMatcher = { str: String -> IS_JVM_SOURCE_FILE.test(str) || "/$MANIFEST_DIR" in str },


I'm not fully aware of the whole compilation process but if we add this logic here, it will also run for jars generated by kapt (as it's based on whole input.sourceJarsList). Since the issue for missing manifest files seems to be related to ksp only, could we possibly put this expand logic in a place where it wouldn't affect kapt generated jars? 💭

@zalewskise I think we actually want this for Kapt as wellsince the meta directory could contain files needed in the final jar. One example that comes to mind is google-auto-service where it spits out information that's needed in the final jar.

raghulvelusamy requested review from ahumesky, cgruber, restingbull, Bencodes and nkoroste as code owners December 18, 2023 21:50