Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added option to override request #99

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+27 −0
Open

Added option to override request #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f59dbc
added option to override request
khartnett Feb 22, 2019
7c1e974
removed unused require
khartnett Feb 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,9 @@ screenshot.clip.x | number | - | Specifies x-coordinate of top-left corner of cl
screenshot.clip.y | number | - | Specifies y-coordinate of top-left corner of clipping region of the page.
screenshot.clip.width | number | - | Specifies width of clipping region of the page.
screenshot.clip.height | number | - | Specifies height of clipping region of the page.
request.headers | object | - | (POST only) Override request headers.
request.method | string | - | Override request method.
request.postData | string | - | Override request postData.


**Example:**
Expand Down Expand Up @@ -250,6 +253,9 @@ The only required parameter is `url`.

// Passed to Puppeteer page.screenshot()
screenshot: { ... },

// Intercepts and overrides request
request: { ...},
}
```

Expand Down
8 changes: 8 additions & 0 deletions src/core/render-core.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,14 @@ async function render(_opts = {}) {
}
});

if (opts.request) {
await page.setRequestInterception(true);
page.on('request', (request) => {
request.continue(opts.request);
});
}


let data;
try {
logger.info('Set browser viewport..');
Expand Down
5 changes: 5 additions & 0 deletions src/http/render-http.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,11 @@ function getOptsFromQuery(query) {
},
omitBackground: query['screenshot.omitBackground'],
},
request: {
headers: query['request.headers'],
method: query['request.method'],
postData: query['request.postData'],
},
};
return opts;
}
Expand Down
8 changes: 8 additions & 0 deletions src/util/validation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ const sharedQuerySchema = Joi.object({
'screenshot.clip.width': Joi.number(),
'screenshot.clip.height': Joi.number(),
'screenshot.omitBackground': Joi.boolean(),
// 'request.headers': Joi.object(), // any way to send an object?
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if there are any clever workarounds here. Could optionally be a json string that gets decoded? I think #78 has this same issue.

'request.method': Joi.string().valid(['GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'CONNECT', 'OPTIONS', 'TRACE', 'PATCH']),
'request.postData': Joi.string(),
});

const renderQuerySchema = Joi.object({
Expand Down Expand Up @@ -126,6 +129,11 @@ const renderBodyObject = Joi.object({
omitBackground: Joi.boolean(),
}),
failEarly: Joi.string(),
request: Joi.object({
headers: Joi.object(),
method: Joi.string().valid(['GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'CONNECT', 'OPTIONS', 'TRACE', 'PATCH']),
postData: Joi.string(),
}),
});

const renderBodySchema = Joi.alternatives([
Expand Down