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

low-code connectors: fix parse and format methods #15326

Merged
merged 15 commits into from
Aug 9, 2022
Merged

Conversation

girarda
Copy link
Contributor

@girarda girarda commented Aug 4, 2022

What

Fixes 2 bugs in the datetime stream slicer

  1. formatting a datetime as timestamp returns a float instead of an int
  2. the parse_date method doesn't use self._datetime_format

How

  • cast the output of _format_datetime to an int if the format is "timestamp"
  • parse date using strptime and self._datetime_format

Recommended reading order

  1. airbyte-cdk/python/airbyte_cdk/sources/declarative/stream_slicers/datetime_stream_slicer.py
  2. airbyte-cdk/python/unit_tests/sources/declarative/stream_slicers/test_datetime_stream_slicer.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 Aug 4, 2022
if self._datetime_format == "timestamp":
return dt.timestamp()
if self._datetime_format == TIMESTAMP_FORMAT:
return int(dt.timestamp())
Copy link
Contributor Author

Choose a reason for hiding this comment

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

cast to int because dt.timestamp() returns a flow

return datetime.datetime.fromtimestamp(int(date)).replace(tzinfo=self._timezone)
return date
elif isinstance(date, str):
return datetime.datetime.strptime(str(date), self._datetime_format).replace(tzinfo=self._timezone)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

better to use the specified datetime_format instead of relying on dateutil.parser's best guess

@girarda girarda marked this pull request as ready for review August 4, 2022 19:05
@girarda girarda requested a review from a team as a code owner August 4, 2022 19:05
@girarda girarda changed the title fix parse and format methods low-code connectors: fix parse and format methods Aug 4, 2022
else:
return dateutil.parser.parse(date).replace(tzinfo=self._timezone)
elif isinstance(date, int):
def parse_date(self, date: Union[str, datetime.datetime]) -> datetime.datetime:
Copy link
Contributor

Choose a reason for hiding this comment

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

can't place the comment in the right spot so adding it here. Can you clarify in the doc string for datetime_format what the reference for formats is? eg add a link to it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor

@sherifnada sherifnada left a comment

Choose a reason for hiding this comment

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

I think the contract around datetime_format is unclear -- can you clarify what are the expected/accepted values?

@girarda
Copy link
Contributor Author

girarda commented Aug 4, 2022

I think the contract around datetime_format is unclear -- can you clarify what are the expected/accepted values?

@sherifnada the contract is now stated in the docstring. I removed the "timestamp" magic keyword because "%s" is equivalent

Copy link
Contributor

@sherifnada sherifnada left a comment

Choose a reason for hiding this comment

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

awesome!

@girarda
Copy link
Contributor Author

girarda commented Aug 9, 2022

/publish-cdk dry-run=false

🕑 https://github.com/airbytehq/airbyte/actions/runs/2822130722
https://github.com/airbytehq/airbyte/actions/runs/2822130722

@girarda
Copy link
Contributor Author

girarda commented Aug 9, 2022

/publish-cdk dry-run=false

🕑 https://github.com/airbytehq/airbyte/actions/runs/2822181334
https://github.com/airbytehq/airbyte/actions/runs/2822181334

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CDK Connector Development Kit
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants