forked from firefox-devtools/profiler
-
Notifications
You must be signed in to change notification settings - Fork 0
/
zipped-profiles.js
226 lines (216 loc) · 6.87 KB
/
zipped-profiles.js
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
// @flow
import { combineReducers } from 'redux';
import { oneLine } from 'common-tags';
import { ensureExists } from '../utils/flow';
import * as ZipFiles from '../profile-logic/zip-files';
import type {
ZipFileState,
Reducer,
ZippedProfilesState,
} from 'firefox-profiler/types';
/**
* This reducer contains all of the state that deals with loading in profiles from
* zip files.
*/
const zipFile: Reducer<ZipFileState> = (
state = {
phase: 'NO_ZIP_FILE',
zip: null,
pathInZipFile: null,
},
action
) => {
switch (action.type) {
case 'UPDATE_URL_STATE': {
if (
action.newUrlState &&
action.newUrlState.pathInZipFile === null &&
state.phase === 'VIEW_PROFILE_IN_ZIP_FILE'
) {
// When the back button is hit on the browser, the UrlState can update, but
// the state of the zip file viewer can be out of date. In this case, make
// sure and revert the state back to LIST_FILES_IN_ZIP_FILE rather than
// VIEW_PROFILE_IN_ZIP_FILE. Otherwise the zip file viewer will try and
// display a profile that does not exist.
return _validateStateTransition(state, {
phase: 'LIST_FILES_IN_ZIP_FILE',
zip: state.zip,
pathInZipFile: null,
});
}
return state;
}
case 'RECEIVE_ZIP_FILE':
return _validateStateTransition(state, {
phase: 'LIST_FILES_IN_ZIP_FILE',
zip: action.zip,
pathInZipFile: null,
});
case 'RETURN_TO_ZIP_FILE_LIST':
case 'DISMISS_PROCESS_PROFILE_FROM_ZIP_ERROR':
return _validateStateTransition(state, {
phase: 'LIST_FILES_IN_ZIP_FILE',
zip: ensureExists(state.zip),
pathInZipFile: null,
});
case 'PROCESS_PROFILE_FROM_ZIP_FILE':
return _validateStateTransition(state, {
phase: 'PROCESS_PROFILE_FROM_ZIP_FILE',
zip: ensureExists(state.zip),
pathInZipFile: action.pathInZipFile,
});
case 'FILE_NOT_FOUND_IN_ZIP_FILE':
return _validateStateTransition(state, {
phase: 'FILE_NOT_FOUND_IN_ZIP_FILE',
zip: ensureExists(state.zip),
pathInZipFile: action.pathInZipFile,
});
case 'FAILED_TO_PROCESS_PROFILE_FROM_ZIP_FILE':
return _validateStateTransition(state, {
phase: 'FAILED_TO_PROCESS_PROFILE_FROM_ZIP_FILE',
zip: ensureExists(state.zip),
pathInZipFile: ensureExists(state.pathInZipFile),
});
case 'FATAL_ERROR':
return state.phase === 'NO_ZIP_FILE' ||
state.phase === 'LIST_FILES_IN_ZIP_FILE'
? state
: _validateStateTransition(state, {
phase: 'FAILED_TO_PROCESS_PROFILE_FROM_ZIP_FILE',
zip: ensureExists(state.zip),
pathInZipFile: ensureExists(state.pathInZipFile),
});
case 'VIEW_ORIGINS_PROFILE':
case 'VIEW_FULL_PROFILE':
case 'VIEW_ACTIVE_TAB_PROFILE':
// Only process this as a change if a zip file is actually loaded.
return state.phase === 'NO_ZIP_FILE'
? state
: _validateStateTransition(state, {
phase: 'VIEW_PROFILE_IN_ZIP_FILE',
zip: ensureExists(state.zip),
pathInZipFile: ensureExists(state.pathInZipFile),
});
case 'PROFILE_PUBLISHED':
case 'SANITIZED_PROFILE_PUBLISHED':
case 'WAITING_FOR_PROFILE_FROM_FILE':
// Revert back to not having a zip file.
return {
phase: 'NO_ZIP_FILE',
zip: null,
pathInZipFile: null,
};
default:
return state;
}
};
const error: Reducer<null | Error> = (state = null, action) => {
switch (action.type) {
case 'FAILED_TO_PROCESS_PROFILE_FROM_ZIP_FILE':
case 'FATAL_ERROR':
return action.error;
default:
return state;
}
};
/**
* This function ensures that the state transitions are logical and make sense. The
* switch statement provides a mapping of what states are valid to transition to from
* a previous state. A switch is used rather than an object in order to make it easier
* to exhaustively check with Flow.
*/
function _validateStateTransition(
prev: ZipFileState,
next: ZipFileState
): ZipFileState {
const prevPhase = prev.phase;
if (prevPhase === next.phase) {
return next;
}
let expectedNextPhases;
switch (prevPhase) {
case 'NO_ZIP_FILE':
expectedNextPhases = [
// Coming into a fresh page load with a zip file, this is the first state
// transition.
'LIST_FILES_IN_ZIP_FILE',
// This will happen if coming in from a URL that is already pointing at a file
// in a zip.
'PROCESS_PROFILE_FROM_ZIP_FILE',
];
break;
case 'LIST_FILES_IN_ZIP_FILE':
expectedNextPhases = [
'PROCESS_PROFILE_FROM_ZIP_FILE',
'FILE_NOT_FOUND_IN_ZIP_FILE',
];
break;
case 'PROCESS_PROFILE_FROM_ZIP_FILE':
expectedNextPhases = [
'VIEW_PROFILE_IN_ZIP_FILE',
'FAILED_TO_PROCESS_PROFILE_FROM_ZIP_FILE',
// When navigating with the URL, it's possible to go back and list the files.
'LIST_FILES_IN_ZIP_FILE',
];
break;
case 'FILE_NOT_FOUND_IN_ZIP_FILE':
expectedNextPhases = ['LIST_FILES_IN_ZIP_FILE'];
break;
case 'FAILED_TO_PROCESS_PROFILE_FROM_ZIP_FILE':
expectedNextPhases = ['LIST_FILES_IN_ZIP_FILE'];
break;
case 'VIEW_PROFILE_IN_ZIP_FILE':
expectedNextPhases = ['LIST_FILES_IN_ZIP_FILE'];
break;
default:
throw new Error(`Unhandled ZipFileState “${(prevPhase: empty)}”`);
}
if (!expectedNextPhases.includes(next.phase)) {
console.error('Previous ZipFileState:', prev);
console.error('Next ZipFileState:', next);
throw new Error(oneLine`
Attempted to transition the ZipFileState from the phase “${prev.phase}”
to “${next.phase}”, however “${prev.phase}” can only transition to
“${expectedNextPhases.join('”, “')}”.
`);
}
return next;
}
const selectedZipFileIndex: Reducer<null | ZipFiles.IndexIntoZipFileTable> = (
state = null,
action
) => {
switch (action.type) {
case 'CHANGE_SELECTED_ZIP_FILE': {
return action.selectedZipFileIndex;
}
default:
return state;
}
};
const expandedZipFileIndexes: Reducer<
Array<ZipFiles.IndexIntoZipFileTable | null>,
> = (
// In practice this should never contain null, but needs to support the
// TreeView interface.
state = [],
action
) => {
switch (action.type) {
case 'CHANGE_EXPANDED_ZIP_FILES': {
return action.expandedZipFileIndexes;
}
default:
return state;
}
};
const zipFileReducer: Reducer<ZippedProfilesState> = combineReducers({
zipFile,
error,
selectedZipFileIndex,
expandedZipFileIndexes,
});
export default zipFileReducer;