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

Breaking Changes introduced in version 1.6.0 #190

Closed
JP-Dhabolt opened this issue Aug 22, 2022 · 3 comments · Fixed by #191
Closed

Breaking Changes introduced in version 1.6.0 #190

JP-Dhabolt opened this issue Aug 22, 2022 · 3 comments · Fixed by #191

Comments

@JP-Dhabolt
Copy link

Expected Behavior

Minor version updates do not introduce breaking changes

Actual Behavior

Minor version updates introduced breaking change.

Steps to Reproduce the Problem

  1. Have code relying on cloudevents~=1.2
  2. Allow dependencies to update to 1.6.0, which is minor version updates only
  3. Various code is broken, with one specific being from cloudevents.http import to_json. This is not the only breaking change introduced, just the one that specifically impacted my team.

Specifications

  • Platform: Linux
  • Python Version: 3.8

It looks like it was #188 that caused the breaking change, based on the Changelog and the history of cloudevents/http/__init__.py. It looks like the intention was to deprecate some functionality, but by changing the import path, it broke the functionality instead.
@sasha-tkachev
Copy link
Contributor

@JP-Dhabolt I will look into that

sasha-tkachev added a commit to sasha-tkachev/sdk-python that referenced this issue Aug 22, 2022
@sasha-tkachev
fix: missing to_json import cloudevents#190
258af22 
Signed-off-by: Alexander Tkachev <sasha64sasha@gmail.com>
sasha-tkachev added a commit to sasha-tkachev/sdk-python that referenced this issue Aug 22, 2022
@sasha-tkachev
test: backwards compatability import from http module cloudevents#190
67337d3 
Signed-off-by: Alexander Tkachev <sasha64sasha@gmail.com>
@sasha-tkachev sasha-tkachev mentioned this issue Aug 22, 2022
Merged
2 tasks
@sasha-tkachev
Copy link
Contributor

You are correct, to_json is missing from the cloudevents.http module __init__ .
I fixed the issue in #191 and added a regression test so it wont happen again as-well

xSAVIKx pushed a commit that referenced this issue Aug 25, 2022
@sasha-tkachev @pre-commit-ci
fix: to_json breaking change (#191)
eba24db 
* fix: missing to_json import #190

Signed-off-by: Alexander Tkachev <sasha64sasha@gmail.com>

* test: backwards compatability import from http module #190

Signed-off-by: Alexander Tkachev <sasha64sasha@gmail.com>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* docs: update changelog

Signed-off-by: Alexander Tkachev <sasha64sasha@gmail.com>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* docs: update changelog

Signed-off-by: Alexander Tkachev <sasha64sasha@gmail.com>

* feat: bump version

Signed-off-by: Alexander Tkachev <sasha64sasha@gmail.com>

Signed-off-by: Alexander Tkachev <sasha64sasha@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
@xSAVIKx
Copy link
Member

xSAVIKx commented Aug 25, 2022

Hey @JP-Dhabolt, thx for raising this.

The fix is merged already and should be released shortly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: to_json breaking change sasha-tkachev/sdk-python
3 participants
@sasha-tkachev @xSAVIKx @JP-Dhabolt