async-safe 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e20fdea7f6f63f3a47aa8be85492fa2725e6b3ea2c0284de63dd6fe45af6f49c
-  data.tar.gz: 6556e3ed8f46cfe8157983229d4584a6b01eb0e8f2b36f83fe3ec5f541211830
+  metadata.gz: 52f743f5c66ba254659d3f6afb52e8f6bf1189f395ca931e708890eea1fe4e00
+  data.tar.gz: 4a89412e5fd61a9c4c5bdac4d90a6897e70fbeccac5301b58e56a3cf622542a8
 SHA512:
-  metadata.gz: 6a02637fc476e5e38a6b1952394ad99ca3fbe13b106b6d7ac0abbafc7f285167f3a0ef9302a28ac0e12f29a70edce7158ea2690b88d309e99a5d1f073da58580
-  data.tar.gz: 24fbc11d3be799f80649e1a487edc6f1b4040fbb0e4688d590f2caafceb76b761c298569a3b2384939844753eec8b788ff0bf70d8f820b3fbe4c9d9403183542
+  metadata.gz: b7b6981fe90ffdbef57060678ba4988202333120848cc40d4528873b9a6ccd5b39a53549d35886d75a08343db12697855eb56c74af9d06c9434e2a153d6caef5
+  data.tar.gz: 8a0ec23a746938beeadd581af8e7aaa19dc0219826343a40ef9d93071e34b2956e67fcab1c33c3529940716195b7958e2f99a127c2e6c47ca72e333f0c783f61

data/context/getting-started.md

@@ -25,7 +25,7 @@ Async::Safe.enable!
 
 When a violation is detected, an `Async::Safe::ViolationError` will be raised immediately with details about the object, method, and execution contexts involved.
 
-## Single-Owner Model
+### Single-Owner Model
 
 By default, all objects are assumed to follow a **single-owner model** - they should only be accessed from one fiber/thread at a time:
 
@@ -51,7 +51,7 @@ Fiber.schedule do
 end
 ~~~
 
-## Marking Async-Safe Classes
+### Marking Async-Safe Classes
 
 Mark entire classes as safe for concurrent access:
 
@@ -90,7 +90,7 @@ class MyQueue
 end
 ~~~
 
-## Marking Async-Safe Methods
+### Marking Async-Safe Methods
 
 Mark specific methods as async-safe:
 
@@ -122,7 +122,7 @@ Fiber.schedule do
 end
 ~~~
 
-## Transferring Ownership
+### Transferring Ownership
 
 Explicitly transfer ownership between fibers:
 

data/lib/async/safe/builtins.rb

@@ -20,3 +20,30 @@ Fiber::ASYNC_SAFE = true
 
 # ObjectSpace::WeakMap is async-safe:
 ObjectSpace::WeakMap::ASYNC_SAFE = true
+
+module Async
+	module Safe
+		module TransferableThreadQueue
+			def pop(...)
+				object = super(...)
+				Async::Safe.transfer(object)
+				object
+			end
+			
+			def deq(...)
+				object = super(...)
+				Async::Safe.transfer(object)
+				object
+			end
+			
+			def shift(...)
+				object = super(...)
+				Async::Safe.transfer(object)
+				object
+			end
+		end
+	end
+end
+
+Thread::Queue.prepend(Async::Safe::TransferableThreadQueue)
+Thread::SizedQueue.prepend(Async::Safe::TransferableThreadQueue)

data/lib/async/safe/monitor.rb

@@ -64,10 +64,13 @@ module Async
 			ASYNC_SAFE = true
 			
 			# Initialize a new monitor instance.
-			def initialize
+			#
+			# @parameter logger [Object | Nil] Optional logger to use for violations instead of raising exceptions.
+			def initialize(logger: nil)
 				@owners = ObjectSpace::WeakMap.new
 				@mutex = Thread::Mutex.new
 				@trace_point = nil
+				@logger = logger
 			end
 			
 			attr :owners
@@ -128,12 +131,11 @@ module Async
 					if owner = @owners[object]
 						# Violation if accessed from different fiber:
 						if owner != current
-							raise ViolationError.new(
-								target: object,
-								method: method,
-								owner: owner,
-								current: current,
-							)
+							if @logger
+								@logger.warn(self, "Async::Safe violation detected!", klass: klass, method: method, owner: owner, current: current, backtrace: caller_locations(3..))
+							else
+								raise ViolationError.new(target: object, method: method, owner: owner, current: current)
+							end
 						end
 					else
 						# First access - record owner:

data/lib/async/safe/version.rb

@@ -5,7 +5,7 @@
 
 module Async
 	module Safe
-		VERSION = "0.1.0"
+		VERSION = "0.2.0"
 	end
 end
 

data/lib/async/safe.rb

@@ -61,8 +61,14 @@ module Async
 			#
 			# This activates a TracePoint that tracks object access across fibers and threads.
 			# There is no performance overhead when monitoring is disabled.
-			def enable!
-				@monitor ||= Monitor.new
+			#
+			# @parameter logger [Object | Nil] Optional logger to use for violations instead of raising exceptions.
+			def enable!(logger: nil)
+				if @monitor
+					raise "Async::Safe is already enabled!"
+				end
+				
+				@monitor = Monitor.new(logger: logger)
 				@monitor.enable!
 			end
 			

data/readme.md

@@ -22,6 +22,11 @@ Please see the [project documentation](https://socketry.github.io/async-safe/) f
 
 Please see the [project releases](https://socketry.github.io/async-safe/releases/index) for all releases.
 
+### v0.2.0
+
+  - `Thread::Queue` transfers ownership of objects popped from it.
+  - Add support for `logger:` option in `Async::Safe.enable!` which logs violations instead of raising errors.
+
 ### v0.1.0
 
   - Implement TracePoint-based ownership tracking.

data/releases.md

@@ -1,5 +1,10 @@
 # Releases
 
+## v0.2.0
+
+  - `Thread::Queue` transfers ownership of objects popped from it.
+  - Add support for `logger:` option in `Async::Safe.enable!` which logs violations instead of raising errors.
+
 ## v0.1.0
 
   - Implement TracePoint-based ownership tracking.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-safe
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Samuel Williams