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

🐛 fix s3/gcs bucket cleanup #11728

Merged
merged 14 commits into from
Apr 5, 2022
Merged

Conversation

ChristopheDuong
Copy link
Contributor

@ChristopheDuong ChristopheDuong commented Apr 5, 2022

What

When cleaning up a bucket in overwrite sync mode, the destination might drop too many files from the bucket path if other streams are being written to the same bucket path.

How

Restrict clean up to objects matching the custom s3 path format string instead

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
  • If new credentials are required for use in CI, add them to GSM. 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
  • If new credentials are required for use in CI, add them to GSM. 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

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

@github-actions github-actions bot added the area/connectors Connector related issues label Apr 5, 2022
@ChristopheDuong ChristopheDuong requested review from tuliren, Phlair and edgao and removed request for Phlair April 5, 2022 11:01
@@ -29,9 +28,11 @@
/**
* Remove files that were just stored in the bucket
*/
void cleanUpBucketObject(String streamName, List<String> stagedFiles) throws Exception;
void cleanUpBucketObject(String objectPath, List<String> stagedFiles) throws Exception;
Copy link
Contributor

Choose a reason for hiding this comment

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

this is a better name

@@ -49,15 +49,18 @@
LOGGER.info("S3 format config: {}", formatConfig.toString());
switch (formatConfig.getFormat()) {
case AVRO -> {
final Callable<BufferStorage> createStorageFunctionWithExtension = () -> createStorageFunctionWithoutExtension.apply(AvroSerializedBuffer.DEFAULT_SUFFIX);
final Callable<BufferStorage> createStorageFunctionWithExtension =
Copy link
Contributor

Choose a reason for hiding this comment

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

do you have a different line width?

Copy link
Contributor Author

@ChristopheDuong ChristopheDuong Apr 5, 2022

Choose a reason for hiding this comment

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

I think this change was done by ./gradlew format
(i wasn't editing this file in my IDE. btw my IDE is set to 150, and this line seems to be longer than 150)


@Test
void testCleanUpBucketObject() {
final String pathFormat = S3DestinationConstants.DEFAULT_PATH_FORMAT;
Copy link
Contributor

Choose a reason for hiding this comment

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

does this test have other objects in the bucket? should it do a list after to make sure only the relevant objects are deleted?

Copy link
Contributor Author

@ChristopheDuong ChristopheDuong Apr 5, 2022

Choose a reason for hiding this comment

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

this is a unit test using a mock object instead of a real s3 client / API

Maybe the acceptance tests should also check this though

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah. I think it should to prevent this from happening again.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

FYI @grishick, I created the following issue: #11731

@ChristopheDuong
Copy link
Contributor Author

ChristopheDuong commented Apr 5, 2022

/test connector=connectors/destination-gcs

🕑 connectors/destination-gcs https://github.com/airbytehq/airbyte/actions/runs/2096283079
✅ connectors/destination-gcs https://github.com/airbytehq/airbyte/actions/runs/2096283079
No Python unittests run

@ChristopheDuong
Copy link
Contributor Author

ChristopheDuong commented Apr 5, 2022

/test connector=connectors/destination-s3

🕑 connectors/destination-s3 https://github.com/airbytehq/airbyte/actions/runs/2096309071
✅ connectors/destination-s3 https://github.com/airbytehq/airbyte/actions/runs/2096309071
No Python unittests run

@ChristopheDuong
Copy link
Contributor Author

ChristopheDuong commented Apr 5, 2022

I confirmed with manual testing that two different connections writing to the same bucket path won't be conflicting with each other in overwrite mode anymore with this fix

Copy link
Contributor

@davinchia davinchia left a comment

Choose a reason for hiding this comment

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

:shipit:

@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Apr 5, 2022
@ChristopheDuong
Copy link
Contributor Author

ChristopheDuong commented Apr 5, 2022

/publish connector=connectors/destination-s3

🕑 connectors/destination-s3 https://github.com/airbytehq/airbyte/actions/runs/2096794931
✅ connectors/destination-s3 https://github.com/airbytehq/airbyte/actions/runs/2096794931

@ChristopheDuong
Copy link
Contributor Author

ChristopheDuong commented Apr 5, 2022

/publish connector=connectors/destination-gcs

🕑 connectors/destination-gcs https://github.com/airbytehq/airbyte/actions/runs/2097162560
❌ connectors/destination-gcs https://github.com/airbytehq/airbyte/actions/runs/2097162560

@ChristopheDuong
Copy link
Contributor Author

ChristopheDuong commented Apr 5, 2022

/publish connector=connectors/destination-gcs

🕑 connectors/destination-gcs https://github.com/airbytehq/airbyte/actions/runs/2097491828
✅ connectors/destination-gcs https://github.com/airbytehq/airbyte/actions/runs/2097491828

@airbytehq airbytehq deleted a comment from codecov bot Apr 5, 2022
Comment on lines +124 to +146
protected void deserializeNestedObjects(final List<AirbyteMessage> messages, final List<AirbyteRecordMessage> actualMessages) {
for (final AirbyteMessage message : messages) {
if (message.getType() == Type.RECORD) {
final var iterator = message.getRecord().getData().fieldNames();
while (iterator.hasNext()) {
final var fieldName = iterator.next();
if (message.getRecord().getData().get(fieldName).isContainerNode()) {
message.getRecord().getData().get(fieldName).fieldNames().forEachRemaining(f -> {
final var data = message.getRecord().getData().get(fieldName).get(f);
final var wrappedData = String.format("{\"%s\":%s,\"_airbyte_additional_properties\":null}", f,
dateTimeFieldNames.containsKey(f) || !data.isTextual() ? data.asText() : StringUtils.wrap(data.asText(), "\""));
try {
((ObjectNode) message.getRecord().getData()).set(fieldName, new ObjectMapper().readTree(wrappedData));
} catch (final JsonProcessingException e) {
e.printStackTrace();
}
});
}
}
}
}
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

These seemed to be missing from #9816 for these tests to pass...

Same thing in all the other acceptanceTest files from this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants