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] Handle cases where handling event takes more than the allowed timeout #1326

Conversation

No0b1t0
Copy link
Contributor

@No0b1t0 No0b1t0 commented Jan 15, 2025

added timeout for asyncio.observer call, retries, logging of when the observer request started and an attempt to show the errors properly

Description

What - added a timeout to the async observer call, if the observer is stuck all are waiting. now, it will timeout and will attempt a retry after 90 second. the retry interval is based on a maximum time for event handling of a snapshot of logs

Why - as mentioned above, the timeout cases the process to hold and queue events are not being pulled and handled

How - added timeout, retries, additional logs

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.

… observer request started and an attempt to show the errors properly
@No0b1t0 No0b1t0 requested a review from a team as a code owner January 15, 2025 16:09
Copy link
Contributor

@Tankilevitch Tankilevitch left a comment

Choose a reason for hiding this comment

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

lets add changelog as well as bump version

Comment on lines 88 to 89
retries_left = 3
timeout = 90
Copy link
Contributor

Choose a reason for hiding this comment

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

lets store it in consts

@Tankilevitch Tankilevitch changed the title [Integration] Gitlab - no live events for merge requests timeout to for long pulls [Integration][Gitlab] Handle cases where handling event takes more than the allowed timeout Jan 15, 2025
@github-actions github-actions bot added size/M and removed size/S labels Jan 15, 2025
@No0b1t0 No0b1t0 requested a review from Tankilevitch January 15, 2025 17:13
Copy link
Contributor

@Tankilevitch Tankilevitch left a comment

Choose a reason for hiding this comment

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

LGTM

@Tankilevitch Tankilevitch merged commit d21ea6c into main Jan 15, 2025
19 checks passed
@Tankilevitch Tankilevitch deleted the PORT-12472-bug-git-lab-integration-no-live-events-for-merge-requests branch January 15, 2025 17:20
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