vue-instantsearch-ssr/src/util/__tests__/parseAlgoliaHit.test.js

👀 Lightning-fast Algolia search for Vue apps

// copied from React InstantSearch
import { parseAlgoliaHit } from '../parseAlgoliaHit';

describe('parseAlgoliaHit()', () => {
  it('it does not break when there is a missing attribute', () => {
    const attribute = 'attr';
    const out = parseAlgoliaHit({
      attribute,
      hit: {},
      highlightProperty: '_highlightResult',
    });
    expect(out).toEqual([]);
  });

  it('creates a single element when there is no tag', () => {
    const value = 'foo bar baz';
    const attribute = 'attr';
    const out = parseAlgoliaHit({
      attribute,
      hit: createHit(attribute, value),
      highlightProperty: '_highlightResult',
    });
    expect(out).toEqual([{ isHighlighted: false, value }]);
  });

  it('creates a single element when there is only a tag', () => {
    const textValue = 'foo bar baz';
    const value = `__ais-highlight__${textValue}__/ais-highlight__`;
    const attribute = 'attr';
    const out = parseAlgoliaHit({
      attribute,
      hit: createHit(attribute, value),
      highlightProperty: '_highlightResult',
    });
    expect(out).toEqual([{ value: textValue, isHighlighted: true }]);
  });

  it('fetches and parses a deep attribute', () => {
    const textValue = 'foo bar baz';
    const value = `__ais-highlight__${textValue}__/ais-highlight__`;
    const hit = {
      lvl0: { lvl1: { lvl2: value } },
      _highlightResult: {
        lvl0: { lvl1: { lvl2: { value } } },
      },
    };
    const out = parseAlgoliaHit({
      attribute: 'lvl0.lvl1.lvl2',
      hit,
      highlightProperty: '_highlightResult',
    });
    expect(out).toEqual([{ value: textValue, isHighlighted: true }]);
  });

  it('parses the string and returns the part that are highlighted - 1 big highlight', () => {
    const str =
      'like __ais-highlight__al__/ais-highlight__golia does __ais-highlight__al__/ais-highlight__golia';
    const hit = createHit('attr', str);
    const parsed = parseAlgoliaHit({
      attribute: 'attr',
      hit,
      highlightProperty: '_highlightResult',
    });
    expect(parsed).toEqual([
      { value: 'like ', isHighlighted: false },
      { value: 'al', isHighlighted: true },
      { value: 'golia does ', isHighlighted: false },
      { value: 'al', isHighlighted: true },
      { value: 'golia', isHighlighted: false },
    ]);
  });

  it('supports the array format, parses it and returns the part that is highlighted', () => {
    const hit = {
      tags: ['litterature', 'biology', 'photography'],
      _highlightResult: {
        tags: [
          { value: 'litterature' },
          { value: 'biology' },
          { value: '__ais-highlight__photo__/ais-highlight__graphy' },
        ],
      },
    };

    const actual = parseAlgoliaHit({
      attribute: 'tags',
      hit,
      highlightProperty: '_highlightResult',
    });

    const exepectation = [
      [{ value: 'litterature', isHighlighted: false }],
      [{ value: 'biology', isHighlighted: false }],
      [
        { value: 'photo', isHighlighted: true },
        { value: 'graphy', isHighlighted: false },
      ],
    ];

    expect(actual).toEqual(exepectation);
  });

  it('parses the string and returns the part that are highlighted - same pre and post tag', () => {
    const str = 'surpise **lo**l mouhahah roflmao **lo**utre';
    const hit = createHit('attr', str);
    const parsed = parseAlgoliaHit({
      preTag: '**',
      postTag: '**',
      attribute: 'attr',
      hit,
      highlightProperty: '_highlightResult',
    });
    expect(parsed).toEqual([
      { value: 'surpise ', isHighlighted: false },
      { value: 'lo', isHighlighted: true },
      { value: 'l mouhahah roflmao ', isHighlighted: false },
      { value: 'lo', isHighlighted: true },
      { value: 'utre', isHighlighted: false },
    ]);
  });

  it('throws when hit is `null`', () => {
    expect(
      parseAlgoliaHit.bind(null, {
        attribute: 'unknownattribute',
        hit: null,
        highlightProperty: '_highlightResult',
      })
    ).toThrow('`hit`, the matching record, must be provided');
  });

  it('throws when hit is `undefined`', () => {
    expect(
      parseAlgoliaHit.bind(null, {
        attribute: 'unknownAttribute',
        hit: undefined,
        highlightProperty: '_highlightResult',
      })
    ).toThrow('`hit`, the matching record, must be provided');
  });

  it('unescapes escaped strings', () => {
    expect(
      parseAlgoliaHit({
        attribute: 'title',
        hit: {
          _highlightResult: {
            title: {
              value: ''TV' & <Home> "Theater"',
            },
          },
        },
        highlightProperty: '_highlightResult',
      })
    ).toEqual([
      {
        isHighlighted: false,
        value: `'TV' & <Home> "Theater"`,
      },
    ]);

    expect(
      parseAlgoliaHit({
        attribute: 'categories',
        hit: {
          _highlightResult: {
            categories: [
              {
                value: 'TV &amp; Home Theater',
              },
              {
                value: '__ais-highlight__&#39;TV&#39;__/ais-highlight__',
              },
            ],
          },
        },
        highlightProperty: '_highlightResult',
      })
    ).toEqual([
      [
        {
          isHighlighted: false,
          value: `TV & Home Theater`,
        },
      ],
      [
        {
          isHighlighted: true,
          value: `'TV'`,
        },
      ],
    ]);
  });
});

function createHit(attribute, value) {
  return {
    [attribute]: value,
    _highlightResult: {
      [attribute]: { value },
    },
  };
}