@dxos/echo-pipeline 0.8.2-staging.7ac8446 → 0.8.2

package/dist/types/src/db-host/query-state.d.ts

@@ -1,41 +0,0 @@
-import { Resource } from '@dxos/context';
-import { type Indexer } from '@dxos/indexing';
-import { type Filter as FilterProto } from '@dxos/protocols/proto/dxos/echo/filter';
-import { type QueryRequest, type QueryResult } from '@dxos/protocols/proto/dxos/echo/query';
-import { type AutomergeHost } from '../automerge';
-type QueryStateParams = {
-    indexer: Indexer;
-    automergeHost: AutomergeHost;
-    request: QueryRequest;
-};
-type QueryRunResult = {
-    changed: boolean;
-};
-export type QueryMetrics = {
-    objectsReturned: number;
-    objectsReturnedFromIndex: number;
-    documentsLoaded: number;
-    executionTime: number;
-    indexQueryTime: number;
-    documentLoadTime: number;
-};
-/**
- * Manages querying logic on service side.
- */
-export declare class QueryState extends Resource {
-    private readonly _params;
-    private _results;
-    /**
-     * Metrics are only captured for the first run of the query since that is the most representative.
-     * We plan to change the query logic so that reactive updates do not require a full re-run of the query.
-     */
-    private _firstRun;
-    readonly filter: FilterProto;
-    metrics: QueryMetrics;
-    get active(): boolean;
-    constructor(_params: QueryStateParams);
-    getResults(): QueryResult[];
-    execQuery(): Promise<QueryRunResult>;
-}
-export {};
-//# sourceMappingURL=query-state.d.ts.map

package/dist/types/src/db-host/query-state.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"query-state.d.ts","sourceRoot":"","sources":["../../../../src/db-host/query-state.ts"],"names":[],"mappings":"AAKA,OAAO,EAA2B,QAAQ,EAAE,MAAM,eAAe,CAAC;AAElE,OAAO,EAAE,KAAK,OAAO,EAAmB,MAAM,gBAAgB,CAAC;AAI/D,OAAO,EAAE,KAAK,MAAM,IAAI,WAAW,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,MAAM,uCAAuC,CAAC;AAI5F,OAAO,EAAE,KAAK,aAAa,EAAsB,MAAM,cAAc,CAAC;AAEtE,KAAK,gBAAgB,GAAG;IACtB,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,EAAE,aAAa,CAAC;IAC7B,OAAO,EAAE,YAAY,CAAC;CACvB,CAAC;AAEF,KAAK,cAAc,GAAG;IACpB,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,eAAe,EAAE,MAAM,CAAC;IACxB,wBAAwB,EAAE,MAAM,CAAC;IACjC,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,qBACa,UAAW,SAAQ,QAAQ;IA2B1B,OAAO,CAAC,QAAQ,CAAC,OAAO;IA1BpC,OAAO,CAAC,QAAQ,CAAqB;IAErC;;;OAGG;IACH,OAAO,CAAC,SAAS,CAAQ;IAEzB,SACgB,MAAM,EAAE,WAAW,CAAC;IAG7B,OAAO,EAAE,YAAY,CAO1B;IAEF,IACI,MAAM,YAET;gBAE4B,OAAO,EAAE,gBAAgB;IAKtD,UAAU;IAMJ,SAAS,IAAI,OAAO,CAAC,cAAc,CAAC;CAoG3C"}

package/src/db-host/query-state.ts

@@ -1,217 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { type DocumentId } from '@dxos/automerge/automerge-repo';
-import { Context, LifecycleState, Resource } from '@dxos/context';
-import { createIdFromSpaceKey, type SpaceDoc } from '@dxos/echo-protocol';
-import { type Indexer, type IndexQuery } from '@dxos/indexing';
-import { invariant } from '@dxos/invariant';
-import { DXN, PublicKey } from '@dxos/keys';
-import { objectPointerCodec } from '@dxos/protocols';
-import { type Filter as FilterProto } from '@dxos/protocols/proto/dxos/echo/filter';
-import { type QueryRequest, type QueryResult } from '@dxos/protocols/proto/dxos/echo/query';
-import { trace } from '@dxos/tracing';
-import { isNonNullable } from '@dxos/util';
-
-import { type AutomergeHost, getSpaceKeyFromDoc } from '../automerge';
-
-type QueryStateParams = {
-  indexer: Indexer;
-  automergeHost: AutomergeHost;
-  request: QueryRequest;
-};
-
-type QueryRunResult = {
-  changed: boolean;
-};
-
-export type QueryMetrics = {
-  objectsReturned: number;
-  objectsReturnedFromIndex: number;
-  documentsLoaded: number;
-  executionTime: number;
-  indexQueryTime: number;
-  documentLoadTime: number;
-};
-
-/**
- * Manages querying logic on service side.
- */
-@trace.resource()
-export class QueryState extends Resource {
-  private _results: QueryResult[] = [];
-
-  /**
-   * Metrics are only captured for the first run of the query since that is the most representative.
-   * We plan to change the query logic so that reactive updates do not require a full re-run of the query.
-   */
-  private _firstRun = true;
-
-  @trace.info({ depth: null })
-  public readonly filter: FilterProto;
-
-  @trace.info()
-  public metrics: QueryMetrics = {
-    objectsReturned: 0,
-    objectsReturnedFromIndex: 0,
-    documentsLoaded: 0,
-    executionTime: 0,
-    indexQueryTime: 0,
-    documentLoadTime: 0,
-  };
-
-  @trace.info()
-  get active() {
-    return this._lifecycleState === LifecycleState.OPEN;
-  }
-
-  constructor(private readonly _params: QueryStateParams) {
-    super();
-    this.filter = _params.request.filter;
-  }
-
-  getResults() {
-    return this._results;
-  }
-
-  // https://github.com/open-telemetry/semantic-conventions/blob/main/docs/attributes-registry/db.md#generic-database-attributes
-  @trace.span({ showInBrowserTimeline: true, op: 'db.query', attributes: { 'db.system': 'echo' } })
-  async execQuery(): Promise<QueryRunResult> {
-    const filter = this._params.request.filter;
-
-    const beginQuery = performance.now();
-
-    // For object id filters, we return no results as those are handled by the SpaceQuerySource.
-    const hits =
-      filter.objectIds && filter.objectIds?.length > 0
-        ? []
-        : await this._params.indexer.execQuery(filterToIndexQuery(filter));
-    if (this._firstRun) {
-      this.metrics.indexQueryTime = performance.now() - beginQuery;
-    }
-
-    const beginFilter = performance.now();
-
-    const results: QueryResult[] = (
-      await Promise.all(
-        hits.map(async (result) => {
-          if (this._firstRun) {
-            this.metrics.objectsReturnedFromIndex++;
-          }
-
-          const { objectId, documentId, spaceKey: spaceKeyInIndex } = objectPointerCodec.decode(result.id);
-
-          let spaceKey: string | null;
-          if (spaceKeyInIndex !== undefined) {
-            spaceKey = spaceKeyInIndex;
-          } else {
-            // Indexes created by older versions of the indexer do not have the spaceKey in the index.
-            // If the spaceKey is not in the index, we need to load the document to get it.
-
-            if (this._firstRun) {
-              this.metrics.documentsLoaded++;
-            }
-
-            const handle = await this._params.automergeHost.loadDoc<SpaceDoc>(
-              Context.default(),
-              documentId as DocumentId,
-            );
-
-            // `whenReady` creates a timeout so we guard it with an if to skip it if the handle is already ready.
-            if (this._ctx.disposed) {
-              return;
-            }
-            spaceKey = getSpaceKeyFromDoc(handle.docSync()!);
-          }
-
-          if (!spaceKey) {
-            return;
-          }
-          // TODO(mykola): Remove business logic from here.
-          if (
-            this._params.request.filter.options?.spaces?.length &&
-            !this._params.request.filter.options.spaces.some((key) => key.equals(spaceKey!))
-          ) {
-            return;
-          }
-
-          if (this._firstRun) {
-            this.metrics.objectsReturned++;
-          }
-
-          return {
-            id: objectId,
-            documentId,
-            spaceId: await createIdFromSpaceKey(PublicKey.from(spaceKey)),
-            spaceKey: PublicKey.from(spaceKey),
-            rank: result.rank,
-          } satisfies QueryResult;
-        }),
-      )
-    ).filter(isNonNullable);
-
-    if (this._firstRun) {
-      this.metrics.documentLoadTime = performance.now() - beginFilter;
-    }
-
-    if (this._ctx.disposed) {
-      return { changed: false };
-    }
-
-    const areResultsUnchanged =
-      !this._firstRun &&
-      this._results.length === results.length &&
-      this._results.every((oldResult) => results.some((result) => result.id === oldResult.id)) &&
-      results.every((result) => this._results.some((oldResult) => oldResult.id === result.id));
-
-    if (this._firstRun) {
-      this.metrics.executionTime = performance.now() - beginQuery;
-    }
-
-    this._firstRun = false;
-    if (areResultsUnchanged) {
-      return { changed: false };
-    }
-
-    this._results = results;
-    return { changed: true };
-  }
-}
-
-// TODO(burdon): Process Filter DSL.
-const filterToIndexQuery = (filter: FilterProto): IndexQuery => {
-  invariant(!(filter.type && (filter.or ?? []).length > 0), 'Cannot mix type and or filters.');
-  invariant(
-    (filter.or ?? []).every((subFilter) => !(subFilter.type && (subFilter.or ?? []).length > 0)),
-    'Cannot mix type and or filters.',
-  );
-  if (
-    filter.type ||
-    ((filter.or ?? []).length > 0 && (filter.or ?? []).every((subFilter) => !subFilter.not && subFilter.type))
-  ) {
-    return {
-      typenames:
-        filter.type && filter.type.length > 0
-          ? filter.type.map((type) => dxnToIndexerTypename(DXN.parse(type)))
-          : (filter.or ?? [])
-              .flatMap((f) => f.type?.map((type) => dxnToIndexerTypename(DXN.parse(type))) ?? [])
-              .filter(isNonNullable),
-      inverted: filter.not,
-    };
-  } else {
-    // Query all objects.
-    return { typenames: [] };
-  }
-};
-
-const dxnToIndexerTypename = (dxn: DXN) => {
-  switch (dxn.kind) {
-    case DXN.kind.TYPE:
-      return dxn.parts[0];
-    case DXN.kind.ECHO:
-      return dxn.parts[1];
-    default:
-      throw new Error(`Invalid DXN kind: ${dxn.kind}`);
-  }
-};