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

Support variable test URLs #38

Merged
merged 5 commits into from
Oct 8, 2021
Merged

Support variable test URLs #38

merged 5 commits into from
Oct 8, 2021

Conversation

chosak
Copy link
Member

@chosak chosak commented Oct 7, 2021

This commit modifies the list of URLs that get tested each night. Instead of testing a hardcoded list, the URLs to be tested are now read in from an external file. This file is downloaded from a secret URL which is stored in a GitHub repository secret named TEST_PAGES_URL (if this secret is undefined, the fallback behavior is to only test the root of the website).

In order to support the variable list of URLs, the dashboard design has been updated so that it always displays the (alphabetical) full list of URLs ever tested, but now includes a new column with the most recent report date.

Screenshots

image

@caheberer @sonnakim or others: any design suggestions on the column names? It feels a little more cramped now. Would it make sense to make a change something like this?

image

Another thought would be to add https://www.consumerfinance.gov to the header somehow and make all of the links relative.

Todos

  • Add sorting to the URL and date columns.

Checklist

  • PR has an informative and human-readable title
  • Changes are limited to a single goal (no scope creep)
  • Code can be automatically merged (no conflicts)
  • Code follows the standards laid out in the development playbook
  • Passes all existing automated tests
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Reviewers requested with the Reviewers tool ➡️

This commit modifies which URLs are tested each night. Instead of having
a hardcoded list in urls.js, the code now tries to load the list from a
text file named urls.txt.

The nightly GitHub Action now downloads this file from a URL which needs
to be configured as a GitHub repository secret named TEST_PAGES_URL.

If the file does not exist, running `yarn lighthouse` will now only run
against the root page of the domain.
With this commit, the dashboard now includes all URLs ever tested, and
includes a new column indicating the date of the most recent report.
@caheberer
Copy link
Member

I really like the suggested change to the column headings. I think it's clearer (and helpfully shorter!) :)

@sonnakim
Copy link
Member

sonnakim commented Oct 8, 2021

Agreed!
My other thought (unrelated to your request, so maybe this could be a separate effort) is that it would be nice to include an introduction explaining who we are and what this page is about, maybe including a brief explanation of what Lighthouse is, how these pages are chosen, etc.

@chosak
Copy link
Member Author

chosak commented Oct 8, 2021

Thanks @caheberer @sonnakim! I've made the column change. I like the idea for introductory text but would prefer to implement in a future PR.

Copy link
Member

@sonnakim sonnakim left a comment

Choose a reason for hiding this comment

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

Looks good!

@chosak chosak merged commit 6ceb913 into main Oct 8, 2021
@chosak chosak deleted the feature/configurable-urls branch October 8, 2021 15:10
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