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.

Sign up for GitHub

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

Jump to bottom

Standardize HttpRequester's url_base and path format #17524

Merged
merged 6 commits into from
Oct 5, 2022
Merged

Standardize HttpRequester's url_base and path format #17524

merged 6 commits into from
Oct 5, 2022

Conversation

girarda
Copy link
Contributor

@girarda girarda commented Oct 3, 2022 •
edited
Loading

What

  • The urljoin method used to join the url_base and the path behave non intuitively. Namely, it strips the part after the last "/", which causes issues when the defining the url_base as https://api.pipedrive.com/v1 because the v1 part is removed
  • Instead of failing to build the URL, the HttpRequester should always remove the leading "/" from the path and add it to the url_base (for consistency)

This PR resolves #16553

How

  • Remove leading "/" from HttpRequester's path
  • Add trailing "/" to HttpRequester's url_base

Recommended reading order

  1. airbyte-cdk/python/airbyte_cdk/sources/declarative/requesters/http_requester.py
  2. airbyte-cdk/python/unit_tests/sources/declarative/requesters/test_http_requester.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/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.

@github-actions github-actions bot added the CDK Connector Development Kit label Oct 3, 2022
@girarda girarda marked this pull request as ready for review October 3, 2022 20:51
@girarda girarda requested a review from a team as a code owner October 3, 2022 20:51
@girarda girarda requested a review from brianjlai October 3, 2022 20:51
@girarda
Copy link
Contributor Author

girarda commented Oct 5, 2022 •
edited by github-actions bot
Loading

/publish-cdk dry-run=false

🕑 https://github.com/airbytehq/airbyte/actions/runs/3193054498
✅ https://github.com/airbytehq/airbyte/actions/runs/3193054498

@girarda girarda merged commit 3bdd7f4 into master Oct 5, 2022
@girarda girarda deleted the alex/fix_trailing_slash branch October 5, 2022 22:30
@octavia-squidington-iii octavia-squidington-iii mentioned this pull request Oct 6, 2022
Merged
letiescanciano added a commit that referenced this pull request Oct 6, 2022
@letiescanciano
Merge branch 'master' into leti/experiment-speedy-connection-for-acti…
6c7ebc1 
…vation

* master: (26 commits)
  supply a source id for schema discovery in connector integration tests (#17662)
  Source Iterable: Add permission check for stream (#17602)
  Moving TrackingClientSingleton.initialize into the bean itself (#17631)
  Handle null workspace IDs in tracking/reporting methods gracefully (#17641)
  Bump Airbyte version from 0.40.11 to 0.40.12 (#17653)
  Revert "Do not wait the end of a reset to return an update (#17591)" (#17640)
  Standardize HttpRequester's url_base and path format (#17524)
  Create geography_type enum and add geography column in connection and workspace table (#16818)
  airbyte-cron: update connector definitions from remote (#16438)
  Do not wait the end of a reset to return an update (#17591)
  Remove redundant title labels from connector specs (#17544)
  Updated GA4 status
  support large schema discovery (#17394)
  🪟 🐛 Fixes connector checks not properly ending their loading state (#17620)
  🪟🧪 [Experiment] add hideOnboarding experiment (#17605)
  Source Recharge: change releaseStage to GA (#17606)
  Source Recharge: skip stream if 403 received (#17608)
  remove sonar-scan workflow (#17609)
  Mark/tables should be full width on all pages (#17401)
  Auto fail all workfow if there is a Versioning issue (#17562)
  ...
jhammarstedt pushed a commit to jhammarstedt/airbyte that referenced this pull request Oct 31, 2022
@girarda @jhammarstedt
Standardize HttpRequester's url_base and path format (airbytehq#17524)
dad5a37 
* add trailing slash to base url if missing

* remove leading / from path

* Bump
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brianjlai brianjlai brianjlai approved these changes

Assignees
No one assigned
Labels
CDK Connector Development Kit
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Low-code CDK: Odd behavior when a stream's path starts with /
2 participants
@girarda @brianjlai