mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Michael SnowdenandGitHub
1d6e8d5d6b
## What changed? <!-- Describe what has changed in this PR --> I migrated our usage of `gofakeit` to `go-faker`. ## Why? <!-- Tell your future self why have you made these changes --> Because `go-faker` does not handle circular references, which we have in our `Failure` proto. See https://github.com/brianvoe/gofakeit/issues/281#issue-2071796056 ## How did you test it? <!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> I added a test which verifies that these cases are handled gracefully. I also removed the workaround we had for this in our `ActivityInfo` generator. ## Potential risks <!-- Assuming the worst case, what can be broken when deploying this change to production? --> By default, this is less performant than `gofakeit`. However, by calling `SetRandomMapAndSliceMaxSize(2)` (down from the default of 100), we have comparable performance (on the order of 100 micro seconds for large structs). ## Is hotfix candidate? <!-- Is this PR a hotfix candidate or does it require a notification to be sent to the broader community? (Yes/No) --> No.
53 lines
2.4 KiB
Go
53 lines
2.4 KiB
Go
// The MIT License
|
|
//
|
|
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
|
|
//
|
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
|
|
// Package fakedata provides utilities for generating random data for testing. We recently migrated from gofakeit to
|
|
// go-faker. This was to avoid the problem described here: https://github.com/brianvoe/gofakeit/issues/281#issue-2071796056.
|
|
// To make such migrations easier in the future, and to ensure that we use [faker.SetIgnoreInterface] before any
|
|
// invocation, we created this package.
|
|
package fakedata
|
|
|
|
import (
|
|
"github.com/go-faker/faker/v4"
|
|
)
|
|
|
|
func init() {
|
|
// We need this option to prevent faker.FakeData from returning an error for any struct that has an interface{} field.
|
|
faker.SetIgnoreInterface(true)
|
|
// We need this option to prevent faker from taking a long time while generating random data for structs that have
|
|
// map or slice fields. This is especially relevant for persistence.ShardInfo, which takes about 1s without this
|
|
// option, but only ~100µs with it.
|
|
if err := faker.SetRandomMapAndSliceMaxSize(2); err != nil {
|
|
panic(err)
|
|
}
|
|
}
|
|
|
|
// FakeStruct generates random data for the given struct pointer. Example usage:
|
|
//
|
|
// var shardInfo persistencespb.ShardInfo
|
|
// _ = fakedata.FakeStruct(&shardInfo)
|
|
func FakeStruct(a interface{}) error {
|
|
return faker.FakeData(a)
|
|
}
|