/
FileSaver.ts
259 lines (220 loc) · 9.07 KB
/
FileSaver.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
import * as Promise from 'bluebird';
import * as sprequest from 'sp-request';
import {ISPRequest} from 'sp-request';
import * as url from 'url';
import * as _ from 'lodash';
import {IEnvironment, IUserCredentials} from 'sp-request';
import {FileContentOptions, CheckinType} from './SPSaveOptions';
import {UrlHelper} from './../utils/UrlHelper';
import {FoldersCreator} from './../utils/FoldersCreator';
import {ILogger} from './../utils/ILogger';
import {ConsoleLogger} from './../utils/ConsoleLogger';
export class FileSaver {
private static saveConfilctCode: string = '-2130246326';
private static cobaltCode: string = '-1597308888';
private static reUploadTimeout: number = 1500;
private static maxAttempts: number = 3;
private sprequest: ISPRequest;
private uploadFileRestUrl: string;
private getFileRestUrl: string;
private checkoutFileRestUrl: string;
private checkinFileRestUrl: string;
private path: string;
private foldersCreator: FoldersCreator;
private logger: ILogger;
private options: FileContentOptions;
constructor(options: FileContentOptions) {
let creds: IUserCredentials = _.pick<IUserCredentials, FileContentOptions>(options, ['username', 'password']);
let env: IEnvironment = _.pick<IEnvironment, FileContentOptions>(options, ['domain', 'workstation']);
this.sprequest = sprequest.create(creds, env);
this.options = _.defaults<FileContentOptions>(_.assign<{}, FileContentOptions>({}, options), {
checkin: false,
checkinType: 0,
checkinMessage: 'Checked in by spsave',
notification: false
});
this.options.siteUrl = UrlHelper.removeTrailingSlash(this.options.siteUrl);
this.options.folder = UrlHelper.trimSlashes(this.options.folder);
this.path = UrlHelper.removeTrailingSlash(url.parse(this.options.siteUrl).path);
this.foldersCreator = new FoldersCreator(this.sprequest, this.options.folder, this.options.siteUrl);
this.logger = new ConsoleLogger();
this.buildRestUrls();
}
public execute(): Promise<any> {
let requestDeferred: Promise.Resolver<any> = Promise.defer<any>();
this.foldersCreator.createFoldersHierarchy()
.then(() => {
this.saveFile(requestDeferred);
})
.catch(err => {
requestDeferred.reject(err);
});
return requestDeferred.promise;
}
/* saves file in a folder. If save conflict or cobalt error is thrown, tries to reupload file `maxAttempts` times */
private saveFile(requestDeferred: Promise.Resolver<any>, attempts: number = 1): void {
if (attempts > FileSaver.maxAttempts) {
let message: string = `File '${this.options.fileName}' probably is not uploaded: too many errors. Upload process interrupted.`;
this.logger.error(message);
requestDeferred.reject(new Error(message));
return;
}
/* checkout file (only if option checkin provided) */
let checkoutResult: Promise<boolean> = this.checkoutFile();
let uploadResult: Promise<any> =
checkoutResult
.then(() => {
/* upload file to folder */
return this.sprequest.requestDigest(this.options.siteUrl)
.then(digest => {
return this.sprequest.post(this.uploadFileRestUrl, {
headers: {
'X-RequestDigest': digest
},
body: this.options.fileContent,
json: false
});
});
});
Promise.join(checkoutResult, uploadResult, (fileExists, data) => {
/* checkin file if checkin options presented */
if (this.options.checkin && fileExists) {
return this.checkinFile();
/* if this is the first upload and we need to checkin the file, explicitly trigger checkin by uploading once again */
} else if (this.options.checkin && !fileExists) {
this.saveFile(requestDeferred, attempts + 1);
return undefined;
} else {
this.logger.success(this.options.fileName + ` successfully uploaded to '${this.options.siteUrl}/${this.options.folder}'`);
}
requestDeferred.resolve(JSON.parse(data.body));
return undefined;
}).then(data => {
if (!data) {
return;
}
if (requestDeferred.promise.isPending()) {
this.logger.success(this.options.fileName +
` successfully uploaded to '${this.options.siteUrl}/${this.options.folder}' and checked in.` +
` Checkin type: ${CheckinType[this.options.checkinType]}`);
requestDeferred.resolve(data.body);
}
})
.catch(err => {
if (err && (err.statusCode === 500 || err.statusCode === 409)) { /* save conflict or cobalt error */
this.tryReUpload(err, requestDeferred, attempts);
return;
}
requestDeferred.reject(err);
});
}
/* checkins files */
private checkinFile(): Promise<any> {
let requestDeferred: Promise.Resolver<any> = Promise.defer<any>();
this.sprequest.requestDigest(this.options.siteUrl)
.then(digest => {
return this.sprequest.post(this.checkinFileRestUrl, {
headers: {
'X-RequestDigest': digest
}
});
})
.then(data => {
requestDeferred.resolve(data);
})
.catch(err => {
requestDeferred.reject(err);
});
return requestDeferred.promise;
}
/* tries to checkout file. returns true if file exists or false if doesn't */
private checkoutFile(): Promise<boolean> {
let requestDeferred: Promise.Resolver<boolean> = Promise.defer<boolean>();
/* if checkin option isn't provided, just resolve to true and return */
if (!this.options.checkin) {
requestDeferred.resolve(true);
return requestDeferred.promise;
}
this.getFileByUrl()
.then(data => {
/* if already checked out, resolve to true */
if (data.body.d.CheckOutType === 0) {
requestDeferred.resolve(true);
return undefined;
}
/* not checked out yet, so checkout */
return this.sprequest.requestDigest(this.options.siteUrl)
.then(digest => {
return this.sprequest.post(this.checkoutFileRestUrl, {
headers: {
'X-RequestDigest': digest
}
});
});
}, err => {
/* file doesn't exist message code, resolve with false */
if (err.message.indexOf('-2146232832') !== 0) {
requestDeferred.resolve(false);
return undefined;
}
requestDeferred.reject(err);
return undefined;
})
.then(data => {
if (requestDeferred.promise.isPending()) {
this.logger.info(`${this.options.fileName} checked out.`);
requestDeferred.resolve(true);
}
})
.catch(err => {
requestDeferred.reject(err);
});
return requestDeferred.promise;
}
private getFileByUrl(): Promise<any> {
return this.sprequest.get(this.getFileRestUrl);
}
/* check if error is save conflict or cobalt error and tries to reupload the file, otherwise reject deferred */
private tryReUpload(exception: any, deferred: Promise.Resolver<any>, attempts: number): void {
let errorData: any;
try {
errorData = JSON.parse(exception.error);
} catch (e) {
deferred.reject(exception);
return;
}
let reUpload: () => void = (): void => {
setTimeout(() => {
this.saveFile(deferred, attempts + 1);
}, FileSaver.reUploadTimeout);
};
if (errorData.error) {
if (errorData.error.code && errorData.error.code.indexOf(FileSaver.saveConfilctCode) === 0) {
this.logger.warning(`Save conflict detected for file '${this.options.fileName}'. Trying to re-upload...`);
reUpload();
} else if (errorData.error.code && errorData.error.code.indexOf(FileSaver.cobaltCode) === 0) {
this.logger.warning(`Cobalt error detected for file '${this.options.fileName}'. Trying to re-upload...`);
reUpload();
} else {
this.logger.error(errorData.error);
deferred.reject(exception);
}
} else {
deferred.reject(exception);
}
}
private buildRestUrls(): void {
let fileServerRelativeUrl: string = `${this.path}/${this.options.folder}/${this.options.fileName}`;
this.uploadFileRestUrl = this.options.siteUrl +
'/_api/web/GetFolderByServerRelativeUrl(@FolderName)/Files/add(url=@FileName,overwrite=true)' +
`?@FolderName='${encodeURIComponent(this.options.folder)}'&@FileName='${encodeURIComponent(this.options.fileName)}'`;
this.getFileRestUrl = this.options.siteUrl + '/_api/web/GetFileByServerRelativeUrl(@FileUrl)' +
`?@FileUrl='${encodeURIComponent(fileServerRelativeUrl)}'`;
this.checkoutFileRestUrl = this.options.siteUrl + '/_api/web/GetFileByServerRelativeUrl(@FileUrl)/CheckOut()' +
`?@FileUrl='${encodeURIComponent(fileServerRelativeUrl)}'`;
this.checkinFileRestUrl = this.options.siteUrl +
'/_api/web/GetFileByServerRelativeUrl(@FileUrl)/CheckIn(comment=@Comment,checkintype=@Type)' +
`?@FileUrl='${encodeURIComponent(fileServerRelativeUrl)}'&@Comment='${(this.options.checkinMessage)}'` +
`&@Type='${this.options.checkinType}'`;
}
}