🎉 Source Typeform: Full Stream Coverage

[itaseskii]

What

Increase Typeform connector stream coverage with Webhooks, Workspaces, Images, Themes

Closes #12219

How

Describe the solution

Recommended reading order

1. source.py & ./schemas/
2. test_source.py & test_streams.py & conftest.py

🚨 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

• 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

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.

[lgomezm]

@itaseskii I see all the new streams you're adding have the same primary_key field ("id"). Maybe you can just add it to the parent PaginatedStream class?

class PaginatedStream(TypeformStream):

  primary_key = "id"

[lgomezm]

Could you update the integration tests to account for the new streams?

[lgomezm]

Hi @itaseskii. Your PR looks good! Just a couple minor questions. Please update the PR description to describe the solution or at least list the recommended review order.

[itaseskii]

Could you update the integration tests to account for the new streams?

@lgomezm Done.

[itaseskii]

@itaseskii I see all the new streams you're adding have the same primary_key field ("id"). Maybe you can just add it to the parent PaginatedStream class?

class PaginatedStream(TypeformStream):

  primary_key = "id"

@lgomezm I don't really agree with this. PaginatedStream has nothing to do with primary keys and its context should only contain data related to pagination. I could move the primary_key = "id" statement to the parent TypeformStream and only override it for the Responses stream but I don't think that is a good idea if it can't be guaranteed that the primary_key will be the same for every Typeform stream.

[itaseskii]

Hi @itaseskii. Your PR looks good! Just a couple minor questions. Please update the PR description to describe the solution or at least list the recommended review order.

Thanks for the review. I have added a recommended reading order

[lgomezm]

LGTM. Thank you for this contribution.

[harshithmullapudi]

/test connector=source-typeform

🕑 source-typeform https://github.com/airbytehq/airbyte/actions/runs/2268714952
❌ source-typeform https://github.com/airbytehq/airbyte/actions/runs/2268714952
🐛 https://gradle.com/s/zq7rpxvwi3fcq
Python short test summary info:

=========================== short test summary info ============================
FAILED test_core.py::TestBasicRead::test_read[inputs0] - AssertionError: All ...
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/plugin.py:56: Skipping TestIncremental.test_two_sequential_reads because not found in the config
=================== 1 failed, 19 passed, 1 skipped in 47.03s ===================

[harshithmullapudi]

@itaseskii can you share screenshot for integration tests?

[CLAassistant]

All committers have signed the CLA.

[harshithmullapudi]

@itaseskii can you fix the above tests

[itaseskii]

Hey @harshithmullapudi sorry for the late response. I will do it ASAP.

[harshithmullapudi]

Hey @itaseskii I am taking a look at this. Do you mind if I fix this and merge it?

[itaseskii]

@harshithmullapudi Yeah sure.

[harshithmullapudi]

closing this in favor of #13079