commonMain.io.polywrap.wasm.WasmPackage.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of polywrap-client Show documentation
Polywrap Client for JVM and Android
There is a newer version: 0.10.4
package io.polywrap.wasm

import io.polywrap.core.FileReader
import io.polywrap.core.WrapPackage
import io.polywrap.core.Wrapper
import io.polywrap.core.wrap.WrapManifest
import uniffi.polywrap_native.FfiWrapPackage
import uniffi.polywrap_native.ffiWrapPackageFromBytecode

/**
 * Implementation of the [WrapPackage] interface for Wasm Wrap packages
 *
 * @param fileReader A [FileReader] instance used to read the package files, including the Wasm module and WRAP manifest
 */
@OptIn(ExperimentalUnsignedTypes::class)
data class WasmPackage(private val fileReader: FileReader) : WrapPackage, AutoCloseable {

    val ffiWrapPackage: FfiWrapPackage by lazy {
        val module = getWasmModule().getOrThrow()
        ffiWrapPackageFromBytecode(module.asUByteArray().asList())
    }

    /**
     * Creates a new [WasmPackage] instance with the given manifest buffer and wasm module buffer.
     *
     * @param manifestBuffer the manifest buffer
     * @param wasmModule the wasm module buffer
     * @param fileReader a file reader used to read other package files
     */
    constructor(manifestBuffer: ByteArray, wasmModule: ByteArray, fileReader: FileReader? = null) :
        this(FileReaderFactory.fromMemory(manifestBuffer, wasmModule, fileReader))

    /**
     * Creates a new [WasmPackage] instance with the given manifest buffer and file reader.
     *
     * @param manifestBuffer the manifest buffer
     * @param fileReader a file reader used to read other package files
     */
    constructor(manifestBuffer: ByteArray, fileReader: FileReader) : this(FileReaderFactory.fromManifest(manifestBuffer, fileReader))

    /**
     * Creates a new [WasmPackage] instance with the given wasm module and file reader.
     *
     * @param fileReader a file reader used to read other package files
     * @param wasmModule the wasm module buffer
     */
    constructor(fileReader: FileReader, wasmModule: ByteArray) : this(FileReaderFactory.fromWasmModule(wasmModule, fileReader))

    /**
     * Produce an instance of the WrapPackage's WRAP manifest
     *
     * @return A [WrapManifest] instance
     */
    override fun getManifest(): Result {
        val result = fileReader.readFile(FileReader.WRAP_MANIFEST_PATH)
        if (result.isFailure) {
            return Result.failure(Error("Wrapper does not contain a WRAP manifest"))
        }
        return WrapManifest.deserialize(result.getOrThrow())
    }

    /**
     * Construct an instance of the package's Wasm Wrapper
     *
     * @return A [WasmWrapper] instance
     *
     * @throws Exception if the package does not contain a Wasm module
     */
    override fun createWrapper(): Wrapper {
        return WasmWrapper(ffiWrapPackage.createWrapper())
    }

    /**
     * Retrieves the file at the specified path within the Wrap package.
     *
     * @param path The path to the file.
     * @return A [ByteArray] containing the file contents
     */
    override fun getFile(path: String): Result {
        val dataResult = fileReader.readFile(path)
        if (dataResult.isFailure) {
            Result.failure(Exception("WasmWrapper: File was not found.\nSubpath: $path"))
        }
        return dataResult
    }

    /**
     * Reads the Wasm module from the Wrap package using the provided [FileReader], and returns the module bytes
     *
     * @return The Wasm module bytes
     */
    fun getWasmModule(): Result {
        val result = fileReader.readFile(FileReader.WRAP_MODULE_PATH)
        if (!result.isSuccess) {
            return Result.failure(Exception("Wrapper does not contain a Wasm module"))
        }
        return result
    }

    override fun close() {
        ffiWrapPackage?.close()
    }
}