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

[RFC] vibe.web.web: Support JSON more natively #1697

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[RFC] vibe.web.web: Support JSON more natively #1697

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
38 changes: 32 additions & 6 deletions tests/vibe.web.web/source/app.d
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ module app;

import vibe.core.core;
import vibe.core.log;
import vibe.data.json;
import vibe.http.client;
import vibe.http.router;
import vibe.http.server;
Expand All @@ -10,6 +11,19 @@ import std.format : format;

// TODO: test the various parameter and return type combinations, as well as all attributes

struct MyStruct
{
int foo = 2;
}

class Service {
@noRoute void getFoo(HTTPServerResponse res) { res.writeBody("oops"); }
void getBar(HTTPServerResponse res) { res.writeBody("ok"); }
// for POST/PUT requests: incoming objects are automatically serialized to Json
// by default an unknown return type is serialized to Json
auto postStruct(MyStruct st) { return st.foo + 3; }
}

shared static this()
{
auto settings = new HTTPServerSettings;
Expand All @@ -21,7 +35,18 @@ shared static this()

runTask({
scope (exit) exitEventLoop();

void postJson(V)(string url, V[string] payload, HTTPStatus expected, scope void delegate(scope HTTPClientResponse res) expectedHandler) {
requestHTTP("http://127.0.0.1:9132"~url,
(scope req) {
req.method = HTTPMethod.POST;
req.writeJsonBody(payload);
},
(scope res) {
assert(res.statusCode == expected, format("Unexpected status code for %s: %s", url, res.statusCode));
expectedHandler(res);
}
);
}
void test(string url, HTTPStatus expected) {
requestHTTP("http://" ~ serverAddr.toString ~ url,
(scope req) {
Expand All @@ -34,11 +59,12 @@ shared static this()
}
test("/foo", HTTPStatus.notFound);
test("/bar", HTTPStatus.ok);

postJson("/struct", ["foo": 5], HTTPStatus.ok, (scope res) {
auto j = res.readJson;
assert(j.get!int == 8);
});

logInfo("All web tests succeeded.");
});
}

class Service {
@noRoute void getFoo(HTTPServerResponse res) { res.writeBody("oops"); }
void getBar(HTTPServerResponse res) { res.writeBody("ok"); }
}
16 changes: 14 additions & 2 deletions web/vibe/web/web.d
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -923,8 +923,18 @@ private void handleRequest(string M, alias overload, C, ERROR...)(HTTPServerRequ
} else static if (is(PT == bool)) {
params[i] = param_names[i] in req.form || param_names[i] in req.query;
} else {
import std.algorithm.comparison : among;

enum has_default = !is(default_values[i] == void);
ParamResult pres = readFormParamRec(req, params[i], param_names[i], !has_default, nested_style, err);
ParamResult pres = void;
// For POST/PUT requests, parameters are usually sent via JSON
if (req.method.among(HTTPMethod.POST, HTTPMethod.PUT) && req.json.type != Json.Type.undefined && i == 0) {
params[i].setVoid(req.json.deserializeJson!PT);
pres = ParamResult.ok;
} else {
// otherwise try to read the parameters from a query forms
pres = readFormParamRec(req, params[i], param_names[i], !has_default, nested_style, err);
}
static if (has_default) {
if (pres == ParamResult.skipped)
params[i].setVoid(default_values[i]);
Expand Down Expand Up @@ -1021,7 +1031,9 @@ private void handleRequest(string M, alias overload, C, ERROR...)(HTTPServerRequ
res.writeBody(ret);
}
} else {
static assert(is(RET == void), M~": Only InputStream, Json and void are supported as return types for route methods.");
// Serialize to Json by default
static if (!is(RET : void))
res.writeJsonBody(ret);
}
}
} catch (Exception ex) {
Expand Down