Skip to content

Commit 973ead2

Browse files
uttamukkojiuttamukkoji
authored
Merge pull request #83 from contentstack/feature/debugger-flag-for-logHandler
Feature/debugger flag for log handler
2 parents 2040c98 + 473855e commit 973ead2

File tree

10 files changed

+78
-52
lines changed

10 files changed

+78
-52
lines changed

‎.github/workflows/npm-publish.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
- uses: actions/setup-node@v3
2727
with:
2828
node-version: '12.x'
29-
registry-url: 'https://registry.npmjs.org'
29+
registry-url: 'https://npm.pkg.github.com'
3030
scope: '@contentstack'
3131
- run: npm ci
3232
- run: npm publish

‎.talismanrc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
threshold: medium
22
fileignoreconfig:
33
- filename: package-lock.json
4-
checksum: be538ba2f4b106e5de0a55a3137271f659901e287ec09e8ae93351543242712e
4+
checksum: 1e966081577191b52e4ac7fa113c9563d5e120043a3e399dec06e3943c4d81bc

‎index.d.ts‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ export interface Config {
5252
region?: Region;
5353
branch?: string;
5454
live_preview?: LivePreview;
55-
fetchOptions?: object;
55+
fetchOptions?: FetchOptions;
5656
}
5757
// Stack Config
5858
export interface StackConfig {
@@ -79,13 +79,28 @@ export interface LivePreviewQuery {
7979
content_type_uid: string
8080
}
8181

82+
export interface RetryDelayOption {
83+
base?: number
84+
customBackoff?: (retryCount: number, error: Error) => number
85+
}
86+
export interface FetchOptions {
87+
[propName: string]: any
88+
debug?: boolean
89+
timeout?: number
90+
retryLimit?: number
91+
retryDelay?: number
92+
retryCondition?: (error: any) => boolean
93+
logHandler?: (level: string, data: any) => void
94+
retryDelayOptions?: RetryDelayOption
95+
}
96+
8297
// Stack
8398
export class Stack {
8499
constructor(config: Config);
85100
/**
86101
* @deprecated since version 3.15.0
87102
*/
88-
constructor(api_key: string, delivery_token: string, environment_name: string, region?: Region, fetchOptions?: any, live_preview?: LivePreview);
103+
constructor(api_key: string, delivery_token: string, environment_name: string, region?: Region, fetchOptions?: FetchOptions, live_preview?: LivePreview);
89104

90105
environment: string;
91106
cachePolicy: CachePolicy;
@@ -116,7 +131,7 @@ export function Stack(config: Config): Stack;
116131
/**
117132
* @deprecated since version 3.15.0
118133
*/
119-
export function Stack(api_key: string, access_token: string, environment_name: string, region?: string, fetchOptions?: object): Stack;
134+
export function Stack(api_key: string, access_token: string, environment_name: string, region?: string, fetchOptions?: FetchOptions): Stack;
120135

121136
export class ContentType {
122137
constructor();

‎package-lock.json‎

Lines changed: 17 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "contentstack",
3-
"version": "3.15.4",
3+
"version": "3.15.5",
44
"description": "Contentstack Javascript SDK",
55
"homepage": "https://www.contentstack.com/",
66
"author": {
@@ -11,7 +11,7 @@
1111
"browser": "dist/web/contentstack.js",
1212
"react-native": "dist/react-native/contentstack.js",
1313
"types": "./index.d.ts",
14-
"_id": "contentstack@3.15.4",
14+
"_id": "contentstack@3.15.5",
1515
"scripts": {
1616
"test": "npm run test:e2e && npm run test:typescript",
1717
"test:e2e": "tape test/index.js | tap-html --out ./tap-html.html",
@@ -55,11 +55,11 @@
5555
],
5656
"dist": {
5757
"shasum": "a328ed07240476a26b31a23261355dc929e1da63",
58-
"tarball": "https://registry.npmjs.org/contentstack/-/contentstack-3.15.4.tgz"
58+
"tarball": "https://registry.npmjs.org/contentstack/-/contentstack-3.15.5.tgz"
5959
},
6060
"license": "MIT",
6161
"directories": {},
62-
"_resolved": "https://registry.npmjs.org/contentstack/-/contentstack-3.15.4.tgz",
62+
"_resolved": "https://registry.npmjs.org/contentstack/-/contentstack-3.15.5.tgz",
6363
"_npmOperationalInternal": {
6464
"host": "packages-18-east.internal.npmjs.com",
6565
"tmp": "tmp/contentstack-3.15.0.tgz_1477830884275_0.9869455888401717"

‎src/core/lib/request.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ function fetchRetry(url, headers, fetchOptions, resolve, reject, retryDelay = 30
6868

6969
function onError (error) {
7070
if (retryLimit === 0) {
71-
fetchOptions.logHandler('error', error);
71+
if (fetchOptions.debug) fetchOptions.logHandler('error', error);
7272
reject(error);
7373
}else {
7474
var msDelay = retryDelay
@@ -90,10 +90,10 @@ function fetchRetry(url, headers, fetchOptions, resolve, reject, retryDelay = 30
9090
})
9191
}
9292
}
93-
fetchOptions.logHandler('info', { url: url, option: option});
93+
if (fetchOptions.debug) fetchOptions.logHandler('info', { url: url, option: option});
9494
fetch(url, option)
9595
.then(function(response) {
96-
fetchOptions.logHandler('info', response);
96+
if (fetchOptions.debug) fetchOptions.logHandler('info', response);
9797
let data = response.json();
9898
if (response.ok && response.status === 200) {
9999
resolve(data);
@@ -102,16 +102,16 @@ function fetchRetry(url, headers, fetchOptions, resolve, reject, retryDelay = 30
102102
if (fetchOptions.retryCondition && fetchOptions.retryCondition(response)) {
103103
onError(json)
104104
} else {
105-
fetchOptions.logHandler('error', json);
105+
if (fetchOptions.debug) fetchOptions.logHandler('error', json);
106106
reject(json)
107107
}
108108
}).catch(() => {
109-
fetchOptions.logHandler('error', {status: response.status, statusText: response.statusText});
109+
if (fetchOptions.debug) fetchOptions.logHandler('error', {status: response.status, statusText: response.statusText});
110110
reject({status: response.status, statusText: response.statusText})
111111
});
112112
}
113113
}).catch((error) => {
114-
fetchOptions.logHandler('error', error);
114+
if (fetchOptions.debug) fetchOptions.logHandler('error', error);
115115
reject(error)
116116
});
117117
}

‎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-
this.fetchOptions.logHandler('error',"Kindly provide a valid parameters.");
78+
if(this.fetchOptions.debug) 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-
fetchOptions.logHandler('error', "Kindly provide an asset uid. e.g. .Assets('asset_uid')");
122+
if(fetchOptions.debug) 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-
this.fetchOptions.logHandler('error', "Kindly provide the valid policy");
86+
if (this.fetchOptions.debug) 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-
this.fetchOptions.logHandler('error', "Argument should be a String or an Array.");
138+
if (this.fetchOptions.debug) 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-
this.fetchOptions.logHandler('error', "Argument should be a String.");
163+
if (this.fetchOptions.debug) 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-
this.fetchOptions.logHandler('error', "First argument should be a String.");
182+
if (this.fetchOptions.debug) 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-
this.fetchOptions.logHandler('error', "Kindly provide valid parameters.");
326+
if (this.fetchOptions.debug) 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-
this.fetchOptions.logHandler('error', "Kindly provide an entry uid. e.g. .Entry('asset_uid')");
363+
if (this.fetchOptions.debug) 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-
this.fetchOptions.logHandler('error', "Kindly provide valid parameters.");
12+
if (this.fetchOptions.debug) 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-
this.fetchOptions.logHandler('error', "Kindly provide valid parameters.");
25+
if (this.fetchOptions.debug) 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-
this.fetchOptions.logHandler('error', "Kindly provide valid parameters.");
36+
if (this.fetchOptions.debug) 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-
this.fetchOptions.logHandler('error', "Argument should be a string.");
64+
if (this.fetchOptions.debug) 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-
this.fetchOptions.logHandler('error', "Argument should be a number.");
74+
if (this.fetchOptions.debug) 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-
this.fetchOptions.logHandler('error', "Kindly provide valid parameters.");
398+
if (this.fetchOptions.debug) 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-
this.fetchOptions.logHandler('error', "Kindly provide valid parameters.");
423+
if (this.fetchOptions.debug) 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-
this.fetchOptions.logHandler('error', "Kindly provide valid parameters");
479+
if (this.fetchOptions.debug) 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-
this.fetchOptions.logHandler('error', "Kindly provide valid parameters");
590+
if (this.fetchOptions.debug) 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-
this.fetchOptions.logHandler('error', "Kindly provide valid parameters.");
654+
if (this.fetchOptions.debug) 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-
this.fetchOptions.logHandler('error', "Kindly provide valid parameters.");
694+
if (this.fetchOptions.debug) 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-
this.fetchOptions.logHandler('error', "Kindly provide valid parameters.");
720+
if (this.fetchOptions.debug) this.fetchOptions.logHandler('error', "Kindly provide valid parameters.");
721721
}
722722
}
723723

0 commit comments

Comments
 (0)