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

[Integration][Gitlab] | Resolve UserWarning Log By Fixing Pagination for Project Labels Requests #1332

Merged
merged 6 commits into from
Jan 16, 2025

Conversation

mk-armah
Copy link
Member

@mk-armah mk-armah commented Jan 16, 2025

Description

What
A UserWarning is displayed in the console:

UserWarning: Calling a `list()` method without specifying `get_all=True` or `iterator=True` will return a maximum of 20 items. Your query returned 20 of 30 items. See https://python-gitlab.readthedocs.io/en/v3.15.0/api-usage.html#pagination for more details. If this was done intentionally, then this warning can be supressed by adding the argument `get_all=False` to the `list()` call

Why

  • This occurs when calling project.labels.list without specifying parameters that handle pagination.
  • We need to fetch more than the default 20 items without triggering this warning and potentially missing data.

How
We now leverage the AsyncFetcher.fetch_batch utility to make the request. Internally, fetch_batch sets get_all=False and handles pagination automatically, ensuring we can iterate over all items in batches without hitting the 20-item limit or triggering the warning.


Type of change

Please leave one option from the following and delete the rest:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • New Integration (non-breaking change which adds a new integration)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Non-breaking change (fix of existing functionality that will not change current behavior)
  • Documentation (added/updated documentation)

All tests should be run against the port production environment(using a testing org).

Core testing checklist

  • Integration able to create all default resources from scratch
  • Resync finishes successfully
  • Resync able to create entities
  • Resync able to update entities
  • Resync able to detect and delete entities
  • Scheduled resync able to abort existing resync and start a new one
  • Tested with at least 2 integrations from scratch
  • Tested with Kafka and Polling event listeners
  • Tested deletion of entities that don't pass the selector

Integration testing checklist

  • Integration able to create all default resources from scratch
  • Resync able to create entities
  • Resync able to update entities
  • Resync able to detect and delete entities
  • Resync finishes successfully
  • If new resource kind is added or updated in the integration, add example raw data, mapping and expected result to the examples folder in the integration directory.
  • If resource kind is updated, run the integration with the example data and check if the expected result is achieved
  • If new resource kind is added or updated, validate that live-events for that resource are working as expected
  • Docs PR link here

Preflight checklist

  • Handled rate limiting
  • Handled pagination
  • Implemented the code in async
  • Support Multi account

Screenshots

Include screenshots from your environment showing how the resources of the integration will look.

API Documentation

Provide links to the API documentation used for this integration.

@mk-armah mk-armah requested a review from a team as a code owner January 16, 2025 19:46
@mk-armah mk-armah changed the title Port 12531 [Integration][Gitlab] | Resolve UserWarning Log Jan 16, 2025
@mk-armah mk-armah merged commit 9b801b0 into main Jan 16, 2025
18 checks passed
@mk-armah mk-armah deleted the PORT-12531 branch January 16, 2025 22:22
@mk-armah mk-armah changed the title [Integration][Gitlab] | Resolve UserWarning Log [Integration][Gitlab] | Resolve UserWarning Log By Fixing Pagination for Project Labels Jan 17, 2025
@mk-armah mk-armah changed the title [Integration][Gitlab] | Resolve UserWarning Log By Fixing Pagination for Project Labels [Integration][Gitlab] | Resolve UserWarning Log By Fixing Pagination for Project Labels Requests Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants