-
Notifications
You must be signed in to change notification settings - Fork 88
/
b00_breeze.dataService.odata.js
502 lines (445 loc) · 17.8 KB
/
b00_breeze.dataService.odata.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
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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
(function (factory) {
if (typeof breeze === "object") {
factory(breeze);
} else if (typeof require === "function" && typeof exports === "object" && typeof module === "object") {
// CommonJS or Node: hard-coded dependency on "breeze-client"
factory(require("breeze-client"));
} else if (typeof define === "function" && define["amd"]) {
// AMD anonymous module with hard-coded dependency on "breeze-client"
define(["breeze-client"], factory);
}
}(function (breeze) {
"use strict";
var core = breeze.core;
var MetadataStore = breeze.MetadataStore;
var JsonResultsAdapter = breeze.JsonResultsAdapter;
var DataProperty = breeze.DataProperty;
var DataType = breeze.DataType;
var AutoGeneratedKeyType = breeze.AutoGeneratedKeyType;
var OData;
var ctor = function DataServiceODataAdapter() {
this.name = "OData";
};
var proto = ctor.prototype; // minifies better (as seen in jQuery)
proto.initialize = function () {
OData = core.requireLib("OData", "Needed to support remote OData services");
OData.jsonHandler.recognizeDates = true;
};
// borrow from AbstractDataServiceAdapter
var abstractDsaProto = breeze.AbstractDataServiceAdapter.prototype;
proto._catchNoConnectionError = abstractDsaProto._catchNoConnectionError;
proto.changeRequestInterceptor = abstractDsaProto.changeRequestInterceptor;
proto._createChangeRequestInterceptor = abstractDsaProto._createChangeRequestInterceptor;
proto.headers = { "DataServiceVersion": "2.0" };
// Absolute URL is the default as of Breeze 1.5.5.
// To use relative URL (like pre-1.5.5), add adapterInstance.relativeUrl = true:
//
// var ds = breeze.config.initializeAdapterInstance("dataService", "webApiOData");
// ds.relativeUrl = true;
//
// To use custom url construction, add adapterInstance.relativeUrl = myfunction(dataService, url):
//
// var ds = breeze.config.initializeAdapterInstance("dataService", "webApiOData");
// ds.relativeUrl = function(dataService, url) {
// return somehowConvert(url);
// }
//
proto.getAbsoluteUrl = function (dataService, url){
var serviceName = dataService.qualifyUrl('');
// only prefix with serviceName if not already on the url
var base = (core.stringStartsWith(url, serviceName)) ? '' : serviceName;
// If no protocol, turn base into an absolute URI
if (window && serviceName.indexOf('//') < 0) {
// no protocol; make it absolute
base = window.location.protocol + '//' + window.location.host +
(core.stringStartsWith(serviceName, '/') ? '' : '/') +
base;
}
return base + url;
};
proto.getRoutePrefix = function (dataService) {
// Get the routePrefix from a Web API OData service name.
// The routePrefix is presumed to be the pathname within the dataService.serviceName
// Examples of servicename -> routePrefix:
// 'http://localhost:55802/odata/' -> 'odata/'
// 'http://198.154.121.75/service/odata/' -> 'service/odata/'
var parser;
if (typeof document === 'object') { // browser
parser = document.createElement('a');
parser.href = dataService.serviceName;
} else { // node
parser = url.parse(dataService.serviceName);
}
var prefix = parser.pathname;
if (prefix[0] === '/') {
prefix = prefix.substr(1);
} // drop leading '/' (all but IE)
if (prefix.substr(-1) !== '/') {
prefix += '/';
} // ensure trailing '/'
return prefix;
};
// crude serializer. Doesn't recurse
function toQueryString(obj) {
var parts = [];
for (var i in obj) {
if (obj.hasOwnProperty(i)) {
parts.push(encodeURIComponent(i) + "=" + encodeURIComponent(obj[i]));
}
}
return parts.join("&");
}
proto.executeQuery = function (mappingContext) {
var deferred = breeze.Q.defer();
var url;
if (this.relativeUrl === true) {
url = mappingContext.getUrl();
} else if (core.isFunction(this.relativeUrl)) {
url = this.relativeUrl(mappingContext.dataService, mappingContext.getUrl());
} else {
url = this.getAbsoluteUrl(mappingContext.dataService, mappingContext.getUrl());
}
// Add query params if .withParameters was used
if (!core.isEmpty(mappingContext.query.parameters)) {
var paramString = toQueryString(mappingContext.query.parameters);
var sep = url.indexOf("?") < 0 ? "?" : "&";
url = url + sep + paramString;
}
OData.read({
requestUri: url,
headers: core.extend({}, this.headers)
},
function (data, response) {
var inlineCount;
if (data.__count) {
// OData can return data.__count as a string
inlineCount = parseInt(data.__count, 10);
}
// Odata returns different result structure when it returns multiple entities (data.results) vs single entity (data directly).
// @see http://www.odata.org/documentation/odata-version-2-0/json-format/#RepresentingCollectionsOfEntries
// and http://www.odata.org/documentation/odata-version-2-0/json-format/#RepresentingEntries
var results;
if (data.results) {
results = data.results;
} else {
results = data;
}
return deferred.resolve({ results: results, inlineCount: inlineCount, httpResponse: response });
},
function (error) {
return deferred.reject(createError(error, url));
}
);
return deferred.promise;
};
proto.fetchMetadata = function (metadataStore, dataService) {
var deferred = breeze.Q.defer();
var serviceName = dataService.serviceName;
var url;
if (this.relativeUrl === true) {
url = dataService.qualifyUrl('$metadata');
} else if (core.isFunction(this.relativeUrl)) {
url = this.relativeUrl(dataService, '$metadata');
} else {
url = this.getAbsoluteUrl(dataService, '$metadata');
}
var mheaders = core.extend({}, this.headers);
mheaders.Accept = 'application/*; odata.metadata=full';
// OData.read(url,
OData.read({
requestUri: url,
// headers: { "Accept": "application/json"}
headers: mheaders
},
function (data) {
// data.dataServices.schema is an array of schemas. with properties of
// entityContainer[], association[], entityType[], and namespace.
if (!data || !data.dataServices) {
var error = new Error("Metadata query failed for: " + url);
return deferred.reject(error);
}
var csdlMetadata = data.dataServices;
// might have been fetched by another query
if (!metadataStore.hasMetadataFor(serviceName)) {
try {
metadataStore.importMetadata(csdlMetadata);
} catch (e) {
return deferred.reject(new Error("Metadata query failed for " + url + "; Unable to process returned metadata: " + e.message));
}
metadataStore.addDataService(dataService);
}
return deferred.resolve(csdlMetadata);
}, function (error) {
var err = createError(error, url);
err.message = "Metadata query failed for: " + url + "; " + (err.message || "");
return deferred.reject(err);
},
OData.metadataHandler
);
return deferred.promise;
};
proto.saveChanges = function (saveContext, saveBundle) {
var adapter = saveContext.adapter = this;
var deferred = breeze.Q.defer();
var url;
if (this.relativeUrl === true) {
saveContext.routePrefix = adapter.getRoutePrefix(saveContext.dataService);
url = saveContext.dataService.qualifyUrl("$batch");
} else if (core.isFunction(adapter.relativeUrl)) {
saveContext.routePrefix = adapter.relativeUrl(saveContext.dataService, '');
url = saveContext.routePrefix + '$batch';
} else {
saveContext.routePrefix = adapter.getAbsoluteUrl(saveContext.dataService, '');
url = saveContext.routePrefix + '$batch';
}
var requestData = createChangeRequests(saveContext, saveBundle);
var tempKeys = saveContext.tempKeys;
var contentKeys = saveContext.contentKeys;
OData.request({
headers: core.extend({}, this.headers),
requestUri: url,
method: "POST",
data: requestData
}, function (data, response) {
var entities = [];
var keyMappings = [];
var saveResult = { entities: entities, keyMappings: keyMappings };
data.__batchResponses.forEach(function (br) {
br.__changeResponses.forEach(function (cr) {
var response = cr.response || cr;
var statusCode = response.statusCode;
if ((!statusCode) || statusCode >= 400) {
deferred.reject(createError(cr, url));
return;
}
var contentId = cr.headers["Content-ID"];
// Olingo sends different case of 'ID' for the header name.
if (!contentId) {
contentId = cr.headers["Content-Id"];
}
var rawEntity = cr.data;
if (rawEntity) {
var tempKey = tempKeys[contentId];
if (tempKey) {
var entityType = tempKey.entityType;
if (entityType.autoGeneratedKeyType !== AutoGeneratedKeyType.None) {
var tempValue = tempKey.values[0];
var realKey = entityType.getEntityKeyFromRawEntity(rawEntity, DataProperty.getRawValueFromServer);
var keyMapping = { entityTypeName: entityType.name, tempValue: tempValue, realValue: realKey.values[0] };
keyMappings.push(keyMapping);
}
}
entities.push(rawEntity);
} else {
var origEntity = contentKeys[contentId];
entities.push(origEntity);
}
});
});
return deferred.resolve(saveResult);
}, function (err) {
return deferred.reject(createError(err, url));
}, OData.batchHandler);
return deferred.promise;
};
proto.jsonResultsAdapter = new JsonResultsAdapter({
name: "OData_default",
visitNode: function (node, mappingContext, nodeContext) {
var result = {};
if (node == null) return result;
var metadata = node.__metadata;
if (metadata != null) {
// TODO: may be able to make this more efficient by caching of the previous value.
var entityTypeName = MetadataStore.normalizeTypeName(metadata.type);
var et = entityTypeName && mappingContext.entityManager.metadataStore.getEntityType(entityTypeName, true);
// OData response doesn't distinguish a projection from a whole entity.
// We'll assume that whole-entity data would have at least as many properties (<=)
// as the EntityType has mapped properties on the basis that
// most projections remove properties rather than add them.
// If not, assume it's a projection and do NOT treat as an entity
if (et && et._mappedPropertiesCount <= Object.keys(node).length - 1) {
// if (et && et._mappedPropertiesCount === Object.keys(node).length - 1) { // OLD
result.entityType = et;
var uriKey = metadata.uri || metadata.id;
if (uriKey) {
// Strip baseUri to make uriKey a relative uri
// Todo: why is this necessary when absolute works for every OData source tested?
var re = new RegExp('^' + mappingContext.dataService.serviceName, 'i');
uriKey = uriKey.replace(re, '');
}
result.extraMetadata = {
uriKey: uriKey,
etag: metadata.etag
}
}
}
// OData v3 - projection arrays will be enclosed in a results array
if (node.results) {
result.node = node.results;
}
var propertyName = nodeContext.propertyName;
result.ignore = node.__deferred != null || propertyName === "__metadata" ||
// EntityKey properties can be produced by EDMX models
(propertyName === "EntityKey" && node.$type && core.stringStartsWith(node.$type, "System.Data"));
return result;
}
});
function transformValue(prop, val) {
if (prop.isUnmapped) return undefined;
if (prop.dataType === DataType.DateTimeOffset) {
// The datajs lib tries to treat client dateTimes that are defined as DateTimeOffset on the server differently
// from other dateTimes. This fix compensates before the save.
val = val && new Date(val.getTime() - (val.getTimezoneOffset() * 60000));
} else if (prop.dataType.quoteJsonOData) {
val = val != null ? val.toString() : val;
}
return val;
}
function createChangeRequests(saveContext, saveBundle) {
var changeRequestInterceptor = saveContext.adapter._createChangeRequestInterceptor(saveContext, saveBundle);
var changeRequests = [];
var tempKeys = [];
var contentKeys = [];
var entityManager = saveContext.entityManager;
var helper = entityManager.helper;
var id = 0;
var routePrefix = saveContext.routePrefix;
saveBundle.entities.forEach(function (entity, index) {
var aspect = entity.entityAspect;
id = id + 1; // we are deliberately skipping id=0 because Content-ID = 0 seems to be ignored.
var request = { headers: { "Content-ID": id, "DataServiceVersion": "2.0" } };
contentKeys[id] = entity;
if (aspect.entityState.isAdded()) {
request.requestUri = routePrefix + entity.entityType.defaultResourceName;
request.method = "POST";
request.data = helper.unwrapInstance(entity, transformValue);
tempKeys[id] = aspect.getKey();
} else if (aspect.entityState.isModified()) {
updateDeleteMergeRequest(request, aspect, routePrefix);
request.method = "MERGE";
request.data = helper.unwrapChangedValues(entity, entityManager.metadataStore, transformValue);
// should be a PATCH/MERGE
} else if (aspect.entityState.isDeleted()) {
updateDeleteMergeRequest(request, aspect, routePrefix);
request.method = "DELETE";
} else {
return;
}
request = changeRequestInterceptor.getRequest(request, entity, index);
changeRequests.push(request);
});
saveContext.contentKeys = contentKeys;
saveContext.tempKeys = tempKeys;
changeRequestInterceptor.done(changeRequests);
return {
__batchRequests: [
{
__changeRequests: changeRequests
}
]
};
}
function updateDeleteMergeRequest(request, aspect, routePrefix) {
var uriKey;
var extraMetadata = aspect.extraMetadata;
if (extraMetadata == null) {
uriKey = getUriKey(aspect);
aspect.extraMetadata = {
uriKey: uriKey
}
} else {
uriKey = extraMetadata.uriKey;
if (extraMetadata.etag) {
request.headers["If-Match"] = extraMetadata.etag;
}
}
request.requestUri =
// use routePrefix if uriKey lacks protocol (i.e., relative uri)
uriKey.indexOf('//') > 0 ? uriKey : routePrefix + uriKey;
}
function getUriKey(aspect) {
var entityType = aspect.entity.entityType;
var resourceName = entityType.defaultResourceName;
var kps = entityType.keyProperties;
var uriKey = resourceName + "(";
if (kps.length === 1) {
uriKey = uriKey + fmtProperty(kps[0], aspect) + ")";
} else {
var delim = "";
kps.forEach(function (kp) {
uriKey = uriKey + delim + kp.nameOnServer + "=" + fmtProperty(kp, aspect);
delim = ",";
});
uriKey = uriKey + ")";
}
return uriKey;
}
function fmtProperty(prop, aspect) {
return prop.dataType.fmtOData(aspect.getPropertyValue(prop.name));
}
function createError(error, url) {
// OData errors can have the message buried very deeply - and nonobviously
// this code is tricky so be careful changing the response.body parsing.
var result = new Error();
var response = error && error.response;
if (!response) {
// in case DataJS returns "No handler for this data"
result.message = error;
result.statusText = error;
return result;
}
result.message = response.statusText;
result.statusText = response.statusText;
result.status = response.statusCode;
// non std
if (url) result.url = url;
result.body = response.body;
if (response.body) {
var nextErr;
try {
var body = JSON.parse(response.body);
result.body = body;
// OData v3 logic
if (body['odata.error']) {
body = body['odata.error'];
}
var msg = "";
do {
nextErr = body.error || body.innererror;
if (!nextErr) msg = msg + getMessage(body);
nextErr = nextErr || body.internalexception;
body = nextErr || body;
} while (nextErr);
if (msg.length > 0) {
result.message = msg;
}
} catch (e) {
}
}
proto._catchNoConnectionError(result);
return result;
}
function getMessage(body) {
var msg = body.message || "";
return ((typeof (msg) === "string") ? msg : msg.value) + "; ";
}
breeze.config.registerAdapter("dataService", ctor);
var webApiODataCtor = function () {
this.name = "webApiOData";
}
breeze.core.extend(webApiODataCtor.prototype, proto);
breeze.config.registerAdapter("dataService", webApiODataCtor);
// OData 4 adapter
var webApiOData4Ctor = function () {
this.name = "webApiOData4";
}
breeze.core.extend(webApiOData4Ctor.prototype, webApiODataCtor.prototype);
webApiOData4Ctor.prototype.initialize = function () {
// Aargh... they moved the cheese.
var datajs = core.requireLib("datajs", "Needed to support remote OData v4 services");
OData = datajs.V4.oData;
OData.json.jsonHandler.recognizeDates = true;
};
webApiOData4Ctor.prototype.headers = { "OData-Version": "4.0" };
breeze.config.registerAdapter("dataService", webApiOData4Ctor);
}));