elasticgraph-graphql 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/lib/elastic_graph/graphql/config.rb +125 -39
  3. data/lib/elastic_graph/graphql.rb +1 -1
  4. metadata +18 -18
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 292dd7f883e879246db01931fce87901d6aaca61601e3f7dce9f55d260a79d57
4
- data.tar.gz: 1c279ea0afb9ba322edf21e9ca0d145863da3858c9174c37cf27dc2726afbabe
3
+ metadata.gz: bc665f641870a1f2cc3c76587de1ab30de92150f4e4f0992dbb62677becdf7cb
4
+ data.tar.gz: ce6326b9bf846cdafa2f86b61149f820da3be2f19e84e5d2366db93f0d334570
5
5
  SHA512:
6
- metadata.gz: 338b16f44b60f735165d3e159512b65fe54474b1562f6a51da0a5c583838b635c2d2f5ad2d4e5d99a96296c42aa53cb3aecdcddb3a440f4935e2fc467c59f5af
7
- data.tar.gz: 85a4a05c596ef358b9c28d3faa0f0467508c44c6e813e92ba5fa36997220d509e577e4666c6a29dac83bd877df22670092e8b922e5264a538eb1c5330ea576ec
6
+ metadata.gz: 72fb2fd0bacc529b2befe78f503da293c9279a33bc7605905c1bf6ba12e332bd7f94fccafedd07a55092ed3069f0e690965f3a0471896aeeb7e464d993a92a7c
7
+ data.tar.gz: 8cf3ca4740cfca36b66ba59a8fcd7c4b254cd4895b3765b9204c25a94bd45f70fa9f8ee38b5fbe8475a366c9077800876b5c03d45571017d070999f402269ef2
data/lib/elastic_graph/graphql/config.rb CHANGED
@@ -6,65 +6,139 @@
6
6
  #
7
7
  # frozen_string_literal: true
8
8
 
9
+ require "elastic_graph/support/config"
9
10
  require "elastic_graph/errors"
10
11
  require "elastic_graph/graphql/client"
11
12
  require "elastic_graph/schema_artifacts/runtime_metadata/extension_loader"
12
13
 
13
14
  module ElasticGraph
14
15
  class GraphQL
15
- class Config < Data.define(
16
- # Determines the size of our datastore search requests if the query does not specify.
16
+ class Config < Support::Config.define(
17
17
  :default_page_size,
18
- # Determines the maximum size of a requested page. If the client requests a page larger
19
- # than this value, `max_page_size` elements will be returned instead.
20
18
  :max_page_size,
21
- # Queries that take longer than this configured threshold will have a sanitized version logged.
22
19
  :slow_query_latency_warning_threshold_in_ms,
23
- # Object used to identify the client of a GraphQL query based on the HTTP request.
24
20
  :client_resolver,
25
- # Array of modules that will be extended onto the `GraphQL` instance to support extension libraries.
26
21
  :extension_modules,
27
- # Contains any additional settings that were in the settings file beyond settings that are expected as part of ElasticGraph
28
- # itself. Extensions are free to use these extra settings.
29
22
  :extension_settings
30
23
  )
31
- def self.from_parsed_yaml(entire_parsed_yaml)
32
- parsed_yaml = entire_parsed_yaml.fetch("graphql")
33
- extra_keys = parsed_yaml.keys - EXPECTED_KEYS
24
+ all_json_schema_types = ["array", "string", "number", "boolean", "object", "null"]
34
25
 
35
- unless extra_keys.empty?
36
- raise Errors::ConfigError, "Unknown `graphql` config settings: #{extra_keys.join(", ")}"
37
- end
26
+ json_schema at: "graphql",
27
+ optional: false,
28
+ description: "Configuration for GraphQL behavior used by `elasticgraph-graphql`.",
29
+ properties: {
30
+ default_page_size: {
31
+ description: "Determines the `size` of our datastore search requests if the query does not specify via `first` or `last`.",
32
+ type: "integer",
33
+ minimum: 1,
34
+ default: 50,
35
+ examples: [25, 50, 100]
36
+ },
37
+ max_page_size: {
38
+ description: "Determines the maximum size of a requested page. If the client requests a page larger " \
39
+ "than this value, the `size` will be capped by this value.",
40
+ type: "integer",
41
+ minimum: 1,
42
+ default: 500,
43
+ examples: [100, 500, 1000]
44
+ },
45
+ slow_query_latency_warning_threshold_in_ms: {
46
+ description: "Queries that take longer than this configured threshold will have a sanitized version logged so that they can be investigated.",
47
+ type: "integer",
48
+ minimum: 0,
49
+ default: 5000,
50
+ examples: [3000, 5000, 10000]
51
+ },
52
+ client_resolver: {
53
+ description: "Object used to identify the client of a GraphQL query based on the HTTP request.",
54
+ type: "object",
55
+ properties: {
56
+ name: {
57
+ description: "Name of the client resolver class.",
58
+ type: ["string", "null"],
59
+ minLength: 1,
60
+ default: nil,
61
+ examples: [nil, "MyCompany::ElasticGraphClientResolver"]
62
+ },
63
+ require_path: {
64
+ description: "The path to require to load the client resolver class.",
65
+ type: ["string", "null"],
66
+ minLength: 1,
67
+ default: nil,
68
+ examples: [nil, "./lib/my_company/elastic_graph/client_resolver"]
69
+ }
70
+ },
71
+ patternProperties: {/.+/.source => {type: all_json_schema_types}},
72
+ default: {}, # : untyped
73
+ examples: [
74
+ {}, # : untyped
75
+ {
76
+ "name" => "ElasticGraph::GraphQL::ClientResolvers::ViaHTTPHeader",
77
+ "require_path" => "support/client_resolvers",
78
+ "header_name" => "X-Client-Name"
79
+ }
80
+ ]
81
+ },
82
+ extension_modules: {
83
+ description: "Array of modules that will be extended onto the `GraphQL` instance to support extension libraries.",
84
+ type: "array",
85
+ items: {
86
+ type: "object",
87
+ properties: {
88
+ name: {
89
+ type: "string",
90
+ minLength: 1,
91
+ description: "The name of the extension module class to load.",
92
+ examples: ["MyExtensionModule", "ElasticGraph::MyExtension"]
93
+ },
94
+ require_path: {
95
+ type: "string",
96
+ minLength: 1,
97
+ description: "The path to require to load the extension module.",
98
+ examples: ["./my_extension_module", "elastic_graph/my_extension"]
99
+ }
100
+ },
101
+ required: ["name", "require_path"]
102
+ },
103
+ default: [], # : untyped
104
+ examples: [
105
+ [], # : untyped
106
+ [
107
+ {
108
+ "name" => "MyExtensionModule",
109
+ "require_path" => "./my_extension_module"
110
+ }
111
+ ]
112
+ ]
113
+ }
114
+ }
38
115
 
39
- extension_loader = SchemaArtifacts::RuntimeMetadata::ExtensionLoader.new(::Module.new)
40
- extension_mods = parsed_yaml.fetch("extension_modules", []).map do |mod_hash|
41
- extension_loader.load(mod_hash.fetch("name"), from: mod_hash.fetch("require_path"), config: {}).extension_class.tap do |mod|
42
- unless mod.instance_of?(::Module)
43
- raise Errors::ConfigError, "`#{mod_hash.fetch("name")}` is not a module, but all application extension modules must be modules."
44
- end
45
- end
46
- end
116
+ # The standard ElasticGraph root config setting keys; anything else is assumed to be extension settings.
117
+ ELASTICGRAPH_CONFIG_KEYS = %w[graphql indexer logger datastore schema_artifacts]
47
118
 
48
- new(
49
- default_page_size: parsed_yaml.fetch("default_page_size"),
50
- max_page_size: parsed_yaml.fetch("max_page_size"),
51
- slow_query_latency_warning_threshold_in_ms: parsed_yaml["slow_query_latency_warning_threshold_in_ms"] || 5000,
52
- client_resolver: load_client_resolver(parsed_yaml),
53
- extension_modules: extension_mods,
54
- extension_settings: entire_parsed_yaml.except(*ELASTICGRAPH_CONFIG_KEYS)
55
- )
119
+ def self.from_parsed_yaml(parsed_yaml)
120
+ original = super(parsed_yaml)
121
+ return nil if original.nil?
122
+
123
+ extension_settings = original.extension_settings.merge(parsed_yaml.except(*ELASTICGRAPH_CONFIG_KEYS))
124
+ original.with(extension_settings: extension_settings)
56
125
  end
57
126
 
58
- # The keys we expect under `graphql`.
59
- EXPECTED_KEYS = members.map(&:to_s)
127
+ private
60
128
 
61
- # The standard ElasticGraph root config setting keys; anything else is assumed to be extension settings.
62
- ELASTICGRAPH_CONFIG_KEYS = %w[graphql indexer logger datastore schema_artifacts]
129
+ def convert_values(client_resolver:, extension_modules:, **values)
130
+ client_resolver = load_client_resolver(client_resolver)
131
+ extension_modules = load_extension_modules(extension_modules)
63
132
 
64
- private_class_method def self.load_client_resolver(parsed_yaml)
65
- config = parsed_yaml.fetch("client_resolver") do
66
- return Client::DefaultResolver.new({})
67
- end
133
+ values.merge({
134
+ client_resolver: client_resolver,
135
+ extension_modules: extension_modules,
136
+ extension_settings: {} # : parsedYamlSettings
137
+ })
138
+ end
139
+
140
+ def load_client_resolver(config)
141
+ return Client::DefaultResolver.new({}) if config.empty?
68
142
 
69
143
  client_resolver_loader = SchemaArtifacts::RuntimeMetadata::ExtensionLoader.new(Client::DefaultResolver)
70
144
  extension = client_resolver_loader.load(
@@ -76,6 +150,18 @@ module ElasticGraph
76
150
 
77
151
  __skip__ = extension_class.new(extension.config)
78
152
  end
153
+
154
+ def load_extension_modules(extension_module_hashes)
155
+ extension_loader = SchemaArtifacts::RuntimeMetadata::ExtensionLoader.new(::Module.new)
156
+
157
+ extension_module_hashes.map do |mod_hash|
158
+ extension_loader.load(mod_hash.fetch("name"), from: mod_hash.fetch("require_path"), config: {}).extension_class.tap do |mod|
159
+ unless mod.instance_of?(::Module)
160
+ raise Errors::ConfigError, "`#{mod_hash.fetch("name")}` is not a module, but all application extension modules must be modules."
161
+ end
162
+ end
163
+ end
164
+ end
79
165
  end
80
166
  end
81
167
  end
data/lib/elastic_graph/graphql.rb CHANGED
@@ -26,7 +26,7 @@ module ElasticGraph
26
26
  # `from_yaml_file(file_name, &block)` is also available (via `Support::FromYamlFile`).
27
27
  def self.from_parsed_yaml(parsed_yaml, &datastore_client_customization_block)
28
28
  new(
29
- config: GraphQL::Config.from_parsed_yaml(parsed_yaml),
29
+ config: GraphQL::Config.from_parsed_yaml(parsed_yaml) || GraphQL::Config.new,
30
30
  datastore_core: DatastoreCore.from_parsed_yaml(parsed_yaml, &datastore_client_customization_block)
31
31
  )
32
32
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: elasticgraph-graphql
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Myron Marston
@@ -31,28 +31,28 @@ dependencies:
31
31
  requirements:
32
32
  - - '='
33
33
  - !ruby/object:Gem::Version
34
- version: 1.0.0
34
+ version: 1.0.1
35
35
  type: :runtime
36
36
  prerelease: false
37
37
  version_requirements: !ruby/object:Gem::Requirement
38
38
  requirements:
39
39
  - - '='
40
40
  - !ruby/object:Gem::Version
41
- version: 1.0.0
41
+ version: 1.0.1
42
42
  - !ruby/object:Gem::Dependency
43
43
  name: elasticgraph-schema_artifacts
44
44
  requirement: !ruby/object:Gem::Requirement
45
45
  requirements:
46
46
  - - '='
47
47
  - !ruby/object:Gem::Version
48
- version: 1.0.0
48
+ version: 1.0.1
49
49
  type: :runtime
50
50
  prerelease: false
51
51
  version_requirements: !ruby/object:Gem::Requirement
52
52
  requirements:
53
53
  - - '='
54
54
  - !ruby/object:Gem::Version
55
- version: 1.0.0
55
+ version: 1.0.1
56
56
  - !ruby/object:Gem::Dependency
57
57
  name: graphql
58
58
  requirement: !ruby/object:Gem::Requirement
@@ -93,70 +93,70 @@ dependencies:
93
93
  requirements:
94
94
  - - '='
95
95
  - !ruby/object:Gem::Version
96
- version: 1.0.0
96
+ version: 1.0.1
97
97
  type: :development
98
98
  prerelease: false
99
99
  version_requirements: !ruby/object:Gem::Requirement
100
100
  requirements:
101
101
  - - '='
102
102
  - !ruby/object:Gem::Version
103
- version: 1.0.0
103
+ version: 1.0.1
104
104
  - !ruby/object:Gem::Dependency
105
105
  name: elasticgraph-elasticsearch
106
106
  requirement: !ruby/object:Gem::Requirement
107
107
  requirements:
108
108
  - - '='
109
109
  - !ruby/object:Gem::Version
110
- version: 1.0.0
110
+ version: 1.0.1
111
111
  type: :development
112
112
  prerelease: false
113
113
  version_requirements: !ruby/object:Gem::Requirement
114
114
  requirements:
115
115
  - - '='
116
116
  - !ruby/object:Gem::Version
117
- version: 1.0.0
117
+ version: 1.0.1
118
118
  - !ruby/object:Gem::Dependency
119
119
  name: elasticgraph-opensearch
120
120
  requirement: !ruby/object:Gem::Requirement
121
121
  requirements:
122
122
  - - '='
123
123
  - !ruby/object:Gem::Version
124
- version: 1.0.0
124
+ version: 1.0.1
125
125
  type: :development
126
126
  prerelease: false
127
127
  version_requirements: !ruby/object:Gem::Requirement
128
128
  requirements:
129
129
  - - '='
130
130
  - !ruby/object:Gem::Version
131
- version: 1.0.0
131
+ version: 1.0.1
132
132
  - !ruby/object:Gem::Dependency
133
133
  name: elasticgraph-indexer
134
134
  requirement: !ruby/object:Gem::Requirement
135
135
  requirements:
136
136
  - - '='
137
137
  - !ruby/object:Gem::Version
138
- version: 1.0.0
138
+ version: 1.0.1
139
139
  type: :development
140
140
  prerelease: false
141
141
  version_requirements: !ruby/object:Gem::Requirement
142
142
  requirements:
143
143
  - - '='
144
144
  - !ruby/object:Gem::Version
145
- version: 1.0.0
145
+ version: 1.0.1
146
146
  - !ruby/object:Gem::Dependency
147
147
  name: elasticgraph-schema_definition
148
148
  requirement: !ruby/object:Gem::Requirement
149
149
  requirements:
150
150
  - - '='
151
151
  - !ruby/object:Gem::Version
152
- version: 1.0.0
152
+ version: 1.0.1
153
153
  type: :development
154
154
  prerelease: false
155
155
  version_requirements: !ruby/object:Gem::Requirement
156
156
  requirements:
157
157
  - - '='
158
158
  - !ruby/object:Gem::Version
159
- version: 1.0.0
159
+ version: 1.0.1
160
160
  email:
161
161
  - myron@squareup.com
162
162
  executables: []
@@ -247,10 +247,10 @@ licenses:
247
247
  - MIT
248
248
  metadata:
249
249
  bug_tracker_uri: https://github.com/block/elasticgraph/issues
250
- changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.0
251
- documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.0/
250
+ changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.1
251
+ documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.1/
252
252
  homepage_uri: https://block.github.io/elasticgraph/
253
- source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.0/elasticgraph-graphql
253
+ source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.1/elasticgraph-graphql
254
254
  gem_category: core
255
255
  rdoc_options: []
256
256
  require_paths: