[DavidBiddle]

What problem does this pull request solve?

Trello card: https://trello.com/c/P7bDQZTP/3248-get-submission-delivery-configuration-from-latest-live-version-of-the-form-in-forms-runner

Adds a new v3 API endpoint that will return a list of forms which have a given delivery schedule.

The endpoint is at /api/v3/forms/with-delivery-schedule/:schedule where :schedule is one of immediate, daily or weekly.

It will return a JSON response listing form IDs and state for any current or draft FormDocuments with the specified delivery schedule:

[
  {
    "form_id": 1,
    "state": "current"
  },
  {
    "form_id": 2,
    "state": "current"
  },
  {
    "form_id": 3,
    "state": "current"
  },
  {
    "form_id": 8,
    "state": "current"
  },
  {
    "form_id": 5,
    "state": "current"
  },
  {
    "form_id": 6,
    "state": "current"
  },
  {
    "form_id": 9,
    "state": "current"
  },
  {
    "form_id": 7,
    "state": "current"
  },
  {
    "form_id": 4,
    "state": "current"
  },
  {
    "form_id": 1,
    "state": "draft"
  },
  {
    "form_id": 2,
    "state": "draft"
  },
  {
    "form_id": 3,
    "state": "draft"
  },
  {
    "form_id": 5,
    "state": "draft"
  },
  {
    "form_id": 6,
    "state": "draft"
  },
  {
    "form_id": 7,
    "state": "draft"
  },
  {
    "form_id": 8,
    "state": "draft"
  },
  {
    "form_id": 9,
    "state": "draft"
  },
  {
    "form_id": 4,
    "state": "draft"
  }
]

Note that the only possible values for state are current and draft - live and archived form documents will show up as current. This matches the terminology we use in the delivery configurations endpoint. In forms-runner if a form is submitted in preview-archived mode we want to check it against the most recent live or archived form document

Things to consider when reviewing

• Ensure that you consider the wider context.
• Does it work when run on your machine?
• Is it clear what the code is doing?
• Do the commit messages explain why the changes were made?
• Are there all the unit tests needed?
• Do the end to end tests need updating before these changes will pass?
• Has all relevant documentation been updated?

[DavidBiddle]

Moving this back to draft because I think I need to rework it - if this and the corresponding runner work were implemented there's a risk of lost submissions (documented on the trello card)

Edit: I investigated and this was a false alarm - sticking with the current implementation

[Copilot]

🟢 Approval recommended

The remaining feedback concerns non-blocking test scenario and description corrections, with no identified functional defects.

3 open issues

• Use a different draft schedule to test schedule filtering · New
• Test empty results for a draft with a different schedule · New
• Test exclusion of a nonmatching draft schedule · New

What changed in this PR

Adds a v3 API endpoint for forms-runner to find forms by delivery schedule, returning matching draft and latest live or archived documents as draft and current states.

Changes:

• Adds /api/v3/forms/with-delivery-schedule/:schedule for immediate, daily, and weekly schedules.
• Queries document delivery configurations and combines matching form IDs and states.
• Adds delivery configuration factory traits and model/request coverage.

File	Description
spec/​requests/​api/​v3_form_documents_controller_spec.rb	Tests endpoint responses across document states and no-match cases.
spec/​models/​form_spec.rb	Tests delivery traits, schedule queries, and combined results.
spec/​factories/​models/​forms.rb	Adds S3 and daily/weekly email delivery traits.
config/​routes.rb	Adds the schedule-filtered route while preserving existing endpoints.
app/​models/​form.rb	Adds schedule queries and maps document tags to response states.
app/​controllers/​api/​v3_form_documents_controller.rb	Adds the action returning matching forms as JSON.

_{Review effort: Balanced}

[github-actions]

🎉 A review copy of this PR has been deployed! You can reach it at: https://pr-3239.admin.review.forms.service.gov.uk/

It may take 5 minutes or so for the application to be fully deployed and working. If it still isn't ready
after 5 minutes, there may be something wrong with the ECS task. You will need to go to the integration AWS account
to debug, or otherwise ask an infrastructure person.

For the sign in details and more information, see the review apps wiki page.