/** * Copyright 2022 Gravwell, Inc. All rights reserved. * * Contact: [legal@gravwell.io](mailto:legal@gravwell.io) * * This software may be modified and distributed under the terms of the MIT * license. See the LICENSE file for details. */ import { Observable, timer } from 'rxjs'; import { filter, last, map, mapTo, startWith, takeUntil } from 'rxjs/operators'; import { Query, RawQuery } from '~/models/query'; import { ElementFilter, isOperationFilter } from '~/models/search/element-filter'; import { RawElementFilter, RawExtractionFilter, RawOperationFilter } from '~/models/search/raw-element-filter'; import { RawPongMessageSent } from '~/models/search/raw-search-message-sent'; import { toElementFilter } from '~/models/search/to-element-filter'; import { ValidatedQuery } from '~/models/search/validated-query'; import { APIContext } from '../utils/api-context'; import { APISubscription } from '../utils/api-subscription'; import { apiSubscriptionFromWebSocket } from '../utils/api-subscription-from-web-socket'; import { buildURL } from '../utils/build-url'; import { WebSocket } from '../utils/web-socket'; export const makeSubscribeToOneQueryParsing = ( context: APIContext, ): (() => Promise< APISubscription }> >) => { const templatePath = '/api/ws/search'; const url = buildURL(templatePath, { ...context, protocol: 'ws' }); return async (): Promise< APISubscription }> > => { const socket = new WebSocket(url, context.authToken ?? undefined); const rawSubscription = apiSubscriptionFromWebSocket< RawQueryValidationMessageReceived, RawQueryValidationMessageSent >(socket); rawSubscription.send({ Subs: ['PONG', 'parse', 'search', 'attach'] }); const wsClosed$: Observable = rawSubscription.sent$.pipe(startWith(undefined), mapTo(undefined), last()); timer(1000, 5000) .pipe(takeUntil(wsClosed$)) .subscribe({ next: () => { rawSubscription.send({ type: 'PONG', data: {} }); }, error: err => console.warn(err), }); const received$ = rawSubscription.received$.pipe( filter((msg): msg is RawQueryValidationDesiredMessageReceived => { try { return (msg as RawQueryValidationDesiredMessageReceived)?.type === 'parse'; } catch { return false; } }), map(msg => ({ ...toValidatedQuery(msg.data), id: msg.data.Sequence })), ); const sent$ = rawSubscription.sent$.pipe( filter((msg): msg is RawQueryValidationDesiredMessageSent => { try { return (msg as RawQueryValidationDesiredMessageSent)?.type === 'parse'; } catch { return false; } }), map(msg => ({ id: msg.data.Sequence, query: msg.data.SearchString, filters: (msg.data.Filters ?? []).map(toElementFilter), })), ); const received: Array = []; const sent: Array<{ id: number; query: Query; filters: Array }> = []; received$.subscribe({ next: receivedMessage => received.push(receivedMessage), error: err => console.warn(err) }); sent$.subscribe({ next: sentMessage => sent.push(sentMessage), error: err => console.warn(err) }); return { close: () => rawSubscription.close(), send: async msg => { const rawMsg: RawQueryValidationMessageSent = { type: 'parse', data: { SearchString: msg.query, Sequence: msg.id, }, }; if (msg.filters.length !== 0) { rawMsg.data.Filters = msg.filters.map(f => { if (isOperationFilter(f)) { const opFilter: RawOperationFilter = { Tag: f.tag ?? undefined, Module: f.module, Path: f.path, Args: f.arguments ?? undefined, Op: f.operation, Value: f.value, }; return opFilter; } const exFilter: RawExtractionFilter = { Tag: f.tag ?? undefined, Module: f.module, Path: f.path, Args: f.arguments ?? undefined, }; return exFilter; }); } await rawSubscription.send(rawMsg); }, received$, received, sent$, sent, }; }; }; type RawQueryValidationDesiredMessageSent = { type: 'parse'; data: { SearchString: string; Sequence: number; /** Include the Filters field during data exploration (data explorer) */ Filters?: Array; }; }; type RawQueryValidationMessageSent = | RawQueryValidationDesiredMessageSent | RawPongMessageSent | { Subs: Array<'PONG' | 'parse' | 'search' | 'attach'> }; type RawQueryValidationDesiredMessageReceived = { type: 'parse'; data: RawValidatedQuery }; type RawQueryValidationMessageReceived = RawQueryValidationDesiredMessageReceived | { Resp: 'ACK' }; interface RawValidatedQueryBase { CollapsingIndex: number; ModuleHints: Array<{ Name: string; Condensing: boolean; ProducedEVs: Array | null; ConsumedEVs: Array | null; ResourcesNeeded: Array | null; }> | null; ModuleIndex: number; ParsedQuery: RawQuery; Sequence: number; Tags: Array | null; TimeZoomDisabled: boolean; } interface RawApprovedValidatedQuery extends RawValidatedQueryBase { GoodQuery: true; RawQuery: RawQuery; RenderModule: string; } interface RawRepprovedValidatedQuery extends RawValidatedQueryBase { GoodQuery: false; ParseError: string; } type RawValidatedQuery = RawApprovedValidatedQuery | RawRepprovedValidatedQuery; const toValidatedQuery = (raw: RawValidatedQuery): ValidatedQuery => { switch (raw.GoodQuery) { case true: return { query: raw.ParsedQuery, isValid: true, error: null, }; case false: return { query: raw.ParsedQuery, isValid: false, error: { message: raw.ParseError ?? 'Unknown error', module: raw.ModuleIndex, }, }; } };