-
Notifications
You must be signed in to change notification settings - Fork 2
feat(events): fix and complete get-overflow-published-events endpoint #573
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
Open
smarcet
wants to merge
4
commits into
main
Choose a base branch
from
feat/get-overflow-events
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
7a4520a
feat(events): fix and complete get-overflow-published-events endpoint
smarcet e646963
fix(events): gate overflow endpoint with a dedicated read scope
smarcet 9d2042f
fix(events): apply CodeRabbit nitpicks on overflow endpoint
smarcet 1d73245
fix(events): drop unbounded outer cache on overflow token serializer
smarcet File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
25 changes: 25 additions & 0 deletions
25
...s/Protected/Summit/Strategies/events/RetrieveAllOverflowPublishedSummitEventsStrategy.php
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| <?php namespace App\Http\Controllers; | ||
| /** | ||
| * Copyright 2026 OpenStack Foundation | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| **/ | ||
| use models\summit\SummitEvent; | ||
| use utils\FilterParser; | ||
|
|
||
| class RetrieveAllOverflowPublishedSummitEventsStrategy extends RetrievePublishedSummitEventsBySummitStrategy | ||
| { | ||
| protected function buildFilter() | ||
| { | ||
| $filter = parent::buildFilter(); | ||
| $filter->addFilterCondition(FilterParser::buildFilter('occupancy','==',SummitEvent::OccupancyOverflow)); | ||
| return $filter; | ||
| } | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| <?php namespace Database\Migrations\Config; | ||
| /** | ||
| * Copyright 2026 OpenStack Foundation | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| **/ | ||
|
|
||
| use App\Security\SummitScopes; | ||
| use Doctrine\DBAL\Schema\Schema; | ||
| use Doctrine\Migrations\AbstractMigration; | ||
|
|
||
| /** | ||
| * Seed the get-overflow-published-events endpoint. | ||
| * | ||
| * Adds: | ||
| * - 1 api_scopes row (ReadOverflowEvents) - dedicated scope so this endpoint's Mux | ||
| * playback tokens are not gated by the broad ReadSummitData/ReadAllSummitData scopes | ||
| * shared by unrelated read endpoints | ||
| * - 1 api_endpoints row (get-overflow-published-events) | ||
| * - 1 endpoint_api_scopes association (ReadOverflowEvents) | ||
| * | ||
| * All INSERTs are idempotent via WHERE NOT EXISTS. | ||
| */ | ||
| final class Version20260715120000 extends AbstractMigration | ||
| { | ||
| use APIEndpointsMigrationHelper; | ||
|
|
||
| private const API_NAME = 'summits'; | ||
| private const ENDPOINT_NAME = 'get-overflow-published-events'; | ||
| private const ENDPOINT_ROUTE = '/api/v1/summits/{id}/events/all/published/occupancy/overflow'; | ||
|
|
||
| public function getDescription(): string | ||
| { | ||
| return 'Seed get-overflow-published-events endpoint with a dedicated read scope.'; | ||
| } | ||
|
|
||
| public function up(Schema $schema): void | ||
| { | ||
| $this->addSql($this->insertApiScope( | ||
| self::API_NAME, | ||
| SummitScopes::ReadOverflowEvents, | ||
| 'Read Summit Overflow Events Data', | ||
| 'Grants read only access to published summit events currently in OVERFLOW occupancy, including overflow streaming URLs and tokens' | ||
| )); | ||
|
|
||
| $this->registerEndpoint( | ||
| self::API_NAME, | ||
| self::ENDPOINT_NAME, | ||
| self::ENDPOINT_ROUTE, | ||
| 'GET', | ||
| [ | ||
| SummitScopes::ReadOverflowEvents, | ||
| ] | ||
| ); | ||
| } | ||
|
|
||
| public function down(Schema $schema): void | ||
| { | ||
| $this->unregisterEndpoint(self::API_NAME, self::ENDPOINT_NAME); | ||
| $this->addSql($this->deleteApiScopes(self::API_NAME, [SummitScopes::ReadOverflowEvents])); | ||
| } | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🩺 Stability & Availability | 🔴 Critical | ⚡ Quick win
Prevent fatal errors on null dates.
getStartDate()andgetEndDate()can returnnullif the event type does not allow publishing dates. Calling->getTimestamp()onnullwill cause a fatal error. Use the nullsafe operator (?->) to handle potentially missing dates gracefully.🛡️ Proposed fix
📝 Committable suggestion
🤖 Prompt for AI Agents