New source: Zenhub Graphql #33986

Jgerardopine · 2024-01-05T20:39:54Z

What

Adding a new source: Zenhub

How

This solution gets all the issues form the zenhub repositories by providing a namespace and (optional) repositories

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user?
No Breaking changes

For connector PRs, use this section to explain which type of semantic versioning bump occurs as a result of the changes. Refer to our Semantic Versioning for Connectors guidelines for more information. Breaking changes to connectors must be documented by an Airbyte engineer (PR author, or reviewer for community PRs) by using the Breaking Change Release Playbook.

If there are breaking changes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Actions

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

Community member? Grant edit access to maintainers (instructions)
Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
Connector version is set to 0.0.1
- Dockerfile has version 0.0.1
Documentation updated
- Connector's README.md
- Connector's bootstrap.md. See description and examples
- docs/integrations/<source or destination>/<name>.md including changelog with an entry for the initial version. See changelog example
- docs/integrations/README.md

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
If new credentials are required for use in CI, add them to GSM. Instructions.

Updating a connector

Community member or Airbyter

Grant edit access to maintainers (instructions)
Unit & integration tests added

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
If new credentials are required for use in CI, add them to GSM. Instructions.

Connector Generator

Issue acceptance criteria met
PR name follows PR naming conventions
If adding a new generator, add it to the list of scaffold modules being tested
The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:generateScaffolds then checking in your changes
Documentation which references the generator is updated as needed

Updating the Python CDK

Airbyter

Before merging:

Pull Request description explains what problem it is solving
Code change is unit tested
Build and my-py check pass
Smoke test the change on at least one affected connector
- On Github: Run this workflow, passing --use-local-cdk --name=source-<connector> as options
- Locally: airbyte-ci connectors --use-local-cdk --name=source-<connector> test
PR is reviewed and approved

After merging:

Publish the CDK
- The CDK does not follow proper semantic versioning. Choose minor if this the change has significant user impact or is a breaking change. Choose patch otherwise.
- Write a thoughtful changelog message so we know what was updated.
Merge the platform PR that was auto-created for updating the Connector Builder's CDK version
- This step is optional if the change does not affect the connector builder or declarative connectors.

…s to search for specific keys in a response, and all the basic structure that came with the Python HTTP API

CLAassistant · 2024-01-05T20:40:01Z

All committers have signed the CLA.

vercel · 2024-01-05T20:40:01Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
airbyte-docs	⬜️ Ignored (Inspect)	Visit Preview		Jan 21, 2024 9:06pm

github-actions · 2024-01-05T20:40:13Z

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,

Check for hidden checklists in your PR description
Toggle the github label checklist-action-run on/off to re-run the checklist CI.

…ght place

Jgerardopine · 2024-01-06T03:12:13Z

airbyte-integrations/connectors/source-zenhub-graphql/source_zenhub_graphql/source.py

-
-    @property
-    def http_method(self) -> str:
-        return "POST"


I put the POST property in the wrong class.

Jgerardopine · 2024-01-06T03:12:27Z

airbyte-integrations/connectors/source-zenhub-graphql/source_zenhub_graphql/streams.py

-
+    @property
+    def http_method(self) -> str:
+        return "POST"


This is the fix

…hange to empty string)

girarda · 2024-01-21T20:56:19Z

airbyte-integrations/connectors/source-zenhub-graphql/README.md

@@ -0,0 +1,166 @@
+# Zenhub Graphql Source


why do we need a new source? Can't we update the existing zenhub connector?

edit: derp. there's no zenhub connector. Is the fact that this is using graphql relevant to the user? Why not call this the zenhub source?

Yes, you are right. It is not relevant for the user. I will rename it to be just Zenhub

bleonard · 2024-01-22T21:37:42Z

airbyte-integrations/connectors/source-zenhub-graphql/integration_tests/sample_config.json

+{
+  "access_token": "<user's_access_token>"
+  , "workspace_name": "<your_workspace>"
+  , "repo_names": ["yout_list","of_repos"]


bleonard · 2024-01-22T21:38:02Z

airbyte-integrations/connectors/source-zenhub-graphql/README.md

@@ -0,0 +1,166 @@
+# Zenhub Graphql Source


bleonard · 2024-01-22T21:43:39Z

airbyte-integrations/connectors/source-zenhub-graphql/source_zenhub_graphql/streams.py

+        for issue in issues:
+            pipeline_issue= issue.get('pipelineIssue', {}) or {}
+            pipeline = pipeline_issue.get('pipeline', {}) or {}
+            prioirity = pipeline_issue.get('priority', {}) or {}


typo in variable name

bleonard · 2024-01-22T21:44:31Z

airbyte-integrations/connectors/source-zenhub-graphql/source_zenhub_graphql/streams.py

+        issues_query.totalCount()
+        issue_node = issues_query.nodes.__as__(Issue)
+        issue_node.id()
+        issue_node.ghId()


This builds the query? Interesting.

bleonard · 2024-01-22T21:54:41Z

airbyte-integrations/connectors/source-zenhub-graphql/integration_tests/configured_catalog.json

+      "stream": {
+        "name": "zenhub_issues",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh", "incremental"]


Do you know how you are going to do incremental syncs here?
I see the searchIssuesByPipeline query in the Explorer. It looks like it has a sort order. Maybe by udpated_at. Is that the plan?

Yes, I am thinking on using updated_at

natikgadzhi · 2024-04-09T19:44:56Z

We can get back to this sometime, but for now — closing.

Jgerardopine added 3 commits January 5, 2024 01:03

Initial comit. Contains Workspace endpoint, graphql declaration, util…

e9e3c1d

…s to search for specific keys in a response, and all the basic structure that came with the Python HTTP API

Enter Discovery phase

365d432

Trying to get the body in the right format in the HTTP request

6e05c77

octavia-squidington-iii added the area/connectors Connector related issues label Jan 5, 2024

octavia-squidington-iii added the connectors/source/zenhub-graphql label Jan 5, 2024

Jgerardopine assigned maxi297 Jan 5, 2024

Fix issue with wrong query. Solution add http post property in the ri…

1b6572f

…ght place

Jgerardopine commented Jan 6, 2024

View reviewed changes

First endpoint. Check, Discover and Read tests passed

8784bb3

katmarkham self-assigned this Jan 10, 2024

Jgerardopine added 8 commits January 20, 2024 11:39

Clean some comments, order code

80ee7bf

Add the second stream, to get al pipelines

3eaf3d3

Add workspace_id to returned dict

c130ab2

Add third stream - Get all issues

7e16b6c

Fix find_ids_by_name function

9d22ef3

Fix problem on graphql Issues query. It was malformed.

dfb52e7

Add parse_repsonse. Change yield object logic to allow None values (c…

f6b56c8

…hange to empty string)

Adding basic Acceptance tests

f105de1

Jgerardopine assigned artem1205 and lazebnyi and unassigned maxi297 and katmarkham Jan 21, 2024

Merge branch 'master' into jgpines/zenhub_cdk_graphql

0b414f5

Jgerardopine assigned maxi297 Jan 21, 2024

vercel bot deployed to Preview January 21, 2024 04:22 View deployment

Some cleanup, changes and update on Issues Schema

469b229

Change back the catalogs (after several experiments).

706c101

girarda reviewed Jan 21, 2024

View reviewed changes

Updates to Schemas

5baa44d

Jgerardopine unassigned maxi297 Jan 22, 2024

Jgerardopine requested a review from lazebnyi January 22, 2024 14:53

Jgerardopine assigned Jgerardopine and unassigned artem1205 and lazebnyi Jan 22, 2024

bleonard reviewed Jan 22, 2024

View reviewed changes

natikgadzhi closed this Apr 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New source: Zenhub Graphql #33986

New source: Zenhub Graphql #33986

Jgerardopine commented Jan 5, 2024

CLAassistant commented Jan 5, 2024 •

edited

Loading

vercel bot commented Jan 5, 2024 •

edited

Loading

github-actions bot commented Jan 5, 2024 •

edited by Jgerardopine

Loading

Jgerardopine Jan 6, 2024

Jgerardopine Jan 6, 2024

girarda Jan 21, 2024 •

edited

Loading

Jgerardopine Jan 22, 2024 •

edited

Loading

bleonard Jan 22, 2024

bleonard Jan 22, 2024

bleonard Jan 22, 2024

bleonard Jan 22, 2024

bleonard Jan 22, 2024

Jgerardopine Jan 22, 2024

bleonard Jan 22, 2024

Jgerardopine Jan 22, 2024

natikgadzhi commented Apr 9, 2024

New source: Zenhub Graphql #33986

New source: Zenhub Graphql #33986

Conversation

Jgerardopine commented Jan 5, 2024

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Actions

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

Airbyter

CLAassistant commented Jan 5, 2024 • edited Loading

vercel bot commented Jan 5, 2024 • edited Loading

github-actions bot commented Jan 5, 2024 • edited by Jgerardopine Loading

Before Merging a Connector Pull Request

Choose a reason for hiding this comment

Choose a reason for hiding this comment

girarda Jan 21, 2024 • edited Loading

Choose a reason for hiding this comment

Jgerardopine Jan 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

natikgadzhi commented Apr 9, 2024

CLAassistant commented Jan 5, 2024 •

edited

Loading

vercel bot commented Jan 5, 2024 •

edited

Loading

github-actions bot commented Jan 5, 2024 •

edited by Jgerardopine

Loading

girarda Jan 21, 2024 •

edited

Loading

Jgerardopine Jan 22, 2024 •

edited

Loading