debian-mirror-gitlab/spec/frontend/locale/sprintf_spec.js

import sprintf from '~/locale/sprintf';

describe('locale', () => {
  describe('sprintf', () => {
    it('does not modify string without parameters', () => {
      const input = 'No parameters';

      const output = sprintf(input);

      expect(output).toBe(input);
    });

    it('ignores extraneous parameters', () => {
      const input = 'No parameters';

      const output = sprintf(input, { ignore: 'this' });

      expect(output).toBe(input);
    });

    it('ignores extraneous placeholders', () => {
      const input = 'No %{parameters}';

      const output = sprintf(input);

      expect(output).toBe(input);
    });

    it('replaces parameters', () => {
      const input = '%{name} has %{count} parameters';
      const parameters = {
        name: 'this',
        count: 2,
      };

      const output = sprintf(input, parameters);

      expect(output).toBe('this has 2 parameters');
    });

    it('replaces multiple occurrences', () => {
      const input = 'to %{verb} or not to %{verb}';
      const parameters = {
        verb: 'be',
      };

      const output = sprintf(input, parameters);

      expect(output).toBe('to be or not to be');
    });

    it('escapes parameters', () => {
      const input = 'contains %{userContent}';
      const parameters = {
        userContent: '<script>alert("malicious!")</script>',
      };

      const output = sprintf(input, parameters);

      expect(output).toBe('contains &lt;script&gt;alert(&quot;malicious!&quot;)&lt;/script&gt;');
    });

    it('does not escape parameters for escapeParameters = false', () => {
      const input = 'contains %{safeContent}';
      const parameters = {
        safeContent: '15',
      };

      const output = sprintf(input, parameters, false);

      expect(output).toBe('contains 15');
    });

    describe('replaces duplicated % in input', () => {
      it('removes duplicated percentage signs', () => {
        const input = 'contains duplicated %{safeContent}%%';

        const parameters = {
          safeContent: '15',
        };

        const output = sprintf(input, parameters, false);

        expect(output).toBe('contains duplicated 15%');
      });
    });

    describe('ignores special replacements in the input', () => {
      it.each(['$$', '$&', '$`', `$'`])('replacement "%s" is ignored', (replacement) => {
        const input = 'My odd %{replacement} is preserved';

        const parameters = { replacement };

        const output = sprintf(input, parameters, false);
        expect(output).toBe(`My odd ${replacement} is preserved`);
      });
    });
  });
});