@gitlab/ui/src/components/utilities/friendly_wrap/friendly_wrap.spec.js

GitLab UI Components

import { shallowMount } from '@vue/test-utils';
import FriendlyWrap from './friendly_wrap.vue';

describe('Friendly wrap component', () => {
  let wrapper;

  const createComponent = (props) => {
    wrapper = shallowMount(FriendlyWrap, {
      propsData: props,
    });
  };

  it('wraps text on slashes by default', () => {
    const text = '/some/file/path';
    const textWrapped = '/<wbr>some/<wbr>file/<wbr>path';
    createComponent({
      text,
    });

    expect(wrapper.text()).toBe(text);
    expect(wrapper.html()).toMatch(textWrapped);
  });

  it('supports backslashes', () => {
    const text = '\\some\\long\\file\\path';
    const textWrapped = '\\<wbr>some\\<wbr>long\\<wbr>file\\<wbr>path';
    createComponent({
      text,
      symbols: ['\\'],
    });
    expect(wrapper.text()).toBe(text);
    expect(wrapper.html()).toMatch(textWrapped);
  });

  it('accepts multiple symbols', () => {
    const text = 'some;text-that.needs;to-be.wrapped';
    const textWrapped = 'some;<wbr>text-<wbr>that.<wbr>needs;<wbr>to-<wbr>be.<wbr>wrapped';
    createComponent({
      text,
      symbols: [';', '-', '.'],
    });
    expect(wrapper.text()).toBe(text);
    expect(wrapper.html()).toMatch(textWrapped);
  });

  it('works with words', () => {
    const text = 'it goes on and on and on and on';
    const textWrapped = 'it goes on and<wbr> on and<wbr> on and<wbr> on';
    createComponent({
      text,
      symbols: ['and'],
    });
    expect(wrapper.text()).toBe(text);
    expect(wrapper.html()).toMatch(textWrapped);
  });

  it(`does not break with sensitive symbols like '<' or 'w' or 'b' or 'r' or '>'`, () => {
    const text = '< or w or b or r or >';
    const textWrapped = '&lt;<wbr> or<wbr> w<wbr> or<wbr> b<wbr> or<wbr> r<wbr> or<wbr> &gt;';
    createComponent({
      text,
      symbols: ['<', ...'wbr'.split(''), '>'],
    });

    expect(wrapper.text()).toBe(text);
    expect(wrapper.html()).toMatch(textWrapped);
  });

  it('allows HTML entities as words', () => {
    const text = 'foo&lt;foo&gt;foo>foo<foo';
    const textWrapped = 'foo&amp;lt;<wbr>foo&amp;gt;<wbr>foo&gt;foo&lt;foo';
    createComponent({
      text,
      symbols: ['&lt;', '&gt;'],
    });

    expect(wrapper.text()).toBe(text);
    expect(wrapper.html()).toMatch(textWrapped);
  });

  it('escapes text to prevent XSS', () => {
    const text = '<script>alert(1)</script>';
    const textWrapped = '&lt;script&gt;alert(1)&lt;/<wbr>script&gt;';
    createComponent({
      text,
    });

    expect(wrapper.text()).toBe(text);
    expect(wrapper.html()).toMatch(textWrapped);
  });

  it('does not unnecessarily insert a wbr at the end', () => {
    const text = '/';
    createComponent({
      text,
    });

    expect(wrapper.text()).toBe(text);
    expect(wrapper.find('wbr').exists()).toBe(false);
  });

  it('does not insert unnecessary whitespace', () => {
    const text = '';
    createComponent({
      text,
    });

    // Cannot use `wrapper.text()`, since that automatically trims whitespace
    expect(wrapper.element.textContent).toBe(text);
  });

  it.each([null, undefined])('gracefully handles %p', (text) => {
    createComponent({
      text,
    });

    // Assert prop validation failed
    expect(wrapper).toHaveLoggedVueErrors();

    // But it still rendered
    expect(wrapper.text()).toBe('');
  });
});