io-watch 0.6.1 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b3d57b500111de6639098f96580da6ddfc5029f77fc0daf97159e54415ea7c5
-  data.tar.gz: 0ee6cfbdb782214fc141b713f7396448e92ae438244939ed48b9681a6e620f7f
+  metadata.gz: 14f3ccb0d7a3066e70e3ab6e25221c585f1a17034e0e9731fe85637e6797b4d8
+  data.tar.gz: 35d7f43fd20d2ef7cf68558c787344cc49c614498e98e8ccfc25bfca08d5b5d6
 SHA512:
-  metadata.gz: 3e4873bbd69789206c2704fe3e20914c7955c79d2310513adcf8dd9371c6773bf9d0a729b19b1de4a18fe852631435184559d98600d7de5b2ecd81a5a633075a
-  data.tar.gz: cbc9fdaedb8f1383e36e845cd07341e2427e706c205a94da35b355eb87ae049f9d2a256d30beb3a4616f35fbcf10f66e5022e0653849a3762a01376a7937f003
+  metadata.gz: 045d52cf0bc46fcc1410af1eb75362b21584561350996baa58c0b87a8b0216d24013d18ed97542d9c987f4b457b828b115f10f0ad5848734842194b45f2b09a0
+  data.tar.gz: 1d1a110f3d8f85e1d4f74fd2b55d927d4c91a3b02bbf506ce4b1f20272b67ba6c8830d3e265fa4948feac4de1ee5d2531ca76c8f2211255b21cc9d5cab33644f

data/bin/io-watch

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'console'
 require 'io/watch'

data/ext/configure

@@ -43,7 +43,7 @@ esac
 cat > Makefile <<EOF
 TARGET = io-watch
 CC = $CC
-CFLAGS = -Wall -Wextra
+CFLAGS = -Wall -Wextra -Werror
 LDFLAGS = $LDFLAGS
 SOURCES = $SOURCES
 OBJECTS = \$(SOURCES:.c=.o)
@@ -74,4 +74,4 @@ uninstall:
 .PHONY: all clean install uninstall
 EOF
 
-echo "Configuration complete. Run 'make' to build the project."
+echo "Configuration complete. Run 'make' to build the project."

data/ext/io/watch/fsevent.c

@@ -44,6 +44,7 @@ void IO_Watch_FSEvent_callback(
 	const FSEventStreamEventFlags eventFlags[],
 	const FSEventStreamEventId eventIds[]) {
 	
+	(void)streamRef; // unused
 	const char **eventPaths = (const char**)eventData;
 	struct IO_Watch *watch = context;
 	
@@ -104,4 +105,4 @@ void IO_Watch_run(struct IO_Watch *watch) {
 	}
 	free(pathsToWatch);
 	CFRelease(pathsToWatchArray);
-}
+}

data/ext/io/watch/inotify.c

@@ -9,6 +9,8 @@
 #include <dirent.h>
 #include <string.h>
 #include <sys/stat.h>
+#include <time.h>
+#include <poll.h>
 
 enum {
 	DEBUG = 0,
@@ -18,11 +20,16 @@ struct IO_Watch_Watch {
 	int watch_descriptor;
 	char *path;
 	int index;
+	
+	int modified;
 };
 
 struct IO_Watch_Watch_Array {
 	size_t size;
 	size_t capacity;
+	
+	size_t pending;
+	
 	struct IO_Watch_Watch *watches;
 };
 
@@ -31,6 +38,7 @@ struct IO_Watch_Watch_Array {
 void IO_Watch_Watch_Array_initialize(struct IO_Watch_Watch_Array *array) {
 	array->size = 0;
 	array->capacity = 16;
+	array->pending = 0;
 	array->watches = malloc(array->capacity * sizeof(struct IO_Watch_Watch));
 	if (!array->watches) {
 		perror("io-watch:IO_Watch_Watch_Array_initialize:malloc");
@@ -176,6 +184,46 @@ void IO_Watch_INotify_print_event(struct inotify_event *event) {
 	fprintf(stderr, "\n");
 }
 
+static size_t IO_Watch_INotify_flush_events(struct IO_Watch_Watch_Array watch_array) {
+	size_t count = 0;
+	
+	if (watch_array.pending == 0) {
+		return 0;
+	}
+	
+	for (size_t i = 0; i < watch_array.size; i++) {
+		int modified = watch_array.watches[i].modified;
+		if (modified) {
+			count++;
+			
+			printf("{\"index\":%d,\"mask\":%u}\n", watch_array.watches[i].index, modified);
+			watch_array.watches[i].modified = 0;
+		}
+	}
+	
+	watch_array.pending = 0;
+	
+	fflush(stdout);
+	
+	if (DEBUG) fprintf(stderr, "io-watch:IO_Watch_INotify_flush_events: Flushed %zu events\n", count);
+	
+	return count;
+}
+
+static float IO_Watch_handle_timeout(float latency, struct timespec *start_time) {
+	if (start_time) {
+		struct timespec current_time;
+		clock_gettime(CLOCK_MONOTONIC, &current_time);
+		
+		float delta = current_time.tv_sec - start_time->tv_sec;
+		delta += (current_time.tv_nsec - start_time->tv_nsec) / 1e9;
+		
+		return latency - delta;
+	} else {
+		return 0.0;
+	}
+}
+
 void IO_Watch_run(struct IO_Watch *watch) {
 	int fd = inotify_init1(IN_NONBLOCK);
 	if (fd == -1) {
@@ -193,16 +241,60 @@ void IO_Watch_run(struct IO_Watch *watch) {
 		IO_Watch_Watch_Array_scan(fd, &watch_array, path, i);
 	}
 	
+	float latency = watch->latency;
+	
+	// If start_time is non-null, it means we are now coallescing events, up to the specified latency:
+	struct timespec start_time_buffer, *start_time = NULL;
+	
 	printf("{\"status\":\"started\"}\n");
 	fflush(stdout);
 	
 	char buffer[BUFFER_SIZE] __attribute__ ((aligned(8)));
 	
 	while (1) {
+		// Check for any events:
 		ssize_t result = read(fd, buffer, BUFFER_SIZE);
-		if (result == -1 && errno != EAGAIN) {
-			perror("(io-watch:IO_Watch_run:read)");
-			exit(EXIT_FAILURE);
+		
+		// Calculate the timeout, if any:
+		float timeout = IO_Watch_handle_timeout(latency, start_time);
+		
+		// We need to check if the timeout has expired:
+		if (timeout < 0.0) {
+			if (DEBUG) fprintf(stderr, "io-watch:IO_Watch_run: Timeout expired\n");
+			
+			start_time = NULL;
+			// Flush any pending events:
+			IO_Watch_INotify_flush_events(watch_array);
+		}
+		
+		// If no events are available, we have to wait for the timeout:
+		if (result == -1) {
+			if (errno != EAGAIN && errno != EWOULDBLOCK) {
+				perror("(io-watch:IO_Watch_run:read)");
+				exit(EXIT_FAILURE);
+			}
+			
+			if (DEBUG) fprintf(stderr, "io-watch:IO_Watch_run: No events available, waiting for %0.4f seconds\n", timeout);
+			
+			// Wait until the file descriptor becomes readable:
+			struct pollfd poll_fd = {fd, POLLIN, 0};
+			int poll_timeout = start_time ? (int) (timeout * 1e3) : -1;
+			
+			// If we have a timeout of 0.0, we have to poll for at least 1 ms:
+			if (poll_timeout == 0 && timeout > 0.0) {
+				poll_timeout = 1;
+			}
+			
+			if (DEBUG) fprintf(stderr, "io-watch:IO_Watch_run:poll: Polling for %d ms\n", poll_timeout);
+			poll(&poll_fd, 1, poll_timeout);
+			continue;
+		}
+		
+		// If we have received events, we have to set the start_time if it is not set:
+		if (!start_time) {
+			if (DEBUG) fprintf(stderr, "io-watch:IO_Watch_run: Setting start_time\n");
+			start_time = &start_time_buffer;
+			clock_gettime(CLOCK_MONOTONIC, start_time);
 		}
 		
 		for (ssize_t offset = 0; offset < result;) {
@@ -225,7 +317,9 @@ void IO_Watch_run(struct IO_Watch *watch) {
 			ssize_t index = IO_Watch_Watch_Array_find(&watch_array, event->wd);
 			
 			if (index != -1) {
-				printf("{\"index\":%d,\"mask\":%u}\n", watch_array.watches[index].index, event->mask);
+				if (DEBUG) fprintf(stderr, "io-watch:IO_Watch_run: Modified path %s mask=%d\n", watch_array.watches[index].path, event->mask);
+				watch_array.watches[index].modified |= event->mask;
+				watch_array.pending += 1;
 				
 				// If a new directory is created, add a watch for it
 				if (event->mask & IN_CREATE && event->mask & IN_ISDIR) {
@@ -239,9 +333,8 @@ void IO_Watch_run(struct IO_Watch *watch) {
 			
 			offset += sizeof(struct inotify_event) + event->len;
 		}
-		fflush(stdout);
 	}
-
+	
 	for (size_t i = 0; i < watch_array.size; i++) {
 		inotify_rm_watch(fd, watch_array.watches[i].watch_descriptor);
 		free(watch_array.watches[i].path);

data/lib/io/watch/monitor.rb

@@ -9,6 +9,7 @@ class IO
 	module Watch
 		# Represents a list of roots to watch for changes.
 		class Monitor
+			# The path to the compiled `io-watch` command.
 			def self.command_path
 				if extension_path = Gem.loaded_specs['io-watch']&.extension_dir
 					if File.exist?(extension_path)

data/lib/io/watch/version.rb

@@ -5,6 +5,6 @@
 
 class IO
 	module Watch
-		VERSION = '0.6.1'
+		VERSION = '0.6.3'
 	end
 end

data/lib/io/watch.rb

@@ -6,8 +6,11 @@
 require_relative 'watch/version'
 require_relative 'watch/monitor'
 
+# @namespace
 class IO
+	# @namespace
 	module Watch
+		# Create a new monitor.
 		def self.new(...)
 			Monitor.new(...)
 		end

data/license.md

@@ -1,6 +1,7 @@
 # MIT License
 
 Copyright, 2024, by Samuel Williams.  
+Copyright, 2024, by Étienne Barrié.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -4,6 +4,10 @@ Monitor the file-system for changes.
 
 [![Development Status](https://github.com/socketry/io-watch/workflows/Test/badge.svg)](https://github.com/socketry/io-watch/actions?workflow=Test)
 
+## Motivation
+
+Previously, I was using the `listen` gem in combination with `rb-inotify` or `rb-fsevent` to watch for file-system changes. However, those libraries have been around for an extremely long time and have accumulated a lot of cruft. In addition, I don't like having to multiplex in application code depending on the underlying platform. I created this library to provide a simple, unified interface for watching directories for changes. This is the most consistently supported behaviour across all platforms, and fits the needs of most applications without a huge amount of complexity.
+
 ## Usage
 
 Please see the [project documentation](https://socketry.github.io/io-watch/) for more details.

metadata

@@ -1,10 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: io-watch
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.3
 platform: ruby
 authors:
 - Samuel Williams
+- Étienne Barrié
 autorequire:
 bindir: bin
 cert_chain:
@@ -37,7 +38,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-08-11 00:00:00.000000000 Z
+date: 2024-08-12 00:00:00.000000000 Z
 dependencies: []
 description:
 email: