Module: BetterAuth::Telemetry::Detectors::Environment

Defined in:
lib/better_auth/telemetry/detectors/environment.rb

Overview

Environment detector. Classifies the current process as ‘“production”`, `“ci”`, `“test”`, or `“development”`, mirroring the upstream `detect-runtime.ts:detectEnvironment` short-circuit chain.

Precedence (top wins):

1. `"production"` — when any of `RACK_ENV`, `RAILS_ENV`,
   `APP_ENV` equals the literal string `"production"`.
2. `"ci"` — when any of the documented CI marker variables
   ({CI_VARS}) is set to a non-empty value that is not the
   case-insensitive string `"false"`.
3. `"test"` — when any of `RACK_ENV`, `RAILS_ENV`, `APP_ENV`
   equals the literal string `"test"`.
4. `"development"` — fallback when no rule above matches.

The CI marker check intentionally skips the literal string ‘“false”` (case-insensitive) so a host that exports `CI=false` (a common pattern in non-CI shells where CI tooling has been opted out) is not misclassified. Empty values are also treated as unset.

Examples:

BetterAuth::Telemetry::Detectors::Environment.call
# => "development"

Constant Summary collapse

CI_VARS =

CI marker variables, in the upstream-defined order. Any non-empty / non-‘“false”` value flips the classifier to `“ci”`.

%w[
  CI
  BUILD_ID
  BUILD_NUMBER
  CI_APP_ID
  CI_BUILD_ID
  CI_BUILD_NUMBER
  CI_NAME
  CONTINUOUS_INTEGRATION
  RUN_ID
].freeze
TEST_VARS =

Test/production env variable names that get inspected for the literal ‘“production”` and `“test”` strings.

%w[RACK_ENV RAILS_ENV APP_ENV].freeze

Class Method Summary collapse

Class Method Details

.any_env_eq?(keys, value) ⇒ Boolean

Returns true when at least one of the named vars equals ‘value`.

Parameters:

  • keys (Array<String>) —

    env var names to inspect.

  • value (String) —

    expected exact value.

Returns:

  • (Boolean) —

    true when at least one of the named vars equals ‘value`.



80
81
82
 
# File 'lib/better_auth/telemetry/detectors/environment.rb', line 80

def any_env_eq?(keys, value)
  keys.any? { |k| ENV[k] == value }
end

.call ⇒ String

Returns one of ‘“production”`, `“ci”`, `“test”`, or `“development”`.

Returns:

  • (String) —

    one of ‘“production”`, `“ci”`, `“test”`, or `“development”`.



55
56
57
58
59
60
61
 
# File 'lib/better_auth/telemetry/detectors/environment.rb', line 55

def call
  return "production" if any_env_eq?(TEST_VARS, "production")
  return "ci" if ci?
  return "test" if any_env_eq?(TEST_VARS, "test")

  "development"
end

.ci? ⇒ Boolean

Returns true when at least one CI marker variable has a non-empty value that is not (case-insensitive) ‘“false”`.

Returns:

  • (Boolean) —

    true when at least one CI marker variable has a non-empty value that is not (case-insensitive) ‘“false”`.



66
67
68
69
70
71
72
73
74
 
# File 'lib/better_auth/telemetry/detectors/environment.rb', line 66

def ci?
  CI_VARS.any? do |key|
    value = ENV[key]
    next false if value.nil? || value.empty?
    next false if value.casecmp("false").zero?

    true
  end
end