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

chore(release)!: Version 3.0 #3364

Draft
wants to merge 27 commits into
base: main
Choose a base branch
from
Draft

chore(release)!: Version 3.0 #3364

wants to merge 27 commits into from

Conversation

JacobCoffee
Copy link
Member

@JacobCoffee JacobCoffee commented Apr 10, 2024

Standing PR for the 3.0 release

Important

  • Until feature freeze in 2.x, be mindful of the changes you are pulling into this branch.
  • Use rebasing to bring the latest changes from main into this branch as it makes the process of merging it back into main with a merge commit when the release is due easier
  • Use a merge commit without squashing when merging this branch into main to keep the history of the feature commits intact

Breaking Changes

Any breaking changes should be properly marked with ! in the conventional commits schema, e.g., fix($scope)!: fix thing but it broke stuff, feat(dtos)!: add breaking feature

@JacobCoffee JacobCoffee requested review from provinzkraut and a team as code owners April 10, 2024 07:00
@JacobCoffee JacobCoffee added the do not merge Don't merge this label Apr 10, 2024
@github-actions github-actions bot added area/ci This PR involves changes to the CI/Infra area/dependencies This PR involves changes to the dependencies area/docs This PR involves changes to the documentation size: medium pr/internal labels Apr 10, 2024
@JacobCoffee JacobCoffee marked this pull request as draft April 10, 2024 07:02
Copy link

codecov bot commented Apr 10, 2024

Codecov Report

Attention: Patch coverage is 98.17629% with 6 lines in your changes missing coverage. Please review.

Project coverage is 98.30%. Comparing base (f31ef97) to head (6dd1e6e).

Files with missing lines Patch % Lines
litestar/handlers/http_handlers/_utils.py 50.00% 3 Missing ⚠️
...estar/handlers/websocket_handlers/route_handler.py 89.65% 1 Missing and 2 partials ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3364      +/-   ##
==========================================
- Coverage   98.35%   98.30%   -0.05%     
==========================================
  Files         345      340       -5     
  Lines       15582    15209     -373     
  Branches     1718     1672      -46     
==========================================
- Hits        15325    14951     -374     
- Misses        122      127       +5     
+ Partials      135      131       -4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@github-actions github-actions bot added area/connection area/contrib This PR involves changes to the contrib (Deprecated) area/handlers This PR involves changes to the handlers area/middleware This PR involves changes to the middleware area/private-api This PR involves changes to the privatized API area/static-files area/template area/testing size: large and removed size: medium labels Apr 10, 2024
JacobCoffee and others added 27 commits December 12, 2024 15:36
* Trigger documentation build

* Trigger documentation build

* docs: update to v3 style

* docs: move some things to litestar.dev repo, change versioning, add environment tag

* docs: update landing page

* chore: update lockfile

* chore: add AA upper constraint

* fix(docs): re-colonize

* docs: enable sphinx-togglebutton

* docs: use current year var

* deps: update deps

* fix(docs): do not link __name__ for now

* fix(docs): use correct link to page

---------

Co-authored-by: Peter Schutt <[email protected]>
* Remove deprecated StaticFiles and StaticFilesConfig
* remove special casing of static files app from handlers/router
* remove outdated docs sections
* Add what's new section
* Rename tests for consistency
This PR changes behavior of parameters that are typed in a union with `None`. Prior behavior was to implicitly default their value to `None` if a value wasn't provided making an apparently non-optional parameter (i.e., no declared default) actually optional. Surprising behavior at best, dangerous at worst.

New behavior is to throw a client error when a parameter without a default is not provided.
* refactor: removes deprecated OpenAPIController

This PR removes all deprecated elements of OpenAPIConfig and the OpenAPIController, removes any obsolete tests and refactors tests that were parametrized to test both OpenAPIController and the router-based approach.

* docs: What's new entry

* Update docs/usage/openapi/ui_plugins.rst

Co-authored-by: Jacob Coffee <[email protected]>

* Update litestar/openapi/config.py

* fix: remove whitespace

* fix: import table formatting

(i hope)

---------

Co-authored-by: Jacob Coffee <[email protected]>
…e` (#3393)

* Remove 'app' parameter from `.to_asgi_response`
Remove the deprecated utility functions, `get_litestar_scope_state``, ``set_litestar_scope_state``, ``delete_litestar_scope_state``, and ``is_sync_or_async_generator``.
* remove handler names
* Remove option handler creation from HTTPRoute
* Remove methods attribute from BaseRoute
* Move kwargs model to handlers and creation to on_registration
* Store kwargs model on handlers instead of routes
* Simplify HTTPRoute route_handler_map creation
* Simplify Router.route_handler_method_map
* Relax typing of HTTPRoute
* Move handling logic to route handlers
* Remove scope_type
* Don't pass route to HTTPRouteHandler during handling
* Don't pass scope to handle methods
* Resolve and establish connections in routes; Only pass connections to handlers

---------

Co-authored-by: Jacob Coffee <[email protected]>
Co-authored-by: Peter Schutt <[email protected]>
fix(docs): adjust build script
* Backport static files path traversal fix
* make route handlers functional decorators
…deprecated params of internal `ExceptionHandlerMiddleware` (#3435)

* refactor!: Remove deprecated `app` param of `Response.to_asgi_response` (#3393)
* Remove 'app' parameter from `.to_asgi_response`
* Remove debug param
* Remove exception_handlers param
* Remove litestar.middleware.exceptions
Port parse_values_from_connection_kwargs changes
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
9 New Code Smells (required ≤ 3)
7 New Major Issues (required ≤ 2)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/asgi area/channels area/connection area/constants This PR involves changes to the constants area/contrib This PR involves changes to the contrib (Deprecated) area/controller area/dependencies This PR involves changes to the dependencies area/docs This PR involves changes to the documentation area/enums This PR involves changes to the enums area/handlers This PR involves changes to the handlers area/kwargs area/logging area/middleware This PR involves changes to the middleware area/openapi This PR involves changes to the OpenAPI schema area/private-api This PR involves changes to the privatized API area/response area/router area/static-files area/template area/testing area/types This PR involves changes to the custom types do not merge Don't merge this pr/internal size: large
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants