Skip to content

ServiceSchema implementation #76

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

Merged
Monkatraz merged 13 commits into from
Apr 17, 2024
Merged

ServiceSchema implementation #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
54c9877
separate services and procedures types, give each procedure its own type
Monkatraz Apr 2, 2024
4cd80f9
replace builder with ServiceSchema
Monkatraz Apr 3, 2024
f379ec8
allow TNever again, but make the uncaught schema always available as …
Monkatraz Apr 4, 2024
06774be
get rid of all the anys by using methods rather than function props
Monkatraz Apr 4, 2024
97dc2e7
add ProcedureResult to make things a little cleaner
Monkatraz Apr 4, 2024
51b709b
Merge branch 'main' into brn-service-schemas
Monkatraz Apr 4, 2024
c57fa72
some last type tweaks
Monkatraz Apr 4, 2024
4f17d58
missing newline
Monkatraz Apr 4, 2024
db9e3c2
add scaffold
Monkatraz Apr 17, 2024
d5603a6
add optional init fields
Monkatraz Apr 17, 2024
76fa609
report name
Monkatraz Apr 17, 2024
975c9ed
bump package version
Monkatraz Apr 17, 2024
fc54f5f
Merge branch 'main' into brn-service-schemas
Monkatraz Apr 17, 2024
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
6 changes: 2 additions & 4 deletions __tests__/bandwidth.bench.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import { afterAll, assert, bench, describe } from 'vitest';
import { waitForMessage } from '../util/testHelpers';
import { TestServiceConstructor } from './fixtures/services';
import { TestServiceSchema } from './fixtures/services';
import { createServer } from '../router/server';
import { createClient } from '../router/client';
import { buildServiceDefs } from '../router/defs';
import { transports } from './fixtures/transports';
import { nanoid } from 'nanoid';

Expand All @@ -26,8 +25,7 @@ describe('bandwidth', async () => {

const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([TestServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, { test: TestServiceSchema });
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand Down
29 changes: 13 additions & 16 deletions __tests__/cleanup.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ import {
} from 'vitest';
import { iterNext } from '../util/testHelpers';
import {
SubscribableServiceConstructor,
TestServiceConstructor,
UploadableServiceConstructor,
SubscribableServiceSchema,
TestServiceSchema,
UploadableServiceSchema,
} from './fixtures/services';
import { createClient, createServer } from '../router';
import {
Expand All @@ -21,7 +21,6 @@ import {
waitFor,
waitForTransportToFinish,
} from './fixtures/cleanup';
import { buildServiceDefs } from '../router/defs';
import { testMatrix } from './fixtures/matrix';

describe.each(testMatrix())(
Expand All @@ -36,8 +35,7 @@ describe.each(testMatrix())(
// setup
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([TestServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, { test: TestServiceSchema });
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand Down Expand Up @@ -76,8 +74,7 @@ describe.each(testMatrix())(
// setup
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([TestServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, { test: TestServiceSchema });
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand Down Expand Up @@ -116,8 +113,7 @@ describe.each(testMatrix())(
// setup
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([TestServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, { test: TestServiceSchema });
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand Down Expand Up @@ -163,8 +159,7 @@ describe.each(testMatrix())(
// setup
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([TestServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, { test: TestServiceSchema });
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand Down Expand Up @@ -231,8 +226,9 @@ describe.each(testMatrix())(
// setup
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([SubscribableServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, {
subscribable: SubscribableServiceSchema,
});
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand Down Expand Up @@ -292,8 +288,9 @@ describe.each(testMatrix())(
// setup
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([UploadableServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, {
uploadable: UploadableServiceSchema,
});
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand Down
23 changes: 11 additions & 12 deletions __tests__/disconnects.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ import {
} from 'vitest';
import { iterNext } from '../util/testHelpers';
import {
SubscribableServiceConstructor,
TestServiceConstructor,
UploadableServiceConstructor,
SubscribableServiceSchema,
TestServiceSchema,
UploadableServiceSchema,
} from './fixtures/services';
import { createClient, createServer } from '../router';
import {
Expand All @@ -20,7 +20,6 @@ import {
waitFor,
} from './fixtures/cleanup';
import { Err, UNEXPECTED_DISCONNECT } from '../router/result';
import { buildServiceDefs } from '../router/defs';
import { testMatrix } from './fixtures/matrix';

describe.each(testMatrix())(
Expand All @@ -34,8 +33,7 @@ describe.each(testMatrix())(
test('rpc', async () => {
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([TestServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, { test: TestServiceSchema });
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand Down Expand Up @@ -77,8 +75,7 @@ describe.each(testMatrix())(
test('stream', async () => {
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([TestServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, { test: TestServiceSchema });
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand Down Expand Up @@ -126,8 +123,9 @@ describe.each(testMatrix())(
const client2Transport = getClientTransport('client2');
const serverTransport = getServerTransport();

const serviceDefs = buildServiceDefs([SubscribableServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, {
subscribable: SubscribableServiceSchema,
});
const client1 = createClient<typeof server>(
client1Transport,
serverTransport.clientId,
Expand Down Expand Up @@ -213,8 +211,9 @@ describe.each(testMatrix())(
test('upload', async () => {
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([UploadableServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, {
uploadable: UploadableServiceSchema,
});
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand Down
65 changes: 34 additions & 31 deletions __tests__/e2e.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,17 @@ import { iterNext } from '../util/testHelpers';
import { createServer } from '../router/server';
import { createClient } from '../router/client';
import {
BinaryFileServiceConstructor,
BinaryFileServiceSchema,
DIV_BY_ZERO,
FallibleServiceConstructor,
OrderingServiceConstructor,
FallibleServiceSchema,
STREAM_ERROR,
SubscribableServiceConstructor,
UploadableServiceConstructor,
TestServiceConstructor,
SubscribableServiceSchema,
TestServiceSchema,
UploadableServiceSchema,
OrderingServiceSchema,
} from './fixtures/services';
import { UNCAUGHT_ERROR } from '../router/result';
import { testFinishesCleanly } from './fixtures/cleanup';
import { buildServiceDefs } from '../router/defs';
import { testMatrix } from './fixtures/matrix';

describe.each(testMatrix())(
Expand All @@ -36,8 +35,7 @@ describe.each(testMatrix())(
// setup
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([TestServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, { test: TestServiceSchema });
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand All @@ -60,8 +58,9 @@ describe.each(testMatrix())(
// setup
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([FallibleServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, {
fallible: FallibleServiceSchema,
});
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand Down Expand Up @@ -93,8 +92,9 @@ describe.each(testMatrix())(
// setup
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([BinaryFileServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, {
bin: BinaryFileServiceSchema,
});
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand All @@ -120,8 +120,7 @@ describe.each(testMatrix())(
// setup
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([TestServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, { test: TestServiceSchema });
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand Down Expand Up @@ -164,8 +163,7 @@ describe.each(testMatrix())(
// setup
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([TestServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, { test: TestServiceSchema });
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand Down Expand Up @@ -202,8 +200,9 @@ describe.each(testMatrix())(
// setup
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([FallibleServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, {
fallible: FallibleServiceSchema,
});
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand Down Expand Up @@ -243,8 +242,9 @@ describe.each(testMatrix())(
// setup
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([SubscribableServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, {
subscribable: SubscribableServiceSchema,
});
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand Down Expand Up @@ -286,8 +286,9 @@ describe.each(testMatrix())(
// setup
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([UploadableServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, {
uploadable: UploadableServiceSchema,
});
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand Down Expand Up @@ -315,8 +316,9 @@ describe.each(testMatrix())(
// setup
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([UploadableServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, {
uploadable: UploadableServiceSchema,
});
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand Down Expand Up @@ -346,8 +348,9 @@ describe.each(testMatrix())(
// setup
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([OrderingServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, {
test: OrderingServiceSchema,
});
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand Down Expand Up @@ -394,8 +397,9 @@ describe.each(testMatrix())(
// setup
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([OrderingServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, {
test: OrderingServiceSchema,
});
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand Down Expand Up @@ -425,8 +429,7 @@ describe.each(testMatrix())(
// setup
const clientTransport = getClientTransport('client');
const serverTransport = getServerTransport();
const serviceDefs = buildServiceDefs([TestServiceConstructor()]);
const server = createServer(serverTransport, serviceDefs);
const server = createServer(serverTransport, { test: TestServiceSchema });
const client = createClient<typeof server>(
clientTransport,
serverTransport.clientId,
Expand Down
5 changes: 3 additions & 2 deletions __tests__/fixtures/cleanup.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { expect, vi } from 'vitest';
import { Connection, OpaqueTransportMessage, Transport } from '../../transport';
import { Server } from '../../router';
import { log } from '../../logging';
import { ServiceSchemaMap } from '../../router/services';
import { testingSessionOptions } from '../../util/testHelpers';

const waitUntilOptions = {
Expand Down Expand Up @@ -90,7 +91,7 @@ export async function ensureTransportBuffersAreEventuallyEmpty(
);
}

export async function ensureServerIsClean(s: Server<unknown>) {
export async function ensureServerIsClean(s: Server<ServiceSchemaMap>) {
return waitFor(() =>
expect(
s.streams,
Expand All @@ -106,7 +107,7 @@ export async function testFinishesCleanly({
}: Partial<{
clientTransports: Array<Transport<Connection>>;
serverTransport: Transport<Connection>;
server: Server<unknown>;
server: Server<ServiceSchemaMap>;
}>) {
log?.info('*** end of test cleanup ***');
vi.useFakeTimers({ shouldAdvanceTime: true });
Expand Down
Loading