chef-powershell 18.0.3 → 18.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf6e34db30449b1eeef2a30e24af5d2357839b16ca91163cc8b46fc58d3cb717
-  data.tar.gz: e9af27d7f4a7c81ee8a43309d75aa7b355417ff850d7ca232d1a601b0c16f544
+  metadata.gz: f3943b91db500700d5fa545d1ac204c220f39f105ddffcfb3a9c1c7fa7d4a194
+  data.tar.gz: ee94470b0f02a82da5bb63aadefd4411b79398f6591f622d202264cf34a1f7ea
 SHA512:
-  metadata.gz: 181b87d2c761fd7f9766dd2265cc49d220bf3340ca1daa5c1adc23f56301563db1f1c4b709d1b0dcd3feef7e61eb6760a5a804f60410ff038d6ba168fcd89484
-  data.tar.gz: 9008aa802415f63719bb1b3cc0f5ca038959802e01e0a2679ca2cf67409a8ee4710f506f4c3cf60aad3f67f6051d07cdd33067b02da7f15030c1b1f839ef13f2
+  metadata.gz: dd20e5f7adb2d459a8f0006a919d220a1a73cb99d75d3c651166053378ffafc1bd2859ac1bd1dcdaba8074e3b84f648d4c786ea1f2789303f05562f78c7a45ab
+  data.tar.gz: 9c2419d28ea984490a4263588476a58726d94e1cf6c6d9da985ad649d2711a2a88484a78dd46e1170adf455b4eb4c747b664c6c1be3a0b302cac429e24a9fe8f

data/chef-powershell.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.6"
 
   spec.add_runtime_dependency "ffi", "~> 1.15"
-  spec.add_runtime_dependency "ffi-yajl", "~> 2.5"
+  spec.add_runtime_dependency "ffi-yajl", "~> 2.4"
 
   spec.metadata = {
     "bug_tracker_uri" => "https://github.com/chef/chef/issues",

data/lib/chef-powershell/powershell.rb

@@ -64,6 +64,10 @@ class ChefPowerShell
     end
 
     module PowerMod
+      class << self
+        attr_accessor :result_string, :retry_count, :exception, :result, :errors, :verbose, :hashed_outcome
+      end
+
       extend FFI::Library
       # FFI requires attaching to modules, not classes, so we need to
       # have a module here. The module level variables *could* be refactored
@@ -72,17 +76,29 @@ class ChefPowerShell
       @@ps_command = ""
       @@ps_timeout = -1
 
-      AllocateCallback = FFI::Function.new(:pointer, [:size_t]) do |size|
-        # Capture the pointer here so that Ruby knows that it is an
-        # FFI::MemoryPointer that can receive &.free. If you try to
-        # free the pointer from execute_powershell, Ruby will not have
-        # access to the type information and will core dump spectacularly.
-        @@pointer = FFI::MemoryPointer.new(:uchar, size)
-      end
-
-      def self.free_pointer
-        @@pointer&.free
-        @@pointer = nil
+      StoreResultCallback = FFI::Function.new(:bool, %i{pointer size_t}) do |data, size|
+        # try parsing the result *first* before returning from the function, and if it fails,
+        # return false so that the function can be retried from the C++ side.
+        @result_string = data.get_bytes(0, size).force_encoding("UTF-16LE").encode("UTF-8")
+        @hashed_outcome = FFI_Yajl::Parser.parse(@result_string)
+        @result = FFI_Yajl::Parser.parse(@hashed_outcome["result"])
+        @errors = @hashed_outcome["errors"]
+        @verbose = @hashed_outcome["verbose"]
+        true
+      rescue NoMethodError, FFI_Yajl::ParseError => e
+        @retry_count += 1
+        # capture exception so that it can be raised later, since otherwise
+        # we will be raising back to C++.
+        @exception = e
+        return true if @retry_count > 3
+
+        puts "Retrying PowerShell command execution #{@retry_count}"
+        sleep 1
+        false
+      rescue => e
+        # no retry for other exceptions
+        @exception = e
+        true
       end
 
       def self.set_ps_dll(value)
@@ -98,10 +114,12 @@ class ChefPowerShell
       end
 
       def self.do_work
+        @exception = nil
+        @retry_count = 0
         ffi_lib @@powershell_dll
         attach_function :execute_powershell, :ExecuteScript, %i{string int pointer}, :pointer
 
-        execute_powershell(@@ps_command, @@ps_timeout, AllocateCallback)
+        execute_powershell(@@ps_command, @@ps_timeout, StoreResultCallback)
       end
     end
 
@@ -117,13 +135,13 @@ class ChefPowerShell
 
       PowerMod.set_ps_command(script)
       execution = PowerMod.do_work
-      output = execution.read_utf16string
-      hashed_outcome = FFI_Yajl::Parser.parse(output)
-      @result = FFI_Yajl::Parser.parse(hashed_outcome["result"])
-      @errors = hashed_outcome["errors"]
-      @verbose = hashed_outcome["verbose"]
-    ensure
-      PowerMod.free_pointer
+      # we returned "true" to escape retry, but we still need to check the
+      # exception and raise it if it exists.
+      raise PowerMod.exception if PowerMod.exception
+
+      @result = PowerMod.result
+      @errors = PowerMod.errors
+      @verbose = PowerMod.verbose
     end
   end
 end

data/lib/chef-powershell/version.rb

@@ -16,5 +16,5 @@
 
 module ChefPowerShellModule
   CHEFPOWERSHELL_ROOT = File.expand_path("..", __dir__)
-  VERSION = "18.0.3".freeze
+  VERSION = "18.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-powershell
 version: !ruby/object:Gem::Version
-  version: 18.0.3
+  version: 18.1.0
 platform: ruby
 authors:
 - Chef Software, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-08 00:00:00.000000000 Z
+date: 2023-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.4'
 description: 
 email:
 - oss@chef.io