tanker-core 2.6.2.beta.2 → 2.6.3.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69f962904a2700e1eff1d3f7d44a5a7f29be26c0048a89ffffc3ad5e5a856f82
-  data.tar.gz: 040e523c8912592aadec416c027cb925d0c6e2936e0d1364c6e6cd75cae9164c
+  metadata.gz: b340cd6c68ae50a570cb9b2fe022cef3e58d977ea496f6a9a9188805dbcefc8f
+  data.tar.gz: '08ed2f6c92839b80f1ad99298affcc5346baa1dd54cec35140a49dcbf1ea53af'
 SHA512:
-  metadata.gz: e515de3523845ec392141a9ed06baf9c936a863cb0d905384398232c705cf182377c97cf12efedebf83055b09df8ea6d8d02dabe6620b251489790cc22a54520
-  data.tar.gz: a60601421d1c3402ebf73d4e35cdc6127c367769523697b7495635ae0a56d2d84c8acba65e5e126f4de4164f2fddb0eede58a88acc45646b7fdcaa28baeb2f10
+  metadata.gz: db46bd49eef92e19a889758223a1ca7e187fefd2db5a47fbefd44f990a61a34ca57133bb01683130293c6830805e53b92ca7362538ca00aee4babc08600a7d50
+  data.tar.gz: 841f15d5be8536cca1426ce9e56696c8f053a3684d93ecefdb9f944caf6fc5411aaed74a416c3822495bf26cee104389918df00dda706e955430fe213e6deafd

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/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
@@ -174,14 +182,15 @@ module Tanker
     def initialize(tanker_stream, substream)
       @tanker_stream = tanker_stream
       @substream = substream
+    end
+
+    def init_io
+      read, @write = IO.pipe
 
       # The user will only read on the pipe, so we need something that reads
       # from Tanker and writes to the pipe, it's this thread.
       Thread.new { read_thread }
-    end
 
-    def init_io
-      read, @write = IO.pipe
       read
     end
 

data/lib/tanker/core/version.rb

@@ -2,7 +2,7 @@
 
 module Tanker
   class Core
-    VERSION = '2.6.2.beta.2'
+    VERSION = '2.6.3.beta.1'
 
     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.beta.2
+  version: 2.6.3.beta.1
 platform: ruby
 authors:
 - Tanker team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-21 00:00:00.000000000 Z
+date: 2020-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -165,8 +165,8 @@ 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/darwin-x86_64/libctanker.dylib
+- vendor/tanker/linux-x86_64/libctanker.so
 homepage: https://tanker.io
 licenses:
 - Apache-2.0