Module: Exercism

Defined in:
lib/exercism.rb,
lib/exercism/config.rb,
lib/exercism/secrets.rb,
lib/exercism/redis_pool.rb,
lib/exercism/tooling_job.rb

Defined Under Namespace

Modules: RedisPool Classes: Config, ConfigError, Secrets, ToolingJob

Constant Summary collapse

S3_CLIENT_MUTEX =
Mutex.new

Class Method Summary collapse

Class Method Details

.cloudfront_clientObject



66
67
68
69
# File 'lib/exercism.rb', line 66

def self.cloudfront_client
  require 'aws-sdk-cloudfront'
  Aws::CloudFront::Client.new(ExercismConfig::GenerateAwsSettings.())
end

.cloudwatch_logs_clientObject



61
62
63
64
# File 'lib/exercism.rb', line 61

def self.cloudwatch_logs_client
  require 'aws-sdk-cloudwatchlogs'
  Aws::CloudWatchLogs::Client.new(ExercismConfig::GenerateAwsSettings.())
end

.configObject



8
9
10
# File 'lib/exercism.rb', line 8

def self.config
  @config ||= ExercismConfig::RetrieveConfig.()
end

.discourse_clientObject



119
120
121
122
123
124
125
126
# File 'lib/exercism.rb', line 119

def self.discourse_client
  require 'discourse_api'

  DiscourseApi::Client.new("https://forum.exercism.org").tap do |client|
    client.api_key = ENV.fetch("DISCOURSE_API_KEY", Exercism.secrets.discourse_api_key)
    client.api_username = ENV.fetch("DISCOURSE_API_USERNAME", "system")
  end
end

.dynamodb_clientObject



32
33
34
# File 'lib/exercism.rb', line 32

def self.dynamodb_client
  Aws::DynamoDB::Client.new(ExercismConfig::GenerateAwsSettings.())
end

.ecr_clientObject



56
57
58
59
# File 'lib/exercism.rb', line 56

def self.ecr_client
  require 'aws-sdk-ecr'
  Aws::ECR::Client.new(ExercismConfig::GenerateAwsSettings.())
end

.envObject



4
5
6
# File 'lib/exercism.rb', line 4

def self.env
  @env ||= ExercismConfig::DetermineEnvironment.()
end

.mongodb_clientObject



128
129
130
131
132
133
134
# File 'lib/exercism.rb', line 128

def self.mongodb_client
  require 'mongo'
  Mongo::Client.new(
    self.config.mongodb_url,
    database: self.config.mongodb_database_name
  )
end

.octokit_clientObject



76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/exercism.rb', line 76

def self.octokit_client
  require 'octokit'

  access_token = ENV.fetch(
    "GITHUB_ACCESS_TOKEN",
    self.secrets.github_access_token
  )

  @octokit_client ||= Octokit::Client.new(access_token:).tap do |c|
    c.auto_paginate = true
  end
end

.octokit_graphql_clientObject



89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/exercism.rb', line 89

def self.octokit_graphql_client
  require 'octokit'

  access_token = ENV.fetch(
    "GITHUB_GRAPHQL_READONLY_ACCESS_TOKEN",
    self.secrets.github_graphql_readonly_access_token
  )

  @octokit_graphql_client ||= Octokit::Client.new(access_token:).tap do |c|
    c.auto_paginate = true
  end
end

.openai_clientObject



136
137
138
139
140
# File 'lib/exercism.rb', line 136

def self.openai_client
  require 'openai'

  @openai_client ||= OpenAI::Client.new(access_token: self.secrets.openai_api_key)
end

.opensearch_clientObject



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/exercism.rb', line 102

def self.opensearch_client
  require 'opensearch'

  # For now, we're using the ElasticSearch client, but this needs to be
  # changed to the OpenSearch client once it becomes available
  OpenSearch::Client.new(
    host: ENV.fetch("OPENSEARCH_HOST", config.opensearch_host),
    user: ENV.fetch("OPENSEARCH_USER", Exercism.env.production? ? nil : "admin"),
    password: ENV.fetch("OPENSEARCH_PASSWORD", Exercism.env.production? ? nil : "admin"),
    transport_options: {
      ssl: {
        verify: Exercism.env.production?
      }
    }
  )
end

.redis_cache_clientObject



19
# File 'lib/exercism.rb', line 19

def self.redis_cache_client = RedisPool.for(:cache) { redis_client(config.cache_redis_url) }

.redis_client(url) ⇒ Object



21
22
23
24
25
26
27
28
29
30
# File 'lib/exercism.rb', line 21

def self.redis_client(url)
  require 'redis'
  require 'redis-clustering'

  if Exercism.env.development? || Exercism.env.test?
    Redis.new(url:)
  else
    Redis::Cluster.new(nodes: [url])
  end
end

.redis_git_cache_clientObject



18
# File 'lib/exercism.rb', line 18

def self.redis_git_cache_client = RedisPool.for(:git_cache) { redis_client(config.git_cache_redis_url) }

.redis_tooling_clientObject

Pooled rather than built per call - see Exercism::RedisPool for why.



17
# File 'lib/exercism.rb', line 17

def self.redis_tooling_client = RedisPool.for(:tooling) { redis_client(config.tooling_redis_url) }

.s3_clientObject

Memoized so the SDK's connection pool is reused, with a raised http_idle_timeout (default 5s) so pooled connections survive quiet spells on low-QPS paths instead of paying a TLS handshake each time. The mutex guarantees exactly one client per process.



42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/exercism.rb', line 42

def self.s3_client
  S3_CLIENT_MUTEX.synchronize do
    @s3_client ||= begin
      require 'aws-sdk-s3'
      Aws::S3::Client.new(
        ExercismConfig::GenerateAwsSettings.().merge(
          force_path_style: true,
          http_idle_timeout: 60
        )
      )
    end
  end
end

.secretsObject



12
13
14
# File 'lib/exercism.rb', line 12

def self.secrets
  @secrets ||= ExercismConfig::RetrieveSecrets.()
end

.ses_clientObject



71
72
73
74
# File 'lib/exercism.rb', line 71

def self.ses_client
  require 'aws-sdk-sesv2'
  Aws::SESV2::Client.new(ExercismConfig::GenerateAwsSettings.())
end