migrate sentry to config-based cdk #15345

girarda · 2022-08-05T03:00:38Z

What

Migrate the Sentry connector to config-based

How

Replace custom source with a source inheriting from YamlDeclarativeSource
Define the connector config in airbyte-integrations/connectors/source-sentry/source_sentry/sentry.yaml
Set additionalProperties to true in the spec

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

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.
/test connector=connectors/<name> command is passing
New Connector version released on Dockerhub by running the /publish command described here
After the connector is published, connector added to connector index as described here
Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as 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

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.
/test connector=connectors/<name> command is passing
New Connector version released on Dockerhub and connector version bumped 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

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

girarda · 2022-08-09T23:44:29Z

airbyte-integrations/connectors/source-sentry/source_sentry/sentry.yaml

+    page_size: "*ref(definitions.page_size)"
+    limit_option:
+      inject_into: "request_parameter"
+      field_name: ""


a bit absurd to to need this... cursor pagination should be a first-class paginator

girarda · 2022-08-09T23:44:44Z

airbyte-integrations/connectors/source-sentry/source_sentry/sentry.yaml

+    authenticator:
+      type: "BearerAuthenticator"
+      api_token: "{{ config.auth_token }}"
+  paginator:


the test account doesn't have enough data to test the pagination...

what about our actual sentry account?

Good idea! I was able to test the pagination on the events stream. The same pagination is used for issues and projects.

project_details does not have pagination https://docs.sentry.io/api/projects/retrieve-a-project/

girarda · 2022-08-09T23:45:03Z

/test connector=connectors/source-sentry

🕑 connectors/source-sentry https://github.com/airbytehq/airbyte/actions/runs/2829035752
❌ connectors/source-sentry https://github.com/airbytehq/airbyte/actions/runs/2829035752
🐛 https://gradle.com/s/qwpsj3t7lw27i

Build Failed

Test summary info:

	 =========================== short test summary info ============================
	 FAILED unit_tests/test_source.py::test_check_connection - assert (False,\n 'U...
	 �[31m============ �[31m�[1m1 failed�[0m, �[32m14 passed�[0m, �[33m42 warnings�[0m�[31m in 156.83s (0:02:36)�[0m�[31m =============�[0m

girarda · 2022-08-10T19:26:35Z

/test connector=connectors/source-sentry

🕑 connectors/source-sentry https://github.com/airbytehq/airbyte/actions/runs/2835176225
❌ connectors/source-sentry https://github.com/airbytehq/airbyte/actions/runs/2835176225
🐛 https://gradle.com/s/ncyy4znovpkkw

Build Failed

Test summary info:

=========================== short test summary info ============================
FAILED test_core.py::TestSpec::test_additional_properties_is_true[inputs0] - ...
FAILED test_core.py::TestBasicRead::test_read[inputs0] - AssertionError:  Rec...
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/plugin.py:60: Skipping TestIncremental.test_two_sequential_reads because not found in the config
=================== 2 failed, 24 passed, 1 skipped in 29.02s ===================

girarda · 2022-08-10T19:42:46Z

/test connector=connectors/source-sentry

🕑 connectors/source-sentry https://github.com/airbytehq/airbyte/actions/runs/2835264269
❌ connectors/source-sentry https://github.com/airbytehq/airbyte/actions/runs/2835264269
🐛 https://gradle.com/s/nkoa55jva4qjw

Build Failed

Test summary info:

=========================== short test summary info ============================
FAILED test_core.py::TestSpec::test_backward_compatibility[inputs0] - IndexEr...
FAILED test_core.py::TestBasicRead::test_read[inputs0] - AssertionError:  Rec...
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/plugin.py:60: Skipping TestIncremental.test_two_sequential_reads because not found in the config
=================== 2 failed, 24 passed, 1 skipped in 29.77s ===================

girarda · 2022-08-10T19:49:38Z

/test connector=connectors/source-sentry

🕑 connectors/source-sentry https://github.com/airbytehq/airbyte/actions/runs/2835298844
❌ connectors/source-sentry https://github.com/airbytehq/airbyte/actions/runs/2835298844
🐛 https://gradle.com/s/mzyeh5nage6yq

Build Failed

Test summary info:

=========================== short test summary info ============================
FAILED test_core.py::TestSpec::test_backward_compatibility[inputs0] - IndexEr...
FAILED test_core.py::TestConnection::test_check[inputs0] - AssertionError: as...
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/plugin.py:60: Skipping TestIncremental.test_two_sequential_reads because not found in the config
=================== 2 failed, 24 passed, 1 skipped in 29.31s ===================

girarda · 2022-08-10T19:59:50Z

/test connector=connectors/source-sentry

🕑 connectors/source-sentry https://github.com/airbytehq/airbyte/actions/runs/2835346839
❌ connectors/source-sentry https://github.com/airbytehq/airbyte/actions/runs/2835346839
🐛 https://gradle.com/s/evyillvlkxew2

Build Failed

Test summary info:

=========================== short test summary info ============================
FAILED test_core.py::TestConnection::test_check[inputs0] - AssertionError: as...
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/plugin.py:60: Skipping TestIncremental.test_two_sequential_reads because not found in the config
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/tests/test_core.py:67: Backward compatibility tests are disabled for version 0.1.1.
=================== 1 failed, 24 passed, 2 skipped in 27.40s ===================

girarda · 2022-08-10T20:36:39Z

/test connector=connectors/source-sentry

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

Name                        Stmts   Miss  Cover
-----------------------------------------------
source_sentry/source.py         4      0   100%
source_sentry/__init__.py       2      0   100%
source_sentry/streams.py       64     10    84%
-----------------------------------------------
TOTAL                          70     10    86%
	 Name                                                 Stmts   Miss  Cover   Missing
	 ----------------------------------------------------------------------------------
	 source_acceptance_test/base.py                          10      4    60%   15-18
	 source_acceptance_test/config.py                        83      6    93%   78-80, 84-86
	 source_acceptance_test/conftest.py                     164    164     0%   6-282
	 source_acceptance_test/plugin.py                        48     48     0%   6-104
	 source_acceptance_test/tests/test_core.py              338    111    67%   40, 60-68, 73-80, 84-85, 89-90, 174, 216-233, 253-261, 265-270, 276, 309-314, 356-363, 403-405, 408, 468-477, 506-507, 513, 516, 549-559, 572-597, 602-606
	 source_acceptance_test/tests/test_full_refresh.py       52      2    96%   34, 65
	 source_acceptance_test/tests/test_incremental.py       121     25    79%   21-23, 29-31, 36-43, 48-61, 208-214
	 source_acceptance_test/utils/asserts.py                 37      2    95%   57-58
	 source_acceptance_test/utils/common.py                  77     17    78%   15-16, 24-30, 47-54, 64, 67
	 source_acceptance_test/utils/compare.py                 62     23    63%   21-51, 68, 97-99
	 source_acceptance_test/utils/connector_runner.py       110     48    56%   23-26, 32, 36, 39-64, 67-69, 72-74, 77-79, 82-84, 87-89, 92-110, 144-146
	 source_acceptance_test/utils/json_schema_helper.py     105     13    88%   30-31, 38, 41, 65-68, 96, 120, 190-192
	 ----------------------------------------------------------------------------------
	 TOTAL                                                 1311    463    65%

Build Passed

Test summary info:

=========================== short test summary info ============================
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/plugin.py:60: Skipping TestIncremental.test_two_sequential_reads because not found in the config
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/tests/test_core.py:67: Backward compatibility tests are disabled for version 0.1.1.
======================== 25 passed, 2 skipped in 27.24s ========================

girarda · 2022-08-11T21:33:02Z

/test connector=connectors/source-sentry

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

	 Name                                                 Stmts   Miss  Cover   Missing
	 ----------------------------------------------------------------------------------
	 source_acceptance_test/base.py                          10      4    60%   15-18
	 source_acceptance_test/config.py                        83      6    93%   78-80, 84-86
	 source_acceptance_test/conftest.py                     164    164     0%   6-282
	 source_acceptance_test/plugin.py                        48     48     0%   6-104
	 source_acceptance_test/tests/test_core.py              329    111    66%   39, 50-58, 63-70, 74-75, 79-80, 164, 202-219, 228-236, 240-245, 251, 284-289, 327-334, 374-376, 379, 439-448, 477-478, 484, 487, 520-530, 543-568, 573-577
	 source_acceptance_test/tests/test_full_refresh.py       52      2    96%   34, 65
	 source_acceptance_test/tests/test_incremental.py       121     25    79%   21-23, 29-31, 36-43, 48-61, 208-214
	 source_acceptance_test/utils/asserts.py                 37      2    95%   57-58
	 source_acceptance_test/utils/common.py                  77     17    78%   15-16, 24-30, 47-54, 64, 67
	 source_acceptance_test/utils/compare.py                 62     23    63%   21-51, 68, 97-99
	 source_acceptance_test/utils/connector_runner.py       110     48    56%   23-26, 32, 36, 39-64, 67-69, 72-74, 77-79, 82-84, 87-89, 92-110, 144-146
	 source_acceptance_test/utils/json_schema_helper.py     105     13    88%   30-31, 38, 41, 65-68, 96, 120, 190-192
	 ----------------------------------------------------------------------------------
	 TOTAL                                                 1321    463    65%

Build Passed

Test summary info:

=========================== short test summary info ============================
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/plugin.py:60: Skipping TestIncremental.test_two_sequential_reads because not found in the config
======================== 26 passed, 1 skipped in 29.07s ========================

sherifnada

pretty easy to read these YAML connectors so far.

left a request for change because I think pagination is not implemented.

sherifnada · 2022-08-11T21:51:14Z

airbyte-integrations/connectors/source-sentry/source_sentry/sentry.yaml

+    authenticator:
+      type: "BearerAuthenticator"
+      api_token: "{{ config.auth_token }}"
+  paginator:


what about our actual sentry account?

sherifnada · 2022-08-11T21:51:38Z

airbyte-integrations/connectors/source-sentry/source_sentry/sentry.yaml

+      api_token: "{{ config.auth_token }}"
+  paginator:
+    type: LimitPaginator
+    url_base: "*ref(definitions.requester.url_base)"


why are we passing url_base to the paginator?

a bit of an implementation detail, but it's to replace the base url from the cursor when updating the path. although maybe that could be done in the retriever. left a comment on this

airbyte-integrations/connectors/source-sentry/source_sentry/sentry.yaml

sherifnada · 2022-08-11T21:56:44Z

airbyte-integrations/connectors/source-sentry/source_sentry/sentry.yaml

+      requester:
+        $ref: "*ref(definitions.requester)"
+        path: "projects/"
+      paginator:


this seems incorrect? https://docs.sentry.io/api/projects/list-your-projects/ has paginatino

good catch. also added it to the issues stream

sherifnada · 2022-08-11T21:57:27Z

airbyte-integrations/connectors/source-sentry/source_sentry/sentry.yaml

+    page_size: "*ref(definitions.page_size)"
+    limit_option:
+      inject_into: "request_parameter"
+      field_name: ""


what does it mean to have an empty field_name? is this correct?

the right solution here is probably for limit_option and page_token_option to be optional. left a comment

…ntry.yaml Co-authored-by: Sherif A. Nada <snadalive@gmail.com>

girarda · 2022-08-12T01:54:56Z

/publish connector=connectors/source-sentry

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

Connector	Did it publish?	Were definitions generated?
connectors/source-sentry	✅	✅

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

girarda added 2 commits August 4, 2022 19:47

events and projects

932dcac

done minus pagination

0c0135b

github-actions bot added the area/connectors Connector related issues label Aug 5, 2022

octavia-squidington-iii added the connectors/source/sentry label Aug 5, 2022

handle single records

f473dee

github-actions bot added the CDK Connector Development Kit label Aug 9, 2022

Merge branch 'master' into alex/configbased-sentry

666c170

github-actions bot removed the CDK Connector Development Kit label Aug 9, 2022

pagination

886c24a

girarda commented Aug 9, 2022

View reviewed changes

girarda added 4 commits August 9, 2022 16:47

bump min cdk version

e234a8d

start on unit tests

4bd72f1

Update more unit tests

e1c0ae0

Handle extracting no records from root

42af817

girarda added 2 commits August 10, 2022 12:26

Merge branch 'master' into alex/configbased-sentry

1f01abc

additionalProperties=true

ddae912

handle empty streams

d1c0224

skip backward compatibility tests

144f816

check on project_detail

0010cf3

girarda added 4 commits August 10, 2022 13:54

remove unit tests

793521e

handle missing keys

52d28fe

delete stream classes

d9252ae

Merge branch 'master' into alex/selectNoRecords

7975a89

github-actions bot removed kubernetes area/platform issues related to the platform labels Aug 11, 2022

enable backward compatibility test

0a9f825

github-actions bot removed the area/documentation Improvements or additions to documentation label Aug 11, 2022

girarda added 2 commits August 11, 2022 14:27

bump cdk version

4f16cb9

reset

5338da3

girarda removed connectors/source/postgres connectors/source/sendgrid connectors/source/file-secure connectors/source/relational-db connectors/source/hubplanner connectors/source/postgres-strict-encrypt labels Aug 11, 2022

girarda requested review from brianjlai and sherifnada August 11, 2022 21:32

girarda marked this pull request as ready for review August 11, 2022 21:32

sherifnada suggested changes Aug 11, 2022

View reviewed changes

girarda and others added 3 commits August 11, 2022 15:05

Update airbyte-integrations/connectors/source-sentry/source_sentry/se…

a2a0db8

…ntry.yaml Co-authored-by: Sherif A. Nada <snadalive@gmail.com>

Use paginator

37321d6

fix pagination

5a9bb1e

sherifnada approved these changes Aug 11, 2022

View reviewed changes

bump version

8e062cb

github-actions bot added the area/documentation Improvements or additions to documentation label Aug 12, 2022

auto-bump connector version [ci skip]

f4a9723

girarda merged commit 330a196 into master Aug 12, 2022

girarda deleted the alex/configbased-sentry branch August 12, 2022 02:33

octavia-squidington-iii mentioned this pull request Aug 19, 2022

Bump Airbyte version from 0.40.0-alpha to 0.40.1-alpha #15775

Closed

evantahler mentioned this pull request Aug 22, 2022

Bump Airbyte version from 0.40.0-alpha to 0.40.1 #15857

Merged

brianjlai mentioned this pull request Aug 29, 2022

Revert Sendgrid and Sentry to prior version using Python CDK instead of Low Code #16095

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

migrate sentry to config-based cdk #15345

migrate sentry to config-based cdk #15345

girarda commented Aug 5, 2022 •

edited

Loading

girarda Aug 9, 2022

girarda Aug 9, 2022

sherifnada Aug 11, 2022

girarda Aug 11, 2022

girarda commented Aug 9, 2022 •

edited by github-actions bot

Loading

girarda commented Aug 10, 2022 •

edited by github-actions bot

Loading

girarda commented Aug 10, 2022 •

edited by github-actions bot

Loading

girarda commented Aug 10, 2022 •

edited by github-actions bot

Loading

girarda commented Aug 10, 2022 •

edited by github-actions bot

Loading

girarda commented Aug 10, 2022 •

edited by github-actions bot

Loading

girarda commented Aug 11, 2022 •

edited by github-actions bot

Loading

sherifnada left a comment

sherifnada Aug 11, 2022

sherifnada Aug 11, 2022

girarda Aug 11, 2022

sherifnada Aug 11, 2022

girarda Aug 11, 2022

sherifnada Aug 11, 2022

girarda Aug 11, 2022

girarda commented Aug 12, 2022 •

edited by github-actions bot

Loading

migrate sentry to config-based cdk #15345

migrate sentry to config-based cdk #15345

Conversation

girarda commented Aug 5, 2022 • edited Loading

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Checklist

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

Tests

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

girarda commented Aug 9, 2022 • edited by github-actions bot Loading

Build Failed

girarda commented Aug 10, 2022 • edited by github-actions bot Loading

Build Failed

girarda commented Aug 10, 2022 • edited by github-actions bot Loading

Build Failed

girarda commented Aug 10, 2022 • edited by github-actions bot Loading

Build Failed

girarda commented Aug 10, 2022 • edited by github-actions bot Loading

Build Failed

girarda commented Aug 10, 2022 • edited by github-actions bot Loading

Build Passed

girarda commented Aug 11, 2022 • edited by github-actions bot Loading

Build Passed

sherifnada left a 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

girarda commented Aug 12, 2022 • edited by github-actions bot Loading

girarda commented Aug 5, 2022 •

edited

Loading

girarda commented Aug 9, 2022 •

edited by github-actions bot

Loading

girarda commented Aug 10, 2022 •

edited by github-actions bot

Loading

girarda commented Aug 10, 2022 •

edited by github-actions bot

Loading

girarda commented Aug 10, 2022 •

edited by github-actions bot

Loading

girarda commented Aug 10, 2022 •

edited by github-actions bot

Loading

girarda commented Aug 10, 2022 •

edited by github-actions bot

Loading

girarda commented Aug 11, 2022 •

edited by github-actions bot

Loading

girarda commented Aug 12, 2022 •

edited by github-actions bot

Loading