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

Fill out query params for Stocksnap DAG, allow restarts #4102

Merged
merged 2 commits into from Apr 16, 2024

Conversation

AetherUnbound
Copy link
Contributor

Fixes

Related to #4101

Description

This PR adds some machinery around the query_params handling for the Stocksnap DAG so that we can leverage the options we already have available for query parameters for manipulating the page(s) that the Stocksnap DAG operates on. This doesn't address the error described in the above issue, but it should make it much easier to reproduce (since we should now receive a specific page for where the run failed rather than having to wait 9 hours!).

Testing Instructions

  1. Run the Stocksnap DAG locally, with a sensible ingestion limit. This should behave normally. Use just catalog/pgcli and SELECT count(*) from images; to verify that the ingestion limit records were loaded.
  2. Trigger a new Stocksnap run with the initial_query_params set to {"page": 100}. Use the same commands as above to verify that there are now twice as many records (e.g. new data and not the same page was loaded).
  3. Add a raise ValueError("Whoops") in the get_record_data function of the Stocksnap ingester, and check that the error logs show which page failed.
  4. (Optional) Use the query params list (e.g. [{"page": 5}, {"page": 10}]) to trigger a new DAG to only run over a few different sets of parameters.

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 (if 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.

@AetherUnbound AetherUnbound added the 🟧 priority: high Stalls work on the project or its dependents label Apr 12, 2024
@AetherUnbound AetherUnbound requested a review from a team as a code owner April 12, 2024 18:47
@AetherUnbound AetherUnbound added 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository 🔧 tech: airflow Involves Apache Airflow 🧱 stack: catalog Related to the catalog and Airflow DAGs labels Apr 12, 2024
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@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.

Requesting clarification on the changed test; approving in case page 0 is meaningless and we are intentionally changing this to skip that page now.

expect_result = "https://stocksnap.io/api/load-photos/date/desc/0"
expect_result = "https://stocksnap.io/api/load-photos/date/desc/1"
Copy link
Contributor

Choose a reason for hiding this comment

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

This is surpising... does this difference matter? Is page 0 a meaningful page that we need to retrieve, different from page 1?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So this is actually a more semantically appropriate tests - the way the class was set up previously is that it would produce 0 if that attribute was accessed directly after construction, but when it was actually called it would be after the first get_next_query_parameters, which would always increment the value and set it to 1. We want page 1 and need to start there, this change just more appropriately reflects that as the starting page (rather than relying on the expected ingestion flow which would increment it before actually calling the endpoint).

Copy link
Contributor

Choose a reason for hiding this comment

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

Great!

@AetherUnbound AetherUnbound merged commit e90b146 into main Apr 16, 2024
42 checks passed
@AetherUnbound AetherUnbound deleted the fix/stocksnap-ingestion-errors branch April 16, 2024 20: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: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents 🧱 stack: catalog Related to the catalog and Airflow DAGs 🔧 tech: airflow Involves Apache Airflow
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

3 participants