Add support for container build compression

docs/reference/config.md

@@ -1520,6 +1520,21 @@ The following settings are available:
 `wave.build.cacheRepository`
 : The container repository used to cache image layers built by the Wave service (note: the corresponding credentials must be provided in your Seqera Platform account).
 
+`wave.build.compression.mode`
+: :::{versionadded} 25.05.0-edge
+  :::
+: Defines the compression algorithm that should be used when building the container. Allowed values are: `gzip`, `estargz` and `zstd` (default: `gzip`).
+
+`wave.build.compression.level`
+: :::{versionadded} 25.05.0-edge
+  :::
+: Level of compression used when building a container depending the chosen algorithm: gzip, estargz (0-9) and zstd (0-22).
+   .
+`wave.build.compression.force`
+: :::{versionadded} 25.05.0-edge
+  :::
+: Forcefully apply compression option to all layers, including already existing layers (default: `false`).
+
 `wave.build.conda.basePackages`
 : One or more Conda packages to be always added in the resulting container (default: `conda-forge::procps-ng`).
 

modules/nf-lang/src/main/java/nextflow/config/scopes/WaveBuildConfig.java

@@ -37,6 +37,8 @@ public class WaveBuildConfig implements ConfigScope {
 
     public WaveBuildSpackConfig spack;
 
+    public WaveBuildCompression compression;
+
 }
 
 class WaveBuildCondaConfig implements ConfigScope {
@@ -76,3 +78,23 @@ class WaveBuildSpackConfig implements ConfigScope {
     public String commands;
 
 }
+
+class WaveBuildCompression implements ConfigScope {
+    @ConfigOption
+    @Description("""
+        Defines the compression algorithm that should be used when building the container. Allowed values are: `gzip`, `estargz` and `zstd` (default: `gzip`).
+    """)
+    public String mode;
+
+    @ConfigOption
+    @Description("""
+        Level of compression used when building a container depending the chosen algorithm: gzip, estargz (0-9) and zstd (0-22).
+    """)
+    public Integer level;
+
+    @ConfigOption
+    @Description("""
+        Forcefully apply compression option to all layers, including already existing layers (default: `false`).
+    """)
+    public boolean force;
+}

plugins/nf-wave/build.gradle

@@ -37,7 +37,7 @@ dependencies {
     api 'org.apache.commons:commons-lang3:3.12.0'
     api 'com.google.code.gson:gson:2.10.1'
     api 'org.yaml:snakeyaml:2.2'
-    api 'io.seqera:wave-api:0.15.1'
+    api 'io.seqera:wave-api:0.16.0'
     api 'io.seqera:wave-utils:0.15.1'
 
     testImplementation(testFixtures(project(":nextflow")))

plugins/nf-wave/src/main/io/seqera/wave/plugin/SubmitContainerTokenRequest.groovy

@@ -21,6 +21,7 @@ package io.seqera.wave.plugin
 import groovy.transform.CompileStatic
 import groovy.transform.EqualsAndHashCode
 import groovy.transform.ToString
+import io.seqera.wave.api.BuildCompression
 import io.seqera.wave.api.ImageNameStrategy
 import io.seqera.wave.api.PackagesSpec
 import io.seqera.wave.api.ScanLevel
@@ -154,4 +155,9 @@ class SubmitContainerTokenRequest {
      */
     List<ScanLevel> scanLevels
 
+    /**
+     * Model build compression option
+     */
+    BuildCompression buildCompression
+
 }

plugins/nf-wave/src/main/io/seqera/wave/plugin/WaveClient.groovy

@@ -230,7 +230,8 @@ class WaveClient {
                 dryRun: ContainerInspectMode.dryRun(),
                 mirror: config.mirrorMode(),
                 scanMode: config.scanMode(),
-                scanLevels: config.scanAllowedLevels()
+                scanLevels: config.scanAllowedLevels(),
+                buildCompression: config.buildCompression()
         )
     }
 
@@ -257,7 +258,8 @@ class WaveClient {
                 dryRun: ContainerInspectMode.dryRun(),
                 mirror: config.mirrorMode(),
                 scanMode: config.scanMode(),
-                scanLevels: config.scanAllowedLevels()
+                scanLevels: config.scanAllowedLevels(),
+                buildCompression: config.buildCompression()
         )
         return sendRequest(request)
     }

plugins/nf-wave/src/main/io/seqera/wave/plugin/config/WaveConfig.groovy

@@ -20,6 +20,7 @@ package io.seqera.wave.plugin.config
 import groovy.transform.CompileStatic
 import groovy.transform.ToString
 import groovy.util.logging.Slf4j
+import io.seqera.wave.api.BuildCompression
 import io.seqera.wave.api.ScanLevel
 import io.seqera.wave.api.ScanMode
 import io.seqera.wave.config.CondaOpts
@@ -53,6 +54,7 @@ class WaveConfig {
     final private Boolean mirrorMode
     final private ScanMode scanMode
     final private List<ScanLevel> scanAllowedLevels
+    final private BuildCompression buildCompression
 
     WaveConfig(Map opts, Map<String,String> env=System.getenv()) {
         this.enabled = opts.enabled
@@ -72,6 +74,7 @@ class WaveConfig {
         this.buildMaxDuration = opts.navigate('build.maxDuration', '40m') as Duration
         this.scanMode = opts.navigate('scan.mode') as ScanMode
         this.scanAllowedLevels = parseScanLevels(opts.navigate('scan.allowedLevels'))
+        this.buildCompression = parseCompression(opts.navigate('build.compression') as Map)
         // some validation
         validateConfig()
     }
@@ -102,6 +105,8 @@ class WaveConfig {
 
     Duration buildMaxDuration() { buildMaxDuration }
 
+    BuildCompression buildCompression() { buildCompression }
+
     private void validateConfig() {
         def scheme= FileHelper.getUrlProtocol(endpoint)
         if( scheme !in ['http','https'] )
@@ -191,4 +196,17 @@ class WaveConfig {
         }
         throw new IllegalArgumentException("Invalid value for 'wave.scan.levels' setting - offending value: $value; type: ${value.getClass().getName()}")
     }
+
+    protected BuildCompression parseCompression(Map opts) {
+        if( !opts )
+            return null
+        final result = new BuildCompression()
+        if( opts.mode )
+            result.mode = BuildCompression.Mode.valueOf(opts.mode.toString().toLowerCase())
+        if( opts.level )
+            result.level = opts.level as Integer
+        if( opts.force )
+            result.force = opts.force as Boolean
+        return result
+    }
 }

plugins/nf-wave/src/test/io/seqera/wave/plugin/WaveClientTest.groovy

@@ -34,6 +34,7 @@ import com.sun.net.httpserver.HttpServer
 import groovy.json.JsonOutput
 import groovy.transform.CompileStatic
 import groovy.util.logging.Slf4j
+import io.seqera.wave.api.BuildCompression
 import io.seqera.wave.api.BuildStatusResponse
 import io.seqera.wave.api.ContainerStatus
 import io.seqera.wave.api.ContainerStatusResponse
@@ -281,6 +282,27 @@ class WaveClientTest extends Specification {
         req.timestamp instanceof String
     }
 
+    def 'should create request object with build compression' () {
+        given:
+        def session = Mock(Session) { getConfig() >> [wave:[build:[compression:[mode:'estargz', level:11]]]]}
+        def IMAGE =  'foo:latest'
+        def wave = new WaveClient(session)
+
+        when:
+        def req = wave.makeRequest(WaveAssets.fromImage(IMAGE))
+        then:
+        req.containerImage == IMAGE
+        !req.containerPlatform
+        !req.containerFile
+        !req.condaFile
+        !req.containerConfig.layers
+        and:
+        req.buildCompression == new BuildCompression().withMode(BuildCompression.Mode.estargz).withLevel(11)
+        and:
+        req.fingerprint == 'bd2cb4b32df41f2d290ce2366609f2ad'
+        req.timestamp instanceof String
+    }
+
     def 'should create request object with dry-run mode' () {
         given:
         ContainerInspectMode.activate(true)

plugins/nf-wave/src/test/io/seqera/wave/plugin/config/WaveConfigTest.groovy

@@ -17,6 +17,7 @@
 
 package io.seqera.wave.plugin.config
 
+import io.seqera.wave.api.BuildCompression
 import io.seqera.wave.api.ScanLevel
 import io.seqera.wave.api.ScanMode
 import nextflow.util.Duration
@@ -185,7 +186,7 @@ class WaveConfigTest extends Specification {
         given:
         def config = new WaveConfig([enabled: true])
         expect:
-        config.toString() == 'WaveConfig(enabled:true, endpoint:https://wave.seqera.io, containerConfigUrl:[], tokensCacheMaxDuration:30m, condaOpts:CondaOpts(mambaImage=mambaorg/micromamba:1.5.10-noble; basePackages=conda-forge::procps-ng, commands=null), strategy:[container, dockerfile, conda], bundleProjectResources:null, buildRepository:null, cacheRepository:null, retryOpts:RetryOpts(delay:450ms, maxDelay:1m 30s, maxAttempts:10, jitter:0.25), httpClientOpts:HttpOpts(), freezeMode:null, preserveFileTimestamp:null, buildMaxDuration:40m, mirrorMode:null, scanMode:null, scanAllowedLevels:null)'
+        config.toString() == 'WaveConfig(enabled:true, endpoint:https://wave.seqera.io, containerConfigUrl:[], tokensCacheMaxDuration:30m, condaOpts:CondaOpts(mambaImage=mambaorg/micromamba:1.5.10-noble; basePackages=conda-forge::procps-ng, commands=null), strategy:[container, dockerfile, conda], bundleProjectResources:null, buildRepository:null, cacheRepository:null, retryOpts:RetryOpts(delay:450ms, maxDelay:1m 30s, maxAttempts:10, jitter:0.25), httpClientOpts:HttpOpts(), freezeMode:null, preserveFileTimestamp:null, buildMaxDuration:40m, mirrorMode:null, scanMode:null, scanAllowedLevels:null, buildCompression:null)'
     }
 
     def 'should not allow invalid setting' () {
@@ -257,7 +258,24 @@ class WaveConfigTest extends Specification {
         'low,high'          | List.of(ScanLevel.LOW,ScanLevel.HIGH)
         'LOW, HIGH'         | List.of(ScanLevel.LOW,ScanLevel.HIGH)
         ['medium','high']   | List.of(ScanLevel.MEDIUM,ScanLevel.HIGH)
+    }
 
+    def 'should validate build compression' () {
+        expect:
+        new WaveConfig(build: [compression: COMPRESSION]).buildCompression() == EXPECTED
+        where:
+        COMPRESSION         | EXPECTED
+        null                | null
+        [mode:'gzip']       | BuildCompression.gzip
+        [mode:'estargz']    | BuildCompression.estargz
+        and:
+        [mode:'gzip', level: 1]   | new BuildCompression().withMode(BuildCompression.Mode.gzip).withLevel(1)
+        [mode:'estargz', level: 2]| new BuildCompression().withMode(BuildCompression.Mode.estargz).withLevel(2)
+        [mode:'zstd', level: 3]   | new BuildCompression().withMode(BuildCompression.Mode.zstd).withLevel(3)
+        and:
+        [mode:'gzip', level: 1, force:true]     | new BuildCompression().withMode(BuildCompression.Mode.gzip).withLevel(1).withForce(true)
+        [mode:'estargz', level: 2, force:true ] | new BuildCompression().withMode(BuildCompression.Mode.estargz).withLevel(2).withForce(true)
+        [mode:'zstd', level: 3,force:true]      | new BuildCompression().withMode(BuildCompression.Mode.zstd).withLevel(3).withForce(true)
     }
 
 }