Add Checkin API and Badge Preview and Download Feature #420
+900
−31
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixed Checkin API to handle requests with Device Authorization and to include badge url in the response if the plugin is enabled and also add preview functionalites
Reviewer's Guide by SourceryThis PR implements a new CheckIn API and adds badge preview/download functionality for the check-in process. The changes include extensive refactoring of the check-in logic into smaller, more maintainable functions, addition of new API endpoints for badge operations, and implementation of CORS support to enable cross-origin requests from the check-in application. Sequence diagram for Checkin Redeem ProcesssequenceDiagram
actor User
participant CheckinRedeemView
participant _redeem_process
participant Checkin
participant BadgeOutputProvider
User->>CheckinRedeemView: POST /checkin/redeem
CheckinRedeemView->>_redeem_process: Call _redeem_process
_redeem_process->>Checkin: perform_checkin
alt Badge Plugin Enabled
_redeem_process->>BadgeOutputProvider: generate badge
BadgeOutputProvider-->>_redeem_process: Return badge PDF
end
_redeem_process-->>CheckinRedeemView: Return Response
CheckinRedeemView-->>User: Response with status
Updated class diagram for Checkin and Badge ModelsclassDiagram
class Checkin {
+require_checkin_attention: bool
}
class BadgeOutputProvider {
+generate(OrderPosition) Tuple
+settings_form_fields
}
class CheckinRedeemInputSerializer {
+lists
+secret
+force
+source_type
+type
+ignore_unpaid
+questions_supported
+nonce
+datetime
+answers
}
Checkin <|-- CheckinRedeemInputSerializer
BadgeOutputProvider <|-- CheckinRedeemInputSerializer
Checkin <|-- BadgeOutputProvider
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @Sak1012 - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟡 Complexity: 1 issue found
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| return downloads | ||
|
|
||
|
|
||
| def _redeem_process(*, checkinlists, raw_barcode, answers_data, dateandtime, |
There was a problem hiding this comment.
issue (complexity): Consider extracting check-in business logic into a dedicated service layer to separate concerns.
The check-in logic has become overly complex by mixing business operations with API concerns. Consider refactoring into a service layer:
class CheckInService:
def __init__(self, checkinlists):
self.list_by_event = self._validate_checkinlists(checkinlists)
def process_checkin(self, barcode, checkin_args):
# Core business logic steps:
position = self._find_ticket_position(barcode)
self._validate_position(position)
return self._perform_checkin(position, checkin_args)
def _find_ticket_position(self, barcode):
# Ticket lookup logic
pass
def _validate_position(self, position):
# Validation rules
pass
def _perform_checkin(self, position, args):
# Check-in execution
passThen the API view becomes simpler:
def redeem(self, request):
service = CheckInService(checkinlists)
result = service.process_checkin(
barcode=request.data['secret'],
checkin_args={'type': request.data['type'], ...}
)
return self._format_response(result)This separates concerns and makes the code more maintainable while preserving functionality.
mariobehling
requested changes
Nov 4, 2024
| <button class="btn btn-default btn-block" id="editor-add-poweredby" | ||
| data-content="dark" | ||
| disabled> | ||
| <span class="fa fa-image"></span> | ||
| {% trans "pretix Logo" %} | ||
| {% trans "Eventyay Logo" %} |
I have made the necessary modifications 👍 |
mariobehling
requested changes
Nov 4, 2024
deployment/docker/nginx.conf
Outdated
| @@ -47,6 +47,22 @@ http { | |||
| server_name _; | |||
| index index.php index.html; | |||
| root /var/www; | |||
|
|
|||
| add_header 'Access-Control-Allow-Origin' 'https://checkin.eventyay.com' always; | |||
There was a problem hiding this comment.
Please change this into a variable. So we can use different URLs, e.g. for the development branch.
There was a problem hiding this comment.
How about using wildcard * to allow all "origin"?
There was a problem hiding this comment.
Well, for partners such as Wikimedia we also want to deploy it to different domains.
hongquan
requested changes
Nov 5, 2024
src/pretix/settings.py
Outdated
| @@ -373,6 +373,8 @@ | |||
| } | |||
|
|
|||
| MIDDLEWARE = [ | |||
| 'corsheaders.middleware.CorsMiddleware', | |||
There was a problem hiding this comment.
You should remove this middleware to test if the Nginx config works.
deployment/docker/nginx.conf
Outdated
| @@ -47,6 +47,22 @@ http { | |||
| server_name _; | |||
| index index.php index.html; | |||
| root /var/www; | |||
|
|
|||
| add_header 'Access-Control-Allow-Origin' 'https://checkin.eventyay.com' always; | |||
There was a problem hiding this comment.
How about using wildcard * to allow all "origin"?
Sak1012
force-pushed
the
checkinapi
branch
4 times, most recently
from
3c6277d
to
5c51706
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR let's organisers perform Checkin from Open-event-checkin with the new CheckIn API and also facilitates badge preview, printing and downloading functionalities at checkin.
Summary by Sourcery
Add a new Checkin API and badge preview, printing, and downloading features to enhance the check-in process. Implement PDF rendering support and configure CORS headers for cross-origin requests.
New Features:
Enhancements:
Deployment: