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

Add ADR for a query option to filter get_urls #88

Merged
merged 11 commits into from
Jan 30, 2025
Merged

Add ADR for a query option to filter get_urls #88

merged 11 commits into from
Jan 30, 2025

Conversation

philipnbbc
Copy link
Contributor

Details

This PR adds an ADR that proposes a accept_get_urls query option to filter flow segment get_urls. This allows clients to indicate that pre-signed URLs are not required, potentially significantly reducing the request time when requesting a large number of flow segments.

Pivotal Story (if relevant)

Story URL: https://www.pivotaltracker.com/story/show/187930100

Related PRs

Where appropriate. Indicate order to be merged.

Submitter PR Checks

(tick as appropriate)

  • PR completes task/fixes bug
  • API version has been incremented if necessary
  • ADR status has been updated, and ADR implementation has been recorded
  • Documentation updated (README, etc.)
  • PR added to Pivotal story (if relevant)
  • Follow-up stories added to Pivotal

Reviewer PR Checks

(tick as appropriate)

  • PR completes task/fixes bug
  • Design makes sense, and fits with our current code base
  • Code is easy to follow
  • PR size is sensible
  • Commit history is sensible and tidy

Info on PRs

The checks above are guidelines. They don't all have to be ticked, but they should all have been considered.

@philipnbbc philipnbbc requested a review from a team as a code owner September 17, 2024 16:48
@philipnbbc philipnbbc force-pushed the philipn-filter-get-urls branch from fc6acb8 to 84cbe85 Compare September 17, 2024 16:50
@AndrewGibb AndrewGibb self-assigned this Sep 26, 2024
AndrewGibb
AndrewGibb approved these changes Sep 26, 2024
View reviewed changes
Copy link
Contributor

@AndrewGibb AndrewGibb left a comment

Choose a reason for hiding this comment

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

A suggested change and a typo.

Once changed, LGTM.

docs/adr/0023-filter-segment-get-urls.md Outdated Show resolved Hide resolved
api/TimeAddressableMediaStore.yaml Outdated Show resolved Hide resolved
api/TimeAddressableMediaStore.yaml Outdated Show resolved Hide resolved
@philipnbbc philipnbbc force-pushed the philipn-filter-get-urls branch from ace6ebc to d5ebe4a Compare September 26, 2024 12:49
@philipnbbc
Copy link
Contributor Author

This PR will be left open for now as further discussion is needed to understand whether it fits the requirements or not.

@j616
Copy link
Contributor

j616 commented Nov 18, 2024

Follow the Workshop where this was discussed, we should also update the App Note describing the get_url label format to add an extra .presigned element. i.e. <provider>.<region[optional]>.<availabilityZone[optional]>:<storeType>.<presigned[optional]>:<storeName> which may be used as such example-cloud-provider.eu-west-1.a:example-storage-product.presigned:example-store-name

@philipnbbc philipnbbc force-pushed the philipn-filter-get-urls branch from 980b76d to ae1f303 Compare January 24, 2025 14:01
@philipnbbc
Copy link
Contributor Author

philipnbbc commented Jan 24, 2025 •
edited
Loading

Follow the Workshop where this was discussed, we should also update the App Note describing the get_url label format to add an extra .presigned element. i.e. <provider>.<region[optional]>.<availabilityZone[optional]>:<storeType>.<presigned[optional]>:<storeName> which may be used as such example-cloud-provider.eu-west-1.a:example-storage-product.presigned:example-store-name

Added in ae1f303

philipnbbc and others added 9 commits January 24, 2025 14:51
@philipnbbc
gha: check commit messages on PR commits only
53d4e60 
Using github.ref resulted in fetch-depth number of commits before the PR branch
because the action fetches the refs/pull/88/merge ref firstly with the fetch-depth
and that doesn't yet include the PR commits.
@philipnbbc
adr: Add ADR for query option to filter flow segment get_urls
c608074
@philipnbbc
api: add accept_get_urls query option for /segments endpoint
df5578a
@philipnbbc @AndrewGibb
review: fix typo
c94eb63 
Co-authored-by: Andrew Gibb <[email protected]>
@philipnbbc @AndrewGibb
review: expand on why returning no flow segment get_urls could be useful
0e0f92d 
Co-authored-by: Andrew Gibb <[email protected]>
@philipnbbc
review: clarify that omitting accept_get_urls results in all get_urls
0d26844
@philipnbbc
review: remove 'default' filter option and note need for label
7fa3572 
A user is encouraged to set a label so that it can be filtered for.
@philipnbbc
review: improve regex for accept_get_urls query param
c44e004
@philipnbbc
Add '.presigned' extension to get_url label format's store type
bf0a76d
@philipnbbc philipnbbc force-pushed the philipn-filter-get-urls branch from ae1f303 to bf0a76d Compare January 24, 2025 14:57
@philipnbbc philipnbbc changed the base branch from main to philipn-fix-commit-check-checkout-ref January 24, 2025 14:58
@philipnbbc philipnbbc requested a review from a team January 24, 2025 16:19
Base automatically changed from philipn-fix-commit-check-checkout-ref to main January 27, 2025 16:41
samdbmg
samdbmg approved these changes Jan 28, 2025
View reviewed changes
Copy link
Member

@samdbmg samdbmg left a comment

Choose a reason for hiding this comment

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

Changes LGTM. One trivial wording suggestion inlined: up to you

api/TimeAddressableMediaStore.yaml Outdated Show resolved Hide resolved
api/TimeAddressableMediaStore.yaml Outdated Show resolved Hide resolved
@philipnbbc philipnbbc force-pushed the philipn-filter-get-urls branch from 0825283 to 18bdec7 Compare January 29, 2025 09:58
@philipnbbc philipnbbc merged commit b257492 into main Jan 30, 2025
5 checks passed
@philipnbbc philipnbbc deleted the philipn-filter-get-urls branch January 30, 2025 11:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AndrewGibb AndrewGibb AndrewGibb approved these changes

@samdbmg samdbmg samdbmg approved these changes

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

Successfully merging this pull request may close these issues.
4 participants
@philipnbbc @j616 @samdbmg @AndrewGibb