Source Zendesk Support: Convert `tickets.custom_fields` values to string #14829

grubberr · 2022-07-19T11:05:28Z

Signed-off-by: Sergey Chvalyuk grubberr@gmail.com

What

Fix for https://github.com/airbytehq/oncall/issues/320
"tickets.custom_fields" can be

"custom_fields": [
                {
                    "id": 360023382300,
                    "value": null
                },
                {
                    "id": 360004841380,
                    "value": "customer_tickets____transfer_in____origo_customer_action_required__rejection_"
                },
                {
                    "id": 360022469240,
                    "value": "5"
                },
                {
                    "id": 360023712840,
                    "value": false
                },
            ],

value(s) can be "boolean" type but current schema:

{
  "custom_fields": {
    "type": ["null", "array"],
    "items": {
      "properties": {
        "id": {
          "type": ["null", "integer"]
        },
        "value": {
          "type": ["null", "string"]
        }
      },
      "type": ["null", "object"]
    }
  }
}

How

We need to convert "boolean" to "string" for conform schema

Pre-merge Checklist

Expand the relevant checklist and delete the others.

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

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

grubberr · 2022-07-19T11:05:48Z

/test connector=connectors/source-zendesk-support

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

Name                                                 Stmts   Miss  Cover
------------------------------------------------------------------------
source_acceptance_test/utils/__init__.py                 6      0   100%
source_acceptance_test/tests/__init__.py                 4      0   100%
source_acceptance_test/__init__.py                       2      0   100%
source_acceptance_test/tests/test_full_refresh.py       52      2    96%
source_acceptance_test/utils/asserts.py                 37      2    95%
source_acceptance_test/config.py                        77      6    92%
source_acceptance_test/utils/json_schema_helper.py     105     13    88%
source_acceptance_test/tests/test_incremental.py       121     25    79%
source_acceptance_test/utils/common.py                  80     17    79%
source_acceptance_test/tests/test_core.py              298    106    64%
source_acceptance_test/utils/compare.py                 62     23    63%
source_acceptance_test/base.py                          10      4    60%
source_acceptance_test/utils/connector_runner.py       110     48    56%
------------------------------------------------------------------------
TOTAL                                                  964    246    74%
Name                                 Stmts   Miss  Cover
--------------------------------------------------------
source_zendesk_support/__init__.py       2      0   100%
source_zendesk_support/streams.py      331     34    90%
source_zendesk_support/source.py        44      6    86%
--------------------------------------------------------
TOTAL                                  377     40    89%

Build Passed

Test summary info:

All Passed

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

grubberr · 2022-07-21T11:59:20Z

/test connector=connectors/source-zendesk-support

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

Name                                                 Stmts   Miss  Cover
------------------------------------------------------------------------
source_acceptance_test/utils/__init__.py                 6      0   100%
source_acceptance_test/tests/__init__.py                 4      0   100%
source_acceptance_test/__init__.py                       2      0   100%
source_acceptance_test/tests/test_full_refresh.py       52      2    96%
source_acceptance_test/utils/asserts.py                 37      2    95%
source_acceptance_test/config.py                        77      6    92%
source_acceptance_test/utils/json_schema_helper.py     105     13    88%
source_acceptance_test/tests/test_incremental.py       121     25    79%
source_acceptance_test/utils/common.py                  80     17    79%
source_acceptance_test/tests/test_core.py              298    106    64%
source_acceptance_test/utils/compare.py                 62     23    63%
source_acceptance_test/base.py                          10      4    60%
source_acceptance_test/utils/connector_runner.py       110     48    56%
------------------------------------------------------------------------
TOTAL                                                  964    246    74%
Name                                 Stmts   Miss  Cover
--------------------------------------------------------
source_zendesk_support/__init__.py       2      0   100%
source_zendesk_support/streams.py      337     36    89%
source_zendesk_support/source.py        44      6    86%
--------------------------------------------------------
TOTAL                                  383     42    89%

Build Passed

Test summary info:

All Passed

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

grubberr · 2022-07-21T13:23:42Z

/test connector=connectors/source-zendesk-support

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

Name                                                 Stmts   Miss  Cover
------------------------------------------------------------------------
source_acceptance_test/utils/__init__.py                 6      0   100%
source_acceptance_test/tests/__init__.py                 4      0   100%
source_acceptance_test/__init__.py                       2      0   100%
source_acceptance_test/tests/test_full_refresh.py       52      2    96%
source_acceptance_test/utils/asserts.py                 37      2    95%
source_acceptance_test/config.py                        77      6    92%
source_acceptance_test/utils/json_schema_helper.py     105     13    88%
source_acceptance_test/tests/test_incremental.py       121     25    79%
source_acceptance_test/utils/common.py                  80     17    79%
source_acceptance_test/tests/test_core.py              298    106    64%
source_acceptance_test/utils/compare.py                 62     23    63%
source_acceptance_test/base.py                          10      4    60%
source_acceptance_test/utils/connector_runner.py       110     48    56%
------------------------------------------------------------------------
TOTAL                                                  964    246    74%
Name                                 Stmts   Miss  Cover
--------------------------------------------------------
source_zendesk_support/__init__.py       2      0   100%
source_zendesk_support/streams.py      337     34    90%
source_zendesk_support/source.py        44      6    86%
--------------------------------------------------------
TOTAL                                  383     40    90%

Build Passed

Test summary info:

All Passed

sherifnada · 2022-07-21T17:18:53Z

airbyte-integrations/connectors/source-zendesk-support/source_zendesk_support/streams.py

@@ -475,6 +475,13 @@ class Tickets(SourceZendeskIncrementalExportStream):

    response_list_name: str = "tickets"

+    def parse_response(self, response: requests.Response, **kwargs) -> Iterable[Mapping]:


any reason not to use the TypeTransformer here?

Changed to use TypeTransformer!

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

grubberr · 2022-07-21T21:26:39Z

/test connector=connectors/source-zendesk-support

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

Name                                                 Stmts   Miss  Cover
------------------------------------------------------------------------
source_acceptance_test/utils/__init__.py                 6      0   100%
source_acceptance_test/tests/__init__.py                 4      0   100%
source_acceptance_test/__init__.py                       2      0   100%
source_acceptance_test/tests/test_full_refresh.py       52      2    96%
source_acceptance_test/utils/asserts.py                 37      2    95%
source_acceptance_test/config.py                        77      6    92%
source_acceptance_test/utils/json_schema_helper.py     105     13    88%
source_acceptance_test/tests/test_incremental.py       121     25    79%
source_acceptance_test/utils/common.py                  80     17    79%
source_acceptance_test/tests/test_core.py              298    106    64%
source_acceptance_test/utils/compare.py                 62     23    63%
source_acceptance_test/base.py                          10      4    60%
source_acceptance_test/utils/connector_runner.py       110     48    56%
------------------------------------------------------------------------
TOTAL                                                  964    246    74%
Name                                 Stmts   Miss  Cover
--------------------------------------------------------
source_zendesk_support/__init__.py       2      0   100%
source_zendesk_support/streams.py      332     34    90%
source_zendesk_support/source.py        44      6    86%
--------------------------------------------------------
TOTAL                                  378     40    89%

Build Passed

Test summary info:

All Passed

grubberr · 2022-07-22T04:49:29Z

/publish connector=connectors/source-zendesk-support

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

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

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

extend schema for tickets

ebb488f

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

github-actions bot added the area/connectors Connector related issues label Jul 19, 2022

octavia-squidington-iii added the connectors/source/zendesk-support label Jul 19, 2022

grubberr self-assigned this Jul 19, 2022

grubberr added 3 commits July 21, 2022 14:38

Merge branch 'master' into grubberr/oncall-320-source-zendesk-support

1943955

parse "custom_fields"

d53fd2c

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

zendesk-support.md updated

5dabf9f

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

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

grubberr changed the title ~~Source Zendesk Support: extend schema for tickets~~ Source Zendesk Support: Convert tickets.custom_fields values to string Jul 21, 2022

grubberr requested a review from arsenlosenko July 21, 2022 12:08

arsenlosenko approved these changes Jul 21, 2022

View reviewed changes

grubberr requested a review from sherifnada July 21, 2022 12:45

grubberr added 2 commits July 21, 2022 15:56

Merge branch 'master' into grubberr/oncall-320-source-zendesk-support

12d1133

test_read_tickets_stream added

1790c27

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

sherifnada reviewed Jul 21, 2022

View reviewed changes

grubberr added 2 commits July 21, 2022 21:42

Merge branch 'master' into grubberr/oncall-320-source-zendesk-support

3494f98

use transformer

ce659be

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

grubberr requested a review from sherifnada July 21, 2022 21:45

sherifnada approved these changes Jul 22, 2022

View reviewed changes

auto-bump connector version [ci skip]

7b2c98a

grubberr merged commit 29d6fc8 into master Jul 22, 2022

grubberr deleted the grubberr/oncall-320-source-zendesk-support branch July 22, 2022 05:14

octavia-squidington-iii mentioned this pull request Jul 23, 2022

Bump Airbyte version from 0.39.37-alpha to 0.39.38-alpha #14976

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Source Zendesk Support: Convert `tickets.custom_fields` values to string #14829

Source Zendesk Support: Convert `tickets.custom_fields` values to string #14829

grubberr commented Jul 19, 2022 •

edited

Loading

grubberr commented Jul 19, 2022 •

edited by github-actions bot

Loading

grubberr commented Jul 21, 2022 •

edited by github-actions bot

Loading

grubberr commented Jul 21, 2022 •

edited by github-actions bot

Loading

sherifnada Jul 21, 2022

grubberr Jul 21, 2022

grubberr commented Jul 21, 2022 •

edited by github-actions bot

Loading

grubberr commented Jul 22, 2022 •

edited by github-actions bot

Loading

		@@ -475,6 +475,13 @@ class Tickets(SourceZendeskIncrementalExportStream):

		response_list_name: str = "tickets"

		def parse_response(self, response: requests.Response, **kwargs) -> Iterable[Mapping]:

Source Zendesk Support: Convert tickets.custom_fields values to string #14829

Source Zendesk Support: Convert tickets.custom_fields values to string #14829

Conversation

grubberr commented Jul 19, 2022 • edited Loading

What

How

Pre-merge Checklist

Community member or Airbyter

Airbyter

Tests

grubberr commented Jul 19, 2022 • edited by github-actions bot Loading

Build Passed

grubberr commented Jul 21, 2022 • edited by github-actions bot Loading

Build Passed

grubberr commented Jul 21, 2022 • edited by github-actions bot Loading

Build Passed

sherifnada Jul 21, 2022

Choose a reason for hiding this comment

grubberr Jul 21, 2022

Choose a reason for hiding this comment

grubberr commented Jul 21, 2022 • edited by github-actions bot Loading

Build Passed

grubberr commented Jul 22, 2022 • edited by github-actions bot Loading

Source Zendesk Support: Convert `tickets.custom_fields` values to string #14829

Source Zendesk Support: Convert `tickets.custom_fields` values to string #14829

grubberr commented Jul 19, 2022 •

edited

Loading

grubberr commented Jul 19, 2022 •

edited by github-actions bot

Loading

grubberr commented Jul 21, 2022 •

edited by github-actions bot

Loading

grubberr commented Jul 21, 2022 •

edited by github-actions bot

Loading

grubberr commented Jul 21, 2022 •

edited by github-actions bot

Loading

grubberr commented Jul 22, 2022 •

edited by github-actions bot

Loading