async-utilization 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4114f3169e309e3062d153202d83d3eb7b38031dc47a5fbb0df0e3cf63296e9d
-  data.tar.gz: 68eca39b660a7d6414e12bb79ee464d3267d62ec4a1a5ab39c23742a6bb645a4
+  metadata.gz: 2494a3f35fcbfd987fe6520ceda64225ccc6592ebe4072f0260f38a430d0d3fc
+  data.tar.gz: '0668665f31e13ac0d00c5eded51ad94f7f394927318e05ef83f7a5cd818e22e3'
 SHA512:
-  metadata.gz: 45cd92a3a8ae94aa2c2d6847cff090c7e5a1fadd96cd43dad062c2cf1384d9c1743926311151386a32517d41757e267fb35c5e7e276a4f7cead08468a83c9b68
-  data.tar.gz: 901a1771f0116652411a7cdbb5122669e814b4dc3594646d764179851ba0cf1ef7e8800838191bf2a67e2db3c877513ced9f3df4f58adedc8b4a84f4a0800890
+  metadata.gz: 863148a136e0a8696c337c5c24e18f8751bea2b586f1a703235992103c5454d1621d9296c401ded2d75aa532255beab3ae7ee2ad84211a8eb3b9971aac7b5fc8
+  data.tar.gz: 4a6e0ee78558c67dd2f8c5e8bb284c0aaed26cb23a3df700b451841a8081dafd9973ff2ef033f7f137cae4e657b60eae29cfeca89a8edd7ca3233f46a7318ce5

data/lib/async/utilization/metric.rb

@@ -11,16 +11,26 @@ module Async
 		# including the buffer, offset, and type. When the observer changes, the cache
 		# is invalidated and rebuilt on the next access.
 		class Metric
+			# Create a new metric for the given field and observer.
+			#
+			# @parameter field [Symbol] The field name for this metric.
+			# @parameter observer [Observer | Nil] The observer to associate with this metric.
+			# @returns [Metric] A new metric instance.
+			def self.for(field, observer)
+				self.new(field).tap do |metric|
+					metric.observer = observer
+				end
+			end
+			
 			# Initialize a new metric.
 			#
 			# @parameter name [Symbol] The field name for this metric.
-			# @parameter registry [Registry] The registry instance to use.
-			def initialize(name, registry)
+			def initialize(name)
 				@name = name.to_sym
-				@registry = registry
 				@value = 0
-				@cache_valid = false
-				@cached_field_info = nil
+				
+				@observer = nil
+				@cached_field = nil
 				@cached_buffer = nil
 				@guard = Mutex.new
 			end
@@ -34,19 +44,35 @@ module Async
 			# @attribute [Mutex] The mutex for thread safety.
 			attr :guard
 			
-			# Invalidate the cached field information.
+			# Set the observer and rebuild cache.
 			#
-			# Called when the observer changes to force cache rebuild.
-			def invalidate
-				@cache_valid = false
-				@cached_field_info = nil
-				@cached_buffer = nil
+			# This is called when the registry assigns a new observer (or removes it).
+			# The cache is invalidated and then immediately recomputed so that the
+			# fast write path doesn't need to re-check the observer on the first write.
+			#
+			# @parameter observer [Observer | Nil] The new observer (or nil).
+			def observer=(observer)
+				@guard.synchronize do
+					@observer = observer
+					
+					if @observer
+						if field = @observer.schema[@name]
+							if buffer = @observer.buffer
+								@cached_field = field
+								@cached_buffer = buffer
+								
+								return write_direct(@value)
+							end
+						end
+					end
+					
+					@cached_field = nil
+					@cached_buffer = nil
+				end
 			end
 			
 			# Increment the metric value.
 			#
-			# Uses the fast path (direct buffer write) when cache is valid and observer is available.
-			#
 			# @returns [Integer] The new value of the field.
 			def increment
 				@guard.synchronize do
@@ -103,28 +129,6 @@ module Async
 			
 			protected
 			
-			# Check if the cache is valid and rebuild if necessary.
-			#
-			# Always attempts to build the cache if it's invalid. Returns true if cache
-			# is now valid (observer exists, field is in schema, and buffer is available), false otherwise.
-			#
-			# @returns [bool] True if cache is valid, false otherwise.
-			def ensure_cache_valid!
-				unless @cache_valid
-					if observer = @registry.observer
-						if field = observer.schema[@name]
-							if buffer = observer.buffer
-								@cached_field_info = field
-								@cached_buffer = buffer
-							end
-						end
-					end
-					
-					# Once we've validated the cache, even if there was no observer or buffer, we mark it as valid, so that we don't try to revalidate it again:
-					@cache_valid = true
-				end
-			end
-			
 			# Write directly to the cached buffer if available.
 			#
 			# This is the fast path that avoids hash lookups. Always ensures cache is valid
@@ -133,16 +137,12 @@ module Async
 			# @parameter value [Numeric] The value to write.
 			# @returns [Boolean] Whether the write succeeded.
 			def write_direct(value)
-				self.ensure_cache_valid!
-				
 				if @cached_buffer
-					@cached_buffer.set_value(@cached_field_info.type, @cached_field_info.offset, value)
+					@cached_buffer.set_value(@cached_field.type, @cached_field.offset, value)
 				end
 				
 				return true
 			rescue => error
-				# If write fails, log warning but don't invalidate cache
-				# The error might be transient, and invalidating would force hash lookups
 				Console.warn(self, "Failed to write metric value!", metric: {name: @name, value: value}, exception: error)
 				
 				return false

data/lib/async/utilization/observer.rb

@@ -3,7 +3,6 @@
 # Released under the MIT License.
 # Copyright, 2026, by Samuel Williams.
 
-require "console"
 require_relative "schema"
 
 module Async
@@ -71,21 +70,6 @@ module Async
 			
 			# @attribute [IO::Buffer] The mapped buffer for shared memory.
 			attr :buffer
-			
-			# Set a field value.
-			#
-			# Writes the value to shared memory at the offset defined by the schema.
-			# Only fields defined in the schema will be written.
-			#
-			# @parameter field [Symbol] The field name to set.
-			# @parameter value [Numeric] The value to set.
-			def set(field, value)
-				if field = @schema[field]
-					@buffer.set_value(field.type, field.offset, value)
-				end
-			rescue => error
-				Console.warn(self, "Failed to set field in shared memory!", field: field, exception: error)
-			end
 		end
 	end
 end

data/lib/async/utilization/registry.rb

@@ -3,6 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2026, by Samuel Williams.
 
+require "console"
+
 module Async
 	module Utilization
 		# Registry for emitting utilization metrics.
@@ -61,26 +63,23 @@ module Async
 			
 			# Set the observer for the registry.
 			#
-			# When an observer is set, it is notified of all current metric values
-			# so it can sync its state. The observer must implement `set(field, value)`.
-			# All cached metrics are invalidated when the observer changes.
+			# When an observer is set, all cached metrics are updated so they write
+			# directly to the observer's buffer. The observer must expose `schema`
+			# and `buffer` attributes.
 			#
-			# @parameter observer [#set] The observer to set.
+			# @parameter observer [Observer | Nil] The observer to set.
 			def observer=(observer)
 				@guard.synchronize do
-					# Invalidate all cached metrics
+					@observer = observer
+					
+					# Invalidate all cached metrics with new observer (or nil)
 					@metrics.each_value do |metric|
-						metric.invalidate
+						metric.observer = observer
 					end
 					
-					@observer = observer
+					# Console.info(self, "Observer assigned", observer: observer, metric_count: @metrics.size)
 				end
 				
-				# Notify observer of all current metric values (outside guard to avoid deadlock)
-				@metrics.each do |name, metric|
-					value = metric.guard.synchronize{metric.value}
-					observer.set(name, value)
-				end
 			end
 			
 			# Set a field value.
@@ -135,7 +134,7 @@ module Async
 				field = field.to_sym
 				
 				@guard.synchronize do
-					@metrics[field] ||= Metric.new(field, self)
+					@metrics[field] ||= Metric.for(field, @observer)
 				end
 			end
 		end

data/lib/async/utilization/version.rb

@@ -7,6 +7,6 @@
 module Async
 	# @namespace
 	module Utilization
-		VERSION = "0.3.1"
+		VERSION = "0.3.2"
 	end
 end

data/readme.md

@@ -14,6 +14,10 @@ Please see the [project documentation](https://socketry.github.io/async-utilizat
 
 Please see the [project releases](https://socketry.github.io/async-utilization/releases/index) for all releases.
 
+### v0.3.2
+
+  - Better observer state handling.
+
 ### v0.3.1
 
   - Remove unused `thread-local` dependency.

data/releases.md

@@ -1,5 +1,9 @@
 # Releases
 
+## v0.3.2
+
+  - Better observer state handling.
+
 ## v0.3.1
 
   - Remove unused `thread-local` dependency.

data/test/async/utilization/metric.rb

@@ -154,8 +154,8 @@ describe Async::Utilization::Metric do
 	end
 	
 	it "writes directly to shared memory when observer is set" do
-		registry.observer = observer
 		metric = registry.metric(:total_requests)
+		registry.observer = observer
 		
 		metric.set(42)
 		
@@ -216,22 +216,6 @@ describe Async::Utilization::Metric do
 		expect(metric1).to be == metric2
 	end
 	
-	it "falls back to observer.set when write_direct fails" do
-		registry.observer = observer
-		metric = registry.metric(:total_requests)
-		
-		# Force cache to be invalid by invalidating it
-		metric.invalidate
-		
-		# Set a value - should fall back to observer.set
-		metric.set(42)
-		expect(metric.value).to be == 42
-		
-		# Verify it was written to shared memory
-		buffer = IO::Buffer.map(File.open(shm_path, "r+b"), file_size, 0)
-		expect(buffer.get_value(:u64, 0)).to be == 42
-	end
-	
 	it "handles write errors gracefully" do
 		registry.observer = observer
 		metric = registry.metric(:total_requests)
@@ -239,10 +223,6 @@ describe Async::Utilization::Metric do
 		# Set a value first to build the cache
 		metric.set(10)
 		
-		# Verify cache is built
-		expect(metric.instance_variable_get(:@cache_valid)).to be == true
-		cached_buffer = metric.instance_variable_get(:@cached_buffer)
-		
 		# Create an invalid buffer that will raise an error
 		invalid_buffer = Object.new
 		def invalid_buffer.set_value(type, offset, value)
@@ -251,13 +231,10 @@ describe Async::Utilization::Metric do
 		
 		metric.instance_variable_set(:@cached_buffer, invalid_buffer)
 		
-		# Should not raise, but log warning and keep cache valid
+		# Should not raise, but log warning
 		metric.set(42)
 		expect(metric.value).to be == 42
 		
-		# Cache should remain valid (not invalidated on error)
-		expect(metric.instance_variable_get(:@cache_valid)).to be == true
-		
 		# Assert that a warning was logged
 		expect_console.to have_logged(
 			severity: be == :warn,
@@ -265,4 +242,27 @@ describe Async::Utilization::Metric do
 			message: be == "Failed to write metric value!"
 		)
 	end
+	
+	it "clears cache when observer is removed" do
+		registry.observer = observer
+		metric = registry.metric(:total_requests)
+		metric.set(10)
+		
+		# Remove observer — cache should be cleared
+		registry.observer = nil
+		
+		# Write should not go to the old buffer
+		metric.set(99)
+		
+		buffer = IO::Buffer.map(File.open(shm_path, "r+b"), file_size, 0)
+		expect(buffer.get_value(:u64, 0)).to be == 10
+		
+		# In-memory value is still updated
+		expect(metric.value).to be == 99
+		
+		# Re-attaching observer should sync the current value
+		registry.observer = observer
+		buffer = IO::Buffer.map(File.open(shm_path, "r+b"), file_size, 0)
+		expect(buffer.get_value(:u64, 0)).to be == 99
+	end
 end

data/test/async/utilization/observer.rb

@@ -4,13 +4,11 @@
 # Copyright, 2026, by Samuel Williams.
 
 require "sus"
-require "sus/fixtures/console/captured_logger"
 require "sus/fixtures/temporary_directory_context"
 require "async/utilization"
 require "fileutils"
 
 describe Async::Utilization::Observer do
-	include Sus::Fixtures::Console::CapturedLogger
 	include Sus::Fixtures::TemporaryDirectoryContext
 	
 	let(:shm_path) {File.join(root, "test.shm")}
@@ -41,68 +39,30 @@ describe Async::Utilization::Observer do
 		expect(observer.schema).to be == schema
 	end
 	
-	it "can write values to shared memory" do
-		observer.set(:total_requests, 42)
-		observer.set(:active_requests, 5)
-		
-		# Read back from file to verify
-		buffer = IO::Buffer.map(File.open(shm_path, "r+b"), file_size, 0)
-		expect(buffer.get_value(:u64, 0)).to be == 42
-		expect(buffer.get_value(:u32, 8)).to be == 5
-	end
-	
 	with "non-page-aligned offsets" do
 		let(:file_size) {IO::Buffer::PAGE_SIZE * 2}
 		let(:offset) {100}  # Not page-aligned
 		
-		it "handles non-page-aligned offsets" do
-			observer.set(:total_requests, 100)
-			observer.set(:active_requests, 20)
+		it "maps values at the correct offset" do
+			observer.buffer.set_value(:u64, schema[:total_requests].offset, 100)
+			observer.buffer.set_value(:u32, schema[:active_requests].offset, 20)
 			
-			# Read back from file at the correct offset
+			# Read back from file at the correct byte position
 			buffer = IO::Buffer.map(File.open(shm_path, "r+b"), file_size, 0)
-			expect(buffer.get_value(:u64, offset)).to be == 100
-			expect(buffer.get_value(:u32, offset + 8)).to be == 20
+			expect(buffer.get_value(:u64, offset + schema[:total_requests].offset)).to be == 100
+			expect(buffer.get_value(:u32, offset + schema[:active_requests].offset)).to be == 20
 		end
 	end
 	
-	it "ignores fields not in schema" do
-		# Should not raise an error
-		observer.set(:unknown_field, 999)
-		
-		# Verify nothing was written
-		buffer = IO::Buffer.map(File.open(shm_path, "r+b"), file_size, 0)
-		expect(buffer.get_value(:u64, 0)).to be == 0
-	end
-	
 	with "page-aligned offsets" do
 		let(:file_size) {page_size * 2}
 		let(:segment_size) {page_size}
 		
-		it "handles page-aligned offsets without slicing" do
-			expect(observer).to be_a(Async::Utilization::Observer)
-			observer.set(:total_requests, 123)
+		it "maps values at the correct offset" do
+			observer.buffer.set_value(:u64, schema[:total_requests].offset, 123)
 			
-			# Verify value was written
 			buffer = IO::Buffer.map(File.open(shm_path, "r+b"), file_size, 0)
-			expect(buffer.get_value(:u64, 0)).to be == 123
+			expect(buffer.get_value(:u64, schema[:total_requests].offset)).to be == 123
 		end
 	end
-	
-	it "handles errors gracefully when setting values" do
-		# Create an invalid buffer that will cause an error
-		# We'll mock the buffer to raise an error
-		buffer = observer.instance_variable_get(:@buffer)
-		expect(buffer).to receive(:set_value).and_raise(IOError, "Buffer error")
-		
-		# Should not raise, but log a warning
-		observer.set(:total_requests, 42)
-		
-		# Assert that a warning was logged
-		expect_console.to have_logged(
-			severity: be == :warn,
-			subject: be_a(Async::Utilization::Observer),
-			message: be == "Failed to set field in shared memory!"
-		)
-	end
 end

data/test/async/utilization/registry.rb

@@ -56,44 +56,24 @@ describe Async::Utilization::Registry do
 		expect(registry.values[:test_field]).to be == 0
 	end
 	
-	it "can set an observer" do
-		observer = Object.new
-		def observer.set(field, value); end
-		
-		registry.set(:test_field, 10)
-		registry.observer = observer
-		
-		expect(registry.observer).to be == observer
-	end
-	
 	it "notifies observer when values change" do
-		values_set = []
-		
-		# Create a proper observer with schema
 		schema = Async::Utilization::Schema.build(test_field: :u64)
-		observer = Object.new
+		buffer = IO::Buffer.new(8)
 		
-		# Define methods on observer
-		observer.define_singleton_method(:set) do |field, value|
-			values_set << [field, value]
-		end
+		observer = Object.new
 		observer.define_singleton_method(:schema){schema}
-		observer.define_singleton_method(:buffer){nil}  # No buffer, so write_direct will return false
+		observer.define_singleton_method(:buffer){buffer}
 		
 		registry.set(:test_field, 5)
 		registry.observer = observer
 		
-		# Observer should be notified of existing values
-		expect(values_set).to be(:include?, [:test_field, 5])
+		# Buffer should be synced with the existing value on observer assignment
+		expect(buffer.get_value(:u64, 0)).to be == 5
 		
-		# Clear and test new changes
-		# Note: Since observer has no buffer, write_direct will return false
-		# and no notification will occur (as per new design)
-		values_set.clear
 		registry.increment(:test_field)
 		
-		# With no buffer, write_direct fails silently, so no notification
-		expect(values_set).to be == []
+		# Buffer should reflect the incremented value
+		expect(buffer.get_value(:u64, 0)).to be == 6
 	end
 	
 	it "uses metric method for fast path" do
@@ -117,12 +97,35 @@ describe Async::Utilization::Registry do
 		expect(registry.values).to have_keys(module_set_test: be == 99)
 	end
 	
-	it "can set observer" do
+	it "wires up existing metrics when observer is assigned" do
+		schema = Async::Utilization::Schema.build(test_field: :u64)
+		buffer = IO::Buffer.new(8)
+		observer = Object.new
+		observer.define_singleton_method(:schema){schema}
+		observer.define_singleton_method(:buffer){buffer}
+		
+		registry.set(:test_field, 7)
+		registry.observer = observer
+		
+		expect(buffer.get_value(:u64, 0)).to be == 7
+	end
+	
+	it "stops writing to buffer when observer is removed" do
+		schema = Async::Utilization::Schema.build(test_field: :u64)
+		buffer = IO::Buffer.new(8)
 		observer = Object.new
-		def observer.set(field, value); end
+		observer.define_singleton_method(:schema){schema}
+		observer.define_singleton_method(:buffer){buffer}
 		
 		registry.observer = observer
+		registry.set(:test_field, 5)
+		expect(buffer.get_value(:u64, 0)).to be == 5
+		
+		registry.observer = nil
+		registry.set(:test_field, 99)
 		
-		expect(registry.observer).to be == observer
+		# Buffer unchanged, in-memory value updated
+		expect(buffer.get_value(:u64, 0)).to be == 5
+		expect(registry.values[:test_field]).to be == 99
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-utilization
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Samuel Williams