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

BufferedStreamConsumerTest: remove non-determinism in size of generated test records #9274

Merged
merged 2 commits into from
Jan 4, 2022

Conversation

grubberr
Copy link
Contributor

@grubberr grubberr commented Jan 4, 2022

Signed-off-by: Sergey Chvalyuk grubberr@gmail.com

What

BufferedStreamConsumerTest has side-effects
because generateRecords could generated records of different size and also total size of all records != 1000 as
assumed. Tests FAIL time to time.

How

My fix make all records fixed size (40 bytes) and total size of all records now equal 1000 (as assumed in function param)

How

Describe the solution

Recommended reading order

  1. x.java
  2. y.python

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/SUMMARY.md
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the connector is published, connector added to connector index as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the new connector version is published, connector version bumped in the seed directory as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Connector Generator

  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed.

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>
fix buffer flush

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>
@grubberr grubberr temporarily deployed to more-secrets January 4, 2022 10:31 Inactive
@grubberr grubberr linked an issue Jan 4, 2022 that may be closed by this pull request
@grubberr grubberr self-assigned this Jan 4, 2022
@grubberr grubberr requested a review from DoNotPanicUA January 4, 2022 10:50
@@ -315,7 +315,7 @@ private static void consumeRecords(final BufferedStreamConsumer consumer, final
List<AirbyteMessage> output = Lists.newArrayList();
long bytesCounter = 0;
for (int i = 0;; i++) {
JsonNode payload = Jsons.jsonNode(ImmutableMap.of("id", RandomStringUtils.randomAscii(7), "name", "human " + String.format("%5d", i)));
JsonNode payload = Jsons.jsonNode(ImmutableMap.of("id", RandomStringUtils.randomAlphabetic(7), "name", "human " + String.format("%8d", i)));
Copy link
Contributor

Choose a reason for hiding this comment

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

how does this make the generated size always be 40?

Copy link
Contributor Author

@grubberr grubberr Jan 4, 2022

Choose a reason for hiding this comment

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

now it generates object of fixed size:

{"id":"dumplEw","name":"human        0"}
{"id":"tnJatrn","name":"human       25"}

I have added more spaces before number (to make it 40 bytes)

I have also changed randomAscii -> randomAlphabetic
to avoid generation DOULD-QUOTE and BACK-SLACH which can generated 2 bytes after json-encoding

Copy link
Contributor

Choose a reason for hiding this comment

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

Got it, thanks for the explanation!

@@ -147,7 +147,7 @@ protected void acceptTracked(final AirbyteMessage message) throws Exception {
// are serialized again when writing to
// the destination
long messageSizeInBytes = ByteUtils.getSizeInBytesForUTF8CharSet(Jsons.serialize(recordMessage.getData()));
if (bufferSizeInBytes + messageSizeInBytes >= maxQueueSizeInBytes) {
if (bufferSizeInBytes + messageSizeInBytes > maxQueueSizeInBytes) {
Copy link
Contributor

Choose a reason for hiding this comment

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

why is this changed too? should this also be =?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As for me it's real bug in code itself which I discovered fixing tests.
We need to FLUSH buffer only if
bufferSizeInBytes + messageSizeInBytes > maxQueueSizeInBytes

because if

bufferSizeInBytes + messageSizeInBytes = maxQueueSizeInBytes

we still has to keep buffer not flushed

it's not my logic
it's what I see according to tests

@grubberr grubberr temporarily deployed to more-secrets January 4, 2022 11:56 Inactive
Copy link
Contributor

@DoNotPanicUA DoNotPanicUA left a comment

Choose a reason for hiding this comment

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

😍

@grubberr grubberr merged commit c0a46c1 into master Jan 4, 2022
@grubberr grubberr deleted the grubberr/buffered_stream_consumer_test_fix branch January 4, 2022 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

buffered_stream_consumer.BufferedStreamConsumerTest FAIL time to time
4 participants