Class: Parse::Client

Inherits:

Object

Object
Parse::Client

show all

Includes:: API::Aggregate, API::Analytics, API::Batch, API::CloudFunctions, API::Config, API::Files, API::Hooks, API::Objects, API::Push, API::Schema, API::Server, API::Sessions, API::Users

Defined in:: lib/parse/client.rb

Overview

This class is the core and low level API for the Parse SDK REST interface that is used by the other components. It can manage multiple sessions, which means you can have multiple client instances pointing to different Parse Applications at the same time. It handles sending raw requests as well as providing Request/Response objects for all API handlers. The connection engine is Faraday, which means it is open to add any additional middleware for features you'd like to implement.

Defined Under Namespace

Modules: Connectable Classes: DuplicateValueError, ResponseError

Constant Summary collapse

USER_AGENT_HEADER = The user agent header key.

"User-Agent".freeze

USER_AGENT_VERSION = The value for the User-Agent header.

"Parse-Stack v#{Parse::Stack::VERSION}".freeze

DEFAULT_RETRIES = The default retry count

RETRY_DELAY = The wait time in seconds between retries

1.5

LIVE_QUERY_LOOPBACK_HOSTS = Hosts considered "loopback" for the cleartext-ws:// guard in #configure_live_query. Mirrors LiveQuery::Client::LOOPBACK_HOSTS so the explicit-URL path and the derived-URL path agree on what counts as local.

%w[localhost 127.0.0.1 ::1 [::1] 0.0.0.0].freeze

Constants included from API::Server

API::Server::DEPRECATED_SERVER_VERSION_BELOW

Constants included from API::Hooks

API::Hooks::TRIGGER_NAMES

Class Attribute Summary collapse

.clients ⇒ Object readonly
Returns the value of attribute clients.

Instance Attribute Summary collapse

#api_key ⇒ String readonly
The Parse API key to be sent in every API request.
#application_id ⇒ String (also: #app_id) readonly
The Parse application identifier to be sent in every API request.
#cache ⇒ Moneta::Transformer, Moneta::Expires
The underlying cache store for caching API requests.
#master_key ⇒ String readonly
The Parse master key for this application, which when set, will be sent in every API request.
#retry_limit ⇒ Integer
If set, returns the current retry count for this instance.
#server_url ⇒ String readonly
The Parse server url that will be receiving these API requests.
#session_token ⇒ String^? readonly
The session token bound to this client, if any (see the :session_token constructor option).

Attributes included from API::Server

#server_info

Attributes included from API::Config

#config, #master_key_only

Class Method Summary collapse

.client(conn = :default) ⇒ Parse::Client
Returns or create a new Parse::Client connection for the given connection name.
.client?(conn = :default) ⇒ Boolean
True if a Parse::Client has been configured.
.setup(opts = {}) { ... } ⇒ Client
Setup the a new client with the appropriate Parse app keys, middleware and options.

Instance Method Summary collapse

#anonymous ⇒ Parse::Client
A NEW anonymous client that mirrors THIS client's connection but carries neither a master key nor a session token — every request it makes is unauthenticated (app-id + REST key only).
#authorization ⇒ Parse::Authorization::Context
This client's authorization context: the identity and role caches, and the session-token resolver that feeds every mongo-direct ACL decision.
#become(session_token) ⇒ Parse::Client
A NEW non-master Client that mirrors THIS client's connection settings (server_url / application_id / api_key) but carries no master key and binds session_token, so it acts on the server as that user (ACL / CLP / protectedFields enforced, no master-key fallback).
#body_carries_atomic_op?(body) ⇒ Boolean
Whether a request body carries a Parse atomic operation, i.e.
#clear_cache! ⇒ Object
Clear the SDK's own cached entries.
#configure_live_query(opts) ⇒ Object private
Configure LiveQuery with the given options.
#connected?(endpoint = nil) ⇒ Boolean
Connectivity probe.
#delete(uri, body = nil, headers = {}) ⇒ Parse::Response
Send a DELETE request.
#get(uri, query = nil, headers = {}) ⇒ Parse::Response
Send a GET request.
#idempotent_retry?(method, body, headers = nil) ⇒ Boolean
Whether a request whose outcome is UNKNOWN (a 500/503 or a dropped connection) is safe to transparently re-send.
#initialize(opts = {}) ⇒ Client constructor
Create a new client connected to the Parse Server REST API endpoint.
#inspect ⇒ Object
Redacted inspection.
#post(uri, body = nil, headers = {}) ⇒ Parse::Response
Send a POST request.
#put(uri, body = nil, headers = {}) ⇒ Parse::Response
Send a PUT request.
#reachable? ⇒ Boolean
No-credentials liveness probe.
#request(method, uri = nil, body: nil, query: nil, headers: nil, opts: {}) ⇒ Parse::Response
Send a REST API request to the server.
#sdk_cache ⇒ Object
The store the SDK itself reads and writes: the response cache, the identity and role planes, and #clear_cache!.
#send_request(req) ⇒ Parse::Response
Send a Request object.
#server_deduped_request?(headers) ⇒ Boolean
Whether this request is covered by Parse Server's server-side request-id deduplication, making a replay a no-op.
#url_prefix ⇒ String
The url prefix of the Parse Server url.
#validate_live_query_url!(url, allow_insecure:) ⇒ Object private
#warn_about_unknown_live_query_keys!(live_query_opts) ⇒ Object private
#with_session(&block) ⇒ Object
Run a block with this client's bound #session_token active as the ambient session, so every query / object operation inside it that resolves the default client (e.g. Post.count, Post.all, obj.save) is authorized by Parse Server as that user — ACL and CLP enforced, master key suppressed — without threading session_token: through each call.

Constructor Details

#initialize(opts = {}) ⇒ `Client`

Create a new client connected to the Parse Server REST API endpoint.

Parameters:

opts (Hash) (defaults to: {}) —
a set of connection options to configure the client.

Options Hash (opts):

:server_url (String) —
The server url of your Parse Server if you are not using the hosted Parse service. By default it will use ENV if available, otherwise fallback to Protocol::SERVER_URL.
:app_id (String) —
The Parse application id. Defaults to ENV.
:api_key (String) —
Your Parse REST API Key. Defaults to ENV.
:master_key (String) —
The Parse application master key (optional). If this key is set, it will be sent on every request sent by the client and your models. Defaults to ENV.
:session_token (String) —
An optional session token bound to this client. When set, every request that does not pass an explicit session_token: / use_master_key: true and is not inside a Parse.with_session block sends this token (and suppresses the master key), so the client transparently acts as that user. Precedence is explicit per-call > Parse.with_session ambient > this bound token. Typically paired with master_key: nil to build a user-scoped client (see Webhooks::Payload#user_client).
:logging (Boolean, Symbol) —
Controls request/response logging.
- true - Enable logging at :info level
- :debug - Enable verbose logging with headers and body content
- :warn - Only log errors and warnings
- false or nil - Disable logging (default) This configures both the new Middleware::Logging middleware and the legacy Middleware::BodyBuilder logging.
:logger (Logger) —
A custom logger instance for request/response logging. Defaults to Logger.new(STDOUT) if not specified.
:adapter (Object) —
The connection adapter. By default it uses :net_http_persistent for connection pooling. Set connection_pooling: false to use the standard Faraday.default_adapter (Net/HTTP) instead.
:connection_pooling (Boolean, Hash) —
Controls HTTP connection pooling. Defaults to true, using the :net_http_persistent adapter for improved performance through connection reuse. Set to false to disable pooling and create a new connection for each request. This option is ignored if :adapter is explicitly specified. Pass a Hash to enable pooling with custom configuration:
- :pool_size [Integer] - Number of connections per thread (default: 1)
- :idle_timeout [Integer] - Seconds before closing idle connections (default: 5)
- :keep_alive [Integer] - HTTP Keep-Alive timeout in seconds @example Custom connection pooling Parse.setup( connection_pooling: { pool_size: 5, idle_timeout: 60, keep_alive: 60 } )
:cache (Moneta::Transformer, Moneta::Expires, Parse::Cache::Redis, String) —
A caching adapter of type Moneta::Transformer or Moneta::Expires that will be used by the caching middleware Middleware::Caching. You can also pass a redis:// URL string (an internal Moneta-Redis store will be built for you) or a Parse::Cache::Redis wrapper, which adds a connection pool and automatic namespace forwarding. Caching queries and object fetches can help improve the performance of your application, even if it is for a few seconds. Only successful GET object fetches and non-empty result queries will be cached by default. You may set the default expiration time with the expires option. At any point in time you may clear the cache by calling the #clear_cache! method on the client connection. See Moneta.
:expires (Integer) —
Sets the default cache expiration time (in seconds) for successful non-empty GET requests when using the caching middleware. The default value is 3 seconds. If :expires is set to 0, caching will be disabled. You can always clear the current state of the cache using the clear_cache! method on your Parse::Client instance.
:cache_namespace (String) —
Optional prefix applied to every cache key. Useful when two Parse apps share one Redis instance and would otherwise collide on identical paths (e.g. mk:/classes/Song/abc). Keys become <namespace>:<existing-prefix>:<url>, so a SCAN <namespace>:* evicts a whole app cleanly. Defaults to no namespace for backward compatibility — explicit only, never auto-derived from app_id.
:faraday (Hash) —
You may pass a hash of options that will be passed to the Faraday constructor.
:live_query_url (String) —
The WebSocket URL for Parse LiveQuery server (e.g., "wss://your-parse-server.com"). If not specified, falls back to ENV. LiveQuery enables real-time subscriptions to changes in Parse objects. @example Enable LiveQuery Parse.setup( server_url: "https://your-server.com/parse", application_id: "YOUR_APP_ID", api_key: "YOUR_API_KEY", live_query_url: "wss://your-server.com" )
:live_query (Hash) —
Advanced LiveQuery configuration options. Pass a hash with custom settings for the LiveQuery client.
- :url [String] - WebSocket URL (alternative to :live_query_url)
- :auto_reconnect [Boolean] - Auto-reconnect on disconnect (default: true)

Raises:

Parse::Error::ConnectionError if the client was not properly configured with required keys or url.
ArgumentError if the cache instance passed to the :cache option is not of Moneta::Transformer or Moneta::Expires

See Also:

# File 'lib/parse/client.rb', line 628

def initialize(opts = {})
  @server_url = opts[:server_url] || ENV["PARSE_SERVER_URL"] || Parse::Protocol::SERVER_URL
  @application_id = opts[:application_id] || opts[:app_id] || ENV["PARSE_SERVER_APPLICATION_ID"] || ENV["PARSE_APP_ID"]
  @api_key = opts[:api_key] || opts[:rest_api_key] || ENV["PARSE_SERVER_REST_API_KEY"] || ENV["PARSE_API_KEY"]
  # Distinguish an explicit `master_key: nil` (deliberately a non-master
  # client — what user_client / session_client / user_agent rely on) from
  # an omitted key (fall back to ENV). The previous `opts[:master_key] ||
  # ENV[...]` form silently re-inherited the process master key for the
  # explicit-nil case, putting a "non-master" client back into master mode
  # in any deployment that exports PARSE_SERVER_MASTER_KEY / PARSE_MASTER_KEY.
  @master_key = if opts.key?(:master_key)
      opts[:master_key]
    else
      ENV["PARSE_SERVER_MASTER_KEY"] || ENV["PARSE_MASTER_KEY"]
    end
  # Optional token bound to this client; applied per request as the
  # lowest-priority auth fallback (see #request). Normalize blank/whitespace
  # to nil so it never trips the "token present" branch at request time
  # (where `present?` is false for whitespace) and silently fall back to the
  # master key on a master-configured client.
  bound_token = opts[:session_token]
  bound_token = bound_token.session_token if bound_token.respond_to?(:session_token)
  bound_token = bound_token.to_s.strip
  @session_token = bound_token.empty? ? nil : bound_token

  @require_https = opts.fetch(:require_https, ENV["PARSE_REQUIRE_HTTPS"] == "true")
  @allow_faraday_proxy = opts.fetch(:allow_faraday_proxy, false)

  # Security check for HTTP usage (except localhost/127.0.0.1 for development)
  if @server_url&.start_with?("http://") && !@server_url.match?(%r{^http://(localhost|127\.0\.0\.1)(:|/)})
    if @require_https
      raise ArgumentError, "[Parse::Client] HTTPS required but server URL uses HTTP: #{@server_url}. " \
                           "Set require_https: false or use an HTTPS URL."
    else
      warn "[Parse::Client] SECURITY WARNING: Using HTTP instead of HTTPS for Parse server. " \
           "This exposes credentials and data to network interception. " \
           "Use HTTPS in production: #{@server_url}"
    end
  end

  # Determine the HTTP adapter to use
  # Priority: explicit :adapter > :connection_pooling setting > default (pooling enabled)
  # Falls back to default adapter if net_http_persistent is not available
  if opts[:adapter]
    # User explicitly specified an adapter, use it directly
    adapter = opts[:adapter]
    adapter_options = {}
  elsif opts[:connection_pooling] == false
    # User explicitly disabled connection pooling
    adapter = Faraday.default_adapter
    adapter_options = {}
  elsif opts[:connection_pooling].is_a?(Hash)
    # User provided connection pooling with custom options
    if NET_HTTP_PERSISTENT_AVAILABLE
      adapter = :net_http_persistent
      adapter_options = opts[:connection_pooling]
    else
      adapter = Faraday.default_adapter
      adapter_options = {}
    end
  else
    # Default: use persistent connections for better performance (if available)
    if NET_HTTP_PERSISTENT_AVAILABLE
      adapter = :net_http_persistent
      adapter_options = {}
    else
      adapter = Faraday.default_adapter
      adapter_options = {}
    end
  end

  opts[:expires] ||= 3
  if @server_url.nil? || @application_id.nil? || (@api_key.nil? && @master_key.nil?)
    raise Parse::Error::ConnectionError, "Please call Parse.setup(server_url:, application_id:, api_key:) to setup a client"
  end
  @server_url += "/" unless @server_url.ends_with?("/")

  # Resolve timeouts. Defaults guard the calling thread against an
  # unresponsive Parse Server (slowloris, hung dyno) which would
  # otherwise tie up Puma/Sidekiq workers indefinitely.
  open_timeout = opts.fetch(:open_timeout, (ENV["PARSE_OPEN_TIMEOUT"] || 5).to_i)
  read_timeout = opts.fetch(:timeout, (ENV["PARSE_TIMEOUT"] || 30).to_i)

  #Configure Faraday
  opts[:faraday] ||= {}
  # Guard against silent TLS downgrade or attacker-controlled proxy via
  # opts[:faraday]. The require_https check earlier only inspects the URL
  # scheme; without this guard a caller passing
  #   faraday: { ssl: { verify: false }, proxy: "http://attacker" }
  # would neuter TLS verification on an HTTPS connection.
  validate_faraday_opts!(opts[:faraday])
  opts[:faraday].merge!(:url => @server_url)
  @conn = Faraday.new(opts[:faraday]) do |conn|
    # Apply timeouts before any user-supplied middleware sees a request.
    conn.options.timeout = read_timeout if read_timeout > 0
    conn.options.open_timeout = open_timeout if open_timeout > 0
    #conn.request :json

    # Configure logging if enabled
    if opts[:logging].present?
      # Configure the new structured logging middleware
      Parse::Middleware::Logging.enabled = true
      Parse::Middleware::Logging.logger = opts[:logger] if opts[:logger]
      case opts[:logging]
      when :debug
        Parse::Middleware::Logging.log_level = :debug
        Parse::Middleware::BodyBuilder.logging = true
      when :warn
        Parse::Middleware::Logging.log_level = :warn
      else
        Parse::Middleware::Logging.log_level = :info
      end
    end

    # This middleware handles sending the proper authentication headers to Parse
    # on each request.

    # this is the required authentication middleware. Should be the first thing
    # so that other middlewares have access to the env that is being set by
    # this middleware. First added is first to brocess.
    conn.use Parse::Middleware::Authentication,
             application_id: @application_id,
             master_key: @master_key,
             api_key: @api_key
    # Request/response logging middleware (configured via Parse.logging_enabled)
    conn.use Parse::Middleware::Logging

    # Performance profiling middleware (configured via Parse.profiling_enabled)
    conn.use Parse::Middleware::Profiling

    # This middleware turns the result from Parse into a Parse::Response object
    # and making sure request that are going out, follow the proper MIME format.
    # We place it after the Authentication middleware in case we need to use then
    # authentication information when building request and responses.
    conn.use Parse::Middleware::BodyBuilder

    if opts[:cache].present?
      if opts[:expires].to_i <= 0
        warn "[Parse::Client] Cache store provided but :expires is not set or is 0. " \
             "Caching will be disabled. Set :expires to enable caching (e.g., expires: 10)."
      else
        # advanced: provide a REDIS url, we'll configure a Redis store.
        if opts[:cache].is_a?(String) && opts[:cache].starts_with?("redis://")
          begin
            # Eagerly load the redis adapter so a missing `redis` gem
            # fails fast here (at setup) with the friendly hint below,
            # rather than deferring to the first cache access — the
            # Parse::Cache::Redis pool builds its Moneta-Redis backends
            # lazily, so without this the LoadError would surface later.
            require "moneta/adapters/redis"
            # Route through Parse::Cache::Redis rather than a bare
            # `Moneta.new(:Redis, ...)`. SECURITY: the Moneta-Redis store
            # Marshals values by default, so every cache hit would
            # `Marshal.load` whatever bytes come back from Redis — an
            # arbitrary-code-execution primitive if the cache is shared,
            # unauthenticated, or reachable over a plaintext `redis://`
            # MITM. The wrapper forces `value_serializer: nil` and
            # JSON-(de)serializes cached values itself, closing that
            # deserialization vector on this shorthand the same way an
            # explicitly-constructed wrapper does.
            opts[:cache] = Parse::Cache::Redis.new(url: opts[:cache])
          rescue LoadError
            puts "[Parse::Middleware::Caching] Did you forget to load the redis gem (Gemfile)?"
            raise
          end
        end

        unless [:key?, :[], :delete, :store].all? { |method| opts[:cache].respond_to?(method) }
          raise ArgumentError, "Parse::Client option :cache needs to be a type of Moneta store"
        end

        # If the caller passed a `Parse::Cache::Redis` wrapper, let its
        # built-in namespace flow through automatically. An explicit
        # `cache_namespace:` still wins so callers can override.
        if defined?(Parse::Cache::Redis) && opts[:cache].is_a?(Parse::Cache::Redis)
          opts[:cache_namespace] ||= opts[:cache].namespace
        end

        self.cache = opts[:cache]

        # Build one keyspace from the effective namespace and install it on
        # both the middleware and the store, so key generation and eviction
        # can never disagree. Previously the middleware could hold a
        # `cache_namespace:` the store knew nothing about, and
        # `clear_cache!` scoped using only the store's own namespace, so a
        # namespaced client cleared every SDK key on the database.
        #
        # Opt-in: without `cache_keyspace: true` the legacy key shape is
        # kept, so an upgrade changes nothing until an operator asks for it.
        #
        # `scoped` derives an immutable, per-client view rather than
        # mutating the store in place. This matters when one backend
        # (e.g. a `Parse::Cache::Redis` connection pool) is shared across
        # more than one `Parse::Client`: mutating a shared store's
        # keyspace would rebind it out from under whichever client
        # configured it first, so this client's own `sdk_cache` becomes
        # the view while `cache` stays the store that was configured, and
        # the shared backend itself is never touched.
        cache_keyspace = nil
        if opts[:cache_keyspace]
          cache_keyspace = Parse::Cache::Keyspace.new(
            app_id: @application_id,
            server_url: @server_url,
            namespace: opts[:cache_namespace],
          )
          # Derive an immutable per-client view rather than mutating the
          # backend, so two clients can share a connection pool without
          # sharing ownership of the keyspace. There is deliberately no
          # `keyspace=` fallback here, since reintroducing a mutable
          # binding at the call site would restore the cross-client
          # rebinding this replaces.
          #
          # A store that cannot produce a view is wrapped rather than left
          # alone. Leaving it bare still composed keys correctly, because
          # the middleware below receives the keyspace directly, so the
          # deployment looked keyspaced; but `clear_cache!` then called the
          # store's own unrestricted `clear`, which on a plain
          # `Moneta.new(:Redis)` is FLUSHDB. Opting into keyspacing and
          # getting a database-wide flush is the exact inversion of the
          # option: it deletes other applications' entries and any
          # `parse-stack:foc:v1:*` create-locks sharing the database.
          #
          # The view is assigned to `sdk_cache`, NOT over `cache`. An
          # earlier version replaced `cache` outright, which meant the
          # store an application configured and passed in was no longer
          # reachable through the accessor documented for reaching it,
          # and application reads and writes silently moved inside the
          # SDK's keyspace. A scoped view also cannot honestly stand in
          # for a complete Moneta store: `clear`, `each_key`, and `close`
          # either break scope isolation or quietly change meaning.
          @sdk_cache = if self.cache.respond_to?(:scoped)
              self.cache.scoped(cache_keyspace)
            else
              Parse::Cache::KeyspacedStore.new(store: self.cache, keyspace: cache_keyspace)
            end
        end

        # Register the invalidation triggers once a keyspace exists, so
        # role and identity staleness is bounded by webhook rather than by
        # application discipline. Opt-in with the keyspace, since without
        # planes there is nothing to invalidate.
        if cache_keyspace && sdk_cache.respond_to?(:roles) &&
           opts.fetch(:cache_invalidation_hooks, true)
          begin
            Parse::Cache::Invalidation.install!(sdk_cache)
          rescue StandardError => e
            warn "[Parse::Client] cache invalidation hooks not installed: #{e.class}"
          end
        end

        conn.use Parse::Middleware::Caching, sdk_cache, {
          expires: opts[:expires].to_i,
          # Optional `cache_namespace:` prefixes every key so two Parse
          # apps sharing one Redis don't collide on `mk:/classes/Song/abc`.
          # Explicit only — we do NOT auto-derive from app_id to keep
          # existing single-app deployments backward-compatible.
          namespace: opts[:cache_namespace],
          keyspace: cache_keyspace,
          # During a rolling deploy, new workers write keyspaced keys while
          # old workers still read the legacy shape, so invalidation has to
          # hit both until every old worker is drained.
          delete_legacy_variants: opts.fetch(:cache_delete_legacy_variants, true),
        }

        # Inform about opt-in cache behavior
        unless Parse.default_query_cache
          warn "[Parse::Client] Caching middleware enabled (expires: #{opts[:expires]}s). " \
               "Queries do NOT use cache by default. Use `cache: true` on queries to opt-in, " \
               "or set `Parse.default_query_cache = true` for opt-out behavior."
        end
      end
    end

    yield(conn) if block_given?

    # Configure the adapter with optional settings
    # For net_http_persistent:
    # - pool_size must be passed as an adapter argument (constructor param, no setter)
    # - idle_timeout and keep_alive have setters and are configured in the block
    if adapter_options.any?
      # Extract constructor arguments for the adapter
      adapter_args = {}
      adapter_args[:pool_size] = adapter_options[:pool_size] if adapter_options[:pool_size]

      conn.adapter adapter, **adapter_args do |http|
        http.idle_timeout = adapter_options[:idle_timeout] if adapter_options[:idle_timeout]
        http.keep_alive = adapter_options[:keep_alive] if adapter_options[:keep_alive]
      end
    else
      conn.adapter adapter
    end
  end
  # Faraday's constructor may still synthesise a ProxyOptions from
  # HTTPS_PROXY/HTTP_PROXY env vars regardless of the `proxy: nil`
  # we pass in opts. Clear the proxy on the connection itself to be
  # sure no env-derived MITM survives.
  @conn.proxy = nil if !@allow_faraday_proxy && @conn.respond_to?(:proxy=)
  Parse::Client.clients[:default] ||= self

  # Configure LiveQuery if URL provided
  configure_live_query(opts)
end

Class Attribute Details

.clients ⇒ `Object` (readonly)

Returns the value of attribute clients.



472
473
474

# File 'lib/parse/client.rb', line 472

def clients
  @clients
end

Instance Attribute Details

#api_key ⇒ `String` (readonly)

The Parse API key to be sent in every API request.

Returns:

(String)

348	# File 'lib/parse/client.rb', line 348 attr_accessor :cache

#application_id ⇒ `String` (readonly) Also known as: app_id

The Parse application identifier to be sent in every API request.

Returns:

(String)

348	# File 'lib/parse/client.rb', line 348 attr_accessor :cache

#cache ⇒ `Moneta::Transformer`, `Moneta::Expires`

The underlying cache store for caching API requests.

Returns:

(Moneta::Transformer, Moneta::Expires)

See Also:

Parse.cache



348
349
350

# File 'lib/parse/client.rb', line 348

def cache
  @cache
end

#master_key ⇒ `String` (readonly)

The Parse master key for this application, which when set, will be sent in every API request. (There is a way to prevent this on a per request basis.)

Returns:

(String)

348	# File 'lib/parse/client.rb', line 348 attr_accessor :cache

#retry_limit ⇒ `Integer`

If set, returns the current retry count for this instance. Otherwise, returns DEFAULT_RETRIES. Set to 0 to disable retry mechanism.

Returns:

(Integer) —
the current retry count for this client.

348	# File 'lib/parse/client.rb', line 348 attr_accessor :cache

#server_url ⇒ `String` (readonly)

The Parse server url that will be receiving these API requests. By default this will be Protocol::SERVER_URL.

Returns:

(String)

348	# File 'lib/parse/client.rb', line 348 attr_accessor :cache

#session_token ⇒ `String`^? (readonly)

Returns the session token bound to this client, if any (see the :session_token constructor option). Applied as the lowest-priority auth fallback on every request.

Returns:

(String, nil) —
the session token bound to this client, if any (see the :session_token constructor option). Applied as the lowest-priority auth fallback on every request.



354
355
356

# File 'lib/parse/client.rb', line 354

def session_token
  @session_token
end

Class Method Details

.client(conn = :default) ⇒ `Parse::Client`

Returns or create a new Parse::Client connection for the given connection name.

Parameters:

conn (Symbol) (defaults to: :default) —
the name of the connection.

Returns:

(Parse::Client)



484
485
486

# File 'lib/parse/client.rb', line 484

def client(conn = :default)
  @clients[conn] ||= self.new
end

.client?(conn = :default) ⇒ `Boolean`

Returns true if a Parse::Client has been configured.

Parameters:

conn (Symbol) (defaults to: :default) —
the name of the connection.

Returns:

(Boolean) —
true if a Parse::Client has been configured.



476
477
478

# File 'lib/parse/client.rb', line 476

def client?(conn = :default)
  @clients[conn].present?
end

.setup(opts = {}) { ... } ⇒ `Client`

Setup the a new client with the appropriate Parse app keys, middleware and options.

Examples:

Parse.setup app_id: "YOUR_APP_ID",
            api_key: "YOUR_REST_API_KEY",
            master_key: "YOUR_MASTER_KEY", # optional
            server_url: 'https://localhost:1337/parse' #default

Parameters:

opts (Hash) (defaults to: {}) —
a set of connection options to configure the client.

Options Hash (opts):

:server_url (String) —
The server url of your Parse Server if you are not using the hosted Parse service. By default it will use ENV if available, otherwise fallback to Protocol::SERVER_URL.
:app_id (String) —
The Parse application id. Defaults to ENV.
:api_key (String) —
Your Parse REST API Key. Defaults to ENV.
:master_key (String) —
The Parse application master key (optional). If this key is set, it will be sent on every request sent by the client and your models. Defaults to ENV.
:session_token (String) —
An optional session token bound to this client. When set, every request that does not pass an explicit session_token: / use_master_key: true and is not inside a Parse.with_session block sends this token (and suppresses the master key), so the client transparently acts as that user. Precedence is explicit per-call > Parse.with_session ambient > this bound token. Typically paired with master_key: nil to build a user-scoped client (see Webhooks::Payload#user_client).
:logging (Boolean, Symbol) —
Controls request/response logging.
- true - Enable logging at :info level
- :debug - Enable verbose logging with headers and body content
- :warn - Only log errors and warnings
- false or nil - Disable logging (default) This configures both the new Middleware::Logging middleware and the legacy Middleware::BodyBuilder logging.
:logger (Logger) —
A custom logger instance for request/response logging. Defaults to Logger.new(STDOUT) if not specified.
:adapter (Object) —
The connection adapter. By default it uses :net_http_persistent for connection pooling. Set connection_pooling: false to use the standard Faraday.default_adapter (Net/HTTP) instead.
:connection_pooling (Boolean, Hash) —
Controls HTTP connection pooling. Defaults to true, using the :net_http_persistent adapter for improved performance through connection reuse. Set to false to disable pooling and create a new connection for each request. This option is ignored if :adapter is explicitly specified. Pass a Hash to enable pooling with custom configuration:
- :pool_size [Integer] - Number of connections per thread (default: 1)
- :idle_timeout [Integer] - Seconds before closing idle connections (default: 5)
- :keep_alive [Integer] - HTTP Keep-Alive timeout in seconds @example Custom connection pooling Parse.setup( connection_pooling: { pool_size: 5, idle_timeout: 60, keep_alive: 60 } )
:cache (Moneta::Transformer, Moneta::Expires, Parse::Cache::Redis, String) —
A caching adapter of type Moneta::Transformer or Moneta::Expires that will be used by the caching middleware Middleware::Caching. You can also pass a redis:// URL string (an internal Moneta-Redis store will be built for you) or a Parse::Cache::Redis wrapper, which adds a connection pool and automatic namespace forwarding. Caching queries and object fetches can help improve the performance of your application, even if it is for a few seconds. Only successful GET object fetches and non-empty result queries will be cached by default. You may set the default expiration time with the expires option. At any point in time you may clear the cache by calling the #clear_cache! method on the client connection. See Moneta.
:expires (Integer) —
Sets the default cache expiration time (in seconds) for successful non-empty GET requests when using the caching middleware. The default value is 3 seconds. If :expires is set to 0, caching will be disabled. You can always clear the current state of the cache using the clear_cache! method on your Parse::Client instance.
:cache_namespace (String) —
Optional prefix applied to every cache key. Useful when two Parse apps share one Redis instance and would otherwise collide on identical paths (e.g. mk:/classes/Song/abc). Keys become <namespace>:<existing-prefix>:<url>, so a SCAN <namespace>:* evicts a whole app cleanly. Defaults to no namespace for backward compatibility — explicit only, never auto-derived from app_id.
:faraday (Hash) —
You may pass a hash of options that will be passed to the Faraday constructor.
:live_query_url (String) —
The WebSocket URL for Parse LiveQuery server (e.g., "wss://your-parse-server.com"). If not specified, falls back to ENV. LiveQuery enables real-time subscriptions to changes in Parse objects. @example Enable LiveQuery Parse.setup( server_url: "https://your-server.com/parse", application_id: "YOUR_APP_ID", api_key: "YOUR_API_KEY", live_query_url: "wss://your-server.com" )
:live_query (Hash) —
Advanced LiveQuery configuration options. Pass a hash with custom settings for the LiveQuery client.
- :url [String] - WebSocket URL (alternative to :live_query_url)
- :auto_reconnect [Boolean] - Auto-reconnect on disconnect (default: true)

Yields:

the block for additional configuration with Faraday middleware.

Returns:

(Client) —
a new instance of Client

See Also:



503
504
505

# File 'lib/parse/client.rb', line 503

def setup(opts = {}, &block)
  @clients[:default] = self.new(opts, &block)
end

Instance Method Details

#anonymous ⇒ `Parse::Client`

A NEW anonymous client that mirrors THIS client's connection but carries neither a master key nor a session token — every request it makes is unauthenticated (app-id + REST key only). Use it to drop the bound user identity for a one-off public read without mutating a shared client. Equivalent to #become with no token.

Returns:

(Parse::Client)



429
430
431

# File 'lib/parse/client.rb', line 429

def anonymous
  become(nil)
end

#authorization ⇒ `Parse::Authorization::Context`

This client's authorization context: the identity and role caches, and the session-token resolver that feeds every mongo-direct ACL decision.

One context per client, created lazily and never shared. That is the point of it living here rather than in module-level state: two clients pointed at two Parse applications must not resolve a token against each other's caches, nor validate it against each other's /users/me.

Returns:

(Parse::Authorization::Context)



385
386
387

# File 'lib/parse/client.rb', line 385

def authorization
  @authorization ||= Parse::Authorization::Context.new(client: self)
end

#become(session_token) ⇒ `Parse::Client`

A NEW non-master Parse::Client that mirrors THIS client's connection settings (server_url / application_id / api_key) but carries no master key and binds session_token, so it acts on the server as that user (ACL / CLP / protectedFields enforced, no master-key fallback). This is the general primitive behind Webhooks::Payload#user_client and User#session_client: derive a user-scoped client from a configured (e.g. master) client without re-specifying the connection.

user_client = Parse.client.become(user.session_token)
Parse::Query.new("Post", client: user_client).results   # as the user

Parameters:

session_token (String, #session_token) —
the token to bind. A blank token yields a tokenless non-master client (anonymous REST).

Returns:

(Parse::Client)

# File 'lib/parse/client.rb', line 413

def become(session_token)
  Parse::Client.new(
    server_url: @server_url,
    app_id: @application_id,
    api_key: @api_key,
    master_key: nil,
    session_token: session_token,
  )
end

#body_carries_atomic_op?(body) ⇒ `Boolean`

Whether a request body carries a Parse atomic operation, i.e. any field whose value is a Hash with an __op key (Increment, Add, AddUnique, Remove, AddRelation, RemoveRelation, Delete). Such ops are not idempotent and must not be replayed on an ambiguous failure. Assumes the body is a Ruby Hash, which the SDK's normal save/update path always provides; a pre-serialized String body is treated as op-free (and therefore retryable), so callers handing request a raw JSON string for a PUT-with-op would bypass this guard.

Parameters:

body (Object) —
the request body.

Returns:

(Boolean)

# File 'lib/parse/client.rb', line 1482

def body_carries_atomic_op?(body)
  return false unless body.is_a?(Hash)
  body.any? { |_k, v| v.is_a?(Hash) && (v.key?("__op") || v.key?(:__op)) }
end

#clear_cache! ⇒ `Object`

Clear the SDK's own cached entries.

Operates on #sdk_cache, so with cache_keyspace: true this removes only keys under this client's keyspace and leaves application keys in the same store untouched. Without a keyspace sdk_cache IS cache, and the call has its historical whole-store meaning.

To clear the underlying store outright, call client.cache.clear explicitly. On a Redis-backed store that is FLUSHDB and takes everything on the database with it, including other applications and any parse-stack:foc:v1:* create-locks.

# File 'lib/parse/client.rb', line 1087

def clear_cache!
  target = sdk_cache
  target.clear if target.present?
end

#configure_live_query(opts) ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Configure LiveQuery with the given options

Parameters:

opts (Hash) —
configuration options

Options Hash (opts):

:live_query_url (String) —
WebSocket URL for LiveQuery server (wss://...)

# File 'lib/parse/client.rb', line 985

def configure_live_query(opts)
  live_query_url = opts[:live_query_url] || ENV["PARSE_LIVE_QUERY_URL"]

  return unless live_query_url || opts[:live_query]

  require_relative "live_query"

  live_query_opts = opts[:live_query].is_a?(Hash) ? opts[:live_query] : {}
  resolved_url = live_query_url || live_query_opts[:url]

  # Refuse explicit `ws://` against a non-loopback host unless
  # `allow_insecure: true` is also passed in `live_query:`. The
  # downstream `derive_websocket_url` path already enforces this for
  # URLs derived from a Parse Server `http://` URL, but an explicit
  # `live_query: { url: "ws://prod-host" }` or
  # `live_query_url: "ws://prod-host"` bypassed it — the master key
  # and any session token would ride the connect frame in cleartext.
  validate_live_query_url!(resolved_url, allow_insecure: live_query_opts[:allow_insecure])

  # Warn (don't raise) on `live_query: { ... }` keys that are not
  # `Parse::LiveQuery::Configuration` setters. The block form would
  # otherwise silently swallow typos like
  # `live_query: { ssl_min_versoin: :TLSv1_3 }` and leave TLS at the
  # default, losing the operator's intent. The pre-fix kwargs form
  # raised `ArgumentError` here; this restores the surface without
  # making it a hard failure for unknown-but-harmless keys.
  warn_about_unknown_live_query_keys!(live_query_opts)

  Parse::LiveQuery.configure do |config|
    config.application_id = @application_id if @application_id
    config.client_key = @api_key if @api_key
    config.master_key = @master_key if @master_key

    # Apply hash-form options first so the resolved URL (which honors
    # top-level `live_query_url:` over `live_query: { url: }`) wins.
    # Without this, the loop would re-write `config.url` from the
    # hash and silently invert the documented precedence.
    live_query_opts.each do |key, value|
      next if key == :url
      setter = "#{key}="
      config.public_send(setter, value) if config.respond_to?(setter)
    end

    config.url = resolved_url if resolved_url
  end
end

#connected?(endpoint = nil) ⇒ `Boolean`

Connectivity probe. By default hits the Parse Server health endpoint — the same target as #reachable? — so it returns true whenever the server is up, regardless of CLP configuration.

Why not a _User find? A limit-0 find against _User exercises the auth stack, but locking _User finds to the master key via a Class-Level Permission is standard production hardening — on such a server the probe gets a permission error and (wrongly) reports "not connected" for a perfectly healthy, correctly-configured deployment. The default therefore avoids any data class.

To ALSO validate credentials, pass endpoint: a path to a class the configured key is allowed to read (e.g. "classes/_User" on a default server, or one of your own readable classes). The probe runs limit: 0 so it never pulls rows, and routes through the auth middleware, so a wrong application_id / REST key surfaces as an Error::AuthenticationError and is converted to false. Any connection, timeout, or API error returns false rather than raising; genuine programming errors (e.g. NoMethodError) still propagate.

Parameters:

endpoint (String, nil) (defaults to: nil) —
optional path to probe instead of the health endpoint, to validate credentials against a readable class.

Returns:

(Boolean) —
true if the server is reachable (and, when an endpoint is given, the credentials are accepted).

# File 'lib/parse/client.rb', line 1128

def connected?(endpoint = nil)
  path = endpoint || Parse::API::Server::SERVER_HEALTH_PATH
  response = request(:get, path, query: { limit: 0 }, opts: { cache: false })
  response.success?
rescue Parse::Error, Faraday::Error
  false
end

#delete(uri, body = nil, headers = {}) ⇒ `Parse::Response`

Send a DELETE request.

Parameters:

uri (String) —
the uri path for this request.
body (Hash) (defaults to: nil) —
a hash that will be JSON encoded for the body of this request.
headers (Hash) (defaults to: {}) —
additional headers to send in this request.

Returns:

(Parse::Response) —
the response for this request.



1519
1520
1521

# File 'lib/parse/client.rb', line 1519

def delete(uri, body = nil, headers = {})
  request :delete, uri, body: body, headers: headers
end

#get(uri, query = nil, headers = {}) ⇒ `Parse::Response`

Send a GET request.

Parameters:

uri (String) —
the uri path for this request.
query (Hash) (defaults to: nil) —
the set of url query parameters.
headers (Hash) (defaults to: {}) —
additional headers to send in this request.

Returns:

(Parse::Response) —
the response for this request.



1492
1493
1494

# File 'lib/parse/client.rb', line 1492

def get(uri, query = nil, headers = {})
  request :get, uri, query: query, headers: headers
end

#idempotent_retry?(method, body, headers = nil) ⇒ `Boolean`

Whether a request whose outcome is UNKNOWN (a 500/503 or a dropped connection) is safe to transparently re-send.

Server-dedup fast path: when the operator has asserted Parse Server idempotency is configured (Request.assume_server_idempotency) AND this request carries a stable X-Parse-Request-Id header, the server deduplicates a replay, so even a POST or an atomic-op write is safe to retry — the write applies at most once. The replay is NOT a transparent success, though: Parse Server rejects the duplicate with error 159, surfaced as a raised Error::DuplicateRequestError the caller must rescue (the original write already landed). The SDK sends the same request id on every retry (the header is set once and preserved across the retry), which is what makes the server-side dedup match.

Otherwise the conservative method/body heuristic applies: GET and DELETE are idempotent; a full-object PUT update is idempotent ONLY when it carries no atomic __op mutation (Increment/Add/AddUnique/Remove/Relation would double-apply on replay); POST (object create / batch) is never auto-retried. 429 throttles are handled at the call site, since the server provably discarded the request and those re-send regardless.

Parameters:

method (Symbol) —
the (downcased) HTTP method of the request.
body (Hash, Object, nil) —
the request body.
headers (Hash, nil) (defaults to: nil) —
the outgoing request headers (consulted for the request-id header on the server-dedup fast path).

Returns:

(Boolean)

# File 'lib/parse/client.rb', line 1448

def idempotent_retry?(method, body, headers = nil)
  return true if server_deduped_request?(headers)
  case method
  when :get, :delete then true
  when :put then !body_carries_atomic_op?(body)
  else false
  end
end

#inspect ⇒ `Object`

Redacted inspection. The default Ruby #inspect would dump every ivar, exposing the master key and any bound session token in cleartext wherever a client is logged or surfaced in an error reporter. Show only the connection identity and a boolean for each credential's presence.

# File 'lib/parse/client.rb', line 393

def inspect
  "#<#{self.class.name} server_url=#{@server_url.inspect} " \
  "app_id=#{@application_id.inspect} master_key=#{@master_key ? "[FILTERED]" : "nil"} " \
  "session_token=#{@session_token ? "[FILTERED]" : "nil"}>"
end

#post(uri, body = nil, headers = {}) ⇒ `Parse::Response`

Send a POST request.

Parameters:

body (Hash) (defaults to: nil) —
a hash that will be JSON encoded for the body of this request.
uri (String) —
the uri path for this request.
headers (Hash) (defaults to: {}) —
additional headers to send in this request.

Returns:

(Parse::Response) —
the response for this request.



1501
1502
1503

# File 'lib/parse/client.rb', line 1501

def post(uri, body = nil, headers = {})
  request :post, uri, body: body, headers: headers
end

#put(uri, body = nil, headers = {}) ⇒ `Parse::Response`

Send a PUT request.

Parameters:

uri (String) —
the uri path for this request.
body (Hash) (defaults to: nil) —
a hash that will be JSON encoded for the body of this request.
headers (Hash) (defaults to: {}) —
additional headers to send in this request.

Returns:

(Parse::Response) —
the response for this request.



1510
1511
1512

# File 'lib/parse/client.rb', line 1510

def put(uri, body = nil, headers = {})
  request :put, uri, body: body, headers: headers
end

#reachable? ⇒ `Boolean`

No-credentials liveness probe. Hits the Parse Server health endpoint and returns true when the server responds with status "ok". No application credentials are required, so this passes even when the configured application_id or REST key is wrong. Use #connected? to also validate credentials.

Returns:

(Boolean) —
true if the server is up and returned a healthy status.

# File 'lib/parse/client.rb', line 1098

def reachable?
  response = request(:get, Parse::API::Server::SERVER_HEALTH_PATH, opts: { cache: false })
  response.success?
rescue Parse::Error, Faraday::Error
  false
end

#request(method, uri = nil, body: nil, query: nil, headers: nil, opts: {}) ⇒ `Parse::Response`

Send a REST API request to the server. This is the low-level API used for all requests to the Parse server with the provided options. Every request sent to Parse through the client goes through the configured set of middleware that can be modified by applying different headers or specific options. This method supports retrying requests a few times when a ServiceUnavailableError is raised.

Parameters:

method (Symbol) —
The method type of the HTTP request (ex. :get, :post).
- This parameter can also be a Request object.
uri (String) (defaults to: nil) —
the url path. It should not be an absolute url.
body (Hash) (defaults to: nil) —
the body of the request.
query (Hash) (defaults to: nil) —
the set of url query parameters to use in a GET request.
headers (Hash) (defaults to: nil) —
additional headers to apply to this request.
opts (Hash) (defaults to: {}) —
a set of options to pass through the middleware stack.
- :cache [Integer] the number of seconds to cache this specific request. If set to false, caching will be disabled completely all together, which means even if a cached response exists, it will not be used.
- :use_master_key [Boolean] whether this request should send the master key, if it was configured with Parse.setup. By default, if a master key was configured, all outgoing requests will contain it in the request header. Default true.
- :session_token [String] The session token to send in this request. This disables sending the master key in the request, and sends this request with the credentials provided by the session_token.
- :retry [Integer] The number of retrties to perform if the service is unavailable. Set to false to disable the retry mechanism. When performing request retries, the client will sleep for a number of seconds (RETRY_DELAY) between requests. The default value is DEFAULT_RETRIES.

Returns:

(Parse::Response) —
the response for this request.

Raises:

Parse::Error::AuthenticationError when HTTP response status is 401 or 403
Parse::Error::TimeoutError when HTTP response status is 400 or 408, and the Parse code is 143 or Response::ERROR_TIMEOUT.
Parse::Error::ConnectionError when HTTP response status is 404 is not an object not found error.
- This will also be raised if after retrying a request a number of times has finally failed.
Parse::Error::ProtocolError when HTTP response status is 405 or 406
Parse::Error::ServiceUnavailableError when HTTP response status is 500 or 503.
- This may also happen when the Parse Server response code is any number less than Response::ERROR_SERVICE_UNAVAILABLE.
Parse::Error::ServerError when the Parse response code is less than 100
Parse::Error::RequestLimitExceededError when the Parse response code is Response::ERROR_EXCEEDED_BURST_LIMIT.
- This usually means you have exceeded the burst limit on requests, which will mean you will be throttled for the next 60 seconds.
Parse::Error::InvalidSessionTokenError when the Parse response code is 209.
Parse::Error::DuplicateRequestError when the Parse response code is Response::ERROR_DUPLICATE_REQUEST (159) — request-id idempotency rejected a duplicate; the original write already applied.
- This means the session token that was sent in the request seems to be invalid.

See Also:

# File 'lib/parse/client.rb', line 1186

def request(method, uri = nil, body: nil, query: nil, headers: nil, opts: {})
  # Pre-declare locals referenced inside rescue blocks so CodeQL's
  # uninitialized-variable analysis is satisfied even if an exception
  # raises before the natural assignment site.
  response = nil
  _retry_count = nil
  _retry_delay = nil
  _request = nil
  # Kwarg-absorption guard. The `**opts` splat in API helper methods
  # (lib/parse/api/*.rb) absorbs a caller-passed `opts: { ... }`
  # keyword as a key named `:opts` rather than as the request options
  # hash itself. The auth context (session_token, use_master_key)
  # buried under :opts then never reaches the request — the call
  # silently goes out anonymous (or master, if one is configured),
  # which is a permission-downgrade footgun. Fail loudly here so the
  # bug surfaces in dev/test instead of in production.
  if opts.is_a?(Hash) && opts[:opts].is_a?(Hash)
    raise ArgumentError, "Parse::Client#request received nested `opts: { opts: { ... } }` — " \
                         "pass session_token: / use_master_key: directly as keywords, " \
                         "not wrapped in an `opts:` hash. " \
                         "Bad: Parse.client.create_object('X', body, opts: { session_token: t }) " \
                         "Good: Parse.client.create_object('X', body, session_token: t, use_master_key: false)"
  end

  # Retry budget. Initialized ONCE here, ABOVE the `begin` below, so the
  # `retry` keyword in the rescue clauses (which re-runs only the begin
  # block, not the whole method) preserves the countdown across attempts.
  # If this initialization ran inside the begin it would reset on every
  # attempt, turning a transient 500/503/429 into an infinite retry loop.
  _retry_count ||= self.retry_limit

  if opts[:retry] == false
    _retry_count = 0
  elsif opts[:retry].to_i > 0
    _retry_count = opts[:retry]
  end

  # The effective starting budget, captured ONCE after the opts override
  # (and, like `_retry_count`, above the `begin` so `retry` doesn't reset
  # it). The backoff multiplier is `(_retry_max - _retry_count)`, which
  # grows 1, 2, 3, … as attempts are consumed. Deriving it from
  # `self.retry_limit` instead would go to zero or negative whenever a
  # caller passes `opts: { retry: N }` with N above the instance default,
  # silently disabling the backoff (every retry firing at zero delay).
  _retry_max ||= _retry_count

  begin
    headers ||= {}
    # if the first argument is a Parse::Request object, then construct it
    _request = nil
    if method.is_a?(Request)
      _request = method
      method = _request.method
      uri ||= _request.path
      query ||= _request.query
      body ||= _request.body
      headers.merge! _request.headers
    else
      _request = Parse::Request.new(method, uri, body: body, headers: headers, opts: opts)
    end

    # http method
    method = method.downcase.to_sym
    # set the User-Agent
    headers[USER_AGENT_HEADER] = USER_AGENT_VERSION

    if opts[:cache] == false
      headers[Parse::Middleware::Caching::CACHE_CONTROL] = "no-cache"
    elsif opts[:cache] == :write_only
      # Write-only mode: skip reading from cache, but still write to cache
      # Useful for fetch!/reload! which want fresh data but should update cache
      headers[Parse::Middleware::Caching::CACHE_WRITE_ONLY] = "true"
    elsif opts[:cache].is_a?(Numeric)
      # specify the cache duration of this request
      headers[Parse::Middleware::Caching::CACHE_EXPIRES_DURATION] = opts[:cache].to_s
    end

    # Resolve the auth context in three layers:
    #   1. explicit per-call `use_master_key:` and `session_token:`
    #   2. ambient session set by `Parse.with_session { ... }` (fiber-local)
    #   3. process-wide `Parse.client_mode` flag — when true, master key is
    #      never sent unless the caller explicitly passed `use_master_key: true`
    explicit_master = opts.key?(:use_master_key)

    if opts[:use_master_key] == false
      headers[Parse::Middleware::Authentication::DISABLE_MASTER_KEY] = "true"
    elsif Parse.client_mode && opts[:use_master_key] != true
      # client mode defaults master key OFF unless explicitly opted in
      headers[Parse::Middleware::Authentication::DISABLE_MASTER_KEY] = "true"
    end

    raw_token = opts[:session_token]
    # SEC-02: an EXPLICITLY-supplied session_token that is a blank /
    # whitespace-only string is an unusable credential — NOT an invitation
    # to fall back to the master key. Treat it as "no credential"
    # (anonymous) and fail closed: suppress the master key and send no
    # session header, so Parse Server applies public ACL/CLP instead of
    # silently executing with master authority. The caller passed a token
    # explicitly, so we also do NOT fall through to the ambient / bound
    # token — that was their stated (empty) scope. `session_token: nil`
    # (value literally nil) is unchanged: it means "not set", and still
    # resolves via the ambient / bound fallback below.
    explicit_blank_token = raw_token.is_a?(String) && raw_token.strip.empty?
    token = explicit_blank_token ? nil : raw_token
    # When no explicit token was passed AND the caller didn't ask to send
    # the master key, fall through to (in order) the fiber-local ambient set
    # by `Parse.with_session`, then this client's own bound `@session_token`.
    # Explicit `use_master_key: true` is treated as a deliberate admin call
    # and skips both — otherwise an `admin.do_thing(use_master_key: true)`
    # nested inside a `with_session(user)` block (or on a token-bound client)
    # would silently downgrade. The ambient wins over the bound token so a
    # `with_session` override inside a user-scoped client still takes effect.
    if token.nil? && !explicit_blank_token && !(explicit_master && opts[:use_master_key] == true)
      ambient = Parse.current_session_token
      # A whitespace-only ambient must not count as present: otherwise it
      # blocks the bound-token fallback below and then fails the later
      # `token.present?` check, silently sending the master key instead.
      token = ambient if ambient.is_a?(String) && !ambient.strip.empty?
      token = @session_token if (token.nil? || token.to_s.strip.empty?) && @session_token
    end
    if explicit_blank_token
      # Fail closed: never send the master key for an unusable explicit token.
      headers[Parse::Middleware::Authentication::DISABLE_MASTER_KEY] = "true"
    elsif token.present?
      token = token.session_token if token.respond_to?(:session_token)
      headers[Parse::Middleware::Authentication::DISABLE_MASTER_KEY] = "true"
      headers[Parse::Protocol::SESSION_TOKEN] = token
    end

    #if it is a :get request, then use query params, otherwise body.
    params = (method == :get ? query : body) || {}
    # if the path does not start with the '/1/' prefix, then add it to be nice.
    # actually send the request and return the body
    response_env = @conn.send(method, uri, params, headers)
    response = response_env.body
    response.request = _request

    case response.http_status
    when 401, 403
      Parse::Client._safe_warn("AuthenticationError", response)
      raise Parse::Error::AuthenticationError, response
    when 400, 408
      if response.code == Parse::Response::ERROR_TIMEOUT || response.code == 143 #"net/http: timeout awaiting response headers"
        Parse::Client._safe_warn("TimeoutError", response)
        raise Parse::Error::TimeoutError, response
      end
    when 404
      unless response.object_not_found?
        Parse::Client._safe_warn("ConnectionError", response)
        raise Parse::Error::ConnectionError, response
      end
    when 405, 406
      Parse::Client._safe_warn("ProtocolError", response)
      raise Parse::Error::ProtocolError, response
    when 429 # Request over the throttle limit
      Parse::Client._safe_warn("RequestLimitExceededError", response)
      raise Parse::Error::RequestLimitExceededError, response
    when 500, 503
      Parse::Client._safe_warn("ServiceUnavailableError", response)
      raise Parse::Error::ServiceUnavailableError, response
    end

    if response.error?
      if response.code <= Parse::Response::ERROR_SERVICE_UNAVAILABLE
        Parse::Client._safe_warn("ServiceUnavailableError", response)
        raise Parse::Error::ServiceUnavailableError, response
      elsif response.code <= 100
        Parse::Client._safe_warn("ServerError", response)
        raise Parse::Error::ServerError, response
      elsif response.code == Parse::Response::ERROR_EXCEEDED_BURST_LIMIT
        Parse::Client._safe_warn("RequestLimitExceededError", response)
        raise Parse::Error::RequestLimitExceededError, response
      elsif response.code == 209 # Error 209: invalid session token
        Parse::Client._safe_warn("InvalidSessionTokenError", response)
        raise Parse::Error::InvalidSessionTokenError, response
      elsif response.code == Parse::Response::ERROR_DUPLICATE_REQUEST # 159
        # Request-id idempotency rejected a duplicate — the original write
        # already applied (NOT a second time). Surface a typed, catchable
        # signal rather than a generic error; this is what a transparently-
        # retried write that landed-but-lost-its-response sees on the replay.
        Parse::Client._safe_warn("DuplicateRequestError", response)
        raise Parse::Error::DuplicateRequestError, response
      end
    end

    response
  rescue Parse::Error::RequestLimitExceededError, Parse::Error::ServiceUnavailableError => e
    # 429 (RequestLimitExceeded): the server threw the request away, so
    # re-sending is safe for any method. 500/503 (ServiceUnavailable) is
    # ambiguous — a write may have applied before the error — so only
    # re-send when the request is idempotent (see #idempotent_retry?).
    retryable = e.is_a?(Parse::Error::RequestLimitExceededError) || idempotent_retry?(method, body, headers)
    if _retry_count > 0 && retryable
      warn "[Parse:Retry] Retries remaining #{_retry_count} : #{response.request}"
      _retry_count -= 1
      # Use Retry-After header if available, otherwise use linear backoff
      retry_after = response.retry_after if response.respond_to?(:retry_after)
      if retry_after && retry_after > 0
        _retry_delay = retry_after
        warn "[Parse:Retry] Using Retry-After header: #{_retry_delay}s"
      else
        # Linear backoff (RETRY_DELAY × attempt number) with +/-25% jitter.
        # Never zero —
        # zero-wait retries amplify DoS against upstream and stampede on 429.
        backoff_delay = RETRY_DELAY * (_retry_max - _retry_count)
        _retry_delay = backoff_delay * (0.75 + rand * 0.5)
      end
      sleep _retry_delay if _retry_delay > 0
      retry
    end
    raise
  rescue Faraday::ClientError, Faraday::TimeoutError, Net::OpenTimeout => e
    # Request timed out mid-flight: the outcome is unknown (the server may
    # have received and applied the write but never answered), so only
    # re-send idempotent requests to avoid double-applying.
    #
    # Faraday 2.x raises `Faraday::TimeoutError` for a read timeout
    # (`Timeout::Error` / `Errno::ETIMEDOUT`); it subclasses `Faraday::Error`,
    # not `ClientError`, so it must be listed explicitly to be caught. We
    # deliberately do NOT catch `Faraday::ConnectionFailed` (connection
    # refused/reset, plus the wrapped connect-timeout): refused is a
    # non-transient "server down / misconfigured" failure, and auto-retrying
    # it only adds backoff latency before the inevitable error. Broadening to
    # reset connections safely (retry reset, fail fast on refused) is tracked
    # as a follow-up.
    if _retry_count > 0 && idempotent_retry?(method, body, headers)
      warn "[Parse:Retry] Retries remaining #{_retry_count} : #{_request}"
      _retry_count -= 1
      backoff_delay = RETRY_DELAY * (_retry_max - _retry_count)
      _retry_delay = backoff_delay * (0.75 + rand * 0.5)
      sleep _retry_delay if _retry_delay > 0
      retry
    end
    raise Parse::Error::ConnectionError, "#{_request} : #{e.class} - #{e.message}"
  end
end

#sdk_cache ⇒ `Object`

The store the SDK itself reads and writes: the response cache, the identity and role planes, and #clear_cache!.

With cache_keyspace: true this is a Parse::Cache::ScopedView (or a Parse::Cache::KeyspacedStore for a store that cannot produce one) confined to this client's keyspace. Without it, this IS #cache, so nothing about an existing deployment changes.

Kept separate from #cache because the two answer different questions. cache is the store the application configured and may still use for its own keys, under their original physical names. sdk_cache is the SDK's slice of it, and clearing that slice must not reach application data.

Returns:

(Object) —
the SDK-owned store.



372
373
374

# File 'lib/parse/client.rb', line 372

def sdk_cache
  @sdk_cache || self.cache
end

#send_request(req) ⇒ `Parse::Response`

Send a Request object.

Parameters:

req (Parse::Request) —
the request to send

Returns:

(Parse::Response) —
the response for this request.

Raises:

ArgumentError if req is not of type Parse::Request.

# File 'lib/parse/client.rb', line 1527

def send_request(req) #Parse::Request object
  raise ArgumentError, "Object not of Parse::Request type." unless req.is_a?(Parse::Request)
  request req.method, req.path, req.body, req.headers
end

#server_deduped_request?(headers) ⇒ `Boolean`

Whether this request is covered by Parse Server's server-side request-id deduplication, making a replay a no-op. True only when the operator has opted in via Request.assume_server_idempotency AND the request actually carries a non-blank request-id header (writes to inherently non-idempotent paths — sessions, logout, functions, push, jobs — never get a request id, so they correctly fail this check).

Parameters:

headers (Hash, nil) —
the outgoing request headers.

Returns:

(Boolean)

# File 'lib/parse/client.rb', line 1465

def server_deduped_request?(headers)
  return false unless Parse::Request.assume_server_idempotency
  return false unless headers.is_a?(Hash)
  rid = headers[Parse::Request.request_id_header]
  rid.is_a?(String) && !rid.strip.empty?
end

#url_prefix ⇒ `String`

Returns the url prefix of the Parse Server url.

Returns:

(String) —
the url prefix of the Parse Server url.



1072
1073
1074

# File 'lib/parse/client.rb', line 1072

def url_prefix
  @conn.url_prefix
end

#validate_live_query_url!(url, allow_insecure:) ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Raises:

(ArgumentError)

# File 'lib/parse/client.rb', line 1033

def validate_live_query_url!(url, allow_insecure:)
  return unless url.is_a?(String) && url.start_with?("ws://")

  host = URI.parse(url).host.to_s rescue ""
  return if LIVE_QUERY_LOOPBACK_HOSTS.include?(host)
  return if allow_insecure

  raise ArgumentError,
    "[Parse::Client] Refusing explicit insecure LiveQuery URL #{url.inspect}. " \
    "The connect frame carries the master key and any session token in " \
    "plaintext on this socket. Use wss:// for routable hosts, or pass " \
    "`live_query: { allow_insecure: true }` to opt into cleartext for " \
    "local development on a non-loopback address."
end

#warn_about_unknown_live_query_keys!(live_query_opts) ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/parse/client.rb', line 1049

def warn_about_unknown_live_query_keys!(live_query_opts)
  return unless live_query_opts.is_a?(Hash) && live_query_opts.any?

  probe = Parse::LiveQuery::Configuration.new
  unknown = live_query_opts.keys.reject { |k| probe.respond_to?("#{k}=") }
  return if unknown.empty?

  warn "[Parse::Client] Ignoring unknown live_query option(s): " \
    "#{unknown.inspect}. Valid keys are Parse::LiveQuery::Configuration " \
    "setters (url, application_id, client_key, master_key, ping_interval, " \
    "pong_timeout, allow_insecure, ssl_min_version, ssl_max_version, " \
    "logging_enabled, log_level, ...). Check for typos."
end

#with_session(&block) ⇒ `Object`

Run a block with this client's bound #session_token active as the ambient session, so every query / object operation inside it that resolves the default client (e.g. Post.count, Post.all, obj.save) is authorized by Parse Server as that user — ACL and CLP enforced, master key suppressed — without threading session_token: through each call.

This is the client-receiver flavor of Parse.with_session (and mirrors User#with_session); it scopes by binding the token as the AMBIENT session — it does not re-route operations through this client object, so the connection used inside the block is still the resolved default client. If you need operations to run against a different client, pass that client explicitly (e.g. Parse::Query.new("Post", client: #{become}(...))).

total = Parse::User.login(u, p).with_session { Post.count }   # readable Posts only

Scopes REST-routed operations (find / get / count / save). It does NOT scope mongo-direct queries (results_direct, aggregate, Atlas search): those resolve auth from the query's own session_token: / acl_user: and, absent that, run in MASTER mode — so a mongo-direct read inside this block is a full master read, not anonymous. Scope mongo-direct explicitly with a per-query session_token: or a scoped Agent.

Returns:

the value of the block.

Raises:

(ArgumentError) —
if this client has no bound session token (scoping would be a no-op and almost certainly a mistake).

# File 'lib/parse/client.rb', line 458

def with_session(&block)
  raise ArgumentError, "Parse::Client#with_session requires a block" unless block_given?
  raise ArgumentError, "Parse::Client#with_session requires a client with a bound session_token" if @session_token.nil?
  Parse.with_session(@session_token, &block)
end

Class: Parse::Client

Overview

Defined Under Namespace

Constant Summary collapse

Constants included from API::Server

Constants included from API::Hooks

Class Attribute Summary collapse

Instance Attribute Summary collapse

Attributes included from API::Server

Attributes included from API::Config

Class Method Summary collapse

Instance Method Summary collapse

Methods included from API::Users

Methods included from API::Sessions

Methods included from API::Server

Methods included from API::Schema

Methods included from API::Push

Methods included from API::Objects

Methods included from API::Hooks

Methods included from API::Files

Methods included from API::Config

Methods included from API::CloudFunctions

Methods included from API::Batch

Methods included from API::Aggregate

Methods included from API::Analytics

Constructor Details

#initialize(opts = {}) ⇒ Client

Class Attribute Details

.clients ⇒ Object (readonly)

Instance Attribute Details

#api_key ⇒ String (readonly)

#application_id ⇒ String (readonly) Also known as: app_id

#cache ⇒ Moneta::Transformer, Moneta::Expires

#master_key ⇒ String (readonly)

#retry_limit ⇒ Integer

#server_url ⇒ String (readonly)

#session_token ⇒ String? (readonly)

Class Method Details

.client(conn = :default) ⇒ Parse::Client

.client?(conn = :default) ⇒ Boolean

.setup(opts = {}) { ... } ⇒ Client

Examples:

Instance Method Details

#anonymous ⇒ Parse::Client

#authorization ⇒ Parse::Authorization::Context

#become(session_token) ⇒ Parse::Client

#body_carries_atomic_op?(body) ⇒ Boolean

#clear_cache! ⇒ Object

#configure_live_query(opts) ⇒ Object

#connected?(endpoint = nil) ⇒ Boolean

#delete(uri, body = nil, headers = {}) ⇒ Parse::Response

#get(uri, query = nil, headers = {}) ⇒ Parse::Response

#idempotent_retry?(method, body, headers = nil) ⇒ Boolean

#inspect ⇒ Object

#post(uri, body = nil, headers = {}) ⇒ Parse::Response

#put(uri, body = nil, headers = {}) ⇒ Parse::Response

#reachable? ⇒ Boolean

#request(method, uri = nil, body: nil, query: nil, headers: nil, opts: {}) ⇒ Parse::Response

#sdk_cache ⇒ Object

#send_request(req) ⇒ Parse::Response

#server_deduped_request?(headers) ⇒ Boolean

#url_prefix ⇒ String

#validate_live_query_url!(url, allow_insecure:) ⇒ Object

#warn_about_unknown_live_query_keys!(live_query_opts) ⇒ Object

#with_session(&block) ⇒ Object

#initialize(opts = {}) ⇒ `Client`

.clients ⇒ `Object` (readonly)

#api_key ⇒ `String` (readonly)

#application_id ⇒ `String` (readonly) Also known as: app_id

#cache ⇒ `Moneta::Transformer`, `Moneta::Expires`

#master_key ⇒ `String` (readonly)

#retry_limit ⇒ `Integer`

#server_url ⇒ `String` (readonly)

#session_token ⇒ `String`^? (readonly)

.client(conn = :default) ⇒ `Parse::Client`

.client?(conn = :default) ⇒ `Boolean`

.setup(opts = {}) { ... } ⇒ `Client`

#anonymous ⇒ `Parse::Client`

#authorization ⇒ `Parse::Authorization::Context`

#become(session_token) ⇒ `Parse::Client`

#body_carries_atomic_op?(body) ⇒ `Boolean`

#clear_cache! ⇒ `Object`

#configure_live_query(opts) ⇒ `Object`

#connected?(endpoint = nil) ⇒ `Boolean`

#delete(uri, body = nil, headers = {}) ⇒ `Parse::Response`

#get(uri, query = nil, headers = {}) ⇒ `Parse::Response`

#idempotent_retry?(method, body, headers = nil) ⇒ `Boolean`

#inspect ⇒ `Object`

#post(uri, body = nil, headers = {}) ⇒ `Parse::Response`

#put(uri, body = nil, headers = {}) ⇒ `Parse::Response`

#reachable? ⇒ `Boolean`

#request(method, uri = nil, body: nil, query: nil, headers: nil, opts: {}) ⇒ `Parse::Response`

#sdk_cache ⇒ `Object`

#send_request(req) ⇒ `Parse::Response`

#server_deduped_request?(headers) ⇒ `Boolean`

#url_prefix ⇒ `String`

#validate_live_query_url!(url, allow_insecure:) ⇒ `Object`

#warn_about_unknown_live_query_keys!(live_query_opts) ⇒ `Object`

#with_session(&block) ⇒ `Object`