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

🐛Source GitHub: added description for no repos case error #26075

Merged

Conversation

darynaishchenko
Copy link
Collaborator

@darynaishchenko darynaishchenko commented May 15, 2023

resolved: https://github.com/airbytehq/oncall/issues/1747
Problem:
In case when user provided repository name that do not exist in github, or just wrong name (typo for example), connector says that is repository config is invalid, which is not clear.
Solution:
Added description why config can be invalid to help user fix it.

@darynaishchenko darynaishchenko self-assigned this May 15, 2023
@octavia-squidington-iii octavia-squidington-iii added area/connectors Connector related issues area/documentation Improvements or additions to documentation labels May 15, 2023
@github-actions
Copy link
Contributor

github-actions bot commented May 15, 2023

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 and you've followed all steps in the Breaking Changes Checklist
  • Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
  • 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
  • You, or an Airbyter, have run /test successfully on this PR - or on a non-forked branch
  • You, or an Airbyter, have run /publish successfully on this PR - or on a non-forked branch
  • You've updated the connector's metadata.yaml file new!

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.

@darynaishchenko
Copy link
Collaborator Author

darynaishchenko commented May 15, 2023

/test connector=connectors/source-github

🕑 connectors/source-github https://github.com/airbytehq/airbyte/actions/runs/4982422786
✅ connectors/source-github https://github.com/airbytehq/airbyte/actions/runs/4982422786
Python tests coverage:

Name                             Stmts   Miss  Cover
----------------------------------------------------
source_github/github_schema.py    8807      0   100%
source_github/__init__.py            2      0   100%
source_github/utils.py              16      1    94%
source_github/streams.py           838     91    89%
source_github/graphql.py           167     22    87%
source_github/source.py            137     37    73%
----------------------------------------------------
TOTAL                             9967    151    98%

Build Passed

Test summary info:

=========================== short test summary info ============================
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/connector_acceptance_test/tests/test_core.py:100: The previous and actual specifications are identical.
SKIPPED [2] ../usr/local/lib/python3.9/site-packages/connector_acceptance_test/tests/test_core.py:578: The previous and actual discovered catalogs are identical.
================== 47 passed, 3 skipped in 334.25s (0:05:34) ===================

@darynaishchenko darynaishchenko changed the title Source GitHub: added description for no repos case error 🐛Source GitHub: added description for no repos case error May 15, 2023
@darynaishchenko darynaishchenko marked this pull request as ready for review May 15, 2023 15:47
@darynaishchenko darynaishchenko force-pushed the daryna/source-github/exeption-no-streams-available branch from d79bd76 to a93239e Compare May 15, 2023 16:32
Copy link
Collaborator

@lazebnyi lazebnyi left a comment

Choose a reason for hiding this comment

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

LGTM! Minor changes needed.

@@ -234,7 +234,15 @@ def streams(self, config: Mapping[str, Any]) -> List[Stream]:
raise e

if not any((organizations, repositories)):
raise Exception("No streams available. Please check permissions")
user_message = (
Copy link
Collaborator

Choose a reason for hiding this comment

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

Need add unit tests for this functionality.

@darynaishchenko
Copy link
Collaborator Author

darynaishchenko commented May 16, 2023

/test connector=connectors/source-github

🕑 connectors/source-github https://github.com/airbytehq/airbyte/actions/runs/4991320444
✅ connectors/source-github https://github.com/airbytehq/airbyte/actions/runs/4991320444
Python tests coverage:

Name                             Stmts   Miss  Cover
----------------------------------------------------
source_github/github_schema.py    8807      0   100%
source_github/__init__.py            2      0   100%
source_github/utils.py              16      1    94%
source_github/streams.py           838     91    89%
source_github/graphql.py           167     22    87%
source_github/source.py            135     35    74%
----------------------------------------------------
TOTAL                             9965    149    99%

Build Passed

Test summary info:

=========================== short test summary info ============================
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/connector_acceptance_test/tests/test_core.py:100: The previous and actual specifications are identical.
SKIPPED [2] ../usr/local/lib/python3.9/site-packages/connector_acceptance_test/tests/test_core.py:578: The previous and actual discovered catalogs are identical.
================== 47 passed, 3 skipped in 321.13s (0:05:21) ===================

@darynaishchenko
Copy link
Collaborator Author

darynaishchenko commented May 16, 2023

/publish connector=connectors/source-github

🕑 Publishing the following connectors:
connectors/source-github
https://github.com/airbytehq/airbyte/actions/runs/4992301202


Connector Version Did it publish? Were definitions generated?
connectors/source-github 0.4.10

if you have connectors that successfully published but failed definition generation, follow step 4 here ▶️

@darynaishchenko darynaishchenko merged commit 0599080 into master May 16, 2023
@darynaishchenko darynaishchenko deleted the daryna/source-github/exeption-no-streams-available branch May 16, 2023 15:07
marcosmarxm pushed a commit to natalia-miinto/airbyte that referenced this pull request Jun 8, 2023
…26075)

* added description for no repos case error

* added AirbyteTracedException

* added changelog

* removed handling error in validation

* updated github.md

* added unit test test_streams_no_streams_available_error

* auto-bump connector version

---------

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation checklist-action-run connectors/source/github
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants