feat: Update useSerialLogs to accept URL params by steverydz · Pull Request #5674 · canonical/snapcraft.io

steverydz · 2026-04-17T15:25:53Z

Done

Updates the useSerialLogs hook so it accepts parameters for start time, end time and page size which will be passed to the backend API call

How to QA

Go to https://snapcraft-io-5674.demos.haus/api/store/njwQYXFnS7ppo7LaGxoh7aqVZc1CPi26/models/test-superalpaca-00/serial-log?page-size=3
Check that there are only three items returned
Go to https://snapcraft-io-5674.demos.haus/api/store/njwQYXFnS7ppo7LaGxoh7aqVZc1CPi26/models/test-superalpaca-00/serial-log?start-time=2026-03-24T04:00:23.875000&end-time=2026-03-28T04:00:23.875000
Check that the items are empty because there are no logs in that date range

Testing

This PR has tests
No testing required (explain why):

Security

Security considerations for review (list them):
- Examples:
- Access control: users can only access their own data
- Input: user input is validated and sanitised
- Sensitive data: secret or private data is not exposed in any way
- ...
This PR has no security considerations (explain why): URL parameters are encoded

Issue / Card

Fixes https://warthogs.atlassian.net/browse/WD-36148

Screenshots

n/a

UX Approval

This PR does not require UX approval
This PR does require UX approval (add context):

webteam-app · 2026-04-17T15:25:58Z

Demo

Jenkins

demos.haus

Copilot

Pull request overview

This PR extends the serial logs fetch flow so consumers can request /serial-log with optional filtering/pagination query params, wiring the new params through the Flask endpoint and the React useSerialLogs hook.

Changes:

Add support for start-time, end-time, and page-size query params on the serial log API endpoint.
Update useSerialLogs to accept optional URL params and include them in the request URL / query cache key.
Add/extend Python and TS tests around the new parameters.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 7 comments.

File	Description
`webapp/endpoints/models.py`	Reads `start-time`/`end-time`/`page-size` from the request and forwards them to the Store API call.
`tests/endpoints/tests_models.py`	Adds new endpoint tests for serial-log requests that include query params.
`static/js/publisher/hooks/useSerialLogs.ts`	Extends the hook signature to accept optional URL params and builds a `URL` with search params.
`static/js/publisher/hooks/__tests__/useSerialLogs.test.tsx`	Adds hook tests for the new optional params.

Copilot

Pull request overview

Updates the serial log fetching flow to support pagination and time-range filtering by accepting URL query parameters in both the Flask endpoint and the React useSerialLogs hook.

Changes:

Extend /api/store/<id>/models/<model>/serial-log to forward start-time, end-time, page-size, and next-page query params to the Store API client.
Update useSerialLogs to construct a URL with optional query params and include them in the React Query cache key.
Add backend and frontend tests covering the new parameters.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.

File	Description
webapp/endpoints/models.py	Reads new query params and forwards them to `PublisherGW.get_store_model_serial_logs`.
tests/endpoints/tests_models.py	Adds endpoint tests verifying query params are passed through to the gateway call.
static/js/publisher/hooks/useSerialLogs.ts	Adds optional URL params support and uses a constructed URL for `fetch`.
static/js/publisher/hooks/tests/useSerialLogs.test.tsx	Adds MSW-based tests asserting the hook sends the correct query params.

+        # Arguments are passed positionally:
+        # (session, store_id, model_name, start_time, end_time, page_size)


edisile · 2026-04-20T15:03:10Z

+        mock_get_serial_log.assert_called_once()
+        # Arguments are passed positionally:
+        # session, store_id, model_name, start_time,
+        # end_time, page_size, cursor
+        self.assertEqual(
+            mock_get_serial_log.call_args.args[6],
+            "nextpage",
+        )


bad suggestion IMO, I feel like this would make the test more brittle and difficult to read

bartaz · 2026-04-20T14:43:28Z

+    start_time = flask.request.args.get("start-time")
+    end_time = flask.request.args.get("end-time")
+    page_size = flask.request.args.get("page-size")
+    cursor = flask.request.args.get("next-page")


Any reason why we rename cursor to next-page param?

@bartaz This is for clarity for the frontend as cursor isn't necessarily that obvious, although that is what it's called in the store API

edisile · 2026-04-20T14:54:51Z

+  if (urlSearchParams) {
+    const { startTime, endTime, pageSize, nextPage } = urlSearchParams;
+
+    if (startTime && endTime) {


does the API only accept calls where both timestamps are present? in that case the urlSearchParams type could state this clearly

{ pageSize?: number; nextPage?: string; } | { startTime: string; endTime: string; }

@edisile there's some nuance around it, but essentially yes. I'll update so it's clearer.

Yes — the hook now uses an interval object ({ startTime, endTime }) for timestamp filtering, so the type enforces both values together. This is in 972b8e82.

Copilot · 2026-04-20T15:25:32Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

download.cypress.io
- Triggering command: /opt/hostedtoolcache/node/24.14.1/x64/bin/node /opt/hostedtoolcache/node/24.14.1/x64/bin/node dist/index.js --exec install (dns block)
login.ubuntu.com
- Triggering command: /usr/bin/python3 python3 -m unittest discover tests (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Copilot AI review requested due to automatic review settings April 17, 2026 15:25

Copilot started reviewing on behalf of steverydz April 17, 2026 15:26 View session

steverydz added Review: Code needed Review: QA needed labels Apr 17, 2026

steverydz force-pushed the WD-35798-serial-log-api-pagination branch from ca3dc87 to 7d5de49 Compare April 17, 2026 15:29

Copilot AI reviewed Apr 17, 2026

View reviewed changes

steverydz force-pushed the WD-35798-serial-log-api-pagination branch 2 times, most recently from 0fc2cc3 to 0251a4e Compare April 20, 2026 13:05

bartaz added Review: QA +1 and removed Review: QA needed labels Apr 20, 2026

edisile requested review from Copilot and edisile April 20, 2026 14:33

Copilot started reviewing on behalf of edisile April 20, 2026 14:34 View session

Copilot AI reviewed Apr 20, 2026

View reviewed changes

bartaz reviewed Apr 20, 2026

View reviewed changes

edisile reviewed Apr 20, 2026

View reviewed changes

Copilot started work on behalf of steverydz April 20, 2026 15:09 View session

feat: Update useSerialLogs to accept URL params

972b8e8

steverydz force-pushed the WD-35798-serial-log-api-pagination branch from 0251a4e to 972b8e8 Compare April 20, 2026 15:15

Copilot finished work on behalf of steverydz April 20, 2026 15:25

edisile self-requested a review April 21, 2026 08:14

edisile approved these changes Apr 21, 2026

View reviewed changes

steverydz merged commit 042ea5b into main Apr 21, 2026
23 of 24 checks passed

steverydz deleted the WD-35798-serial-log-api-pagination branch April 21, 2026 10:47

		# Arguments are passed positionally:
		# (session, store_id, model_name, start_time, end_time, page_size)

Conversation

steverydz commented Apr 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Done

How to QA

Testing

Security

Issue / Card

Screenshots

UX Approval

Uh oh!

webteam-app commented Apr 17, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Apr 20, 2026

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

steverydz commented Apr 17, 2026 •

edited

Loading