Compare commits
1 Commits
path-to-no
...
grackle-la
Author | SHA1 | Date | |
---|---|---|---|
c84c4ab578 |
@ -48,72 +48,6 @@ type Timeout = ReturnType<typeof setTimeout>
|
|||||||
|
|
||||||
type ClientMetrics = Models['ClientMetrics_type']
|
type ClientMetrics = Models['ClientMetrics_type']
|
||||||
|
|
||||||
type Value<T, U> = U extends undefined
|
|
||||||
? { type: T; value: U }
|
|
||||||
: U extends void
|
|
||||||
? { type: T }
|
|
||||||
: { type: T; value: U }
|
|
||||||
|
|
||||||
type State<T, U> = Value<T, U>
|
|
||||||
|
|
||||||
enum EngineConnectionStateType {
|
|
||||||
Fresh = 'fresh',
|
|
||||||
Connecting = 'connecting',
|
|
||||||
ConnectionEstablished = 'connection-established',
|
|
||||||
Disconnected = 'disconnected',
|
|
||||||
}
|
|
||||||
|
|
||||||
enum DisconnectedType {
|
|
||||||
Error = 'error',
|
|
||||||
Timeout = 'timeout',
|
|
||||||
Quit = 'quit',
|
|
||||||
}
|
|
||||||
|
|
||||||
type DisconnectedValue =
|
|
||||||
| State<DisconnectedType.Error, Error | undefined>
|
|
||||||
| State<DisconnectedType.Timeout, void>
|
|
||||||
| State<DisconnectedType.Quit, void>
|
|
||||||
|
|
||||||
// These are ordered by the expected sequence.
|
|
||||||
enum ConnectingType {
|
|
||||||
WebSocketConnecting = 'websocket-connecting',
|
|
||||||
WebSocketEstablished = 'websocket-established',
|
|
||||||
PeerConnectionCreated = 'peer-connection-created',
|
|
||||||
ICEServersSet = 'ice-servers-set',
|
|
||||||
SetLocalDescription = 'set-local-description',
|
|
||||||
OfferedSdp = 'offered-sdp',
|
|
||||||
ReceivedSdp = 'received-sdp',
|
|
||||||
SetRemoteDescription = 'set-remote-description',
|
|
||||||
WebRTCConnecting = 'webrtc-connecting',
|
|
||||||
ICECandidateReceived = 'ice-candidate-received',
|
|
||||||
TrackReceived = 'track-received',
|
|
||||||
DataChannelRequested = 'data-channel-requested',
|
|
||||||
DataChannelConnecting = 'data-channel-connecting',
|
|
||||||
DataChannelEstablished = 'data-channel-established',
|
|
||||||
}
|
|
||||||
|
|
||||||
type ConnectingValue =
|
|
||||||
| State<ConnectingType.WebSocketConnecting, void>
|
|
||||||
| State<ConnectingType.WebSocketEstablished, void>
|
|
||||||
| State<ConnectingType.PeerConnectionCreated, void>
|
|
||||||
| State<ConnectingType.ICEServersSet, void>
|
|
||||||
| State<ConnectingType.SetLocalDescription, void>
|
|
||||||
| State<ConnectingType.OfferedSdp, void>
|
|
||||||
| State<ConnectingType.ReceivedSdp, void>
|
|
||||||
| State<ConnectingType.SetRemoteDescription, void>
|
|
||||||
| State<ConnectingType.WebRTCConnecting, void>
|
|
||||||
| State<ConnectingType.TrackReceived, void>
|
|
||||||
| State<ConnectingType.ICECandidateReceived, void>
|
|
||||||
| State<ConnectingType.DataChannelRequested, string>
|
|
||||||
| State<ConnectingType.DataChannelConnecting, string>
|
|
||||||
| State<ConnectingType.DataChannelEstablished, void>
|
|
||||||
|
|
||||||
type EngineConnectionState =
|
|
||||||
| State<EngineConnectionStateType.Fresh, void>
|
|
||||||
| State<EngineConnectionStateType.Connecting, ConnectingValue>
|
|
||||||
| State<EngineConnectionStateType.ConnectionEstablished, void>
|
|
||||||
| State<EngineConnectionStateType.Disconnected, DisconnectedValue>
|
|
||||||
|
|
||||||
// EngineConnection encapsulates the connection(s) to the Engine
|
// EngineConnection encapsulates the connection(s) to the Engine
|
||||||
// for the EngineCommandManager; namely, the underlying WebSocket
|
// for the EngineCommandManager; namely, the underlying WebSocket
|
||||||
// and WebRTC connections.
|
// and WebRTC connections.
|
||||||
@ -121,28 +55,10 @@ class EngineConnection {
|
|||||||
websocket?: WebSocket
|
websocket?: WebSocket
|
||||||
pc?: RTCPeerConnection
|
pc?: RTCPeerConnection
|
||||||
unreliableDataChannel?: RTCDataChannel
|
unreliableDataChannel?: RTCDataChannel
|
||||||
mediaStream?: MediaStream
|
|
||||||
|
|
||||||
private _state: EngineConnectionState = {
|
|
||||||
type: EngineConnectionStateType.Fresh,
|
|
||||||
}
|
|
||||||
|
|
||||||
get state(): EngineConnectionState {
|
|
||||||
return this._state
|
|
||||||
}
|
|
||||||
|
|
||||||
set state(next: EngineConnectionState) {
|
|
||||||
console.log(`${JSON.stringify(this.state)} → ${JSON.stringify(next)}`)
|
|
||||||
if (next.type === EngineConnectionStateType.Disconnected) {
|
|
||||||
console.trace()
|
|
||||||
const sub = next.value
|
|
||||||
if (sub.type === DisconnectedType.Error) {
|
|
||||||
console.error(sub.value)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
this._state = next
|
|
||||||
}
|
|
||||||
|
|
||||||
|
private ready: boolean
|
||||||
|
private connecting: boolean
|
||||||
|
private dead: boolean
|
||||||
private failedConnTimeout: Timeout | null
|
private failedConnTimeout: Timeout | null
|
||||||
|
|
||||||
readonly url: string
|
readonly url: string
|
||||||
@ -178,77 +94,74 @@ class EngineConnection {
|
|||||||
}) {
|
}) {
|
||||||
this.url = url
|
this.url = url
|
||||||
this.token = token
|
this.token = token
|
||||||
|
this.ready = false
|
||||||
|
this.connecting = false
|
||||||
|
this.dead = false
|
||||||
this.failedConnTimeout = null
|
this.failedConnTimeout = null
|
||||||
this.onWebsocketOpen = onWebsocketOpen
|
this.onWebsocketOpen = onWebsocketOpen
|
||||||
this.onDataChannelOpen = onDataChannelOpen
|
this.onDataChannelOpen = onDataChannelOpen
|
||||||
this.onEngineConnectionOpen = onEngineConnectionOpen
|
this.onEngineConnectionOpen = onEngineConnectionOpen
|
||||||
this.onConnectionStarted = onConnectionStarted
|
this.onConnectionStarted = onConnectionStarted
|
||||||
|
|
||||||
this.onClose = onClose
|
this.onClose = onClose
|
||||||
this.onNewTrack = onNewTrack
|
this.onNewTrack = onNewTrack
|
||||||
|
|
||||||
// TODO(paultag): This ought to be tweakable.
|
// TODO(paultag): This ought to be tweakable.
|
||||||
const pingIntervalMs = 10000
|
const pingIntervalMs = 10000
|
||||||
|
|
||||||
// Without an interval ping, our connection will timeout.
|
|
||||||
let pingInterval = setInterval(() => {
|
let pingInterval = setInterval(() => {
|
||||||
switch (this.state.type as EngineConnectionStateType) {
|
if (this.dead) {
|
||||||
case EngineConnectionStateType.ConnectionEstablished:
|
clearInterval(pingInterval)
|
||||||
this.send({ type: 'ping' })
|
}
|
||||||
break
|
if (this.isReady()) {
|
||||||
case EngineConnectionStateType.Disconnected:
|
// When we're online, every 10 seconds, we'll attempt to put a 'ping'
|
||||||
clearInterval(pingInterval)
|
// command through the WebSocket connection. This will help both ends
|
||||||
break
|
// of the connection maintain the TCP connection without hitting a
|
||||||
default:
|
// timeout condition.
|
||||||
break
|
this.send({ type: 'ping' })
|
||||||
}
|
}
|
||||||
}, pingIntervalMs)
|
}, pingIntervalMs)
|
||||||
|
|
||||||
const connectionTimeoutMs = VITE_KC_CONNECTION_TIMEOUT_MS
|
const connectionTimeoutMs = VITE_KC_CONNECTION_TIMEOUT_MS
|
||||||
let connectRetryInterval = setInterval(() => {
|
let connectInterval = setInterval(() => {
|
||||||
if (this.state.type !== EngineConnectionStateType.Disconnected) return
|
if (this.dead) {
|
||||||
switch (this.state.value.type) {
|
clearInterval(connectInterval)
|
||||||
case DisconnectedType.Error:
|
return
|
||||||
clearInterval(connectRetryInterval)
|
|
||||||
break
|
|
||||||
case DisconnectedType.Timeout:
|
|
||||||
console.log('Trying to reconnect')
|
|
||||||
this.connect()
|
|
||||||
break
|
|
||||||
default:
|
|
||||||
break
|
|
||||||
}
|
}
|
||||||
|
if (this.isReady()) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
console.log('connecting via retry')
|
||||||
|
this.connect()
|
||||||
}, connectionTimeoutMs)
|
}, connectionTimeoutMs)
|
||||||
}
|
}
|
||||||
|
// isConnecting will return true when connect has been called, but the full
|
||||||
|
// WebRTC is not online.
|
||||||
isConnecting() {
|
isConnecting() {
|
||||||
return this.state.type === EngineConnectionStateType.Connecting
|
return this.connecting
|
||||||
}
|
}
|
||||||
|
// isReady will return true only when the WebRTC *and* WebSocket connection
|
||||||
|
// are connected. During setup, the WebSocket connection comes online first,
|
||||||
|
// which is used to establish the WebRTC connection. The EngineConnection
|
||||||
|
// is not "Ready" until both are connected.
|
||||||
isReady() {
|
isReady() {
|
||||||
return this.state.type === EngineConnectionStateType.ConnectionEstablished
|
return this.ready
|
||||||
}
|
}
|
||||||
|
|
||||||
tearDown() {
|
tearDown() {
|
||||||
this.disconnectAll()
|
this.dead = true
|
||||||
this.state = {
|
this.close()
|
||||||
type: EngineConnectionStateType.Disconnected,
|
|
||||||
value: { type: DisconnectedType.Quit },
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// shouldTrace will return true when Sentry should be used to instrument
|
// shouldTrace will return true when Sentry should be used to instrument
|
||||||
// the Engine.
|
// the Engine.
|
||||||
shouldTrace() {
|
shouldTrace() {
|
||||||
return Sentry.getCurrentHub()?.getClient()?.getOptions()?.sendClientReports
|
return Sentry.getCurrentHub()?.getClient()?.getOptions()?.sendClientReports
|
||||||
}
|
}
|
||||||
|
|
||||||
// connect will attempt to connect to the Engine over a WebSocket, and
|
// connect will attempt to connect to the Engine over a WebSocket, and
|
||||||
// establish the WebRTC connections.
|
// establish the WebRTC connections.
|
||||||
//
|
//
|
||||||
// This will attempt the full handshake, and retry if the connection
|
// This will attempt the full handshake, and retry if the connection
|
||||||
// did not establish.
|
// did not establish.
|
||||||
connect() {
|
connect() {
|
||||||
|
console.log('connect was called')
|
||||||
if (this.isConnecting() || this.isReady()) {
|
if (this.isConnecting() || this.isReady()) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@ -282,269 +195,71 @@ class EngineConnection {
|
|||||||
let handshakeSpan: SpanPromise
|
let handshakeSpan: SpanPromise
|
||||||
let iceSpan: SpanPromise
|
let iceSpan: SpanPromise
|
||||||
|
|
||||||
const spanStart = (op: string) =>
|
|
||||||
new SpanPromise(webrtcMediaTransaction.startChild({ op }))
|
|
||||||
|
|
||||||
if (this.shouldTrace()) {
|
if (this.shouldTrace()) {
|
||||||
webrtcMediaTransaction = Sentry.startTransaction({ name: 'webrtc-media' })
|
webrtcMediaTransaction = Sentry.startTransaction({
|
||||||
websocketSpan = spanStart('websocket')
|
name: 'webrtc-media',
|
||||||
}
|
|
||||||
|
|
||||||
const createPeerConnection = () => {
|
|
||||||
this.pc = new RTCPeerConnection()
|
|
||||||
|
|
||||||
// Data channels MUST BE specified before SDP offers because requesting
|
|
||||||
// them affects what our needs are!
|
|
||||||
const DATACHANNEL_NAME_UMC = 'unreliable_modeling_cmds'
|
|
||||||
this.pc.createDataChannel(DATACHANNEL_NAME_UMC)
|
|
||||||
|
|
||||||
this.state = {
|
|
||||||
type: EngineConnectionStateType.Connecting,
|
|
||||||
value: {
|
|
||||||
type: ConnectingType.DataChannelRequested,
|
|
||||||
value: DATACHANNEL_NAME_UMC,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
this.pc.addEventListener('icecandidate', (event) => {
|
|
||||||
if (event.candidate === null) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
this.state = {
|
|
||||||
type: EngineConnectionStateType.Connecting,
|
|
||||||
value: {
|
|
||||||
type: ConnectingType.ICECandidateReceived,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
// Request a candidate to use
|
|
||||||
this.send({
|
|
||||||
type: 'trickle_ice',
|
|
||||||
candidate: event.candidate.toJSON(),
|
|
||||||
})
|
|
||||||
})
|
})
|
||||||
|
websocketSpan = new SpanPromise(
|
||||||
this.pc.addEventListener('icecandidateerror', (_event: Event) => {
|
webrtcMediaTransaction.startChild({ op: 'websocket' })
|
||||||
const event = _event as RTCPeerConnectionIceErrorEvent
|
)
|
||||||
console.warn(
|
|
||||||
`ICE candidate returned an error: ${event.errorCode}: ${event.errorText} for ${event.url}`
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
// https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/connectionstatechange_event
|
|
||||||
// Event type: generic Event type...
|
|
||||||
this.pc.addEventListener('connectionstatechange', (event: any) => {
|
|
||||||
console.log('connectionstatechange: ' + event.target?.connectionState)
|
|
||||||
switch (event.target?.connectionState) {
|
|
||||||
// From what I understand, only after have we done the ICE song and
|
|
||||||
// dance is it safest to connect the video tracks / stream
|
|
||||||
case 'connected':
|
|
||||||
if (this.shouldTrace()) {
|
|
||||||
iceSpan.resolve?.()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Let the browser attach to the video stream now
|
|
||||||
this.onNewTrack({ conn: this, mediaStream: this.mediaStream! })
|
|
||||||
break
|
|
||||||
case 'failed':
|
|
||||||
this.disconnectAll()
|
|
||||||
this.state = {
|
|
||||||
type: EngineConnectionStateType.Disconnected,
|
|
||||||
value: {
|
|
||||||
type: DisconnectedType.Error,
|
|
||||||
value: new Error(
|
|
||||||
'failed to negotiate ice connection; restarting'
|
|
||||||
),
|
|
||||||
},
|
|
||||||
}
|
|
||||||
break
|
|
||||||
default:
|
|
||||||
break
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
this.pc.addEventListener('track', (event) => {
|
|
||||||
const mediaStream = event.streams[0]
|
|
||||||
|
|
||||||
this.state = {
|
|
||||||
type: EngineConnectionStateType.Connecting,
|
|
||||||
value: {
|
|
||||||
type: ConnectingType.TrackReceived,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
if (this.shouldTrace()) {
|
|
||||||
let mediaStreamTrack = mediaStream.getVideoTracks()[0]
|
|
||||||
mediaStreamTrack.addEventListener('unmute', () => {
|
|
||||||
// let settings = mediaStreamTrack.getSettings()
|
|
||||||
// mediaTrackSpan.span.setTag("fps", settings.frameRate)
|
|
||||||
// mediaTrackSpan.span.setTag("width", settings.width)
|
|
||||||
// mediaTrackSpan.span.setTag("height", settings.height)
|
|
||||||
mediaTrackSpan.resolve?.()
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
this.webrtcStatsCollector = (): Promise<ClientMetrics> => {
|
|
||||||
return new Promise((resolve, reject) => {
|
|
||||||
if (mediaStream.getVideoTracks().length !== 1) {
|
|
||||||
reject(new Error('too many video tracks to report'))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
let videoTrack = mediaStream.getVideoTracks()[0]
|
|
||||||
void this.pc?.getStats(videoTrack).then((videoTrackStats) => {
|
|
||||||
let client_metrics: ClientMetrics = {
|
|
||||||
rtc_frames_decoded: 0,
|
|
||||||
rtc_frames_dropped: 0,
|
|
||||||
rtc_frames_received: 0,
|
|
||||||
rtc_frames_per_second: 0,
|
|
||||||
rtc_freeze_count: 0,
|
|
||||||
rtc_jitter_sec: 0.0,
|
|
||||||
rtc_keyframes_decoded: 0,
|
|
||||||
rtc_total_freezes_duration_sec: 0.0,
|
|
||||||
}
|
|
||||||
|
|
||||||
// TODO(paultag): Since we can technically have multiple WebRTC
|
|
||||||
// video tracks (even if the Server doesn't at the moment), we
|
|
||||||
// ought to send stats for every video track(?), and add the stream
|
|
||||||
// ID into it. This raises the cardinality of collected metrics
|
|
||||||
// when/if we do, but for now, just report the one stream.
|
|
||||||
|
|
||||||
videoTrackStats.forEach((videoTrackReport) => {
|
|
||||||
if (videoTrackReport.type === 'inbound-rtp') {
|
|
||||||
client_metrics.rtc_frames_decoded =
|
|
||||||
videoTrackReport.framesDecoded || 0
|
|
||||||
client_metrics.rtc_frames_dropped =
|
|
||||||
videoTrackReport.framesDropped || 0
|
|
||||||
client_metrics.rtc_frames_received =
|
|
||||||
videoTrackReport.framesReceived || 0
|
|
||||||
client_metrics.rtc_frames_per_second =
|
|
||||||
videoTrackReport.framesPerSecond || 0
|
|
||||||
client_metrics.rtc_freeze_count =
|
|
||||||
videoTrackReport.freezeCount || 0
|
|
||||||
client_metrics.rtc_jitter_sec = videoTrackReport.jitter || 0.0
|
|
||||||
client_metrics.rtc_keyframes_decoded =
|
|
||||||
videoTrackReport.keyFramesDecoded || 0
|
|
||||||
client_metrics.rtc_total_freezes_duration_sec =
|
|
||||||
videoTrackReport.totalFreezesDuration || 0
|
|
||||||
} else if (videoTrackReport.type === 'transport') {
|
|
||||||
// videoTrackReport.bytesReceived,
|
|
||||||
// videoTrackReport.bytesSent,
|
|
||||||
}
|
|
||||||
})
|
|
||||||
resolve(client_metrics)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// The app is eager to use the MediaStream; as soon as onNewTrack is
|
|
||||||
// called, the following sequence happens:
|
|
||||||
// EngineConnection.onNewTrack -> StoreState.setMediaStream ->
|
|
||||||
// Stream.tsx reacts to mediaStream change, setting a video element.
|
|
||||||
// We wait until connectionstatechange changes to "connected"
|
|
||||||
// to pass it to the rest of the application.
|
|
||||||
|
|
||||||
this.mediaStream = mediaStream
|
|
||||||
})
|
|
||||||
|
|
||||||
this.pc.addEventListener('datachannel', (event) => {
|
|
||||||
this.unreliableDataChannel = event.channel
|
|
||||||
|
|
||||||
this.state = {
|
|
||||||
type: EngineConnectionStateType.Connecting,
|
|
||||||
value: {
|
|
||||||
type: ConnectingType.DataChannelConnecting,
|
|
||||||
value: event.channel.label,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
this.unreliableDataChannel.addEventListener('open', (event) => {
|
|
||||||
this.state = {
|
|
||||||
type: EngineConnectionStateType.Connecting,
|
|
||||||
value: {
|
|
||||||
type: ConnectingType.DataChannelEstablished,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
if (this.shouldTrace()) {
|
|
||||||
dataChannelSpan.resolve?.()
|
|
||||||
}
|
|
||||||
|
|
||||||
this.onDataChannelOpen(this)
|
|
||||||
|
|
||||||
// Everything is now connected.
|
|
||||||
this.state = { type: EngineConnectionStateType.ConnectionEstablished }
|
|
||||||
|
|
||||||
this.onEngineConnectionOpen(this)
|
|
||||||
})
|
|
||||||
|
|
||||||
this.unreliableDataChannel.addEventListener('close', (event) => {
|
|
||||||
console.log(event)
|
|
||||||
console.log('unreliable data channel closed')
|
|
||||||
this.disconnectAll()
|
|
||||||
this.unreliableDataChannel = undefined
|
|
||||||
|
|
||||||
if (this.areAllConnectionsClosed()) {
|
|
||||||
this.state = {
|
|
||||||
type: EngineConnectionStateType.Disconnected,
|
|
||||||
value: { type: DisconnectedType.Quit },
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
this.unreliableDataChannel.addEventListener('error', (event) => {
|
|
||||||
this.disconnectAll()
|
|
||||||
|
|
||||||
this.state = {
|
|
||||||
type: EngineConnectionStateType.Disconnected,
|
|
||||||
value: {
|
|
||||||
type: DisconnectedType.Error,
|
|
||||||
value: new Error(event.toString()),
|
|
||||||
},
|
|
||||||
}
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
this.state = {
|
|
||||||
type: EngineConnectionStateType.Connecting,
|
|
||||||
value: {
|
|
||||||
type: ConnectingType.WebSocketConnecting,
|
|
||||||
},
|
|
||||||
}
|
}
|
||||||
|
|
||||||
this.websocket = new WebSocket(this.url, [])
|
this.websocket = new WebSocket(this.url, [])
|
||||||
this.websocket.binaryType = 'arraybuffer'
|
this.websocket.binaryType = 'arraybuffer'
|
||||||
|
|
||||||
|
this.pc = new RTCPeerConnection()
|
||||||
|
this.pc.createDataChannel('unreliable_modeling_cmds')
|
||||||
this.websocket.addEventListener('open', (event) => {
|
this.websocket.addEventListener('open', (event) => {
|
||||||
this.state = {
|
console.log('Connected to websocket, waiting for ICE servers')
|
||||||
type: EngineConnectionStateType.Connecting,
|
|
||||||
value: {
|
|
||||||
type: ConnectingType.WebSocketEstablished,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
this.onWebsocketOpen(this)
|
|
||||||
|
|
||||||
// This is required for when KCMA is running stand-alone / within Tauri.
|
|
||||||
// Otherwise when run in a browser, the token is sent implicitly via
|
|
||||||
// the Cookie header.
|
|
||||||
if (this.token) {
|
if (this.token) {
|
||||||
this.send({ headers: { Authorization: `Bearer ${this.token}` } })
|
this.send({ headers: { Authorization: `Bearer ${this.token}` } })
|
||||||
}
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
this.pc.addEventListener('icecandidateerror', (_event) => {
|
||||||
|
const event = _event as RTCPeerConnectionIceErrorEvent
|
||||||
|
console.error(
|
||||||
|
`ICE candidate returned an error: ${event.errorCode}: ${event.errorText} for ${event.url}`
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
this.pc.addEventListener('connectionstatechange', (event) => {
|
||||||
|
if (this.pc?.iceConnectionState === 'connected') {
|
||||||
|
if (this.shouldTrace()) {
|
||||||
|
iceSpan.resolve?.()
|
||||||
|
}
|
||||||
|
} else if (this.pc?.iceConnectionState === 'failed') {
|
||||||
|
// failed is a terminal state; let's explicitly kill the
|
||||||
|
// connection to the server at this point.
|
||||||
|
console.log('failed to negotiate ice connection; restarting')
|
||||||
|
this.close()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
this.websocket.addEventListener('open', (event) => {
|
||||||
if (this.shouldTrace()) {
|
if (this.shouldTrace()) {
|
||||||
websocketSpan.resolve?.()
|
websocketSpan.resolve?.()
|
||||||
|
|
||||||
handshakeSpan = spanStart('handshake')
|
handshakeSpan = new SpanPromise(
|
||||||
iceSpan = spanStart('ice')
|
webrtcMediaTransaction.startChild({ op: 'handshake' })
|
||||||
dataChannelSpan = spanStart('data-channel')
|
)
|
||||||
mediaTrackSpan = spanStart('media-track')
|
iceSpan = new SpanPromise(
|
||||||
|
webrtcMediaTransaction.startChild({ op: 'ice' })
|
||||||
|
)
|
||||||
|
dataChannelSpan = new SpanPromise(
|
||||||
|
webrtcMediaTransaction.startChild({
|
||||||
|
op: 'data-channel',
|
||||||
|
})
|
||||||
|
)
|
||||||
|
mediaTrackSpan = new SpanPromise(
|
||||||
|
webrtcMediaTransaction.startChild({
|
||||||
|
op: 'media-track',
|
||||||
|
})
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
if (this.shouldTrace()) {
|
if (this.shouldTrace()) {
|
||||||
void Promise.all([
|
Promise.all([
|
||||||
handshakeSpan.promise,
|
handshakeSpan.promise,
|
||||||
iceSpan.promise,
|
iceSpan.promise,
|
||||||
dataChannelSpan.promise,
|
dataChannelSpan.promise,
|
||||||
@ -554,30 +269,18 @@ class EngineConnection {
|
|||||||
webrtcMediaTransaction?.finish()
|
webrtcMediaTransaction?.finish()
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
this.onWebsocketOpen(this)
|
||||||
})
|
})
|
||||||
|
|
||||||
this.websocket.addEventListener('close', (event) => {
|
this.websocket.addEventListener('close', (event) => {
|
||||||
this.disconnectAll()
|
console.log('websocket connection closed', event)
|
||||||
this.websocket = undefined
|
this.close()
|
||||||
|
|
||||||
if (this.areAllConnectionsClosed()) {
|
|
||||||
this.state = {
|
|
||||||
type: EngineConnectionStateType.Disconnected,
|
|
||||||
value: { type: DisconnectedType.Quit },
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
})
|
||||||
|
|
||||||
this.websocket.addEventListener('error', (event) => {
|
this.websocket.addEventListener('error', (event) => {
|
||||||
this.disconnectAll()
|
console.log('websocket connection error', event)
|
||||||
|
this.close()
|
||||||
this.state = {
|
|
||||||
type: EngineConnectionStateType.Disconnected,
|
|
||||||
value: {
|
|
||||||
type: DisconnectedType.Error,
|
|
||||||
value: new Error(event.toString()),
|
|
||||||
},
|
|
||||||
}
|
|
||||||
})
|
})
|
||||||
|
|
||||||
this.websocket.addEventListener('message', (event) => {
|
this.websocket.addEventListener('message', (event) => {
|
||||||
@ -611,137 +314,28 @@ class EngineConnection {
|
|||||||
}
|
}
|
||||||
|
|
||||||
let resp = message.resp
|
let resp = message.resp
|
||||||
|
if (!resp) {
|
||||||
// If there's no body to the response, we can bail here.
|
// If there's no body to the response, we can bail here.
|
||||||
// !resp.type is usually "pong" response for our "ping"
|
|
||||||
if (!resp || !resp.type) {
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
console.log('received', resp)
|
if (resp.type === 'sdp_answer') {
|
||||||
|
let answer = resp.data?.answer
|
||||||
|
if (!answer || answer.type === 'unspecified') {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
switch (resp.type) {
|
if (this.pc?.signalingState !== 'stable') {
|
||||||
case 'ice_server_info':
|
// If the connection is stable, we shouldn't bother updating the
|
||||||
let ice_servers = resp.data?.ice_servers
|
// SDP, since we have a stable connection to the backend. If we
|
||||||
|
// need to renegotiate, the whole PeerConnection needs to get
|
||||||
// Now that we have some ICE servers it makes sense
|
// tore down.
|
||||||
// to start initializing the RTCPeerConnection. RTCPeerConnection
|
this.pc?.setRemoteDescription(
|
||||||
// will begin the ICE process.
|
new RTCSessionDescription({
|
||||||
createPeerConnection()
|
type: answer.type,
|
||||||
|
sdp: answer.sdp,
|
||||||
this.state = {
|
|
||||||
type: EngineConnectionStateType.Connecting,
|
|
||||||
value: {
|
|
||||||
type: ConnectingType.PeerConnectionCreated,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
// No ICE servers can be valid in a local dev. env.
|
|
||||||
if (ice_servers?.length === 0) {
|
|
||||||
console.warn('No ICE servers')
|
|
||||||
this.pc?.setConfiguration({})
|
|
||||||
} else {
|
|
||||||
// When we set the Configuration, we want to always force
|
|
||||||
// iceTransportPolicy to 'relay', since we know the topology
|
|
||||||
// of the ICE/STUN/TUN server and the engine. We don't wish to
|
|
||||||
// talk to the engine in any configuration /other/ than relay
|
|
||||||
// from a infra POV.
|
|
||||||
this.pc?.setConfiguration({
|
|
||||||
iceServers: ice_servers,
|
|
||||||
iceTransportPolicy: 'relay',
|
|
||||||
})
|
})
|
||||||
}
|
)
|
||||||
|
|
||||||
this.state = {
|
|
||||||
type: EngineConnectionStateType.Connecting,
|
|
||||||
value: {
|
|
||||||
type: ConnectingType.ICEServersSet,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
// We have an ICE Servers set now. We just setConfiguration, so let's
|
|
||||||
// start adding things we care about to the PeerConnection and let
|
|
||||||
// ICE negotiation happen in the background. Everything from here
|
|
||||||
// until the end of this function is setup of our end of the
|
|
||||||
// PeerConnection and waiting for events to fire our callbacks.
|
|
||||||
|
|
||||||
// Add a transceiver to our SDP offer
|
|
||||||
this.pc?.addTransceiver('video', {
|
|
||||||
direction: 'recvonly',
|
|
||||||
})
|
|
||||||
|
|
||||||
// Create a session description offer based on our local environment
|
|
||||||
// that we will send to the remote end. The remote will send back
|
|
||||||
// what it supports via sdp_answer.
|
|
||||||
this.pc
|
|
||||||
?.createOffer()
|
|
||||||
.then((offer: RTCSessionDescriptionInit) => {
|
|
||||||
console.log(offer)
|
|
||||||
this.state = {
|
|
||||||
type: EngineConnectionStateType.Connecting,
|
|
||||||
value: {
|
|
||||||
type: ConnectingType.SetLocalDescription,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
return this.pc?.setLocalDescription(offer).then(() => {
|
|
||||||
this.send({
|
|
||||||
type: 'sdp_offer',
|
|
||||||
offer,
|
|
||||||
})
|
|
||||||
this.state = {
|
|
||||||
type: EngineConnectionStateType.Connecting,
|
|
||||||
value: {
|
|
||||||
type: ConnectingType.OfferedSdp,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
})
|
|
||||||
})
|
|
||||||
.catch((error: Error) => {
|
|
||||||
console.error(error)
|
|
||||||
// The local description is invalid, so there's no point continuing.
|
|
||||||
this.disconnectAll()
|
|
||||||
this.state = {
|
|
||||||
type: EngineConnectionStateType.Disconnected,
|
|
||||||
value: {
|
|
||||||
type: DisconnectedType.Error,
|
|
||||||
value: error,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
})
|
|
||||||
break
|
|
||||||
|
|
||||||
case 'sdp_answer':
|
|
||||||
let answer = resp.data?.answer
|
|
||||||
if (!answer || answer.type === 'unspecified') {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
this.state = {
|
|
||||||
type: EngineConnectionStateType.Connecting,
|
|
||||||
value: {
|
|
||||||
type: ConnectingType.ReceivedSdp,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
// As soon as this is set, RTCPeerConnection tries to
|
|
||||||
// establish a connection.
|
|
||||||
// @ts-ignore
|
|
||||||
// Have to ignore because dom.ts doesn't have the right type
|
|
||||||
void this.pc?.setRemoteDescription(answer)
|
|
||||||
|
|
||||||
this.state = {
|
|
||||||
type: EngineConnectionStateType.Connecting,
|
|
||||||
value: {
|
|
||||||
type: ConnectingType.SetRemoteDescription,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
this.state = {
|
|
||||||
type: EngineConnectionStateType.Connecting,
|
|
||||||
value: {
|
|
||||||
type: ConnectingType.WebRTCConnecting,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
if (this.shouldTrace()) {
|
if (this.shouldTrace()) {
|
||||||
// When both ends have a local and remote SDP, we've been able to
|
// When both ends have a local and remote SDP, we've been able to
|
||||||
@ -749,46 +343,194 @@ class EngineConnection {
|
|||||||
// servers, but this is hand-shook.
|
// servers, but this is hand-shook.
|
||||||
handshakeSpan.resolve?.()
|
handshakeSpan.resolve?.()
|
||||||
}
|
}
|
||||||
break
|
}
|
||||||
|
} else if (resp.type === 'trickle_ice') {
|
||||||
|
let candidate = resp.data?.candidate
|
||||||
|
this.pc?.addIceCandidate(candidate as RTCIceCandidateInit)
|
||||||
|
} else if (resp.type === 'ice_server_info' && this.pc) {
|
||||||
|
console.log('received ice_server_info')
|
||||||
|
let ice_servers = resp.data?.ice_servers
|
||||||
|
|
||||||
case 'trickle_ice':
|
if (ice_servers?.length > 0) {
|
||||||
let candidate = resp.data?.candidate
|
// When we set the Configuration, we want to always force
|
||||||
console.log('trickle_ice: using this candidate: ', candidate)
|
// iceTransportPolicy to 'relay', since we know the topology
|
||||||
void this.pc?.addIceCandidate(candidate as RTCIceCandidateInit)
|
// of the ICE/STUN/TUN server and the engine. We don't wish to
|
||||||
break
|
// talk to the engine in any configuration /other/ than relay
|
||||||
|
// from a infra POV.
|
||||||
|
this.pc.setConfiguration({
|
||||||
|
iceServers: ice_servers,
|
||||||
|
iceTransportPolicy: 'relay',
|
||||||
|
})
|
||||||
|
} else {
|
||||||
|
this.pc?.setConfiguration({})
|
||||||
|
}
|
||||||
|
|
||||||
case 'metrics_request':
|
// We have an ICE Servers set now. We just setConfiguration, so let's
|
||||||
if (this.webrtcStatsCollector === undefined) {
|
// start adding things we care about to the PeerConnection and let
|
||||||
// TODO: Error message here?
|
// ICE negotiation happen in the background. Everything from here
|
||||||
return
|
// until the end of this function is setup of our end of the
|
||||||
}
|
// PeerConnection and waiting for events to fire our callbacks.
|
||||||
void this.webrtcStatsCollector().then((client_metrics) => {
|
|
||||||
|
this.pc.addEventListener('icecandidate', (event) => {
|
||||||
|
if (!this.pc || !this.websocket) return
|
||||||
|
if (event.candidate !== null) {
|
||||||
|
console.log('sending trickle ice candidate')
|
||||||
|
const { candidate } = event
|
||||||
this.send({
|
this.send({
|
||||||
type: 'metrics_response',
|
type: 'trickle_ice',
|
||||||
metrics: client_metrics,
|
candidate: candidate.toJSON(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
// Offer to receive 1 video track
|
||||||
|
this.pc.addTransceiver('video', {})
|
||||||
|
|
||||||
|
// Finally (but actually firstly!), to kick things off, we're going to
|
||||||
|
// generate our SDP, set it on our PeerConnection, and let the server
|
||||||
|
// know about our capabilities.
|
||||||
|
this.pc
|
||||||
|
.createOffer()
|
||||||
|
.then(async (descriptionInit) => {
|
||||||
|
await this?.pc?.setLocalDescription(descriptionInit)
|
||||||
|
console.log('sent sdp_offer begin')
|
||||||
|
this.send({
|
||||||
|
type: 'sdp_offer',
|
||||||
|
offer: this.pc?.localDescription,
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
break
|
.catch(console.log)
|
||||||
|
} else if (resp.type === 'metrics_request') {
|
||||||
|
if (this.webrtcStatsCollector === undefined) {
|
||||||
|
// TODO: Error message here?
|
||||||
|
return
|
||||||
|
}
|
||||||
|
this.webrtcStatsCollector().then((client_metrics) => {
|
||||||
|
this.send({
|
||||||
|
type: 'metrics_response',
|
||||||
|
metrics: client_metrics,
|
||||||
|
})
|
||||||
|
})
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
|
this.pc.addEventListener('track', (event) => {
|
||||||
|
const mediaStream = event.streams[0]
|
||||||
|
|
||||||
|
if (this.shouldTrace()) {
|
||||||
|
let mediaStreamTrack = mediaStream.getVideoTracks()[0]
|
||||||
|
mediaStreamTrack.addEventListener('unmute', () => {
|
||||||
|
// let settings = mediaStreamTrack.getSettings()
|
||||||
|
// mediaTrackSpan.span.setTag("fps", settings.frameRate)
|
||||||
|
// mediaTrackSpan.span.setTag("width", settings.width)
|
||||||
|
// mediaTrackSpan.span.setTag("height", settings.height)
|
||||||
|
mediaTrackSpan.resolve?.()
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
this.webrtcStatsCollector = (): Promise<ClientMetrics> => {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
if (mediaStream.getVideoTracks().length !== 1) {
|
||||||
|
reject(new Error('too many video tracks to report'))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
let videoTrack = mediaStream.getVideoTracks()[0]
|
||||||
|
this.pc?.getStats(videoTrack).then((videoTrackStats) => {
|
||||||
|
let client_metrics: ClientMetrics = {
|
||||||
|
rtc_frames_decoded: 0,
|
||||||
|
rtc_frames_dropped: 0,
|
||||||
|
rtc_frames_received: 0,
|
||||||
|
rtc_frames_per_second: 0,
|
||||||
|
rtc_freeze_count: 0,
|
||||||
|
rtc_jitter_sec: 0.0,
|
||||||
|
rtc_keyframes_decoded: 0,
|
||||||
|
rtc_total_freezes_duration_sec: 0.0,
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO(paultag): Since we can technically have multiple WebRTC
|
||||||
|
// video tracks (even if the Server doesn't at the moment), we
|
||||||
|
// ought to send stats for every video track(?), and add the stream
|
||||||
|
// ID into it. This raises the cardinality of collected metrics
|
||||||
|
// when/if we do, but for now, just report the one stream.
|
||||||
|
|
||||||
|
videoTrackStats.forEach((videoTrackReport) => {
|
||||||
|
if (videoTrackReport.type === 'inbound-rtp') {
|
||||||
|
client_metrics.rtc_frames_decoded =
|
||||||
|
videoTrackReport.framesDecoded || 0
|
||||||
|
client_metrics.rtc_frames_dropped =
|
||||||
|
videoTrackReport.framesDropped || 0
|
||||||
|
client_metrics.rtc_frames_received =
|
||||||
|
videoTrackReport.framesReceived || 0
|
||||||
|
client_metrics.rtc_frames_per_second =
|
||||||
|
videoTrackReport.framesPerSecond || 0
|
||||||
|
client_metrics.rtc_freeze_count =
|
||||||
|
videoTrackReport.freezeCount || 0
|
||||||
|
client_metrics.rtc_jitter_sec = videoTrackReport.jitter || 0.0
|
||||||
|
client_metrics.rtc_keyframes_decoded =
|
||||||
|
videoTrackReport.keyFramesDecoded || 0
|
||||||
|
client_metrics.rtc_total_freezes_duration_sec =
|
||||||
|
videoTrackReport.totalFreezesDuration || 0
|
||||||
|
} else if (videoTrackReport.type === 'transport') {
|
||||||
|
// videoTrackReport.bytesReceived,
|
||||||
|
// videoTrackReport.bytesSent,
|
||||||
|
}
|
||||||
|
})
|
||||||
|
resolve(client_metrics)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
this.onNewTrack({
|
||||||
|
conn: this,
|
||||||
|
mediaStream: mediaStream,
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
this.pc.addEventListener('datachannel', (event) => {
|
||||||
|
this.unreliableDataChannel = event.channel
|
||||||
|
|
||||||
|
console.log('accepted unreliable data channel', event.channel.label)
|
||||||
|
this.unreliableDataChannel.addEventListener('open', (event) => {
|
||||||
|
console.log('unreliable data channel opened', event)
|
||||||
|
if (this.shouldTrace()) {
|
||||||
|
dataChannelSpan.resolve?.()
|
||||||
|
}
|
||||||
|
|
||||||
|
this.onDataChannelOpen(this)
|
||||||
|
|
||||||
|
this.ready = true
|
||||||
|
this.connecting = false
|
||||||
|
// Do this after we set the connection is ready to avoid errors when
|
||||||
|
// we try to send messages before the connection is ready.
|
||||||
|
this.onEngineConnectionOpen(this)
|
||||||
|
})
|
||||||
|
|
||||||
|
this.unreliableDataChannel.addEventListener('close', (event) => {
|
||||||
|
console.log('unreliable data channel closed')
|
||||||
|
this.close()
|
||||||
|
})
|
||||||
|
|
||||||
|
this.unreliableDataChannel.addEventListener('error', (event) => {
|
||||||
|
console.log('unreliable data channel error')
|
||||||
|
this.close()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
const connectionTimeoutMs = VITE_KC_CONNECTION_TIMEOUT_MS
|
const connectionTimeoutMs = VITE_KC_CONNECTION_TIMEOUT_MS
|
||||||
|
|
||||||
if (this.failedConnTimeout) {
|
if (this.failedConnTimeout) {
|
||||||
|
console.log('clearing timeout before set')
|
||||||
clearTimeout(this.failedConnTimeout)
|
clearTimeout(this.failedConnTimeout)
|
||||||
this.failedConnTimeout = null
|
this.failedConnTimeout = null
|
||||||
}
|
}
|
||||||
|
console.log('timeout set')
|
||||||
this.failedConnTimeout = setTimeout(() => {
|
this.failedConnTimeout = setTimeout(() => {
|
||||||
if (this.isReady()) {
|
if (this.isReady()) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
this.failedConnTimeout = null
|
console.log('engine connection timeout on connection, closing')
|
||||||
this.disconnectAll()
|
this.close()
|
||||||
this.state = {
|
|
||||||
type: EngineConnectionStateType.Disconnected,
|
|
||||||
value: {
|
|
||||||
type: DisconnectedType.Timeout,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}, connectionTimeoutMs)
|
}, connectionTimeoutMs)
|
||||||
|
|
||||||
this.onConnectionStarted(this)
|
this.onConnectionStarted(this)
|
||||||
@ -807,15 +549,23 @@ class EngineConnection {
|
|||||||
typeof message === 'string' ? message : JSON.stringify(message)
|
typeof message === 'string' ? message : JSON.stringify(message)
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
disconnectAll() {
|
close() {
|
||||||
this.websocket?.close()
|
this.websocket?.close()
|
||||||
this.unreliableDataChannel?.close()
|
|
||||||
this.pc?.close()
|
this.pc?.close()
|
||||||
|
this.unreliableDataChannel?.close()
|
||||||
|
this.websocket = undefined
|
||||||
|
this.pc = undefined
|
||||||
|
this.unreliableDataChannel = undefined
|
||||||
this.webrtcStatsCollector = undefined
|
this.webrtcStatsCollector = undefined
|
||||||
}
|
if (this.failedConnTimeout) {
|
||||||
areAllConnectionsClosed() {
|
console.log('closed timeout in close')
|
||||||
console.log(this.websocket, this.pc, this.unreliableDataChannel)
|
clearTimeout(this.failedConnTimeout)
|
||||||
return !this.websocket && !this.pc && !this.unreliableDataChannel
|
this.failedConnTimeout = null
|
||||||
|
}
|
||||||
|
|
||||||
|
this.onClose(this)
|
||||||
|
this.ready = false
|
||||||
|
this.connecting = false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -935,7 +685,7 @@ export class EngineCommandManager {
|
|||||||
// We also do this here because we want to ensure we create the gizmo
|
// We also do this here because we want to ensure we create the gizmo
|
||||||
// and execute the code everytime the stream is restarted.
|
// and execute the code everytime the stream is restarted.
|
||||||
const gizmoId = uuidv4()
|
const gizmoId = uuidv4()
|
||||||
void this.sendSceneCommand({
|
this.sendSceneCommand({
|
||||||
type: 'modeling_cmd_req',
|
type: 'modeling_cmd_req',
|
||||||
cmd_id: gizmoId,
|
cmd_id: gizmoId,
|
||||||
cmd: {
|
cmd: {
|
||||||
@ -948,7 +698,7 @@ export class EngineCommandManager {
|
|||||||
})
|
})
|
||||||
|
|
||||||
// Initialize the planes.
|
// Initialize the planes.
|
||||||
void this.initPlanes().then(() => {
|
this.initPlanes().then(() => {
|
||||||
// We execute the code here to make sure if the stream was to
|
// We execute the code here to make sure if the stream was to
|
||||||
// restart in a session, we want to make sure to execute the code.
|
// restart in a session, we want to make sure to execute the code.
|
||||||
// We force it to re-execute the code because we want to make sure
|
// We force it to re-execute the code because we want to make sure
|
||||||
@ -995,7 +745,7 @@ export class EngineCommandManager {
|
|||||||
// because in all other cases we send JSON strings. But in the case of
|
// because in all other cases we send JSON strings. But in the case of
|
||||||
// export we send a binary blob.
|
// export we send a binary blob.
|
||||||
// Pass this to our export function.
|
// Pass this to our export function.
|
||||||
void exportSave(event.data)
|
exportSave(event.data)
|
||||||
} else {
|
} else {
|
||||||
const message: Models['WebSocketResponse_type'] = JSON.parse(
|
const message: Models['WebSocketResponse_type'] = JSON.parse(
|
||||||
event.data
|
event.data
|
||||||
|
@ -29,7 +29,7 @@ export default function CodeEditor() {
|
|||||||
The left pane is where you write your code. It's a code editor with
|
The left pane is where you write your code. It's a code editor with
|
||||||
syntax highlighting and autocompletion. We've decided to take the
|
syntax highlighting and autocompletion. We've decided to take the
|
||||||
difficult route of writing our own language—called <code>kcl</code>
|
difficult route of writing our own language—called <code>kcl</code>
|
||||||
—for describing geometry, because we don't want to inherit all the
|
—for describing geometry, because don't want to inherit all the
|
||||||
other functionality from existing languages. We have a lot of ideas
|
other functionality from existing languages. We have a lot of ideas
|
||||||
about how <code>kcl</code> will evolve, and we want to hear your
|
about how <code>kcl</code> will evolve, and we want to hear your
|
||||||
thoughts on it.
|
thoughts on it.
|
||||||
|
1
src/wasm-lib/Cargo.lock
generated
1
src/wasm-lib/Cargo.lock
generated
@ -1864,7 +1864,6 @@ dependencies = [
|
|||||||
"dashmap",
|
"dashmap",
|
||||||
"databake",
|
"databake",
|
||||||
"derive-docs 0.1.5 (registry+https://github.com/rust-lang/crates.io-index)",
|
"derive-docs 0.1.5 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||||
"either",
|
|
||||||
"expectorate",
|
"expectorate",
|
||||||
"futures",
|
"futures",
|
||||||
"insta",
|
"insta",
|
||||||
|
@ -1,56 +0,0 @@
|
|||||||
use kcl_lib::ast::types::RequiredParamAfterOptionalParam;
|
|
||||||
use kittycad_execution_plan::ExecutionError;
|
|
||||||
|
|
||||||
use crate::String2;
|
|
||||||
|
|
||||||
#[derive(Debug, thiserror::Error, PartialEq, Clone)]
|
|
||||||
pub enum CompileError {
|
|
||||||
#[error("the name {name} was not defined")]
|
|
||||||
Undefined { name: String },
|
|
||||||
#[error("the function {fn_name} requires at least {required} arguments but you only supplied {actual}")]
|
|
||||||
NotEnoughArgs {
|
|
||||||
fn_name: String2,
|
|
||||||
required: usize,
|
|
||||||
actual: usize,
|
|
||||||
},
|
|
||||||
#[error("the function {fn_name} accepts at most {maximum} arguments but you supplied {actual}")]
|
|
||||||
TooManyArgs {
|
|
||||||
fn_name: String2,
|
|
||||||
maximum: usize,
|
|
||||||
actual: usize,
|
|
||||||
},
|
|
||||||
#[error("you tried to call {name} but it's not a function")]
|
|
||||||
NotCallable { name: String },
|
|
||||||
#[error("you're trying to use an operand that isn't compatible with the given arithmetic operator: {0}")]
|
|
||||||
InvalidOperand(&'static str),
|
|
||||||
#[error("you cannot use the value {0} as an index")]
|
|
||||||
InvalidIndex(String),
|
|
||||||
#[error("you tried to index into a value that isn't an array. Only arrays have numeric indices!")]
|
|
||||||
CannotIndex,
|
|
||||||
#[error("you tried to get the element {i} but that index is out of bounds. The array only has a length of {len}")]
|
|
||||||
IndexOutOfBounds { i: usize, len: usize },
|
|
||||||
#[error("you tried to access the property of a value that doesn't have any properties")]
|
|
||||||
NoProperties,
|
|
||||||
#[error("you tried to access a property of an array, but arrays don't have properties. They do have numeric indexes though, try using an index e.g. [0]")]
|
|
||||||
ArrayDoesNotHaveProperties,
|
|
||||||
#[error(
|
|
||||||
"you tried to read the '.{property}' of an object, but the object doesn't have any properties with that key"
|
|
||||||
)]
|
|
||||||
UndefinedProperty { property: String },
|
|
||||||
#[error("{0}")]
|
|
||||||
BadParamOrder(RequiredParamAfterOptionalParam),
|
|
||||||
#[error("A KCL function cannot have anything after its return value")]
|
|
||||||
MultipleReturns,
|
|
||||||
#[error("A KCL function must end with a return statement, but your function doesn't have one.")]
|
|
||||||
NoReturnStmt,
|
|
||||||
#[error("You used the %, which means \"substitute this argument for the value to the left in this |> pipeline\". But there is no such value, because you're not calling a pipeline.")]
|
|
||||||
NotInPipeline,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, thiserror::Error)]
|
|
||||||
pub enum Error {
|
|
||||||
#[error("{0}")]
|
|
||||||
Compile(#[from] CompileError),
|
|
||||||
#[error("{0}")]
|
|
||||||
Execution(#[from] ExecutionError),
|
|
||||||
}
|
|
@ -9,7 +9,6 @@ pub enum KclValueGroup {
|
|||||||
ObjectExpression(Box<ast::types::ObjectExpression>),
|
ObjectExpression(Box<ast::types::ObjectExpression>),
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug)]
|
|
||||||
pub enum SingleValue {
|
pub enum SingleValue {
|
||||||
Literal(Box<ast::types::Literal>),
|
Literal(Box<ast::types::Literal>),
|
||||||
Identifier(Box<ast::types::Identifier>),
|
Identifier(Box<ast::types::Identifier>),
|
||||||
@ -20,7 +19,6 @@ pub enum SingleValue {
|
|||||||
KclNoneExpression(ast::types::KclNone),
|
KclNoneExpression(ast::types::KclNone),
|
||||||
MemberExpression(Box<ast::types::MemberExpression>),
|
MemberExpression(Box<ast::types::MemberExpression>),
|
||||||
FunctionExpression(Box<ast::types::FunctionExpression>),
|
FunctionExpression(Box<ast::types::FunctionExpression>),
|
||||||
PipeSubstitution(Box<ast::types::PipeSubstitution>),
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl From<ast::types::BinaryPart> for KclValueGroup {
|
impl From<ast::types::BinaryPart> for KclValueGroup {
|
||||||
@ -63,7 +61,7 @@ impl From<ast::types::Value> for KclValueGroup {
|
|||||||
ast::types::Value::ObjectExpression(e) => Self::ObjectExpression(e),
|
ast::types::Value::ObjectExpression(e) => Self::ObjectExpression(e),
|
||||||
ast::types::Value::MemberExpression(e) => Self::Single(SingleValue::MemberExpression(e)),
|
ast::types::Value::MemberExpression(e) => Self::Single(SingleValue::MemberExpression(e)),
|
||||||
ast::types::Value::FunctionExpression(e) => Self::Single(SingleValue::FunctionExpression(e)),
|
ast::types::Value::FunctionExpression(e) => Self::Single(SingleValue::FunctionExpression(e)),
|
||||||
ast::types::Value::PipeSubstitution(e) => Self::Single(SingleValue::PipeSubstitution(e)),
|
ast::types::Value::PipeSubstitution(_) => todo!(),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -81,7 +79,6 @@ impl From<KclValueGroup> for ast::types::Value {
|
|||||||
SingleValue::KclNoneExpression(e) => ast::types::Value::None(e),
|
SingleValue::KclNoneExpression(e) => ast::types::Value::None(e),
|
||||||
SingleValue::MemberExpression(e) => ast::types::Value::MemberExpression(e),
|
SingleValue::MemberExpression(e) => ast::types::Value::MemberExpression(e),
|
||||||
SingleValue::FunctionExpression(e) => ast::types::Value::FunctionExpression(e),
|
SingleValue::FunctionExpression(e) => ast::types::Value::FunctionExpression(e),
|
||||||
SingleValue::PipeSubstitution(e) => ast::types::Value::PipeSubstitution(e),
|
|
||||||
},
|
},
|
||||||
KclValueGroup::ArrayExpression(e) => ast::types::Value::ArrayExpression(e),
|
KclValueGroup::ArrayExpression(e) => ast::types::Value::ArrayExpression(e),
|
||||||
KclValueGroup::ObjectExpression(e) => ast::types::Value::ObjectExpression(e),
|
KclValueGroup::ObjectExpression(e) => ast::types::Value::ObjectExpression(e),
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
mod binding_scope;
|
mod binding_scope;
|
||||||
mod error;
|
|
||||||
mod kcl_value_group;
|
mod kcl_value_group;
|
||||||
mod native_functions;
|
mod native_functions;
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
@ -9,16 +8,15 @@ use std::collections::HashMap;
|
|||||||
|
|
||||||
use kcl_lib::{
|
use kcl_lib::{
|
||||||
ast,
|
ast,
|
||||||
ast::types::{BodyItem, FunctionExpressionParts, KclNone, LiteralValue, Program},
|
ast::types::{BodyItem, FunctionExpressionParts, KclNone, LiteralValue, Program, RequiredParamAfterOptionalParam},
|
||||||
};
|
};
|
||||||
use kittycad_execution_plan as ep;
|
use kittycad_execution_plan as ep;
|
||||||
use kittycad_execution_plan::{Address, Instruction};
|
use kittycad_execution_plan::{Address, ExecutionError, Instruction};
|
||||||
use kittycad_execution_plan_traits as ept;
|
use kittycad_execution_plan_traits as ept;
|
||||||
use kittycad_execution_plan_traits::NumericPrimitive;
|
use kittycad_execution_plan_traits::NumericPrimitive;
|
||||||
use kittycad_modeling_session::Session;
|
use kittycad_modeling_session::Session;
|
||||||
|
|
||||||
use self::binding_scope::{BindingScope, EpBinding, GetFnResult};
|
use self::binding_scope::{BindingScope, EpBinding, GetFnResult};
|
||||||
use self::error::{CompileError, Error};
|
|
||||||
use self::kcl_value_group::{KclValueGroup, SingleValue};
|
use self::kcl_value_group::{KclValueGroup, SingleValue};
|
||||||
|
|
||||||
/// Execute a KCL program by compiling into an execution plan, then running that.
|
/// Execute a KCL program by compiling into an execution plan, then running that.
|
||||||
@ -56,17 +54,16 @@ impl Planner {
|
|||||||
if retval.is_some() {
|
if retval.is_some() {
|
||||||
return Err(CompileError::MultipleReturns);
|
return Err(CompileError::MultipleReturns);
|
||||||
}
|
}
|
||||||
let mut ctx = Context::default();
|
|
||||||
let instructions_for_this_node = match item {
|
let instructions_for_this_node = match item {
|
||||||
BodyItem::ExpressionStatement(node) => match KclValueGroup::from(node.expression) {
|
BodyItem::ExpressionStatement(node) => match KclValueGroup::from(node.expression) {
|
||||||
KclValueGroup::Single(value) => self.plan_to_compute_single(&mut ctx, value)?.instructions,
|
KclValueGroup::Single(value) => self.plan_to_compute_single(value)?.instructions,
|
||||||
KclValueGroup::ArrayExpression(_) => todo!(),
|
KclValueGroup::ArrayExpression(_) => todo!(),
|
||||||
KclValueGroup::ObjectExpression(_) => todo!(),
|
KclValueGroup::ObjectExpression(_) => todo!(),
|
||||||
},
|
},
|
||||||
BodyItem::VariableDeclaration(node) => self.plan_to_bind(node)?,
|
BodyItem::VariableDeclaration(node) => self.plan_to_bind(node)?,
|
||||||
BodyItem::ReturnStatement(node) => match KclValueGroup::from(node.argument) {
|
BodyItem::ReturnStatement(node) => match KclValueGroup::from(node.argument) {
|
||||||
KclValueGroup::Single(value) => {
|
KclValueGroup::Single(value) => {
|
||||||
let EvalPlan { instructions, binding } = self.plan_to_compute_single(&mut ctx, value)?;
|
let EvalPlan { instructions, binding } = self.plan_to_compute_single(value)?;
|
||||||
retval = Some(binding);
|
retval = Some(binding);
|
||||||
instructions
|
instructions
|
||||||
}
|
}
|
||||||
@ -81,7 +78,7 @@ impl Planner {
|
|||||||
|
|
||||||
/// Emits instructions which, when run, compute a given KCL value and store it in memory.
|
/// Emits instructions which, when run, compute a given KCL value and store it in memory.
|
||||||
/// Returns the instructions, and the destination address of the value.
|
/// Returns the instructions, and the destination address of the value.
|
||||||
fn plan_to_compute_single(&mut self, ctx: &mut Context, value: SingleValue) -> Result<EvalPlan, CompileError> {
|
fn plan_to_compute_single(&mut self, value: SingleValue) -> Result<EvalPlan, CompileError> {
|
||||||
match value {
|
match value {
|
||||||
SingleValue::KclNoneExpression(KclNone { start: _, end: _ }) => {
|
SingleValue::KclNoneExpression(KclNone { start: _, end: _ }) => {
|
||||||
let address = self.next_addr.offset_by(1);
|
let address = self.next_addr.offset_by(1);
|
||||||
@ -124,27 +121,7 @@ impl Planner {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
SingleValue::Identifier(expr) => {
|
SingleValue::Identifier(expr) => {
|
||||||
// The KCL parser interprets bools as identifiers.
|
// This is just duplicating a binding.
|
||||||
// Consider changing them to be KCL literals instead.
|
|
||||||
let b = if expr.name == "true" {
|
|
||||||
Some(true)
|
|
||||||
} else if expr.name == "false" {
|
|
||||||
Some(false)
|
|
||||||
} else {
|
|
||||||
None
|
|
||||||
};
|
|
||||||
if let Some(b) = b {
|
|
||||||
let address = self.next_addr.offset_by(1);
|
|
||||||
return Ok(EvalPlan {
|
|
||||||
instructions: vec![Instruction::SetPrimitive {
|
|
||||||
address,
|
|
||||||
value: ept::Primitive::Bool(b),
|
|
||||||
}],
|
|
||||||
binding: EpBinding::Single(address),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// This identifier is just duplicating a binding.
|
|
||||||
// So, don't emit any instructions, because the value has already been computed.
|
// So, don't emit any instructions, because the value has already been computed.
|
||||||
// Just return the address that it was stored at after being computed.
|
// Just return the address that it was stored at after being computed.
|
||||||
let previously_bound_to = self
|
let previously_bound_to = self
|
||||||
@ -157,7 +134,7 @@ impl Planner {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
SingleValue::UnaryExpression(expr) => {
|
SingleValue::UnaryExpression(expr) => {
|
||||||
let operand = self.plan_to_compute_single(ctx, SingleValue::from(expr.argument))?;
|
let operand = self.plan_to_compute_single(SingleValue::from(expr.argument))?;
|
||||||
let EpBinding::Single(binding) = operand.binding else {
|
let EpBinding::Single(binding) = operand.binding else {
|
||||||
return Err(CompileError::InvalidOperand(
|
return Err(CompileError::InvalidOperand(
|
||||||
"you tried to use a composite value (e.g. array or object) as the operand to some math",
|
"you tried to use a composite value (e.g. array or object) as the operand to some math",
|
||||||
@ -181,8 +158,8 @@ impl Planner {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
SingleValue::BinaryExpression(expr) => {
|
SingleValue::BinaryExpression(expr) => {
|
||||||
let l = self.plan_to_compute_single(ctx, SingleValue::from(expr.left))?;
|
let l = self.plan_to_compute_single(SingleValue::from(expr.left))?;
|
||||||
let r = self.plan_to_compute_single(ctx, SingleValue::from(expr.right))?;
|
let r = self.plan_to_compute_single(SingleValue::from(expr.right))?;
|
||||||
let EpBinding::Single(l_binding) = l.binding else {
|
let EpBinding::Single(l_binding) = l.binding else {
|
||||||
return Err(CompileError::InvalidOperand(
|
return Err(CompileError::InvalidOperand(
|
||||||
"you tried to use a composite value (e.g. array or object) as the operand to some math",
|
"you tried to use a composite value (e.g. array or object) as the operand to some math",
|
||||||
@ -230,7 +207,7 @@ impl Planner {
|
|||||||
instructions: new_instructions,
|
instructions: new_instructions,
|
||||||
binding: arg,
|
binding: arg,
|
||||||
} = match KclValueGroup::from(argument) {
|
} = match KclValueGroup::from(argument) {
|
||||||
KclValueGroup::Single(value) => self.plan_to_compute_single(ctx, value)?,
|
KclValueGroup::Single(value) => self.plan_to_compute_single(value)?,
|
||||||
KclValueGroup::ArrayExpression(_) => todo!(),
|
KclValueGroup::ArrayExpression(_) => todo!(),
|
||||||
KclValueGroup::ObjectExpression(_) => todo!(),
|
KclValueGroup::ObjectExpression(_) => todo!(),
|
||||||
};
|
};
|
||||||
@ -346,56 +323,7 @@ impl Planner {
|
|||||||
binding: binding.clone(),
|
binding: binding.clone(),
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
SingleValue::PipeSubstitution(_expr) => {
|
SingleValue::PipeExpression(_) => todo!(),
|
||||||
if let Some(ref binding) = ctx.pipe_substitution {
|
|
||||||
Ok(EvalPlan {
|
|
||||||
instructions: Vec::new(),
|
|
||||||
binding: binding.clone(),
|
|
||||||
})
|
|
||||||
} else {
|
|
||||||
Err(CompileError::NotInPipeline)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
SingleValue::PipeExpression(expr) => {
|
|
||||||
let mut bodies = expr.body.into_iter();
|
|
||||||
|
|
||||||
// Get the first expression (i.e. body) of the pipeline.
|
|
||||||
let first = bodies.next().expect("Pipe expression must have > 1 item");
|
|
||||||
let EvalPlan {
|
|
||||||
mut instructions,
|
|
||||||
binding: mut current_value,
|
|
||||||
} = match KclValueGroup::from(first) {
|
|
||||||
KclValueGroup::Single(v) => self.plan_to_compute_single(ctx, v)?,
|
|
||||||
KclValueGroup::ArrayExpression(_) => todo!(),
|
|
||||||
KclValueGroup::ObjectExpression(_) => todo!(),
|
|
||||||
};
|
|
||||||
|
|
||||||
// Handle the remaining bodies.
|
|
||||||
for body in bodies {
|
|
||||||
let value = match KclValueGroup::from(body) {
|
|
||||||
KclValueGroup::Single(v) => v,
|
|
||||||
KclValueGroup::ArrayExpression(_) => todo!(),
|
|
||||||
KclValueGroup::ObjectExpression(_) => todo!(),
|
|
||||||
};
|
|
||||||
// This body will probably contain a % (pipe substitution character).
|
|
||||||
// So it needs to know what the previous pipeline body's value is,
|
|
||||||
// to replace the % with that value.
|
|
||||||
ctx.pipe_substitution = Some(current_value.clone());
|
|
||||||
let EvalPlan {
|
|
||||||
instructions: instructions_for_this_body,
|
|
||||||
binding,
|
|
||||||
} = self.plan_to_compute_single(ctx, value)?;
|
|
||||||
instructions.extend(instructions_for_this_body);
|
|
||||||
current_value = binding;
|
|
||||||
}
|
|
||||||
// Before we return, clear the pipe substitution, because nothing outside this
|
|
||||||
// pipeline should be able to use it anymore.
|
|
||||||
ctx.pipe_substitution = None;
|
|
||||||
Ok(EvalPlan {
|
|
||||||
instructions,
|
|
||||||
binding: current_value,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -406,12 +334,11 @@ impl Planner {
|
|||||||
&mut self,
|
&mut self,
|
||||||
declarations: ast::types::VariableDeclaration,
|
declarations: ast::types::VariableDeclaration,
|
||||||
) -> Result<Vec<Instruction>, CompileError> {
|
) -> Result<Vec<Instruction>, CompileError> {
|
||||||
let mut ctx = Context::default();
|
|
||||||
declarations
|
declarations
|
||||||
.declarations
|
.declarations
|
||||||
.into_iter()
|
.into_iter()
|
||||||
.try_fold(Vec::new(), |mut acc, declaration| {
|
.try_fold(Vec::new(), |mut acc, declaration| {
|
||||||
let (instrs, binding) = self.plan_to_bind_one(&mut ctx, declaration.init)?;
|
let (instrs, binding) = self.plan_to_bind_one(declaration.init)?;
|
||||||
self.binding_scope.bind(declaration.id.name, binding);
|
self.binding_scope.bind(declaration.id.name, binding);
|
||||||
acc.extend(instrs);
|
acc.extend(instrs);
|
||||||
Ok(acc)
|
Ok(acc)
|
||||||
@ -420,14 +347,13 @@ impl Planner {
|
|||||||
|
|
||||||
fn plan_to_bind_one(
|
fn plan_to_bind_one(
|
||||||
&mut self,
|
&mut self,
|
||||||
ctx: &mut Context,
|
|
||||||
value_being_bound: ast::types::Value,
|
value_being_bound: ast::types::Value,
|
||||||
) -> Result<(Vec<Instruction>, EpBinding), CompileError> {
|
) -> Result<(Vec<Instruction>, EpBinding), CompileError> {
|
||||||
match KclValueGroup::from(value_being_bound) {
|
match KclValueGroup::from(value_being_bound) {
|
||||||
KclValueGroup::Single(init_value) => {
|
KclValueGroup::Single(init_value) => {
|
||||||
// Simple! Just evaluate it, note where the final value will be stored in KCEP memory,
|
// Simple! Just evaluate it, note where the final value will be stored in KCEP memory,
|
||||||
// and bind it to the KCL identifier.
|
// and bind it to the KCL identifier.
|
||||||
let EvalPlan { instructions, binding } = self.plan_to_compute_single(ctx, init_value)?;
|
let EvalPlan { instructions, binding } = self.plan_to_compute_single(init_value)?;
|
||||||
Ok((instructions, binding))
|
Ok((instructions, binding))
|
||||||
}
|
}
|
||||||
KclValueGroup::ArrayExpression(expr) => {
|
KclValueGroup::ArrayExpression(expr) => {
|
||||||
@ -440,7 +366,7 @@ impl Planner {
|
|||||||
KclValueGroup::Single(value) => {
|
KclValueGroup::Single(value) => {
|
||||||
// If this element of the array is a single value, then binding it is
|
// If this element of the array is a single value, then binding it is
|
||||||
// straightforward -- you got a single binding, no need to change anything.
|
// straightforward -- you got a single binding, no need to change anything.
|
||||||
let EvalPlan { instructions, binding } = self.plan_to_compute_single(ctx, value)?;
|
let EvalPlan { instructions, binding } = self.plan_to_compute_single(value)?;
|
||||||
acc_instrs.extend(instructions);
|
acc_instrs.extend(instructions);
|
||||||
acc_bindings.push(binding);
|
acc_bindings.push(binding);
|
||||||
}
|
}
|
||||||
@ -453,7 +379,7 @@ impl Planner {
|
|||||||
.elements
|
.elements
|
||||||
.into_iter()
|
.into_iter()
|
||||||
.try_fold(Vec::new(), |mut seq, child_element| {
|
.try_fold(Vec::new(), |mut seq, child_element| {
|
||||||
let (instructions, binding) = self.plan_to_bind_one(ctx, child_element)?;
|
let (instructions, binding) = self.plan_to_bind_one(child_element)?;
|
||||||
acc_instrs.extend(instructions);
|
acc_instrs.extend(instructions);
|
||||||
seq.push(binding);
|
seq.push(binding);
|
||||||
Ok(seq)
|
Ok(seq)
|
||||||
@ -471,7 +397,7 @@ impl Planner {
|
|||||||
.properties
|
.properties
|
||||||
.into_iter()
|
.into_iter()
|
||||||
.try_fold(map, |mut map, property| {
|
.try_fold(map, |mut map, property| {
|
||||||
let (instructions, binding) = self.plan_to_bind_one(ctx, property.value)?;
|
let (instructions, binding) = self.plan_to_bind_one(property.value)?;
|
||||||
map.insert(property.key.name, binding);
|
map.insert(property.key.name, binding);
|
||||||
acc_instrs.extend(instructions);
|
acc_instrs.extend(instructions);
|
||||||
Ok(map)
|
Ok(map)
|
||||||
@ -493,7 +419,7 @@ impl Planner {
|
|||||||
|(mut acc_instrs, mut acc_bindings), (key, value)| {
|
|(mut acc_instrs, mut acc_bindings), (key, value)| {
|
||||||
match KclValueGroup::from(value) {
|
match KclValueGroup::from(value) {
|
||||||
KclValueGroup::Single(value) => {
|
KclValueGroup::Single(value) => {
|
||||||
let EvalPlan { instructions, binding } = self.plan_to_compute_single(ctx, value)?;
|
let EvalPlan { instructions, binding } = self.plan_to_compute_single(value)?;
|
||||||
acc_instrs.extend(instructions);
|
acc_instrs.extend(instructions);
|
||||||
acc_bindings.insert(key.name, binding);
|
acc_bindings.insert(key.name, binding);
|
||||||
}
|
}
|
||||||
@ -506,7 +432,7 @@ impl Planner {
|
|||||||
.elements
|
.elements
|
||||||
.into_iter()
|
.into_iter()
|
||||||
.try_fold(Vec::with_capacity(n), |mut seq, child_element| {
|
.try_fold(Vec::with_capacity(n), |mut seq, child_element| {
|
||||||
let (instructions, binding) = self.plan_to_bind_one(ctx, child_element)?;
|
let (instructions, binding) = self.plan_to_bind_one(child_element)?;
|
||||||
seq.push(binding);
|
seq.push(binding);
|
||||||
acc_instrs.extend(instructions);
|
acc_instrs.extend(instructions);
|
||||||
Ok(seq)
|
Ok(seq)
|
||||||
@ -524,7 +450,7 @@ impl Planner {
|
|||||||
.properties
|
.properties
|
||||||
.into_iter()
|
.into_iter()
|
||||||
.try_fold(HashMap::with_capacity(n), |mut map, property| {
|
.try_fold(HashMap::with_capacity(n), |mut map, property| {
|
||||||
let (instructions, binding) = self.plan_to_bind_one(ctx, property.value)?;
|
let (instructions, binding) = self.plan_to_bind_one(property.value)?;
|
||||||
map.insert(property.key.name, binding);
|
map.insert(property.key.name, binding);
|
||||||
acc_instrs.extend(instructions);
|
acc_instrs.extend(instructions);
|
||||||
Ok(map)
|
Ok(map)
|
||||||
@ -542,6 +468,56 @@ impl Planner {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, thiserror::Error, PartialEq, Clone)]
|
||||||
|
pub enum CompileError {
|
||||||
|
#[error("the name {name} was not defined")]
|
||||||
|
Undefined { name: String },
|
||||||
|
#[error("the function {fn_name} requires at least {required} arguments but you only supplied {actual}")]
|
||||||
|
NotEnoughArgs {
|
||||||
|
fn_name: String2,
|
||||||
|
required: usize,
|
||||||
|
actual: usize,
|
||||||
|
},
|
||||||
|
#[error("the function {fn_name} accepts at most {maximum} arguments but you supplied {actual}")]
|
||||||
|
TooManyArgs {
|
||||||
|
fn_name: String2,
|
||||||
|
maximum: usize,
|
||||||
|
actual: usize,
|
||||||
|
},
|
||||||
|
#[error("you tried to call {name} but it's not a function")]
|
||||||
|
NotCallable { name: String },
|
||||||
|
#[error("you're trying to use an operand that isn't compatible with the given arithmetic operator: {0}")]
|
||||||
|
InvalidOperand(&'static str),
|
||||||
|
#[error("you cannot use the value {0} as an index")]
|
||||||
|
InvalidIndex(String),
|
||||||
|
#[error("you tried to index into a value that isn't an array. Only arrays have numeric indices!")]
|
||||||
|
CannotIndex,
|
||||||
|
#[error("you tried to get the element {i} but that index is out of bounds. The array only has a length of {len}")]
|
||||||
|
IndexOutOfBounds { i: usize, len: usize },
|
||||||
|
#[error("you tried to access the property of a value that doesn't have any properties")]
|
||||||
|
NoProperties,
|
||||||
|
#[error("you tried to access a property of an array, but arrays don't have properties. They do have numeric indexes though, try using an index e.g. [0]")]
|
||||||
|
ArrayDoesNotHaveProperties,
|
||||||
|
#[error(
|
||||||
|
"you tried to read the '.{property}' of an object, but the object doesn't have any properties with that key"
|
||||||
|
)]
|
||||||
|
UndefinedProperty { property: String },
|
||||||
|
#[error("{0}")]
|
||||||
|
BadParamOrder(RequiredParamAfterOptionalParam),
|
||||||
|
#[error("A KCL function cannot have anything after its return value")]
|
||||||
|
MultipleReturns,
|
||||||
|
#[error("A KCL function must end with a return statement, but your function doesn't have one.")]
|
||||||
|
NoReturnStmt,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, thiserror::Error)]
|
||||||
|
pub enum Error {
|
||||||
|
#[error("{0}")]
|
||||||
|
Compile(#[from] CompileError),
|
||||||
|
#[error("{0}")]
|
||||||
|
Execution(#[from] ExecutionError),
|
||||||
|
}
|
||||||
|
|
||||||
/// Every KCL literal value is equivalent to an Execution Plan value, and therefore can be
|
/// Every KCL literal value is equivalent to an Execution Plan value, and therefore can be
|
||||||
/// bound to some KCL name and Execution Plan address.
|
/// bound to some KCL name and Execution Plan address.
|
||||||
fn kcl_literal_to_kcep_literal(expr: LiteralValue) -> ept::Primitive {
|
fn kcl_literal_to_kcep_literal(expr: LiteralValue) -> ept::Primitive {
|
||||||
@ -586,9 +562,3 @@ enum KclFunction {
|
|||||||
Add(native_functions::Add),
|
Add(native_functions::Add),
|
||||||
UserDefined(UserDefinedFunction),
|
UserDefined(UserDefinedFunction),
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Context used when compiling KCL.
|
|
||||||
#[derive(Default, Debug)]
|
|
||||||
struct Context {
|
|
||||||
pipe_substitution: Option<EpBinding>,
|
|
||||||
}
|
|
||||||
|
@ -128,23 +128,6 @@ fn name_not_found() {
|
|||||||
assert_eq!(err, CompileError::Undefined { name: "y".to_owned() });
|
assert_eq!(err, CompileError::Undefined { name: "y".to_owned() });
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn assign_bool() {
|
|
||||||
// Check that Grackle properly compiles KCL bools to EP bools.
|
|
||||||
for (str, val) in [("true", true), ("false", false)] {
|
|
||||||
let program = format!("let x = {str}");
|
|
||||||
let (plan, scope) = must_plan(&program);
|
|
||||||
assert_eq!(
|
|
||||||
plan,
|
|
||||||
vec![Instruction::SetPrimitive {
|
|
||||||
address: Address::ZERO,
|
|
||||||
value: val.into(),
|
|
||||||
}]
|
|
||||||
);
|
|
||||||
assert_eq!(scope.get("x"), Some(&EpBinding::Single(Address::ZERO)));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn aliases() {
|
fn aliases() {
|
||||||
let program = "
|
let program = "
|
||||||
@ -528,6 +511,7 @@ fn define_recursive_function() {
|
|||||||
let (plan, _scope) = must_plan(program);
|
let (plan, _scope) = must_plan(program);
|
||||||
assert_eq!(plan, Vec::new())
|
assert_eq!(plan, Vec::new())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn use_kcl_function_as_param() {
|
fn use_kcl_function_as_param() {
|
||||||
let program = "fn wrapper = (f) => {
|
let program = "fn wrapper = (f) => {
|
||||||
@ -555,6 +539,142 @@ fn use_kcl_function_as_param() {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn use_kcl_function_y_combinator() {
|
||||||
|
let program = "
|
||||||
|
// TRUE := λx.λy.x
|
||||||
|
fn _TRUE = (x) => {
|
||||||
|
return (y) => { return x }
|
||||||
|
}
|
||||||
|
|
||||||
|
// FALSE := λx.λy.y
|
||||||
|
fn _FALSE = (x) => {
|
||||||
|
return (y) => { return y }
|
||||||
|
}
|
||||||
|
|
||||||
|
// constant false (no matter what is applied, the falsey value is returned)
|
||||||
|
fn cFalse = (x) => {
|
||||||
|
return _FALSE
|
||||||
|
}
|
||||||
|
|
||||||
|
// ISZERO := λn.n (λx.FALSE) TRUE
|
||||||
|
fn is_zero = (n) => {
|
||||||
|
let fa = n(cFalse)
|
||||||
|
return fa(_TRUE)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IFTHENELSE := λp.λa.λb.p a b
|
||||||
|
fn ifthenelse = (p) => {
|
||||||
|
return (a) => {
|
||||||
|
return (b) => {
|
||||||
|
let fa = p(a)
|
||||||
|
return fa(b)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// SUCC := λn.λf.λx.f (n f x)
|
||||||
|
// Inserts another (f x) in the church numeral chain
|
||||||
|
fn succ = (n) => {
|
||||||
|
return (f) => {
|
||||||
|
return (x) => {
|
||||||
|
let fa = n(f)
|
||||||
|
let fb = fa(x)
|
||||||
|
return f(fb)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// PLUS := λm.λn.m SUCC n
|
||||||
|
fn plus = (m) => {
|
||||||
|
return (n) => {
|
||||||
|
let fa = m(succ)
|
||||||
|
return fa(n)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 0 := λf.λx.x
|
||||||
|
fn _0 = (f) => {
|
||||||
|
return (x) => { return x }
|
||||||
|
}
|
||||||
|
|
||||||
|
fn cZero = (x) => {
|
||||||
|
return _0
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1 := λf.λx.f x
|
||||||
|
fn _1 = (f) => {
|
||||||
|
return (x) => { return f(x) }
|
||||||
|
}
|
||||||
|
|
||||||
|
let _2 = succ(_1)
|
||||||
|
let _3 = succ(_2)
|
||||||
|
let _4 = succ(_3)
|
||||||
|
let _5 = succ(_4)
|
||||||
|
let _6 = succ(_5)
|
||||||
|
// ...
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// PRED := λn.n (λg.λk.ISZERO (g 1) k (PLUS (g k) 1)) (λv.0) 0
|
||||||
|
fn pred = (n) => {
|
||||||
|
fn f1 = (g) => {
|
||||||
|
return (k) => {
|
||||||
|
let fa = is_zero(g(_1))
|
||||||
|
let fb = fa(k)
|
||||||
|
let fc1 = plus(g(k))
|
||||||
|
let fc2 = fc1(_1)
|
||||||
|
let fc = fb(fc2)
|
||||||
|
return fc
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let f2 = n(f1)
|
||||||
|
let f3 = f2(cZero)
|
||||||
|
let f4 = f3(_0)
|
||||||
|
return f4
|
||||||
|
}
|
||||||
|
|
||||||
|
// MUL := λm.λn.m (PLUS n) 0
|
||||||
|
fn mul = (m) => {
|
||||||
|
return (n) => {
|
||||||
|
let fa = m(plus(n))
|
||||||
|
let fb = fa(_0)
|
||||||
|
return fb
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// G := λr. λn.(1, if n = 0; else n × (r (n−1)))
|
||||||
|
fn G = (r) => {
|
||||||
|
return (n) => {
|
||||||
|
let fa = ifthenelse(n)
|
||||||
|
let fb = fa(_1)
|
||||||
|
let fc1 = mul(n)
|
||||||
|
let fc2 = fc1(r(pred(n)))
|
||||||
|
let fc = fb(fc2)
|
||||||
|
return fc
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Y := λg.(λx.g (x x)) (λx.g (x x))
|
||||||
|
fn Y = (g) => {
|
||||||
|
fn f1 = (x) => { return g(x(x)) }
|
||||||
|
let f2 = g(f1)
|
||||||
|
let f3 = f2(f1)
|
||||||
|
return f3
|
||||||
|
}
|
||||||
|
|
||||||
|
fn fact = (n) => {
|
||||||
|
let fa = Y(G)
|
||||||
|
return fa(n)
|
||||||
|
}
|
||||||
|
|
||||||
|
// x should be _6
|
||||||
|
let x = fact(_3)
|
||||||
|
";
|
||||||
|
|
||||||
|
let (plan, scope) = must_plan(program);
|
||||||
|
// Somehow check the result is the same as _6 definition
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn use_kcl_functions_with_params() {
|
fn use_kcl_functions_with_params() {
|
||||||
for (i, program) in [
|
for (i, program) in [
|
||||||
@ -601,33 +721,6 @@ fn use_kcl_functions_with_params() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn pipe_substitution_outside_pipe_expression() {
|
|
||||||
let program = "let x = add(1, %)";
|
|
||||||
let err = should_not_compile(program);
|
|
||||||
assert!(matches!(err, CompileError::NotInPipeline));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn unsugar_pipe_expressions() {
|
|
||||||
// These two programs should be equivalent,
|
|
||||||
// because that's just the definition of the |> operator.
|
|
||||||
let program2 = "
|
|
||||||
fn double = (x) => { return x * 2 }
|
|
||||||
fn triple = (x) => { return x * 3 }
|
|
||||||
let x = 1 |> double(%) |> triple(%) // should be 6
|
|
||||||
";
|
|
||||||
let program1 = "
|
|
||||||
fn double = (x) => { return x * 2 }
|
|
||||||
fn triple = (x) => { return x * 3 }
|
|
||||||
let x = triple(double(1)) // should be 6
|
|
||||||
";
|
|
||||||
// So, check that they are.
|
|
||||||
let (plan1, _) = must_plan(program1);
|
|
||||||
let (plan2, _) = must_plan(program2);
|
|
||||||
assert_eq!(plan1, plan2);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn define_kcl_functions() {
|
fn define_kcl_functions() {
|
||||||
let (plan, scope) = must_plan("fn triple = (x) => { return x * 3 }");
|
let (plan, scope) = must_plan("fn triple = (x) => { return x * 3 }");
|
||||||
|
@ -32,7 +32,6 @@ thiserror = "1.0.50"
|
|||||||
ts-rs = { version = "7", features = ["uuid-impl"] }
|
ts-rs = { version = "7", features = ["uuid-impl"] }
|
||||||
uuid = { version = "1.6.1", features = ["v4", "js", "serde"] }
|
uuid = { version = "1.6.1", features = ["v4", "js", "serde"] }
|
||||||
winnow = "0.5.18"
|
winnow = "0.5.18"
|
||||||
either = "1.6.1"
|
|
||||||
|
|
||||||
[target.'cfg(target_arch = "wasm32")'.dependencies]
|
[target.'cfg(target_arch = "wasm32")'.dependencies]
|
||||||
js-sys = { version = "0.3.65" }
|
js-sys = { version = "0.3.65" }
|
||||||
|
@ -19,7 +19,6 @@ use crate::{
|
|||||||
parser::PIPE_OPERATOR,
|
parser::PIPE_OPERATOR,
|
||||||
std::{kcl_stdlib::KclStdLibFn, FunctionKind},
|
std::{kcl_stdlib::KclStdLibFn, FunctionKind},
|
||||||
};
|
};
|
||||||
use crate::executor::PathToNode;
|
|
||||||
|
|
||||||
mod literal_value;
|
mod literal_value;
|
||||||
mod none;
|
mod none;
|
||||||
@ -1434,7 +1433,6 @@ impl From<Literal> for MemoryItem {
|
|||||||
value: JValue::from(literal.value.clone()),
|
value: JValue::from(literal.value.clone()),
|
||||||
meta: vec![Metadata {
|
meta: vec![Metadata {
|
||||||
source_range: literal.into(),
|
source_range: literal.into(),
|
||||||
path_to_node: vec![],
|
|
||||||
}],
|
}],
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
@ -1446,7 +1444,6 @@ impl From<&Box<Literal>> for MemoryItem {
|
|||||||
value: JValue::from(literal.value.clone()),
|
value: JValue::from(literal.value.clone()),
|
||||||
meta: vec![Metadata {
|
meta: vec![Metadata {
|
||||||
source_range: literal.into(),
|
source_range: literal.into(),
|
||||||
path_to_node: vec![],
|
|
||||||
}],
|
}],
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
@ -1644,7 +1641,7 @@ impl ArrayExpression {
|
|||||||
Value::UnaryExpression(unary_expression) => unary_expression.get_result(memory, pipe_info, ctx).await?,
|
Value::UnaryExpression(unary_expression) => unary_expression.get_result(memory, pipe_info, ctx).await?,
|
||||||
Value::ObjectExpression(object_expression) => object_expression.execute(memory, pipe_info, ctx).await?,
|
Value::ObjectExpression(object_expression) => object_expression.execute(memory, pipe_info, ctx).await?,
|
||||||
Value::ArrayExpression(array_expression) => array_expression.execute(memory, pipe_info, ctx).await?,
|
Value::ArrayExpression(array_expression) => array_expression.execute(memory, pipe_info, ctx).await?,
|
||||||
Value::PipeExpression(pipe_expression) => pipe_expression.get_result(memory, pipe_info, ctx, vec![]).await?,
|
Value::PipeExpression(pipe_expression) => pipe_expression.get_result(memory, pipe_info, ctx).await?,
|
||||||
Value::PipeSubstitution(pipe_substitution) => {
|
Value::PipeSubstitution(pipe_substitution) => {
|
||||||
return Err(KclError::Semantic(KclErrorDetails {
|
return Err(KclError::Semantic(KclErrorDetails {
|
||||||
message: format!("PipeSubstitution not implemented here: {:?}", pipe_substitution),
|
message: format!("PipeSubstitution not implemented here: {:?}", pipe_substitution),
|
||||||
@ -1668,7 +1665,6 @@ impl ArrayExpression {
|
|||||||
value: results.into(),
|
value: results.into(),
|
||||||
meta: vec![Metadata {
|
meta: vec![Metadata {
|
||||||
source_range: self.into(),
|
source_range: self.into(),
|
||||||
path_to_node: vec![],
|
|
||||||
}],
|
}],
|
||||||
}))
|
}))
|
||||||
}
|
}
|
||||||
@ -1798,7 +1794,7 @@ impl ObjectExpression {
|
|||||||
Value::UnaryExpression(unary_expression) => unary_expression.get_result(memory, pipe_info, ctx).await?,
|
Value::UnaryExpression(unary_expression) => unary_expression.get_result(memory, pipe_info, ctx).await?,
|
||||||
Value::ObjectExpression(object_expression) => object_expression.execute(memory, pipe_info, ctx).await?,
|
Value::ObjectExpression(object_expression) => object_expression.execute(memory, pipe_info, ctx).await?,
|
||||||
Value::ArrayExpression(array_expression) => array_expression.execute(memory, pipe_info, ctx).await?,
|
Value::ArrayExpression(array_expression) => array_expression.execute(memory, pipe_info, ctx).await?,
|
||||||
Value::PipeExpression(pipe_expression) => pipe_expression.get_result(memory, pipe_info, ctx, vec![]).await?,
|
Value::PipeExpression(pipe_expression) => pipe_expression.get_result(memory, pipe_info, ctx).await?,
|
||||||
Value::PipeSubstitution(pipe_substitution) => {
|
Value::PipeSubstitution(pipe_substitution) => {
|
||||||
return Err(KclError::Semantic(KclErrorDetails {
|
return Err(KclError::Semantic(KclErrorDetails {
|
||||||
message: format!("PipeSubstitution not implemented here: {:?}", pipe_substitution),
|
message: format!("PipeSubstitution not implemented here: {:?}", pipe_substitution),
|
||||||
@ -1826,7 +1822,6 @@ impl ObjectExpression {
|
|||||||
value: object.into(),
|
value: object.into(),
|
||||||
meta: vec![Metadata {
|
meta: vec![Metadata {
|
||||||
source_range: self.into(),
|
source_range: self.into(),
|
||||||
path_to_node: vec![],
|
|
||||||
}],
|
}],
|
||||||
}))
|
}))
|
||||||
}
|
}
|
||||||
@ -2036,7 +2031,6 @@ impl MemberExpression {
|
|||||||
value: value.clone(),
|
value: value.clone(),
|
||||||
meta: vec![Metadata {
|
meta: vec![Metadata {
|
||||||
source_range: self.into(),
|
source_range: self.into(),
|
||||||
path_to_node: vec![],
|
|
||||||
}],
|
}],
|
||||||
}))
|
}))
|
||||||
} else {
|
} else {
|
||||||
@ -2093,7 +2087,6 @@ impl MemberExpression {
|
|||||||
value: value.clone(),
|
value: value.clone(),
|
||||||
meta: vec![Metadata {
|
meta: vec![Metadata {
|
||||||
source_range: self.into(),
|
source_range: self.into(),
|
||||||
path_to_node: vec![],
|
|
||||||
}],
|
}],
|
||||||
}))
|
}))
|
||||||
} else {
|
} else {
|
||||||
@ -2258,7 +2251,6 @@ impl BinaryExpression {
|
|||||||
value,
|
value,
|
||||||
meta: vec![Metadata {
|
meta: vec![Metadata {
|
||||||
source_range: self.into(),
|
source_range: self.into(),
|
||||||
path_to_node: vec![],
|
|
||||||
}],
|
}],
|
||||||
}));
|
}));
|
||||||
}
|
}
|
||||||
@ -2280,7 +2272,6 @@ impl BinaryExpression {
|
|||||||
value,
|
value,
|
||||||
meta: vec![Metadata {
|
meta: vec![Metadata {
|
||||||
source_range: self.into(),
|
source_range: self.into(),
|
||||||
path_to_node: vec![],
|
|
||||||
}],
|
}],
|
||||||
}))
|
}))
|
||||||
}
|
}
|
||||||
@ -2444,7 +2435,6 @@ impl UnaryExpression {
|
|||||||
value: (-(num)).into(),
|
value: (-(num)).into(),
|
||||||
meta: vec![Metadata {
|
meta: vec![Metadata {
|
||||||
source_range: self.into(),
|
source_range: self.into(),
|
||||||
path_to_node: vec![],
|
|
||||||
}],
|
}],
|
||||||
}))
|
}))
|
||||||
}
|
}
|
||||||
@ -2574,12 +2564,11 @@ impl PipeExpression {
|
|||||||
memory: &mut ProgramMemory,
|
memory: &mut ProgramMemory,
|
||||||
pipe_info: &mut PipeInfo,
|
pipe_info: &mut PipeInfo,
|
||||||
ctx: &ExecutorContext,
|
ctx: &ExecutorContext,
|
||||||
path_to_node: PathToNode,
|
|
||||||
) -> Result<MemoryItem, KclError> {
|
) -> Result<MemoryItem, KclError> {
|
||||||
// Reset the previous results.
|
// Reset the previous results.
|
||||||
pipe_info.previous_results = vec![];
|
pipe_info.previous_results = vec![];
|
||||||
pipe_info.index = 0;
|
pipe_info.index = 0;
|
||||||
execute_pipe_body(memory, &self.body, pipe_info, self.into(), ctx, path_to_node).await
|
execute_pipe_body(memory, &self.body, pipe_info, self.into(), ctx).await
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Rename all identifiers that have the old name to the new given name.
|
/// Rename all identifiers that have the old name to the new given name.
|
||||||
@ -2597,8 +2586,6 @@ async fn execute_pipe_body(
|
|||||||
pipe_info: &mut PipeInfo,
|
pipe_info: &mut PipeInfo,
|
||||||
source_range: SourceRange,
|
source_range: SourceRange,
|
||||||
ctx: &ExecutorContext,
|
ctx: &ExecutorContext,
|
||||||
path_to_node: PathToNode,
|
|
||||||
|
|
||||||
) -> Result<MemoryItem, KclError> {
|
) -> Result<MemoryItem, KclError> {
|
||||||
if pipe_info.index == body.len() {
|
if pipe_info.index == body.len() {
|
||||||
pipe_info.is_in_pipe = false;
|
pipe_info.is_in_pipe = false;
|
||||||
|
@ -11,7 +11,6 @@ use schemars::JsonSchema;
|
|||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
use serde_json::Value as JValue;
|
use serde_json::Value as JValue;
|
||||||
use tower_lsp::lsp_types::{Position as LspPosition, Range as LspRange};
|
use tower_lsp::lsp_types::{Position as LspPosition, Range as LspRange};
|
||||||
// use either::Either;
|
|
||||||
|
|
||||||
use crate::{
|
use crate::{
|
||||||
ast::types::{BodyItem, FunctionExpression, KclNone, Value},
|
ast::types::{BodyItem, FunctionExpression, KclNone, Value},
|
||||||
@ -633,18 +632,6 @@ impl From<Point3d> for kittycad::types::Point3D {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// number or string
|
|
||||||
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema)]
|
|
||||||
#[ts(export)]
|
|
||||||
pub enum NumberOrString {
|
|
||||||
Num(i32), // assuming 'number' is equivalent to a 32-bit integer
|
|
||||||
Str(String),
|
|
||||||
}
|
|
||||||
|
|
||||||
/// PathToNode
|
|
||||||
pub type PathToNode = Vec<(NumberOrString, String)>;
|
|
||||||
|
|
||||||
|
|
||||||
/// Metadata.
|
/// Metadata.
|
||||||
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema)]
|
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema)]
|
||||||
#[ts(export)]
|
#[ts(export)]
|
||||||
@ -652,16 +639,11 @@ pub type PathToNode = Vec<(NumberOrString, String)>;
|
|||||||
pub struct Metadata {
|
pub struct Metadata {
|
||||||
/// The source range.
|
/// The source range.
|
||||||
pub source_range: SourceRange,
|
pub source_range: SourceRange,
|
||||||
/// The path to node for this memory Item
|
|
||||||
pub path_to_node: PathToNode,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl From<SourceRange> for Metadata {
|
impl From<SourceRange> for Metadata {
|
||||||
fn from(source_range: SourceRange) -> Self {
|
fn from(source_range: SourceRange) -> Self {
|
||||||
Self {
|
Self { source_range }
|
||||||
source_range,
|
|
||||||
path_to_node: Vec::new()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -847,17 +829,12 @@ pub async fn execute(
|
|||||||
) -> Result<ProgramMemory, KclError> {
|
) -> Result<ProgramMemory, KclError> {
|
||||||
let mut pipe_info = PipeInfo::default();
|
let mut pipe_info = PipeInfo::default();
|
||||||
|
|
||||||
// let path_to_Node: PathToNode = vec![("body".to_string(), "".to_string())];
|
|
||||||
let path_to_node: PathToNode = vec![(NumberOrString::Str("body".to_string()), "".to_string())];
|
|
||||||
|
|
||||||
// Iterate over the body of the program.
|
// Iterate over the body of the program.
|
||||||
for (index, statement) in program.body.iter().enumerate() {
|
for statement in &program.body {
|
||||||
let mut with_body_path_to_node = path_to_node.clone();
|
|
||||||
with_body_path_to_node.push((NumberOrString::Num(index as i32), "index".to_string()));
|
|
||||||
match statement {
|
match statement {
|
||||||
BodyItem::ExpressionStatement(expression_statement) => {
|
BodyItem::ExpressionStatement(expression_statement) => {
|
||||||
if let Value::PipeExpression(pipe_expr) = &expression_statement.expression {
|
if let Value::PipeExpression(pipe_expr) = &expression_statement.expression {
|
||||||
pipe_expr.get_result(memory, &mut pipe_info, ctx, with_body_path_to_node).await?;
|
pipe_expr.get_result(memory, &mut pipe_info, ctx).await?;
|
||||||
} else if let Value::CallExpression(call_expr) = &expression_statement.expression {
|
} else if let Value::CallExpression(call_expr) = &expression_statement.expression {
|
||||||
let fn_name = call_expr.callee.name.to_string();
|
let fn_name = call_expr.callee.name.to_string();
|
||||||
let mut args: Vec<MemoryItem> = Vec::new();
|
let mut args: Vec<MemoryItem> = Vec::new();
|
||||||
@ -928,15 +905,10 @@ pub async fn execute(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
BodyItem::VariableDeclaration(variable_declaration) => {
|
BodyItem::VariableDeclaration(variable_declaration) => {
|
||||||
|
for declaration in &variable_declaration.declarations {
|
||||||
for (index, declaration) in variable_declaration.declarations.iter().enumerate() {
|
|
||||||
let var_name = declaration.id.name.to_string();
|
let var_name = declaration.id.name.to_string();
|
||||||
let source_range: SourceRange = declaration.init.clone().into();
|
let source_range: SourceRange = declaration.init.clone().into();
|
||||||
let mut with_dec_path_to_node = with_body_path_to_node.clone();
|
let metadata = Metadata { source_range };
|
||||||
with_dec_path_to_node.push((NumberOrString::Str("declarations".to_string()), "VariableDeclaration".to_string()));
|
|
||||||
with_dec_path_to_node.push((NumberOrString::Num(index as i32), "index".to_string()));
|
|
||||||
with_dec_path_to_node.push((NumberOrString::Str("init".to_string()), "".to_string()));
|
|
||||||
let metadata = Metadata { source_range, path_to_node: with_dec_path_to_node.clone() };
|
|
||||||
|
|
||||||
match &declaration.init {
|
match &declaration.init {
|
||||||
Value::None(none) => {
|
Value::None(none) => {
|
||||||
@ -991,7 +963,7 @@ pub async fn execute(
|
|||||||
memory.add(&var_name, result, source_range)?;
|
memory.add(&var_name, result, source_range)?;
|
||||||
}
|
}
|
||||||
Value::PipeExpression(pipe_expression) => {
|
Value::PipeExpression(pipe_expression) => {
|
||||||
let result = pipe_expression.get_result(memory, &mut pipe_info, ctx, with_dec_path_to_node).await?;
|
let result = pipe_expression.get_result(memory, &mut pipe_info, ctx).await?;
|
||||||
memory.add(&var_name, result, source_range)?;
|
memory.add(&var_name, result, source_range)?;
|
||||||
}
|
}
|
||||||
Value::PipeSubstitution(pipe_substitution) => {
|
Value::PipeSubstitution(pipe_substitution) => {
|
||||||
@ -1055,7 +1027,7 @@ pub async fn execute(
|
|||||||
memory.return_ = Some(ProgramReturn::Value(result));
|
memory.return_ = Some(ProgramReturn::Value(result));
|
||||||
}
|
}
|
||||||
Value::PipeExpression(pipe_expr) => {
|
Value::PipeExpression(pipe_expr) => {
|
||||||
let result = pipe_expr.get_result(memory, &mut pipe_info, ctx, with_body_path_to_node).await?;
|
let result = pipe_expr.get_result(memory, &mut pipe_info, ctx).await?;
|
||||||
memory.return_ = Some(ProgramReturn::Value(result));
|
memory.return_ = Some(ProgramReturn::Value(result));
|
||||||
}
|
}
|
||||||
Value::PipeSubstitution(_) => {}
|
Value::PipeSubstitution(_) => {}
|
||||||
|
@ -190,7 +190,6 @@ impl Args {
|
|||||||
value: j,
|
value: j,
|
||||||
meta: vec![Metadata {
|
meta: vec![Metadata {
|
||||||
source_range: self.source_range,
|
source_range: self.source_range,
|
||||||
path_to_node: Vec::new()
|
|
||||||
}],
|
}],
|
||||||
}))
|
}))
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user