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

BCDA-8124: Best practices for speeding up downloads #200

Merged
merged 4 commits into from
May 15, 2024
Merged

Conversation

greg-pf
Copy link
Contributor

@greg-pf greg-pf commented May 14, 2024

🎫 Ticket

https://jira.cms.gov/browse/BCDA-8124

🛠 Changes

  1. Add best practices for speeding up downloads
  2. Link to speeding up downloads from guide

ℹ️ Context for reviewers

Content drafted in BCDA-8000 and published to https://stage.bcda.cms.gov/build.html

✅ Acceptance Validation

Deployed to staging and verified links work

https://stage.bcda.cms.gov/build.html#speeding-up-downloads
image

https://stage.bcda.cms.gov/build.html#requesting-all-three
image

🔒 Security Implications

  • This PR adds a new software dependency or dependencies.
  • This PR modifies or invalidates one or more of our security controls.
  • This PR stores or transmits data that was not stored or transmitted before.
  • This PR requires additional review of its security implications for other reasons.

If any security implications apply, add Jason Ashbaugh (GitHub username: StewGoin) as a reviewer and do not merge this PR without his approval.

@greg-pf greg-pf marked this pull request as ready for review May 14, 2024 16:32
<p>
Requesting compressed data can help increase your download speed. You can request compressed data files by
specifying the `Accept-Encoding: gzip` header in your download requests. After you finish downloading, uncompress
(unzip) the file to access your data.
Copy link
Contributor

Choose a reason for hiding this comment

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

No need to uncompress; by specifying the header, the user's request agent should uncompress the data due to the returned Content-Encoding header. This just speeds up transport

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@@ -170,8 +170,8 @@ <h3 class="ds-c-alert__heading"> Files expire after 24 hours.</h3>
</div>

<p>
The "Accept-Encoding: gzip" header is optional, but will return a significantly smaller (40X smaller) file with a faster download speed. You will need to uncompress the file after downloading if you supply this header. When downloading multiple files, you can further speed up the process by downloading multiple files concurrently.
The "Accept-Encoding: gzip" header is optional, but will return a significantly smaller (40X smaller) file with a faster download speed. Follow our recommended best practices for <a href="#speeding-up-downloads" class="in-text__link">speeding up downloads</a>.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we decrease to ~30X? In tests, compression ratios are closer to 30x than 40.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@greg-pf greg-pf requested a review from alex-dzeda May 14, 2024 18:17
@greg-pf greg-pf merged commit b1127b0 into master May 15, 2024
1 check passed
@greg-pf greg-pf deleted the greg/BCDA-8124 branch May 15, 2024 17:06
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.

2 participants