-
Notifications
You must be signed in to change notification settings - Fork 5.5k
/
AuthSessionStore.test.ts
198 lines (165 loc) · 6.1 KB
/
AuthSessionStore.test.ts
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
/*
* Copyright 2020 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { withLogCollector } from '@backstage/test-utils';
import { z } from 'zod';
import { AuthSessionStore } from './AuthSessionStore';
import { SessionManager } from './types';
const defaultOptions = {
storageKey: 'my-key',
schema: z.any(),
sessionScopes: (session: string) => new Set(session.split(' ')),
};
class LocalStorage {
private store: Record<string, string> = {};
getItem(key: string) {
return this.store[key] || null;
}
setItem(key: string, value: string) {
this.store[key] = value.toString();
}
removeItem(key: string) {
delete this.store[key];
}
}
class MockManager implements SessionManager<string> {
setSession = jest.fn();
getSession = jest.fn();
removeSession = jest.fn();
sessionState$ = jest.fn();
}
describe('GheAuth AuthSessionStore', () => {
beforeEach(() => {
delete (window as any).localStorage;
(window as any).localStorage = new LocalStorage();
});
afterEach(() => {
jest.resetAllMocks();
});
it('should load session', async () => {
localStorage.setItem('my-key', '"a b c"');
const manager = new MockManager();
const store = new AuthSessionStore({ manager, ...defaultOptions });
await expect(store.getSession({})).resolves.toBe('a b c');
expect(manager.getSession).not.toHaveBeenCalled();
expect(manager.setSession).toHaveBeenCalledWith('a b c');
});
it('should not use session without enough scope', async () => {
localStorage.setItem('my-key', '"a b c"');
const manager = new MockManager();
manager.getSession.mockResolvedValue('a b c d');
const store = new AuthSessionStore({ manager, ...defaultOptions });
await expect(store.getSession({ scopes: new Set(['d']) })).resolves.toBe(
'a b c d',
);
expect(manager.getSession).toHaveBeenCalledTimes(1);
expect(manager.setSession).not.toHaveBeenCalled();
});
it('should not use expired session', async () => {
localStorage.setItem('my-key', '"a b c"');
const manager = new MockManager();
manager.getSession.mockResolvedValue('123');
const store = new AuthSessionStore({
manager,
...defaultOptions,
sessionShouldRefresh: () => true,
});
await expect(store.getSession({})).resolves.toBe('123');
expect(manager.getSession).toHaveBeenCalledTimes(1);
expect(manager.setSession).not.toHaveBeenCalled();
});
it('should not load missing session', async () => {
const manager = new MockManager();
manager.getSession.mockResolvedValue('123');
const store = new AuthSessionStore({ manager, ...defaultOptions });
await expect(store.getSession({})).resolves.toBe('123');
expect(manager.getSession).toHaveBeenCalledTimes(1);
expect(manager.setSession).not.toHaveBeenCalled();
expect(localStorage.getItem('my-key')).toBe('"123"');
});
it('should ignore bad session values', async () => {
localStorage.setItem('my-key', 'derp');
const manager = new MockManager();
manager.getSession.mockResolvedValue('123');
const store = new AuthSessionStore({ manager, ...defaultOptions });
await expect(store.getSession({})).resolves.toBe('123');
expect(manager.getSession).toHaveBeenCalledTimes(1);
expect(manager.setSession).not.toHaveBeenCalled();
});
it('should clear session', () => {
localStorage.setItem('my-key', '"a b c"');
const manager = new MockManager();
const store = new AuthSessionStore({ manager, ...defaultOptions });
store.removeSession();
expect(localStorage.getItem('my-key')).toBe(null);
expect(manager.removeSession).toHaveBeenCalled();
});
it('should set session', async () => {
const manager = new MockManager();
const store = new AuthSessionStore({ manager, ...defaultOptions });
await expect(store.getSession({ optional: true })).resolves.toBe(undefined);
expect(localStorage.getItem('my-key')).toBe(null);
expect(manager.setSession).not.toHaveBeenCalled();
store.setSession('123');
expect(manager.setSession).toHaveBeenCalled();
expect(localStorage.getItem('my-key')).toBe('"123"');
await expect(store.getSession({ optional: true })).resolves.toBe('123');
});
it('should forward sessionState calls', () => {
const manager = new MockManager();
const store = new AuthSessionStore({ manager, ...defaultOptions });
store.sessionState$();
expect(manager.sessionState$).toHaveBeenCalled();
});
it('should schema-validate stored data', async () => {
const manager = new MockManager();
const firstStore = new AuthSessionStore<boolean>({
manager,
storageKey: 'a',
schema: z.boolean(),
sessionScopes: () => new Set(),
});
const secondStore = new AuthSessionStore<number>({
manager,
storageKey: 'a',
schema: z.number(),
sessionScopes: () => new Set(),
});
firstStore.setSession(true);
await expect(firstStore.getSession({})).resolves.toBe(true);
await expect(
withLogCollector(async () => {
await expect(secondStore.getSession({})).resolves.toBeUndefined();
}),
).resolves.toMatchObject({
log: [
expect.stringContaining(
'Failed to load session from local storage because it did not conform to the expected schema',
),
],
});
await expect(
withLogCollector(async () => {
await secondStore.setSession('no' as any);
}),
).resolves.toMatchObject({
warn: [
expect.stringContaining(
'Failed to save session to local storage because it did not conform to the expected schema',
),
],
});
});
});