README

Lumen service provider to perform batched requests. Usage and implementation roughly based on making batch requests with Facebook's Graph API.

Batching requests allows you to send multiple requests at once, allowing you to perform multiple operations in a single HTTP request. Each request in the batch is processed in sequence unless dependencies are specified.

Requests within the batch can list dependancies on other requests within the batch, and access their responses via JSONP syntax. Again, similar to Facebook's Graph API. Using JSONP syntax, a request in the batch can use the response from another request in the batch. More information is provided in the Usage and Examples section.

Once all requests have been completed, an array of responses will be returned and the HTTP connection closed.

Built on PHP 7.1.13 and Laravel Framework Lumen (5.6.3).

Dependancies

PHP >=7.1 Built and tested on PHP 7.1.13
Laravel/Lumen ~5.6 Originally built using Laravel Lumen version 5.6.3 (https://github.com/laravel/lumen)
FlowCommunications/JSONPath ~0.4.0 Accommodates JSONP parsing for specifying dependancies (https://github.com/FlowCommunications/JSONPath)

Installation and Setup

Install the package via composer.

composer install dvanderburg/lumen-batched-request

$app->register(Dvanderburg\BatchedRequest\BatchedRequestServiceProvider::class);

Simple Batched Requests

Send a basic batched request by sending an HTTP post to /batch/. This example will perform two GET requests and a POST, returning an array of responses.

HTTP POST Example:

POST /batch HTTP/1.1
Content-Type: application/json
batch: [
	{ method: "GET",	relative_url: "/product/1234" },
	{ method: "GET",	relative_url: "/user/?ids=larry,jill,sally" },
	{ method: "POST",	'content-type': "application/x-www-form-urlencoded", name: 'create-user', relative_url: "/user/?username=john" body: "password=admin"},

Axios XHR Example:

axios.post('/batch', {
	batch: [
		{ method: "GET",	relative_url: "/product/1234" },
		{ method: "GET",	relative_url: "/user/?ids=larry,jill,sally" },
		{ method: "POST",	'content-type': "application/x-www-form-urlencoded", name: 'create-user', relative_url: "/user/?username=john" body: "password=admin"},
	]
});

JQuery XHR Example:

$.ajax({
	method: "POST",
	dataType: "json",
	data: {
		batch: [
			{ method: "GET",	relative_url: "/product/1234" },
			{ method: "GET",	relative_url: "/users/?ids=larry,jill,sally" },
			{ method: "POST",	'content-type': "application/x-www-form-urlencoded", name: 'create-user', relative_url: "/user/?username=john" body: "password=admin" },
		]
	}
})

For the examples above, the expected response format would be:

[
	{
		code: 200,
		body: { product_id: 1234 }
	},
	{
		code: 200,
		body: [{ username: "larry" }, { username: "jill" }, { username: "sally" }]
	},
	{
		code: 200,
		body: { username: "john" }
	},
]

Errors

If a specific request in the batch fails, its response within the array of responses will contain a non-200 code. However, the actual HTTP request to process the batch will still return a 200-OK.

Specifying Dependencies with JSONP

Sometimes the operation of one request in the batch is dependant on the response of another. This dependancy can be created by specifying a name for a request and then accessing the response of that request using JSONP syntax.

The following example retrieves a user's collection of books which are represented with a book_id. The book IDs are then used by a second request in the batch to retrieve information about those books.

HTTP POST Example:

POST /batch HTTP/1.1
Content-Type: application/json
batch: [
	{ "method": "GET", "name": "get-user-books", "relative_url": "/user_books/?username=larry" },
	{ "method": "GET", "relative_url": "/book/?book_ids={result=get-user-books:$.book_id}" },

In the example above, the first request in the batch is named get-user-books and the second request references that request by name and uses JSONP syntax to extract all the book_ids from the first request in order to know what books to retrieve.

The result of the JSONP expression is exported in csv format. In the example above that may look like: 1234,5678,9012.

If a request is a dependancy of another request and fails, it will cause the request which is dependant on it to also fail. In the above example if the get-user-books request fails, the request to retrieve books will also fail.

Headers, Cookies, and Files

Headers, cookies, and files associated with the HTTP request to /batch/ will be available to all requests in the batch. For example: Sending bearer-token authentication as a header will set that header on all subrequests in the batch, meaning any authenticaiton middleware will be executed for each request in the batch.

dvanderburg / lumen-batched-request

Maintainers

Details