Skip to content
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

🎉 New Source: Pexels API [low-code cdk] #18854

Merged
merged 12 commits into from
Nov 29, 2022

Conversation

btkcodedev
Copy link
Collaborator

@btkcodedev btkcodedev commented Nov 2, 2022

What

Developing new connector for the source: Pexels API
New data source will be definitely useful for image data url's

Resolves:
🎉 New Source: Pexels API

How

Developed using low-code cdk

Recommended reading order

  1. spec.yaml
  2. pexels-api.yaml
  3. schemas/*

🚨 User Impact 🚨

  • No breaking changes, Just addition of new source
New Connector: Source Pexels API

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
    • 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

Tests

Integration & Acceptance Full Test Results

image

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 @btkcodedev, 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.

@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!

@btkcodedev
Copy link
Collaborator Author

All comments resolved.
@marcosmarxm Review Required from community.

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.

Some comments, there are some points need imprvements.

@btkcodedev
Copy link
Collaborator Author

@marcosmarxm All comments resolved.
Test results

image

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.

Some comments.

@btkcodedev
Copy link
Collaborator Author

My config:
{
"api_key": "563492ad6f9170000100000126081f5bb22a4748b3575c3af4540e2f",
"query":"people",
"orientation": "landscape",
"size": "large",
"color": "orange",
"locale": "en-US",
"photo_id": "3756777",
"video_id": "2499611",
"collection_id": "mgnr9pi"
}

Recent Test Result:

image

@btkcodedev
Copy link
Collaborator Author

@marcosmarxm All comments resolved

@marcosmarxm
Copy link
Member

@btkcodedev I'll review your PR today!

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.

One comment, I'm having problem running tests with current configuration.

Comment on lines 9 to 11
- photo_id
- video_id
- collection_id
Copy link
Member

Choose a reason for hiding this comment

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

@btkcodedev I think this still not right. I don't want to retrieve only one photo and a video and a collection. I want to probably pass a collection id and retrieve all data inside of it.
I think most valuable for this connector it is to only implement the endpoint for search or retrieve data from collections id.

@marcosmarxm
Copy link
Member

Because this contribution didn't receive recent updates it won't be consider valid to hacktoberfest event. You can continue the work to get this merge in your own pace. Thank so much for your contribution!

@CLAassistant
Copy link

CLAassistant commented Nov 18, 2022

CLA assistant check
All committers have signed the CLA.

@btkcodedev
Copy link
Collaborator Author

um..I've just made the final change just right now. It's ready for shipping
@marcosmarxm It's your call boss, You could give an exception or just be it out.
Either way, i will be happy with the decision :)

@btkcodedev btkcodedev requested review from marcosmarxm and removed request for marcosmarxm November 18, 2022 18:33
@marcosmarxm
Copy link
Member

I'll test your changes later.

@btkcodedev btkcodedev removed the request for review from marcosmarxm November 18, 2022 18:35
@btkcodedev
Copy link
Collaborator Author

Thanks! pal. Really appreciating your maintainership
My config:
{
"api_key": "563492ad6f9170000100000126081f5bb22a4748b3575c3af4540e2f",
"query":"people",
"orientation": "landscape",
"size": "large",
"color": "orange",
"locale": "en-US"
}

@marcosmarxm
Copy link
Member

marcosmarxm commented Nov 18, 2022

/test connector=connectors/source-pexels-api

🕑 connectors/source-pexels-api https://github.com/airbytehq/airbyte/actions/runs/3500061852
❌ connectors/source-pexels-api https://github.com/airbytehq/airbyte/actions/runs/3500061852
🐛 https://gradle.com/s/ed6o4k3kjfgio

Build Failed

Test summary info:

=========================== short test summary info ============================
FAILED test_core.py::TestConnection::test_check[inputs1] - Failed: Timeout >3...
FAILED test_core.py::TestBasicRead::test_read[inputs0] - docker.errors.Contai...
FAILED test_full_refresh.py::TestFullRefresh::test_sequential_reads[inputs0]
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/plugin.py:63: Skipping TestIncremental.test_two_sequential_reads: not found in the config.
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/tests/test_core.py:51: The previous connector image could not be retrieved.
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/tests/test_core.py:229: The previous connector image could not be retrieved.
=================== 3 failed, 21 passed, 3 skipped in 54.86s ===================

@marcosmarxm
Copy link
Member

marcosmarxm commented Nov 18, 2022

/test connector=connectors/source-pexels-api

🕑 connectors/source-pexels-api https://github.com/airbytehq/airbyte/actions/runs/3500652290
✅ connectors/source-pexels-api https://github.com/airbytehq/airbyte/actions/runs/3500652290
Python tests coverage:

	 Name                                                 Stmts   Miss  Cover   Missing
	 ----------------------------------------------------------------------------------
	 source_acceptance_test/base.py                          12      4    67%   16-19
	 source_acceptance_test/config.py                       139      5    96%   87, 93, 235, 239-240
	 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              398    111    72%   53, 58, 87-95, 100-107, 111-112, 116-117, 299, 337-354, 363-371, 375-380, 386, 419-424, 462-469, 512-514, 517, 582-590, 602-605, 610, 666-667, 673, 676, 712-722, 735-760
	 source_acceptance_test/tests/test_incremental.py       158     14    91%   52-59, 64-77, 240
	 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/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     107     13    88%   30-31, 38, 41, 65-68, 96, 120, 192-194
	 ----------------------------------------------------------------------------------
	 TOTAL                                                 1563    349    78%

Build Passed

Test summary info:

=========================== short test summary info ============================
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/plugin.py:63: Skipping TestIncremental.test_two_sequential_reads: not found in the config.
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/tests/test_core.py:88: The previous connector image could not be retrieved.
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/tests/test_core.py:364: The previous connector image could not be retrieved.
======================== 26 passed, 3 skipped in 29.59s ========================

@marcosmarxm
Copy link
Member

marcosmarxm commented Nov 18, 2022

/publish connector=connectors/source-pexels-api

🕑 Publishing the following connectors:
connectors/source-pexels-api
https://github.com/airbytehq/airbyte/actions/runs/3500735001


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

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

@marcosmarxm
Copy link
Member

well well, @RealChrisSean base branch is locked because of code freeze. I can't merge this PR but it was published before the deadline!

Thanks for the contribution @btkcodedev

@marcosmarxm
Copy link
Member

Hello 👋, first thank you for this amazing contribution.

We really appreciate the effort you've made to improve the project.
We ask you patience for the code review. Last month our team was focused on Hacktoberfest event and that probably left some PR without the proper feedback. And this week, due to the Thanksgiving US Holiday, most our team is out of office with their families. Another important piece of information why code won't be merge this week is: as a safety measure the core team has decided to freeze merging code to main branch to keep the release stable. Next week we'll return to you with the proper code review and update the status of your contribution.

If you have any questions feel free to send me a message in Slack!
Thanks!

@btkcodedev
Copy link
Collaborator Author

@marcosmarxm Could I get that hacktober label back and merge this PR :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation community connectors/source/pexels-api internal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants