coveo-search-ui/src/ui/RelevanceInspector/RankingInfoTable.ts

Coveo JavaScript Search Framework

import { parseRankingInfo, IRankingInfo, buildListOfTermsElement, IWeightsPerTerm } from './RankingInfoParser';
import { each, uniq, contains, chain, reduce } from 'underscore';
import { TableBuilder, ITableDataSource, GenericHtmlRenderer } from './TableBuilder';
import { $$, Dom } from '../../utils/Dom';
import { IQueryResult } from '../../rest/QueryResult';
import { IComponentBindings } from '../Base/ComponentBindings';
import { IResultsComponentBindings } from '../Base/ResultsComponentBindings';
import { IRelevanceInspectorTab } from './RelevanceInspector';
import agGridModule = require('ag-grid/main');

export class RankingInfoTable implements IRelevanceInspectorTab {
  public gridOptions: agGridModule.GridOptions;
  constructor(public results: IQueryResult[], public bindings: IComponentBindings) {}

  public async build(): Promise<Dom> {
    const container = $$('div');

    const agGridElement = $$('div', {
      className: 'ag-theme-fresh'
    });
    container.append(agGridElement.el);

    let topLevelInfoThatHaveAtLeastANonZeroValue: string[] = [];
    let containsKeywordRankingInfo = false;

    this.results.forEach(result => {
      const rankingInfo = parseRankingInfo(result.rankingInfo);
      containsKeywordRankingInfo = rankingInfo.termsWeight != null;
      if (rankingInfo && rankingInfo.documentWeights) {
        each(rankingInfo.documentWeights, (value: number, key: string) => {
          if (value != 0) {
            topLevelInfoThatHaveAtLeastANonZeroValue.push(key);
          }
        });
      }
    });

    topLevelInfoThatHaveAtLeastANonZeroValue = uniq(topLevelInfoThatHaveAtLeastANonZeroValue);

    const data = this.results.map(result => {
      const rankingInfo = parseRankingInfo(result.rankingInfo);

      if (rankingInfo) {
        const documentsWeights = this.buildTopLevelDocumentsWeights(rankingInfo, topLevelInfoThatHaveAtLeastANonZeroValue);
        const breakdownPerTerm: Record<string, ITableDataSource> = {};

        const onlyTopFewKeywords: Record<string, IWeightsPerTerm> = {};

        chain(rankingInfo.termsWeight)
          .keys()
          .sortBy(key => {
            const total = reduce(rankingInfo.termsWeight[key].Weights, (memo, value) => memo + value, 0);
            return total;
          })
          .reverse()
          .first(3)
          .each(key => {
            onlyTopFewKeywords[key] = rankingInfo.termsWeight[key];
          });

        each(onlyTopFewKeywords, (value, key) => {
          const builtKey = `Keyword: ${key}`;
          breakdownPerTerm[builtKey] = {
            content: buildListOfTermsElement(value.Weights).el.outerHTML,
            cellRenderer: GenericHtmlRenderer,
            width: 200
          };
        });

        const totalContent = rankingInfo.totalWeight ? rankingInfo.totalWeight : 0;
        return {
          ...TableBuilder.thumbnailCell(result, this.bindings as IResultsComponentBindings),
          ...documentsWeights,
          ...breakdownPerTerm,
          ...{ Total: { content: totalContent || 0 } }
        };
      }
      return {};
    });

    const { gridOptions } = await new TableBuilder().build(data, agGridElement, {
      getRowHeight: () => {
        return containsKeywordRankingInfo ? 400 : 250;
      },
      onGridReady: params => {
        setTimeout(() => {
          if (params) {
            params.api.sizeColumnsToFit();
            params.api.setSortModel([{ colId: 'Total', sort: 'desc' }]);
          }
        }, 0);
      }
    });

    this.gridOptions = gridOptions;

    return container;
  }

  private buildTopLevelDocumentsWeights(rankingInfo: IRankingInfo, hasAtLeastOneNonZeroValue: string[]): Record<string, ITableDataSource> {
    const documentWeights: Record<string, ITableDataSource> = {};
    each(rankingInfo.documentWeights || {}, (value, key) => {
      if (contains(hasAtLeastOneNonZeroValue, key)) documentWeights[key] = { content: value || 0 };
    });
    return documentWeights;
  }
}