Skip to content

🎉 New Source: GNews [low-code CDK] #18808

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.

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

Merged
merged 9 commits into from
Nov 9, 2022
Merged

🎉 New Source: GNews [low-code CDK] #18808

merged 9 commits into from
Nov 9, 2022

Conversation

Xabilahu
Copy link
Contributor

@Xabilahu Xabilahu commented Nov 1, 2022

What

New Source: GNews https://gnews.io

Screenshot from 2022-11-01 20-44-03

🚨 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/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

Screenshot from 2022-11-01 20-33-52

@Xabilahu Xabilahu changed the title 🎉 New Source: Gnews [low-code CDK] 🎉 New Source: GNews [low-code CDK] Nov 1, 2022
@Xabilahu
Copy link
Contributor Author

Xabilahu commented Nov 1, 2022

secrets/config.json being used for integ tests is:

{
  "api_key": "API-KEY",
  "query": "Apple OR Microsoft",
  "top_headlines_topic": "technology"
}

Copy link
Member

@marcosmarxm marcosmarxm left a comment

Choose a reason for hiding this comment

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

Hello @Xabilahu, Marcos from Airbyte here 👋 . We received more than 25 new contributions along the weekend. One is yours 🎉 thank so much for! Our team is limited and maybe the review process can take longer than expected. As described in the Airbyte's Hacktoberfest your contribution was submitted before November 2nd and it is eligible to win the prize. The review process will validate other requirements. I ask to you patience until someone from the team review it.

Because I reviewed some contributions for Hacktoberfest so far I saw some common patterns you can check in advance:

  • Make sure you have added connector documentation to /docs/integrations/
  • Remove the file catalog from /integration_tests
  • Edit the sample_config.json inside /integration_tests
  • For the configured_catalog you can use only json_schema: {}
  • Add title to all properties in the spec.yaml
  • Make sure the documentationUrl in the spec.yaml redirect to Airbyte's future connector page, eg: connector Airtable the documentationUrl: https://docs.airbyte.com/integrations/sources/airtable
  • Review now new line at EOF (end-of-file) for all files.

If possible send to me a DM in Slack with the tests credentials, this process will make easier to us run integration tests and publish your connector. If you only has production keys, make sure to create a bootstrap.md explaining how to get the keys.

@Xabilahu
Copy link
Contributor Author

Xabilahu commented Nov 2, 2022

Hi @marcosmarxm, thanks for the update! Below the status of the checklist:

  • Make sure you have added connector documentation to /docs/integrations/
  • Remove the file catalog from /integration_tests
  • Edit the sample_config.json inside /integration_tests
  • For the configured_catalog you can use only json_schema: {}
  • Add title to all properties in the spec.yaml
  • Make sure the documentationUrl in the spec.yaml redirect to Airbyte's future connector page, eg: connector Airtable the documentationUrl: https://docs.airbyte.com/integrations/sources/airtable
  • Review now new line at EOF (end-of-file) for all files.

@Xabilahu Xabilahu requested a review from marcosmarxm November 2, 2022 10:27
Copy link
Member

@marcosmarxm marcosmarxm left a comment

Choose a reason for hiding this comment

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

Requesting about incremental syncs.

Comment on lines 20 to 21
from: "{{ config['from'] }}"
to: "{{ config['to'] }}"
Copy link
Member

Choose a reason for hiding this comment

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

@Xabilahu similar case as New York, what about implementing incremental syncs to this API?

@Xabilahu
Copy link
Contributor Author

Xabilahu commented Nov 3, 2022

I implemented support for incremental syncs and error handling. I need some help figuring out some problem for the error handlers. I already sent a message in the hacktoberfest-2022 slack channel. Pasting the message here for reference:


Hi guys! I'm trying to add some backoff strategies to a low-code CDK based connector, and I found that in the docs backoff strategies are mentioned like ConstantBackoff, whereas the CDK implementation says ConstantBackoffStrategy. This happens for every backoff strategy.

Moreover, I get the following error with this definition:

    error_handler:
      type: "CompositeErrorHandler"
      error_handlers:
        - response_filters:
          - http_codes: [ 429 ]
            action: RETRY
          backoff_strategies:
            - type: "ConstantBackoffStrategy"
              backoff_time_in_seconds: 1.0
        - response_filters:
          - http_codes: [ 403 ]
            action: RETRY
          backoff_strategies:
            - class_name: "source_gnews.WaitUntilMidnightBackoffStrategy"

It seems that there is no support for $options:

Exception: failed to create object of type <class 'airbyte_cdk.sources.declarative.requesters.error_handlers.backoff_strategies.constant_backoff_strategy.ConstantBackoffStrategy'> because __init__() got an unexpected keyword argument 'options'

Am I missing something?

@Xabilahu
Copy link
Contributor Author

Xabilahu commented Nov 4, 2022

As per @girarda, this issue should be fixed by #18053

@marcosmarxm
Copy link
Member

Hello! I'm going to be out of the office this Friday and won't be able to review your contribution again today, I return next Monday. So far, most contributions look solid and are almost done to be approved. As said in Chris' comment all contributions made before 2-November are eligible to receive the prize and have 2 weeks to merge the contributions. But I ensure next week we're going to have your contribution merged. If you have questions about the implementation you can send them in #hacktoberfest-2022 in Airbyte's Slack.

Sorry the inconvenience and see you again next week, thank you so much for your contribution!

@marcosmarxm
Copy link
Member

marcosmarxm commented Nov 8, 2022

@Xabilahu I'm having problem running tests with ./gradlew airbyte-integrations:connectors:source-gnews:integrationTest can you check if you can run locally?

@Xabilahu
Copy link
Contributor Author

Xabilahu commented Nov 8, 2022

@marcosmarxm Tests are passing now ;)

@Xabilahu Xabilahu requested a review from marcosmarxm November 8, 2022 19:10
@marcosmarxm
Copy link
Member

marcosmarxm commented Nov 9, 2022

/test connector=connectors/source-gnews

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

Name                                                   Stmts   Miss  Cover
--------------------------------------------------------------------------
source_gnews/wait_until_midnight_backoff_strategy.py      16      0   100%
source_gnews/__init__.py                                   3      0   100%
source_gnews/source.py                                     4      1    75%
--------------------------------------------------------------------------
TOTAL                                                     23      1    96%
	 Name                                                 Stmts   Miss  Cover   Missing
	 ----------------------------------------------------------------------------------
	 source_acceptance_test/base.py                          12      4    67%   16-19
	 source_acceptance_test/config.py                       133      3    98%   87, 93, 230
	 source_acceptance_test/conftest.py                     196     92    53%   35, 41-43, 48, 54, 60, 66, 72-74, 93, 98-100, 106-108, 114-115, 120-121, 126, 132, 141-150, 156-161, 176, 200, 231, 237, 243-248, 256-261, 269-282, 287-293, 300-311, 318-334
	 source_acceptance_test/plugin.py                        69     25    64%   22-23, 31, 36, 120-140, 144-148
	 source_acceptance_test/tests/test_core.py              345    110    68%   53, 64-72, 77-84, 88-89, 93-94, 178, 216-233, 242-250, 254-259, 265, 298-303, 341-348, 391-393, 396, 461-469, 481-484, 489, 545-546, 552, 555, 591-601, 614-639
	 source_acceptance_test/tests/test_incremental.py       145     20    86%   21-23, 29-31, 36-43, 48-61, 224
	 source_acceptance_test/utils/asserts.py                 37      2    95%   57-58
	 source_acceptance_test/utils/common.py                  94     10    89%   16-17, 32-38, 72, 75
	 source_acceptance_test/utils/compare.py                 62     23    63%   21-51, 68, 97-99
	 source_acceptance_test/utils/config_migration.py        23     23     0%   5-37
	 source_acceptance_test/utils/connector_runner.py       112     50    55%   23-26, 32, 36, 39-68, 71-73, 76-78, 81-83, 86-88, 91-93, 96-114, 148-150
	 source_acceptance_test/utils/json_schema_helper.py     105     13    88%   30-31, 38, 41, 65-68, 96, 120, 190-192
	 ----------------------------------------------------------------------------------
	 TOTAL                                                 1512    375    75%

Build Passed

Test summary info:

=========================== short test summary info ============================
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/tests/test_core.py:65: The previous connector image could not be retrieved.
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/tests/test_core.py:243: The previous connector image could not be retrieved.
======================== 27 passed, 2 skipped in 51.57s ========================

@marcosmarxm
Copy link
Member

marcosmarxm commented Nov 9, 2022

/publish connector=connectors/source-gnews

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


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

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

Copy link
Member

@marcosmarxm marcosmarxm left a comment

Choose a reason for hiding this comment

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

Thanks @Xabilahu

@marcosmarxm marcosmarxm merged commit 88d743b into airbytehq:master Nov 9, 2022
@Xabilahu Xabilahu deleted the gnews branch November 10, 2022 10:13
akashkulk pushed a commit that referenced this pull request Dec 2, 2022
* Initial GNews source connector implementation

* Update changelog with PR id

* Add support for incremental syncs and error handling

* Make tests pass

* run format

* auto-bump connector version

Co-authored-by: marcosmarxm <[email protected]>
Co-authored-by: Octavia Squidington III <[email protected]>
Co-authored-by: Marcos Marx <[email protected]>
@sajarin sajarin added internal and removed bounty labels Dec 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants