Skip to content

Merge in pre connect-es rpc/js #365

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.

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
merged 2 commits into from
Sep 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 4 additions & 23 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@
},
"homepage": "https://github.com/viamrobotics/viam-typescript-sdk#readme",
"dependencies": {
"@viamrobotics/rpc": "^0.2.6",
"exponential-backoff": "^3.1.1"
},
"devDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion src/app/viam-transport.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { grpc } from '@improbable-eng/grpc-web';
import { dialDirect } from '@viamrobotics/rpc';
import { dialDirect } from '../rpc';

import {
AuthenticateRequest,
Expand Down
2 changes: 1 addition & 1 deletion src/robot/client.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
/* eslint-disable max-classes-per-file */
import { grpc } from '@improbable-eng/grpc-web';
import { dialDirect, dialWebRTC, type DialOptions } from '@viamrobotics/rpc';
import { backOff } from 'exponential-backoff';
import { Duration } from 'google-protobuf/google/protobuf/duration_pb';
import { isCredential, type Credentials } from '../app/viam-transport';
Expand Down Expand Up @@ -32,6 +31,7 @@ import { SensorsServiceClient } from '../gen/service/sensors/v1/sensors_pb_servi
import { SLAMServiceClient } from '../gen/service/slam/v1/slam_pb_service';
import { VisionServiceClient } from '../gen/service/vision/v1/vision_pb_service';
import { ViamResponseStream } from '../responses';
import { dialDirect, dialWebRTC, type DialOptions } from '../rpc';
import { MetadataTransport, encodeResourceName, promisify } from '../utils';
import GRPCConnectionManager from './grpc-connection-manager';
import type { Robot, RobotStatusStream } from './robot';
Expand Down
6 changes: 3 additions & 3 deletions src/robot/session-manager.test.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// @vitest-environment happy-dom

import { beforeEach, describe, expect, it, vi } from 'vitest';
import { ConnectionClosedError } from '@viamrobotics/rpc';
import { FakeTransportBuilder } from '@improbable-eng/grpc-web-fake-transport';
import { grpc } from '@improbable-eng/grpc-web';
import { FakeTransportBuilder } from '@improbable-eng/grpc-web-fake-transport';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { RobotServiceClient } from '../gen/robot/v1/robot_pb_service';
import { ConnectionClosedError } from '../rpc';
vi.mock('../gen/robot/v1/robot_pb_service');

import SessionManager from './session-manager';
Expand Down
4 changes: 2 additions & 2 deletions src/robot/session-manager.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import { ConnectionClosedError } from '@viamrobotics/rpc';
import { grpc } from '@improbable-eng/grpc-web';
import robotApi from '../gen/robot/v1/robot_pb';
import {
RobotServiceClient,
type ServiceError,
} from '../gen/robot/v1/robot_pb_service';
import robotApi from '../gen/robot/v1/robot_pb';
import { ConnectionClosedError } from '../rpc';
import SessionTransport from './session-transport';

const timeoutBlob = new Blob(
Expand Down
2 changes: 1 addition & 1 deletion src/robot/session-transport.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { GRPCError } from '@viamrobotics/rpc';
import { grpc } from '@improbable-eng/grpc-web';
import { GRPCError } from '../rpc';
import type SessionManager from './session-manager';

export default class SessionTransport implements grpc.Transport {
Expand Down
81 changes: 81 additions & 0 deletions src/rpc/base-channel.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
import type { ProtobufMessage } from '@improbable-eng/grpc-web/dist/typings/message';
import { ConnectionClosedError } from './connection-closed-error';

export class BaseChannel {
public readonly ready: Promise<unknown>;

private readonly peerConn: RTCPeerConnection;
private readonly dataChannel: RTCDataChannel;
private pResolve: ((value: unknown) => void) | undefined;
private pReject: ((reason?: unknown) => void) | undefined;

private closed = false;
private closedReason: Error | undefined;

protected maxDataChannelSize = 65_535;

constructor(peerConn: RTCPeerConnection, dataChannel: RTCDataChannel) {
this.peerConn = peerConn;
this.dataChannel = dataChannel;

this.ready = new Promise<unknown>((resolve, reject) => {
this.pResolve = resolve;
this.pReject = reject;
});

dataChannel.addEventListener('open', () => this.onChannelOpen());
dataChannel.addEventListener('close', () => this.onChannelClose());
dataChannel.addEventListener('error', (ev) => {
this.onChannelError(ev);
});

peerConn.addEventListener('iceconnectionstatechange', () => {
const state = peerConn.iceConnectionState;
if (
!(state === 'failed' || state === 'disconnected' || state === 'closed')
) {
return;
}
this.pReject?.(new Error(`ICE connection failed with state: ${state}`));
});
}

public close() {
this.closeWithReason(undefined);
}

public isClosed() {
return this.closed;
}

public isClosedReason() {
return this.closedReason;
}

protected closeWithReason(err?: Error) {
if (this.closed) {
return;
}
this.closed = true;
this.closedReason = err;
this.pReject?.(err);
this.peerConn.close();
}

private onChannelOpen() {
this.pResolve?.(undefined);
}

private onChannelClose() {
this.closeWithReason(new ConnectionClosedError('data channel closed'));
}

private onChannelError(ev: any) {
console.error('channel error', ev);
this.closeWithReason(new Error(ev));
}

protected write(msg: ProtobufMessage) {
this.dataChannel.send(msg.serializeBinary());
}
}
62 changes: 62 additions & 0 deletions src/rpc/base-stream.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
import type { grpc } from '@improbable-eng/grpc-web';
import type { PacketMessage, Stream } from '../gen/proto/rpc/webrtc/v1/grpc_pb';

// MaxMessageSize (2^25) is the maximum size a gRPC message can be.
const MaxMessageSize = 33_554_432;

export class BaseStream {
protected readonly stream: Stream;
private readonly onDone: (id: number) => void;
protected readonly opts: grpc.TransportOptions;
protected closed = false;
private readonly packetBuf: Uint8Array[] = [];
private packetBufSize = 0;
private err: Error | undefined;

constructor(
stream: Stream,
onDone: (id: number) => void,
opts: grpc.TransportOptions
) {
this.stream = stream;
this.onDone = onDone;
this.opts = opts;
}

public closeWithRecvError(err?: Error) {
if (this.closed) {
return;
}
this.closed = true;
this.err = err;
this.onDone(this.stream.getId());
// pretty sure passing the error does nothing.
this.opts.onEnd(this.err);
}

protected processPacketMessage(msg: PacketMessage): Uint8Array | undefined {
const data = msg.getData_asU8();
if (data.length + this.packetBufSize > MaxMessageSize) {
this.packetBuf.length = 0;
this.packetBufSize = 0;
console.error(
`message size larger than max ${MaxMessageSize}; discarding`
);
return undefined;
}
this.packetBuf.push(data);
this.packetBufSize += data.length;
if (msg.getEom()) {
const pktData = new Uint8Array(this.packetBufSize);
let position = 0;
for (const partialData of this.packetBuf) {
pktData.set(partialData, position);
position += partialData.length;
}
this.packetBuf.length = 0;
this.packetBufSize = 0;
return pktData;
}
return undefined;
}
}
Loading