Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

proposal: spec: direct reference to embedded fields in struct literals #9859

Open
adg opened this issue Feb 12, 2015 · 27 comments
Open

proposal: spec: direct reference to embedded fields in struct literals #9859

adg opened this issue Feb 12, 2015 · 27 comments
Labels
LanguageChange Proposal v2 A language change or incompatible library change
Milestone

Comments

@adg
Copy link
Contributor

adg commented Feb 12, 2015

Consider

type E struct {
    A int
}

type T struct {
    E
}

This works:

T{E: E{A: 1}}

This does not:

T{A: 1}

Makes some struct literals more verbose than they need be, and makes them asymmetrical to their usage (where you can access the embedded struct's fields directly).

Can we allow it?

(cc @bradfitz)

@adg
Copy link
Contributor Author

adg commented Feb 12, 2015

One possible argument against is that it allows you to effectively specify the same field twice, for example:

T{E: E{A: 1}, A: 2}

But this case already exists

S{B: 2, B: 3}

and is disallowed, so maybe that isn't worth worrying about.

@bradfitz
Copy link
Contributor

FWIW, @adg and I both tripped over this independently. We both assumed T{A: 1} would work.

@griesemer
Copy link
Contributor

I've wished to be to able to do this many times (go/ast is a prime example).

I don't know that we ever thought through all the consequences, but it's perhaps worthwhile considering.

@griesemer griesemer self-assigned this Feb 12, 2015
@dominikh
Copy link
Member

Is there any known reason it wasn't considered back in #164?

@griesemer
Copy link
Contributor

@dominikh issue #164 was about a "programmer error" or misunderstanding of the spec as written.

Usually we don't look at each such error and consider a spec change. However this has come up before (it has restricted what I wanted to do in APIs significantly) so maybe it's time to at least investigate the consequences of such a language change more thoroughly.

That said, language changes are really very low priority. We'll get to it when we get to it.

@josharian
Copy link
Contributor

r's comment on this on golang-nuts was:

It might one day, but as it stands the requirement to provide more information is more robust against changes in the data types.

@rsc rsc added this to the Unplanned milestone Apr 10, 2015
@rsc rsc removed the priority-low label Apr 10, 2015
rsc added a commit that referenced this issue Jun 22, 2015
Historically we have declined to try to provide real support for URLs
that contain %2F in the path, but they seem to be popping up more
often, especially in (arguably ill-considered) REST APIs that shoehorn
entire paths into individual path elements.

The obvious thing to do is to introduce a URL.RawPath field that
records the original encoding of Path and then consult it during
URL.String and URL.RequestURI. The problem with the obvious thing
is that it breaks backward compatibility: if someone parses a URL
into u, modifies u.Path, and calls u.String, they expect the result
to use the modified u.Path and not the original raw encoding.

Split the difference by treating u.RawPath as a hint: the observation
is that there are many valid encodings of u.Path. If u.RawPath is one
of them, use it. Otherwise compute the encoding of u.Path as before.

If a client does not use RawPath, the only change will be that String
selects a different valid encoding sometimes (the original passed
to Parse).

This ensures that, for example, HTTP requests use the exact
encoding passed to http.Get (or http.NewRequest, etc).

Also add new URL.EscapedPath method for access to the actual
escaped path. Clients should use EscapedPath instead of
reading RawPath directly.

All the old workarounds remain valid.

Fixes #5777.
Might help #9859.
Fixes #7356.
Fixes #8767.
Fixes #8292.
Fixes #8450.
Fixes #4860.
Fixes #10887.
Fixes #3659.
Fixes #8248.
Fixes #6658.
Reduces need for #2782.

Change-Id: I77b88f14631883a7d74b72d1cf19b0073d4f5473
Reviewed-on: https://go-review.googlesource.com/11302
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
@rsc rsc changed the title spec: direct reference to embedded fields in struct literals proposal: spec: direct reference to embedded fields in struct literals Jun 20, 2017
@rsc rsc added the v2 A language change or incompatible library change label Jun 20, 2017
@ghasemloo
Copy link

ghasemloo commented Jul 11, 2017

I have also written code that assumed this would work.

Considering the reading and assignment of embedded fields work it is quite unintuitive that this doesn't.

https://goplay.googleplex.com/p/d9tdQxQism

@dsnet dsnet added the Proposal label Aug 7, 2017
@dsnet dsnet modified the milestones: Proposal, Unplanned Aug 7, 2017
@zombiezen
Copy link
Contributor

@neild and I were discussing this and there are two things that would have to be addressed (not showstoppers, just considerations to make):

  1. What happens if both the anonymous field containing the embedded field and the embedded field itself are specified?
T{E: E{}, A: 42}

This is probably a compile error, much like specifying duplicate fields in struct literals today.

  1. What happens if the anonymous field is a pointer type? Should setting an embedded field cause the anonymous field to be implicitly allocated?

I also suspect that this could be done before Go 2, since it makes previously invalid Go programs valid, and shouldn't alter the meaning of existing Go programs.

@ghasemloo
Copy link

ghasemloo commented Aug 27, 2017

How much should we be consistent with assignments? If 1 is a compile error should the following also be a compile error?
https://goplay.googleplex.com/p/9CL_5Owvzi

For 2, in assignments you would get a runtime error. I feel the idea of allocation on the fly can obscure memory allocation and if you have multiple nested embedding a simple int assignment would do a lot more than a user would expect and surprise them. So I feel it might be better to just have a runtime error as in the case of assignment and no hidden memory allocation:
https://goplay.googleplex.com/p/HWSFemHcFf
Also that is the behavior without embedding:
https://goplay.googleplex.com/p/ixVAW3xa-Q

@neild
Copy link
Contributor

neild commented Aug 28, 2017

The assignment rules already cover the case where the same value (or part of a value) appears multiple times in an assignment.

The assignment proceeds in two phases. First, the operands of index expressions and pointer indirections (including implicit pointer indirections in selectors) on the left and the expressions on the right are all evaluated in the usual order. Second, the assignments are carried out in left-to-right order.

@ianlancetaylor ianlancetaylor added NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. and removed Thinking labels Jan 9, 2018
@ianlancetaylor
Copy link
Contributor

What should happen for the case that @zombiezen mentions above, in which a field is embedded via a pointer? Here are some possibilities:

  1. silently allocate the pointer
  2. panic at run time with a nil dereference error
  3. give a compilation error

It seems like choice 3 is the best one. The compiler can always tell how a field is embedded, so it can tell that a field is embedded via a pointer.

Is it too confusing for struct literals to permit direct embedded fields but not fields embedded via pointers?

@ianlancetaylor ianlancetaylor removed the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Jun 2, 2020
@jimmyfrasche
Copy link
Member

1 or 3 are both valid options. 2 doesn't make sense given that 3 is a valid option.

3 would incentivize non-pointer embedding to get the simpler behavior even when a pointer embedding might make more sense.

1 seems more uniform and hence easier to use. Composite literals aren't necessary. They exist to make things easier.

@jba
Copy link
Contributor

jba commented Jun 2, 2020

I'd like to mention the curious case of an embedded, unexported pointer field with exported fields of its own:

package pkg

type u struct { A int }

type S struct { *u }

Currently, outside of pkg there is no way to allocate S.u or initialize A, although s.A is legal where var s pkg.S.

If pkg.S{A: 1} allocates, then you can do something that you couldn't before.

I don't know if there's any code out there that would care (that depends for its correctness on the inability to allocate u outside the package). There might be.

@jimmyfrasche
Copy link
Member

Hmm, that is a strong argument for option 3

@griesemer
Copy link
Contributor

griesemer commented Jun 2, 2020

Given a struct type T with arbitrary embeddings (directly, or indirectly), if the following code is valid:

var x T
x.f1 = v1
x.f2 = v2
...

for (possibly embedded and possibly exported) struct fields f1, f2, ..., and corresponding values v1, v2, ..., it seems that it should be valid to write:

T{f1: v1, f2: v2, ...}

and vice versa.

This rule alone would take care of visibility across packages and potential field name ambiguities. It would also explain what happens with pointer indirections (it will panic).

This is perhaps the simplest and most intuitive rule and would permit code transformation from one style to the other without change of semantics (which is currently the case for the restricted form of struct literals).

If the compiler is permitted to report an error when a struct literal is known to panic (which is easy to decide) then using a struct literal would be the "safer" choice. But one would lose the ability to transform code between the two variants without semantic change. I don't know if that's a good trade-off.

@jimmyfrasche
Copy link
Member

You could also only implicitly create the pointer if you could explicitly create it. In @jba's example you couldn't write pkg.S{A: 1} because you couldn't write pkg.S{u: &pkg.u{A: 1}}

@networkimprov
Copy link

Possible alternatives:

T{E{A: 1}}

T{E.A: 1}

@darkfeline
Copy link
Contributor

If we implicitly allocating embedded pointers, if you have a long chain of embedded pointers, then it's non-obvious that:

x := Foo{Value: v}

is implicitly expanding to:

x := Foo{Bar: &Bar{Baz: &Baz{Spam: &Spam{Egg: &Egg{Value: v}}}}}

I don't think I like having non-obvious allocations like that.

@jba
Copy link
Contributor

jba commented Jun 3, 2020

@griesemer, your rule seems obvious (in hindsight). Could you go further and say that the sequence of assignments is actually the meaning of the struct literal? Interestingly, the spec never really gives the exact meaning of a struct literal. It strongly suggests it by saying keys are field names and values must be assignable to their respective fields. It even says omitted fields get the zero value. But it never actually says that the given values are assigned to the fields.

@karlbateman
Copy link

How much should we be consistent with assignments? If 1 is a compile error should the following also be a compile error?
https://goplay.googleplex.com/p/9CL_5Owvzi

For 2, in assignments you would get a runtime error. I feel the idea of allocation on the fly can obscure memory allocation and if you have multiple nested embedding a simple int assignment would do a lot more than a user would expect and surprise them. So I feel it might be better to just have a runtime error as in the case of assignment and no hidden memory allocation:
https://goplay.googleplex.com/p/HWSFemHcFf
Also that is the behavior without embedding:
https://goplay.googleplex.com/p/ixVAW3xa-Q

@ghasemloo The links you've provided are not public 🛡️ not sure if that was intentional?

JensErat added a commit to mercedes-benz/cadvisor that referenced this issue Dec 17, 2020
If actually running the influxdb tests (not included in Makefile), a
compiler error occured ("cannot use promoted field in struct literal of
type") because direct access to promoted fields is only allowed in
assignments, not when initializing structs (at least, unless
golang/go#9859 gets implemented).

Signed-off-by: Jens Erat <jens.erat@daimler.com>
@brackendawson
Copy link

brackendawson commented Feb 17, 2021

Consider

type E struct {
    A int
}

type T struct {
    E
}

This works:

T{E: E{A: 1}}

This does not:

T{A: 1}

If E is generic using the current generics proposal, then there is nowhere to specify the type on the above proposed literal of T.

https://go.googlesource.com/proposal/+/refs/heads/master/design/go2draft-type-parameters.md#embedded-instantiated-type

@griesemer
Copy link
Contributor

If E is generic the example might look like this:

type E[T any] struct {
	A T
}

type T1 struct {
	E[int]
}

type T2[T any] struct {
	E[T]
}

that is, either E is instantiated with a fixed type such as int in T1, or is is instantiated with another type parameter T as in T2.

In these cases the equivalent struct literals would be:

T1{E[int]{A: 1}}
T2[int]{E[int]{A: 1}}

and, per this proposal, it could be:

T1{A: 1}      // we statically know the type of A from the declaration of E[int]
T2[int]{A: 1} // we statically know the type of A from the T2 type argument

So this should be doable even in the presence of generic embedded fields.

Unrelated, please note that

T1{E: E[int]{A: 1}}
T2[int]{E: E[int]{A: 1}}

doesn't work at the moment in the generics prototype, even though it should. See also #44345 .

@brackendawson
Copy link

Amusingly your experience today was the reverse of mine. I separately discovered #44345 in the experimental playground and then came here wondering how it impacts this issue.

jan--f added a commit to jan--f/observability-operator that referenced this issue May 18, 2022
Problem: Embedded structs can as of yet not be directly referenced in struct
literals.

Solution: Explicitly use the embedded structs.

Issues: golang/go#9859,
prometheus-operator/prometheus-operator#4539

Signed-off-by: Jan Fajerski <jfajersk@redhat.com>
jan--f added a commit to jan--f/observability-operator that referenced this issue May 18, 2022
Problem: Embedded structs can as of yet not be directly referenced in struct
literals.

Solution: Explicitly use the embedded structs.

Issues: golang/go#9859,
prometheus-operator/prometheus-operator#4539

Signed-off-by: Jan Fajerski <jfajersk@redhat.com>
jan--f added a commit to jan--f/observability-operator that referenced this issue May 23, 2022
Problem: Embedded structs can as of yet not be directly referenced in struct
literals.

Solution: Explicitly use the embedded structs.

Issues: golang/go#9859,
prometheus-operator/prometheus-operator#4539

Signed-off-by: Jan Fajerski <jfajersk@redhat.com>
jan--f added a commit to rhobs/observability-operator that referenced this issue May 30, 2022
* feat: update prometheus-operator dependency in go.mod

This updates the prometheus-operator go dependency to v0.55.0. This
allows specifiying additional auth options in remote_write sections.

Signed-off-by: Jan Fajerski <jfajersk@redhat.com>

* fix: adjust usage of PrometheusSpec type

Problem: Embedded structs can as of yet not be directly referenced in struct
literals.

Solution: Explicitly use the embedded structs.

Issues: golang/go#9859,
prometheus-operator/prometheus-operator#4539

Signed-off-by: Jan Fajerski <jfajersk@redhat.com>

* refactor: generate dependencies from prometheus-operator repo

There is no need to track the prometheus-operator dependencies, they can
just be generated from the upstream artifacts.

Signed-off-by: Jan Fajerski <jfajersk@redhat.com>

* feat: bump prometheus-operator dependency to v0.55.1

Signed-off-by: Jan Fajerski <jfajersk@redhat.com>

* refactor: generate monitoring related CRD manifests

This adds a Makefile target to generate the prometheus-operator related
CRD manifests with controller-gen. For this controller-gen will respect
the prometheus-operator version specified in go.mod.

Signed-off-by: Jan Fajerski <jfajersk@redhat.com>
@Inuart
Copy link

Inuart commented Aug 25, 2022

I can't seem to find this proposal in the proposals project. Is it missing from there or is it following another review process?

@ianlancetaylor
Copy link
Contributor

Language changes like this one mostly follow a separate process, tracked in #33892.

This issue is on that list but it hasn't gotten much attention recently.

@ValarDragon
Copy link

Wanted to echo support of this! Currently there are places I have to avoid using an embedded struct to de-duplicate logic, due to dev UX overhead for downstream users w/ nested struct construction.

@takanuva15
Copy link

Wanted to echo support of this!

👍 Agreed, this would make promoted fields much more intuitive. I thought this was already possible but was surprised to learn that embedded fields are directly gettable but not directly settable on instantiation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
LanguageChange Proposal v2 A language change or incompatible library change
Projects
None yet
Development

No branches or pull requests