Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[i18n-Audio] Add DB schemas and shared API/store stubs #3987

Merged
merged 7 commits into from
Sep 21, 2023
Merged

[i18n-Audio] Add DB schemas and shared API/store stubs #3987

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9087cdf
Add DB schemas
kofi-q Sep 20, 2023
e8fab0c
Add shared API and store to libs/backend
kofi-q Sep 20, 2023
e4f9007
Install shared API and store in Mark, Scan, & Mark-Scan
kofi-q Sep 21, 2023
e5f6511
Add app tests, using shared test utils
kofi-q Sep 21, 2023
8299d88
Update libs/backend package.json
kofi-q Sep 21, 2023
dff26d8
Update zod schema reference in DB schemas
kofi-q Sep 21, 2023
58cbdd3
Drop redundant tests
kofi-q Sep 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions apps/mark-scan/backend/schema.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,27 @@ create table system_settings (
id integer primary key check (id = 1),
data text not null -- JSON blob
);

create table languages (
code text primary key
);

create table ui_strings (
language_code text primary key,
data text not null, -- JSON blob - see libs/types/UiStringTranslationsSchema
foreign key (language_code) references languages(code)
);

create table audio_clips (
id text not null,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Double checking my understanding: These id values are the same as the audio keys as described in the spec, e.g. d5b21f, correct?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, these correspond the audio keys - and I'm realising the inconsistent naming is confusing (especially once I started building on this PR 😅 ). I think I'm going to settle on id and change the property names in related schemas to id/audioId to make things more consistent

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, I like that!

language_code text not null,
data_base64 text not null, -- Base64-encoded audio bytes
primary key (language_code, id),
foreign key (language_code) references languages(code)
);

create table ui_string_audio_keys (
language_code text primary key,
data text not null, -- JSON blob - see libs/types/UiStringTranslationsSchema
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we want to reference libs/types/UiStringAudioKeysSchema here (and same in the other schema.sql files)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, thanks for the catch!

foreign key (language_code) references languages(code)
);
53 changes: 52 additions & 1 deletion apps/mark-scan/backend/src/app.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,17 @@ import {
singlePrecinctSelectionFor,
} from '@votingworks/utils';
import { Buffer } from 'buffer';
import { createBallotPackageZipArchive, MockUsb } from '@votingworks/backend';
import {
createBallotPackageZipArchive,
createUiStringsApiMock,
MockUsb,
} from '@votingworks/backend';
import { Server } from 'http';
import * as grout from '@votingworks/grout';
import {
DEFAULT_SYSTEM_SETTINGS,
ElectionDefinition,
LanguageCode,
SinglePrecinctSelection,
safeParseSystemSettings,
} from '@votingworks/types';
Expand All @@ -40,6 +45,14 @@ jest.mock('@votingworks/utils', (): typeof import('@votingworks/utils') => {
};
});

const mockUiStringsApi = createUiStringsApiMock();
jest.mock('@votingworks/backend', (): typeof import('@votingworks/backend') => {
return {
...jest.requireActual('@votingworks/backend'),
createUiStringsApi: () => mockUiStringsApi,
};
});

let apiClient: grout.Client<Api>;
let mockAuth: InsertedSmartCardAuthApi;
let mockUsb: MockUsb;
Expand All @@ -62,6 +75,7 @@ beforeEach(async () => {
afterEach(() => {
stateMachine.stopMachineService();
server?.close();
jest.resetAllMocks();
});

async function setUpUsbAndConfigureElection(
Expand Down Expand Up @@ -240,3 +254,40 @@ test('configureWithSampleBallotPackageForIntegrationTest configures electionGene
const electionDefinitionResult = await apiClient.getElectionDefinition();
expect(electionDefinitionResult).toEqual(electionGeneralDefinition);
});

test('installs UI Strings API', async () => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm taking a sec to wrap my mind around the difference between these tests and the tests in app.ui_strings.test.ts, specifically trying to understand why the former are necessary.

It seems like the main thing tested in this file that's not tested in app.ui_strings.test.ts is the Grout client's ability to access the endpoints. Otherwise, app.ui_strings.test.ts tests everything tested in here and more (installation of the UI strings API + actual implementation since it doesn't mock).

I wonder if we can just assume that the Grout client will work fine, given libs/grout tests. Or alternatively, have the shared ui_strings_api_test_runner.ts create a Grout client for testing.

I might be missing something! Just wondering if we can get rid of these app.test.ts tests so that everything, tests included, really is automatic.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, thanks - I lost perspective on this after a couple iterations. Initially had the shared test runner just taking in a store input and testing that, but you're spot on WRT not needing these tests since the test runner is testing against an app's actual API.
Will go ahead and drop these!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Figured that might've been the case re iterations!

mockOf(mockUiStringsApi.getAvailableLanguages).mockImplementation(() => [
LanguageCode.SPANISH,
]);
await expect(apiClient.getAvailableLanguages()).resolves.toEqual([
LanguageCode.SPANISH,
]);

mockOf(mockUiStringsApi.getUiStrings).mockImplementation(() => ({
foo: 'bar',
}));
await expect(
apiClient.getUiStrings({ languageCode: LanguageCode.SPANISH })
).resolves.toEqual({
foo: 'bar',
});

mockOf(mockUiStringsApi.getUiStringAudioKeys).mockImplementation(() => ({
foo: ['123', '456'],
}));
await expect(
apiClient.getUiStringAudioKeys({ languageCode: LanguageCode.SPANISH })
).resolves.toEqual({
foo: ['123', '456'],
});

mockOf(mockUiStringsApi.getAudioClipsBase64).mockImplementation(() => ({
abc: 'data-abc',
}));
await expect(
apiClient.getAudioClipsBase64({
languageCode: LanguageCode.ENGLISH,
audioKeys: ['abc'],
})
).resolves.toEqual({ abc: 'data-abc' });
});
14 changes: 12 additions & 2 deletions apps/mark-scan/backend/src/app.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,11 @@ import {
singlePrecinctSelectionFor,
} from '@votingworks/utils';

import { Usb, readBallotPackageFromUsb } from '@votingworks/backend';
import {
createUiStringsApi,
Usb,
readBallotPackageFromUsb,
} from '@votingworks/backend';
import { Logger } from '@votingworks/logging';
import { electionGeneralDefinition } from '@votingworks/fixtures';
import { useDevDockRouter } from '@votingworks/dev-dock-backend';
Expand All @@ -36,7 +40,8 @@ const debug = makeDebug('mark-scan:app-backend');

const defaultMediaMountDir = '/media';

function buildApi(
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
export function buildApi(
auth: InsertedSmartCardAuthApi,
usb: Usb,
logger: Logger,
Expand Down Expand Up @@ -232,6 +237,11 @@ function buildApi(

stateMachine.confirmInvalidateBallot();
},

...createUiStringsApi({
logger,
store: workspace.store.getUiStringsStore(),
}),
});
}

Expand Down
26 changes: 26 additions & 0 deletions apps/mark-scan/backend/src/app.ui_strings.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import tmp from 'tmp';

import { createMockUsb, runUiStringApiTests } from '@votingworks/backend';
import { fakeLogger } from '@votingworks/logging';

import { buildMockInsertedSmartCardAuth } from '@votingworks/auth';
import { Store } from './store';
import { createWorkspace } from './util/workspace';
import { buildApi } from './app';

const store = Store.memoryStore();
const workspace = createWorkspace(tmp.dirSync().name, { store });

afterAll(() => {
workspace.reset();
});

runUiStringApiTests({
api: buildApi(
buildMockInsertedSmartCardAuth(),
createMockUsb().mock,
fakeLogger(),
workspace
),
store: store.getUiStringsStore(),
});
18 changes: 15 additions & 3 deletions apps/mark-scan/backend/src/store.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// The durable datastore for configuration info.
//

import { UiStringsStore, createUiStringStore } from '@votingworks/backend';
import { Optional } from '@votingworks/basics';
import { Client as DbClient } from '@votingworks/db';
import {
Expand All @@ -21,7 +22,10 @@ const SchemaPath = join(__dirname, '../schema.sql');
* Manages a data store for imported election definition and system settings
*/
export class Store {
private constructor(private readonly client: DbClient) {}
private constructor(
private readonly client: DbClient,
private readonly uiStringsStore: UiStringsStore
) {}

getDbPath(): string {
return this.client.getDatabasePath();
Expand All @@ -31,14 +35,18 @@ export class Store {
* Builds and returns a new store whose data is kept in memory.
*/
static memoryStore(): Store {
return new Store(DbClient.memoryClient(SchemaPath));
const client = DbClient.memoryClient(SchemaPath);
const uiStringsStore = createUiStringStore(client);
return new Store(client, uiStringsStore);
}

/**
* Builds and returns a new store at `dbPath`.
*/
static fileStore(dbPath: string): Store {
return new Store(DbClient.fileClient(dbPath, SchemaPath));
const client = DbClient.fileClient(dbPath, SchemaPath);
const uiStringsStore = createUiStringStore(client);
return new Store(client, uiStringsStore);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! I like these patterns that you're setting for shared store and API code. I'd been with experimenting with similar ideas recently, e.g.

vxsuite/apps/scan/backend/src/store.ts

Lines 36 to 40 in 6c454a5

import {
clearCastVoteRecordHashes,
getCastVoteRecordRootHash,
updateCastVoteRecordHashes,
} from '@votingworks/auth';

vxsuite/apps/scan/backend/src/store.ts

Lines 958 to 968 in 6c454a5

getCastVoteRecordRootHash(): string {
return getCastVoteRecordRootHash(this.client);
}
updateCastVoteRecordHashes(cvrId: string, cvrHash: string): void {
updateCastVoteRecordHashes(this.client, cvrId, cvrHash);
}
clearCastVoteRecordHashes(): void {
clearCastVoteRecordHashes(this.client);
}

I like that what you're setting up is more automatic than what I'd set up. Looks like we can add new methods to libs/backend and the app stores and APIs will automatically update 🪄.

Re SQL schemas, I too just copied the schemas since we don't yet have a clear pattern for sharing those - that seems fine to me.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! I missed those - makes me feel better knowing that we have other instances where we're sharing the query code

}

/**
Expand Down Expand Up @@ -184,4 +192,8 @@ export class Store {
if (!result) return undefined;
return safeParseSystemSettings(result.data).unsafeUnwrap();
}

getUiStringsStore(): UiStringsStore {
return this.uiStringsStore;
}
}
7 changes: 5 additions & 2 deletions apps/mark-scan/backend/src/util/workspace.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,15 @@ export function constructAuthMachineState(
};
}

export function createWorkspace(root: string): Workspace {
export function createWorkspace(
root: string,
options: { store?: Store } = {}
): Workspace {
const resolvedRoot = resolve(root);
ensureDirSync(resolvedRoot);

const dbPath = join(resolvedRoot, 'mark.db');
const store = Store.fileStore(dbPath);
const store = options.store || Store.fileStore(dbPath);

return {
path: resolvedRoot,
Expand Down
24 changes: 24 additions & 0 deletions apps/mark/backend/schema.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,27 @@ create table system_settings (
id integer primary key check (id = 1),
data text not null -- JSON blob
);

create table languages (
code text primary key
);

create table ui_strings (
language_code text primary key,
data text not null, -- JSON blob - see libs/types/UiStringTranslationsSchema
foreign key (language_code) references languages(code)
);

create table audio_clips (
id text not null,
language_code text not null,
data_base64 text not null, -- Base64-encoded audio bytes
primary key (language_code, id),
foreign key (language_code) references languages(code)
);

create table ui_string_audio_keys (
language_code text primary key,
data text not null, -- JSON blob - see libs/types/UiStringTranslationsSchema
foreign key (language_code) references languages(code)
);
52 changes: 51 additions & 1 deletion apps/mark/backend/src/app.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,19 @@ import {
DEFAULT_SYSTEM_SETTINGS,
safeParseJson,
SystemSettingsSchema,
LanguageCode,
} from '@votingworks/types';
import {
BooleanEnvironmentVariableName,
getFeatureFlagMock,
} from '@votingworks/utils';

import { Buffer } from 'buffer';
import { createBallotPackageZipArchive, MockUsb } from '@votingworks/backend';
import {
createBallotPackageZipArchive,
createUiStringsApiMock,
MockUsb,
} from '@votingworks/backend';
import { Server } from 'http';
import * as grout from '@votingworks/grout';
import { createApp } from '../test/app_helpers';
Expand All @@ -38,6 +43,14 @@ jest.mock('@votingworks/utils', (): typeof import('@votingworks/utils') => {
};
});

const mockUiStringsApi = createUiStringsApiMock();
jest.mock('@votingworks/backend', (): typeof import('@votingworks/backend') => {
return {
...jest.requireActual('@votingworks/backend'),
createUiStringsApi: () => mockUiStringsApi,
};
});

let apiClient: grout.Client<Api>;
let mockAuth: InsertedSmartCardAuthApi;
let mockUsb: MockUsb;
Expand Down Expand Up @@ -190,3 +203,40 @@ test('configureWithSampleBallotPackageForIntegrationTest configures electionGene
const electionDefinitionResult = await apiClient.getElectionDefinition();
expect(electionDefinitionResult).toEqual(electionGeneralDefinition);
});

test('installs UI Strings API', async () => {
mockOf(mockUiStringsApi.getAvailableLanguages).mockImplementation(() => [
LanguageCode.SPANISH,
]);
await expect(apiClient.getAvailableLanguages()).resolves.toEqual([
LanguageCode.SPANISH,
]);

mockOf(mockUiStringsApi.getUiStrings).mockImplementation(() => ({
foo: 'bar',
}));
await expect(
apiClient.getUiStrings({ languageCode: LanguageCode.SPANISH })
).resolves.toEqual({
foo: 'bar',
});

mockOf(mockUiStringsApi.getUiStringAudioKeys).mockImplementation(() => ({
foo: ['123', '456'],
}));
await expect(
apiClient.getUiStringAudioKeys({ languageCode: LanguageCode.SPANISH })
).resolves.toEqual({
foo: ['123', '456'],
});

mockOf(mockUiStringsApi.getAudioClipsBase64).mockImplementation(() => ({
abc: 'data-abc',
}));
await expect(
apiClient.getAudioClipsBase64({
languageCode: LanguageCode.ENGLISH,
audioKeys: ['abc'],
})
).resolves.toEqual({ abc: 'data-abc' });
});
14 changes: 12 additions & 2 deletions apps/mark/backend/src/app.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,11 @@ import {
} from '@votingworks/types';
import { isElectionManagerAuth } from '@votingworks/utils';

import { Usb, readBallotPackageFromUsb } from '@votingworks/backend';
import {
createUiStringsApi,
Usb,
readBallotPackageFromUsb,
} from '@votingworks/backend';
import { Logger } from '@votingworks/logging';
import { electionGeneralDefinition } from '@votingworks/fixtures';
import { useDevDockRouter } from '@votingworks/dev-dock-backend';
Expand All @@ -37,7 +41,8 @@ function constructAuthMachineState(
};
}

function buildApi(
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
export function buildApi(
auth: InsertedSmartCardAuthApi,
usb: Usb,
logger: Logger,
Expand Down Expand Up @@ -139,6 +144,11 @@ function buildApi(

return ok(electionDefinition);
},

...createUiStringsApi({
logger,
store: workspace.store.getUiStringsStore(),
}),
});
}

Expand Down
Loading