Consistent about using urljoin #264

HungNgien · 2025-02-13T03:45:50Z

Summary by Sourcery

Enhancements:

Construct URLs using urljoin for consistency and correctness.

sourcery-ai · 2025-02-13T03:45:53Z

Reviewer's Guide by Sourcery

This pull request standardizes URL generation by replacing manual string concatenation and formatting with the urljoin function. The changes enhance URL reliability by ensuring correct URL joining in various parts of the codebase.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Replaced string concatenation and formatting with urljoin for URL building in settings.	Removed direct concatenation for LOGIN_URL and updated usage of BASE_PATH. Updated fallback URLs for ticket and video base paths to include trailing slashes. Replaced '/'.join for OAuth2Provider endpoints (AUTHORIZE_URL, ACCESS_TOKEN_URL, REDIRECT_URI) with urljoin. Updated SSO_USER_INFO URL to be constructed using urljoin.	`src/pretalx/settings.py`
Standardized API URL generation in event video settings.	Changed string formatting for constructing the video API URL to use urljoin.	`src/pretalx/api/views/event.py`
Refactored registration URL building in authentication views.	Modified the registration URL construction to remove extra slash and correctly join paths using urljoin.	`src/pretalx/eventyay_common/views/auth.py`

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. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!
Generate a plan of action for an issue: Comment @sourcery-ai plan on
an issue to generate a plan of action for it.

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 adding a comment explaining why urljoin is preferred over string concatenation.

Here's what I looked at during the review

🟡 General issues: 1 issue found
🟢 Security: all looks good
🟢 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 ✨

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

src/pretalx/settings.py

sourcery-ai

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

Overall Comments:

It looks like you're using f-strings in some places and .format in others; can you pick one?
Consider adding from urllib.parse import urljoin to the top of the files where it's used.

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 Security: all looks good
🟢 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 ✨

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

mariobehling · 2025-02-13T07:16:33Z

src/pretalx/settings.py

@@ -690,10 +689,10 @@ def merge_csp(*options, config=None):
    )

 EVENTYAY_TICKET_BASE_PATH = config.get(
-    "urls", "eventyay-ticket", fallback="https://app-test.eventyay.com/tickets"
+    "urls", "eventyay-ticket", fallback="https://app-test.eventyay.com/tickets/"


Why a hardcoded domain should be in the code? How to make this domain agnostic?

It is just a default value when the urls key is missing in the config.
To use other domain, we just need to set it in config.

app-test domain is a temporary domain for the dev branch. It should not be used as a fallback anywhere. If the urls key is missing best would be an error message for the developer. If the fallback can be made domain agnostic this option should be choosen. We will change the dev branch deployment domain in future and app-test is not suitable therefore to be part of the code.

As discussed in chat other projects usually use "localhost" as fallback. Please explain why localhost cannot be the fallback.

Since this fallback value does not impact the production, I can set it to "localhost" or any other value you prefer.

ok, sounds good. localhost, please.

mariobehling · 2025-02-13T07:16:41Z

src/pretalx/settings.py

 )
 EVENTYAY_VIDEO_BASE_PATH = config.get(
-    "urls", "eventyay-video", fallback="https://app-test.eventyay.com/video"
+    "urls", "eventyay-video", fallback="https://app-test.eventyay.com/video/"


Why a hardcoded domain should be in the code? How to make this domain agnostic?

Consistent about using urljoin

ffe106b

HungNgien added 2 commits February 13, 2025 10:49

Fix black warning

d9dfc34

Fix black warning

a231dbe

HungNgien marked this pull request as ready for review February 13, 2025 03:52

sourcery-ai bot reviewed Feb 13, 2025

View reviewed changes

src/pretalx/settings.py Outdated Show resolved Hide resolved

HungNgien marked this pull request as draft February 13, 2025 04:02

HungNgien added 2 commits February 13, 2025 11:06

Remove LOGIN_URL as not being used

937032b

Change quote

7742463

HungNgien marked this pull request as ready for review February 13, 2025 04:08

sourcery-ai bot reviewed Feb 13, 2025

View reviewed changes

mariobehling approved these changes Feb 13, 2025

View reviewed changes

mariobehling reviewed Feb 13, 2025

View reviewed changes

mariobehling requested changes Feb 13, 2025

View reviewed changes

Set value to localhost

fb5050b

mariobehling merged commit 8f365e2 into fossasia:development Feb 13, 2025
6 of 8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Consistent about using urljoin #264

Consistent about using urljoin #264

HungNgien commented Feb 13, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Feb 13, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

sourcery-ai bot left a comment

sourcery-ai bot left a comment

mariobehling Feb 13, 2025

hongquan Feb 13, 2025

mariobehling Feb 13, 2025

mariobehling Feb 13, 2025

HungNgien Feb 13, 2025

mariobehling Feb 13, 2025

mariobehling Feb 13, 2025

Consistent about using urljoin #264

Consistent about using urljoin #264

Conversation

HungNgien commented Feb 13, 2025 • edited by sourcery-ai bot Loading

Summary by Sourcery

sourcery-ai bot commented Feb 13, 2025 • edited Loading

Reviewer's Guide by Sourcery

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

sourcery-ai bot left a comment

Choose a reason for hiding this comment

sourcery-ai bot left a comment

Choose a reason for hiding this comment

mariobehling Feb 13, 2025

Choose a reason for hiding this comment

hongquan Feb 13, 2025

Choose a reason for hiding this comment

mariobehling Feb 13, 2025

Choose a reason for hiding this comment

mariobehling Feb 13, 2025

Choose a reason for hiding this comment

HungNgien Feb 13, 2025

Choose a reason for hiding this comment

mariobehling Feb 13, 2025

Choose a reason for hiding this comment

mariobehling Feb 13, 2025

Choose a reason for hiding this comment

HungNgien commented Feb 13, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Feb 13, 2025 •

edited

Loading