agoo 2.14.2 → 2.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e538b3f1c7ed9ea23d8529c29bf5104d0882b0dcda49e6114bb011491b1e3ed7
-  data.tar.gz: ee1a1284779ec7108675794f4eff89f826c76f3a5e10a7f07a42bab8bbae31cb
+  metadata.gz: 74cca7bbc7156c967212d01e349f2d9134af318c8abd59687167fa5580773e54
+  data.tar.gz: cf765b3109277f2caa4fbb2c25d5352990fd03a394a78de82cf81ed4b235b6f4
 SHA512:
-  metadata.gz: e28b50c1bea0934691679719532108fdd6d912f3beed8b9eabe6071ccd71af393b14f3c81d094cb82b5777a22884cc716e12d3c66629e39c5f7f1290919fc030
-  data.tar.gz: 1d478668d82b79acc3d2cabb56fe9aca55fb3513b4c5a5810c0d200a69b081573ff532a346c13d513fae0980fa6331f3701ee041d43ea7cfc32cd2d2a586d0c2
+  metadata.gz: 50ef0edcf1dcec15be40de1594ddd9dbbec5749fd9099f140ffd0ce986a50728d3ff442e63f4a2756f0bdcd082618cf37a183b31676c432cddb07f4ec916d48f
+  data.tar.gz: 485447bbd3013e516472a8f6531316eb5d1b4144b3197359425cc838807878756c990145c68ecaa5322a157ce93601a671449291fbece8cae05f0fe35d9c1f56

data/CHANGELOG.md

@@ -2,6 +2,37 @@
 
 All changes to the Agoo gem are documented here. Releases follow semantic versioning.
 
+## [2.15.1] - 2022-06-18
+
+### Added
+
+- Introspection can now be disabled with the `hide_schema` option to the Agoo server.
+
+- If an exception raised from a GraphQL callback responds to `code`
+  that code will be used as the HTTP status.
+
+- Added missing ability to set or add elements of a request argument
+  on GraphQL callback methods.
+
+## [2.15.0] - 2022-05-20
+
+### Added
+
+- Support added for PATCH.
+
+- A `:hide_schema` option has been added to show the graphql/schema as
+  not found unless added by with the handle method of the server.
+
+- Raising an exception that responds to `code` in a graphql resolve
+  function will return that code as the HTTP status code.
+
+## [2.14.3] - 2022-05-05
+
+### Fixed
+- Agoo now reports an error if the developer make the mistake of
+  building a schema that loops back on itself too many times using
+  fragments.
+
 ## [2.14.2] - 2022-02-22
 
 ### Fixed

data/ext/agoo/con.c

@@ -327,6 +327,8 @@ con_header_read(agooCon c, size_t *mlenp) {
 	    method = AGOO_PUT;
 	} else if (4 == b - c->buf && 0 == strncmp("POST", c->buf, 4)) {
 	    method = AGOO_POST;
+	} else if (5 == b - c->buf && 0 == strncmp("PATCH", c->buf, 5)) {
+	    method = AGOO_PATCH;
 	} else {
 	    return bad_request(c, 400, __LINE__);
 	}

data/ext/agoo/gqleval.c

@@ -21,6 +21,7 @@
 #include "websocket.h"
 
 #define MAX_RESOLVE_ARGS	16
+#define MAX_DEPTH		100
 
 gqlRef		gql_root = NULL;
 gqlType		_gql_root_type = NULL;
@@ -273,7 +274,10 @@ gql_eval_sels(agooErr err, gqlDoc doc, gqlRef ref, gqlField field, gqlSel sels,
     gqlSel	sel;
     gqlField	sf = NULL;
 
-    // TBD if depth over max then return an error
+    if (MAX_DEPTH < depth) {
+	return agoo_err_set(err, AGOO_ERR_EVAL, "Maximum resolve depth of %d exceeded.", MAX_DEPTH);
+    }
+    depth++;
 
     for (sel = sels; NULL != sel; sel = sel->next) {
 	if (NULL != field) {
@@ -474,8 +478,14 @@ gql_eval_get_hook(agooReq req) {
 	result = gql_doc_eval_func(&err, doc);
     }
     if (NULL == result) {
+	int code = 500;
+
+	if (err.code < 0) {
+	    code = -err.code;
+	}
+	err.code = AGOO_ERR_EVAL;
 	gql_doc_destroy(doc);
-	err_resp(req->res, &err, 500);
+	err_resp(req->res, &err, code);
 	return;
     }
     if (GQL_SUBSCRIPTION == doc->op->kind) {
@@ -644,7 +654,13 @@ gql_eval_post_hook(agooReq req) {
 	indent = (int)strtol(s, NULL, 10);
     }
     if (NULL == (result = eval_post(&err, req)) && AGOO_ERR_OK != err.code) {
-	err_resp(req->res, &err, 400);
+	int code = 400;
+
+	if (err.code < 0) {
+	    code = -err.code;
+	}
+	err.code = AGOO_ERR_EVAL;
+	err_resp(req->res, &err, code);
     } else if (NULL == result) {
 	value_resp(req, result, 200, indent);
     } else {

data/ext/agoo/gqlintro.c

@@ -1497,13 +1497,13 @@ gql_intro_eval(agooErr err, gqlDoc doc, gqlSel sel, gqlValue result, int depth)
     struct _gqlCobj	obj;
 
     if (0 == strcmp("__type", sel->name)) {
-	if (1 < depth) {
+	if (2 < depth) {
 	    return agoo_err_set(err, AGOO_ERR_EVAL, "__type can only be called from a query root.");
 	}
 	obj.clas = &root_class;
 	obj.ptr = NULL;
     } else if (0 == strcmp("__schema", sel->name)) {
-	if (1 < depth) {
+	if (2 < depth) {
 	    return agoo_err_set(err, AGOO_ERR_EVAL, "__scheme can only be called from a query root.");
 	}
 	obj.clas = &root_class;

data/ext/agoo/request.c

@@ -684,6 +684,24 @@ call(VALUE self) {
     return io;
 }
 
+/* Document-method: set
+ *
+ * call-seq: set()
+ *
+ * Sets an key value pair to the environment of the request.
+ */
+static VALUE
+set(VALUE self, VALUE key, VALUE val) {
+    agooReq	r = DATA_PTR(self);
+
+    if (NULL == r) {
+	rb_raise(rb_eArgError, "Request is no longer valid.");
+    }
+    rb_hash_aset((VALUE)r->env, key, val);
+
+    return Qnil;
+}
+
 VALUE
 request_wrap(agooReq req) {
     // freed from the C side of things
@@ -723,6 +741,7 @@ request_init(VALUE mod) {
     rb_define_method(req_class, "body", body, 0);
     rb_define_method(req_class, "rack_logger", rack_logger, 0);
     rb_define_method(req_class, "call", call, 0);
+    rb_define_method(req_class, "set", set, 2);
 
     new_id = rb_intern("new");
 

data/ext/agoo/rgraphql.c

@@ -58,8 +58,24 @@ make_ruby_use(agooErr    err,
     volatile VALUE	v;
     ID			m = rb_intern(method);
 
-    if (!rb_respond_to(root, m) ||
-	Qnil == (v = rb_funcall(root, m, 0))) {
+    if (!rb_respond_to(root, m)) {
+	return AGOO_ERR_OK;
+    }
+    switch (rb_obj_method_arity(root, m)) {
+    case 0:
+	v = rb_funcall(root, m, 0);
+	break;
+    case 1:
+	v = rb_funcall(root, m, 1, Qnil);
+	break;
+    case 2:
+	v = rb_funcall(root, m, 2, Qnil, Qnil);
+	break;
+    default:
+	v = Qnil;
+	break;
+    }
+    if (Qnil == v) {
 	return AGOO_ERR_OK;
     }
     if (NULL == (type = gql_type_get(type_name))) {
@@ -89,7 +105,13 @@ rescue_error(VALUE x, VALUE ignore) {
     const char		*ms = rb_string_value_ptr(&msg);
 
     agoo_err_set(eval->err, AGOO_ERR_EVAL, "%s: %s", classname, ms);
+    if (rb_respond_to(info, rb_intern("code"))) {
+	VALUE	code = rb_funcall(info, rb_intern("code"), 0);
 
+	if (RUBY_T_FIXNUM == rb_type(code)) {
+	    eval->err->code = -FIX2INT(code);
+	}
+    }
     return Qfalse;
 }
 

data/ext/agoo/rserver.c

@@ -48,6 +48,7 @@ static VALUE	options_sym;
 static VALUE	post_sym;
 static VALUE	push_env_key;
 static VALUE	put_sym;
+static VALUE	patch_sym;
 
 static VALUE	rserver;
 
@@ -207,12 +208,12 @@ configure(agooErr err, int port, const char *root, VALUE options) {
 	}
 	if (Qnil != (v = rb_hash_lookup(options, ID2SYM(rb_intern("graphql"))))) {
 	    const char	*path;
-	    agooHook	dump_hook;
 	    agooHook	get_hook;
 	    agooHook	post_hook;
 	    agooHook	options_hook;
-	    char	schema_path[256];
+	    agooHook	head = NULL;
 	    long	plen;
+	    VALUE	hide_schema = Qnil;
 
 	    rb_check_type(v, T_STRING);
 	    if (AGOO_ERR_OK != gql_init(err)) {
@@ -220,21 +221,29 @@ configure(agooErr err, int port, const char *root, VALUE options) {
 	    }
 	    path = StringValuePtr(v);
 	    plen = (long)RSTRING_LEN(v);
-	    if ((int)sizeof(schema_path) - 8 < plen) {
-		rb_raise(rb_eArgError, "A graphql schema path is limited to %d characters.", (int)(sizeof(schema_path) - 8));
-	    }
-	    memcpy(schema_path, path, plen);
-	    memcpy(schema_path + plen, "/schema", 8);
 
-	    dump_hook = agoo_hook_func_create(AGOO_GET, schema_path, gql_dump_hook, &agoo_server.eval_queue);
 	    get_hook = agoo_hook_func_create(AGOO_GET, path, gql_eval_get_hook, &agoo_server.eval_queue);
 	    post_hook = agoo_hook_func_create(AGOO_POST, path, gql_eval_post_hook, &agoo_server.eval_queue);
 	    options_hook = agoo_hook_func_create(AGOO_OPTIONS, path, gql_eval_options_hook, &agoo_server.eval_queue);
-	    dump_hook->next = get_hook;
+	    if (Qnil != (hide_schema = rb_hash_lookup(options, ID2SYM(rb_intern("hide_schema")))) && Qtrue == hide_schema) {
+		head = get_hook;
+	    } else {
+		char		schema_path[256];
+		agooHook	dump_hook;
+
+		if ((int)sizeof(schema_path) - 8 < plen) {
+		    rb_raise(rb_eArgError, "A graphql schema path is limited to %d characters.", (int)(sizeof(schema_path) - 8));
+		}
+		memcpy(schema_path, path, plen);
+		memcpy(schema_path + plen, "/schema", 8);
+		dump_hook = agoo_hook_func_create(AGOO_GET, schema_path, gql_dump_hook, &agoo_server.eval_queue);
+		dump_hook->next = get_hook;
+		head = dump_hook;
+	    }
 	    get_hook->next = post_hook;
 	    post_hook->next = options_hook;
 	    options_hook->next = agoo_server.hooks;
-	    agoo_server.hooks = dump_hook;
+	    agoo_server.hooks = head;
 	}
 	if (Qnil != (v = rb_hash_lookup(options, ID2SYM(rb_intern("quiet"))))) {
 	    if (Qtrue == v) {
@@ -295,6 +304,8 @@ configure(agooErr err, int port, const char *root, VALUE options) {
  *   - *:ssl_sert* [_String_] filepath to the SSL certificate file.
  *
  *   - *:ssl_key* [_String_] filepath to the SSL private key file.
+ *
+ *   - *:hide_schema* [_true_|_false_] if true the graphql/schema path is handled.
  */
 static VALUE
 rserver_init(int argc, VALUE *argv, VALUE self) {
@@ -971,6 +982,8 @@ handle(VALUE self, VALUE method, VALUE pattern, VALUE handler) {
 	meth = AGOO_POST;
     } else if (put_sym == method) {
 	meth = AGOO_PUT;
+    } else if (patch_sym == method) {
+	meth = AGOO_PATCH;
     } else if (Qnil == method) {
 	meth = AGOO_ALL;
     } else {
@@ -1277,6 +1290,7 @@ server_init(VALUE mod) {
     options_sym = ID2SYM(rb_intern("OPTIONS"));		rb_gc_register_address(&options_sym);
     post_sym = ID2SYM(rb_intern("POST"));		rb_gc_register_address(&post_sym);
     put_sym = ID2SYM(rb_intern("PUT"));			rb_gc_register_address(&put_sym);
+    patch_sym = ID2SYM(rb_intern("PATCH"));		rb_gc_register_address(&patch_sym);
 
     push_env_key = rb_str_new_cstr("rack.upgrade");	rb_gc_register_address(&push_env_key);
 

data/lib/agoo/version.rb

@@ -1,5 +1,5 @@
 
 module Agoo
   # Agoo version.
-  VERSION = '2.14.2'
+  VERSION = '2.15.1'
 end

data/test/graphql_test.rb

@@ -458,6 +458,32 @@ fragment basic on Artist {
     post_test(uri, body, 'application/graphql', expect)
   end
 
+  def test_post_fragment_loop
+    uri = URI('http://localhost:6472/graphql?indent=2')
+    body = %^
+{
+  artist(name:"Fazerdaze") {
+    ...loop
+  }
+}
+
+fragment loop on Artist {
+  name
+  ...loop
+}
+^
+    expect = %^{
+  "errors":[
+    {
+      "message":"Maximum resolve depth of 100 exceeded.",
+      "code":"eval error"
+    }
+  ]
+}
+^
+    post_test(uri, body, 'application/graphql', expect, 'errors.0.timestamp')
+  end
+
   def test_post_json_fragment
     uri = URI('http://localhost:6472/graphql?indent=2')
     body = %^{
@@ -1044,7 +1070,7 @@ mutation {
     assert_equal(expect, content)
   end
 
-  def post_test(uri, body, content_type, expect)
+  def post_test(uri, body, content_type, expect, ignore=nil)
     uri = URI(uri)
     req = Net::HTTP::Post.new(uri)
     req['Accept-Encoding'] = '*'
@@ -1055,6 +1081,11 @@ mutation {
     }
     content = res.body
     assert_equal('application/json', res['Content-Type'])
+    unless ignore.nil?
+      result = Oj.load(content, mode: :strict)
+      deep_delete(result, ignore.split('.'))
+      content = Oj.dump(result, indent: 2)
+    end
     assert_equal(expect, content)
   end
 end

data/test/rack_handler_test.rb

@@ -33,7 +33,7 @@ size=big
 	]
       elsif 'POST' == req['REQUEST_METHOD']
 	[ 204, { }, [] ]
-      elsif 'PUT' == req['REQUEST_METHOD']
+      elsif 'PUT' == req['REQUEST_METHOD'] ||  'PATCH' == req['REQUEST_METHOD']
 	[ 201,
 	  { },
 	  [ req['rack.input'].read ]
@@ -65,6 +65,7 @@ size=big
     Agoo::Server.handle(:GET, "/tellme", handler)
     Agoo::Server.handle(:POST, "/makeme", handler)
     Agoo::Server.handle(:PUT, "/makeme", handler)
+    Agoo::Server.handle(:PATCH, "/makeme", handler)
 
     Agoo::Server.start()
 
@@ -156,4 +157,20 @@ size=big
     assert_equal('hello', res.body)
   end
 
+  def test_patch
+    uri = URI('http://localhost:6467/makeme')
+    req = Net::HTTP::Patch.new(uri)
+    # Set the headers the way we want them.
+    req['Accept-Encoding'] = '*'
+    req['Accept'] = 'application/json'
+    req['User-Agent'] = 'Ruby'
+    req.body = 'hello'
+
+    res = Net::HTTP.start(uri.hostname, uri.port) { |h|
+      h.request(req)
+    }
+    assert_equal(Net::HTTPCreated, res.class)
+    assert_equal('hello', res.body)
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: agoo
 version: !ruby/object:Gem::Version
-  version: 2.14.2
+  version: 2.15.1
 platform: ruby
 authors:
 - Peter Ohler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-22 00:00:00.000000000 Z
+date: 2022-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj