🎉 Source Intercom: Added conversation_id field to conversation_part records #11206

lgomezm · 2022-03-16T18:59:52Z

What

Records from the ConversationParts stream don't have conversation_id, so in a scenario where a connection is configured to sync conversations and conversation_parts, there is no hay to determine what conversation_parts belong to what conversations at the destination.

How

Added the conversation_id property to the records yielded by the ConversationParts stream.

🚨 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 by running the /publish command described here
After the new connector version is published, connector version bumped in the seed directory 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

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.

lgomezm · 2022-03-16T19:03:02Z

Since I added a new unit tests, here's the unit test execution:

I had no success at running the integration tests. It looks like they are configured to run with a test account I don't have access to. Please run them when you get a chance.

alafanechere

Thank you for your contribution @lgomezm! I made a minor suggestion. I'll run the acceptance tests and will approve/request changes according to results 🥁

alafanechere · 2022-03-21T18:16:23Z

airbyte-integrations/connectors/source-intercom/source_intercom/source.py

+            if 'conversation_id' not in conversation_part:
+                conversation_part['conversation_id'] = conversation_id


Suggested change

if 'conversation_id' not in conversation_part:

conversation_part['conversation_id'] = conversation_id

conversation_part.setdefault("conversation_id", "conversation_id")

Done in c88184b.

alafanechere · 2022-03-22T08:31:11Z

/test connector=connectors/source-intercom

🕑 connectors/source-intercom https://github.com/airbytehq/airbyte/actions/runs/2021143885
❌ connectors/source-intercom https://github.com/airbytehq/airbyte/actions/runs/2021143885
🐛 https://gradle.com/s/cqagvp74hyhpc

alafanechere

@lgomezm the tests are failing because you did not run ./gradlew format. Please run it and push the changes. You'll have to rename the unit test you declared to make the flake test pass. I'm ready to merge it afterward.

alafanechere · 2022-03-22T17:56:40Z

airbyte-integrations/connectors/source-intercom/unit_tests/unit_test.py

@@ -76,3 +76,35 @@ def test_switch_to_standard_endpoint_if_scroll_expired(requests_mock):
        records += list(stream1.read_records(sync_mode=SyncMode, stream_slice=slice))

    assert stream1._endpoint_type == Companies.EndpointType.standard
+
+
+def test_switch_to_standard_endpoint_if_scroll_expired(requests_mock):


This test is badly named and another these already has this name.

Suggested change

def test_switch_to_standard_endpoint_if_scroll_expired(requests_mock):

def test_conversation_part_has_conversation_id(requests_mock):

Good catch! Updated in 8aebb16

lgomezm · 2022-03-22T21:58:40Z

@alafanechere I've addressed your comments and ran gradlew format. Please let me know if there's anything else I should do. Thanks for reviewing!

alafanechere · 2022-03-23T13:28:54Z

/test connector=connectors/source-intercom

🕑 connectors/source-intercom https://github.com/airbytehq/airbyte/actions/runs/2028679661
✅ connectors/source-intercom https://github.com/airbytehq/airbyte/actions/runs/2028679661
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                        74      6    92%
source_acceptance_test/utils/json_schema_helper.py     105     13    88%
source_acceptance_test/utils/common.py                  70     17    76%
source_acceptance_test/utils/compare.py                 62     23    63%
source_acceptance_test/tests/test_core.py              275    106    61%
source_acceptance_test/base.py                          10      4    60%
source_acceptance_test/utils/connector_runner.py       110     48    56%
source_acceptance_test/tests/test_incremental.py        69     38    45%
------------------------------------------------------------------------
TOTAL                                                  876    259    70%
Name                          Stmts   Miss  Cover
-------------------------------------------------
source_intercom/__init__.py       2      0   100%
source_intercom/source.py       224     42    81%
-------------------------------------------------
TOTAL                           226     42    81%
Name                          Stmts   Miss  Cover
-------------------------------------------------
source_intercom/__init__.py       2      0   100%
source_intercom/source.py       224     55    75%
-------------------------------------------------
TOTAL                           226     55    76%

alafanechere

@lgomezm I'm ready to publish the new version. Could you please bump the version number in:

airbyte-integrations/connectors/source-intercom/Dockerfile
airbyte-config/init/src/main/resources/seed/source_definitions.yaml

Please also update the changelog in docs/integrations/sources/intercom.md.

I'll then run the publish command from the comments. Afterward you need to locally run ./gradlew airbyte-config:init:processResources . This will update the /Users/augustin/workspace/airbyte/airbyte-config/init/src/main/resources/seed/source_specs.yaml, please then commit this file.

I would have liked to do this myself but as I don't have push permission on your organization fork I need to ask you to do this 😄

lgomezm · 2022-03-23T14:45:13Z

@alafanechere In 70216ed, I've updated:

airbyte-integrations/connectors/source-intercom/Dockerfile
airbyte-config/init/src/main/resources/seed/source_definitions.yaml
docs/integrations/sources/intercom.md

Please let me know when you publish, so I can run that final gradle command and push the changes again.

alafanechere · 2022-03-24T19:43:16Z

/publish connector=connectors/source-intercom

🕑 connectors/source-intercom https://github.com/airbytehq/airbyte/actions/runs/2036278591
✅ connectors/source-intercom https://github.com/airbytehq/airbyte/actions/runs/2036278591

alafanechere · 2022-03-25T08:15:15Z

@lgomezm the connector is published, please run ./gradlew airbyte-config:init:processResources and commit + push the change made to the source_specs.yaml file. We can merge afterward 🎉

lgomezm · 2022-03-25T15:56:21Z

@alafanechere Done. source_specs.yaml was updated in 1dd4fd5.

alafanechere

Thank you for this contrib @lgomezm !

lgomezm changed the title ~~Source Intercom: Added conversation_id field to conversation_part records~~ 🎉 Source Intercom: Added conversation_id field to conversation_part records Mar 16, 2022

github-actions bot added the area/connectors Connector related issues label Mar 16, 2022

octavia-squidington-iii added the community label Mar 16, 2022

alafanechere self-assigned this Mar 21, 2022

alafanechere reviewed Mar 21, 2022

View reviewed changes

alafanechere requested changes Mar 22, 2022

View reviewed changes

alafanechere requested changes Mar 23, 2022

View reviewed changes

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

lgomezm added 6 commits March 23, 2022 09:39

Added conversation_id to conversation_part records

ac14dbf

Added unit test

f3eade4

Refactored conversation_parts stream

66d931f

Renamed unit test

f8062ae

Ran gradlew format

1fc1a11

Bumped connector version

70216ed

lgomezm force-pushed the lgomez/intercom_conversation_parts_with_conversation_id branch from 35e3909 to 70216ed Compare March 23, 2022 14:42

Updated source_specs.yaml

1dd4fd5

alafanechere approved these changes Mar 25, 2022

View reviewed changes

alafanechere merged commit 787daa9 into airbytehq:master Mar 25, 2022

lgomezm deleted the lgomez/intercom_conversation_parts_with_conversation_id branch March 25, 2022 19:19

octavia-squidington-iii mentioned this pull request Mar 28, 2022

Bump Airbyte version from 0.35.60-alpha to 0.35.61-alpha #11478

Merged

lazebnyi linked an issue Mar 31, 2022 that may be closed by this pull request

Source Intercom: conversion_parts is not fetched by the source #9572

Closed

lazebnyi mentioned this pull request Mar 31, 2022

Source Intercom: conversion_parts is not fetched by the source #9572

Closed

pylenin mentioned this pull request Apr 15, 2022

Source Intercom: conversation ID isn't being populated in conversations_parts #12066

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🎉 Source Intercom: Added conversation_id field to conversation_part records #11206

🎉 Source Intercom: Added conversation_id field to conversation_part records #11206

lgomezm commented Mar 16, 2022

lgomezm commented Mar 16, 2022

alafanechere left a comment •

edited

Loading

alafanechere Mar 21, 2022

lgomezm Mar 22, 2022

alafanechere commented Mar 22, 2022 •

edited by github-actions bot

Loading

alafanechere left a comment

alafanechere Mar 22, 2022

lgomezm Mar 22, 2022

lgomezm commented Mar 22, 2022

alafanechere commented Mar 23, 2022 •

edited by github-actions bot

Loading

alafanechere left a comment •

edited

Loading

lgomezm commented Mar 23, 2022 •

edited

Loading

alafanechere commented Mar 24, 2022 •

edited by github-actions bot

Loading

alafanechere commented Mar 25, 2022

lgomezm commented Mar 25, 2022

alafanechere left a comment

		if 'conversation_id' not in conversation_part:
		conversation_part['conversation_id'] = conversation_id

	if 'conversation_id' not in conversation_part:
	conversation_part['conversation_id'] = conversation_id
	conversation_part.setdefault("conversation_id", "conversation_id")

	def test_switch_to_standard_endpoint_if_scroll_expired(requests_mock):
	def test_conversation_part_has_conversation_id(requests_mock):

🎉 Source Intercom: Added conversation_id field to conversation_part records #11206

🎉 Source Intercom: Added conversation_id field to conversation_part records #11206

Conversation

lgomezm commented Mar 16, 2022

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Checklist

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

Tests

lgomezm commented Mar 16, 2022

alafanechere left a comment • edited Loading

Choose a reason for hiding this comment

alafanechere Mar 21, 2022

Choose a reason for hiding this comment

lgomezm Mar 22, 2022

Choose a reason for hiding this comment

alafanechere commented Mar 22, 2022 • edited by github-actions bot Loading

alafanechere left a comment

Choose a reason for hiding this comment

alafanechere Mar 22, 2022

Choose a reason for hiding this comment

lgomezm Mar 22, 2022

Choose a reason for hiding this comment

lgomezm commented Mar 22, 2022

alafanechere commented Mar 23, 2022 • edited by github-actions bot Loading

alafanechere left a comment • edited Loading

Choose a reason for hiding this comment

lgomezm commented Mar 23, 2022 • edited Loading

alafanechere commented Mar 24, 2022 • edited by github-actions bot Loading

alafanechere commented Mar 25, 2022

lgomezm commented Mar 25, 2022

alafanechere left a comment

Choose a reason for hiding this comment

alafanechere left a comment •

edited

Loading

alafanechere commented Mar 22, 2022 •

edited by github-actions bot

Loading

alafanechere commented Mar 23, 2022 •

edited by github-actions bot

Loading

alafanechere left a comment •

edited

Loading

lgomezm commented Mar 23, 2022 •

edited

Loading

alafanechere commented Mar 24, 2022 •

edited by github-actions bot

Loading