Create speaker account with SSO as part of the answer to Call for Proposals

[HungNgien]

Make social login to redirect to previous page when Login with SSO in other components

Summary by Sourcery

New Features:

• Added support for Single Sign-On (SSO) for speaker accounts during the Call for Proposals process.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request implements Single Sign-On (SSO) for speaker accounts, allowing users to log in via external providers and redirecting them to the correct page after authentication. It also refactors the login views to use class-based views.

Sequence diagram for SSO login flow with redirect

sequenceDiagram
    actor User
    participant Browser
    participant OAuthLoginView
    participant OAuthReturnView
    participant ExternalProvider
    participant Database

    User->>Browser: Click 'Login with SSO'
    Browser->>OAuthLoginView: GET /oauth_login/{provider}/ with next URL
    OAuthLoginView->>OAuthLoginView: set_oauth2_params()
    OAuthLoginView->>ExternalProvider: Redirect to provider login
    ExternalProvider->>OAuthReturnView: Return with auth data
    OAuthReturnView->>Database: get_or_create_user()
    OAuthReturnView->>OAuthReturnView: prepare_oauth2_params()
    OAuthReturnView->>Browser: Redirect to original page
    Browser->>User: Show authenticated page

Loading

Class diagram for updated OAuth views

classDiagram
    class View {
        <<Django>>
    }
    class OAuthLoginView {
        +get(request, provider)
        -set_oauth2_params(request)
    }
    class OAuthReturnView {
        +get(request)
        -get_or_create_user(request)
        -prepare_oauth2_params(oauth2_params)
    }
    View <|-- OAuthLoginView
    View <|-- OAuthReturnView
    note for OAuthLoginView "Handles initial SSO request"
    note for OAuthReturnView "Processes SSO callback"

Loading

File-Level Changes

Change	Details	Files
Refactored login views to use class-based views.	Converted the function-based views oauth_login and oauth_return to class-based views OAuthLoginView and OAuthReturnView, respectively. Added a method set_oauth2_params to OAuthLoginView to handle the 'next' parameter for redirection after login. Added a method get_or_create_user to OAuthReturnView to retrieve or create the user based on their email address. Added a method prepare_oauth2_params to OAuthReturnView to prepare parameters for the OAuth2 authorization view redirection. Updated the URL patterns in urls.py to use the new class-based views.	src/pretix/plugins/socialauth/views.py
Implemented redirection to the previous page after SSO login.	Added logic to store the 'next' parameter in the session during the login process. Added logic to retrieve the 'next' parameter from the session and redirect the user after successful SSO login. Modified the login template to include the 'next' parameter in the SSO login link. Added handling for OAuth2 parameters in the OAuthReturnView to facilitate redirection after authorization.	src/pretix/plugins/socialauth/views.py src/pretix/control/templates/pretixcontrol/auth/login.html
Updated the login template to include the 'next' parameter in the SSO login link.	Added {% append_next request.GET.next %} to the SSO login link to include the 'next' parameter in the URL.	src/pretix/control/templates/pretixcontrol/auth/login.html

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @HungNgien - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider cleaning up the oauth2_params session data in error cases as well to avoid stale data. This could be done by moving the cleanup to a finally block or similar.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟡 Security: 1 issue found
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[hongquan]

Please simplify the implementation, because you don't need to create a QueryDict in order to build some URL query string, a dict is enough.
Here, you just need to define a dict with default values, then merge with the passed-in oauth2_params.

Btw, this method doesn't use anything from self, it should be moved to a function, to make code less nested.

[HungNgien]

I changed this function to a @staticmethod since it’s only used within this class.
Would it be better to move it to a utils.py file for better modularity?

[hongquan]

Now, you already adopt Pydantic model, you should use its validation result:

try:
    oauth2_params = OAuth2Params.model_validate(oauth2_params_raw)
    auth_url = reverse("control:oauth2_provider.authorize")
    query_string = urlencode(oauth2_params.model_dump())
    return redirect(f"{auth_url}?{query_string}")
except ValidationError as e:
    logger.warning("Ignore invalid OAuth2 parameters: %s.", e)
return response

Here I change log level to warning because this issue of invalid OAuth params is not severe, we can continue to serve user without it.

[hongquan]

You don't need this step if you have Pydantic model. You can tell Pydantic to automatically strip whitespace.

from typing import Annotated

from pydantic import BaseModel, StringConstraints


class OAuth2Params(BaseModel):
     response_type: Annotated[str, StringConstraints(strip_whitespace=True)] = 'code'

Learn more here.