tanker-core 2.6.2.alpha.2 → 2.6.2.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c31a7dd72c30de5e9663ed4a673336087ea1b4643b8e0ee5286acbb3305c0384
-  data.tar.gz: 0b834e4736b7bdc08ed4514b0b6e9ee4e701bac3a1b5463459bec0ba72795aa1
+  metadata.gz: 638dddc98b2aba670d089303d2601a309a1f5cced6683148137e61de666c5edb
+  data.tar.gz: b86a802db223abadd7d90cd09d3584e073bc3e760703e4dcceb2345503908287
 SHA512:
-  metadata.gz: 11e72970a98eade34813b02f4f74db67548a4f869bba886591a4b9d864a6f3eebd8dde9727ba53abd6637724a46a48688143d696d2e8a1496eb5dc46f7f06588
-  data.tar.gz: 34b1e95c6aef86da9d8adb782523128486f60b67c5332036780fdda9f6a327671db29ef8bcb1038769c089c69663b0456a83a9fce378128376ecdc4ae9e6e198
+  metadata.gz: 8af8b985ed3b691a03fbc1af01f5796e673946474f83e543d08ae21b36aa18159c389a94bd43885fa685a5d6b5363c9642717a43573f3536d6cc9f16c2c91365
+  data.tar.gz: 4e7cf105a49f723739866e30c7b0807c5d78cc900729cb286d39e4fdda7b513960bdd239f082caa0df4cd99461a380bfd62cd73e686ea19ed596fedf0357bb85

data/lib/tanker/c_tanker/c_lib.rb

@@ -1,15 +1,10 @@
 # frozen_string_literal: true
 
+require 'ffi/platform'
+
 module Tanker::CTanker
   def self.get_path(name)
-    if /darwin/ =~ RUBY_PLATFORM
-      ext = '.dylib'
-      subdir = 'mac64'
-    else
-      ext = '.so'
-      subdir = 'linux64'
-    end
-
-    File.expand_path "../../../vendor/libctanker/#{subdir}/tanker/lib/lib#{name}#{ext}", __dir__
+    File.expand_path "../../../vendor/tanker/#{FFI::Platform::OS}-#{FFI::Platform::ARCH}/"\
+      "#{FFI::Platform::LIBPREFIX}#{name}.#{FFI::Platform::LIBSUFFIX}", __dir__
   end
 end

data/lib/tanker/core/init.rb

@@ -3,22 +3,34 @@
 module Tanker
   # Main entry point for the Tanker SDK. Can open a Tanker session.
   class Core
+    @log_handler_lock = Mutex.new
+    @log_handler_set = 0
+
+    def self.test_and_set_log_handler
+      @log_handler_lock.synchronize do
+        is_set = @log_handler_set
+        @log_handler_set = 1
+        return is_set
+      end
+    end
+
     def self.set_log_handler(&block) # rubocop:disable Naming/AccessorMethodName
+      @log_handler_set = 1
       @log_handler = lambda do |clog|
         block.call LogRecord.new clog[:category], clog[:level], clog[:file], clog[:line], clog[:message]
       end
       CTanker.tanker_set_log_handler @log_handler
     end
 
-    # Do not spam the console of our users. This must be done first to be effective.
-    set_log_handler { |_| }
-
     def initialize(options)
       # tanker_init is not called globally to avoid potential logs at global scope
       # some frameworks like to pre-execute statements at global scope and then fork, this fork can
       # interact badly with the threads used in the log handler, so never call Tanker at global scope
       CTanker.tanker_init
 
+      # Do not spam the console of our users.
+      self.class.set_log_handler { |_| } unless self.class.test_and_set_log_handler == 1
+
       @revoke_event_handlers = Set.new
       @ctanker = CTanker.tanker_create(options).get
       @freed = false

data/lib/tanker/core/stream.rb

@@ -3,6 +3,29 @@
 require 'English'
 require 'tanker/c_tanker'
 
+# Because Ruby only has synchronous streams, we can't read them on Tanker's
+# thread (in the read callback). To work around that, we start a new Thread for
+# each read operation. This is not that bad because Ruby uses a thread pool
+# behind the scenes and creating a Thread is usually just a work pushed on a
+# queue.
+#
+# Also, there doesn't seem to easily create an IO object. The simplest way is to
+# create a pipe. A pipe is a stream where you read everything you write into it.
+# Tanker streams however are pull streams, so there must be something that pulls
+# from the Tanker stream and pushes onto the IO stream. We start a long-running
+# thread for that which just loops.
+#
+# Because so much is happening in parallel, synchronization is not trivial.
+# There's one mutex per stream, and we lock that same mutex for every critical
+# section. Here are some important constraints that must be held:
+# - Do not copy data to the Tanker buffer if tanker_stream_close has been
+# called
+# - Do not call tanker_stream_read_operation_finish if tanker_stream_close has
+# been called
+# - On the output stream, do not call tanker_stream_read on a closed/closing
+# stream. Though it is ok to close the stream after the call, but before the
+# future is resolved.
+
 module Tanker
   class Core
     def encrypt_stream(stream, encryption_options = nil)
@@ -95,21 +118,6 @@ module Tanker
     end
   end
 
-  # IMPORTANT: about synchronization
-  # Because of a design flaw in the Tanker C streaming API, it is difficult to
-  # handle cancelation. When canceling a read (closing the stream), Tanker
-  # doesn't forward the cancelation request to the input stream (there's no
-  # callback for that), which means that the callback maybe writing to a buffer
-  # that's being freed. We worked around that by adding a mutex and locking it
-  # in both the output stream and the input stream.
-  # Things to be careful about:
-  # - Do not copy data to the Tanker buffer if tanker_stream_close has been
-  # called
-  # - Do not call tanker_stream_read_operation_finish if tanker_stream_close has
-  # been called
-  # - On the output stream, do not call tanker_stream_read on a closed/closing
-  # stream. Though it is ok to close the stream after the call, but before the
-  # future is resolved.
   class IoToTankerStreamWrapper
     attr_reader :error
     attr_reader :read_method

data/lib/tanker/core/version.rb

@@ -2,7 +2,7 @@
 
 module Tanker
   class Core
-    VERSION = '2.6.2.alpha.2'
+    VERSION = '2.6.2.alpha.3'
 
     def self.native_version
       CTanker.tanker_version_string

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tanker-core
 version: !ruby/object:Gem::Version
-  version: 2.6.2.alpha.2
+  version: 2.6.2.alpha.3
 platform: ruby
 authors:
 - Tanker team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-20 00:00:00.000000000 Z
+date: 2020-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -165,8 +165,7 @@ files:
 - lib/tanker/encryption_options.rb
 - lib/tanker/error.rb
 - lib/tanker/sharing_options.rb
-- vendor/libctanker/linux64/tanker/lib/libctanker.so
-- vendor/libctanker/mac64/tanker/lib/libctanker.dylib
+- vendor/tanker/linux-x86_64/libctanker.so
 homepage: https://tanker.io
 licenses:
 - Apache-2.0