summaryrefslogtreecommitdiff
path: root/spec/frontend/vue_shared/components/local_storage_sync_spec.js
blob: a80717a1aea78476a60d16eb1fc7caae0c9e18a4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
import { shallowMount } from '@vue/test-utils';
import LocalStorageSync from '~/vue_shared/components/local_storage_sync.vue';

const STORAGE_KEY = 'key';

describe('Local Storage Sync', () => {
  let wrapper;

  const createComponent = ({ value, asString = false, slots = {} } = {}) => {
    wrapper = shallowMount(LocalStorageSync, {
      propsData: { storageKey: STORAGE_KEY, value, asString },
      slots,
    });
  };

  const setStorageValue = (value) => localStorage.setItem(STORAGE_KEY, value);
  const getStorageValue = (value) => localStorage.getItem(STORAGE_KEY, value);

  afterEach(() => {
    wrapper.destroy();
    localStorage.clear();
  });

  it('is a renderless component', () => {
    const html = '<div class="test-slot"></div>';
    createComponent({
      slots: {
        default: html,
      },
    });

    expect(wrapper.html()).toBe(html);
  });

  describe('localStorage empty', () => {
    it('does not emit input event', () => {
      createComponent({ value: 'ascending' });

      expect(wrapper.emitted('input')).toBeUndefined();
    });

    it('does not save initial value if it did not change', () => {
      createComponent({ value: 'ascending' });

      expect(getStorageValue()).toBeNull();
    });
  });

  describe('localStorage has saved value', () => {
    const savedValue = 'last_updated';

    beforeEach(() => {
      setStorageValue(savedValue);
      createComponent({ asString: true });
    });

    it('emits input event with saved value', () => {
      expect(wrapper.emitted('input')[0][0]).toBe(savedValue);
    });

    it('does not overwrite localStorage with initial prop value', () => {
      expect(getStorageValue()).toBe(savedValue);
    });

    it('updating the value updates localStorage', async () => {
      const newValue = 'last_updated';
      await wrapper.setProps({ value: newValue });

      expect(getStorageValue()).toBe(newValue);
    });
  });

  describe('persist prop', () => {
    it('persists the value by default', async () => {
      const persistedValue = 'persisted';
      createComponent({ asString: true });
      // Sanity check to make sure we start with nothing saved.
      expect(getStorageValue()).toBeNull();

      await wrapper.setProps({ value: persistedValue });

      expect(getStorageValue()).toBe(persistedValue);
    });

    it('does not save a value if persist is set to false', async () => {
      const value = 'saved';
      const notPersistedValue = 'notPersisted';
      createComponent({ asString: true });
      // Save some value so we can test that it's not overwritten.
      await wrapper.setProps({ value });

      expect(getStorageValue()).toBe(value);

      await wrapper.setProps({ persist: false, value: notPersistedValue });

      expect(getStorageValue()).toBe(value);
    });
  });

  describe('saving and restoring', () => {
    it.each`
      value             | asString
      ${'foo'}          | ${true}
      ${'foo'}          | ${false}
      ${'{ a: 1 }'}     | ${true}
      ${'{ a: 1 }'}     | ${false}
      ${3}              | ${false}
      ${['foo', 'bar']} | ${false}
      ${{ foo: 'bar' }} | ${false}
      ${null}           | ${false}
      ${' '}            | ${false}
      ${true}           | ${false}
      ${false}          | ${false}
      ${42}             | ${false}
      ${'42'}           | ${false}
      ${'{ foo: '}      | ${false}
    `('saves and restores the same value', async ({ value, asString }) => {
      // Create an initial component to save the value.
      createComponent({ asString });
      await wrapper.setProps({ value });
      wrapper.destroy();
      // Create a second component to restore the value. Restore is only done once, when the
      // component is first mounted.
      createComponent({ asString });

      expect(wrapper.emitted('input')[0][0]).toEqual(value);
    });

    it('shows a warning when trying to save a non-string value when asString prop is true', async () => {
      const spy = jest.spyOn(console, 'warn').mockImplementation();
      createComponent({ asString: true });
      await wrapper.setProps({ value: [] });

      expect(spy).toHaveBeenCalled();
    });
  });

  describe('with bad JSON in storage', () => {
    const badJSON = '{ badJSON';
    let spy;

    beforeEach(() => {
      spy = jest.spyOn(console, 'warn').mockImplementation();
      setStorageValue(badJSON);
      createComponent();
    });

    it('should console warn', () => {
      expect(spy).toHaveBeenCalled();
    });

    it('should not emit an input event', () => {
      expect(wrapper.emitted('input')).toBeUndefined();
    });
  });

  it('clears localStorage when clear property is true', async () => {
    const value = 'initial';
    createComponent({ asString: true });
    await wrapper.setProps({ value });

    expect(getStorageValue()).toBe(value);

    await wrapper.setProps({ clear: true });

    expect(getStorageValue()).toBeNull();
  });
});