forked from BrandedEntertainmentNetwork/cypress-rest-graphql
-
Notifications
You must be signed in to change notification settings - Fork 0
/
support.js
180 lines (164 loc) · 5.1 KB
/
support.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
const {displayGraphQL, displayRest} = require('./display');
/**
* Helpers design to be over written by specific auth code, if needed. Expects in auth format
* https://github.com/request/request#http-authentication
*/
const bearerAuth = () => Cypress.env('accessToken') ? { bearer: Cypress.env('accessToken') } : null;
const graphQLAuth = () => Cypress.env('graphQLAuth') ? Cypress.env('graphQLAuth') : bearerAuth();
const restAuth = () => Cypress.env('restAuth') ? Cypress.env('restAuth') : bearerAuth();
/**
* Helper to perform GraphQL queries on the API
* Will display the query and response in the pane, for easy review.
* Automatically uses cy.env('accessToken') for auth
* @param {graphQL} query - Query or Mutation graphQL
* @param {Object} variables - Key value pairs/object used as parameters to the query
*/
Cypress.Commands.add('graphQL', { prevSubject: false }, (query, variables) => {
// Perform the query
cy.request({
method: 'POST',
url: `${Cypress.config().baseUrl}/graphql`,
body: { query, variables },
auth: graphQLAuth(),
log: false,
failOnStatusCode: false,
}).then((res) => {
const {
duration,
body: { errors, data },
status,
statusText,
...debug
} = res;
const title = `${query.substring(0, query.indexOf('('))}`
const message = `${title} - ${duration} ms (${statusText})`;
const interestingData = {
title,
query,
variables,
status,
statusText,
duration,
data,
errors,
debug,
};
// log the response
Cypress.log({
name: 'GraphQL',
message,
consoleProps() {
return interestingData;
},
});
displayGraphQL(interestingData);
return interestingData;
});
});
/**
* Helper to periodically perform a graphQL query, checking the response against a condition.
*
* @param {graphQL} query - Query or Mutation graphQL
* @param {Object} variables - Key value pairs/object used as parameters to the query
* @param {Function} condition - Response data passed to this function, failed expects will trigger a loop.
* @param {Number} wait=100 - Millisecond delay between polling
* @param {Number} maxTries=5 - Maximum number of retries before failing totally.
*/
Cypress.Commands.add('graphQLPolling', { prevSubject: false }, (query, variables, condition, wait = 100, maxTries = 5) => {
let retries = -1;
function makeRequest() {
retries++;
return cy.graphQL(query, variables).then((resp) => {
try {
condition(resp);
} catch (err) {
if (retries > maxTries)
throw new Error(`retried too many times (${retries})`);
// eslint-disable-next-line cypress/no-unnecessary-waiting
cy.wait(wait);
return makeRequest();
}
return resp;
});
}
return makeRequest();
},
);
/**
* Wrapper to perform REST based API queries. Improved logging and review.
* @param {String} method='GET' - REST method to use
* @param {String} url - relative or absolute URL to hit
* @param {Object} postBody - Post body
*/
Cypress.Commands.add('rest', { prevSubject: false }, (method = 'GET', url, postBody) => {
const fullUrl = url.substring(0,4) == 'http' ? url : `${Cypress.config().baseUrl}${url}`;
// Perform the query
cy.request({
method: method,
url: fullUrl,
body: postBody,
auth: restAuth(),
log: false,
failOnStatusCode: false,
}).then((res) => {
const {
duration,
body,
status,
statusText,
...debug
} = res;
const title = `${method} ${url}`;
const message = `${title} - ${duration} ms (${statusText})`;
const interestingData = {
title,
url,
postBody,
status,
statusText,
duration,
body,
debug,
};
// log the response
Cypress.log({
name: 'REST',
message,
consoleProps() {
return interestingData;
},
});
displayRest(interestingData);
return interestingData;
});
});
/**
* Helper to periodically perform a graphQL query, checking the response against a condition.
*
* @param {String} method='GET' - REST method to use
* @param {String} url - relative or absolute URL to hit
* @param {Object} postBody - Post body
* @param {Function} condition - Response data passed to this function, failed expects will trigger a loop.
* @param {Number} wait=100 - Millisecond delay between polling
* @param {Number} maxTries=5 - Maximum number of retries before failing totally.
*/
Cypress.Commands.add('restPolling', { prevSubject: false }, (method = 'GET', url, postBody, condition, wait = 100, maxTries = 5) => {
let retries = -1;
function makeRequest() {
retries++;
return cy.rest(method, url, postBody).then((resp) => {
try {
condition(resp);
} catch (err) {
if (retries > maxTries)
throw new Error(`retried too many times (${retries})`);
// eslint-disable-next-line cypress/no-unnecessary-waiting
cy.wait(wait);
return makeRequest();
}
return resp;
});
}
return makeRequest();
},
);