Add autoLabels setting and Labels helper for Seqera executor [ci skip]

pditommaso · claude · pditommaso · commit 96d06fef7098 · 2026-02-06T21:58:03.000+01:00
Co-Authored-By: Claude Opus 4.6 &lt;noreply@anthropic.com&gt;
Signed-off-by: Paolo Di Tommaso &lt;paolo.ditommaso@gmail.com&gt;
diff --git a/docs/reference/config.md b/docs/reference/config.md
@@ -1512,8 +1512,11 @@ The following settings are available:
 `seqera.executor.region`
 : The AWS region for task execution (default: `'eu-central-1'`).
 
+`seqera.executor.autoLabels`
+: When `true`, automatically adds workflow metadata labels to the session with the `nextflow.io/` prefix (default: `false`). The following labels are added: `projectName`, `userName`, `runName`, `sessionId`, `resume`, `revision`, `commitId`, `repository`, `manifestName`, `runtimeVersion`. A `seqera.io/runId` label is also added, computed as a SipHash of the session ID and run name.
+
 `seqera.executor.labels`
-: Custom labels to apply to AWS resources for cost tracking and resource organization. Labels are propagated to ECS tasks, capacity providers, and EC2 instances.
+: Custom labels to apply to AWS resources for cost tracking and resource organization. Labels are propagated to ECS tasks, capacity providers, and EC2 instances. When used together with `autoLabels`, user-defined labels take precedence over auto-generated labels.
 
 `seqera.executor.machineRequirement.arch`
 : The CPU architecture for task execution, e.g. `'x86_64'` or `'arm64'`.
diff --git a/plugins/nf-seqera/src/main/io/seqera/config/ExecutorOpts.groovy b/plugins/nf-seqera/src/main/io/seqera/config/ExecutorOpts.groovy
@@ -72,6 +72,13 @@ class ExecutorOpts implements ConfigScope {
     """)
     final Map<String, String> labels
 
+    @ConfigOption
+    @Description("""
+        When `true`, automatically adds workflow metadata labels (e.g. project name,
+        run name, session ID) with the `nextflow.io/` prefix to the session (default: `false`).
+    """)
+    final boolean autoLabels
+
     /* required by config scope -- do not remove */
 
     ExecutorOpts() {}
@@ -91,6 +98,7 @@ class ExecutorOpts implements ConfigScope {
         this.machineRequirement = new MachineRequirementOpts(opts.machineRequirement as Map ?: Map.of())
         // labels for cost tracking
         this.labels = opts.labels as Map<String, String>
+        this.autoLabels = opts.autoLabels as boolean ?: false
     }
 
     RetryOpts retryOpts() {
@@ -120,4 +128,8 @@ class ExecutorOpts implements ConfigScope {
     Map<String, String> getLabels() {
         return labels
     }
+
+    boolean getAutoLabels() {
+        return autoLabels
+    }
 }
diff --git a/plugins/nf-seqera/src/main/io/seqera/executor/Labels.groovy b/plugins/nf-seqera/src/main/io/seqera/executor/Labels.groovy
@@ -0,0 +1,110 @@
+/*
+ * Copyright 2013-2025, Seqera Labs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package io.seqera.executor
+
+import com.google.common.hash.Hashing
+
+import groovy.transform.CompileStatic
+import nextflow.NextflowMeta
+import nextflow.script.WorkflowMetadata
+
+/**
+ * Helper class to manage session labels.
+ *
+ * Builds the labels map from workflow metadata ({@code nextflow.io/*}),
+ * scheduler metadata ({@code seqera:sched:*}), and user-configured labels.
+ *
+ * @author Paolo Di Tommaso <paolo.ditommaso@gmail.com>
+ */
+@CompileStatic
+class Labels {
+
+    private final Map<String,String> entries = new LinkedHashMap<>(20)
+
+    /**
+     * Add {@code nextflow.io/*} labels from workflow metadata
+     */
+    Labels withWorkflowMetadata(WorkflowMetadata workflow) {
+        if( workflow.projectName )
+            entries.put('nextflow.io/projectName', workflow.projectName)
+        if( workflow.userName )
+            entries.put('nextflow.io/userName', workflow.userName)
+        if( workflow.runName )
+            entries.put('nextflow.io/runName', workflow.runName)
+        if( workflow.sessionId )
+            entries.put('nextflow.io/sessionId', workflow.sessionId.toString())
+        entries.put('nextflow.io/resume', String.valueOf(workflow.resume))
+        if( workflow.sessionId && workflow.runName )
+            entries.put('seqera.io/runId', runId(workflow.sessionId.toString(), workflow.runName))
+        if( workflow.revision )
+            entries.put('nextflow.io/revision', workflow.revision)
+        if( workflow.commitId )
+            entries.put('nextflow.io/commitId', workflow.commitId)
+        if( workflow.repository )
+            entries.put('nextflow.io/repository', workflow.repository)
+        if( workflow.manifest?.name )
+            entries.put('nextflow.io/manifestName', workflow.manifest.name)
+        if( NextflowMeta.instance.version )
+            entries.put('nextflow.io/runtimeVersion', NextflowMeta.instance.version.toString())
+        return this
+    }
+
+    /**
+     * Add {@code seqera:sched:*} scheduler labels
+     */
+    Labels withSchedSessionId(String sessionId) {
+        if( sessionId )
+            entries.put('seqera:sched:sessionId', sessionId)
+        return this
+    }
+
+    Labels withSchedClusterId(String clusterId) {
+        if( clusterId )
+            entries.put('seqera:sched:clusterId', clusterId)
+        return this
+    }
+
+    /**
+     * Add user-configured labels. These take precedence over implicit labels.
+     */
+    Labels withUserLabels(Map<String,String> labels) {
+        if( labels )
+            entries.putAll(labels)
+        return this
+    }
+
+    /**
+     * @return all labels as an unmodifiable map
+     */
+    Map<String,String> getEntries() {
+        return Collections.unmodifiableMap(entries)
+    }
+
+    /**
+     * Compute a run identifier as SipHash of sessionId + runName
+     */
+    protected static String runId(String sessionId, String runName) {
+        return Hashing
+                .sipHash24()
+                .newHasher()
+                .putUnencodedChars(sessionId)
+                .putUnencodedChars(runName)
+                .hash()
+                .toString()
+    }
+}
diff --git a/plugins/nf-seqera/src/main/io/seqera/executor/SeqeraExecutor.groovy b/plugins/nf-seqera/src/main/io/seqera/executor/SeqeraExecutor.groovy
@@ -90,11 +90,15 @@ class SeqeraExecutor extends Executor implements ExtensionPoint {
 
     protected void createSession() {
         final towerConfig = session.config.tower as Map ?: Collections.emptyMap()
+        final labels = new Labels()
+        if( seqeraConfig.autoLabels )
+            labels.withWorkflowMetadata(session.workflowMetadata)
+        labels.withUserLabels(seqeraConfig.labels)
         final request = new CreateSessionRequest()
                 .region(seqeraConfig.region)
                 .name(session.runName)
                 .machineRequirement(MapperUtil.toMachineRequirement(seqeraConfig.machineRequirement))
-                .labels(seqeraConfig.labels)
+                .labels(labels.entries)
                 .workspaceId(PlatformHelper.getWorkspaceId(towerConfig, SysEnv.get()) as Long)
         log.debug "[SEQERA] Creating session: ${request}"
         final response = client.createSession(request)
diff --git a/plugins/nf-seqera/src/test/io/seqera/config/ExecutorOptsTest.groovy b/plugins/nf-seqera/src/test/io/seqera/config/ExecutorOptsTest.groovy
@@ -48,6 +48,7 @@ class ExecutorOptsTest extends Specification {
         config.machineRequirement != null
         config.machineRequirement.arch == null
         config.machineRequirement.provisioning == null
+        !config.autoLabels
     }
 
     def 'should create config with custom region' () {
@@ -163,4 +164,15 @@ class ExecutorOptsTest extends Specification {
         config.labels == [:]
     }
 
+    def 'should enable auto labels' () {
+        when:
+        def config = new ExecutorOpts([
+            endpoint: 'https://sched.example.com',
+            autoLabels: true
+        ])
+
+        then:
+        config.autoLabels
+    }
+
 }
diff --git a/plugins/nf-seqera/src/test/io/seqera/executor/LabelsTest.groovy b/plugins/nf-seqera/src/test/io/seqera/executor/LabelsTest.groovy
@@ -0,0 +1,161 @@
+/*
+ * Copyright 2013-2025, Seqera Labs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package io.seqera.executor
+
+import nextflow.NextflowMeta
+import nextflow.config.Manifest
+import nextflow.script.WorkflowMetadata
+import spock.lang.Specification
+
+/**
+ * Tests for Labels helper
+ *
+ * @author Paolo Di Tommaso <paolo.ditommaso@gmail.com>
+ */
+class LabelsTest extends Specification {
+
+    def 'should create labels with all workflow metadata'() {
+        given:
+        def sessionId = UUID.randomUUID()
+        def workflow = Mock(WorkflowMetadata) {
+            getProjectName() >> 'nf-core/rnaseq'
+            getUserName() >> 'pditommaso'
+            getRunName() >> 'crazy_darwin'
+            getSessionId() >> sessionId
+            isResume() >> true
+            getRevision() >> '3.12.0'
+            getCommitId() >> 'abc1234'
+            getRepository() >> 'https://github.com/nf-core/rnaseq'
+            getManifest() >> new Manifest([name: 'nf-core/rnaseq'])
+        }
+
+        when:
+        def labels = new Labels()
+                .withWorkflowMetadata(workflow)
+
+        then:
+        labels.entries['nextflow.io/projectName'] == 'nf-core/rnaseq'
+        labels.entries['nextflow.io/userName'] == 'pditommaso'
+        labels.entries['nextflow.io/runName'] == 'crazy_darwin'
+        labels.entries['nextflow.io/sessionId'] == sessionId.toString()
+        labels.entries['nextflow.io/resume'] == 'true'
+        labels.entries['nextflow.io/revision'] == '3.12.0'
+        labels.entries['nextflow.io/commitId'] == 'abc1234'
+        labels.entries['nextflow.io/repository'] == 'https://github.com/nf-core/rnaseq'
+        labels.entries['nextflow.io/manifestName'] == 'nf-core/rnaseq'
+        labels.entries['nextflow.io/runtimeVersion'] == NextflowMeta.instance.version.toString()
+        labels.entries['seqera.io/runId'] == Labels.runId(sessionId.toString(), 'crazy_darwin')
+    }
+
+    def 'should compute stable runId from sessionId and runName'() {
+        given:
+        def sid = 'e2315a82-49b0-4langc3-a58a-0d7d52f7e3a1'
+        def runName = 'crazy_darwin'
+
+        expect:
+        Labels.runId(sid, runName) == Labels.runId(sid, runName)
+        Labels.runId(sid, runName) != Labels.runId(sid, 'other_name')
+        Labels.runId(sid, runName) != Labels.runId(UUID.randomUUID().toString(), runName)
+    }
+
+    def 'should omit null workflow metadata from labels'() {
+        given:
+        def workflow = Mock(WorkflowMetadata) {
+            getProjectName() >> 'hello'
+            getUserName() >> 'user1'
+            getRunName() >> 'happy_turing'
+            getSessionId() >> UUID.randomUUID()
+            isResume() >> false
+            getRevision() >> null
+            getCommitId() >> null
+            getRepository() >> null
+            getManifest() >> new Manifest([:])
+        }
+
+        when:
+        def labels = new Labels()
+                .withWorkflowMetadata(workflow)
+
+        then:
+        labels.entries.containsKey('nextflow.io/projectName')
+        labels.entries.containsKey('nextflow.io/userName')
+        labels.entries.containsKey('nextflow.io/runName')
+        labels.entries.containsKey('nextflow.io/sessionId')
+        labels.entries['nextflow.io/resume'] == 'false'
+        !labels.entries.containsKey('nextflow.io/revision')
+        !labels.entries.containsKey('nextflow.io/commitId')
+        !labels.entries.containsKey('nextflow.io/repository')
+        !labels.entries.containsKey('nextflow.io/manifestName')
+    }
+
+    def 'should add scheduler labels'() {
+        when:
+        def labels = new Labels()
+                .withSchedSessionId('sched-session-123')
+                .withSchedClusterId('cluster-456')
+
+        then:
+        labels.entries['seqera:sched:sessionId'] == 'sched-session-123'
+        labels.entries['seqera:sched:clusterId'] == 'cluster-456'
+    }
+
+    def 'should skip null scheduler labels'() {
+        when:
+        def labels = new Labels()
+                .withSchedSessionId(null)
+                .withSchedClusterId(null)
+
+        then:
+        !labels.entries.containsKey('seqera:sched:sessionId')
+        !labels.entries.containsKey('seqera:sched:clusterId')
+    }
+
+    def 'should allow user labels to override implicit labels'() {
+        given:
+        def workflow = Mock(WorkflowMetadata) {
+            getProjectName() >> 'hello'
+            getUserName() >> 'user1'
+            getRunName() >> 'happy_turing'
+            getSessionId() >> UUID.randomUUID()
+            isResume() >> false
+            getManifest() >> new Manifest([:])
+        }
+
+        when:
+        def labels = new Labels()
+                .withWorkflowMetadata(workflow)
+                .withUserLabels([
+                    'nextflow.io/runName': 'custom_name',
+                    'team': 'research'
+                ])
+
+        then:
+        labels.entries['nextflow.io/runName'] == 'custom_name'
+        labels.entries['team'] == 'research'
+        labels.entries['nextflow.io/projectName'] == 'hello'
+    }
+
+    def 'should handle null user labels'() {
+        when:
+        def labels = new Labels()
+                .withUserLabels(null)
+
+        then:
+        labels.entries.isEmpty()
+    }
+}
