Annotated screens

1. Dashboard

The first page after sign-in: how the projects you may read did in the last 24 hours. Its data comes from one call, which reads D1 only. Every label, and the order and length of every list, is the API's.

On a narrow screen the picture scrolls sideways. A pin opens its row in the table.

1 2 3 4 5 6 7 8 9 10 11 12

UI breakdown

User stories and acceptance criteria

1. Only my projects count

   Given a member who may read shop and no other project

   When they open the dashboard

   Then only shop's failures, queues and jobs are counted and listed; an admin sees every project.

2. The cron has stopped

   Given the cron's last run was noted 25 minutes ago

   When the dashboard loads

   Then the Cron tile's chip reads Stale and its line reads Last run noted 25 minutes ago: the cron may have stopped.

3. Nothing is failing

   Given no job's last run failed

   When the dashboard loads

   Then Failing jobs shows No job's last run failed. in place of a table.

4. The load fails

   Given the dashboard request fails

   When the page opens

   Then it shows its heading, the error and Try again in place, never a blank page.

Back to the list of screens

2. Projects

The projects you may see, a link to each one's pages as your permissions allow, and the maintenance switches that hold dispatch during a deploy.

On a narrow screen the picture scrolls sideways. A pin opens its row in the table.

1 2 3 4 5 6 7 8

UI breakdown

User stories and acceptance criteria

1. A member cannot make projects

   Given a member, not an admin

   When they open Projects

   Then Create project and Hold every project are not shown, and POST /api/projects answers 403 for them.

2. Hold a project for a deploy

   Given I have the pause permission in flowdeck

   When I click Hold dispatch and confirm

   Then every page shows Maintenance is on for flowdeck: its queues and jobs are held, and tasks an app adds meanwhile are accepted and wait.

3. Two switches too close together

   Given flowdeck's switch changed 5 seconds ago

   When I switch it again

   Then the API answers 429: A maintenance switch changes at most once every 10 seconds; try again shortly.

4. Links follow permissions

   Given a member without the keys permission in shop

   When they open Projects

   Then shop's row has no API keys link.

Back to the list of screens

3. Queues

The project's queues with Cloud Tasks' columns, 25 a page. A row's menu holds only the actions its allowedActions list.

On a narrow screen the picture scrolls sideways. A pin opens its row in the table.

1 2 3 4 5 6 7 8 9

UI breakdown

User stories and acceptance criteria

1. The default queue stays

   Given the default queue's row

   When I open its menu

   Then it offers Edit, Pause and Purge but no Delete, and a delete sent anyway is 409 The default queue cannot be deleted.

2. Purge a queue

   Given orders holds 6 queued tasks

   When I choose Purge and confirm Purge orders?

   Then every queued task is deleted, running ones finish, and the notice reads Purged 6 tasks from orders.

3. More than one page

   Given a project with 30 queues

   When the list loads

   Then 25 show with Next page; Next page asks with the answer's nextPageToken, and Previous page goes back to the token before.

4. Read only

   Given a member with only the read permission

   When they open Queues

   Then Create queue is not shown and no row has a menu: the rows list no actions.

Back to the list of screens

4. Queue, Tasks tab

A queue as Cloud Tasks shows it: the toolbar in Google's order, the summary strip, and five tabs. Each button is one the queue's allowedActions list.

On a narrow screen the picture scrolls sideways. A pin opens its row in the table.

1 2 3 4 5 6 7 8 9 10 11 12 13 14

UI breakdown

User stories and acceptance criteria

1. Run two ticked tasks

   Given no row is ticked, so Delete task and Run task are disabled

   When I tick order-1001 and order-1002 and click Run task

   Then one request sends both names to batch-run and the notice reads Ran 2 tasks.

2. One task in a batch is refused

   Given two ticked tasks, one of them running

   When I click Delete task and confirm

   Then the other is deleted and the red notice reads Deleted 1 task; 1 could not be. with that task's name and The task is running or already done.

3. Too many filtered lists

   Given I filtered or sorted this queue's tasks 10 times this hour

   When I click Filter again

   Then the API answers 429 At most 10 filtered or sorted task lists an hour; try again later and the list stays as it was.

4. No run permission

   Given a member without the run permission

   When they open the queue

   Then Run task is not in the toolbar and no row menu offers Run now or Retry.

Back to the list of screens

5. Queue, Configuration tab

The same queue on its Configuration tab: the settings grouped as Google groups them, worded by the API. The other tabs are pinned here too.

On a narrow screen the picture scrolls sideways. A pin opens its row in the table.

1 2 3 4 5 6 7 8 9 10 11 12 13

UI breakdown

User stories and acceptance criteria

1. Burst follows the rate

   Given orders sends at most 20 a second

   When I open its Configuration tab

   Then Rate limits shows Max rate 20/s, Max concurrent 50 and Max burst size 20.

2. Turn on success sampling

   Given the queue logs failed attempts only and I have the update permission

   When I open Logs and click Turn on success sampling

   Then the page sends { logging: "sample" } and says Success sampling is on for orders.

3. Retry every failed task

   Given the Failed tab lists three failed tasks and I have the run permission

   When I click Retry all

   Then they are sent again and the notice reads Retried failed tasks: 3.

Back to the list of screens

6. Task

One task and its attempts (the inspector). Headers and body show while the task waits or runs; the API drops them once it is done.

On a narrow screen the picture scrolls sideways. A pin opens its row in the table.

1 2 3 4 5 6 7 8 9 10

UI breakdown

User stories and acceptance criteria

1. Run a queued task now

   Given a queued task due later, and the run permission

   When I click Run now

   Then it becomes due now and the notice reads order-1001 runs now.

2. Retry a failed task

   Given a task that failed for good

   When I open it

   Then the first button reads Retry, and clicking it retries the task under the same name, attempts from 0.

3. A finished task

   Given a task that succeeded

   When I open it

   Then Headers and Body read Dropped once the task was done and no Run now or Delete is offered.

Back to the list of screens

7. Create queue

Create queue, or Edit queue with every setting. The form starts from the API's defaults and sends what was typed; each refused field shows its message beside it.

On a narrow screen the picture scrolls sideways. A pin opens its row in the table.

1 2 3 4 5 6 7 8 9 10 11 12 13 14

UI breakdown

User stories and acceptance criteria

1. Backoff the wrong way round

   Given Min backoff 2h and Max backoff 1h

   When I click Create

   Then nothing is made and Min backoff shows minBackoff is at most maxBackoff.

2. A forwarding loop

   Given queue b forwards to c, and c to a

   When I set a's dead-letter queue to b and save

   Then it is refused beside Dead-letter queue: Forwarding to b would loop back: b → c → a.

3. The form starts from the defaults

   Given a new queue

   When the form opens

   Then it shows 500, 1000, 100, 0s, 0.1s, 1h, 16, the six status codes, Failed attempts only, 100, Normal and None, as GET /api/defaults/queues answers them.

Back to the list of screens

8. Create a task, and From a file

Create HTTP task: an optional name and schedule time, the call and the attempt deadline. Under it, From a file makes up to 50 tasks in one request.

On a narrow screen the picture scrolls sideways. A pin opens its row in the table.

1 2 3 4 5 6 7 8 9 10 11 12

UI breakdown

User stories and acceptance criteria

1. A mistake in the second task

   Given a file whose second task has no url

   When I click Create tasks

   Then nothing is made and the message lists tasks.1.url with url is required: an http:// or https:// URL.

2. A name the queue remembers

   Given a file of 3 tasks, one named like a task that succeeded an hour ago

   When I click Create tasks

   Then the other two are made, the status line reads Created 2 tasks; 1 could not be, and the refused task is listed with why.

3. Not a JSON file

   Given I chose a text file that is not JSON

   When I click Create tasks

   Then no request is sent and the page says notes.txt is not a JSON file.

4. Too far ahead

   Given a schedule time 40 days from now

   When I click Create

   Then nothing is made and Schedule time shows scheduleTime is at most 30 days ahead.

Back to the list of screens

9. Jobs

The Jobs list as Cloud Scheduler's. The filter, the columns and the sort are display only, over the rows the API gave. The toolbar acts on the ticked jobs, calling each job's own route once per job.

On a narrow screen the picture scrolls sideways. A pin opens its row in the table.

1 2 3 4 5 6 7 8 9 10 11 12 13

UI breakdown

User stories and acceptance criteria

1. Resume two jobs at once

   Given homepage-check and hourly-sync are paused

   When I tick both and click Resume

   Then each job's resume route is called in turn and the notice reads Resume: done for homepage-check, hourly-sync.

2. Edit takes one job

   Given two jobs are ticked

   When I look at the toolbar

   Then Edit and Copy are disabled; Force run, Resume and Delete stay enabled.

3. A partial failure

   Given two ticked jobs, and room in the day's quota for one run

   When I click Force run

   Then the red notice reads Force run: 1 of 2 done. followed by the refused job and the API's message.

Back to the list of screens

10. Create a job

Create, Edit or Copy a job in Cloud Scheduler's three steps. Everything is sent at the end as one job definition; a refused field opens its step and shows its message.

On a narrow screen the picture scrolls sideways. A pin opens its row in the table.

1 2 3 4 5 6 7 8 9 10

UI breakdown

User stories and acceptance criteria

1. The next runs as I type

   Given Frequency 0 9 * * 1 and time zone Asia/Kolkata

   When I stop typing

   Then The next 5 runs: lists five Mondays at 9:00, in that zone.

2. A check that retries

   Given Kind Uptime check and Max retry attempts 1

   When I click Create

   Then nothing is made, step 3 opens, and Max retry attempts shows A check does not retry: retryCount is 0.

3. Copy a job

   Given the job nightly-report

   When I choose Copy

   Then the form is titled Copy nightly-report with its settings and an empty name, and Create makes a new job.

Back to the list of screens

11. Job

A job as Cloud Scheduler shows it: its own buttons from its allowedActions, three tiles, and the tabs Logs, Results (checks only) and Configuration.

On a narrow screen the picture scrolls sideways. A pin opens its row in the table.

1 2 3 4 5 6 7 8 9 10 11 12

UI breakdown

User stories and acceptance criteria

1. Resume a paused job

   Given nightly-report is paused, so Next run reads a dash

   When I click Resume

   Then the notice reads Resumed nightly-report. and Next run shows its next time.

2. Force run past the quota

   Given the project's daily quota is used up

   When I click Force run

   Then the API answers 429 with code quota and the notice shows its message; scheduled runs are skipped and logged as Skipped (daily quota).

3. A run while one is going

   Given a job set to skip while a run is still going, with a run under way

   When its next scheduled time comes

   Then no run starts, and Logs shows a run Skipped (still running).

Back to the list of screens

12. API keys

The project's API keys, for apps on /v1. A new key is shown once; after that only its name.

On a narrow screen the picture scrolls sideways. A pin opens its row in the table.

1 2 3 4 5 6 7 8

UI breakdown

User stories and acceptance criteria

1. The key is shown once

   Given I fill in Key name

   When I click Create key

   Then the key is shown once with Copy it now … You won't see it again: the console keeps only a hash of it., and after I have copied it only its name shows.

2. Rotate with the default end

   Given the key shop-app, and Old key ends left empty

   When I click Rotate, then Create key

   Then a new key is made and shown once, and shop-app keeps working for 7 days.

3. The cap on keys

   Given the project has 20 keys that are not revoked

   When I click Create key

   Then nothing is made: 409 A project has at most 20 API keys that are not revoked; revoke one first.

Back to the list of screens

13. Secrets and service accounts

The project's secrets and service accounts. Anyone who may read the project sees their names; values are sealed when saved and never shown again.

On a narrow screen the picture scrolls sideways. A pin opens its row in the table.

1 2 3 4 5 6 7 8 9 10 11 12

UI breakdown

User stories and acceptance criteria

1. An HMAC secret is made by the console

   Given Kind HMAC signing secret

   When I click Add the secret

   Then the console makes the signing secret and shows it once, for the receiving app, with I have copied it.

2. A secret still in use

   Given a job calls with the secret shop-api-token

   When I delete it

   Then it stays: 409 A job or the alert settings use this secret.

3. A credential at the wrong origin

   Given shop-api-token may go only to its one origin

   When a task names it with a URL at another origin

   Then the task is refused (400) with the message at url, and nothing is sent.

Back to the list of screens

14. Alerts

The project's alert settings, a test, and its quiet hours. The page needs the update permission.

On a narrow screen the picture scrolls sideways. A pin opens its row in the table.

1 2 3 4 5 6 7 8 9 10 11 12 13

UI breakdown

User stories and acceptance criteria

1. An address that is not a user

   Given a member adds an address that is no console user's

   When they click Save

   Then nothing is saved and Email addresses shows that it is not an active console user who may read shop.

2. A test with nowhere to go

   Given no email address and no Google Chat webhook

   When I click Send a test

   Then the API answers 409 No alert channel is set.

3. Alerts wait for the morning

   Given quiet hours 22:00 to 06:00 with Alerts wait

   When a task fails for good at 23:00

   Then nothing is sent then; when the window ends at 06:00 one message goes, starting Quiet hours ended for shop: with how many alerts waited.

Back to the list of screens

15. Export and import

A project's settings as one JSON file, to keep or to copy to another project. Never a secret's value, a key or a token.

On a narrow screen the picture scrolls sideways. A pin opens its row in the table.

1 2 3 4 5 6

UI breakdown

User stories and acceptance criteria

1. Preview the sample

   Given the sample file, unchanged, and the update, create and pause permissions

   When I click Preview

   Then the label says what would be made, nothing changes, and Apply shows below it.

2. Apply without the create permission

   Given a file that makes a queue, and no create permission

   When I click Preview

   Then there is no Apply, and the label says why; an apply sent anyway is 403 Applying this needs the create permission.

3. A mistake deep in the file

   Given a file whose third queue has Max attempts 0

   When I click Preview

   Then nothing changes and the message names settings.queues.2.maxAttempts.

4. Too many files

   Given 20 exports and imports this hour

   When I click Download

   Then the API answers 429 At most 20 exports and imports an hour; try again later.

Back to the list of screens

16. Usage

Today's free-plan usage as the Worker counts it, each project's count against its daily cap, and, for admins, the backups.

On a narrow screen the picture scrolls sideways. A pin opens its row in the table.

1 2 3 4 5 6 7 8 9

UI breakdown

User stories and acceptance criteria

1. Back to the default cap

   Given shop's cap is 2,000 and I am an admin

   When I click Set the cap, empty the field and click Set the cap

   Then the notice names shop and its count, and its Daily cap reads 5,000 (the default).

2. A member sees the totals only

   Given a member

   When they open Usage

   Then they see the Free plan lines and their projects, but no Set the cap and no Backups section.

3. A free limit is used up

   Given D1 rows written passed 100,000 today

   When anyone opens Usage

   Then the line reads Over the limit and a red line says every queue is held, and new tasks and job runs are refused, until the next UTC day.

Back to the list of screens

17. People

The console's people and its open invitations, for admins. People come in only by invitation.

On a narrow screen the picture scrolls sideways. A pin opens its row in the table.

1 2 3 4 5 6 7 8 9

UI breakdown

User stories and acceptance criteria

1. No actions on the break-glass admin

   Given the break-glass admin's row

   When I look for its menu

   Then there is none, and a change sent anyway is refused with 409.

2. Mail is off

   Given a valid email and mail settings not set

   When I click Send the invitation

   Then the API answers 503 Mail is off: set the MAIL_* settings to send invitations, after checking the fields first.

3. Someone already here

   Given an address that already has an account

   When I invite it

   Then it is refused: 409 That person is here already.

4. A preset only ticks boxes

   Given the editor preset chosen for shop

   When I look at shop's row

   Then read, create, update, pause and run are ticked, and what is sent is the ticked boxes.

Back to the list of screens

Status and labels

Every state the console shows as a chip. The words are the API's label; the colour and the shape follow the state it answered, so a state never rests on colour alone.

Back to the list of screens