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

DOP-4831: Save Lighthouse HTML reports to S3 (rather than Atlas) #84

Merged
merged 28 commits into from
Jul 22, 2024

Conversation

mmeigs
Copy link
Contributor

@mmeigs mmeigs commented Jul 17, 2024

Context

Storing these HTML strings and JSON results in Atlas is much too large and unnecessary.

This PR does away with storing the JSON results completely, and now stores the HTML reports in S3 in a new bucket docs-lighthouse.

Also, now that the code has become larger, I've split the action into separate files to more coherently organize it. Ideally it's clearer now.

Notes

I'm opening a PR in Snooty to ensure that the AWS credentials will be setup before the action for a successful upload. That will be merged before this.

I have already deleted the jsonRuns within Atlas currently. This has made queries much faster already. Also, once this is merged, I will once again delete whatever jsonRuns still remain, and I will create a script to upload all htmlRuns correctly to S3 and then delete them from Atlas.

Examples

Link to S3 bucket
Link to Snooty PR

Copy link
Collaborator

@branberry branberry left a comment

Choose a reason for hiding this comment

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

Hi Matt! Thank you for doing this. Just a few small comments, but overall it looks great!

src/upload-lighthouse/helpers.ts Outdated Show resolved Hide resolved
src/upload-lighthouse/helpers.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@seungpark seungpark left a comment

Choose a reason for hiding this comment

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

minor nit(s) below but overall looks good

src/upload-lighthouse/upload-to-s3.ts Outdated Show resolved Hide resolved
src/upload-lighthouse/index.ts Outdated Show resolved Hide resolved
@branberry branberry self-requested a review July 22, 2024 14:50
Copy link
Collaborator

@branberry branberry left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks

Copy link
Contributor

@seungpark seungpark left a comment

Choose a reason for hiding this comment

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

🙌

@mmeigs mmeigs merged commit 0a63f37 into main Jul 22, 2024
4 checks passed
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.

3 participants