trmnl_preview 0.13.2 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 905205771ecf23f22c55a3d48835e6ee75ea90d4d2b55638c6ebea0160173578
-  data.tar.gz: 663c559a8b71f943023fae8e18ea2e494c8df04e2d5fe81ffd34ce19a6d4d736
+  metadata.gz: 23e1959e442066534a715efcc371a9c7d4cb41c7dda22727712b12b7b1eb90af
+  data.tar.gz: fbf07c5d835d4981b0380ce774fdfb74edab699c16772e187776ba58a1aee152
 SHA512:
-  metadata.gz: d8fbb97e1eb0ccc38a54ab7820de2837e7ef27b1bc52faed278b912a1ad709aee63f5b58860cbe4dedbd9fac7a5b7b3bce5fb68f2a750a0c064bb489a4846bc5
-  data.tar.gz: 0d3ffc25d6567a13c125bd332be0fd76ec2b018e4de2e144b3e36ac1e4dc99882b6c802c31bbfdcac86e104b00b3448e8d1d4d61733aad953325a67b9399ca0c
+  metadata.gz: 8caa7eeef62cb562df06f7e0b3e1fcbf025cabe1f98fcda83fc365a0ee0fa9d8ce70fca9a3c16514a8ce3c320296c234e96e358d45cf3481e2b0451772e8866a
+  data.tar.gz: 01b1248e629516ab0c1857138807a27066f7b4e97be26024dd5e3365152d399e3e301fefcb864eb8e355546a5d5d6149f7c9851a345a3c8f09819099cd54c5bc

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 
 # Changelog
 
+## 0.14.0
+
+- `trmnlp serve` and `build` print what the transform writes to stdout and stderr (`console.log`, `print`, `puts`), one `transform stdout:` / `transform stderr:` line each, so a transform can be debugged without returning its logs in the data. (#128)
+- The OAuth token exchange and refresh honor `oauth_token_request_auth_method` the way the hosted service does: HTTP Basic only for `header`, otherwise the client credentials go in the request body. trmnlp used HTTP Basic whenever a client secret was set, so a provider that wants the credentials in the body rejected the callback with `invalid_client: client_id is required`. A plugin that relied on HTTP Basic locally sets `oauth_token_request_auth_method: header`, which the hosted service already needs. (#121)
+- `polling_headers` are parsed the way the hosted service parses them: one header per line, `Name: Value` as well as `Name=Value`, a JSON object, and values that contain `=`. Before, trmnlp split only on `&`, so headers saved one per line made the whole poll fail with "cannot include CR/LF" and the markup and transform got no polled data (no `IDX_0`/`IDX_1`). (#127)
+- `trmnlp lint` no longer reports a custom field as unused when only the serverless transform (`src/transform.{py,rb,php,js}`) reads it. Plugins that move their data handling into the transform, reading fields from `input["trmnl"]["plugin_settings"]["custom_fields_values"]`, got one "is not used in form fields or markup" warning per field. The check now searches the transform as well, and its message names it. (#136)
+
 ## 0.13.2
 
 - `google_photos_picker`, `json`, `modal_trigger` and `oauth_provider_select` are known form field types, so `trmnlp lint`, `build` and `serve` no longer warn "unknown field_type" for them. The hosted service renders all four. (#137)

data/README.md

@@ -334,6 +334,7 @@ oauth_scopes: "read:user user:email"
 oauth_pkce_enabled: "true"      # optional, default false
 # oauth_scope_separator: " "      # optional; some providers use ","
 # oauth_refresh_url: https://...  # optional; defaults to oauth_token_url
+# oauth_token_request_auth_method: header  # optional; "header" sends the client credentials as HTTP Basic, otherwise they go in the body
 ```
 
 Your OAuth app credentials stay local and are never synced, so set them in your environment:

data/lib/trmnlp/config/plugin.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'cgi'
+require 'json'
 require 'yaml'
 
 require_relative '../errors'
@@ -113,13 +114,34 @@ module TRMNLP
         project_config.with_custom_fields(value, extra_variables:)
       end
 
-      def string_to_hash(str, delimiter: '=')
-        str.split('&').map do |k_v|
-          key, value = k_v.split(delimiter)
+      # Mirrors the hosted service's Plugins::Helpers::Transformer#string_to_hash.
+      def string_to_hash(str)
+        return json_to_hash(str) if str.strip.start_with?('{')
+
+        str.split(/[\n&]/).filter_map do |pair|
+          pair = pair.strip
+          key, value = pair.split(delimiter_for(pair), 2)
           next if value.nil?
 
-          { key => CGI.unescape_uri_component(value) }
-        end.compact.reduce({}, :merge)
+          [key.strip, CGI.unescape_uri_component(value.strip)]
+        end.to_h
+      end
+
+      # ": " (not ":") so an "https://" URL isn't mistaken for a "Name: Value" header.
+      def delimiter_for(pair)
+        equals = pair.index('=')
+        colon = pair.index(': ')
+        return '=' if colon.nil?
+        return ': ' if equals.nil?
+
+        colon < equals ? ': ' : '='
+      end
+
+      def json_to_hash(str)
+        parsed = JSON.parse(str)
+        parsed.is_a?(Hash) ? parsed.transform_values(&:to_s) : {}
+      rescue JSON::ParserError
+        {}
       end
     end
   end

data/lib/trmnlp/lint/checks/custom_fields_used.rb

@@ -6,13 +6,14 @@ module TRMNLP
   module Lint
     module Checks
       # Reports custom fields declared in .trmnlp.yml that never appear in the
-      # polling settings or the markup — one finding per unused field.
+      # polling settings, the markup or the serverless transform — one finding
+      # per unused field.
       class CustomFieldsUsed < Check
         SETTINGS_KEYS = %w[polling_url polling_headers polling_body].freeze
 
         def issues
           source.custom_field_values.keys.reject { |keyname| used?(keyname) }.map do |keyname|
-            { message: "Custom field '#{keyname}' is not used in form fields or markup." }
+            { message: "Custom field '#{keyname}' is not used in form fields, markup or the transform." }
           end
         end
 
@@ -20,7 +21,8 @@ module TRMNLP
 
         def used?(keyname)
           pattern = /#{Regexp.escape(keyname)}/
-          searchable_settings.match?(pattern) || source.all_markup.match?(pattern)
+          searchable_settings.match?(pattern) || source.all_markup.match?(pattern) ||
+            source.transform_code.match?(pattern)
         end
 
         def searchable_settings

data/lib/trmnlp/lint/source.rb

@@ -33,6 +33,15 @@ module TRMNLP
         @all_markup ||= view_markup.values.join + shared_markup
       end
 
+      # The serverless transform (src/transform.{py,rb,php,js}), or '' without one.
+      # It reads custom fields from its input, so a field may be used only there.
+      def transform_code
+        @transform_code ||= begin
+          path, = paths.transform_file
+          path ? read(path) : ''
+        end
+      end
+
       private
 
       attr_reader :config, :paths

data/lib/trmnlp/oauth/client.rb

@@ -39,9 +39,8 @@ module TRMNLP
         )
       end
 
-      # A PKCE public client has no secret, so its client_id must travel in the
-      # request body; a confidential client authenticates with HTTP Basic.
-      def auth_scheme = provider.client_secret ? :basic_auth : :request_body
+      # Same rule as the hosted service: HTTP Basic only when asked for, otherwise the body.
+      def auth_scheme = provider.token_request_auth_method == 'header' ? :basic_auth : :request_body
 
       # oauth2 posts tokens through a connection built from the site, so give it
       # the endpoint's origin even though the full URL is absolute.

data/lib/trmnlp/oauth/provider.rb

@@ -19,6 +19,7 @@ module TRMNLP
       def refresh_url = settings['oauth_refresh_url'] || token_url
       def scopes = settings['oauth_scopes']
       def scope_separator = settings['oauth_scope_separator'] || ' '
+      def token_request_auth_method = settings['oauth_token_request_auth_method']
       def pkce? = truthy?(settings['oauth_pkce_enabled'])
       def enabled? = truthy?(settings['oauth_enabled'])
       def client_id = env_first(ENV_CLIENT_ID, settings['oauth_client_id'])

data/lib/trmnlp/transform_pipeline.rb

@@ -40,11 +40,19 @@ module TRMNLP
     def run(path, inferred_language, data)
       language = config.plugin.serverless_language || inferred_language
       result = client.execute(code: path.read, stdin: JSON.generate(data), language:)
+      report_printed_output(result)
       return record_failure(result, data) unless result.success?
 
       parse_output(result.output, data)
     end
 
+    # The transform's return value travels separately, so stdout holds only what it printed.
+    def report_printed_output(result)
+      { 'stdout' => result.stdout, 'stderr' => result.stderr }.each do |stream, text|
+        reporter.info("transform #{stream}: #{text.strip}") unless text.strip.empty?
+      end
+    end
+
     def record_failure(result, fallback)
       @error = result.error || "transform exited #{result.exit_code}: #{result.stderr.strip}"
       reporter.info("transform failed: #{@error}")

data/lib/trmnlp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TRMNLP
-  VERSION = '0.13.2'
+  VERSION = '0.14.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnl_preview
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 0.14.0
 platform: ruby
 authors:
 - Rockwell Schrock