tungsten-runtime 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7c60518f52962a9bcf62ad89dd0be554d64d52e768ff886a19946851a7193c50
+  data.tar.gz: 5bec47c402cb907e48047375a8b69d0d976b406a80658169c676b705719fff58
+SHA512:
+  metadata.gz: 9ffb9d1e620fe26036fc6374c3688540645311bc7c9bbaa4a1a18609001d8ac15e1bd25592d9789c8fec49d08fcc4f764f01db50eab709cb955d31a3aa7c0372
+  data.tar.gz: 2600a2effe2c9e7a1595e563ff4009bdccf7f8e279b2ed7f6b4c38ec8d5dc582846487e755ab97266d032a463742f79b0714cd671a99ed16577090999cda7d81

data/LICENSE

@@ -0,0 +1,55 @@
+Apache License
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,23 @@
+# tungsten-runtime 0.1.2
+
+The runtime used by the Ruby SDKs generated by [tungsten](https://github.com/pboachie/tungsten).
+It provides pre-flight validation, authentication, idempotency, confirmation,
+retries, diagnostic error envelopes, previews, pagination, macros and server-sent event streams.
+
+Requires Ruby 3.3 or newer and the base64 gem (~> 0.2). Licensed under Apache-2.0.
+
+The implementation is unchanged from the released `v0.1.2` source. The gemspec
+sets this package version to 0.1.2; the stable internal runtime/header version
+remains 0.1.0.
+
+To pin the package with the released tungsten 0.1.2 compiler:
+
+```yaml
+targets:
+  ruby:
+    out: sdk-ruby
+    runtime: "= 0.1.2"
+```
+
+Omit `runtime_path` to resolve the gem through RubyGems. The compiler's default
+runtime requirement is `~> 0.1`.

data/lib/tungsten/runtime/auth.rb

@@ -0,0 +1,258 @@
+# frozen_string_literal: true
+# SPDX-License-Identifier: Apache-2.0
+
+module Tungsten
+  module Runtime
+    # Auth resolution: an operation's security is an OR of AND-sets of
+    # scheme names; the first alternative the configured credentials fully
+    # satisfy is applied. A composite profile satisfies the names in its
+    # `satisfies` list when every part it needs for this request is
+    # configured.
+    class ClientCore
+      # The headers, cookies and query parameters credentials add.
+      AuthPlan = Struct.new(:headers, :cookies, :query) do
+        def self.empty = new([], [], [])
+      end
+
+      # The plan, the secrets it carries, the authorization-code scheme whose
+      # stored token it sends, or the remediation of an AUTH_FAILED envelope.
+      AuthResult = Struct.new(:plan, :secrets, :oauth, :failed)
+
+      Satisfier = Struct.new(:kind, :name, :parts, :config, :mutation, :scheme, :secret, :client_id,
+                             :client_secret, :token_url, :scopes, keyword_init: true)
+
+      private
+
+      def safe_method?(method) = %w[GET HEAD OPTIONS TRACE].include?(method)
+
+      def composite_key(part)
+        case part["kind"]
+        when "cookie" then part["name"]
+        when "bearer" then "bearer"
+        else part["equals_cookie"] || part["from_config"] || part["name"]
+        end
+      end
+
+      def check_prefix(token, prefix, what)
+        return nil if prefix.nil? || prefix.empty? || token.start_with?(prefix)
+
+        "The #{what} credential must start with \"#{prefix}\"; check that the right kind of token is configured."
+      end
+
+      def skips?(part, mutation) = part["kind"] == "header" && part["mutation_only"] && !mutation
+
+      def credential(name)
+        value = @auth[name]
+        case value
+        when nil then UNSET
+        when Hash then value.to_h { |k, v| [k.to_s, v.nil? ? nil : v.to_s] }
+        else value.to_s
+        end
+      end
+
+      def part_of(parts, snake, camel) = parts.key?(snake) ? parts[snake] : parts[camel]
+
+      def try_composite(name, parts, cred, method)
+        return [nil, nil, ["auth.#{name} (an object for the composite profile #{name})"]] unless cred.is_a?(Hash)
+
+        mutation = !safe_method?(method)
+        missing = []
+        parts.each do |p|
+          next if skips?(p, mutation)
+
+          key = composite_key(p)
+          next unless cred[key].to_s.empty?
+
+          role =
+            case p["kind"]
+            when "cookie" then "cookie #{p['name']}"
+            when "bearer" then "bearer token"
+            else "header #{p['name']}#{p['equals_cookie'] ? " (equal to cookie #{p['equals_cookie']})" : ''}"
+            end
+          missing << "auth.#{name}[#{Util.js_string(key)}] (#{role} of the composite profile #{name})"
+        end
+        return [nil, nil, missing] unless missing.empty?
+
+        ["composite:#{name}", Satisfier.new(kind: :composite, name: name, parts: parts, config: cred, mutation: mutation), nil]
+      end
+
+      def try_direct(scheme, cred)
+        name = scheme["name"]
+        if scheme["kind"] == "oauth2" && cred.is_a?(Hash)
+          if part_of(cred, "flow", "flow") == "authorizationCode"
+            unless scheme["authorization_code"]
+              return [nil, nil, ["auth.#{name} (sets flow \"authorizationCode\", but the API descriptor has no authorizationCode flow for #{name})"]]
+            end
+            if part_of(cred, "client_id", "clientId").to_s.empty?
+              return [nil, nil, ["auth.#{name} (a client_id for the authorizationCode flow)"]]
+            end
+
+            return ["scheme:#{name}", Satisfier.new(kind: :oauth_code, name: name, client_secret: part_of(cred, "client_secret", "clientSecret").to_s), nil]
+          end
+          id = part_of(cred, "client_id", "clientId")
+          secret = part_of(cred, "client_secret", "clientSecret")
+          if !id.nil? && !secret.nil? && scheme["token_url"].is_a?(String) && !scheme["token_url"].empty?
+            return ["scheme:#{name}", Satisfier.new(kind: :oauth, name: name, token_url: scheme["token_url"], scopes: scheme["scopes"] || [],
+                                                    client_id: id, client_secret: secret), nil]
+          end
+          code = scheme["authorization_code"] ? ", or {flow: \"authorizationCode\", client_id, client_secret?, redirect_uri?}" : ""
+          return [nil, nil, ["auth.#{name} (an access token, or {client_id, client_secret} for the token URL#{code})"]]
+        end
+        return ["scheme:#{name}", Satisfier.new(kind: :secret, scheme: scheme, secret: cred), nil] if cred.is_a?(String) && !cred.empty?
+
+        what =
+          case scheme["kind"]
+          when "http_basic" then "\"user:password\" for HTTP Basic scheme #{name}"
+          when "api_key" then "API key for scheme #{name} (#{scheme['in']} #{scheme['wire']})"
+          else "bearer token for scheme #{name}"
+          end
+        [nil, nil, ["auth.#{name} (#{what})"]]
+      end
+
+      def schemes = @api["auth"] || []
+
+      def try_scheme(name, method)
+        missing = []
+        schemes.each do |s|
+          next unless s["kind"] == "composite" && (s["satisfies"] || []).include?(name)
+
+          cred = credential(s["name"])
+          if UNSET.equal?(cred)
+            missing << "auth.#{s['name']} (composite profile #{s['name']})"
+            next
+          end
+          key, sat, more = try_composite(s["name"], s["parts"] || [], cred, method)
+          return [key, sat, nil] if sat
+
+          missing.concat(more)
+        end
+        direct = schemes.find { |s| s["name"] == name && s["kind"] != "composite" }
+        if direct
+          key, sat, more = try_direct(direct, credential(name))
+          return [key, sat, nil] if sat
+
+          missing.concat(more) if missing.empty?
+        elsif missing.empty?
+          missing << "a scheme named #{name} (the API descriptor does not define it)"
+        end
+        [nil, nil, missing]
+      end
+
+      def configured?(name)
+        return true if @auth.key?(name)
+
+        schemes.any? { |s| s["kind"] == "composite" && (s["satisfies"] || []).include?(name) && @auth.key?(s["name"]) }
+      end
+
+      def bearer(plan, token) = plan.headers << ["Authorization", "Bearer #{token}", true]
+
+      # Apply one satisfier; a remediation when it cannot be applied.
+      def apply(sat, result)
+        plan = result.plan
+        case sat.kind
+        when :composite
+          sat.parts.each do |p|
+            next if skips?(p, sat.mutation)
+
+            value = sat.config[composite_key(p)].to_s
+            case p["kind"]
+            when "cookie"
+              plan.cookies << [p["name"], value]
+              result.secrets << value
+            when "bearer"
+              problem = check_prefix(value, p["prefix"], "#{sat.name} bearer")
+              return problem if problem
+
+              bearer(plan, value)
+              result.secrets << value
+            else
+              secret = p["from_config"].nil?
+              plan.headers << [p["name"], value, secret]
+              result.secrets << value if secret
+            end
+          end
+        when :secret
+          scheme = sat.scheme
+          result.secrets << sat.secret
+          case scheme["kind"]
+          when "api_key"
+            case scheme["in"]
+            when "query" then plan.query << [scheme["wire"], sat.secret]
+            when "cookie" then plan.cookies << [scheme["wire"], sat.secret]
+            else plan.headers << [scheme["wire"], sat.secret, true]
+            end
+          when "http_bearer"
+            problem = check_prefix(sat.secret, scheme["prefix"], scheme["name"])
+            return problem if problem
+
+            bearer(plan, sat.secret)
+          when "http_basic"
+            encoded = Base64.strict_encode64(sat.secret)
+            result.secrets << encoded
+            plan.headers << ["Authorization", "Basic #{encoded}", true]
+          else bearer(plan, sat.secret)
+          end
+        when :oauth_code
+          result.secrets << sat.client_secret unless sat.client_secret.empty?
+          token, problem = stored_token(sat.name, false)
+          return problem if problem
+
+          result.secrets << token
+          bearer(plan, token)
+          result.oauth ||= sat.name
+        when :oauth
+          result.secrets << sat.client_secret
+          token, problem = client_credentials_token(sat)
+          return problem if problem
+
+          result.secrets << token
+          bearer(plan, token)
+        end
+        nil
+      end
+
+      # The credentials for an operation.
+      def resolve_auth(op, method)
+        empty = AuthResult.new(AuthPlan.empty, Util::Secrets.new, nil, nil)
+        return empty if op.security.empty?
+
+        best = nil
+        best_touched = false
+        ordered = op.security.reject(&:empty?) + op.security.select(&:empty?)
+        ordered.each do |alternative|
+          sats = []
+          missing = []
+          alternative.each do |name|
+            key, sat, more = try_scheme(name, method)
+            if sat.nil?
+              missing.concat(more)
+              next
+            end
+            existing = sats.find { |k, _| k == key }
+            existing ? existing[1] = sat : sats << [key, sat]
+          end
+          if missing.empty?
+            out = AuthResult.new(AuthPlan.empty, Util::Secrets.new, nil, nil)
+            sats.each do |_, sat|
+              problem = apply(sat, out)
+              return AuthResult.new(nil, nil, nil, "#{problem} Operation #{op.id} was not sent.") if problem
+            end
+            return out
+          end
+          unique = missing.uniq
+          touched = alternative.any? { |n| configured?(n) }
+          better = best.nil? || (touched && !best_touched) || (touched == best_touched && unique.length < best.length)
+          if better
+            best = unique
+            best_touched = touched
+          end
+        end
+        alternatives = op.security.map { |alt| alt.empty? ? "no credentials" : alt.join(" AND ") }
+        missing_text = best ? best.join("; ") : "credentials"
+        AuthResult.new(nil, nil, nil,
+                       "Operation #{op.id} needs #{alternatives.join(' OR ')}. Missing: #{missing_text}. " \
+                       "Configure it in ClientOptions.auth and call again; the request was not sent.")
+      end
+    end
+  end
+end

data/lib/tungsten/runtime/classify.rb

@@ -0,0 +1,248 @@
+# frozen_string_literal: true
+# SPDX-License-Identifier: Apache-2.0
+
+module Tungsten
+  module Runtime
+    # Decoding answers and classifying failures into the envelope.
+    module Classify
+      REQUEST_ID_HEADERS = %w[x-request-id request-id x-correlation-id x-amzn-requestid cf-ray].freeze
+      MESSAGE_FIELDS = %w[message error.message detail error_description title error].freeze
+
+      # A decoded body: `value` (parsed JSON, text, or a Binary; UNSET for an
+      # empty body), and what it was.
+      Decoded = Data.define(:value, :json, :invalid_json, :empty, :jsonl, :bad_line) do
+        def initialize(value:, json: false, invalid_json: false, empty: false, jsonl: false, bad_line: 0) = super
+        def present? = !UNSET.equal?(value)
+      end
+
+      # Everything one call's classification shares: the operation, its key
+      # and header, the attempts so far and how to check a lost mutation.
+      CallContext = Struct.new(:api, :op, :key, :key_header, :attempts, :check, keyword_init: true) do
+        def key? = !key.nil?
+      end
+
+      # How to find out whether an unprotected mutation took effect: the call
+      # to make and what to look for, in words.
+      OutcomeCheck = Data.define(:call, :shows)
+
+      module_function
+
+      def request_id(headers)
+        REQUEST_ID_HEADERS.each do |name|
+          v = headers[name]
+          return Json.take_units(v, 200) if v.is_a?(String) && !v.empty?
+        end
+        nil
+      end
+
+      def media_type(headers) = headers.fetch("content-type", "").split(";").first.to_s.strip.downcase
+
+      def json_media?(media) = media == "application/json" || media.end_with?("+json") || media == "text/json"
+
+      def jsonl_media?(media) = %w[application/jsonl application/x-jsonl application/ndjson application/x-ndjson].include?(media)
+
+      def match_response(responses, status)
+        responses.find { |r| r.status == status } ||
+          responses.find { |r| r.status.is_a?(String) && r.status.match?(/\A[1-5]XX\z/) && r.status[0].to_i == status / 100 } ||
+          responses.find { |r| r.status == "default" }
+      end
+
+      def decode_text(data)
+        text = data.b.delete_prefix("\xEF\xBB\xBF".b).force_encoding(Encoding::UTF_8)
+        text.valid_encoding? ? text : text.scrub("\uFFFD")
+      end
+
+      def decode_body(data, headers, declared)
+        announced = media_type(headers)
+        return Decoded.new(value: UNSET, empty: true) if data.empty? && !jsonl_media?(announced)
+
+        media = announced.empty? ? declared.to_s.downcase : announced
+        jsonl_media = announced.empty? ? media.split(";").first.to_s.strip : announced
+        if jsonl_media?(jsonl_media)
+          raw = decode_text(data)
+          values = []
+          raw.split("\n", -1).each_with_index do |line, i|
+            next if line.strip.empty?
+
+            v = Json.try_parse(line)
+            return Decoded.new(value: raw, invalid_json: true, jsonl: true, bad_line: i + 1) if UNSET.equal?(v)
+
+            values << v
+          end
+          return Decoded.new(value: values, jsonl: true)
+        end
+        if json_media?(media)
+          raw = decode_text(data)
+          v = Json.try_parse(raw)
+          return UNSET.equal?(v) ? Decoded.new(value: raw, invalid_json: true) : Decoded.new(value: v, json: true)
+        end
+        if media.empty? || media.start_with?("text/") || media == "application/problem+xml" || media.end_with?("+xml") ||
+           media == "application/xml"
+          raw = decode_text(data)
+          if media.empty? && raw.lstrip.start_with?("[", "{")
+            v = Json.try_parse(raw)
+            return Decoded.new(value: v, json: true) unless UNSET.equal?(v)
+          end
+          return Decoded.new(value: raw)
+        end
+        Decoded.new(value: Binary.new(data: data))
+      end
+
+      def server_message(body)
+        MESSAGE_FIELDS.each do |field|
+          v = Util.get_path_str(body, field)
+          next unless v.is_a?(String)
+
+          text = v.strip
+          return Json.take_units(text, 200) unless text.empty?
+        end
+        nil
+      end
+
+      def error_code(op, body)
+        return nil if op.error_code_field.nil? || op.error_code_field.empty?
+
+        v = Util.get_path_str(body, op.error_code_field)
+        case v
+        when String then v.empty? ? nil : Json.take_units(v, 200)
+        when Integer, Float then Json.number_text(v)
+        end
+      end
+
+      def refers_to_response?(node, depth = 0)
+        return true if depth > 32
+
+        case node
+        when String then node == "$response" || node.start_with?("$response.")
+        when Array then node.any? { |n| refers_to_response?(n, depth + 1) }
+        when Hash then node.each_value.any? { |n| refers_to_response?(n, depth + 1) }
+        else false
+        end
+      end
+
+      # After a lost answer there is no success body, so a hook whose
+      # arguments reference $response cannot be called.
+      def verify_callable?(verify) = !refers_to_response?(verify["args"])
+
+      def next_action_hint(ctx)
+        op = ctx.op
+        v = op.agent["verify"]
+        if v && v["operation"].to_s != "" && verify_callable?(v)
+          args = v["args"]
+          with = args.is_a?(Hash) && !args.empty? ? " with #{args.keys.join(', ')}" : ""
+          return "Call #{v['operation']}#{with} to check whether #{op.id} took effect before doing anything else."
+        end
+        if op.agent["idempotency"]["policy"] == "content_identity"
+          return "Call #{op.id} again with the identical body; the body is its own identity, so the server answers the original result instead of applying it twice."
+        end
+        return nil unless ctx.key?
+
+        "Call #{op.id} again with the same #{ctx.key_header} value and identical arguments; the server answers the original result instead of applying it twice."
+      end
+
+      # The change an operation makes, in words.
+      def change_of(op)
+        summary = op.summary.strip.delete_suffix(".")
+        summary.empty? ? "the change #{op.id} makes" : "the change #{Util.js_string(summary)}"
+      end
+
+      def replay_protection?(op, has_key) = op.agent["idempotency"]["policy"] == "content_identity" || has_key
+
+      # OUTCOME_UNKNOWN for a mutation whose effect cannot be known. Without
+      # replay protection a repeat can apply the effect twice, so the
+      # envelope never offers one.
+      def outcome_unknown(ctx, cause, next_action: nil, http_status: nil, code: nil, request_id: nil, retry_after_ms: nil)
+        op = ctx.op
+        hint = nil
+        rule =
+          if op.agent["idempotency"]["policy"] == "content_identity"
+            "If you retry, resend the identical bytes only; the body is its own identity."
+          elsif ctx.key?
+            "If you retry, reuse the SAME #{ctx.key_header} value; a new key can apply the effect twice."
+          elsif ctx.check
+            c = ctx.check
+            hint = "Call #{c.call} and check #{c.shows}; call #{op.id} again only if it did not take effect."
+            "This operation has no idempotency key, so repeating it can apply the effect twice. Before calling #{op.id} again, " \
+              "call #{c.call} and check #{c.shows}: if it does, #{op.id} took effect and must not be repeated; call it again only if it did not."
+          else
+            change = change_of(op)
+            hint = "Do not retry #{op.id} blindly: it may have taken effect. Check for #{change} if you can; call #{op.id} " \
+                   "again only if it is not there, or after the task owner accepts that it may apply twice."
+            "This operation has no idempotency key and no registered way to verify it, so #{op.id} may have taken effect and " \
+              "a repeat can apply the effect twice: do not retry it blindly. Check the outcome by other means if you can " \
+              "(look for #{change}); if you cannot, ask whoever owns the task before calling it again."
+          end
+        retryable = replay_protection?(op, ctx.key?) ? "same_key_only" : "after_remediation"
+        Runtime.diag(op.id, "OUTCOME_UNKNOWN")
+               .remedy("#{cause} The server may or may not have applied #{op.id}. #{rule}")
+               .retrying(retryable).next_action(next_action || hint || next_action_hint(ctx))
+               .status(http_status).code(code).request_id(request_id).retry_after_ms(retry_after_ms)
+               .attempts(ctx.attempts).build
+      end
+
+      DEFINITE = %w[VALIDATION_FAILED MALFORMED_REQUEST REQUEST_TOO_LARGE AUTH_FAILED NOT_FOUND CONFLICT PRECONDITION_FAILED
+                    RATE_LIMITED GATE_DISABLED].freeze
+
+      # A manifest entry with one of these categories (or retryable never /
+      # after_remediation) is a definite answer even for an ambiguous status.
+      def definite?(category, retryable) = %w[never after_remediation].include?(retryable) || DEFINITE.include?(category)
+
+      # The envelope of an HTTP error status.
+      def classify_error(ctx, status, headers, decoded, retry_after)
+        api = ctx.api
+        op = ctx.op
+        rid = request_id(headers)
+        base = ->(d) { d.status(status).request_id(rid).retry_after_ms(retry_after).attempts(ctx.attempts) }
+        code = decoded.json ? error_code(op, decoded.value) : nil
+        gate = op.gate
+        if gate && status == gate["disabled_status"] && code.nil?
+          text = (api["gates"] || {})[gate["env_var"]] ||
+                 "This deployment disables #{op.id} because #{gate['env_var']} is off (HTTP #{status}). It is a deployment setting, not a missing resource; do not retry."
+          return base.call(Runtime.diag(op.id, "GATE_DISABLED")).code(code).remedy(text).retrying("never").build
+        end
+        entry = code && (op.agent["remediation"][code] || (api["error_codes"] || {})[code])
+        media = "none"
+        media = media_type(headers).then { |m| m.empty? ? "none" : m } unless decoded.empty
+        non_json = nil
+        unless decoded.json
+          non_json = (api["non_json"] || []).find do |n|
+            n["status"] == status && (n["media"] == media || (n["media"] == "none" && decoded.empty))
+          end
+        end
+        declared = match_response(op.responses, status)
+        ambiguous = (api["ambiguous_statuses"] || []).include?(status) || declared&.kind == "ambiguous" || status.between?(500, 599)
+        definite = (entry && definite?(entry["category"], entry["retryable"])) || (!entry && non_json && definite?(non_json["category"], non_json["retryable"]))
+        if ambiguous && op.mutation? && !definite
+          said = entry && !entry["text"].to_s.empty? ? entry["text"] : (non_json && !non_json["text"].to_s.empty? ? non_json["text"] : nil)
+          cause = "HTTP #{status} leaves the outcome of this call unknown."
+          cause += " #{said}" if said
+          return outcome_unknown(ctx, cause, next_action: entry && entry["next_action"], http_status: status, code: code,
+                                             request_id: rid, retry_after_ms: retry_after)
+        end
+        if entry
+          category = entry["category"] || Runtime.category_for_status(status, decoded.json)
+          retryable = entry["retryable"]
+          text = entry["text"]
+          next_action = entry["next_action"]
+        elsif non_json
+          category = non_json["category"]
+          retryable = non_json["retryable"]
+          text = non_json["text"]
+        else
+          category = Runtime.category_for_status(status, decoded.json)
+        end
+        if category == "OUTCOME_UNKNOWN" && !op.mutation?
+          category = "UPSTREAM_UNAVAILABLE"
+          retryable = "after_delay" if retryable.nil? || retryable == "same_key_only"
+        end
+        if text.nil? || text.empty?
+          text = Runtime.generic_remediation(category)
+          if decoded.json && (said = server_message(decoded.value))
+            text += " Server message: #{Util.js_string(said)}"
+          end
+        end
+        base.call(Runtime.diag(op.id, category)).code(code).remedy(text).retrying_opt(retryable).next_action(next_action).build
+      end
+    end
+  end
+end