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

Rename CDC terms #201

Merged
merged 2 commits into from
Oct 22, 2024
Merged

Rename CDC terms #201

merged 2 commits into from
Oct 22, 2024

Conversation

erickpintor
Copy link
Contributor

@erickpintor erickpintor commented Oct 21, 2024

Description

This patch renames CDC terms according to our new guidelines.

Motivation and context

  • "Steam token" becomes "Event source"
  • .change_feed(..) becomes .feed(..)
  • ChangeFeed{Options,Iterator,Page} becomes Feed{Options,Iterator,Page}

Old terms related to streaming are deprecated and should be removed in the next major version. Old terms related to event feeds were ripped off.

How was the change tested?

Unit tests included.

Screenshots (if appropriate):

NA.

Change types

    • Bug fix (non-breaking change that fixes an issue)
    • New feature (non-breaking change that adds functionality)
    • Breaking change (backwards-incompatible fix or feature)

Checklist:

    • My code follows the code style of this project.
    • My change requires a change to Fauna documentation.
    • My change requires a change to the README, and I have updated it accordingly.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@erickpintor erickpintor force-pushed the cdc-rewording branch 4 times, most recently from 25f7b85 to 4bfff78 Compare October 21, 2024 20:06
@erickpintor
Copy link
Contributor Author

FYI: This is ready for a code review but tests will fail until the next docker release is out some time later today.

fauna/client/client.py Outdated Show resolved Hide resolved
fauna/client/client.py Outdated Show resolved Hide resolved
pnwpedro
pnwpedro previously approved these changes Oct 21, 2024
Copy link
Collaborator

@pnwpedro pnwpedro left a comment

Choose a reason for hiding this comment

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

I agree with @cynicaljoy. Let's improve that a little bit. Suggestion included. Otherwise looks good!

fauna/client/client.py Outdated Show resolved Hide resolved
fauna/client/client.py Outdated Show resolved Hide resolved
fauna/client/client.py Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
fauna/encoding/decoder.py Outdated Show resolved Hide resolved
tests/integration/test_feeds.py Outdated Show resolved Hide resolved
fauna/client/client.py Outdated Show resolved Hide resolved
Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

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

Look good overall! Left some minor nits and feedback.

@findgriffin
Copy link

Not sure if it fits in this PR, but something I just came across while doing event feeds for JVM is that we have a lot of classes with Query in the name that we might want to rename. Things like QueryFailure, QueryTimeout.

@erickpintor
Copy link
Contributor Author

Not sure if it fits in this PR, but something I just came across while doing event feeds for JVM is that we have a lot of classes with Query in the name that we might want to rename. Things like QueryFailure, QueryTimeout.

I'd consider that a separate effort.

@erickpintor
Copy link
Contributor Author

This is ready for another pass.

jrodewig
jrodewig previously approved these changes Oct 22, 2024
Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

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

LGTM aside from a minor fix in the README. Thanks!

README.md Outdated Show resolved Hide resolved
@erickpintor erickpintor merged commit 962eae2 into main Oct 22, 2024
7 checks passed
@erickpintor erickpintor deleted the cdc-rewording branch October 22, 2024 19:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants