-
Notifications
You must be signed in to change notification settings - Fork 19
/
index.ts
296 lines (252 loc) · 8.52 KB
/
index.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
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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
import fs = require('fs');
import path = require('path-posix');
import symlinkOrCopy = require('symlink-or-copy');
import Logger = require('heimdalljs-logger');
import Entry, { DefaultEntry, BaseEntry } from './entry';
import {
sortAndExpand,
validateSortedUnique
} from './util';
declare namespace FSTree {
export type Operand = 'unlink' | 'rmdir' | 'create' | 'change' | 'mkdir';
export type Operation = [Operand, string, DefaultEntry ] | [ Operand, string];
export type Patch = Operation[];
export type Entry = import('./entry').DefaultEntry;
export interface Options {
entries?: BaseEntry[],
sortAndExpand?: boolean
}
export interface StaticOptions {
sortAndExpand?: boolean
}
interface PatchDelegate {
unlink?(inputPath: string, outputPath: string, relativePath: string) : void;
rmdir?(inputPath: string, outputPath: string, relativePath: string) : void;
mkdir?(inputPath: string, outputPath: string, relativePath: string) : void;
change?(inputPath: string, outputPath: string, relativePath: string) : void;
create?(inputPath: string, outputPath: string, relativePath: string) : void;
}
}
const logger = Logger('fs-tree-diff:');
const ARBITRARY_START_OF_TIME = 0;
const DEFAULT_DELEGATE: FSTree.PatchDelegate = {
unlink(inputPath: string, outputPath: string, relativePath: string) {
try {
fs.unlinkSync(outputPath);
} catch (e) {
if (typeof e === 'object' && e !== null && e.code === 'ENOENT') {
return;
}
throw e;
}
},
rmdir(inputPath: string, outputPath: string, relativePath: string) {
fs.rmdirSync(outputPath)
},
mkdir(inputPath: string, outputPath: string, relativePath: string) {
fs.mkdirSync(outputPath);
},
change(inputPath: string, outputPath: string, relativePath: string) {
// We no-op if the platform can symlink, because we assume the output path
// is already linked via a prior create operation.
if (symlinkOrCopy.canSymlink) {
return;
}
fs.unlinkSync(outputPath);
symlinkOrCopy.sync(inputPath, outputPath);
},
create(inputPath: string, outputPath: string, relativePath: string) {
symlinkOrCopy.sync(inputPath, outputPath);
}
};
class FSTree<T extends BaseEntry = DefaultEntry> {
entries: T[]
constructor(options: { entries?: T[], sortAndExpand?: boolean } = {}) {
const entries = options.entries || [];
if (options.sortAndExpand) {
sortAndExpand(entries);
} else {
validateSortedUnique(entries);
}
this.entries = entries;
}
static fromPaths(paths: string[], options: FSTree.StaticOptions = {}) {
const entries = paths.map(path => {
return new Entry(path, 0, ARBITRARY_START_OF_TIME);
});
return new this({
entries: entries,
sortAndExpand: options.sortAndExpand,
});
}
static fromEntries<T extends BaseEntry>(entries: T[], options: FSTree.StaticOptions = {}) {
return new this({
entries: entries,
sortAndExpand: options.sortAndExpand,
});
}
get size() {
return this.entries.length;
}
addEntries(entries: T[], options?: FSTree.StaticOptions) {
if (!Array.isArray(entries)) {
throw new TypeError('entries must be an array');
}
if (options !== null && typeof options === 'object' && options.sortAndExpand) {
sortAndExpand(entries);
} else {
validateSortedUnique(entries);
}
let fromIndex = 0;
let toIndex = 0;
while (fromIndex < entries.length) {
while (toIndex < this.entries.length &&
this.entries[toIndex].relativePath < entries[fromIndex].relativePath) {
toIndex++;
}
if (toIndex < this.entries.length &&
this.entries[toIndex].relativePath === entries[fromIndex].relativePath) {
this.entries.splice(toIndex, 1, entries[fromIndex++]);
} else {
this.entries.splice(toIndex++, 0, entries[fromIndex++]);
}
}
}
addPaths(paths: string[], options?: FSTree.StaticOptions) {
const entries = paths.map(path => {
// TODO:
// addPths + a custom isEqual comparator + custom Entry types are actually incompatible
// As a addPaths will not abide by the custom Entry type
// and will make this.entries be contain a mixture of types.
// isEqual's arguments will then be typed incorrectly
//
// We should likely just deprecate `addPaths` in-favor of addEntries,
// which correctly externalizes the creation of entry
return new Entry(path, 0, ARBITRARY_START_OF_TIME) as T;
});
this.addEntries(entries, options);
}
forEach(fn: (entry: T, index: number, collection: T[]) => void, context: any) {
this.entries.forEach(fn, context);
}
calculatePatch<K extends BaseEntry>(theirFSTree: FSTree<K>, isEqual?: (a: T, b: K) => boolean): FSTree.Patch {
if (arguments.length > 1 && typeof isEqual !== 'function') {
throw new TypeError('calculatePatch\'s second argument must be a function');
}
// TODO: the TS here is strange
if (typeof isEqual !== 'function') {
isEqual = (this.constructor as typeof FSTree).defaultIsEqual;
}
const ours = this.entries;
const theirs = theirFSTree.entries;
const additions: FSTree.Patch = [];
const removals: FSTree.Patch = [];
let i = 0;
let j = 0;
let command;
while (i < ours.length && j < theirs.length) {
let x = ours[i];
let y = theirs[j];
if (x.relativePath < y.relativePath) {
// ours
i++;
removals.push(removeOperation(x));
// remove additions
} else if (x.relativePath > y.relativePath) {
// theirs
j++;
additions.push(addOperation(y));
} else {
if (!isEqual(x, y)) {
command = updateOperation(y);
if (x.isDirectory()) {
removals.push(command);
} else {
additions.push(command);
}
}
// both are the same
i++; j++;
}
}
// cleanup ours
for (; i < ours.length; i++) {
removals.push(removeOperation(ours[i]));
}
// cleanup theirs
for (; j < theirs.length; j++) {
additions.push(addOperation(theirs[j]));
}
return removals.reverse().concat(additions);
}
calculateAndApplyPatch(otherFSTree: FSTree<T>, input: string, output: string, delegate?: FSTree.PatchDelegate) {
(this.constructor as typeof FSTree).applyPatch(input, output, this.calculatePatch(otherFSTree), delegate);
}
static defaultIsEqual(entryA: DefaultEntry, entryB: DefaultEntry) {
if (entryA.isDirectory() && entryB.isDirectory()) {
// ignore directory changes by default
return true;
}
let equal;
if (entryA.size === entryB.size && entryA.mode === entryB.mode) {
if (entryA.mtime === entryB.mtime) {
equal = true;
} else if (entryA.mtime === undefined || entryB.mtime === undefined) {
equal = false;
} else if (+entryA.mtime === +entryB.mtime) {
equal = true;
} else {
equal = false;
}
} else {
equal = false;
}
if (equal === false) {
logger.info('invalidation reason: \nbefore %o\n entryB %o', entryA, entryB);
}
return equal;
}
static applyPatch(input: string, output: string, patch: FSTree.Patch, _delegate?: FSTree.PatchDelegate) {
const delegate = {
...DEFAULT_DELEGATE,
..._delegate
};
for (let i = 0; i < patch.length; i++) {
applyOperation(input, output, patch[i], delegate);
}
}
}
function applyOperation(input: string, output: string, operation: FSTree.Operation, delegate: FSTree.PatchDelegate) {
const methodName = operation[0];
const relativePath = operation[1];
const inputPath = path.join(input, relativePath);
const outputPath = path.join(output, relativePath);
const method = delegate[methodName];
if (typeof method === 'function') {
method(inputPath, outputPath, relativePath);
} else {
throw new Error('Unable to apply patch operation: ' + methodName + '. The value of delegate.' + methodName + ' is of type ' + typeof method + ', and not a function. Check the `delegate` argument to `FSTree.prototype.applyPatch`.');
}
}
function addOperation(entry: FSTree.Entry) : FSTree.Operation {
return [
entry.isDirectory() ? 'mkdir' : 'create',
entry.relativePath,
entry
];
}
function removeOperation(entry: FSTree.Entry) : FSTree.Operation {
return [
entry.isDirectory() ? 'rmdir' : 'unlink',
entry.relativePath,
entry
];
}
function updateOperation(entry: FSTree.Entry) : FSTree.Operation {
return [
'change',
entry.relativePath,
entry
];
};
export = FSTree;