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

Modify the create_world API response #273

Open
wants to merge 5 commits into
base: development
Choose a base branch
from
Open

Modify the create_world API response #273

wants to merge 5 commits into from

Conversation

odkhang
Copy link
Collaborator

@odkhang odkhang commented Nov 14, 2024 •
edited by sourcery-ai bot
Loading

This PR resolve #240

Summary by Sourcery

Enhancements:

  • Refactor domain path construction into a reusable variable to avoid code duplication.

@sourcery-ai Sourcery AI
Copy link

sourcery-ai bot commented Nov 14, 2024 •
edited
Loading

Reviewer's Guide by Sourcery

The PR modifies the create_world API by introducing a new method to extract protocol from URLs and updates how the world domain is constructed. The domain URL now includes the protocol (http/https) derived from SITE_URL setting, making the URLs more complete and standardized.

Class diagram for CreateWorldView modifications

classDiagram
    class CreateWorldView {
        +static get_protocol(url) String
        +static post(request, *args, **kwargs) JsonResponse
    }
    note for CreateWorldView "Added get_protocol method to extract protocol from URL"
Loading

File-Level Changes

Change Details Files
Added a new static method to extract protocol from URLs
  • Implemented get_protocol static method that parses URLs and returns the lowercase protocol
  • Method uses urlparse to extract the scheme from the URL
 server/venueless/api/views.py
Refactored world domain construction in create/update logic
  • Extracted domain path construction to a separate variable to avoid duplication
  • Removed redundant 'or ""' fallback from domain assignment
  • Added protocol to the final domain URL using the new get_protocol method
  • Domain URL now follows the format 'protocol://domain_path'
 server/venueless/api/views.py

Assessment against linked issues

Issue Objective Addressed Explanation
#240 Change URL structure from app.eventyay.com:8443/control/ to app.eventyay.com/video/admin for system admin access ❌ The PR only adds URL protocol handling functionality but does not modify the admin access URL structure
#240 Create worlds for events in subdomain format app.eventyay.com/video/[event organiser]/[event name] automatically when video is added ❌ While the PR modifies world creation API response to handle URLs better, it doesn't implement the specific subdomain structure for events or automatic world creation logic
#240 Implement function access control for organizers to edit config, rooms, etc. ❌ The PR does not implement any access control functionality for organizers
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

@odkhang odkhang marked this pull request as ready for review November 14, 2024 07:31
sourcery-ai[bot]
sourcery-ai bot reviewed Nov 14, 2024
View reviewed changes
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Overall Comments:

  • The domain is being set twice - once without protocol and then again with protocol. Consider constructing the full URL with protocol once and using that for the initial domain assignment.
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve access logic and URL structure
2 participants
@odkhang @lcduong