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

Completely random workflow that will hopefully find us a bug! #6594

Merged
merged 5 commits into from
May 31, 2023

Conversation

Sam-Kramer
Copy link
Contributor

General

Before this PR:

After this PR:

==COMMIT_MSG==
Adds a workflow which is completely randomly generated.
==COMMIT_MSG==

Priority:

Concerns / possible downsides (what feedback would you like?):

Is documentation needed?:

Compatibility

Does this PR create any API breaks (e.g. at the Java or HTTP layers) - if so, do we have compatibility?:

Does this PR change the persisted format of any data - if so, do we have forward and backward compatibility?:

The code in this PR may be part of a blue-green deploy. Can upgrades from previous versions safely coexist? (Consider restarts of blue or green nodes.):

Does this PR rely on statements being true about other products at a deployment - if so, do we have correct product dependencies on these products (or other ways of verifying that these statements are true)?:

Does this PR need a schema migration?

Testing and Correctness

What, if any, assumptions are made about the current state of the world? If they change over time, how will we find out?:

What was existing testing like? What have you done to improve it?:

If this PR contains complex concurrent or asynchronous code, is it correct? The onus is on the PR writer to demonstrate this.:

If this PR involves acquiring locks or other shared resources, how do we ensure that these are always released?:

Execution

How would I tell this PR works in production? (Metrics, logs, etc.):

Has the safety of all log arguments been decided correctly?:

Will this change significantly affect our spending on metrics or logs?:

How would I tell that this PR does not work in production? (monitors, etc.):

If this PR does not work as expected, how do I fix that state? Would rollback be straightforward?:

If the above plan is more complex than “recall and rollback”, please tag the support PoC here (if it is the end of the week, tag both the current and next PoC):

Scale

Would this PR be expected to pose a risk at scale? Think of the shopping product at our largest stack.:

Would this PR be expected to perform a large number of database calls, and/or expensive database calls (e.g., row range scans, concurrent CAS)?:

Would this PR ever, with time and scale, become the wrong thing to do - and if so, how would we know that we need to do something differently?:

Development Process

Where should we start reviewing?:

If this PR is in excess of 500 lines excluding versions lock-files, why does it not make sense to split it?:

Please tag any other people who should be aware of this PR:
@jeremyk-91
@sverma30
@raiju

Copy link
Contributor

@jeremyk-91 jeremyk-91 left a comment

Choose a reason for hiding this comment

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

Design makes sense! Couple of details I'd like to check

import org.jetbrains.annotations.VisibleForTesting;

public final class RandomWorkflows {
private static final SecureRandom RANDOM = DefaultNativeSamplingSecureRandomFactory.INSTANCE.create();
Copy link
Contributor

Choose a reason for hiding this comment

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

💯

generateReadActions(), generateWriteActions(), generateDeleteActions())
.flatMap(Collection::stream)
.collect(Collectors.toList());
Collections.shuffle(actions);
Copy link
Contributor

Choose a reason for hiding this comment

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

We need to pass in the random here, otherwise this uses the static one in Collections which isn't guaranteed to be our native one.

}

private List<ReadTransactionAction> generateReadActions() {
return IntStream.range(0, random.nextInt(workflowConfiguration.maxReads()))
Copy link
Contributor

@jeremyk-91 jeremyk-91 May 25, 2023

Choose a reason for hiding this comment

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

careful with this: both nextInt and range are exclusive on the end, which means we actually will generate up to maxReads - 1 actions. We should add 1 inside the nextInt call I think - it's ugly, but we do need to distinguish maxReads + 1 possible outcomes (I'm assuming we do want zero as a possibility).

private List<ReadTransactionAction> generateReadActions() {
return IntStream.range(0, random.nextInt(workflowConfiguration.maxReads()))
.boxed()
.map(index -> ImmutableReadTransactionAction.of(
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: index is unused, so let's name it accordingly

}

private List<WriteTransactionAction> generateWriteActions() {
return IntStream.range(0, random.nextInt(workflowConfiguration.maxWrites()))
Copy link
Contributor

Choose a reason for hiding this comment

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

as above: be careful with the double exclusion

this.workflow = RandomWorkflows.create(
memoryStore,
CONFIGURATION,
MoreExecutors.listeningDecorator(PTExecutors.newFixedThreadPool(1)),
Copy link
Contributor

Choose a reason for hiding this comment

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

non actionable: I think we normally use PTExecutors.newSingleThreadExecutor() when we want 1 specifically, though this is fine

Copy link
Contributor

@jeremyk-91 jeremyk-91 left a comment

Choose a reason for hiding this comment

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

Design makes sense! Couple of details I'd like to check

}

private List<ReadTransactionAction> generateReadActions() {
return IntStream.rangeClosed(0, random.nextInt(workflowConfiguration.maxReads()))
Copy link
Contributor

Choose a reason for hiding this comment

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

I did think about rangeClosed, though note that this means we will have at least one of each operation type. If that's the intention that's fine, but wanted to make sure!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ah shoot

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah we definitely do not want that

@jeremyk-91
Copy link
Contributor

👍 thanks!

@jeremyk-91 jeremyk-91 merged commit 5b1d8f7 into develop May 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants