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.

Sign up for GitHub

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

Jump to bottom

Source Jira: Add Board, Epic, and Sprint-related streams and improve request caching #6621

Merged
merged 27 commits into from
Oct 20, 2021
Merged

Source Jira: Add Board, Epic, and Sprint-related streams and improve request caching #6621

merged 27 commits into from
Oct 20, 2021

Conversation

cjwooo
Copy link
Contributor

@cjwooo cjwooo commented Oct 1, 2021

What

Should merge #6523 first.
Add BoardIssues, Epics, EpicIssues, and SprintIssues streams.
Allow nested caching of streams utilizing the VCR library.

How

By putting the VCR cache of each stream into its own file, we avoid the nested caching restriction of the VCR library.

Recommended reading order

  1. x.java
  2. y.python

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • 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.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/SUMMARY.md
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions
  • Connector added to connector index like described here

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
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here

Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • 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.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions
  • Connector version bumped like described here

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
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here

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:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed.

@github-actions github-actions bot added the area/connectors Connector related issues label Oct 1, 2021
@cjwooo
Copy link
Contributor Author

cjwooo commented Oct 8, 2021

@sherifnada Can someone review this when they get the chance?

@sherifnada
Copy link
Contributor

@cjwooo apologies for the delay here! Make sure to tag one of us as a reviewer (best Marcos) to make sure we triage in the future.

Did you look into CDK caching? It is being documented here #6846. It would preclude the need to implement custom caching. Would love to hear if it can fill your use case

@cjwooo
Copy link
Contributor Author

cjwooo commented Oct 11, 2021

Pinging @marcosmarxm as suggested.

@cjwooo
Copy link
Contributor Author

cjwooo commented Oct 11, 2021

@sherifnada Looks like the CDK caching does fit our use case. I will integrate it into the Jira source and test it out.

@marcosmarxm marcosmarxm self-assigned this Oct 12, 2021
vitaliizazmic
vitaliizazmic reviewed Oct 13, 2021
View reviewed changes
Copy link
Contributor

@vitaliizazmic vitaliizazmic left a comment

Choose a reason for hiding this comment

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

There are a lot of changes beside new streams and nested caching. Could PR be splitted?

sherifnada
sherifnada reviewed Oct 13, 2021
View reviewed changes
Copy link
Contributor

@sherifnada sherifnada left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM, thanks @cjwooo !

@vitaliizazmic can you make sure we get this published?

airbyte-integrations/connectors/source-jira/source_jira/spec.json Outdated Show resolved Hide resolved
airbyte-integrations/connectors/source-jira/source_jira/spec.json Show resolved Hide resolved
bazarnov
bazarnov requested changes Oct 14, 2021
View reviewed changes
Copy link
Collaborator

@bazarnov bazarnov left a comment

Choose a reason for hiding this comment

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

Small changes required, to minimise the possibility of future bugs with hardcoded field names.

airbyte-integrations/connectors/source-jira/source_jira/streams.py Outdated Show resolved Hide resolved
airbyte-integrations/connectors/source-jira/source_jira/streams.py Outdated Show resolved Hide resolved
airbyte-integrations/connectors/source-jira/source_jira/streams.py Outdated Show resolved Hide resolved
airbyte-integrations/connectors/source-jira/source_jira/streams.py Outdated Show resolved Hide resolved
@cjwooo
Copy link
Contributor Author

cjwooo commented Oct 14, 2021

@sherifnada I've updated the code to use the CDK's caching functionality.

@bazarnov bazarnov self-requested a review October 14, 2021 19:02
sherifnada
sherifnada approved these changes Oct 15, 2021
View reviewed changes
Copy link
Contributor

@sherifnada sherifnada left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM, thanks @cjwooo !

Will get this published soon.

@vitaliizazmic would you be able to push this one to the finish line?

@marcosmarxm marcosmarxm merged commit 1fcd6c4 into airbytehq:master Oct 20, 2021
@sherifnada
Copy link
Contributor

@cjwooo apologies - I missed something in this PR: the spec.json adds some required fields which makes this change backwards incompatible. Could we treat those fields as optional?

@cjwooo
Copy link
Contributor Author

cjwooo commented Oct 20, 2021

Will do

@cjwooo cjwooo mentioned this pull request Oct 20, 2021
Merged
38 tasks
@cjwooo
Copy link
Contributor Author

cjwooo commented Oct 20, 2021

@sherifnada #7222

@jrhizor jrhizor mentioned this pull request Oct 21, 2021
Merged
schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
@cjwooo @schlattk
Source Jira: Add Board, Epic, and Sprint-related streams and improve …
845bccd 
…request caching (airbytehq#6621)

* Create separate cache file per stream and add projects and start_date config

* Add project id to issue record

* Add projectId to issue schema

* Add BoardIssues stream

* Add SprintIssues stream

* Add Epics stream and deduplicate state code

* Add EpicIssues stream and additional fields for Issues stream

* Add story points to sprint issues

* Add new streams to test catalog

* Update gitignore

* Rename cache boolean and fix test catalog

* Fix streams that depend on Issues stream

* Fix sprint_issues stream

* Add more fields to issues stream and format

* Add option to expand issue changelogs

* Remove epic_issues stream

* Expand project descriptions

* Show rendered fields for epics

* Include project key

* Include project key in issues stream

* Address comments

* Use CDK caching

* Remove extra changes

* Fix sprints stream reading from non-scrum boards

* Format
@cjwooo cjwooo deleted the cwu/jira2 branch January 26, 2022 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marcosmarxm marcosmarxm marcosmarxm left review comments

@vitaliizazmic vitaliizazmic vitaliizazmic left review comments

@sherifnada sherifnada sherifnada approved these changes

@bazarnov bazarnov bazarnov approved these changes

Assignees

@marcosmarxm marcosmarxm

Labels
area/connectors Connector related issues community
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@cjwooo @sherifnada @marcosmarxm @bazarnov @vitaliizazmic