Allow closures in file/url for trace,report,timeline,dag,weblog

docs/config.md

@@ -511,7 +511,7 @@ The following settings are available:
 : When `true` turns on the generation of the DAG file (default: `false`).
 
 `dag.file`
-: Graph file name (default: `dag-<timestamp>.dot`).
+: Graph file name or closure returning the file name (default: `dag-<timestamp>.dot`).
 
 `dag.overwrite`
 : When `true` overwrites any existing DAG file with the same name.
@@ -1245,7 +1245,7 @@ The following settings are available:
 : If `true` it create the workflow execution report.
 
 `report.file`
-: The path of the created execution report file (default: `report-<timestamp>.html`).
+: Report file name or closure returning the file name (default: `report-<timestamp>.html`).
 
 `report.overwrite`
 : When `true` overwrites any existing report file with the same name.
@@ -1358,7 +1358,7 @@ The following settings are available:
 : When `true` enables the generation of the timeline report file (default: `false`).
 
 `timeline.file`
-: Timeline file name (default: `timeline-<timestamp>.html`).
+: Timeline file name or closure returning the file name (default: `timeline-<timestamp>.html`).
 
 `timeline.overwrite`
 : When `true` overwrites any existing timeline file with the same name.
@@ -1402,7 +1402,7 @@ The following settings are available:
 : Comma separated list of fields to be included in the report. The available fields are listed at {ref}`this page <trace-fields>`.
 
 `trace.file`
-: Trace file name (default: `trace-<timestamp>.txt`).
+: Trace file name or closure returning the file name (default: `trace-<timestamp>.txt`).
 
 `trace.overwrite`
 : When `true` overwrites any existing trace file with the same name.

modules/nextflow/src/main/groovy/nextflow/Session.groovy

@@ -380,13 +380,17 @@ class Session implements ISession {
         this.disableRemoteBinDir = getExecConfigProp(null, 'disableRemoteBinDir', false)
         this.classesDir = FileHelper.createLocalDir()
         this.executorFactory = new ExecutorFactory(Plugins.manager)
-        this.observers = createObservers()
-        this.statsEnabled = observers.any { it.enableMetrics() }
         this.workflowMetadata = new WorkflowMetadata(this, scriptFile)
 
-        // configure script params
+        // configure script binding
         binding.setParams( (Map)config.params )
         binding.setArgs( new ScriptRunner.ArgsList(args) )
+        binding.setVariable( 'nextflow', NextflowMeta.instance )
+        binding.setVariable( 'workflow', workflowMetadata )
+
+        // configure observers
+        this.observers = createObservers()
+        this.statsEnabled = observers.any { it.enableMetrics() }
 
         cache = CacheFactory.create(uniqueId,runName).open()
 

modules/nextflow/src/main/groovy/nextflow/trace/DefaultObserverFactory.groovy

@@ -43,7 +43,7 @@ class DefaultObserverFactory implements TraceObserverFactory {
         if( !isEnabled )
             return
 
-        String fileName = config.navigate('report.file')
+        String fileName = config.navigateDynamic('report.file', session.binding)
         def maxTasks = config.navigate('report.maxTasks', ReportObserver.DEF_MAX_TASKS) as int
         if( !fileName ) fileName = ReportObserver.DEF_FILE_NAME
         def report = (fileName as Path).complete()
@@ -61,7 +61,7 @@ class DefaultObserverFactory implements TraceObserverFactory {
         if( !isEnabled )
             return
 
-        String fileName = config.navigate('timeline.file')
+        String fileName = config.navigateDynamic('timeline.file', session.binding)
         if( !fileName ) fileName = TimelineObserver.DEF_FILE_NAME
         def traceFile = (fileName as Path).complete()
         def observer = new TimelineObserver(traceFile)
@@ -74,7 +74,7 @@ class DefaultObserverFactory implements TraceObserverFactory {
         if( !isEnabled )
             return
 
-        String fileName = config.navigate('dag.file')
+        String fileName = config.navigateDynamic('dag.file', session.binding)
         if( !fileName ) fileName = GraphObserver.DEF_FILE_NAME
         def traceFile = (fileName as Path).complete()
         def observer = new GraphObserver(traceFile)
@@ -90,7 +90,7 @@ class DefaultObserverFactory implements TraceObserverFactory {
         if( !isEnabled )
             return
 
-        String fileName = config.navigate('trace.file')
+        String fileName = config.navigateDynamic('trace.file', session.binding)
         if( !fileName ) fileName = TraceFileObserver.DEF_FILE_NAME
         def traceFile = (fileName as Path).complete()
         def observer = new TraceFileObserver(traceFile)

modules/nf-commons/src/main/nextflow/extension/Bolts.groovy

@@ -559,6 +559,13 @@ class Bolts {
         return result!=null ? result : defValue
     }
 
+    static def navigateDynamic(Map self, String key, binding, defValue = null) {
+        def result = navigate(self, key, defValue)
+        return result instanceof Closure
+            ? cloneWith(result, binding).call()
+            : result
+    }
+
     /**
      * Converts {@code ConfigObject}s to a plain {@code Map}
      *

tests/checks/dynamic-trace-filepath.nf/.checks

@@ -0,0 +1,9 @@
+set -e
+
+echo ''
+$NXF_RUN -c ../../dynamic-trace-filepath.config | tee stdout
+
+session_id=$(grep "DEBUG nextflow.Session - Run name:" .nextflow.log | sed 's/.* //')
+expected="tracedir-${session_id}-foo/trace.txt"
+
+[[ `grep DEBUG .nextflow.log | grep 'Workflow started -- trace file:' | sed 's/.* //'` == *${expected} ]] || false

tests/dynamic-trace-file.config

@@ -0,0 +1,8 @@
+params {
+  test = "foo"
+}
+
+trace {
+  enabled = true
+  file = { "tracedir-${workflow.runName}-${params.test}/trace.txt" }
+}

tests/dynamic-trace-file.nf

@@ -0,0 +1,25 @@
+#!/usr/bin/env nextflow
+/*
+ * Copyright 2020-2022, Seqera Labs
+ * Copyright 2013-2019, Centre for Genomic Regulation (CRG)
+ *
+ * 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.
+ */
+
+process foo {
+  """
+  echo Hello
+  """
+}
+
+workflow { foo() }