onyxcord 2.0.0 → 2.0.6

data/lib/onyxcord/rate_limiter/async_rest.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'onyxcord/async/runtime'
+
+module OnyxCord
+  module RateLimiter
+    class AsyncRest
+      DEFAULT_ENTRY_TTL = 3600
+      DEFAULT_PRUNE_INTERVAL = 100
+
+      def initialize(clock: -> { Time.now }, entry_ttl: DEFAULT_ENTRY_TTL, prune_interval: DEFAULT_PRUNE_INTERVAL)
+        @route_buckets = {}
+        @bucket_locks = {}
+        @bucket_last_used = {}
+        @global_lock = Mutex.new
+        @clock = clock
+        @entry_ttl = entry_ttl
+        @prune_interval = prune_interval
+        @requests_since_prune = 0
+      end
+
+      def before_request(route, major_parameter)
+        wait_for(mutex_for(route, major_parameter))
+      end
+
+      def record_response(route, major_parameter, headers)
+        headers = normalize_headers(headers)
+        bucket = headers[:x_ratelimit_bucket]
+        key = route_key(route, major_parameter)
+        touch(key)
+
+        if bucket
+          bucket = bucket_key(bucket, major_parameter)
+          @route_buckets[key] = bucket
+          touch(bucket)
+        end
+
+        return unless headers[:x_ratelimit_remaining] == '0'
+
+        wait_seconds = headers[:x_ratelimit_reset_after].to_f
+        return unless wait_seconds.positive?
+
+        async_wait(wait_seconds, mutex_for(route, major_parameter))
+      end
+
+      def handle_rate_limit(route, major_parameter, response)
+        headers = normalize_headers(response.headers)
+        wait_seconds = retry_after(response, headers)
+
+        return unless wait_seconds.positive?
+
+        if headers[:x_ratelimit_global] == 'true' || headers[:x_ratelimit_scope] == 'global'
+          global_wait(wait_seconds)
+        else
+          async_wait(wait_seconds, mutex_for(route, major_parameter))
+        end
+      end
+
+      def stats
+        {
+          route_buckets: @route_buckets.size,
+          bucket_locks: @bucket_locks.size,
+          tracked_keys: @bucket_last_used.size
+        }
+      end
+
+      def prune!
+        return 0 unless @entry_ttl
+
+        cutoff = @clock.call - @entry_ttl
+        stale_keys = @bucket_last_used.select { |_, last_used| last_used < cutoff }.keys
+
+        stale_keys.each do |key|
+          @bucket_locks.delete(key)
+          @bucket_last_used.delete(key)
+          @route_buckets.delete(key)
+          @route_buckets.delete_if { |_, bucket_key| bucket_key == key }
+        end
+
+        @requests_since_prune = 0
+        stale_keys.length
+      end
+
+      private
+
+      def mutex_for(route, major_parameter)
+        key = resolved_key(route, major_parameter)
+        touch(key)
+        @bucket_locks[key] ||= Mutex.new
+      end
+
+      def resolved_key(route, major_parameter)
+        @route_buckets[route_key(route, major_parameter)] || route_key(route, major_parameter)
+      end
+
+      def route_key(route, major_parameter)
+        [route, major_parameter].freeze
+      end
+
+      def bucket_key(bucket, major_parameter)
+        [:bucket, bucket, major_parameter].freeze
+      end
+
+      def retry_after(response, headers)
+        body = response.respond_to?(:body) ? response.body : response.to_s
+        if body && !body.empty?
+          data = JSON.parse(body)
+          return data['retry_after'].to_f if data['retry_after']
+        end
+
+        (headers[:retry_after] || 0).to_f
+      rescue JSON::ParserError
+        (headers[:retry_after] || 0).to_f
+      end
+
+      def normalize_headers(headers)
+        headers.each_with_object({}) do |(key, value), memo|
+          memo[key.to_s.tr('-', '_').downcase.to_sym] = value.to_s
+        end
+      end
+
+      def touch(key)
+        @bucket_last_used[key] = @clock.call
+        prune_if_needed
+      end
+
+      def prune_if_needed
+        return unless @prune_interval
+
+        @requests_since_prune += 1
+        prune! if @requests_since_prune >= @prune_interval
+      end
+
+      def wait_for(mutex)
+        mutex.lock
+        mutex.unlock
+      end
+
+      def async_wait(time, mutex)
+        mutex.synchronize { OnyxCord::AsyncRuntime.sleep(time) }
+      end
+
+      def global_wait(time)
+        OnyxCord::AsyncRuntime.sleep(time)
+      end
+    end
+  end
+end

data/lib/onyxcord/version.rb

@@ -3,5 +3,5 @@
 # OnyxCord and all its functionality, in this case only the version.
 module OnyxCord
   # The current version of onyxcord.
-  VERSION = '2.0.0'
+  VERSION = '2.0.6'
 end

data/lib/onyxcord/webhooks/version.rb

@@ -4,6 +4,6 @@
 module OnyxCord
   module Webhooks
     # The current version of onyxcord-webhooks.
-    VERSION = '2.0.0'
+    VERSION = '2.0.6'
   end
 end

data/lib/onyxcord/websocket.rb

@@ -1,25 +1,15 @@
 # frozen_string_literal: true
 
-require 'async'
+require 'onyxcord/async/runtime'
 require 'async/http/endpoint'
 require 'async/websocket/client'
 
 module OnyxCord
-  # Wrapper around async-websocket that provides the same callback-based
-  # interface used by the Gateway and Voice subsystems. This replaces the
-  # previous websocket-client-simple implementation.
   class WebSocket
-    # @return [Boolean] whether the connection is currently open.
     attr_reader :connected
 
     alias_method :connected?, :connected
 
-    # Creates a new WebSocket wrapper.
-    # @param host [String]            The `wss://` endpoint URL to connect to.
-    # @param open_handler [Proc]      Called once the connection is established.
-    # @param message_handler [Proc]   Called for every text frame received.
-    # @param error_handler [Proc]     Called when an error occurs.
-    # @param close_handler [Proc]     Called when the connection closes.
     def initialize(host, open_handler, message_handler, error_handler, close_handler)
       @host = host
       @open_handler = open_handler
@@ -33,8 +23,6 @@ module OnyxCord
       connect
     end
 
-    # Send a text message over the WebSocket.
-    # @param data [String, Hash] Data to send. Hashes are JSON-encoded automatically.
     def send(data)
       return unless @connection
 
@@ -45,7 +33,6 @@ module OnyxCord
       @error_handler&.call(e)
     end
 
-    # Cleanly close the connection.
     def close
       @connected = false
       @connection&.close
@@ -58,7 +45,7 @@ module OnyxCord
     def connect
       endpoint = Async::HTTP::Endpoint.parse(@host)
 
-      Async do
+      @task = OnyxCord::AsyncRuntime.async do
         Async::WebSocket::Client.connect(endpoint) do |connection|
           @connection = connection
           @connected = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onyxcord
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.6
 platform: ruby
 authors:
 - Gustavo Silva
@@ -365,9 +365,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".devcontainer/Dockerfile"
-- ".devcontainer/devcontainer.json"
-- ".devcontainer/postcreate.sh"
 - ".github/CONTRIBUTING.md"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
@@ -399,6 +396,12 @@ files:
 - lib/onyxcord/api/server.rb
 - lib/onyxcord/api/user.rb
 - lib/onyxcord/api/webhook.rb
+- lib/onyxcord/application_commands.rb
+- lib/onyxcord/application_commands/command.rb
+- lib/onyxcord/application_commands/context.rb
+- lib/onyxcord/application_commands/option.rb
+- lib/onyxcord/application_commands/registry.rb
+- lib/onyxcord/async/runtime.rb
 - lib/onyxcord/await.rb
 - lib/onyxcord/bot.rb
 - lib/onyxcord/cache.rb
@@ -474,7 +477,9 @@ files:
 - lib/onyxcord/events/voice_state_update.rb
 - lib/onyxcord/events/webhooks.rb
 - lib/onyxcord/gateway.rb
+- lib/onyxcord/http.rb
 - lib/onyxcord/id_object.rb
+- lib/onyxcord/json.rb
 - lib/onyxcord/light.rb
 - lib/onyxcord/light/data.rb
 - lib/onyxcord/light/integrations.rb
@@ -483,6 +488,7 @@ files:
 - lib/onyxcord/message_components.rb
 - lib/onyxcord/paginator.rb
 - lib/onyxcord/permissions.rb
+- lib/onyxcord/rate_limiter/async_rest.rb
 - lib/onyxcord/rate_limiter/gateway.rb
 - lib/onyxcord/rate_limiter/rest.rb
 - lib/onyxcord/version.rb

data/.devcontainer/Dockerfile

@@ -1,13 +0,0 @@
-# Which Ruby version to use. You may need to use a more restrictive version,
-# e.g. `3.0`
-ARG VARIANT=3.3
-
-# Pull Microsoft's ruby devcontainer base image
-FROM mcr.microsoft.com/devcontainers/ruby:${VARIANT}
-
-# Install libsodium dependency for voice channel interactions
-RUN apt update -yq && apt install -y libsodium-dev
-
-# Ensure we're running the latest bundler, as what ships with the Ruby image may
-# not be current, and bundler will auto-downgrade to match the Gemfile.lock
-RUN gem install bundler

data/.devcontainer/devcontainer.json

@@ -1,29 +0,0 @@
-{
-  "name": "Ruby",
-  "build": {
-    "dockerfile": "Dockerfile"
-  },
-
-  // Configure tool-specific properties.
-  "customizations": {
-    // Configure properties specific to VS Code.
-    "vscode": {
-      // Add the IDs of extensions you want installed when the container is created.
-      "extensions": [
-        "shopify.ruby-lsp"
-      ]
-    }
-  },
-
-  // Set the environment variables
-  // "runArgs": ["--env-file",".env"],
-
-  // Use 'forwardPorts' to make a list of ports inside the container available locally.
-  //   "forwardPorts": [],
-
-  // Use 'postCreateCommand' to run commands after the container is created.
-  "postCreateCommand": "bash .devcontainer/postcreate.sh",
-
-  // Set `remoteUser` to `root` to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
-  "remoteUser": "vscode"
-}

data/.devcontainer/postcreate.sh

@@ -1,4 +0,0 @@
-#!/bin/bash
-
-bundle config set path vendor/bundle
-bundle install --jobs=1