closeyourit-ruby 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d841fba2147566f662dce067e2d41c44d44cf6d402fb929fc3c73eb9a6af4a1
-  data.tar.gz: cf7b435c2c9a336f107930ded5fc2ad197032a5d62eeca07f25594775a111bcc
+  metadata.gz: d98365053459eaded9732014e987b01e3fcf2ac60a21db83026243d076bc2dbf
+  data.tar.gz: 4cb2024f4681e57d415097b8af237156f3cc0c8b764a2d14ea958bb8824e1738
 SHA512:
-  metadata.gz: a5172771940399ca5f3f2706e35d3c72d16942b79e0b2bbb89f0dfa184e4a66d45f7644704d45b6fb8f62f645b01bc84e75d7abe1d8a08ae0fced77e87781dcf
-  data.tar.gz: dc9b5cc1387ecfb81b70a58815c0f79f7e68f1aeda98c2d3af14d0862f2dd28878a6803a1193e2737c4d8990b833c2aadf0d4461b393a26810957a1b6f0749d0
+  metadata.gz: de2f19a59df8c78825e0070e5c48c97424a7481d314219da675543da1ab71171ecfe7d5cd09cc0d81d48323be6d50435027e8a6bf901f121c6f5f3435b419b0d
+  data.tar.gz: 75ab998c2d1049bdcc047a96a54a01fe92cb50b820e81d1eac3795f4695416d7076956aac3defd82c520daaffd2dccf3726bb585cc189fb76090601928b3447f

data/README.md

@@ -45,7 +45,7 @@ In CloseYourIt, area **Member → Project → tokens**, crea un token: ottieni i
 ```ruby
 # config/initializers/closeyourit.rb
 CloseYourIt.init do |c|
-  c.endpoint_url = ENV["CLOSEYOURIT_ENDPOINT_URL"]   # es. https://closeyour.it
+  c.endpoint_url = ENV["CLOSEYOURIT_ENDPOINT_URL"]   # es. https://www.closeyour.it (host canonico)
   c.token        = ENV["CLOSEYOURIT_TOKEN"]          # Bearer secret del Projects::Token
   c.project_id   = ENV["CLOSEYOURIT_PROJECT_ID"]     # UUID del progetto su CloseYourIt
   c.environment  = Rails.env
@@ -55,6 +55,10 @@ end
 **Senza `endpoint_url` / `token` / `project_id` la gemma è no-op** (nessun invio, nessun overhead). In
 `production` un `endpoint_url` `http://` viene rifiutato (no-op + warning): il token viaggerebbe in chiaro.
 
+> **Endpoint:** usa l'host canonico **`https://www.closeyour.it`**. La gemma segue fino a 2 redirect su POST
+> (preservando metodo e body), quindi anche l'apex `https://closeyour.it` (301 → www) funziona — ma puntare
+> direttamente a www risparmia un hop per ogni evento.
+
 ### Opzioni
 
 | Opzione | Default | Descrizione |
@@ -167,6 +171,23 @@ Privacy-by-default (`send_pii = false`). In sintesi:
 > Rischio residuo: `exception.value` e i nomi tabella/colonna nello SQL possono contenere dati di
 > dominio. Usa `before_send`/`scrub_message_patterns` per azzerarli. Dettaglio in [`PDR.md` §9](PDR.md).
 
+## Diagnostica
+
+Il trasporto è fire-and-forget: non solleva mai e non blocca la request. Per non lasciare
+fallimenti silenziosi, ogni risposta HTTP non-2xx (es. `401` token errato, `404` progetto
+inesistente) viene loggata a `warn`, così come gli eventi scartati a coda piena. I contatori
+sono ispezionabili a runtime:
+
+```ruby
+CloseYourIt.stats.to_h
+# => { enqueued: 128, dropped: 0, sent: 126, failed: 2 }
+```
+
+- `enqueued` — eventi accettati per l'invio
+- `dropped` — scartati perché la coda async era piena (mai backpressure)
+- `sent` — risposta HTTP 2xx
+- `failed` — errore di rete o status non-2xx (vedi i log a `warn`)
+
 ## Sviluppo
 
 ```bash

data/lib/closeyourit/background_worker.rb

@@ -13,13 +13,22 @@ module CloseYourIt
       @executor = build_executor(threads.to_i, max_queue)
     end
 
+    # Ritorna true se l'evento è stato accettato (o eseguito sincrono), false se scartato
+    # perché la coda era piena (`fallback_policy: :discard`). Mai backpressure sulla request.
     def perform(&block)
-      @executor.post do
+      accepted = @executor.post do
         block.call
       rescue Exception => e # rubocop:disable Lint/RescueException
         # Mai propagare: la telemetria non deve poter crashare l'app ospite.
         CloseYourIt.logger.error("CloseYourIt background worker: #{e.class}: #{e.message}")
       end
+
+      unless accepted
+        CloseYourIt.stats.increment(:dropped)
+        CloseYourIt.logger.warn("CloseYourIt background worker: coda piena, evento scartato")
+      end
+
+      accepted
     end
 
     def shutdown(timeout = 1)

data/lib/closeyourit/client.rb

@@ -19,7 +19,8 @@ module CloseYourIt
       return nil if payload.nil?
 
       path = event.ingest_path(@configuration.project_id)
-      @worker.perform { @transport.send_event(payload, path: path) }
+      accepted = @worker.perform { @transport.send_event(payload, path: path) }
+      CloseYourIt.stats.increment(:enqueued) if accepted
       payload
     end
 

data/lib/closeyourit/configuration.rb

@@ -95,9 +95,12 @@ module CloseYourIt
       true
     end
 
-    # Logga i warning di configurazione (es. endpoint http://). Chiamata da `CloseYourIt.init`.
+    # Logga i warning di configurazione (es. endpoint http://, project_id/endpoint malformati).
+    # Non solleva mai: coerente con la filosofia no-op del client. Chiamata da `CloseYourIt.init`.
     def validate!
       CloseYourIt.logger.warn(insecure_endpoint_message) if insecure_endpoint?
+      CloseYourIt.logger.warn(malformed_project_id_message) if malformed_project_id?
+      CloseYourIt.logger.warn(malformed_endpoint_message) if malformed_endpoint?
       self
     end
 
@@ -133,11 +136,35 @@ module CloseYourIt
       nil
     end
 
+    UUID_FORMAT = /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i
+
     def insecure_endpoint?
       uri = parsed_endpoint
       !uri.nil? && uri.scheme != "https"
     end
 
+    # Avvisa se il project_id è valorizzato ma non sembra uno UUID (l'errore tipico è incollare
+    # uno slug/nome al posto dell'id). Non blocca: il server è l'autorità sulla validità.
+    def malformed_project_id?
+      !blank?(project_id) && !UUID_FORMAT.match?(project_id.to_s)
+    end
+
+    def malformed_project_id_message
+      "CloseYourIt: project_id (#{project_id}) non ha forma UUID — verifica di aver copiato l'id corretto."
+    end
+
+    # Avvisa se endpoint_url è valorizzato ma non parsabile o privo di host.
+    def malformed_endpoint?
+      return false if blank?(endpoint_url)
+
+      uri = parsed_endpoint
+      uri.nil? || blank?(uri.host)
+    end
+
+    def malformed_endpoint_message
+      "CloseYourIt: endpoint_url (#{endpoint_url}) non è un URL valido (host mancante)."
+    end
+
     def insecure_endpoint_message
       tail = production? ? "Telemetria DISABILITATA in production." : "Consentito solo in sviluppo."
       "CloseYourIt: endpoint_url usa http:// non sicuro (#{endpoint_url}) — il token viaggerebbe in chiaro. #{tail}"

data/lib/closeyourit/stats.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "concurrent"
+
+module CloseYourIt
+  # Contatori diagnostici thread-safe del client: quanti eventi sono stati accodati,
+  # scartati (coda piena), spediti con successo o falliti (rete o status non-2xx).
+  # Servono a rendere visibili i fallimenti silenziosi del trasporto fire-and-forget.
+  #
+  #   CloseYourIt.stats.to_h # => { enqueued: 12, dropped: 0, sent: 11, failed: 1 }
+  class Stats
+    COUNTERS = %i[enqueued dropped sent failed].freeze
+
+    def initialize
+      @counters = COUNTERS.to_h { |name| [ name, Concurrent::AtomicFixnum.new(0) ] }
+    end
+
+    def increment(name)
+      counter = @counters.fetch(name)
+      counter.increment
+      counter.value
+    end
+
+    def [](name)
+      @counters.fetch(name).value
+    end
+
+    def to_h
+      @counters.transform_values(&:value)
+    end
+
+    def reset!
+      @counters.each_value { |counter| counter.value = 0 }
+      self
+    end
+  end
+end

data/lib/closeyourit/transport.rb

@@ -10,14 +10,25 @@ module CloseYourIt
   class Transport
     OPEN_TIMEOUT = 2
     READ_TIMEOUT = 3
+    # Net::HTTP non segue i redirect: l'host canonico può rispondere 301 (es. apex → www).
+    # Ri-POSTiamo a Location preservando metodo + body, così l'evento non si perde in silenzio.
+    MAX_REDIRECTS = 2
 
     def initialize(configuration)
       @configuration = configuration
     end
 
     def send_event(payload, path:)
-      post(payload, path)
+      response = post(payload, path)
+      if response.is_a?(Net::HTTPSuccess)
+        CloseYourIt.stats.increment(:sent)
+      else
+        CloseYourIt.stats.increment(:failed)
+        CloseYourIt.logger.warn("CloseYourIt transport: HTTP #{response.code} su #{path}")
+      end
+      response
     rescue StandardError => e
+      CloseYourIt.stats.increment(:failed)
       CloseYourIt.logger.error("CloseYourIt transport: #{e.class}: #{e.message}")
       nil
     end
@@ -25,7 +36,21 @@ module CloseYourIt
     private
 
     def post(payload, path)
+      body = JSON.generate(payload)
       uri = URI.parse("#{base_url}#{path}")
+      redirects = 0
+
+      loop do
+        response = post_once(uri, body)
+        location = response["location"] if response.is_a?(Net::HTTPRedirection)
+        return response unless location && redirects < MAX_REDIRECTS
+
+        redirects += 1
+        uri = redirect_uri(uri, location)
+      end
+    end
+
+    def post_once(uri, body)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = uri.scheme == "https"
       http.open_timeout = OPEN_TIMEOUT
@@ -35,11 +60,17 @@ module CloseYourIt
       request["Authorization"] = "Bearer #{@configuration.token}"
       request["Content-Type"] = "application/json"
       request["User-Agent"] = "closeyourit-ruby/#{VERSION}"
-      request.body = JSON.generate(payload)
+      request.body = body
 
       http.request(request)
     end
 
+    # Location può essere assoluto (https://www.…) o relativo (/api/…): risolvilo sull'URI corrente.
+    def redirect_uri(current, location)
+      target = URI.parse(location)
+      target.relative? ? current + target : target
+    end
+
     def base_url
       @configuration.endpoint_url.to_s.chomp("/")
     end

data/lib/closeyourit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CloseYourIt
-  VERSION = "0.2.0"
+  VERSION = "0.3.1"
 end

data/lib/closeyourit-ruby.rb

@@ -7,6 +7,7 @@ require_relative "closeyourit/configuration"
 require_relative "closeyourit/breadcrumb"
 require_relative "closeyourit/scope"
 require_relative "closeyourit/scrubber"
+require_relative "closeyourit/stats"
 require_relative "closeyourit/background_worker"
 require_relative "closeyourit/transport"
 require_relative "closeyourit/event"
@@ -144,6 +145,12 @@ module CloseYourIt
 
     attr_writer :logger
 
+    # Contatori diagnostici del client (accodati/scartati/spediti/falliti).
+    #   CloseYourIt.stats.to_h # => { enqueued: …, dropped: …, sent: …, failed: … }
+    def stats
+      @stats ||= Stats.new
+    end
+
     private
 
     def client

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: closeyourit-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Alessio Bussolari
@@ -55,6 +55,7 @@ files:
 - lib/closeyourit/scope.rb
 - lib/closeyourit/scrubber.rb
 - lib/closeyourit/sidekiq/error_handler.rb
+- lib/closeyourit/stats.rb
 - lib/closeyourit/subscribers/slow_query.rb
 - lib/closeyourit/transport.rb
 - lib/closeyourit/version.rb