Replace `abort()` with `raise SanicException` #1520

mildbyte · 2021-12-28T15:53:51Z

This is for compatibility with newly-released Sanic 21.12.

Description

Sanic 21.12 removed the deprecated abort() in sanic-org/sanic#2306. Before that, it was a simple wrapper around raise SanicException (https://github.com/sanic-org/sanic/blob/523db190a732177eda5a641768667173ba2e2452/sanic/exceptions.py#L262-L265), so this change makes it explicit and removes the dependency on abort().

Note: I haven't tested this yet, relying on Strawberry's CI to catch out compat issues with the currently supported Sanic versions.

Types of Changes

Issues Fixed or Closed by This PR

Fixes the Dependabot bump issue in #1516

Checklist

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

codecov · 2021-12-28T15:56:15Z

Codecov Report

Merging #1520 (ca59f48) into main (4b903b8) will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #1520      +/-   ##
==========================================
+ Coverage   98.11%   98.12%   +0.01%     
==========================================
  Files         129      129              
  Lines        4403     4436      +33     
  Branches      746      754       +8     
==========================================
+ Hits         4320     4353      +33     
  Misses         43       43              
  Partials       40       40

botberry · 2021-12-28T15:56:17Z

Thanks for adding the RELEASE.md file!

Here's a preview of the changelog:

Fix compatibility with Sanic 21.12

Here's the tweet text:

🆕 Release (next) is out! Thanks to Artjoms Iskovs for the PR 👏

Get it here 👉 https://github.com/strawberry-graphql/strawberry/releases/tag/(next)

mildbyte · 2021-12-28T16:05:37Z

I've cherry-picked ab1fe66 from the failing Dependabot PR so that we can verify this actually works when the PR is tested.

patrick91

Nice one! Thank you for this!

patrick91 · 2021-12-28T16:23:30Z

@mildbyte looks like the tests have failed, not sure if it is related to the PR or the update 🤔

would you be able to take a look at them? 😊

mildbyte · 2021-12-28T17:04:31Z

@patrick91 Will do, looks like it's also related to some Sanic deprecations.

mildbyte · 2021-12-28T17:32:27Z

I think this is fixed by upgrading sanic-testing to 0.8.2. I did it myself using Poetry (with poetry update --lock) but it has regenerated the lockfile with a bunch of extra changes (https://github.com/strawberry-graphql/strawberry/pull/1520/files#diff-f53a023eedfa3fbf2925ec7dc76eecdc954ea94b7e47065393dbad519613dc89). Not sure if you have a different process for updating dependencies.

This is for compatibility with newly-released Sanic 21.12 which removed the deprecated `abort()` in sanic-org/sanic#2306. Before that, it was a simple wrapper around `raise SanicException` (https://github.com/sanic-org/sanic/blob/523db190a732177eda5a641768667173ba2e2452/sanic/exceptions.py#L262-L265), so this change makes it explicit and removes the dependency on `abort()`.

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

Bumps [sanic](https://github.com/sanic-org/sanic) from 21.9.3 to 21.12.0. - [Release notes](https://github.com/sanic-org/sanic/releases) - [Changelog](https://github.com/sanic-org/sanic/blob/main/CHANGELOG.rst) - [Commits](sanic-org/sanic@v21.9.3...v21.12.0) --- updated-dependencies: - dependency-name: sanic dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>

(0.7.0 uses the old `app.test_client` attribute which has been deprecated in Sanic 21.12).

mildbyte · 2022-01-03T11:12:12Z

@patrick91 I need some help with getting the CI started off again, don't think I have the permission to trigger the job :)

patrick91 · 2022-01-03T11:13:15Z

@mildbyte done! will do another review in a couple of hours :)

mildbyte · 2022-01-03T17:57:53Z

Ugh. Looks like the test failures are now unrelated to the change directly and are due to unintended poetry.lock dependency bumps from me running poetry update --lock (I only wanted to update sanic-testing). Is there a way to just update that package?

patrick91 · 2022-01-03T18:00:23Z

@mildbyte not 100% sure! I'll take a look at it soon 😊

patrick91 · 2022-01-04T21:22:10Z

Looks like there's a small incompatibility on windows,

looks like the windows event loop implementation doesn't support passing a name:

I think I'll skip the test on windows 3.7 :D

patrick91 · 2022-01-04T22:00:40Z

@mildbyte are you fine with skipping the tests? if so I'll merge 😊

mildbyte · 2022-01-05T07:13:06Z

@patrick91 Go for it, thanks for figuring it out!

botberry · 2022-01-05T09:44:37Z

Thanks for contributing to Strawberry! 🎉 You've been invited to join
the Strawberry GraphQL organisation 😊

You can also request a free sticker by filling this form: https://forms.gle/dmnfQUPoY5gZbVT67

And don't forget to join our discord server: https://strawberry.rocks/discord 🔥

botberry added bot:has-release-file labels Dec 28, 2021

patrick91 approved these changes Dec 28, 2021

View reviewed changes

mildbyte and others added 5 commits January 3, 2022 11:03

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

24b502a

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

Add RELEASE.md

a9e9637

Update sanic-testing to 0.8.2

b3cb16f

(0.7.0 uses the old `app.test_client` attribute which has been deprecated in Sanic 21.12).

mildbyte force-pushed the patch-1 branch from e9d0531 to b3cb16f Compare January 3, 2022 11:05

Update tests

51cfbe4

Skip sanic tests on windows

ca59f48

patrick91 merged commit 2a958ae into strawberry-graphql:main Jan 5, 2022

mildbyte deleted the patch-1 branch January 5, 2022 13:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace `abort()` with `raise SanicException` #1520

Replace `abort()` with `raise SanicException` #1520

mildbyte commented Dec 28, 2021 •

edited

codecov bot commented Dec 28, 2021 •

edited

botberry commented Dec 28, 2021 •

edited

mildbyte commented Dec 28, 2021

patrick91 left a comment

patrick91 commented Dec 28, 2021

mildbyte commented Dec 28, 2021

mildbyte commented Dec 28, 2021

mildbyte commented Jan 3, 2022

patrick91 commented Jan 3, 2022

mildbyte commented Jan 3, 2022 •

edited

patrick91 commented Jan 3, 2022

patrick91 commented Jan 4, 2022

patrick91 commented Jan 4, 2022

mildbyte commented Jan 5, 2022

botberry commented Jan 5, 2022

Replace abort() with raise SanicException #1520

Replace abort() with raise SanicException #1520

Conversation

mildbyte commented Dec 28, 2021 • edited

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

codecov bot commented Dec 28, 2021 • edited

Codecov Report

botberry commented Dec 28, 2021 • edited

mildbyte commented Dec 28, 2021

patrick91 left a comment

Choose a reason for hiding this comment

patrick91 commented Dec 28, 2021

mildbyte commented Dec 28, 2021

mildbyte commented Dec 28, 2021

mildbyte commented Jan 3, 2022

patrick91 commented Jan 3, 2022

mildbyte commented Jan 3, 2022 • edited

patrick91 commented Jan 3, 2022

patrick91 commented Jan 4, 2022

patrick91 commented Jan 4, 2022

mildbyte commented Jan 5, 2022

botberry commented Jan 5, 2022

Replace `abort()` with `raise SanicException` #1520

Replace `abort()` with `raise SanicException` #1520

mildbyte commented Dec 28, 2021 •

edited

codecov bot commented Dec 28, 2021 •

edited

botberry commented Dec 28, 2021 •

edited

mildbyte commented Jan 3, 2022 •

edited