🐛 fix s3/gcs bucket cleanup #11728

ChristopheDuong · 2022-04-05T10:59:00Z

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

🚨 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

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.

davinchia · 2022-04-05T11:25:30Z

...stination-s3/src/main/java/io/airbyte/integrations/destination/s3/BlobStorageOperations.java

@@ -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;


this is a better name

davinchia · 2022-04-05T11:26:25Z

...ination-s3/src/main/java/io/airbyte/integrations/destination/s3/SerializedBufferFactory.java

@@ -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 =


do you have a different line width?

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)

...tination-gcs/src/main/java/io/airbyte/integrations/destination/gcs/GcsStorageOperations.java

davinchia · 2022-04-05T11:29:53Z

...ination-s3/src/test/java/io/airbyte/integrations/destination/s3/S3StorageOperationsTest.java

+
+  @Test
+  void testCleanUpBucketObject() {
+    final String pathFormat = S3DestinationConstants.DEFAULT_PATH_FORMAT;


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

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

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

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

ChristopheDuong · 2022-04-05T12:58:06Z

/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 · 2022-04-05T13:03:05Z

/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

airbyte-integrations/connectors/destination-aws-datalake/src/main/java/AthenaHelper.java

ChristopheDuong · 2022-04-05T13:32:10Z

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

davinchia

…-cleanup

ChristopheDuong · 2022-04-05T14:26:04Z

/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 · 2022-04-05T15:28:20Z

/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 · 2022-04-05T16:29:27Z

/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

ChristopheDuong · 2022-04-05T16:36:31Z

...tegration/java/io/airbyte/integrations/destination/gcs/GcsAvroDestinationAcceptanceTest.java

+  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();
+              }
+            });
+          }
+        }
+      }
+    }
+  }
+


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

Same thing in all the other acceptanceTest files from this PR

ChristopheDuong added 2 commits April 5, 2022 12:56

Restrict bucket clean up

7de403a

bumpversion

762699d

github-actions bot added the area/connectors Connector related issues label Apr 5, 2022

ChristopheDuong requested review from tuliren, Phlair and edgao and removed request for Phlair April 5, 2022 11:01

Add comment

7d56a78

davinchia reviewed Apr 5, 2022

View reviewed changes

...tination-gcs/src/main/java/io/airbyte/integrations/destination/gcs/GcsStorageOperations.java Show resolved Hide resolved

davinchia reviewed Apr 5, 2022

View reviewed changes

ChristopheDuong added 2 commits April 5, 2022 13:57

Fix tests

c2d3510

Fix acceptance tests

af41c7a

davinchia reviewed Apr 5, 2022

View reviewed changes

airbyte-integrations/connectors/destination-aws-datalake/src/main/java/AthenaHelper.java Outdated Show resolved Hide resolved

davinchia approved these changes Apr 5, 2022

View reviewed changes

ChristopheDuong added 2 commits April 5, 2022 15:52

Include file extension in filename in blob storage

c8805af

Add docs

edb2049

github-actions bot added the area/documentation Improvements or additions to documentation label Apr 5, 2022

ChristopheDuong added 2 commits April 5, 2022 16:13

Merge remote-tracking branch 'origin/master' into chris/fix-s3-bucket…

e0f9b76

…-cleanup

Fix test flakyness

7571577

ChristopheDuong added 2 commits April 5, 2022 16:51

Revert changes on unrelated files

95b11f5

Fix gcs acceptance tests

0ffb280

airbytehq deleted a comment from codecov bot Apr 5, 2022

ChristopheDuong mentioned this pull request Apr 5, 2022

Improve "SecondSync" checks in Standard Destination Acceptance tests #11731

Closed

ChristopheDuong added 3 commits April 5, 2022 17:54

Fix GCS acceptance tests

1e1c7d0

format code

37c0371

Fix acceptance tests for gcs

4ce8928

airbytehq deleted a comment from codecov bot Apr 5, 2022

ChristopheDuong commented Apr 5, 2022

View reviewed changes

ChristopheDuong merged commit 393ba35 into master Apr 5, 2022

ChristopheDuong deleted the chris/fix-s3-bucket-cleanup branch April 5, 2022 16:46

ChristopheDuong mentioned this pull request Apr 6, 2022

🐞 Destination S3: remove stream path instead of output path #11740

Closed

voroninman mentioned this pull request Jun 10, 2022

'Reset your data' on a connection with an S3 destination bulk DELETES all sources, not just this connection's #12141

Closed

etsybaev mentioned this pull request Jun 27, 2022

🎉 Destination connectors: Improved "SecondSync" checks in Standard Destination Acceptance tests #14184

Merged

37 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🐛 fix s3/gcs bucket cleanup #11728

🐛 fix s3/gcs bucket cleanup #11728

ChristopheDuong commented Apr 5, 2022 •

edited

Loading

davinchia Apr 5, 2022

davinchia Apr 5, 2022

ChristopheDuong Apr 5, 2022 •

edited

Loading

davinchia Apr 5, 2022

ChristopheDuong Apr 5, 2022 •

edited

Loading

davinchia Apr 5, 2022

ChristopheDuong Apr 5, 2022

ChristopheDuong commented Apr 5, 2022 •

edited by github-actions bot

Loading

ChristopheDuong commented Apr 5, 2022 •

edited by github-actions bot

Loading

ChristopheDuong commented Apr 5, 2022 •

edited

Loading

davinchia left a comment

ChristopheDuong commented Apr 5, 2022 •

edited by github-actions bot

Loading

ChristopheDuong commented Apr 5, 2022 •

edited by github-actions bot

Loading

ChristopheDuong commented Apr 5, 2022 •

edited by github-actions bot

Loading

ChristopheDuong Apr 5, 2022

🐛 fix s3/gcs bucket cleanup #11728

🐛 fix s3/gcs bucket cleanup #11728

Conversation

ChristopheDuong commented Apr 5, 2022 • edited Loading

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Checklist

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

Tests

davinchia Apr 5, 2022

Choose a reason for hiding this comment

davinchia Apr 5, 2022

Choose a reason for hiding this comment

ChristopheDuong Apr 5, 2022 • edited Loading

Choose a reason for hiding this comment

davinchia Apr 5, 2022

Choose a reason for hiding this comment

ChristopheDuong Apr 5, 2022 • edited Loading

Choose a reason for hiding this comment

davinchia Apr 5, 2022

Choose a reason for hiding this comment

ChristopheDuong Apr 5, 2022

Choose a reason for hiding this comment

ChristopheDuong commented Apr 5, 2022 • edited by github-actions bot Loading

ChristopheDuong commented Apr 5, 2022 • edited by github-actions bot Loading

ChristopheDuong commented Apr 5, 2022 • edited Loading

davinchia left a comment

Choose a reason for hiding this comment

ChristopheDuong commented Apr 5, 2022 • edited by github-actions bot Loading

ChristopheDuong commented Apr 5, 2022 • edited by github-actions bot Loading

ChristopheDuong commented Apr 5, 2022 • edited by github-actions bot Loading

ChristopheDuong Apr 5, 2022

Choose a reason for hiding this comment

ChristopheDuong commented Apr 5, 2022 •

edited

Loading

ChristopheDuong Apr 5, 2022 •

edited

Loading

ChristopheDuong Apr 5, 2022 •

edited

Loading

ChristopheDuong commented Apr 5, 2022 •

edited by github-actions bot

Loading

ChristopheDuong commented Apr 5, 2022 •

edited by github-actions bot

Loading

ChristopheDuong commented Apr 5, 2022 •

edited

Loading

ChristopheDuong commented Apr 5, 2022 •

edited by github-actions bot

Loading

ChristopheDuong commented Apr 5, 2022 •

edited by github-actions bot

Loading

ChristopheDuong commented Apr 5, 2022 •

edited by github-actions bot

Loading