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

internal/grpcrand: use Go top-level random functions for go1.21+ #6925

Merged
merged 3 commits into from Feb 1, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions internal/grpcrand/grpcrand.go
@@ -1,3 +1,6 @@
//go:build !go1.21
// +build !go1.21
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you mind adding a TODO here that says something like:

"TODO: when this file is deleted (after Go 1.20 support is dropped), delete all of grpcrand and call the rand package directly."

?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for my absence and thank you @arvindbr8

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No worries, sorry if you were working on the branch. Since this was a oneliner change, and since you had also allowed edits to your PR by maintainers I went ahead and made the change.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need both syntaxes for this, since we don't support Go 1.16 or earlier. Just //go:build is fine.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


/*
*
* Copyright 2018 gRPC authors.
Expand Down
74 changes: 74 additions & 0 deletions internal/grpcrand/grpcrand_go1.21.go
@@ -0,0 +1,74 @@
//go:build go1.21
// +build go1.21

/*
*
* Copyright 2024 gRPC authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/

// Package grpcrand implements math/rand functions in a concurrent-safe way
// with a global random source, independent of math/rand's global source.
package grpcrand

import "math/rand"

// This implementation will be used for Go version 1.21 or newer.
// For older versions, the original implementation with mutex will be used.

// Int implements rand.Int on the grpcrand global source.
func Int() int {
return rand.Int()
}

// Int63n implements rand.Int63n on the grpcrand global source.
func Int63n(n int64) int64 {
return rand.Int63n(n)
}

// Intn implements rand.Intn on the grpcrand global source.
func Intn(n int) int {
return rand.Intn(n)
}

// Int31n implements rand.Int31n on the grpcrand global source.
func Int31n(n int32) int32 {
return rand.Int31n(n)
}

// Float64 implements rand.Float64 on the grpcrand global source.
func Float64() float64 {
return rand.Float64()
}

// Uint64 implements rand.Uint64 on the grpcrand global source.
func Uint64() uint64 {
return rand.Uint64()
}

// Uint32 implements rand.Uint32 on the grpcrand global source.
func Uint32() uint32 {
return rand.Uint32()
}

// ExpFloat64 implements rand.ExpFloat64 on the grpcrand global source.
func ExpFloat64() float64 {
return rand.ExpFloat64()

Check warning on line 68 in internal/grpcrand/grpcrand_go1.21.go

View check run for this annotation

Codecov / codecov/patch

internal/grpcrand/grpcrand_go1.21.go#L67-L68

Added lines #L67 - L68 were not covered by tests
}

// Shuffle implements rand.Shuffle on the grpcrand global source.
var Shuffle = func(n int, f func(int, int)) {
rand.Shuffle(n, f)

Check warning on line 73 in internal/grpcrand/grpcrand_go1.21.go

View check run for this annotation

Codecov / codecov/patch

internal/grpcrand/grpcrand_go1.21.go#L72-L73

Added lines #L72 - L73 were not covered by tests
}