Replacing vets-json-schema with rails validation for COE Form Submissions by jesse-b-wilcore · Pull Request #27781 · department-of-veterans-affairs/vets-api

jesse-b-wilcore · 2026-04-15T20:21:16Z

Keep your PR as a Draft until it's ready for Platform review. A PR is ready for Platform review when it has a teammate approval and tests, linting, and settings checks pass CI. See these tips on how to avoid common delays in getting your PR merged.

Summary

replace vets-json-schema with rails validation

Related issue(s)

2489

Testing done

Unit tests

Screenshots

Note: Optional

What areas of the site does it impact?

(Describe what parts of the site are impacted andifcode touched other areas)

Coe/saved claims

Acceptance criteria

form_matches_schema overridden in CoeClaim with Rails validation
All required fields validated for presence
Field types validated (strings, booleans, nested objects)
Format validation for email, phone numbers, dates, addresses, etcexpected
I added a screenshot of the developed feature

Requested Feedback

(OPTIONAL)What should the reviewers know in addition to the above. Is there anything specific you wish the reviewer to assist with. Do you have any concerns with this PR, why?

github-actions · 2026-04-15T20:22:03Z

	1 Warning
⚠️	This PR changes `428` lines of code (not counting whitespace/newlines, comments, or test files). In order to ensure each PR receives the proper attention it deserves, we recommend not exceeding `200`. Expect some delays getting reviews. File Summary Files .github/CODEOWNERS (+6/-0) app/models/concerns/coe_claim_form_validation.rb (+333/-0) app/models/saved_claim/coe_claim.rb (+34/-4) config/features.yml (+1/-1) lib/coe/service_branch.rb (+38/-0) lib/common/validations_patterns.rb (+11/-0) Note: We exclude files matching the following when considering PR size: `.csv, .json, .tsv, .txt, .md, Gemfile.lock, app/swagger, modules/mobile/docs, spec/fixtures/, spec/support/vcr_cassettes/, modules/mobile/spec/support/vcr_cassettes/, db/seeds, modules/vaos/app/docs, modules/meb_api/app/docs, modules/appeals_api/app/swagger/, .bru, .pdf, modules//spec/fixtures/, modules//spec/factories/, modules//spec/*/.rb, spec/*/.rb, modules//docs//.yaml, modules//docs//.yml, modules//app/docs//.yaml, modules//app/docs//.yml` Big PRs are difficult to review, often become stale, and cause delays.

Generated by 🚫 Danger

jesse-b-wilcore · 2026-04-22T14:29:32Z

-                        { status: e.status, messsage: e.message, body: e.body })
+                        { status: e.status, message: e.message, body: e.body })
    else
-      Rails.logger.error('LGY API returned error', { status: e.status, messsage: e.message, body: e.body })
+      Rails.logger.error('LGY API returned error', { status: e.status, message: e.message, body: e.body })


fixing a typo but unrelated to this ticket

…rm-submission-replacing-vets-json-schema

jesse-b-wilcore · 2026-04-22T14:40:30Z

-    # Otherwise, submit the claim to the LGY API
-    else
-      Rails.logger.info('Begin COE claim submission to LGY API', guid:)
-      response = lgy_service.put_application(payload: prepare_form_data)
-      Rails.logger.info('COE claim submitted to LGY API', guid:, reference_number: response['reference_number'])
-
-      process_attachments!
-      response['reference_number']


else statement was unnecessary

jesse-b-wilcore · 2026-04-22T14:40:52Z

sourced from https://github.com/department-of-veterans-affairs/vets-website/blob/main/src/platform/forms-system/src/js/web-component-patterns/content/serviceBranch.json

For some reason this feels like a very, "FE dev" thing to do, but I like it. I would have stuffed it all into a class constant, which would've made reading the source code more difficult

jesse-b-wilcore · 2026-04-22T14:41:40Z

+module Coe
+  module ServiceBranch
+    CONFIG_PATH = Rails.root.join('config', 'coe', 'service_branch.json')
+    TABLE = JSON.parse(CONFIG_PATH.read).freeze


feel like there may be a better name than table to describe the json structure but couldn't think of it

naming things is hard

jesse-b-wilcore · 2026-04-22T14:42:39Z

    it 'sends the right data to LGY' do
      # rubocop:disable Layout/LineLength
-      coe_claim = create(:coe_claim, form: '{"relevantPriorLoans":[{"dateRange":{"from":"2017-01-01T00:00:00.000Z","to":""},"propertyAddress":{"propertyAddress1":"234","propertyAddress2":"234","propertyCity":"asdf","propertyState":"AL","propertyZip":"11111"},"propertyOwned":false,"vaLoanNumber":"123123123123","intent":"IRRRL"},{"dateRange":{"from":"2010-01-01T00:00:00.000Z","to":"2011-01-01T00:00:00.000Z"},"propertyAddress":{"propertyAddress1":"939393","propertyAddress2":"234","propertyCity":"asdf","propertyState":"AL","propertyZip":"11111"},"propertyOwned":true,"vaLoanNumber":"123123123123","intent":"REFI"}],"vaLoanIndicator":true,"periodsOfService":[{"serviceBranch":"Air Force","dateRange":{"from":"2000-01-01T00:00:00.000Z","to":"2010-01-16T00:00:00.000Z"}}],"identity":"ADSM","contactPhone":"2223334444","contactEmail":"[email protected]","fullName":{"first":"Eddie","middle":"Joseph","last":"Caldwell"},"dateOfBirth":"1933-10-27","applicantAddress":{"country":"USA","street":"123 ANY ST","city":"ANYTOWN","state":"AL","postalCode":"54321"},"privacyAgreementAccepted":true}')
+      coe_claim = create(:coe_claim, form: '{"relevantPriorLoans":[{"dateRange":{"from":"2017-01-01T00:00:00.000Z","to":""},"propertyAddress":{"propertyAddress1":"234","propertyAddress2":"234","propertyCity":"asdf","propertyState":"AL","propertyZip":"11111"},"propertyOwned":false,"vaLoanNumber":"123123123123","intent":"IRRRL"},{"dateRange":{"from":"2010-01-01T00:00:00.000Z","to":"2011-01-01T00:00:00.000Z"},"propertyAddress":{"propertyAddress1":"939393","propertyAddress2":"234","propertyCity":"asdf","propertyState":"AL","propertyZip":"11111"},"propertyOwned":true,"vaLoanNumber":"123123123123","intent":"REFI"}],"vaLoanIndicator":true,"periodsOfService":[{"serviceBranch":"AF","dateRange":{"from":"2000-01-01T00:00:00.000Z","to":"2010-01-16T00:00:00.000Z"}}],"identity":"ADSM","contactPhone":"2223334444","contactEmail":"[email protected]","fullName":{"first":"Eddie","middle":"Joseph","last":"Caldwell"},"dateOfBirth":"1933-10-27","applicantAddress":{"country":"USA","street":"123 ANY ST","city":"ANYTOWN","state":"AL","postalCode":"54321"},"privacyAgreementAccepted":true}')


had to update these as the validations were causing failure in other tests

Wow that is ugly. I don't blame you for just changing "Air Force" -> "AF" to get this one over the line, but it would be good to have a factory function to create different form objects. Would you mind creating a ticket for that, we can throw it on our backlog to do later.

yeah ill make a ticket for it

AdamKing0126 · 2026-04-22T17:11:44Z

-      # values from the FE for military_branch are:
-      # ["Air Force", "Air Force Reserve", "Air National Guard", "Army", "Army National Guard", "Army Reserve",
-      # "Coast Guard", "Coast Guard Reserve", "Marine Corps", "Marine Corps Reserve", "Navy", "Navy Reserve"]
-      # these need to be formatted because LGY only accepts [ARMY, NAVY, MARINES, AIR_FORCE, COAST_GUARD, OTHER]
-      # and then we have to pass in ACTIVE_DUTY or RESERVE_NATIONAL_GUARD for service_type
-      military_branch = service_info['serviceBranch'].parameterize.underscore.upcase
-      service_type = 'ACTIVE_DUTY'
-
-      # "Marine Corps" must be converted to "Marines" here, so that the `.any`
-      # block below can convert "Marine Corps" and "Marine Corps Reserve" to
-      # "MARINES", to meet LGY's requirements.
-      military_branch = military_branch.gsub('MARINE_CORPS', 'MARINES')
-
-      %w[RESERVE NATIONAL_GUARD].any? do |service_branch|
-        next unless military_branch.include?(service_branch)
-
-        index = military_branch.index('_NATIONAL_GUARD') || military_branch.index('_RESERVE')
-        military_branch = military_branch[0, index]
-        # "Air National Guard", unlike "Air Force Reserve", needs to be manually
-        # transformed to AIR_FORCE here, to meet LGY's requirements.
-        military_branch = 'AIR_FORCE' if military_branch == 'AIR'
-        service_type = 'RESERVE_NATIONAL_GUARD'


Because I neglected to include information in the ticket about feature toggles (sorry), this stuff will need to be reinstated, and an if clause introduced, to use the COE::ServiceBranch helper

AdamKing0126 · 2026-04-22T17:14:12Z

                  'vaLoanIndicator' => true,
                  'periodsOfService' => [{
-                    'serviceBranch' => 'Air National Guard',
+                    'serviceBranch' => 'ANG',


I love that you thought to update the swagger documentation here. I would have forgotten this.

Is the rest of the incoming object really identical, from current version to the stuff that the FE guys have rebuilt? Seems like we should check this (although i am totally fine with putting it into a separate PR)

yeah ill make a follow up ticket

AdamKing0126

This looks good so far. Once you insert logic for the feature toggle, I will approve.

AdamKing0126

Looks good, no notes. I appreciate your flexibility wrt feature flag stuff.

work in progress

c377bee

jesse-b-wilcore requested review from a team as code owners April 15, 2026 20:21

jesse-b-wilcore marked this pull request as draft April 15, 2026 20:21

va-vsp-bot added the codeowners-addition-failure label Apr 15, 2026

github-actions Bot added lint-failure test-failure labels Apr 15, 2026

AdamKing0126 reviewed Apr 15, 2026

View reviewed changes

Comment thread app/models/concerns/coe_claim_form_validation.rb Outdated

AdamKing0126 reviewed Apr 15, 2026

View reviewed changes

Comment thread app/models/concerns/coe_claim_form_validation.rb Outdated

khenson-oddball reviewed Apr 16, 2026

View reviewed changes

Comment thread app/models/concerns/coe_claim_form_validation.rb

jesse-b-wilcore added 2 commits April 21, 2026 13:46

addressing PR feedback and cleaning up

911c717

adding file to codeowners

203e3c3

va-vsp-bot removed the codeowners-addition-failure label Apr 21, 2026

jesse-b-wilcore added 2 commits April 21, 2026 14:00

adding test and rest of clean up to fix failing lint check

830b4e1

update tests and vcr cassets

da469dc

github-actions Bot removed lint-failure test-failure labels Apr 21, 2026

jesse-b-wilcore requested review from AdamKing0126 and khenson-oddball April 21, 2026 21:37

github-actions Bot added the require-backend-approval label Apr 22, 2026

changing service branch

38e9497

github-actions Bot added the lint-failure label Apr 22, 2026

factory clean up

43462ee

jesse-b-wilcore commented Apr 22, 2026

View reviewed changes

jesse-b-wilcore added 2 commits April 22, 2026 08:33

Merge branch 'master' into 2489-implement-rails-validation-for-coe-fo…

d0237a0

…rm-submission-replacing-vets-json-schema

addressing pr comment from co-pilot

64c9ec1

department-of-veterans-affairs deleted a comment from va-vsp-bot Apr 22, 2026

jesse-b-wilcore commented Apr 22, 2026

View reviewed changes

github-actions Bot removed the lint-failure label Apr 22, 2026

jesse-b-wilcore commented Apr 22, 2026

View reviewed changes

upping test coverage

a5789a5

department-of-veterans-affairs deleted a comment from github-actions Bot Apr 22, 2026

AdamKing0126 reviewed Apr 22, 2026

View reviewed changes

add flipper logic

fbe5cf3

github-actions Bot added the lint-failure label Apr 22, 2026

fixing lint error

44ebdb7

github-actions Bot removed the lint-failure label Apr 22, 2026

AdamKing0126 approved these changes Apr 22, 2026

View reviewed changes

jesse-b-wilcore marked this pull request as ready for review April 22, 2026 22:03

jesse-b-wilcore requested a review from a team as a code owner April 22, 2026 22:03

Conversation

jesse-b-wilcore commented Apr 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Related issue(s)

Testing done

Screenshots

What areas of the site does it impact?

Acceptance criteria

Requested Feedback

Uh oh!

github-actions Bot commented Apr 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Files

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!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AdamKing0126 left a comment

Choose a reason for hiding this comment

Uh oh!

AdamKing0126 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jesse-b-wilcore commented Apr 15, 2026 •

edited

Loading

github-actions Bot commented Apr 15, 2026 •

edited

Loading