|
| 1 | +import { getState, patchState, signalStore, withState } from '@ngrx/signals'; |
| 2 | +import { withStorageSync } from './with-storage-sync'; |
| 3 | +import { TestBed } from '@angular/core/testing'; |
| 4 | + |
| 5 | +interface StateObject { |
| 6 | + foo: string; |
| 7 | + age: number; |
| 8 | +} |
| 9 | +const initialState: StateObject = { |
| 10 | + foo: 'bar', |
| 11 | + age: 18, |
| 12 | +}; |
| 13 | +const key = 'FooBar'; |
| 14 | + |
| 15 | +describe('withStorageSync', () => { |
| 16 | + beforeEach(() => { |
| 17 | + // make sure to start with a clean storage |
| 18 | + localStorage.removeItem(key); |
| 19 | + }); |
| 20 | + |
| 21 | + it('adds methods for storage access to the store', () => { |
| 22 | + TestBed.runInInjectionContext(() => { |
| 23 | + const Store = signalStore(withStorageSync({ key })); |
| 24 | + const store = new Store(); |
| 25 | + |
| 26 | + expect(Object.keys(store)).toEqual([ |
| 27 | + 'clearStorage', |
| 28 | + 'readFromStorage', |
| 29 | + 'writeToStorage', |
| 30 | + ]); |
| 31 | + }); |
| 32 | + }); |
| 33 | + |
| 34 | + it('offers manual sync using provided methods', () => { |
| 35 | + TestBed.runInInjectionContext(() => { |
| 36 | + // prefill storage |
| 37 | + localStorage.setItem( |
| 38 | + key, |
| 39 | + JSON.stringify({ |
| 40 | + foo: 'baz', |
| 41 | + age: 99, |
| 42 | + } as StateObject) |
| 43 | + ); |
| 44 | + |
| 45 | + const Store = signalStore(withStorageSync({ key, autoSync: false })); |
| 46 | + const store = new Store(); |
| 47 | + expect(getState(store)).toEqual({}); |
| 48 | + |
| 49 | + store.readFromStorage(); |
| 50 | + expect(getState(store)).toEqual({ |
| 51 | + foo: 'baz', |
| 52 | + age: 99, |
| 53 | + }); |
| 54 | + |
| 55 | + patchState(store, { ...initialState }); |
| 56 | + TestBed.flushEffects(); |
| 57 | + |
| 58 | + let storeItem = JSON.parse(localStorage.getItem(key) || '{}'); |
| 59 | + expect(storeItem).toEqual({ |
| 60 | + foo: 'baz', |
| 61 | + age: 99, |
| 62 | + }); |
| 63 | + |
| 64 | + store.writeToStorage(); |
| 65 | + storeItem = JSON.parse(localStorage.getItem(key) || '{}'); |
| 66 | + expect(storeItem).toEqual({ |
| 67 | + ...initialState, |
| 68 | + }); |
| 69 | + |
| 70 | + store.clearStorage(); |
| 71 | + storeItem = localStorage.getItem(key); |
| 72 | + expect(storeItem).toEqual(null); |
| 73 | + }); |
| 74 | + }); |
| 75 | + |
| 76 | + describe('autoSync', () => { |
| 77 | + it('inits from storage and write to storage on changes when set to `true`', () => { |
| 78 | + TestBed.runInInjectionContext(() => { |
| 79 | + // prefill storage |
| 80 | + localStorage.setItem( |
| 81 | + key, |
| 82 | + JSON.stringify({ |
| 83 | + foo: 'baz', |
| 84 | + age: 99, |
| 85 | + } as StateObject) |
| 86 | + ); |
| 87 | + |
| 88 | + const Store = signalStore(withStorageSync(key)); |
| 89 | + const store = new Store(); |
| 90 | + expect(getState(store)).toEqual({ |
| 91 | + foo: 'baz', |
| 92 | + age: 99, |
| 93 | + }); |
| 94 | + |
| 95 | + patchState(store, { ...initialState }); |
| 96 | + TestBed.flushEffects(); |
| 97 | + |
| 98 | + expect(getState(store)).toEqual({ |
| 99 | + ...initialState, |
| 100 | + }); |
| 101 | + const storeItem = JSON.parse(localStorage.getItem(key) || '{}'); |
| 102 | + expect(storeItem).toEqual({ |
| 103 | + ...initialState, |
| 104 | + }); |
| 105 | + }); |
| 106 | + }); |
| 107 | + |
| 108 | + it('does not init from storage and does write to storage on changes when set to `false`', () => { |
| 109 | + TestBed.runInInjectionContext(() => { |
| 110 | + // prefill storage |
| 111 | + localStorage.setItem( |
| 112 | + key, |
| 113 | + JSON.stringify({ |
| 114 | + foo: 'baz', |
| 115 | + age: 99, |
| 116 | + } as StateObject) |
| 117 | + ); |
| 118 | + |
| 119 | + const Store = signalStore(withStorageSync({ key, autoSync: false })); |
| 120 | + const store = new Store(); |
| 121 | + expect(getState(store)).toEqual({}); |
| 122 | + |
| 123 | + patchState(store, { ...initialState }); |
| 124 | + const storeItem = JSON.parse(localStorage.getItem(key) || '{}'); |
| 125 | + expect(storeItem).toEqual({ |
| 126 | + foo: 'baz', |
| 127 | + age: 99, |
| 128 | + }); |
| 129 | + }); |
| 130 | + }); |
| 131 | + }); |
| 132 | + |
| 133 | + describe('select', () => { |
| 134 | + it('syncs the whole state by default', () => { |
| 135 | + TestBed.runInInjectionContext(() => { |
| 136 | + const Store = signalStore(withStorageSync(key)); |
| 137 | + const store = new Store(); |
| 138 | + |
| 139 | + patchState(store, { ...initialState }); |
| 140 | + TestBed.flushEffects(); |
| 141 | + |
| 142 | + const storeItem = JSON.parse(localStorage.getItem(key) || '{}'); |
| 143 | + expect(storeItem).toEqual({ |
| 144 | + ...initialState, |
| 145 | + }); |
| 146 | + }); |
| 147 | + }); |
| 148 | + |
| 149 | + it('syncs selected slices when specified', () => { |
| 150 | + TestBed.runInInjectionContext(() => { |
| 151 | + const Store = signalStore( |
| 152 | + withState(initialState), |
| 153 | + withStorageSync({ key, select: ({ foo }) => ({ foo }) }) |
| 154 | + ); |
| 155 | + const store = new Store(); |
| 156 | + |
| 157 | + patchState(store, { foo: 'baz' }); |
| 158 | + TestBed.flushEffects(); |
| 159 | + |
| 160 | + const storeItem = JSON.parse(localStorage.getItem(key) || '{}'); |
| 161 | + expect(storeItem).toEqual({ |
| 162 | + foo: 'baz', |
| 163 | + }); |
| 164 | + }); |
| 165 | + }); |
| 166 | + }); |
| 167 | + |
| 168 | + describe('parse/stringify', () => { |
| 169 | + it('uses custom parsing/stringification when specified', () => { |
| 170 | + const parse = (stateString: string) => { |
| 171 | + const [foo, age] = stateString.split('_'); |
| 172 | + return { |
| 173 | + foo, |
| 174 | + age: +age, |
| 175 | + }; |
| 176 | + }; |
| 177 | + |
| 178 | + TestBed.runInInjectionContext(() => { |
| 179 | + const Store = signalStore( |
| 180 | + withState(initialState), |
| 181 | + withStorageSync({ |
| 182 | + key, |
| 183 | + parse, |
| 184 | + stringify: (state) => `${state.foo}_${state.age}`, |
| 185 | + }) |
| 186 | + ); |
| 187 | + const store = new Store(); |
| 188 | + |
| 189 | + patchState(store, { foo: 'baz' }); |
| 190 | + TestBed.flushEffects(); |
| 191 | + |
| 192 | + const storeItem = parse(localStorage.getItem(key) || ''); |
| 193 | + expect(storeItem).toEqual({ |
| 194 | + ...initialState, |
| 195 | + foo: 'baz', |
| 196 | + }); |
| 197 | + }); |
| 198 | + }); |
| 199 | + }); |
| 200 | + |
| 201 | + describe('storage factory', () => { |
| 202 | + it('uses specified storage', () => { |
| 203 | + TestBed.runInInjectionContext(() => { |
| 204 | + // prefill storage |
| 205 | + sessionStorage.setItem( |
| 206 | + key, |
| 207 | + JSON.stringify({ |
| 208 | + foo: 'baz', |
| 209 | + age: 99, |
| 210 | + } as StateObject) |
| 211 | + ); |
| 212 | + |
| 213 | + const Store = signalStore( |
| 214 | + withStorageSync({ key, storage: () => sessionStorage }) |
| 215 | + ); |
| 216 | + const store = new Store(); |
| 217 | + expect(getState(store)).toEqual({ |
| 218 | + foo: 'baz', |
| 219 | + age: 99, |
| 220 | + }); |
| 221 | + |
| 222 | + patchState(store, { ...initialState }); |
| 223 | + TestBed.flushEffects(); |
| 224 | + |
| 225 | + expect(getState(store)).toEqual({ |
| 226 | + ...initialState, |
| 227 | + }); |
| 228 | + const storeItem = JSON.parse(sessionStorage.getItem(key) || '{}'); |
| 229 | + expect(storeItem).toEqual({ |
| 230 | + ...initialState, |
| 231 | + }); |
| 232 | + |
| 233 | + store.clearStorage(); |
| 234 | + }); |
| 235 | + }); |
| 236 | + }); |
| 237 | +}); |
0 commit comments