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

connectors-ci: implement per step time out #28771

Merged

Conversation

alafanechere
Copy link
Contributor

@alafanechere alafanechere commented Jul 27, 2023

What

Closes #28769

Problem: Some infinitely hanging pipeline step can block other and make a full GHA workflow timeout.
Solution: Implement a per step timeout logic.

How

  • Use anyio.fail_after feature
  • Tweak run_with_completion to raise TimeOutError when the execution duration exceeds the Step.max_duration value.
  • Set a default max duration to 5 hours on Step
  • Set a max duration of 10mn on ConnectorPackageInstall(Step) to prevent pip infinite dependency problems to timeout the GHA workflows.
  • Unit test the change.

@octavia-squidington-iii octavia-squidington-iii added the area/connectors Connector related issues label Jul 27, 2023
@github-actions
Copy link
Contributor

Before Merging a Connector Pull Request

Wow! What a great pull request you have here! 🎉

To merge this PR, ensure the following has been done/considered for each connector added or updated:

  • PR name follows PR naming conventions
  • Breaking changes are considered. If a Breaking Change is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan.
  • Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
  • You've updated the connector's metadata.yaml file any other relevant changes, including a breakingChanges entry for major version bumps. See metadata.yaml docs
  • Secrets in the connector's spec are annotated with airbyte_secret
  • All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
  • Changelog updated in docs/integrations/<source or destination>/<name>.md with an entry for the new version. See changelog example
  • Migration guide updated in docs/integrations/<source or destination>/<name>-migrations.md with an entry for the new version, if the version is a breaking change. See migration guide example
  • If set, you've ensured the icon is present in the platform-internal repo. (Docs)

If the checklist is complete, but the CI check is failing,

  1. Check for hidden checklists in your PR description

  2. Toggle the github label checklist-action-run on/off to re-run the checklist CI.

This reverts commit 2f4fd39.
@octavia-squidington-iii octavia-squidington-iii removed the area/connectors Connector related issues label Jul 27, 2023
@octavia-squidington-iii
Copy link
Collaborator

source-openweather test report (commit 2f4fd39225) - ✅

⏲️ Total pipeline duration: 03mn01s

Step Result
Validate airbyte-integrations/connectors/source-openweather/metadata.yaml
Connector version semver check
QA checks
Code format checks
Connector package install
Build source-openweather docker image for platform linux/x86_64
Unit tests
Acceptance tests

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-openweather test

@octavia-squidington-iii
Copy link
Collaborator

source-file test report (commit 2f4fd39225) - ❌

⏲️ Total pipeline duration: 10mn03s

Step Result
Validate airbyte-integrations/connectors/source-file/metadata.yaml
Connector version semver check
QA checks
Code format checks
Connector package install

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-file test

@alafanechere
Copy link
Contributor Author

/approve-and-merge reason="this PR unblocks the nightly build, I've thoroughly tested it, and my team is asleep and can't review"

@octavia-approvington
Copy link
Contributor

Send it!
rocket socks

@octavia-approvington octavia-approvington merged commit 9cee15b into master Jul 27, 2023
@octavia-approvington octavia-approvington deleted the augustin/connectors-ci/implement-per-step-timeout branch July 27, 2023 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

connectors-ci: hanging step block pipeline completion
3 participants