strongmind-platform-sdk 3.34.1 → 3.34.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd51875610b6504f5d6cdc31e8384443b384e90ed25a5293d34a1592eba93180
-  data.tar.gz: fbd570234a1128e37a2b8e8dfc408fce6a98cc995486855e6bf600df736a795d
+  metadata.gz: 9b82e33dd88733dca1da0a516c00342899c1227c4301dd4dfd8394aeca5e292a
+  data.tar.gz: 53de61789c363e674b4df379ce42aa33b77b2f0f49fffd49173b82f146b8e382
 SHA512:
-  metadata.gz: 30f9636c5de88c33b9e005d7c68cb351c2ebf44e69fab99c10e3c80f9ef9ed62c69e6e2b1c701d6fb96de6c958ee7814ad69fb2819c57a17595c95cdbccce328
-  data.tar.gz: 68fe58679f511b353f348d5fd5c4624b856858127026293b1a8ef175be3ceb9b9d8d4d9999a5dfa3ad3ee7dc206a65fe2ca3fefc1b9640d59a34595ac13ce441
+  metadata.gz: b12297b6fbe2837bdb9bad307b2035e2f9c3942a1b4d61f27ee81e4638fdb1dfd30d8f92fe64c31ad5f893d4daa7276bf018d72c06d8eb0b2898752d0cad6596
+  data.tar.gz: a63f3b1704854273bd724bcbf69058b1436008f483505481f8f4f1a7d018dac8464d12ee341074fbfe0878f30f3bf5abae542070705a5e035069264fedf8cbde

data/CHANGELOG.md

@@ -1,5 +1,6 @@
 ## [Unreleased]
 
+- Stop logging Identity error response bodies. IS4 answers a create that collides on the username unique index with SQL Server's raw message, which includes the duplicate value (a student's name and SIS id), and the error log line carried that body verbatim. The log line now has the exception class, method, path and status only. The raised error still carries the response, with its request scrubbed, for a consumer that decides it is safe to inspect.
 - Raise typed errors from every Canvas error branch. The read/list/PUT-write methods raised bare `RuntimeError` strings, which consumers could not distinguish from a bug — Central's grade-passback retry wrapper, for example, only retries `CanvasClientError` and so treated every throttled read as fatal. All error branches now raise through one handler: 404 → `MissingModuleItemError`, 401 → `UnauthorizedError`, rate-limited → `RateLimitedError` (new), anything else → `CanvasClientError`. Every class subclasses `CanvasClientError` (itself a `StandardError`), so rescues written against the old classes keep working; only code matching on `RuntimeError` specifically (none known) would notice. Message text changed (see below); no known consumer parses it.
 - Stop echoing raw Canvas response bodies and page query strings into error messages. Consumers persist `error.message` (Central's `OutcomeLog.exception_message`) and forward it to Sentry, and a raw body from a submission, quiz or roster endpoint can carry student records (FERPA). Every error path now shares one message policy: `"<descriptor>: <Canvas's own error messages> (status: N, host: H)"`, with a fixed `unparseable Canvas error body` / `empty Canvas error body` / `Canvas rate limit exceeded` descriptor in place of any body that isn't a JSON error object. The write-path tail (`handle_post_response_errors`) previously appended the whole body and skipped the `error_messages_from` hardening; it now goes through the same builder. Pagination failures name the page path only, dropping the query that carries `as_user_id`/`student_id`. The raw body and status are still available as `CanvasClientError#response_body` and `#status` for a consumer that decides it is safe to inspect.
 - `error_messages_from` also reads a hash-shaped `errors` (field => messages, as Canvas validation errors return) and a top-level `message` key, instead of producing an inspect blob or nothing.

data/lib/platform_sdk/identity/error_handleable.rb

@@ -4,12 +4,7 @@ module PlatformSdk
   module Identity
     # Error handling for Identity SDK
     module ErrorHandleable
-      # The logged payload is the raw request body, which for token endpoints
-      # carries client credentials; redact those fields (form-encoded and
-      # JSON shapes) so an auth outage can't write secrets to consumer logs.
-      SENSITIVE_KEYS = 'client_secret|client_assertion|refresh_token|password'
-      FORM_SECRET_PATTERN = /(#{SENSITIVE_KEYS})=[^&]*/i
-      JSON_SECRET_PATTERN = /("(?:#{SENSITIVE_KEYS})"\s*:\s*")[^"]*(")/i
+      REDACTED = '[REDACTED]'
 
       def with_rescue
         yield
@@ -22,12 +17,9 @@ module PlatformSdk
       end
 
       def raise_error_with_payload(exception_class, error)
-        Rails.logger.info(error_log_payload(exception_class, error).to_json) if defined?(Rails)
-        # The exception itself carries error.response on to consumer
-        # instrumentation (Sentry, custom error handlers), so the raw
-        # request body/headers - which can hold a client_secret or bearer
-        # token - must be scrubbed here too, not just in the log line above.
-        raise exception_class, scrub_response(error.response)
+        payload = error_log_payload(exception_class, error)
+        Rails.logger.info(payload.to_json) if defined?(Rails)
+        raise exception_class.new(error_message(payload), scrub_response(error.response)), cause: nil
       end
 
       # No ActiveSupport here (String#demodulize): this must work for
@@ -36,25 +28,19 @@ module PlatformSdk
       def error_log_payload(exception_class, error)
         {
           exception: exception_class.name.split('::').last,
-          payload: scrub_secrets(error.response.dig(:request, :body)),
-          response_body: error.response[:body],
+          method: error.response.dig(:request, :method),
+          path: error.response.dig(:request, :url_path),
           status: error.response[:status]
         }.compact
       end
 
-      def scrub_secrets(body)
-        return body unless body.is_a?(String)
+      def error_message(payload)
+        message = "the server responded with status #{payload[:status]}"
+        return message unless payload[:method] && payload[:path]
 
-        body.gsub(FORM_SECRET_PATTERN) { "#{Regexp.last_match(1)}=[REDACTED]" }
-            .gsub(JSON_SECRET_PATTERN, '\1[REDACTED]\2')
+        "#{message} for #{payload[:method].to_s.upcase} #{payload[:path]}"
       end
 
-      # Returns a scrubbed copy of the Faraday error response hash; the
-      # original (and its nested :request hash) are left untouched. Only
-      # [:request][:body] and [:request][:headers] are touched -
-      # [:status] and [:body] (the response body) are read elsewhere
-      # (e.g. e.response&.dig(:status), e.response&.dig(:body, 'paramName'))
-      # and must reach consumers unchanged.
       def scrub_response(response)
         return response unless response.is_a?(Hash)
 
@@ -65,7 +51,9 @@ module PlatformSdk
 
       def scrub_request(request)
         scrubbed_request = request.dup
-        scrubbed_request[:body] = scrub_secrets(request[:body]) if request[:body].is_a?(String)
+        scrubbed_request[:body] = REDACTED if request.key?(:body)
+        scrubbed_request[:params] = REDACTED if request.key?(:params)
+        scrubbed_request[:url] = request[:url_path] if request.key?(:url)
         scrubbed_request[:headers] = scrub_headers(request[:headers]) if request[:headers].is_a?(Hash)
         scrubbed_request
       end
@@ -75,7 +63,7 @@ module PlatformSdk
       def scrub_headers(headers)
         scrubbed = headers.dup
         scrubbed.each_key do |key|
-          scrubbed[key] = '[REDACTED]' if key.to_s.casecmp('authorization').zero?
+          scrubbed[key] = REDACTED if key.to_s.casecmp('authorization').zero?
         end
         scrubbed
       end

data/lib/platform_sdk/version.rb

@@ -3,7 +3,7 @@
 module PlatformSdk
   MAJOR = 3
   MINOR = 34
-  PATCH = 1
+  PATCH = 3
 
   VERSION = "#{PlatformSdk::MAJOR}.#{PlatformSdk::MINOR}.#{PlatformSdk::PATCH}".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strongmind-platform-sdk
 version: !ruby/object:Gem::Version
-  version: 3.34.1
+  version: 3.34.3
 platform: ruby
 authors:
 - Platform Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-10-12 00:00:00.000000000 Z
+date: 2026-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -392,7 +392,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: This gem is intended to provide clients and models for accessing the Platform