feat: encode yes/no votes to allow recording overvotes

This is a BREAKING CHANGE in the CVR format.

Refs votingworks/vxmail#37

apps/module-scan/src/endToEndHmpb.test.ts

@@ -91,7 +91,9 @@ test('going through the whole process works', async () => {
     const CVRs: CastVoteRecord[] = exportResponse.text
       .split('\n')
       .map((line) => JSON.parse(line))
-    const p1CVR = CVRs.find((cvr) => cvr['us-senate'])!
+    const p1CVR = CVRs.find(
+      (cvr) => Array.isArray(cvr['us-senate']) && cvr['us-senate'].length > 0
+    )!
     const p2CVR = CVRs.find((cvr) => cvr !== p1CVR)!
 
     delete p1CVR._ballotId
@@ -102,17 +104,17 @@ test('going through the whole process works', async () => {
         "_ballotStyleId": "77",
         "_precinctId": "42",
         "_testBallot": false,
-        "dallas-city-council": "",
-        "dallas-county-commissioners-court-pct-3": "",
-        "dallas-county-proposition-r": "",
-        "dallas-county-retain-chief-justice": "",
+        "dallas-city-council": Array [],
+        "dallas-county-commissioners-court-pct-3": Array [],
+        "dallas-county-proposition-r": Array [],
+        "dallas-county-retain-chief-justice": Array [],
         "dallas-county-sheriff": Array [
           "chad-prda",
         ],
         "dallas-county-tax-assessor": Array [
           "john-ames",
         ],
-        "dallas-mayor": "",
+        "dallas-mayor": Array [],
         "texas-house-district-111": Array [
           "writein",
         ],
@@ -132,19 +134,21 @@ test('going through the whole process works', async () => {
         "_ballotStyleId": "77",
         "_precinctId": "42",
         "_testBallot": false,
-        "dallas-city-council": "",
+        "dallas-city-council": Array [],
         "dallas-county-commissioners-court-pct-3": Array [
           "andrew-jewell",
         ],
-        "dallas-county-proposition-r": "no",
-        "dallas-county-retain-chief-justice": "",
-        "dallas-county-sheriff": "",
-        "dallas-county-tax-assessor": "",
-        "dallas-mayor": "",
-        "texas-house-district-111": "",
-        "texas-sc-judge-place-6": "",
-        "us-house-district-30": "",
-        "us-senate": "",
+        "dallas-county-proposition-r": Array [
+          "no",
+        ],
+        "dallas-county-retain-chief-justice": Array [],
+        "dallas-county-sheriff": Array [],
+        "dallas-county-tax-assessor": Array [],
+        "dallas-mayor": Array [],
+        "texas-house-district-111": Array [],
+        "texas-sc-judge-place-6": Array [],
+        "us-house-district-30": Array [],
+        "us-senate": Array [],
       }
     `)
   }

apps/module-scan/src/interpreter.test.ts

@@ -78,13 +78,13 @@ test('interprets marks on a HMPB', async () => {
     expect.objectContaining({
       _ballotStyleId: '77',
       _precinctId: '42',
-      'dallas-city-council': '',
-      'dallas-county-commissioners-court-pct-3': '',
-      'dallas-county-proposition-r': '',
-      'dallas-county-retain-chief-justice': '',
+      'dallas-city-council': [],
+      'dallas-county-commissioners-court-pct-3': [],
+      'dallas-county-proposition-r': [],
+      'dallas-county-retain-chief-justice': [],
       'dallas-county-sheriff': ['chad-prda'],
       'dallas-county-tax-assessor': ['john-ames'],
-      'dallas-mayor': '',
+      'dallas-mayor': [],
       'texas-house-district-111': ['writein'],
       'texas-sc-judge-place-6': ['jane-bland'],
       'us-house-district-30': ['eddie-bernice-johnson'],
@@ -115,13 +115,13 @@ test('interprets marks on an upside-down HMPB', async () => {
     expect.objectContaining({
       _ballotStyleId: '77',
       _precinctId: '42',
-      'dallas-city-council': '',
-      'dallas-county-commissioners-court-pct-3': '',
-      'dallas-county-proposition-r': '',
-      'dallas-county-retain-chief-justice': '',
+      'dallas-city-council': [],
+      'dallas-county-commissioners-court-pct-3': [],
+      'dallas-county-proposition-r': [],
+      'dallas-county-retain-chief-justice': [],
       'dallas-county-sheriff': ['chad-prda'],
       'dallas-county-tax-assessor': ['john-ames'],
-      'dallas-mayor': '',
+      'dallas-mayor': [],
       'texas-house-district-111': ['writein'],
       'texas-sc-judge-place-6': ['jane-bland'],
       'us-house-district-30': ['eddie-bernice-johnson'],

apps/module-scan/src/interpreter.ts

@@ -11,18 +11,17 @@ import {
   Election,
   getContests,
   Optional,
-  OptionalYesNoVote,
+  YesNoVote,
 } from '@votingworks/ballot-encoder'
 import { Interpreter as HMPBInterpreter } from '@votingworks/hmpb-interpreter'
 import { detect as qrdetect } from '@votingworks/qrdetect'
+import makeDebug from 'debug'
 import { readFile as readFileCallback } from 'fs'
 import { decode as decodeJpeg } from 'jpeg-js'
 import { decode as quircDecode } from 'node-quirc'
 import { promisify } from 'util'
 import { CastVoteRecord } from './types'
 
-import makeDebug from 'debug'
-
 const debug = makeDebug('module-scan:interpreter')
 
 export interface InterpretFileParams {
@@ -47,7 +46,6 @@ interface InterpretBallotStringParams {
 function ballotToCastVoteRecord(
   ballot: CompletedBallot
 ): CastVoteRecord | undefined {
-  // TODO: Replace all this with a `CompletedBallot` -> `CastVoteRecord` mapper.
   const { election, ballotStyle, precinct, ballotId, isTestBallot } = ballot
 
   // figure out the contests
@@ -64,11 +62,13 @@ function ballotToCastVoteRecord(
   for (const contest of contests) {
     // no answer for a particular contest is recorded in our final dictionary as an empty string
     // not the same thing as undefined.
-    let cvrForContest: string | string[] = ''
+    let cvrForContest: string[] = []
     const vote = ballot.votes[contest.id]
 
     if (contest.type === 'yesno') {
-      cvrForContest = (vote as OptionalYesNoVote) || ''
+      if (vote) {
+        cvrForContest = [vote as YesNoVote]
+      }
     } else if (contest.type === 'candidate') {
       // selections for this question
       const candidates = vote as Optional<CandidateVote>