Add generate election package script #5721
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonahkagan
approved these changes
Dec 11, 2024
| layouts and translations. Follow the instructions to setup Google Cloud account | ||
| authentication [here](/../backend/src/language_and_audio/README.md) before | ||
| using. | ||
|
|
There was a problem hiding this comment.
It looks like this README section interrupts the Election Fixture Generator section. Also, it doesn't seem to include usage instructions for Election Package Generator
| * Helper function that renders ballots and generates an election definition for the standard | ||
| * VxSuite hmpb ballot layout. | ||
| */ | ||
| export async function createElectionDefinitionForDefaultHmpbLayouts( |
There was a problem hiding this comment.
Nit: maybe "Template" rather than "Layouts"
| * Helper function to generate all necessary strings used in an election package. | ||
| * Returns three packages of strings: app strings, HMPB strings, and election strings. | ||
| */ | ||
| export async function getAllStringsForElectionPackage( |
There was a problem hiding this comment.
Nit: change get to translate to be more specific about what's happening
| import { generateElectionPackage } from '../../generate-election-package'; | ||
|
|
||
| // A script to generate an election package. | ||
| // Usage: ./generate-election-package <election_fixtures_directory_path> <is_multi_language> <force_restranslate> |
There was a problem hiding this comment.
API suggestions to improve clarity and better mesh with existing scripts in this lib:
- Take a path to the election.json rather than requiring that it is named
baseElection.jsonso the script can be used more flexibly - Instead of
force_retranslate, optionally take a path to the election package that should be used as a translation cache (e.g.--reuse-translations <path_to_package>) - Change
is_multi_languageto a flag--multi-language. It's a bit confusing just seeing a1in the command - Require an output path to be specified
--outputPath <path>
Take them or leave them, not blocking
| // by passing a third argument of '1'. | ||
|
|
||
| // The generated election.json file for this election package will be stored alongside it in the | ||
| // election package directory for convenance. |
There was a problem hiding this comment.
spelling: convenance -> convenience
| ): Promise<number> { | ||
| if (argv.length !== 5) { | ||
| stderr.write( | ||
| 'Usage: generate-election-package <election_fixtures_directory_path> <is_multi_language> <force_restranslate>]\n' |
There was a problem hiding this comment.
Spelling: force_restranslate -> force_retranslate
|
|
||
| /** | ||
| * Mock implementation of the SpeechSynthesizer interface. Returns the input text with '(audio)' appended rather | ||
| * than a base64 encoded audio clip. |
There was a problem hiding this comment.
This comment doesn't seem to be accurate
eventualbuddha
pushed a commit
that referenced
this pull request
Dec 12, 2024
* add generate-election-packages script with test when it needs regen * make default latest metadata * add version of electionPrimaryPrecinctSplits without ballot strings * all new fixtures generated files * fixtures build:resources * export newly added fixtures for use in package generator test * address pr comments * fix refactor
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Next step of the plan outlined in #5695 and implementing a lot of the work from that draft.
This PR adds a script to lib/fixture-generators to generate an election package in a given lib/fixtures directory folder. I add the generated results for 1 initial election but the only work in this PR that uses those fixtures is the new test that makes sure election packages generated are up to date.
Future Planned Work Still Includes:
Testing Plan
Ran tests
Manually tested using generated election package with generated json linked in dev dock for smart cards