ovirt-engine-sdk 4.2.0 → 4.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf11e3460b2e00a5fd673a768a84b1e22657fec7
-  data.tar.gz: '028c4fd704c4591c5753de18f2dbbfdecbeac1e1'
+  metadata.gz: 573f19600decb51717ca7b46538158f0bfe145c9
+  data.tar.gz: a42480a7c2627d263106163ecd835c80f0ef2b53
 SHA512:
-  metadata.gz: cc8b6ac930ddb084da2dcd0e8164044939c8601e81e8d432495e0b3673401ecd583c77da9240498c4329a7085d41e1caa984585ae3da33a6d7086ee3acf6770d
-  data.tar.gz: 739766ec3dd856e92d9829c44a321109b6e5568097a98fb6a739ba435c293e8c6c85bf08fefb7b32df8da19dd1c4f8b889657fe29bff9a548648fae0414c07c8
+  metadata.gz: 3a8a06fe3746bf4c82c9d18c5d9dce0920f6202857444e830c4e917e2d8bacfc2ac9bdd802402a9049b7df029105837c41f1c0c94e3cd7ffc50750abefd66547
+  data.tar.gz: 97c010a0aee2fa5e496df698790a65be800522c4271db84aba09cf3fe6be1794aec263a0f7607edc22eb8aa48fda629a018e182d9e1d872c716b68626deb1219

data/CHANGES.adoc

@@ -2,6 +2,16 @@
 
 This document describes the relevant changes between releases of the SDK.
 
+== 4.2.1 / Dec 13 2017
+
+Bug fixes:
+
+* Fix handling of the `all_content` parameter
+  https://bugzilla.redhat.com/1525555[#1525555].
+
+* Limit the number of requests sent to `libcurl`
+  https://bugzilla.redhat.com/1525302[#1525302].
+
 == 4.2.0 / Dec 4 2017
 
 No chages, version `4.2.0` is identical to `4.2.0-beta2`, only the

data/ext/ovirtsdk4c/ov_http_client.c

@@ -64,16 +64,21 @@ static ID READ_ID;
 static ID STRING_ID;
 static ID STRING_IO_ID;
 static ID URI_ID;
+static ID WARN_ID;
+static ID WARN_Q_ID;
 static ID WRITE_ID;
 
 /* References to classes: */
-static VALUE URI_CLASS;
 static VALUE STRING_IO_CLASS;
+static VALUE URI_CLASS;
 
 /* Constants: */
 const char CR = '\x0D';
 const char LF = '\x0A';
 
+/* Version of libcurl: */
+static curl_version_info_data* libcurl_version;
+
 /* Before version 7.38.0 of libcurl the NEGOTIATE authentication method was named GSSNEGOTIATE: */
 #ifndef CURLAUTH_NEGOTIATE
 #define CURLAUTH_NEGOTIATE CURLAUTH_GSSNEGOTIATE
@@ -85,6 +90,21 @@ const char LF = '\x0A';
 #define CURLPIPE_HTTP1 1
 #endif
 
+/* Define options that may not be available in some versions of libcurl: */
+#if LIBCURL_VERSION_NUM < 0x071e00 /* 7.30.0 */
+#define CURLMOPT_MAX_HOST_CONNECTIONS 7
+#define CURLMOPT_MAX_PIPELINE_LENGTH 8
+#define CURLMOPT_MAX_TOTAL_CONNECTIONS 13
+#endif
+
+#if LIBCURL_VERSION_NUM < 0x070f03 /* 7.16.3 */
+#define CURLMOPT_MAXCONNECTS 6
+#endif
+
+#if LIBCURL_VERSION_NUM < 0x070f00 /* 7.16.0 */
+#define CURLMOPT_PIPELINING 3
+#endif
+
 typedef struct {
     VALUE io; /* IO */
     char* ptr;
@@ -131,6 +151,22 @@ static void ov_http_client_log_info(VALUE log, const char* format, ...) {
     }
 }
 
+static void ov_http_client_log_warn(VALUE log, const char* format, ...) {
+    VALUE enabled;
+    VALUE message;
+    va_list args;
+
+    if (!NIL_P(log)) {
+        enabled = rb_funcall(log, WARN_Q_ID, 0);
+        if (RTEST(enabled)) {
+            va_start(args, format);
+            message = rb_vsprintf(format, args);
+            rb_funcall(log, WARN_ID, 1, message);
+            va_end(args);
+        }
+    }
+}
+
 static void ov_http_client_check_closed(ov_http_client_object* object) {
     if (object->handle == NULL) {
         rb_raise(ov_error_class, "The client is already closed");
@@ -142,6 +178,7 @@ static void ov_http_client_mark(void* vptr) {
 
     ptr = vptr;
     rb_gc_mark(ptr->log);
+    rb_gc_mark(ptr->queue);
     rb_gc_mark(ptr->pending);
     rb_gc_mark(ptr->completed);
 }
@@ -192,6 +229,8 @@ static VALUE ov_http_client_alloc(VALUE klass) {
     ptr->handle = NULL;
     ptr->share = NULL;
     ptr->log = Qnil;
+    ptr->limit = 0;
+    ptr->queue = Qnil;
     ptr->pending = Qnil;
     ptr->completed = Qnil;
     ptr->compress = false;
@@ -567,16 +606,22 @@ static VALUE ov_http_client_initialize(int argc, VALUE* argv, VALUE self) {
         Check_Type(opt, T_FIXNUM);
         pipeline = NUM2LONG(opt);
     }
+    if (pipeline < 0) {
+        rb_raise(rb_eArgError, "The maximum pipeline length can't be %ld, minimum is 0.", pipeline);
+    }
 
     /* Get the value of the 'connections' parameter: */
     opt = rb_hash_aref(opts, CONNECTIONS_SYMBOL);
     if (NIL_P(opt)) {
-        connections = 0;
+        connections = 1;
     }
     else {
         Check_Type(opt, T_FIXNUM);
         connections = NUM2LONG(opt);
     }
+    if (connections < 1) {
+        rb_raise(rb_eArgError, "The maximum number of connections can't be %ld, minimum is 1.", connections);
+    }
 
    /* Get the value of the 'cookies' parameter. If it is a string it will be used as the path of the file where the
       cookies will be stored. If it is any other thing it will be treated as a boolean flag indicating if cookies
@@ -592,11 +637,22 @@ static VALUE ov_http_client_initialize(int argc, VALUE* argv, VALUE self) {
         ptr->cookies = NULL;
     }
 
+    /* Create the queue that contains requests that haven't been sent to libcurl yet: */
+    ptr->queue = rb_ary_new();
+
     /* Create the hash that contains the transfers are pending an completed. Both use the identity of the request
        as key. */
     ptr->completed = rb_funcall(rb_hash_new(), COMPARE_BY_IDENTITY_ID, 0);
     ptr->pending = rb_funcall(rb_hash_new(), COMPARE_BY_IDENTITY_ID, 0);
 
+    /* Calculate the max number of requests that can be handled by libcurl simultaneously. For versions of libcurl
+       newer than 7.30.0 the limit can be increased when using pipelining. For older versions it can't be increased
+       because libcurl would create additional connections for the requests that can't be pipelined. */
+    ptr->limit = connections;
+    if (pipeline > 0 && libcurl_version->version_num >= 0x071e00 /* 7.30.0 */) {
+        ptr->limit *= pipeline;
+    }
+
     /* Create the libcurl multi handle: */
     ptr->handle = curl_multi_init();
     if (ptr->handle == NULL) {
@@ -615,14 +671,47 @@ static VALUE ov_http_client_initialize(int argc, VALUE* argv, VALUE self) {
     /* Enable pipelining: */
     if (pipeline > 0) {
         curl_multi_setopt(ptr->handle, CURLMOPT_PIPELINING, CURLPIPE_HTTP1);
-#ifdef CURLMOPT_MAX_PIPELINE_LENGTH
-        curl_multi_setopt(ptr->handle, CURLMOPT_MAX_PIPELINE_LENGTH, pipeline);
-#endif
+        if (libcurl_version->version_num >= 0x071e00 /* 7.30.0 */) {
+            curl_multi_setopt(ptr->handle, CURLMOPT_MAX_PIPELINE_LENGTH, pipeline);
+        }
+        else {
+            ov_http_client_log_warn(
+                ptr->log,
+                "Can't set maximum pipeline length to %d, it isn't supported by libcurl %s. Upgrade to 7.30.0 or "
+                "newer to avoid this issue.",
+                pipeline,
+                libcurl_version->version
+            );
+        }
     }
+
+    /* Set the max number of connections: */
     if (connections > 0) {
-#ifdef CURLMOPT_MAX_HOST_CONNECTIONS
-        curl_multi_setopt(ptr->handle, CURLMOPT_MAX_HOST_CONNECTIONS, connections);
-#endif
+        if (libcurl_version->version_num >= 0x071e00 /* 7.30.0 */) {
+            curl_multi_setopt(ptr->handle, CURLMOPT_MAX_HOST_CONNECTIONS, connections);
+            curl_multi_setopt(ptr->handle, CURLMOPT_MAX_TOTAL_CONNECTIONS, connections);
+        }
+        else {
+            ov_http_client_log_warn(
+                ptr->log,
+                "Can't set maximum number of connections to %d, it isn't supported by libcurl %s. Upgrade to 7.30.0 "
+                "or newer to avoid this issue.",
+                connections,
+                libcurl_version->version
+            );
+        }
+        if (libcurl_version->version_num >= 0x070f03 /* 7.16.3 */) {
+            curl_multi_setopt(ptr->handle, CURLMOPT_MAXCONNECTS, connections);
+        }
+        else {
+            ov_http_client_log_warn(
+                ptr->log,
+                "Can't set total maximum connection cache size to %d, it isn't supported by libcurl %s. Upgrade to "
+                "7.16.3 or newer to avoid this issue.",
+                connections,
+                libcurl_version->version
+            );
+        }
     }
 
     return self;
@@ -922,7 +1011,7 @@ static void ov_http_client_prepare_handle(ov_http_client_object* client_ptr, ov_
     );
 }
 
-static VALUE ov_http_client_send(VALUE self, VALUE request) {
+static VALUE ov_http_client_submit(VALUE self, VALUE request) {
     CURL* handle;
     VALUE response;
     VALUE transfer;
@@ -992,7 +1081,26 @@ static VALUE ov_http_client_send(VALUE self, VALUE request) {
     return Qnil;
 }
 
+static VALUE ov_http_client_send(VALUE self, VALUE request) {
+    ov_http_client_object* ptr;
+
+    /* Get the pointer to the native object and check that it isn't closed: */
+    ov_http_client_ptr(self, ptr);
+    ov_http_client_check_closed(ptr);
+
+    /* If the limit hasn't been reached then submit the request directly to libcurl, otherwise put it in the queue: */
+    if (RHASH_SIZE(ptr->pending) < ptr->limit) {
+        ov_http_client_submit(self, request);
+    }
+    else {
+        rb_ary_push(ptr->queue, request);
+    }
+
+    return Qnil;
+}
+
 static VALUE ov_http_client_wait(VALUE self, VALUE request) {
+    VALUE next;
     VALUE result;
     ov_http_client_object* ptr;
     ov_http_client_wait_context context;
@@ -1001,15 +1109,24 @@ static VALUE ov_http_client_wait(VALUE self, VALUE request) {
     ov_http_client_ptr(self, ptr);
     ov_http_client_check_closed(ptr);
 
-    /* Work till the transfer has been completed: */
+    /* Work till the transfer has been completed. */
     context.handle = ptr->handle;
     context.code = CURLE_OK;
     context.cancel = false;
     for (;;) {
+        /* Move requests from the queue to libcurl: */
+        while (RARRAY_LEN(ptr->queue) > 0 && RHASH_SIZE(ptr->pending) < ptr->limit) {
+            next = rb_ary_shift(ptr->queue);
+            ov_http_client_submit(self, next);
+        }
+
+        /* Check if the response is already available, if so then return it: */
         result = rb_hash_delete(ptr->completed, request);
         if (!NIL_P(result)) {
             return result;
         }
+
+        /* If the response isn't available yet, then do some real work: */
         rb_thread_call_without_gvl(
             ov_http_client_wait_task,
             &context,
@@ -1082,6 +1199,8 @@ void ov_http_client_define(void) {
     STRING_ID              = rb_intern("string");
     STRING_IO_ID           = rb_intern("StringIO");
     URI_ID                 = rb_intern("URI");
+    WARN_ID                = rb_intern("warn");
+    WARN_Q_ID              = rb_intern("warn?");
     WRITE_ID               = rb_intern("write");
 
     /* Locate classes: */
@@ -1093,4 +1212,7 @@ void ov_http_client_define(void) {
     if (code != CURLE_OK) {
         rb_raise(ov_error_class, "Can't initialize libcurl: %s", curl_easy_strerror(code));
     }
+
+    /* Get the libcurl version: */
+    libcurl_version = curl_version_info(CURLVERSION_NOW);
 }

data/ext/ovirtsdk4c/ov_http_client.h

@@ -37,7 +37,14 @@ typedef struct {
     /* The logger: */
     VALUE log;
 
-    /* This hash store the transfers that are pending. The key of the hash is the request that initiated the transfer,
+    /* The max number of requests that can be processed simultaneously by libcurl. Will be calculated multiplying the
+       max number of connections by the pipeline length: */
+    int limit;
+
+    /* This queue contains the requests that have not yet been sent to libcurl for processing: */
+    VALUE queue;
+
+    /* This hash stores the transfers that are pending. The key of the hash is the request that initiated the transfer,
        and the value is the transfer itself. */
     VALUE pending;
 

data/lib/ovirtsdk4/connection.rb

@@ -101,8 +101,8 @@ module OvirtSDK4
     #   as the names of the headers. If the same header is provided here and in the `headers` parameter of a specific
     #   method call, then the `headers` parameter of the specific method call will have precedence.
     #
-    # @option opts [Integer] :connections (0) The maximum number of connections to open to the host. If the value is
-    #   `0` (the default) then the number of connections will be unlimited.
+    # @option opts [Integer] :connections (1) The maximum number of connections to open to the host. The value must
+    #   be greater than 0.
     #
     # @option opts [Integer] :pipeline (0) The maximum number of request to put in an HTTP pipeline without waiting for
     #   the response. If the value is `0` (the default) then pipelining is disabled.
@@ -126,7 +126,7 @@ module OvirtSDK4
       @proxy_username = opts[:proxy_username]
       @proxy_password = opts[:proxy_password]
       @headers = opts[:headers]
-      @connections = opts[:connections] || 0
+      @connections = opts[:connections] || 1
       @pipeline = opts[:pipeline] || 0
 
       # Check that the URL has been provided:
@@ -275,9 +275,7 @@ module OvirtSDK4
     def follow_link(object)
       # Check that the "href" has a value, as it is needed in order to retrieve the representation of the object:
       href = object.href
-      if href.nil?
-        raise Error, "Can't follow link because the 'href' attribute doesn't have a value"
-      end
+      raise Error, "Can't follow link because the 'href' attribute doesn't have a value" if href.nil?
 
       # Check that the value of the "href" attribute is compatible with the base URL of the connection:
       prefix = URI(@url).path
@@ -634,7 +632,7 @@ module OvirtSDK4
       # parameter. In order to better support those older versions of the engine we need to check if this parameter is
       # included in the request, and add the corresponding header.
       unless request.query.nil?
-        all_content = request.query['all_content']
+        all_content = request.query[:all_content]
         request.headers['All-Content'] = all_content unless all_content.nil?
       end
 

data/lib/ovirtsdk4/service.rb

@@ -175,7 +175,7 @@ module OvirtSDK4
       # Get the values of the options specific to this operation:
       specs.each do |name, kind|
         value = opts.delete(name)
-        query[name] = Writer.render(value, kind) if value
+        query[name] = Writer.render(value, kind) unless value.nil?
       end
 
       # Check the remaining options:
@@ -224,7 +224,7 @@ module OvirtSDK4
       # Get the values of the options specific to this operation:
       specs.each do |name, kind|
         value = opts.delete(name)
-        query[name] = Writer.render(value, kind) if value
+        query[name] = Writer.render(value, kind) unless value.nil?
       end
 
       # Check the remaining options:
@@ -274,7 +274,7 @@ module OvirtSDK4
       # Get the values of the options specific to this operation:
       specs.each do |name, kind|
         value = opts.delete(name)
-        query[name] = Writer.render(value, kind) if value
+        query[name] = Writer.render(value, kind) unless value.nil?
       end
 
       # Check the remaining options:
@@ -321,7 +321,7 @@ module OvirtSDK4
       # Get the values of the options specific to this operation:
       specs.each do |name, kind|
         value = opts.delete(name)
-        query[name] = Writer.render(value, kind) if value
+        query[name] = Writer.render(value, kind) unless value.nil?
       end
 
       # Check the remaining options:
@@ -407,9 +407,7 @@ module OvirtSDK4
     def internal_read_body(response)
       # First check if the response body is empty, as it makes no sense to check the content type if there is
       # no body:
-      if response.body.nil? || response.body.length.zero?
-        connection.raise_error(response, 'The response body is empty')
-      end
+      connection.raise_error(response, 'The response body is empty') if response.body.nil? || response.body.length.zero?
 
       # Check the content type, as otherwise the parsing will fail, and the resulting error message won't be explicit
       # about the cause of the problem:

data/lib/ovirtsdk4/version.rb

@@ -16,5 +16,5 @@
 
 
 module OvirtSDK4
-  VERSION = '4.2.0'.freeze
+  VERSION = '4.2.1'.freeze
 end

data/lib/ovirtsdk4/writer.rb

@@ -195,9 +195,7 @@ module OvirtSDK4
       begin
         if object.is_a?(Array)
           # For arrays we can't decide which tag to use, so the 'root' parameter is mandatory in this case:
-          if root.nil?
-            raise Error, "The 'root' option is mandatory when writing arrays"
-          end
+          raise Error, "The 'root' option is mandatory when writing arrays" if root.nil?
 
           # Write the root tag, and then recursively call the method to write each of the items of the array:
           cursor.write_start(root)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ovirt-engine-sdk
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.2.1
 platform: ruby
 authors:
 - Juan Hernandez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-04 00:00:00.000000000 Z
+date: 2017-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -151,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="