Fix //go:generate code generation to match go1.16 #1300

utamori · 2021-03-03T09:13:54Z

Starting with go1.16, the current generate.go statement will result in an error.

To make it behave the same as before, we need to change the description to the following.

- //go:generate go run entgo.io/ent/cmd/ent generate ./schema
+ //go:generate go install entgo.io/ent/cmd/ent@latest
+ //go:generate ent generate ./schema

Reproducing errors

❯ go version       
go version go1.16 darwin/amd64

Global installation of go1.16 style (not reflected in go.mod)

❯ go install entgo.io/ent/cmd/ent@latest

❯ ent init User

edit ent/schema/user.go

package schema

import (
	"entgo.io/ent"
	"entgo.io/ent/schema/field"
)

// Fields of the User.
func (User) Fields() []ent.Field {
	return []ent.Field{
		field.Int("age").
			Positive(),
		field.String("name").
			Default("unknown"),
	}
}

Since go1.16, go.mod is not automatically updated, so you need to do go mod tidy more often

❯ go mod tidy
go: finding module for package entgo.io/ent/schema/field
go: finding module for package entgo.io/ent
go: found entgo.io/ent in entgo.io/ent v0.6.0
go: found entgo.io/ent/schema/field in entgo.io/ent v0.6.0

When I try to generate the code, I get the following error:

❯ go generate ./ent
/Users/user/go/pkg/mod/entgo.io/[email protected]/entc/gen/func.go:22:2: missing go.sum entry for module providing package github.com/go-openapi/inflect (imported by entgo.io/ent/entc/gen); to add:
        go get entgo.io/ent/entc/[email protected]
/Users/user/go/pkg/mod/entgo.io/[email protected]/cmd/internal/printer/printer.go:16:2: missing go.sum entry for module providing package github.com/olekukonko/tablewriter (imported by entgo.io/ent/cmd/internal/printer); to add:
        go get entgo.io/ent/cmd/internal/[email protected]
/Users/user/go/pkg/mod/entgo.io/[email protected]/cmd/internal/base/base.go:25:2: missing go.sum entry for module providing package github.com/spf13/cobra (imported by entgo.io/ent/cmd/ent); to add:
        go get entgo.io/ent/cmd/[email protected]
/Users/user/go/pkg/mod/entgo.io/[email protected]/entc/load/load.go:29:2: missing go.sum entry for module providing package golang.org/x/tools/go/packages (imported by entgo.io/ent/cmd/internal/base); to add:
        go get entgo.io/ent/cmd/internal/[email protected]
/Users/user/go/pkg/mod/entgo.io/[email protected]/entc/gen/graph.go:24:2: missing go.sum entry for module providing package golang.org/x/tools/imports (imported by entgo.io/ent/entc/gen); to add:
        go get entgo.io/ent/entc/[email protected]
ent/generate.go:3: running "go": exit status 1

Same result with go generate ./...

❯ go generate ./...
/Users/user/go/pkg/mod/entgo.io/[email protected]/entc/gen/func.go:22:2: missing go.sum entry for module providing package github.com/go-openapi/inflect (imported by entgo.io/ent/entc/gen); to add:
        go get entgo.io/ent/entc/[email protected]
/Users/user/go/pkg/mod/entgo.io/[email protected]/cmd/internal/printer/printer.go:16:2: missing go.sum entry for module providing package github.com/olekukonko/tablewriter (imported by entgo.io/ent/cmd/internal/printer); to add:
        go get entgo.io/ent/cmd/internal/[email protected]
/Users/user/go/pkg/mod/entgo.io/[email protected]/cmd/internal/base/base.go:25:2: missing go.sum entry for module providing package github.com/spf13/cobra (imported by entgo.io/ent/cmd/ent); to add:
        go get entgo.io/ent/cmd/[email protected]
/Users/user/go/pkg/mod/entgo.io/[email protected]/entc/load/load.go:29:2: missing go.sum entry for module providing package golang.org/x/tools/go/packages (imported by entgo.io/ent/cmd/internal/base); to add:
        go get entgo.io/ent/cmd/internal/[email protected]
/Users/user/go/pkg/mod/entgo.io/[email protected]/entc/gen/graph.go:24:2: missing go.sum entry for module providing package golang.org/x/tools/imports (imported by entgo.io/ent/entc/gen); to add:
        go get entgo.io/ent/entc/[email protected]
ent/generate.go:3: running "go": exit status 1

Reference

Go 1.16 Release Notes: https://golang.org/doc/go1.16

go install now accepts arguments with version suffixes (for example, go install example.com/[email protected]). This causes go install to build and install packages in module-aware mode, ignoring the go.mod file in the current directory or any parent directory, if there is one. This is useful for installing executables without affecting the dependencies of the main module.

go install, with or without a version suffix (as described above), is now the recommended way to build and install packages in module mode. go get should be used with the -d flag to adjust the current module's dependencies without building packages, and use of go get to build and install packages is deprecated. In a future release, the -d flag will always be enabled.

rotemtam · 2021-03-03T10:55:06Z

Hey @uta-mori,
Can you please provide more details? What error are you seeing? How is it relevant to changes in go1.16?
Thanks

utamori · 2021-03-04T00:12:20Z

@rotemtam
ok. I've added the error and the changes in go1.16.

rotemtam · 2021-03-07T07:08:03Z

Thanks for updating the issue @uta-mori.
In general, it is less advised to use global installs, since some teams have multiple ent projects, and don't all use the same version. SInce the gen tool must be the same version as the ent library you are using, this can raise many day to day issues.

I've tried to reproduce your issue with go get and it seems like codegen works:

➜  go116 go mod init repro
go: creating new go.mod: module repro
➜  go116 go get entgo.io/ent/cmd/ent@latest
go get: added entgo.io/ent v0.6.0
➜  go116 go run entgo.io/ent/cmd/ent init User
➜  go116 go generate ./...
➜  go116 tree ./ent
./ent
├── client.go
├── config.go
├── context.go
├── ent.go
├── enttest
│   └── enttest.go
├── generate.go
├── hook
│   └── hook.go
├── migrate
│   ├── migrate.go
│   └── schema.go
├── mutation.go
├── predicate
│   └── predicate.go
├── runtime
│   └── runtime.go
├── runtime.go
├── schema
│   └── user.go
├── tx.go
├── user
│   ├── user.go
│   └── where.go
├── user.go
├── user_create.go
├── user_delete.go
├── user_query.go
└── user_update.go

7 directories, 22 files

WDYT?

rotemtam · 2021-03-07T08:21:20Z

Re-reading your issue description, I'm able to reproduce the issue, even without global installed binaries. Running go mod tidy will cause the error you described.

This is related to the discussion in golang/go#43653. (cc @marwan-at-work )

To fix the issue, we can add this import to the generate.go file:

import _ "entgo.io/ent/cmd/ent"

This makes the package explicitly depend on the ent command line and its transitive dependencies, in which case go mod tidy will not remove them.

@uta-mori , would you like to contribute a fix to change the generated code in this spirit?

a8m · 2021-03-08T13:02:59Z

Thanks for your contribution @uta-mori 🙏

Any update on this?

utamori · 2021-03-08T13:29:35Z

thank you

added import _ "entgo.io/ent/cmd/ent" to generate.go

go get will default to behavior with the -d flag in the future.
This is a behavior that changes only go.mod.

https://golang.org/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them
The -d flag instructs get not to build or install packages. get will only update go.mod and download source code needed to build packages.

Building and installing packages with get is deprecated. In a future release, the -d flag will be enabled by default, and ‘go get’ will be only be used to adjust dependencies of the current module. To install a package using dependencies from the current module, use ‘go install’. To install a package ignoring the current module, use ‘go install’ with an @Version suffix like “@latest” after each argument.

marwan-at-work · 2021-03-08T13:32:28Z

@uta-mori @a8m why not instead of changing:

//go:generate go run entgo.io/ent/cmd/ent generate ./schema

To

+ //go:generate go install entgo.io/ent/cmd/ent@latest
+ //go:generate ent generate ./schema

Which would only work in Go1.16 and fail for users who have not upgraded yet. Why don't we do this:

//go:generate go run -mod=mod entgo.io/ent/cmd/ent generate ./schema

This would work for both 1.16 and previous Go versions and more importantly: it would ensure the version compatibility between the library ent and the cmd line ent.

utamori · 2021-03-08T13:51:31Z

@marwan-at-work
I did not know that. This is the best one. Thank you!

a8m · 2021-03-09T19:53:36Z

You nailed it @marwan-at-work! Thanks for your help.

a8m

Wonderful! Thanks for fixing this @uta-mori.

utamori added 9 commits February 3, 2021 17:36

doc: fix github link

863c8b3

Merge branch 'master' of github.com:facebook/ent

fcfd402

Merge branch 'master' of github.com:facebook/ent

3b7fad6

Merge branch 'master' of github.com:facebook/ent

2a64428

doc: fix Link entgo.io -> github.com/ent

525b018

🎉 first commit

251f39a

update go generate style

de967e4

doc: update go get to go install

65a61e6

doc: update versioning with go install

43a401c

utamori added 2 commits March 8, 2021 22:15

restore all

519f428

change generate.go content

8dee34a

utamori added 2 commits March 8, 2021 22:46

add -mod=mod option

fcd58b7

add -mod=mod option

3bcd53d

a8m approved these changes Mar 9, 2021

View reviewed changes

a8m merged commit e52439c into ent:master Mar 9, 2021

utamori deleted the go1.16-go-generate branch March 10, 2021 01:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix //go:generate code generation to match go1.16 #1300

Fix //go:generate code generation to match go1.16 #1300

utamori commented Mar 3, 2021 •

edited

Loading

Uh oh!

rotemtam commented Mar 3, 2021

Uh oh!

utamori commented Mar 4, 2021

Uh oh!

rotemtam commented Mar 7, 2021

Uh oh!

rotemtam commented Mar 7, 2021 •

edited

Loading

Uh oh!

a8m commented Mar 8, 2021

Uh oh!

utamori commented Mar 8, 2021

Uh oh!

marwan-at-work commented Mar 8, 2021

Uh oh!

utamori commented Mar 8, 2021 •

edited

Loading

Uh oh!

a8m commented Mar 9, 2021

Uh oh!

a8m left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Fix //go:generate code generation to match go1.16 #1300

Fix //go:generate code generation to match go1.16 #1300

Conversation

utamori commented Mar 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reproducing errors

Reference

Uh oh!

rotemtam commented Mar 3, 2021

Uh oh!

utamori commented Mar 4, 2021

Uh oh!

rotemtam commented Mar 7, 2021

Uh oh!

rotemtam commented Mar 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

a8m commented Mar 8, 2021

Uh oh!

utamori commented Mar 8, 2021

Uh oh!

marwan-at-work commented Mar 8, 2021

Uh oh!

utamori commented Mar 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

a8m commented Mar 9, 2021

Uh oh!

a8m left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

utamori commented Mar 3, 2021 •

edited

Loading

rotemtam commented Mar 7, 2021 •

edited

Loading

utamori commented Mar 8, 2021 •

edited

Loading