ncurl - use weakrefs for async

Author: shikokuchuo

R/stream.R

@@ -99,6 +99,9 @@ stream <- function(dial = NULL, listen = NULL, textframes = FALSE) {
 #'
 #'     In non-interactive sessions: redirects are never followed.
 #'
+#'     For async requests, the redirect address will be returned as a character
+#'     string at \code{$raw} and \code{$data} will be NULL.
+#'
 #' @section TLS Support:
 #'
 #'     Connecting to secure https sites is supported if \code{\link{nng_version}}

README.Rmd

@@ -50,7 +50,7 @@ Implemented transports:
 5. [RPC and Distributed Computing](#rpc-and-distributed-computing)
 6. [Publisher / Subscriber Model](#publisher-subscriber-model)
 7. [Surveyor / Repondent Model](#surveyor-respondent-model)
-8. [ncurl: Minimalist http Client](#ncurl-minimalist-http-client)
+8. [ncurl: (Async) HTTP Client](#ncurl-async-http-client)
 9. [stream: Websocket Client](#stream-websocket-client)
 10. [Building from source](#building-from-source)
 11. [Links](#links)
@@ -402,26 +402,33 @@ Above it can be seen that the final value resolves into a timeout, which is an i
 
 [« Back to ToC](#table-of-contents)
 
-### ncurl: Minimalist http Client
+### ncurl: Async HTTP Client
 
-`ncurl()` is a minimalist http(s) client. In normal use, it takes only one argument, the URL. It can follow redirects.
+`ncurl()` is a minimalist http(s) client.
+
+By setting `async = TRUE`, it performs requests asynchronously, returning immediately with a 'recvAio'.
+
+For normal use, it takes just the URL. It can follow redirects.
 
 ```{r ncurl}
 
 ncurl("http://httpbin.org/headers")
 
 ```
 
-For advanced use, supports additional HTTP methods such as POST or PUT. In this respect, it may be used as a performant and lightweight method for making requests to REST APIs.
+For advanced use, supports additional HTTP methods such as POST or PUT.
 
 ```{r ncurladv}
 
-res <- ncurl("http://httpbin.org/post", async = TRUE, "POST", "application/json", "Bearer APIKEY", '{"key": "value"}')
+res <- ncurl("http://httpbin.org/post", async = TRUE,
+             "POST", "application/json", "Bearer APIKEY", '{"key": "value"}')
+res
+
 call_aio(res)$data
 
 ```
 
-There is also the option of performing requests asynchronously, in which case the function returns immediately with a 'recvAio'.
+In this respect, it may be used as a performant and lightweight method for making REST API requests.
 
 [&laquo; Back to ToC](#table-of-contents)
 

README.md

@@ -51,7 +51,7 @@ Implemented transports:
 5.  [RPC and Distributed Computing](#rpc-and-distributed-computing)
 6.  [Publisher / Subscriber Model](#publisher-subscriber-model)
 7.  [Surveyor / Repondent Model](#surveyor-respondent-model)
-8.  [ncurl: Minimalist http Client](#ncurl-minimalist-http-client)
+8.  [ncurl: (Async) HTTP Client](#ncurl-async-http-client)
 9.  [stream: Websocket Client](#stream-websocket-client)
 10. [Building from source](#building-from-source)
 11. [Links](#links)
@@ -370,7 +370,7 @@ aio
 #> < recvAio >
 #>  - $data for message data
 aio$data |> str()
-#>  num [1:100000000] 1.079 0.855 -0.88 1.192 -0.777 ...
+#>  num [1:100000000] 0.809 -1.518 1.473 0.943 1.033 ...
 ```
 
 As `call_aio()` is blocking and will wait for completion, an alternative
@@ -405,37 +405,37 @@ an environment variable `NANONEXT_LOG`.
 
 ``` r
 logging(level = "info")
-#> 2022-03-29 13:53:51 [ log level ] set to: info
+#> 2022-03-29 14:33:28 [ log level ] set to: info
 
 pub <- socket("pub", listen = "inproc://nanobroadcast")
-#> 2022-03-29 13:53:51 [ sock open ] id: 9 | protocol: pub
-#> 2022-03-29 13:53:51 [ list start ] sock: 9 | url: inproc://nanobroadcast
+#> 2022-03-29 14:33:28 [ sock open ] id: 9 | protocol: pub
+#> 2022-03-29 14:33:28 [ list start ] sock: 9 | url: inproc://nanobroadcast
 sub <- socket("sub", dial = "inproc://nanobroadcast")
-#> 2022-03-29 13:53:51 [ sock open ] id: 10 | protocol: sub
-#> 2022-03-29 13:53:51 [ dial start ] sock: 10 | url: inproc://nanobroadcast
+#> 2022-03-29 14:33:28 [ sock open ] id: 10 | protocol: sub
+#> 2022-03-29 14:33:28 [ dial start ] sock: 10 | url: inproc://nanobroadcast
 
 sub |> subscribe(topic = "examples")
-#> 2022-03-29 13:53:51 [ subscribe ] sock: 10 | topic: examples
+#> 2022-03-29 14:33:28 [ subscribe ] sock: 10 | topic: examples
 pub |> send(c("examples", "this is an example"), mode = "raw", echo = FALSE)
 sub |> recv(mode = "character", keep.raw = FALSE)
 #> [1] "examples"           "this is an example"
 
 pub |> send(c("other", "this other topic will not be received"), mode = "raw", echo = FALSE)
 sub |> recv(mode = "character", keep.raw = FALSE)
-#> 2022-03-29 13:53:51 [ 8 ] Try again
+#> 2022-03-29 14:33:28 [ 8 ] Try again
 
 # specify NULL to subscribe to ALL topics
 sub |> subscribe(topic = NULL)
-#> 2022-03-29 13:53:51 [ subscribe ] sock: 10 | topic: ALL
+#> 2022-03-29 14:33:28 [ subscribe ] sock: 10 | topic: ALL
 pub |> send(c("newTopic", "this is a new topic"), mode = "raw", echo = FALSE)
 sub |> recv("character", keep.raw = FALSE)
 #> [1] "newTopic"            "this is a new topic"
 
 sub |> unsubscribe(topic = NULL)
-#> 2022-03-29 13:53:51 [ unsubscribe ] sock: 10 | topic: ALL
+#> 2022-03-29 14:33:28 [ unsubscribe ] sock: 10 | topic: ALL
 pub |> send(c("newTopic", "this topic will now not be received"), mode = "raw", echo = FALSE)
 sub |> recv("character", keep.raw = FALSE)
-#> 2022-03-29 13:53:51 [ 8 ] Try again
+#> 2022-03-29 14:33:28 [ 8 ] Try again
 
 # however the topics explicitly subscribed to are still received
 pub |> send(c("examples", "this example will still be received"), mode = "raw", echo = FALSE)
@@ -444,7 +444,7 @@ sub |> recv(mode = "character", keep.raw = FALSE)
 
 # set logging level back to the default of errors only
 logging(level = "error")
-#> 2022-03-29 13:53:51 [ log level ] set to: error
+#> 2022-03-29 14:33:28 [ log level ] set to: error
 
 close(pub)
 close(sub)
@@ -495,7 +495,7 @@ aio2$data
 # after the survey expires, the second resolves into a timeout error
 Sys.sleep(0.5)
 aio2$data
-#> 2022-03-29 13:53:52 [ 5 ] Timed out
+#> 2022-03-29 14:33:28 [ 5 ] Timed out
 #> 'errorValue' int 5
 
 close(sur)
@@ -510,36 +510,44 @@ integer message values.
 
 [« Back to ToC](#table-of-contents)
 
-### ncurl: Minimalist http Client
+### ncurl: Async HTTP Client
 
-`ncurl()` is a minimalist http(s) client. In normal use, it takes only
-one argument, the URL. It can follow redirects.
+`ncurl()` is a minimalist http(s) client.
+
+By setting `async = TRUE`, it performs requests asynchronously,
+returning immediately with a ‘recvAio’.
+
+For normal use, it takes just the URL. It can follow redirects.
 
 ``` r
 ncurl("http://httpbin.org/headers")
 #> $raw
 #>   [1] 7b 0a 20 20 22 68 65 61 64 65 72 73 22 3a 20 7b 0a 20 20 20 20 22 48 6f 73
 #>  [26] 74 22 3a 20 22 68 74 74 70 62 69 6e 2e 6f 72 67 22 2c 20 0a 20 20 20 20 22
 #>  [51] 58 2d 41 6d 7a 6e 2d 54 72 61 63 65 2d 49 64 22 3a 20 22 52 6f 6f 74 3d 31
-#>  [76] 2d 36 32 34 33 30 31 36 30 2d 31 30 36 36 64 32 64 35 32 35 33 34 62 34 37
-#> [101] 36 35 37 65 32 34 30 62 32 22 0a 20 20 7d 0a 7d 0a
+#>  [76] 2d 36 32 34 33 30 61 61 38 2d 32 33 32 30 39 39 30 63 34 66 32 39 35 39 65
+#> [101] 66 33 38 32 63 63 34 38 62 22 0a 20 20 7d 0a 7d 0a
 #> 
 #> $data
-#> [1] "{\n  \"headers\": {\n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-62430160-1066d2d52534b47657e240b2\"\n  }\n}\n"
+#> [1] "{\n  \"headers\": {\n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-62430aa8-2320990c4f2959ef382cc48b\"\n  }\n}\n"
 ```
 
 For advanced use, supports additional HTTP methods such as POST or PUT.
-In this respect, it may be used as a performant and lightweight method
-for making requests to REST APIs.
 
 ``` r
-res <- ncurl("http://httpbin.org/post", async = TRUE, "POST", "application/json", "Bearer APIKEY", '{"key": "value"}')
+res <- ncurl("http://httpbin.org/post", async = TRUE,
+             "POST", "application/json", "Bearer APIKEY", '{"key": "value"}')
+res
+#> < recvAio >
+#>  - $data for message data
+#>  - $raw for raw message
+
 call_aio(res)$data
-#> [1] "{\n  \"args\": {}, \n  \"data\": \"{\\\"key\\\": \\\"value\\\"}\", \n  \"files\": {}, \n  \"form\": {}, \n  \"headers\": {\n    \"Authorization\": \"Bearer APIKEY\", \n    \"Content-Length\": \"16\", \n    \"Content-Type\": \"application/json\", \n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-62430160-4b8917cd2b569d8c0294f5ca\"\n  }, \n  \"json\": {\n    \"key\": \"value\"\n  }, \n  \"origin\": \"79.173.189.204\", \n  \"url\": \"http://httpbin.org/post\"\n}\n"
+#> [1] "{\n  \"args\": {}, \n  \"data\": \"{\\\"key\\\": \\\"value\\\"}\", \n  \"files\": {}, \n  \"form\": {}, \n  \"headers\": {\n    \"Authorization\": \"Bearer APIKEY\", \n    \"Content-Length\": \"16\", \n    \"Content-Type\": \"application/json\", \n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-62430aa9-733452c942d2794e22818b4e\"\n  }, \n  \"json\": {\n    \"key\": \"value\"\n  }, \n  \"origin\": \"79.173.189.204\", \n  \"url\": \"http://httpbin.org/post\"\n}\n"
 ```
 
-There is also the option of performing requests asynchronously, in which
-case the function returns immediately with a ‘recvAio’.
+In this respect, it may be used as a performant and lightweight method
+for making REST API requests.
 
 [« Back to ToC](#table-of-contents)
 

man/ncurl.Rd

@@ -123,6 +123,16 @@ static void url_finalizer(SEXP xptr) {
 
 }
 
+static void tls_finalizer(SEXP xptr) {
+
+  if (R_ExternalPtrAddr(xptr) == NULL)
+    return;
+  nng_tls_config *xp = (nng_tls_config *) R_ExternalPtrAddr(xptr);
+  nng_tls_config_free(xp);
+  R_ClearExternalPtr(xptr);
+
+}
+
 /* core aio functions ------------------------------------------------------- */
 
 SEXP rnng_recv_aio(SEXP socket, SEXP timeout) {
@@ -1012,18 +1022,22 @@ SEXP rnng_ncurl_aio(SEXP http, SEXP method, SEXP ctype, SEXP auth, SEXP data) {
   R_RegisterCFinalizerEx(mtx, mtx_finalizer, TRUE);
   SEXP ares = PROTECT(R_MakeExternalPtr(res, R_NilValue, R_NilValue));
   R_RegisterCFinalizerEx(ares, res_finalizer, TRUE);
+  Rf_setAttrib(mtx, nano_IovSymbol, ares);
   SEXP areq = PROTECT(R_MakeExternalPtr(req, R_NilValue, R_NilValue));
   R_RegisterCFinalizerEx(areq, req_finalizer, TRUE);
+  R_MakeWeakRef(mtx, areq, R_NilValue, TRUE);
   SEXP acli = PROTECT(R_MakeExternalPtr(client, R_NilValue, R_NilValue));
   R_RegisterCFinalizerEx(acli, client_finalizer, TRUE);
+  R_MakeWeakRef(mtx, acli, R_NilValue, TRUE);
   SEXP aurl = PROTECT(R_MakeExternalPtr(url, R_NilValue, R_NilValue));
   R_RegisterCFinalizerEx(aurl, url_finalizer, TRUE);
-
-  Rf_setAttrib(mtx, nano_IovSymbol, ares);
-  Rf_setAttrib(mtx, nano_DialerSymbol, areq);
-  Rf_setAttrib(mtx, nano_ContextSymbol, acli);
-  Rf_setAttrib(mtx, nano_UrlSymbol, aurl);
-  Rf_setAttrib(mtx, nano_IdSymbol, Rf_ScalarInteger(tls));
+  R_MakeWeakRef(mtx, aurl, R_NilValue, TRUE);
+  if (tls) {
+    SEXP acfg = PROTECT(R_MakeExternalPtr(cfg, R_NilValue, R_NilValue));
+    R_RegisterCFinalizerEx(acfg, tls_finalizer, TRUE);
+    R_MakeWeakRef(mtx, acfg, R_NilValue, TRUE);
+    UNPROTECT(1);
+  }
   Rf_setAttrib(aio, nano_StateSymbol, mtx);
 
   UNPROTECT(6);
@@ -1063,6 +1077,13 @@ SEXP rnng_aio_http(SEXP aio) {
   code = nng_http_res_get_status(res);
   if (code != 200)
     REprintf("HTTP Server Response: %d %s\n", code, nng_http_res_get_reason(res));
+  if (code >= 300 && code < 400) {
+    const char *location = nng_http_res_get_header(res, "Location");
+    nng_aio_free(aiop);
+    R_ClearExternalPtr(aio);
+    Rf_setAttrib(aio, nano_StateSymbol, R_NilValue);
+    return Rf_mkString(location);
+  }
 
   nng_http_res_get_data(res, &dat, &sz);
   SEXP vec = PROTECT(Rf_allocVector(RAWSXP, sz));