dagger.Platform optionals | Dagger | Page 1

cloud void Sep 2, 2024, 2:27 PM

#

hm, i can't seem to repro on v0.12.6 😢
i've got the following module:

package main

import (
    "dagger/foo/internal/dagger"
)

type Foo struct{}

// Returns a container that echoes whatever string argument is provided
func (m *Foo) Thing(
    // +optional
    platform dagger.Platform,
) string {
    return "hello"
}

calling this works as expected:

dagger call thing
Full trace at https://dagger.cloud/jedevc/traces/903f0d8b93404c95eea6c7247ee3fc7e

✔ connect 0.8s
✔ initialize 5.1s
✔ prepare 0.0s
✔ foo: Foo! 0.0s
✔ Foo.thing: String! 0.9s

hello

#

we also have this usage in our own ci: https://github.com/dagger/dagger/blob/8a987be450e7920823b0b055553047625728d5ad/.dagger/cli.go#L18-L24

#

do you have a reproducer? i can't seem to get it to happen, sorry 😢

#

dagger.Platform optionals

elder dust Sep 2, 2024, 4:44 PM

#

Here is the code causing the problem:

// Build clientcompat binary.
func (m *Twirp) Build(
    // Target platform in "[os]/[platform]/[version]" format (e.g., "darwin/arm64/v7", "windows/amd64", "linux/arm64").
    //
    // +optional
    platform dagger.Platform,
) *dagger.File {
    return m.build(platform, "dev")
}

func (m *Twirp) build(platform dagger.Platform, version string) *dagger.File {
    if version == "" {
        version = "unknown"
    }

    return dag.Go(dagger.GoOpts{
        Version: goVersion,
    }).
        WithSource(m.Source).
        WithPlatform(platform).
        Build(dagger.GoWithSourceBuildOpts{
            Pkg:      "./protoc-gen-twirp_php",
            Trimpath: true,
            Ldflags: []string{
                "-s", "-w",
                "-X", "main.version=" + version,
            },
        })
}

#

marshal: json: error calling MarshalJSON for type *dagger.File: input: go.withSource.withPlatform resolve: failed to set call inputs: failed to convert arg "platform": "" is an invalid OS component of "": O
SAndVersion specifier component must match "^([A-Za-z0-9_-]+)(?:\\(([A-Za-z0-9_.-]*)\\))?$": invalid argument

#

So the problem occurs when it's passed to another module.

cloud void Sep 2, 2024, 4:45 PM

#

oh i see

#

hm that's definitely "intentional", but yeah, weird

elder dust Sep 2, 2024, 4:46 PM

#

I need to check if it's coming from the module itself

#

I use this library to parse the platform: https://github.com/containerd/platforms

GitHub

GitHub - containerd/platforms: Go package for handling platform type

Go package for handling platform type. Contribute to containerd/platforms development by creating an account on GitHub.

#

But I think the error comes from Dagger

elder dust Sep 2, 2024, 4:47 PM

#

cloud void hm that's definitely "intentional", but yeah, weird

It used to work though :/ (at least it does on 0.12.0)

cloud void Sep 2, 2024, 4:47 PM

#

hm, fair

#

i can take a look this week

elder dust Sep 2, 2024, 4:47 PM

#

BTW this is how the module is implemented: https://github.com/sagikazarmark/daggerverse/blob/main/go/main.go#L100

GitHub

daggerverse/go/main.go at main · sagikazarmark/daggerverse

My Dagger modules. Contribute to sagikazarmark/daggerverse development by creating an account on GitHub.

#

So an empty platform is handled

cloud void Sep 2, 2024, 4:48 PM

#

sorry, for slow responses on everything, i'm completely swamped here sorry

#

🙏

#

hm, ah that's entirely expected actually - that module needs to have an // +optional

#

i'm not sure why that used to work though

elder dust Sep 2, 2024, 4:50 PM

#

Oh, good point

#

Not sure if it should be optional or the caller should handle that

cloud void Sep 2, 2024, 4:51 PM

#

i admit it's super weird to be able to have an invalid platform object, i wonder if it would make sense to prefer this as a *, then it can be nil? but then, i guess you can't pass it to WithPlatform

elder dust Sep 2, 2024, 4:52 PM

#

I guess there is no harm in making it optional in the Go module

#dagger.Platform optionals