graph_weaver 0.7.0 → 0.7.2

data/lib/graph_weaver/transport.rb

@@ -96,7 +96,8 @@ class GraphWeaver::Transport
   # a raw query string falls back to the name in the document itself.
   def execute(query, variables: {}, operation_name: nil)
     operation_name ||= GraphWeaver::Internal::Wire.operation_name(query)
-    payload = { url: safe_url, operation: operation_name, client: self.class }
+    payload = { url: safe_url, operation: operation_name, client: self.class,
+                kind: GraphWeaver::Internal::Wire.kind(query) }
 
     GraphWeaver::Internal::Log.instrument(GraphWeaver::EXECUTE_EVENT, payload) do
       perform(query, variables, operation_name, payload)
@@ -132,12 +133,24 @@ class GraphWeaver::Transport
         post(encoded)
       end
     rescue *GraphWeaver.transport_errors.to_a => e
-      # never got a response — DNS, connection refused/reset, TLS, timeout
-      raise GraphWeaver::TransportError.new("#{e.class}: #{e.message}", url: safe_url)
+      # never got a response — DNS, connection refused/reset, TLS, timeout.
+      # The adapter's sentence is its own words, capped like any text we
+      # didn't author.
+      raise GraphWeaver::TransportError.new(
+        "#{e.class}: #{GraphWeaver::Internal::Redact.cap(e.message)}", url: safe_url,
+      )
     end
 
     payload[:http_status] = status
-    GraphWeaver::Internal::Log.log(:debug) { "HTTP #{status} #{tag} from #{safe_url} (#{body.to_s.bytesize} bytes)" }
+    # folded once: a third-party subclass's headers may come back in any
+    # casing, and a subclass that returns none says nothing
+    fields = GraphWeaver::Internal::Headers.wrap(headers || {})
+    # the content type, not the body: it is what tells a proxy's HTML page
+    # from a router's JSON without quoting bytes a server chose
+    GraphWeaver::Internal::Log.log(:debug) do
+      type = GraphWeaver::Internal::Redact.tag(fields["content-type"])
+      "HTTP #{status} #{tag} from #{safe_url} (#{body.to_s.bytesize} bytes#{", #{type}" if type})"
+    end
 
     parsed = parse_body(body)
 
@@ -151,42 +164,54 @@ class GraphWeaver::Transport
       # `"errors": null` (or []) isn't a structured error response, so the
       # status stays the signal
       if parsed.is_a?(Hash) && parsed["errors"].is_a?(Array) && parsed["errors"].any?
-        return Envelope.new(parsed, status)
+        return Envelope.new(parsed, status, fields.retry_after)
       end
 
-      raise GraphWeaver::ServerError.new(status:, body: body.to_s, headers: headers || {}, url: safe_url)
+      refuse!(status, body, headers)
     end
 
     unless parsed.is_a?(Hash)
       # a 200 that isn't a GraphQL object — an HTML error page from a proxy, a
       # captive portal, or a bare JSON array/string: the server misbehaved.
-      # An empty body says so rather than trailing off after the colon, and a
-      # well-formed @defer stream is named rather than dumped: it isn't
+      # A well-formed @defer stream is named rather than lumped in: it isn't
       # non-GraphQL, it's more than one GraphQL document.
-      quoted =
-        if incremental?(headers)
+      detail =
+        if incremental?(fields)
           "this response is incremental delivery (@defer/@stream), which this client doesn't read"
         elsif body.to_s.empty?
           "empty response body"
         else
-          "non-GraphQL response: #{body.to_s[0, 500]}"
+          "non-GraphQL response"
         end
-      raise GraphWeaver::ServerError.new(status:, body: quoted, headers: headers || {}, url: safe_url)
+      refuse!(status, body, headers, detail:)
     end
 
-    Envelope.new(parsed, status)
+    Envelope.new(parsed, status, fields.retry_after)
+  end
+
+  # The response wasn't one we can read. A body is never quoted — not into the
+  # message, not into a log line: it is text a server chose, and an error page
+  # that echoes the request fills it with the variables and the Authorization
+  # header we just sent. `detail` is what WE say went wrong; the bytes are on
+  # ServerError#body for whoever rescues it.
+  private def refuse!(status, body, headers, detail: nil)
+    raise GraphWeaver::ServerError.new(status:, body: body.to_s, headers: headers || {}, url: safe_url, detail:)
   end
 
-  # The parsed envelope, plus the HTTP status it came back on — a Hash to
-  # everything that reads a GraphQL response, and to the one caller that
-  # needs more. Retry asks: a router answers rate limiting with a 503 AND
-  # an errors body, so the body alone can't say whether to come back.
+  # The parsed envelope, plus what the HTTP response said around it — a Hash
+  # to everything that reads a GraphQL response, and more to the one caller
+  # that needs it. Retry asks both: a router answers rate limiting with a 503
+  # or 429 AND an errors body, so the body alone can't say whether to come
+  # back, and Retry-After says when. The seconds, not the headers — that is
+  # the whole of what Retry asks, and every other header stays where a
+  # ServerError already carries it.
   class Envelope < Hash
-    attr_reader :http_status
+    attr_reader :http_status, :retry_after
 
-    def initialize(parsed, http_status)
+    def initialize(parsed, http_status, retry_after = nil)
       super()
       @http_status = http_status
+      @retry_after = retry_after
       update(parsed)
     end
   end
@@ -201,10 +226,9 @@ class GraphWeaver::Transport
   private_constant :BOM
 
   # A multipart/mixed body is one @defer/@stream response arriving in
-  # installments. Folded here because a third-party subclass's headers may
-  # come back in any casing; a subclass that returns none says nothing.
-  private def incremental?(headers)
-    GraphWeaver::Internal::Headers.wrap(headers || {})["content-type"].to_s.start_with?("multipart/mixed")
+  # installments.
+  private def incremental?(fields)
+    fields["content-type"].to_s.start_with?("multipart/mixed")
   end
 
   # the parsed body, or nil when it isn't JSON (a caller's connection may

data/lib/graph_weaver/version.rb

@@ -1,3 +1,3 @@
 module GraphWeaver
-  VERSION = "0.7.0"
+  VERSION = "0.7.2"
 end

data/lib/graph_weaver.rb

@@ -65,8 +65,8 @@ module GraphWeaver
     #
     # Anything satisfying the execute contract — a Client, a schema class,
     # a transport, a fake (testing's graphql: tag swaps one in per
-    # example). Generated modules resolve per call -> per module
-    # (MyQuery.client=) -> baked constant -> here.
+    # example). Generated modules resolve per call -> a test mode's stand-in
+    # -> the client their graph names -> here.
     attr_accessor :client
 
     # the default client, when one is required
@@ -389,7 +389,7 @@ module GraphWeaver
     # (see #changed_files). Generated files the plan no longer produces are deleted
     # (see #orphaned), so renaming or dropping a .graphql leaves nothing
     # behind. Pair with a freshness spec (docs/generated_modules.md).
-    def generate!(schema: nil, queries: nil, output: nil, client: nil, types_module: nil)
+    def generate!(schema: nil, queries: nil, output: nil, types_module: nil)
       @changed_files = []
       @unmatched_registrations = []
       @untyped_scalars_by_graph = {}
@@ -399,7 +399,7 @@ module GraphWeaver
       # tree exactly as it was — the railtie's watch mode regenerates on a
       # request and promises a failed save changes nothing, and that promise
       # was true within a graph and false across them.
-      planned = graphs_for(schema:, queries:, output:, client:, types_module:).map do |graph|
+      planned = graphs_for(schema:, queries:, output:, types_module:).map do |graph|
         if Internal::Util.query_files(graph.queries).empty?
           # a brand-new app legitimately has none; a mistyped queries_paths looks
           # exactly the same, and prints nothing either way
@@ -488,11 +488,11 @@ module GraphWeaver
     #      it "generated queries are current" do
     #        GraphWeaver.verify_generated!
     #      end
-    def verify_generated!(schema: nil, queries: nil, output: nil, client: nil, types_module: nil)
+    def verify_generated!(schema: nil, queries: nil, output: nil, types_module: nil)
       @unmatched_registrations = []
       @untyped_scalars_by_graph = {}
       seen = new_seen
-      graphs = graphs_for(schema:, queries:, output:, client:, types_module:)
+      graphs = graphs_for(schema:, queries:, output:, types_module:)
 
       # The dump is checked in too, and everything below reads it — so a
       # stale one is answered before staleness downstream of it, because
@@ -849,7 +849,9 @@ module GraphWeaver
       used_unions = []
       shared = Codegen.load_fragments(fragments)
 
-      plan = Internal::Util.query_files(graph.queries).map do |path|
+      refusals = []
+      paths = Internal::Util.query_files(graph.queries)
+      plan = paths.filter_map do |path|
         source = File.read(path)
         name, filename = graph.generated_names(path, source)
         refuse_duplicate!(seen, name, filename, graph, path)
@@ -858,7 +860,6 @@ module GraphWeaver
           schema:,
           query: Codegen.inline_fragments(source, shared, path),
           name:,
-          client: graph.client,
           graph_name: graph.name,
           types_namespace: graph.types_module,
           hoistable_unions: Codegen.shared_fragment_spreads(source, shared, path),
@@ -870,7 +871,13 @@ module GraphWeaver
         found.concat(codegen.untyped_scalars).uniq!
         used_unions |= codegen.used_union_names
         [filename, out]
+      rescue GraphWeaver::Error => e
+        # collected, not raised: nothing is written either way, and an adopter
+        # aiming generate! at an existing query directory wants the list
+        refusals << e
+        nil
       end
+      refuse_all!(refusals, paths.size)
 
       if used_unions.any? || used.values.any?(&:any?)
         refuse_duplicate_types!(seen, graph)
@@ -890,6 +897,19 @@ module GraphWeaver
     end
     private :generation_plan
 
+    # Every query that refused, in one error. One refusal is re-raised as
+    # itself, so a single bad file reads exactly as it always has — class,
+    # message and all; several become one list, because clearing them a file
+    # per run is the slowest way there is to adopt this.
+    def refuse_all!(refusals, considered)
+      return if refusals.empty?
+      raise refusals.first if refusals.one?
+
+      raise GraphWeaver::Error, "#{refusals.size} of #{considered} queries refused:\n" +
+        refusals.map { |refusal| refusal.message.gsub(/^/, "  ") }.join("\n")
+    end
+    private :refuse_all!
+
     # Two query files landing on one constant, or on one output file. Within a
     # graph the fix is a rename, as it has always been; across two graphs it is
     # `namespace:` for the constant and `output:` for the file — so the message
@@ -1061,8 +1081,10 @@ module GraphWeaver
     # name derived from the file name and the operation — see #module_name) or
     # a raw query string (name derived from the operation name, falling back to
     # "Query" for anonymous operations — collisions are impossible since each
-    # parse gets its own container). Pass name: to override, client: to bake
-    # the module's default client/transport.
+    # parse gets its own container). Pass name: to override, client: to say
+    # what the module runs against — a parsed module generates no file, so it
+    # has no graph to read one off, and this is the only time one is bound
+    # (a per-call `client:` still wins).
     #
     # graph: names the graph this module belongs to, which is what a test mode
     # runs it against in an app with more than one — the same thing generation

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graph_weaver
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.2
 platform: ruby
 authors:
 - Daniel Pepper
@@ -268,7 +268,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".yardopts"
-- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -287,6 +286,19 @@ files:
 - docs/testing.md
 - docs/transports.md
 - docs/upgrading.md
+- examples/README.md
+- examples/countries.rb
+- examples/federation.rb
+- examples/github/generate.rb
+- examples/github/generated/star_mutation.rb
+- examples/github/generated/stargazers_query.rb
+- examples/github/generated/starred_query.rb
+- examples/github/queries/star.graphql
+- examples/github/queries/stargazers.graphql
+- examples/github/queries/starred.graphql
+- examples/github/run.rb
+- examples/github/setup.rb
+- examples/rick_and_morty.rb
 - graph_weaver.gemspec
 - lib/generators/graph_weaver/install_generator.rb
 - lib/graph_weaver.rb
@@ -300,6 +312,7 @@ files:
 - lib/graph_weaver/codegen/scalar_type.rb
 - lib/graph_weaver/codegen/type_helpers.rb
 - lib/graph_weaver/coerce.rb
+- lib/graph_weaver/context_seam.rb
 - lib/graph_weaver/errors.rb
 - lib/graph_weaver/federation.rb
 - lib/graph_weaver/graph.rb
@@ -350,7 +363,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/dpep/graph_weaver/issues
-  changelog_uri: https://github.com/dpep/graph_weaver/blob/main/CHANGELOG.md
+  changelog_uri: https://github.com/dpep/graph_weaver/blob/v0.7.2/CHANGELOG.md
   documentation_uri: https://github.com/dpep/graph_weaver/tree/main/docs
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/dpep/graph_weaver