api: audit for Go 1.16 go1.16.txt #43407

dmitshur · 2020-12-28T20:32:34Z

next.txt was copied to go1.16.txt in CL 276454 (with a followup in CL 278992).
This is a tracking issue for doing an audit of API additions for Go 1.16.

New API changes for Go 1.16

archive/zip

(accepted proposal #41190:)

pkg archive/zip, method (*ReadCloser) Open(string) (fs.File, error)
pkg archive/zip, method (*Reader) Open(string) (fs.File, error)

crypto/x509

(CL 262343, issue #30322:)

pkg crypto/x509, method (SystemRootsError) Unwrap() error

(accepted proposal #37172, reverted:)

~~pkg crypto/x509, type CertificateRequest struct, BasicConstraintsValid bool~~
~~pkg crypto/x509, type CertificateRequest struct, ExtKeyUsage []ExtKeyUsage~~
~~pkg crypto/x509, type CertificateRequest struct, IsCA bool~~
~~pkg crypto/x509, type CertificateRequest struct, KeyUsage KeyUsage~~
~~pkg crypto/x509, type CertificateRequest struct, MaxPathLen int~~
~~pkg crypto/x509, type CertificateRequest struct, MaxPathLenZero bool~~
~~pkg crypto/x509, type CertificateRequest struct, PolicyIdentifiers []asn1.ObjectIdentifier~~
~~pkg crypto/x509, type CertificateRequest struct, SubjectKeyId []uint8~~
~~pkg crypto/x509, type CertificateRequest struct, UnknownExtKeyUsage []asn1.ObjectIdentifier~~

debug/elf

(CL 255138:)

embed (new package in Go 1.16)

pkg embed, method (FS) Open(string) (fs.File, error)
pkg embed, method (FS) ReadDir(string) ([]fs.DirEntry, error)
pkg embed, method (FS) ReadFile(string) ([]uint8, error)
pkg embed, type FS struct

flag

(accepted proposal #39557:)

pkg flag, func Func(string, string, func(string) error)
pkg flag, method (*FlagSet) Func(string, string, func(string) error)

go/build

pkg go/build, type Package struct, EmbedPatterns []string
pkg go/build, type Package struct, IgnoredOtherFiles []string
pkg go/build, type Package struct, TestEmbedPatterns []string
pkg go/build, type Package struct, XTestEmbedPatterns []string

io

pkg io, func NopCloser(Reader) ReadCloser
pkg io, func ReadAll(Reader) ([]uint8, error)
pkg io, type ReadSeekCloser interface { Close, Read, Seek }
pkg io, type ReadSeekCloser interface, Close() error
pkg io, type ReadSeekCloser interface, Read([]uint8) (int, error)
pkg io, type ReadSeekCloser interface, Seek(int64, int) (int64, error)
pkg io, var Discard Writer

io/fs (new package in Go 1.16)

log

(accepted proposal #39057:)

pkg log, func Default() *Logger

net

(CL 250357, issue #4373:)

pkg net, var ErrClosed error

net/http

pkg net/http, func FS(fs.FS) FileSystem

(accepted proposal #41048:)

pkg net/http, type Transport struct, GetProxyConnectHeader func(context.Context, *url.URL, string) (Header, error)

os

(accepted proposal #39444:)

pkg os, var ErrProcessDone error

os/signal

(accepted proposal #37255:)

pkg os/signal, func NotifyContext(context.Context, ...os.Signal) (context.Context, context.CancelFunc)

path/filepath

pkg path/filepath, func WalkDir(string, fs.WalkDirFunc) error

runtime/metrics (new package in Go 1.16)

(accepted proposal #37112:)

syscall

(CL 210639, issue #1435:)

(CL 210057, issue #33542, reverted in CL 283992:)

~~pkg syscall (windows-386), func RtlGenRandom(*uint8, uint32) error~~
~~pkg syscall (windows-amd64), func RtlGenRandom(*uint8, uint32) error~~

(CL 261917, issue #42098:)

pkg syscall (windows-386), type SysProcAttr struct, NoInheritHandles bool
pkg syscall (windows-amd64), type SysProcAttr struct, NoInheritHandles bool

(accepted proposal #42584, CL 269761:)

pkg syscall (windows-386), method (*DLLError) Unwrap() error
pkg syscall (windows-amd64), method (*DLLError) Unwrap() error

testing/fstest (new package in Go 1.16)

testing/iotest

pkg testing/iotest, func ErrReader(error) io.Reader
pkg testing/iotest, func TestReader(io.Reader, []uint8) error

html/template

pkg html/template, func ParseFS(fs.FS, ...string) (*Template, error)
pkg html/template, method (*Template) ParseFS(fs.FS, ...string) (*Template, error)

text/template

pkg text/template, func ParseFS(fs.FS, ...string) (*Template, error)
pkg text/template, method (*Template) ParseFS(fs.FS, ...string) (*Template, error)

text/template/parse

unicode

(CL 248765, issue #40755:)

pkg unicode, const Version = "13.0.0"
pkg unicode, var Chorasmian *RangeTable
pkg unicode, var Dives_Akuru *RangeTable
pkg unicode, var Khitan_Small_Script *RangeTable
pkg unicode, var Yezidi *RangeTable

CC @rsc, @ianlancetaylor, @FiloSottile, @mknyszek, @mpvl, @golang/release.

toothrot · 2021-01-07T19:18:02Z

Hello @rsc, @ianlancetaylor, @FiloSottile, @mknyszek, @mpvl, @golang/release. Could you please verify and check-off these changes?

dmitshur · 2021-01-21T22:02:46Z

Most of the remaining items are related to go:embed and the new io/fs package. @rsc Can you please take a look? Thanks.

@mpvl Do the Unicode API additions look okay to you?

ianlancetaylor · 2021-01-22T23:33:12Z

I've gone through all of these, and verify that they look OK, and that they are mentioned in the release notes. I think we are good.

dmitshur · 2021-01-27T19:50:56Z

There are a couple API additions since api/go1.16.txt was created and this issue filed, as reported by the API check now:

##### API check
+pkg crypto/x509, type CertificateRequest struct, KeyUsage KeyUsage
+pkg go/build/constraint, func IsGoBuild(string) bool
+pkg go/build/constraint, func IsPlusBuild(string) bool
+pkg go/build/constraint, func Parse(string) (Expr, error)
+pkg go/build/constraint, func PlusBuildLines(Expr) ([]string, error)
+pkg go/build/constraint, method (*AndExpr) Eval(func(string) bool) bool
+pkg go/build/constraint, method (*AndExpr) String() string
+pkg go/build/constraint, method (*NotExpr) Eval(func(string) bool) bool
+pkg go/build/constraint, method (*NotExpr) String() string
+pkg go/build/constraint, method (*OrExpr) Eval(func(string) bool) bool
+pkg go/build/constraint, method (*OrExpr) String() string
+pkg go/build/constraint, method (*SyntaxError) Error() string
+pkg go/build/constraint, method (*TagExpr) Eval(func(string) bool) bool
+pkg go/build/constraint, method (*TagExpr) String() string
+pkg go/build/constraint, type AndExpr struct
+pkg go/build/constraint, type AndExpr struct, X Expr
+pkg go/build/constraint, type AndExpr struct, Y Expr
+pkg go/build/constraint, type Expr interface, Eval(func(string) bool) bool
+pkg go/build/constraint, type Expr interface, String() string
+pkg go/build/constraint, type Expr interface, unexported methods
+pkg go/build/constraint, type NotExpr struct
+pkg go/build/constraint, type NotExpr struct, X Expr
+pkg go/build/constraint, type OrExpr struct
+pkg go/build/constraint, type OrExpr struct, X Expr
+pkg go/build/constraint, type OrExpr struct, Y Expr
+pkg go/build/constraint, type SyntaxError struct
+pkg go/build/constraint, type SyntaxError struct, Err string
+pkg go/build/constraint, type SyntaxError struct, Offset int
+pkg go/build/constraint, type TagExpr struct
+pkg go/build/constraint, type TagExpr struct, Tag string

go/build/constraint is a new package in Go 1.16, added in CL 240604, and it's a part of an accepted proposal #41184. @rsc Please confirm the Go 1.16 API looks right or if something is unexpected.

x509.CertificateRequest.KeyUsage needs to be looked at. Perhaps it should've been rolled back in https://golang.org/cl/281235 but got missed. @rolandshoemaker Can you take a look please?

I'm not sure why we didn't notice these earlier via a failing test or some other mechanism. I'll investigate that. CC @toothrot. Update: See #43407 (comment).

rolandshoemaker · 2021-01-27T19:56:58Z

Ah yup, looks like we missed it. I'll open a CL to revert the last bit.

dmitshur · 2021-01-27T20:03:49Z

Thanks Roland.

I'm not sure why we didn't notice these earlier via a failing test or some other mechanism. I'll investigate that. CC @toothrot.

This was caught in the RC1 release tests, so we do have a mechanism, but it can be improved to help detect this earlier in the future. Filed #43956 about that.

gopherbot · 2021-01-27T20:28:58Z

Change https://golang.org/cl/287392 mentions this issue: crypto/x509: remove leftover CertificateRequest field

gopherbot · 2021-01-27T20:29:40Z

Change https://golang.org/cl/287412 mentions this issue: api/go1.16: add build/constraint APIs

Removes the KeyUsage field that was missed in the rollback in CL 281235. Also updates CreateCertificateRequest to reflect that these fields were removed. For #43407. Updates #43477. Updates #37172. Change-Id: I6244aed4a3ef3c2460c38af5511e5c2e82546179 Reviewed-on: https://go-review.googlesource.com/c/go/+/287392 Trust: Alexander Rakoczy <alex@golang.org> Trust: Roland Shoemaker <roland@golang.org> Trust: Dmitri Shuralyov <dmitshur@golang.org> Run-TryBot: Alexander Rakoczy <alex@golang.org> Reviewed-by: Alexander Rakoczy <alex@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org> Reviewed-by: Filippo Valsorda <filippo@golang.org> TryBot-Result: Go Bot <gobot@golang.org>

These APIs were added in CL 240604 as part of an approved proposal. It was submitted after the initial api/go1.16.txt creation. For #41184 For #43407 Change-Id: Ifb54df2b61c554c32bd9d17afbb74f4e42e0b228 Reviewed-on: https://go-review.googlesource.com/c/go/+/287412 Trust: Alexander Rakoczy <alex@golang.org> Run-TryBot: Alexander Rakoczy <alex@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>

dmitshur · 2021-01-27T21:24:27Z

rsc · 2021-01-28T03:07:34Z

Checked all the boxes. This is OK. Thanks.

dmitshur · 2021-01-28T03:22:09Z

Thanks Russ. Closing as resolved.

dmitshur added NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. release-blocker labels Dec 28, 2020

dmitshur added this to the Go1.16 milestone Dec 28, 2020

mpx mentioned this issue Dec 31, 2020

runtime/metrics: use explicit histogram boundaries (API fix) #43443

Closed

bcmills mentioned this issue Jan 11, 2021

go/build: missing Position information for go:embed patterns #43632

Closed

ianlancetaylor closed this as completed Jan 22, 2021

dmitshur reopened this Jan 27, 2021

dmitshur mentioned this issue Jan 27, 2021

api: API check test should disallow API additions after an api/go1.N.txt is created (currently it does this only after a VERSION file is added) #43956

Closed

dmitshur mentioned this issue Jan 27, 2021

doc/go1.16: document new go/build/constraint package #43957

Closed

dmitshur assigned rsc Jan 28, 2021

dmitshur closed this as completed Jan 28, 2021

This comment has been minimized.

Sign in to view

golang locked and limited conversation to collaborators Jan 28, 2022

gopherbot added the FrozenDueToAge label Jan 28, 2022

rsc removed their assignment Jun 23, 2022

dmitshur added NeedsFix The path to resolution is known, but the work has not been done. and removed NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. labels Jun 1, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

api: audit for Go 1.16 go1.16.txt #43407

api: audit for Go 1.16 go1.16.txt #43407

dmitshur commented Dec 28, 2020 •

edited by ianlancetaylor

toothrot commented Jan 7, 2021

dmitshur commented Jan 21, 2021

ianlancetaylor commented Jan 22, 2021

dmitshur commented Jan 27, 2021 •

edited

rolandshoemaker commented Jan 27, 2021

dmitshur commented Jan 27, 2021

gopherbot commented Jan 27, 2021

gopherbot commented Jan 27, 2021

dmitshur commented Jan 27, 2021 •

edited by rsc

rsc commented Jan 28, 2021

dmitshur commented Jan 28, 2021

This comment has been minimized.

api: audit for Go 1.16 go1.16.txt #43407

api: audit for Go 1.16 go1.16.txt #43407

Comments

dmitshur commented Dec 28, 2020 • edited by ianlancetaylor

New API changes for Go 1.16

archive/zip

crypto/x509

debug/elf

embed (new package in Go 1.16)

flag

go/build

io

io/fs (new package in Go 1.16)

log

net

net/http

os

os/signal

path/filepath

runtime/metrics (new package in Go 1.16)

syscall

testing/fstest (new package in Go 1.16)

testing/iotest

html/template

text/template

text/template/parse

unicode

toothrot commented Jan 7, 2021

dmitshur commented Jan 21, 2021

ianlancetaylor commented Jan 22, 2021

dmitshur commented Jan 27, 2021 • edited

rolandshoemaker commented Jan 27, 2021

dmitshur commented Jan 27, 2021

gopherbot commented Jan 27, 2021

gopherbot commented Jan 27, 2021

dmitshur commented Jan 27, 2021 • edited by rsc

rsc commented Jan 28, 2021

dmitshur commented Jan 28, 2021

This comment has been minimized.

dmitshur commented Dec 28, 2020 •

edited by ianlancetaylor

dmitshur commented Jan 27, 2021 •

edited

dmitshur commented Jan 27, 2021 •

edited by rsc