Skip to content

Commit f69059c

Browse files
uttamukkojiuttamukkoji
committed
Merge remote-tracking branch 'origin/feature/adding-debugging-options' into bugs/live-preview-error
2 parents f5df9fd + cc9c309 commit f69059c

File tree

5 files changed

+47
-34
lines changed

5 files changed

+47
-34
lines changed

‎src/core/lib/request.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,15 +89,17 @@ function fetchRetry(url, headers, fetchOptions, resolve, reject, retryDelay = 30
8989
})
9090
}
9191
}
92+
fetchOptions.logHandler('info', { url: url, option: option});
9293
fetch(url, option)
9394
.then(function(response) {
95+
fetchOptions.logHandler('info', response);
9496
let data = response.json();
9597
if (response.ok && response.status === 200) {
9698
resolve(data);
9799
} else {
98100
data.then((json) => {
99101
if (fetchOptions.retryCondition && fetchOptions.retryCondition(response)) {
100-
onError(json)
102+
onError(json)
101103
} else {
102104
reject(json)
103105
}
@@ -106,6 +108,7 @@ function fetchRetry(url, headers, fetchOptions, resolve, reject, retryDelay = 30
106108
});
107109
}
108110
}).catch((error) => {
111+
fetchOptions.logHandler('error', error);
109112
reject(error)
110113
});
111114
}

‎src/core/modules/assets.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ export default class Assets {
7575
this._query[key] = value;
7676
return this;
7777
} else {
78-
console.error("Kindly provide a valid parameters.");
78+
this.fetchOptions.logHandler('error',"Kindly provide a valid parameters.");
7979
}
8080
}
8181

@@ -119,7 +119,7 @@ export default class Assets {
119119
var options = Utils.mergeDeep(this.fetchOptions, fetchOptions);
120120
return Utils.sendRequest(Utils.mergeDeep({}, this), options);
121121
} else {
122-
console.error("Kindly provide an asset uid. e.g. .Assets('asset_uid')");
122+
fetchOptions.logHandler('error', "Kindly provide an asset uid. e.g. .Assets('asset_uid')");
123123
}
124124
}
125125
}

‎src/core/modules/entry.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ export default class Entry {
8383
this.queryCachePolicy = policy;
8484
}
8585
} else {
86-
console.error("Kindly provide the valid policy");
86+
this.fetchOptions.logHandler('error', "Kindly provide the valid policy");
8787
}
8888
return this;
8989
}
@@ -135,7 +135,7 @@ export default class Entry {
135135
}
136136
return this;
137137
} else {
138-
console.error("Argument should be a String or an Array.");
138+
this.fetchOptions.logHandler('error', "Argument should be a String or an Array.");
139139
}
140140
}
141141

@@ -160,7 +160,7 @@ export default class Entry {
160160
this._query['locale'] = language_code;
161161
return this;
162162
} else {
163-
console.error("Argument should be a String.");
163+
this.fetchOptions.logHandler('error', "Argument should be a String.");
164164
}
165165
}
166166

@@ -179,7 +179,7 @@ export default class Entry {
179179
this._query[key] = value;
180180
return this;
181181
} else {
182-
console.error("First argument should be a String.");
182+
this.fetchOptions.logHandler('error', "First argument should be a String.");
183183
}
184184
}
185185

@@ -323,7 +323,7 @@ export default class Entry {
323323
this._query[key] = value;
324324
return this;
325325
} else {
326-
console.error("Kindly provide valid parameters.");
326+
this.fetchOptions.logHandler('error', "Kindly provide valid parameters.");
327327
}
328328
}
329329

@@ -360,7 +360,7 @@ export default class Entry {
360360
var options = Utils.mergeDeep(this.fetchOptions, fetchOptions);
361361
return Utils.sendRequest(Utils.mergeDeep({}, this), options);
362362
} else {
363-
console.error("Kindly provide an entry uid. e.g. .Entry('asset_uid')");
363+
this.fetchOptions.logHandler('error', "Kindly provide an entry uid. e.g. .Entry('asset_uid')");
364364
}
365365
}
366366
}

‎src/core/modules/query.js

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ const _extend = {
99
this._query['query'][key][type] = value;
1010
return this;
1111
} else {
12-
console.error("Kindly provide valid parameters.");
12+
this.fetchOptions.logHandler('error', "Kindly provide valid parameters.");
1313
}
1414
};
1515
},
@@ -22,7 +22,7 @@ const _extend = {
2222
this._query['query'][key][type] = this._query['query'][key][type].concat(value);
2323
return this;
2424
} else {
25-
console.error("Kindly provide valid parameters.");
25+
this.fetchOptions.logHandler('error', "Kindly provide valid parameters.");
2626
}
2727
};
2828
},
@@ -33,7 +33,7 @@ const _extend = {
3333
this._query['query'][key]['$exists'] = bool;
3434
return this;
3535
} else {
36-
console.error("Kindly provide valid parameters.");
36+
this.fetchOptions.logHandler('error', "Kindly provide valid parameters.");
3737
}
3838
};
3939
},
@@ -61,7 +61,7 @@ const _extend = {
6161
this._query[type] = key;
6262
return this;
6363
} else {
64-
console.error("Argument should be a string.");
64+
this.fetchOptions.logHandler('error', "Argument should be a string.");
6565
}
6666
};
6767
},
@@ -71,7 +71,7 @@ const _extend = {
7171
this._query[type] = value;
7272
return this;
7373
} else {
74-
console.error("Argument should be a number.");
74+
this.fetchOptions.logHandler('error', "Argument should be a number.");
7575
}
7676
}
7777
}
@@ -395,7 +395,7 @@ export default class Query extends Entry {
395395

396396
return this;
397397
} else {
398-
console.error("Kindly provide valid parameters.");
398+
this.fetchOptions.logHandler('error', "Kindly provide valid parameters.");
399399
}
400400
}
401401

@@ -420,7 +420,7 @@ export default class Query extends Entry {
420420
this._query['query'][key] = value;
421421
return this;
422422
} else {
423-
console.error("Kindly provide valid parameters.");
423+
this.fetchOptions.logHandler('error', "Kindly provide valid parameters.");
424424
}
425425
}
426426

@@ -476,7 +476,7 @@ export default class Query extends Entry {
476476
this._query['query'] = Utils.mergeDeep(this._query['query'], query);
477477
return this;
478478
} else {
479-
console.error("Kindly provide valid parameters");
479+
this.fetchOptions.logHandler('error', "Kindly provide valid parameters");
480480
}
481481
}
482482

@@ -587,7 +587,7 @@ export default class Query extends Entry {
587587
this._query['tags'] = values;
588588
return this;
589589
} else {
590-
console.error("Kindly provide valid parameters");
590+
this.fetchOptions.logHandler('error', "Kindly provide valid parameters");
591591
}
592592
}
593593

@@ -651,7 +651,7 @@ export default class Query extends Entry {
651651
this._query[key] = value;
652652
return this;
653653
} else {
654-
console.error("Kindly provide valid parameters.");
654+
this.fetchOptions.logHandler('error', "Kindly provide valid parameters.");
655655
}
656656
}
657657

@@ -691,7 +691,7 @@ export default class Query extends Entry {
691691
if (options) this._query['query'][key]['$options'] = options;
692692
return this;
693693
} else {
694-
console.error("Kindly provide valid parameters.");
694+
this.fetchOptions.logHandler('error', "Kindly provide valid parameters.");
695695
}
696696
}
697697

@@ -717,7 +717,7 @@ export default class Query extends Entry {
717717
this._query['typeahead'] = value;
718718
return this;
719719
} else {
720-
console.error("Kindly provide valid parameters.");
720+
this.fetchOptions.logHandler('error', "Kindly provide valid parameters.");
721721
}
722722
}
723723

‎src/core/stack.js

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ let errorRetry = [408, 429]
2525
* @param param.fetchOptions.retryCondition - A function to determine if the error can be retried. Default retry is on status codes 408, 429.
2626
* @param param.fetchOptions.retryDelayOptions.base - The base number of milliseconds to use in the exponential backoff for operation retries.
2727
* @param param.fetchOptions.retryDelayOptions.customBackoff - A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds.
28+
* @param param.fetchOptions.logHandler - A function for logging of requests, responses and errors
2829
*
2930
* @example
3031
* var Stack = Contentstack.Stack({
@@ -33,7 +34,7 @@ let errorRetry = [408, 429]
3334
* 'environment':'environment_name',
3435
* 'region': 'us',
3536
* 'fetchOptions': {
36-
*
37+
*
3738
* }
3839
* });
3940
*
@@ -49,6 +50,18 @@ export default class Stack {
4950
return true;
5051
}
5152
return false
53+
},
54+
logHandler: (level, data) => {
55+
if (level === 'error' && data) {
56+
console.error(`[error] ${data}`)
57+
return
58+
} else if (level === 'warning' && data) {
59+
console.warn(`[warning] ${data}`)
60+
return
61+
} else if (level === 'info' && data) {
62+
console.info(`[info] ${data}`)
63+
return
64+
}
5265
}
5366
};
5467
this.config = Utils.mergeDeep({}, config)
@@ -80,11 +93,10 @@ export default class Stack {
8093
this.environment = stack_arguments[0].environment;
8194
return this;
8295
} else {
83-
console.error("Kindly provide valid object parameters. The specified API Key, Delivery Token, or Environment Name is invalid.");
84-
break;
96+
this.fetchOptions.logHandler('error', "Kindly provide valid object parameters. The specified API Key, Delivery Token, or Environment Name is invalid.");
8597
}
8698
case 3:
87-
console.warn("WARNING! Obsolete function called. Function 'Contentstack.Stack(api_key, delivery_token, environment)' has been deprecated, please use 'Contentstack.Stack({api_key, delivery_token, environment, region, branch, fetchOptions})' function instead!");
99+
this.fetchOptions.logHandler('warning', "WARNING! Obsolete function called. Function 'Contentstack.Stack(api_key, delivery_token, environment)' has been deprecated, please use 'Contentstack.Stack({api_key, delivery_token, environment, region, branch, fetchOptions})' function instead!");
88100
if (typeof stack_arguments[0] === "string" && typeof stack_arguments[1] === "string" && typeof stack_arguments[2] === "string") {
89101
this.headers = {
90102
api_key: stack_arguments[0],
@@ -93,19 +105,18 @@ export default class Stack {
93105
this.environment = stack_arguments[2];
94106
return this;
95107
} else {
96-
console.error("Kindly provide valid string parameters.");
97-
break;
108+
this.fetchOptions.logHandler('error', "Kindly provide valid string parameters.");
98109
}
99110
case 4:
100-
console.warn("WARNING! Obsolete function called. Function 'Contentstack.Stack(api_key, delivery_token, environment)' has been deprecated, please use 'Contentstack.Stack({api_key, delivery_token, environment, region, branch, fetchOptions})' function instead!");
111+
this.fetchOptions.logHandler('warning', "WARNING! Obsolete function called. Function 'Contentstack.Stack(api_key, delivery_token, environment)' has been deprecated, please use 'Contentstack.Stack({api_key, delivery_token, environment, region, branch, fetchOptions})' function instead!");
101112
if (typeof stack_arguments[0] === "string" && typeof stack_arguments[1] === "string" && typeof stack_arguments[2] === "string") {
102113
this.headers = {
103114
api_key: stack_arguments[0],
104115
access_token: stack_arguments[1]
105116
};
106117
this.environment = stack_arguments[2];
107118
} else {
108-
console.error("Kindly provide valid string parameters.");
119+
this.fetchOptions.logHandler('error', "Kindly provide valid string parameters.");
109120
}
110121
if (stack_arguments[3]) {
111122
if(typeof stack_arguments[3] === "string" && stack_arguments[3] !== undefined && stack_arguments[3] !== "us") {
@@ -116,15 +127,15 @@ export default class Stack {
116127
}
117128
return this;
118129
case 5:
119-
console.warn("WARNING! Obsolete function called. Function 'Contentstack.Stack(api_key, delivery_token, environment)' has been deprecated, please use 'Contentstack.Stack({api_key, delivery_token, environment, region, branch, fetchOptions})' function instead!");
130+
this.fetchOptions.logHandler('warning', "WARNING! Obsolete function called. Function 'Contentstack.Stack(api_key, delivery_token, environment)' has been deprecated, please use 'Contentstack.Stack({api_key, delivery_token, environment, region, branch, fetchOptions})' function instead!");
120131
if (typeof stack_arguments[0] === "string" && typeof stack_arguments[1] === "string" && typeof stack_arguments[2] === "string") {
121132
this.headers = {
122133
api_key: stack_arguments[0],
123134
access_token: stack_arguments[1]
124135
};
125136
this.environment = stack_arguments[2];
126137
} else {
127-
console.error("Kindly provide valid string parameters.");
138+
this.fetchOptions.logHandler('error', "Kindly provide valid string parameters.");
128139
}
129140

130141
if (stack_arguments[3]) {
@@ -139,8 +150,7 @@ export default class Stack {
139150
}
140151
return this;
141152
default:
142-
console.error("Kindly provide valid parameters to initialize the Contentstack javascript-SDK Stack.");
143-
break;
153+
this.fetchOptions.logHandler('error', "Kindly provide valid parameters to initialize the Contentstack javascript-SDK Stack.");
144154
}
145155

146156
}
@@ -206,7 +216,7 @@ export default class Stack {
206216
this.queryCachePolicy = policy;
207217
}
208218
} else {
209-
console.error("Kindly provide the valid policy");
219+
this.fetchOptions.logHandler('error', "Kindly provide the valid policy");
210220
}
211221
return this;
212222
}

0 commit comments

Comments
 (0)