Merge pull request #38 from ZettaScaleLabs/user_attachment

User attachment

.github/ISSUE_TEMPLATE/release.yml

@@ -0,0 +1,29 @@
+name: Add an issue to the next release
+description: |
+  Add an issue as part of next release. 
+  This will be added to the current release project. 
+  You must be a contributor to use this template.
+labels: ["release"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Guidelines for a good issue**
+
+        *Is your release item related to a problem?*
+        A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+        *Describe the solution you'd like*
+        A clear and concise description of what you want to happen.
+
+        *Describe alternatives you've considered*
+        A clear and concise description of any alternative solutions or features you've considered.
+
+        *Additional context*
+        Add any other context about the release item request here.
+  - type: textarea
+    id: item
+    attributes:
+      label: "Describe the release item"
+    validations:
+      required: true

.github/workflows/ci.yml

@@ -5,9 +5,9 @@ name: CI
 
 on:
   push:
-    branches: ["**"]
+    branches: [ "**" ]
   pull_request:
-    branches: ["**"]
+    branches: [ "**" ]
   schedule:
     - cron: "0 6 * * 1-5"
   workflow_dispatch:
@@ -18,11 +18,11 @@ env:
 jobs:
   build:
     name: Build on ${{ matrix.os }}
-    runs-on: ["${{ matrix.os }}"]
+    runs-on: [ "${{ matrix.os }}" ]
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macOS-latest]
+        os: [ ubuntu-latest, macOS-latest ]
 
     steps:
       - uses: actions/checkout@v4
@@ -79,3 +79,26 @@ jobs:
     steps:
       - name: Check whether all jobs pass
         run: echo '${{ toJson(needs) }}' | jq -e 'all(.result == "success")'
+
+  # Publish snapshot packages. These jobs will only be triggered when the CI is executed on main.
+  publish_jvm_snapshot_package:
+    name: Publish JVM snapshot package
+    if: github.ref == 'refs/heads/main'
+    needs: ci
+    uses: ./.github/workflows/publish_jvm.yml
+    permissions:
+      contents: read
+      packages: write
+    with:
+      snapshot: true
+
+  publish_android_snapshot_package:
+    name: Publish Android snapshot package
+    if: github.ref == 'refs/heads/main'
+    needs: ci
+    uses: ./.github/workflows/publish_android.yml
+    permissions:
+      contents: read
+      packages: write
+    with:
+      snapshot: true

.github/workflows/enforce-linking-issues.yml

@@ -0,0 +1,10 @@
+name: Enforce linking issues
+
+on:
+  pull_request_target:
+    types: [opened, edited, labeled]
+
+jobs:
+  main:
+    uses: eclipse-zenoh/zenoh/.github/workflows/enforce-linking-issues.yml@main
+    secrets: inherit

.github/workflows/publish_android.yml

@@ -3,6 +3,13 @@ name: Publish Android
 on:
   release:
     types: [published]
+  workflow_call:
+    inputs:
+      snapshot:
+        required: true
+        type: boolean
+        description: 'If the publication is for a snapshot version.'
+        default: false
   workflow_dispatch:
 
 env:
@@ -49,9 +56,19 @@ jobs:
       - name: Validate Gradle wrapper
         uses: gradle/wrapper-validation-action@v1
 
+      - name: Set pub mode env var
+        # Note: This step is intended to allow publishing snapshot packages.
+        # It allows to optionally append the property -PSNAPSHOT to the gradle
+        # publication task on the next step, resulting in the package version
+        # following the convention '<version>-SNAPSHOT'.
+        run: |
+          if [[ "${{ inputs.snapshot }}" == "true" ]]; then
+            echo "PUB_MODE=-PSNAPSHOT" >> $GITHUB_ENV
+          fi
+
       - name: Gradle Publish Android Package
         uses: gradle/gradle-build-action@v2
         with:
-          arguments: publishAndroidReleasePublicationToGithubPackagesRepository
+          arguments: publishAndroidReleasePublicationToGithubPackagesRepository ${{ env.PUB_MODE }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/publish_jvm.yml

@@ -2,7 +2,14 @@ name: Publish JVM
 
 on:
   release:
-    types: [published]
+    types: [ published ]
+  workflow_call:
+    inputs:
+      snapshot:
+        required: true
+        type: boolean
+        description: 'If the publication is for a snapshot version.'
+        default: false
   workflow_dispatch:
 
 env:
@@ -153,9 +160,19 @@ jobs:
       - name: Validate Gradle wrapper
         uses: gradle/wrapper-validation-action@v1
 
+      - name: Set pub mode env var
+        # Note: This step is intended to allow publishing snapshot packages.
+        # It allows to optionally append the property -PSNAPSHOT to the gradle
+        # publication task on the next step, resulting in the package version
+        # following the convention '<version>-SNAPSHOT'.
+        run: |
+          if [[ "${{ inputs.snapshot }}" == "true" ]]; then
+            echo "PUB_MODE=-PSNAPSHOT" >> $GITHUB_ENV
+          fi
+
       - name: Gradle Publish JVM Package
         uses: gradle/gradle-build-action@v2
         with:
-          arguments: publishJvmPublicationToGithubPackagesRepository
+          arguments: publishJvmPublicationToGithubPackagesRepository ${{ env.PUB_MODE }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/update-release-project.yml

@@ -0,0 +1,14 @@
+name: Update release project
+
+on:
+  issues:
+    types: [opened, edited, labeled]
+  pull_request_target:
+    types: [closed]
+    branches:
+      - main
+
+jobs:
+  main:
+    uses: eclipse-zenoh/zenoh/.github/workflows/update-release-project.yml@main
+    secrets: inherit

build.gradle.kts

@@ -12,6 +12,8 @@
 //   ZettaScale Zenoh Team, <[email protected]>
 //
 
+val zenohGroup = "io.zenoh"
+val zenohVersion = "1.0.0"
 
 buildscript {
     repositories {
@@ -35,6 +37,9 @@ plugins {
 }
 
 subprojects {
+    group = zenohGroup
+    version = zenohVersion
+
     repositories {
         google()
         mavenCentral()

examples/build.gradle.kts

@@ -12,9 +12,6 @@
 //   ZettaScale Zenoh Team, <[email protected]>
 //
 
-group = "io.zenoh"
-version = "0.11.0-dev"
-
 plugins {
     kotlin("jvm")
 }

rust-toolchain

@@ -1 +1 @@
-1.72.0
+1.74.0

zenoh-java/build.gradle.kts

@@ -12,9 +12,6 @@
 //   ZettaScale Zenoh Team, <[email protected]>
 //
 
-group = "io.zenoh"
-version = "0.11.0-dev"
-
 plugins {
     id("com.android.library")
     kotlin("multiplatform")
@@ -121,6 +118,10 @@ kotlin {
     }
 
     publishing {
+        publications.withType<MavenPublication> {
+            version = project.version.toString() + if (project.hasProperty("SNAPSHOT")) "-SNAPSHOT" else ""
+        }
+
         repositories {
             maven {
                 name = "GithubPackages"

zenoh-java/src/commonMain/kotlin/io/zenoh/Session.kt

@@ -25,6 +25,7 @@ import io.zenoh.publication.Put
 import io.zenoh.query.*
 import io.zenoh.queryable.Query
 import io.zenoh.queryable.Queryable
+import io.zenoh.sample.Attachment
 import io.zenoh.sample.Sample
 import io.zenoh.selector.Selector
 import io.zenoh.subscriber.Reliability
@@ -387,12 +388,13 @@ class Session private constructor(private val config: Config) : AutoCloseable {
         timeout: Duration,
         target: QueryTarget,
         consolidation: ConsolidationMode,
-        value: Value?
+        value: Value?,
+        attachment: Attachment?,
     ): R? {
         if (jniSession == null) {
             throw sessionClosedException
         }
-        return jniSession?.performGet(selector, callback, onClose, receiver, timeout, target, consolidation, value)
+        return jniSession?.performGet(selector, callback, onClose, receiver, timeout, target, consolidation, value, attachment)
     }
 
     @Throws(ZenohException::class)

zenoh-java/src/commonMain/kotlin/io/zenoh/jni/JNIPublisher.kt

@@ -19,6 +19,7 @@ import io.zenoh.exceptions.ZenohException
 import io.zenoh.prelude.SampleKind
 import io.zenoh.publication.CongestionControl
 import io.zenoh.publication.Priority
+import io.zenoh.sample.Attachment
 import io.zenoh.value.Value
 
 /**
@@ -32,20 +33,39 @@ internal class JNIPublisher(private val ptr: Long) {
      * Put value through the publisher.
      *
      * @param value The [Value] to be put.
+     * @param attachment Optional [Attachment].
      */
     @Throws(ZenohException::class)
-    fun put(value: Value) {
-        putViaJNI(value.payload, value.encoding.knownEncoding.ordinal, ptr)
+    fun put(value: Value, attachment: Attachment?) {
+        putViaJNI(value.payload, value.encoding.knownEncoding.ordinal, attachment?.let { encodeAttachment(it) }, ptr)
     }
 
+    /**
+     * Write operation.
+     *
+     * @param kind The [SampleKind].
+     * @param value The [Value]  to be written.
+     * @param attachment Optional [Attachment].
+     */
     @Throws(ZenohException::class)
-    fun write(kind: SampleKind, value: Value) {
-        writeViaJNI(value.payload, value.encoding.knownEncoding.ordinal, kind.ordinal, ptr)
+    fun write(kind: SampleKind, value: Value, attachment: Attachment?) {
+        writeViaJNI(
+            value.payload,
+            value.encoding.knownEncoding.ordinal,
+            kind.ordinal,
+            attachment?.let { encodeAttachment(it) },
+            ptr
+        )
     }
 
+    /**
+     * Delete operation.
+     *
+     * @param attachment Optional [Attachment].
+     */
     @Throws(ZenohException::class)
-    fun delete() {
-        deleteViaJNI(ptr)
+    fun delete(attachment: Attachment?) {
+        deleteViaJNI(attachment?.let { encodeAttachment(it) }, ptr)
     }
 
     /**
@@ -106,13 +126,17 @@ internal class JNIPublisher(private val ptr: Long) {
 
     /** Puts through the native Publisher. */
     @Throws(ZenohException::class)
-    private external fun putViaJNI(valuePayload: ByteArray, valueEncoding: Int, ptr: Long)
+    private external fun putViaJNI(
+        valuePayload: ByteArray, valueEncoding: Int, encodedAttachment: ByteArray?, ptr: Long
+    )
 
     @Throws(ZenohException::class)
-    private external fun writeViaJNI(payload: ByteArray, encoding: Int, sampleKind: Int, ptr: Long)
+    private external fun writeViaJNI(
+        payload: ByteArray, encoding: Int, sampleKind: Int, encodedAttachment: ByteArray?, ptr: Long
+    )
 
     @Throws(ZenohException::class)
-    private external fun deleteViaJNI(ptr: Long)
+    private external fun deleteViaJNI(encodedAttachment: ByteArray?, ptr: Long)
 
     /** Frees the underlying native Publisher. */
     private external fun freePtrViaJNI(ptr: Long)

zenoh-java/src/commonMain/kotlin/io/zenoh/jni/JNIQuery.kt

@@ -38,6 +38,7 @@ internal class JNIQuery(private val ptr: Long) {
             sample.kind.ordinal,
             timestampEnabled,
             if (timestampEnabled) sample.timestamp!!.ntpValue() else 0,
+            sample.attachment?.let { encodeAttachment(it) },
         )
     }
 
@@ -58,7 +59,8 @@ internal class JNIQuery(private val ptr: Long) {
         valueEncoding: Int,
         sampleKind: Int,
         timestampEnabled: Boolean,
-        timestampNtp64: Long
+        timestampNtp64: Long,
+        attachment: ByteArray?,
     )
 
     @Throws(ZenohException::class)