Skip to content

✨ Source S3: Add reading files inside zip archive #31340

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Oct 18, 2023
Merged

✨ Source S3: Add reading files inside zip archive #31340

merged 6 commits into from
Oct 18, 2023

Conversation

@tolik0
Copy link
Contributor

@tolik0 tolik0 commented Oct 12, 2023 •
edited
Loading

What

In this PR, we've enhanced the capability of our S3 stream reader to efficiently access and read files within ZIP archives stored in S3. The key highlights include:

  • Central Directory Parsing: Introduced logic to read and parse the Central Directory of ZIP archives, which provides metadata about the files contained within.
  • Direct File Access: Leveraged the offset information from the Central Directory to directly seek and read individual files from the ZIP archive without the need to decompress the entire archive.

This implementation ensures a faster and more efficient way to access files within ZIP archives in S3, which is especially beneficial for large archives.

Closes:
#17021

How

The process of reading files from a ZIP archive stored in S3 is divided into two main steps:

1. Reading the Central Directory of the ZIP Archive:

  • The Central Directory (CD) is a crucial part of the ZIP file format. It contains metadata about all the files and directories stored inside the ZIP archive.
  • Our implementation begins by reading the Central Directory to gather information about the contents of the ZIP archive. The ZipFileHandler is responsible for this task.
  • By parsing the Central Directory, we obtain essential details about each file inside the ZIP, such as its name, compression method, compressed size, and most importantly, its offset within the ZIP archive. The offset is crucial because it tells us where the file's data starts in the ZIP archive.

2. Reading Individual Files Using Their Offset:

  • Once we have the offset of a file from the Central Directory, we can directly seek to that position in the ZIP archive to start reading the file's data.
  • The RemoteFileInsideArchive class represents each file inside the ZIP archive. It stores metadata about the file, including its offset, which is used to read the file.
  • When a request is made to read a specific file from the ZIP archive, our implementation seeks to the file's offset in the ZIP archive and begins reading the file's data from that position. This direct seek-and-read approach ensures efficient and fast access to individual files without the need to decompress or read the entire ZIP archive.

In summary, our implementation efficiently reads files from a ZIP archive in S3 by first parsing the Central Directory to gather metadata and then using the offset information to directly access and read individual files.
@vercel
Copy link

vercel bot commented Oct 12, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
airbyte-docs ⬜️ Ignored (Inspect) Visit Preview Oct 18, 2023 8:08am
@github-actions
Copy link
Contributor

github-actions bot commented Oct 12, 2023 •
edited by tolik0
Loading

Before Merging a Connector Pull Request

Wow! What a great pull request you have here! 🎉

To merge this PR, ensure the following has been done/considered for each connector added or updated:

  • PR name follows PR naming conventions
  • Breaking changes are considered. If a Breaking Change is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan.
  • Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
  • You've updated the connector's metadata.yaml file any other relevant changes, including a breakingChanges entry for major version bumps. See metadata.yaml docs
  • Secrets in the connector's spec are annotated with airbyte_secret
  • All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
  • Changelog updated in docs/integrations/<source or destination>/<name>.md with an entry for the new version. See changelog example
  • Migration guide updated in docs/integrations/<source or destination>/<name>-migrations.md with an entry for the new version, if the version is a breaking change. See migration guide example
  • If set, you've ensured the icon is present in the platform-internal repo. (Docs)

If the checklist is complete, but the CI check is failing,

  1. Check for hidden checklists in your PR description

  2. Toggle the github label checklist-action-run on/off to re-run the checklist CI.
davydov-d
davydov-d suggested changes Oct 12, 2023
View reviewed changes
Copy link
Contributor

@davydov-d davydov-d left a comment

Choose a reason for hiding this comment

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

Please add tests, preferably CAT with the new archive type
@tolik0 tolik0 mentioned this pull request Oct 13, 2023
Closed
@tolik0 tolik0 marked this pull request as ready for review October 13, 2023 11:48
@tolik0 tolik0 changed the title Source S3: Add reading files inside zip archive ✨ Source S3: Add reading files inside zip archive Oct 13, 2023
@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Oct 13, 2023
@airbyte-oss-build-runner
Copy link
Collaborator

airbyte-oss-build-runner commented Oct 13, 2023

source-s3 test report (commit e56c48c8b5) - ✅

⏲️ Total pipeline duration: 14mn55s

Step Result
Build source-s3 docker image for platform(s) linux/x86_64 ✅
Unit tests ✅
Acceptance tests ✅
Code format checks ✅
Validate metadata for source-s3 ✅
Connector version semver check ✅
Connector version increment check ✅
QA checks ✅

🔗 View the logs here

☁️ View runs for commit in Dagger Cloud

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-s3 test
@tolik0 tolik0 requested a review from davydov-d October 13, 2023 12:23
davydov-d
davydov-d approved these changes Oct 13, 2023
View reviewed changes
Copy link
Contributor

@davydov-d davydov-d left a comment

Choose a reason for hiding this comment

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

👏
@tolik0 tolik0 requested review from bazarnov and lazebnyi October 16, 2023 09:22
bazarnov
bazarnov approved these changes Oct 17, 2023
View reviewed changes
airbyte-integrations/connectors/source-s3/source_s3/v4/zip_reader.py Outdated
Comment on lines 138 to 140
self._file.seek(file_start + 26) # Offset to the length fields in the ZIP header
name_len, extra_len = struct.unpack("<HH", self._file.read(4))
return file_start + 30 + name_len + extra_len
Copy link
Contributor

@bazarnov bazarnov Oct 17, 2023

Choose a reason for hiding this comment

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

Could you please give more info about these hardcoded ints: 26 and 30 ?
@octavia-squidington-iv octavia-squidington-iv requested review from a team October 17, 2023 10:18
@tolik0 tolik0 force-pushed the tolik0/source-s3/add-reading-inside-zip branch from e56c48c to 0fa7198 Compare October 17, 2023 23:13
@airbyte-oss-build-runner
Copy link
Collaborator

airbyte-oss-build-runner commented Oct 17, 2023

source-s3 test report (commit 7217969808) - ❌

⏲️ Total pipeline duration: 20mn20s

Step Result
Build source-s3 docker image for platform(s) linux/x86_64 ✅
Unit tests ✅
Acceptance tests ❌
Code format checks ✅
Validate metadata for source-s3 ✅
Connector version semver check ✅
Connector version increment check ✅
QA checks ✅

🔗 View the logs here

☁️ View runs for commit in Dagger Cloud

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-s3 test
@tolik0 tolik0 force-pushed the tolik0/source-s3/add-reading-inside-zip branch from 7217969 to eeafed3 Compare October 18, 2023 07:55
@airbyte-oss-build-runner
Copy link
Collaborator

airbyte-oss-build-runner commented Oct 18, 2023

source-s3 test report (commit 5f74715bbe) - ✅

⏲️ Total pipeline duration: 21mn00s

Step Result
Build source-s3 docker image for platform(s) linux/x86_64 ✅
Unit tests ✅
Acceptance tests ✅
Code format checks ✅
Validate metadata for source-s3 ✅
Connector version semver check ✅
Connector version increment check ✅
QA checks ✅

🔗 View the logs here

☁️ View runs for commit in Dagger Cloud

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-s3 test
@tolik0 tolik0 merged commit 951605a into master Oct 18, 2023
@tolik0 tolik0 deleted the tolik0/source-s3/add-reading-inside-zip branch October 18, 2023 08:53
ariesgun pushed a commit to ariesgun/airbyte that referenced this pull request Oct 23, 2023
@tolik0 @ariesgun
✨ Source S3: Add reading files inside zip archive (airbytehq#31340)
61ca31f
@makz81 makz81 mentioned this pull request Feb 15, 2024
Closed
1 task
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 connectors/source/s3

7 participants

@tolik0 @airbyte-oss-build-runner @davydov-d @bazarnov @roman-yermilov-gl @octavia-squidington-iii