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

Migrate utilities/dead_link to PDM #4623

Merged
merged 2 commits into from
Jul 19, 2024
Merged

Migrate utilities/dead_link to PDM #4623

merged 2 commits into from
Jul 19, 2024

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Jul 17, 2024

Fixes

Related to #4166 by @dhruvkb

Description

This PR migrates the dead_links utility to PDM.

To make the redis connection parameters (host and port) configurable, it converts the utility to a click script with --port and --host parameters.

It also moves away from a py_redis library that was last updated 3 years ago to redis, sets the port for redis connection and also uses tqdm.write to make sure that the progress bar is always at the bottom of the terminal.

Testing Instructions

cd utilities/dead_links
../../ov pdm install
../../ov pdm run dead_link_tally.py
You should see the error message saying that you couln't connect to Redis.

Maintainers can also connect to Redis dev server and use the dev port to run ../../ov pdm run dead_link_tally.py --port=DEV_REDIS_PORT to test running this script with staging data.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (ov just catalog/generate-docs for catalog
    PRs) or the media properties generator (ov just catalog/generate-docs media-props
    for the catalog or ov just api/generate-docs for the API) where applicable.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@obulat obulat added 🟩 priority: low Low priority and doesn't need to be rushed 💻 aspect: code Concerns the software code in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🧱 stack: mgmt Related to repo management and automations labels Jul 17, 2024
@obulat obulat self-assigned this Jul 17, 2024
@obulat obulat mentioned this pull request Jul 17, 2024
8 tasks
@obulat obulat changed the title Migrate utilities/dead_link to PDM Migrate utilities/dead_link to PDM Jul 17, 2024
@obulat obulat marked this pull request as ready for review July 17, 2024 08:26
@obulat obulat requested a review from a team as a code owner July 17, 2024 08:26
@sarayourfriend
Copy link
Collaborator

Maintainers only: connect to redis prod.

It's not really necessary for testing, to be clear, and best to avoid if not absolutely necessary to directly connect. You can get the same data locally by requesting search with filter_dead=True and setting the link validation timeout to something very low or modifying the code to specially force the data to appear.

At the very least, connecting to dev Redis should be preferred when production data isn't strictly necessary but it cannot be reproduced locally for some reason.

Copy link
Collaborator

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

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

Left one comment but it isn't a blocker. If you'd rather merge this as is, that's fine by me, but a fast-follow issue + PR to make the port and host configurable to discourage using production unless that's very intentional is, I think, a must for this code.

utilities/dead_links/dead_link_tally.py Outdated Show resolved Hide resolved
Signed-off-by: Olga Bulat <obulat@gmail.com>
Signed-off-by: Olga Bulat <obulat@gmail.com>
Copy link
Member

@krysal krysal left a comment

Choose a reason for hiding this comment

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

This looks more like a full refactor 😄 It worked for me locally with:

../../ov pdm run dead_link_tally.py --port=50263

Great!

@obulat obulat merged commit f6cdfe1 into main Jul 19, 2024
41 checks passed
@obulat obulat deleted the pdm/utilities/dead_links branch July 19, 2024 04:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: mgmt Related to repo management and automations
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants