ecoportal-api-graphql 1.3.13 → 1.3.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fba9a366d06303f179c6b7d841930a66a29b6cc3fe836e06b218b95873bbe77e
-  data.tar.gz: 6114ba779317ec55b649e1f7df685c0140573cea073aa07c04b9e4cfa20b433a
+  metadata.gz: 2eada698a590c0214f8eb7a37255efe68c2573de6c73e3e1ce42ba6a8ff5accb
+  data.tar.gz: 316b65e4027224711711d2248ada651911b1e64ce48aeff6bffb22144e53cd11
 SHA512:
-  metadata.gz: d867c896796e9107870a2a49e3cdc75275b0a96559a9b8fe47fedea407ef639f7ff558ce22de798f79f3f011c7d4464a3eacd01a63e764778d2e0359cd8ed4ad
-  data.tar.gz: c29f555f19fc3d679f51cb512c417caca1e7e5f0006e9ac35a7ccf4d7f074095011ad4a59128a458b69c178dd538d79bf952d1b26b1557397e0d5fc4c41274d4
+  metadata.gz: f0894ce98e42628e50bb594ccbaa0050ae07518517a08745d54f5f61dc4031f959163b69caa1768ed978d0499abbb478c2dc4811867239373c324cac8008cc2a
+  data.tar.gz: 43e3dcf9dd61f521573a2249d26c92a571c23f06f2c742e9b19aa5554832b1195b251f0832da70f6231c68c0f94e108ff6487738a1e81e1c8c7d214944a98e0d

data/CHANGELOG.md

@@ -2,6 +2,93 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.3.16] - 2026-08-13
+
+### Fixed
+
+- Packaging-only republish of `1.3.15` with an allowlisted gemspec (backported from `2.0.0`).
+  Versions `1.3.9`-`1.3.15` shipped internal repository content (`.ai-assistance/` project notes,
+  `docs/worklog.md`, architecture docs) to rubygems.org via the old denylist `spec.files`; they
+  will be yanked. `1.3.16` is the identical `lib/` code (including the `1.3.15` OozeRedirect
+  `executeWorkflowCommands` fix) packaged clean, so the `1.x` line keeps a clean latest release.
+
+## [1.3.15] - 2026-07-30
+
+**Backwards-compatible.** Every change here fixes a query or mutation document that the live
+schema rejected — i.e. code paths that could not run at all — plus the CI gate that found them.
+Cherry-picked onto the 1.3.x line from `main`, where they landed alongside **breaking** changes
+that are deliberately NOT in this release (see "Deferred to 1.4.0" below).
+
+### Fixed
+
+- **`FileUpload::Client` authenticated the v2 REST endpoints wrongly.** The ported S3
+  register/poll steps sent `Authorization: Bearer <oauth_token>`; those endpoints authenticate via
+  `X-ECOPORTAL-API-KEY`, so step 3 404'd and `#upload` never completed. `Ecoportal::API::GraphQL.new`
+  accepts an additive `api_key:` (independent of the GraphQL endpoint's own email/pass OAuth),
+  `HttpClient#api_key` is public, and the client raises a clear error when it is missing.
+  ⚠ **Not yet live-verified** — verify against a sandbox org before relying on it.
+- **Three invalid union selections.** `Query::RegisterPresetViews` (`fieldConfigurations`),
+  `Query::PageWithForces` (`forces`) and `Query::PagesWorkflowCommands` (`workflow`) selected
+  fields directly on a union, which is invalid GraphQL ("Selections can't be made directly on
+  unions") — all three queries failed outright. They now select through the members' shared
+  interface (`FieldConfigurationInterface` / `BasePageInterface`). Response shapes are unchanged.
+- **`fragment ForceFields` asked for a non-existent `id` on bindings.** `Force.bindings` is
+  `[BindingInterface]`, whose only fields are `name` / `referenceId` (+ per-member `reference`),
+  so every query spreading the fragment was invalid. Now selects on the interface directly.
+  NOTE the read/write asymmetry this exposes: `WorkflowEditBindingInput` / `removeBinding` require
+  a binding `id` that no read exposes, so `BindingCollection#delete!(binding)` has no source for it.
+- **7 invalid `PageFields` spreads.** The four review-task mutations return `item: TaskInterface`
+  (not a page — the page is reachable via `subject`), `Template::{Create,Destroy}RelatedPage`
+  return `RelatedPages`, and `Template::UpdateInformation` returns the narrow `Template` type. New
+  `:PageTaskFields` / `:TemplateRelatedPages` / `:TemplateInformation` fragments and read-only
+  `Base/Model::Page::Task` + `Base/Model::Template::{RelatedPages,Information}` models; the payload
+  `item_class`es pointed at `Model::PageUnion`, which never matched the schema. The template
+  mutations that genuinely return a page (`Create`/`Publish`/`Unpublish`/`Update`) are unchanged.
+- **6 payloads selected an `item` their type does not have.** `Page::CreateDraft` → `{ id }`,
+  `Page::{DeleteDraft,PublishDraft}` → `{ ok }`, `Page::BatchUpdateReviewTask` → `{ count }` (and
+  its own `Payload::Page::ReviewTaskBatch`), `Register::Destroy` → `{ ok }`, `PresetView::Destroy`
+  → `{ clientMutationId errors }`. `Payload::Page::Draft` gained `id`/`ok`, `Payload::Register`
+  gained `ok`.
+- **`executeWorkflowCommands` was rendered with arguments it never accepted** — the schema takes a
+  single `input: ExecuteWorkflowCommandsInput!`, so the **page-level command bus could not run**.
+  Both classes' `#query` already built the right `input` hash; only the documents were wrong.
+- **`Payload::OkPayload` now models `errors`** — it selected them but computed `success?` purely
+  from `ok`, silently ignoring a populated errors object.
+
+### Added (tooling — no runtime effect)
+
+- **`validate-queries` CI job** (`.gitlab-ci.yml`): renders every query + mutation against a
+  freshly introspected schema and fails on render failures plus the always-invalid selection
+  classes ("must have selections", "can't be made on scalars", "can't be made directly on unions",
+  "can't be spread inside"). This gate is what found everything above.
+- **`tests/dump_schema.rb`**: fresh introspection through the gem's own `HttpClient`. Requires
+  `SERVER` explicitly (the gem's default host is production). Schema dumps are never committed.
+
+### Deferred to 1.4.0 (breaking — intentionally absent here)
+
+- The AI-summary rewire (`generateAiSummary` → `generatePageSummary`,
+  `submitAiSummaryFeedback` → `submitPageAiSummaryFeedback`, changed `#query` keywords,
+  `Base::AiSummaryVersion` field removals) and the removal of the `SmartFill` mutations
+  (`smartFillGenerate` / `smartFillSubmitFeedback` do not exist in the schema).
+- The 2026-07-13 `WorkflowCommandInput` schema sync and the polymorphic read-model layer.
+
+## [1.3.14] - 2026-07-16
+
+Re-issue of the **1.3.13 HttpClient resilience fix** under a fresh version. The `1.3.13`
+artifact published to the gem server (2026-07-11) could not be relied upon to contain the
+fix below — RubyGems versions are immutable and cannot be re-pushed, so the fix ships here
+as `1.3.14`. Functionally identical to the *intended* `1.3.13` (this is `1.3.12` + the
+resilience fix, nothing else). **Backwards-compatible.**
+
+Consumers that need the 429/1015 resilience (e.g. bulk `cans-upsert` live runs) must floor
+`ecoportal-api-graphql >= 1.3.14` — a `>= 1.3.13` floor is not sufficient.
+
+### Fixed
+
+- Same fix as documented under `[1.3.13]` below: `Common::GraphQL::HttpClient#execute` routes
+  through the inherited `instrument → with_retry { rate_throttling }` pipeline, so a single
+  HTTP 429 (Cloudflare edge rate-limit `1015`) no longer aborts the run.
+
 ## [1.3.13] - 2026-07-12
 
 Reliability: the GraphQL `HttpClient` now inherits the **same request-resilience

data/lib/ecoportal/api/common/graphql/client.rb

@@ -29,8 +29,6 @@ module Ecoportal
 
             puts "Configuring GraphQL Client onto '#{url}'"
 
-            pp email
-
             super(
               url,
               headers:      {

data/lib/ecoportal/api/common/graphql/http_client.rb

@@ -21,6 +21,12 @@ module Ecoportal
 
           attr_reader :host, :version
 
+          # Publicly exposes the configured api_key (inherited as `private` from
+          # `Common::Client`) — `FileUpload::Client` needs it directly to authenticate
+          # against the v2 REST endpoints, independent of this client's own `@version`
+          # (which stays `'graphql'` and therefore always builds a Bearer `key_token`).
+          public :api_key
+
           include Ecoportal::API::Common::GraphQL::AuthService
 
           def initialize(

data/lib/ecoportal/api/graphql/base/ai_summary_version.rb

@@ -1,17 +1,17 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Base
-        # Represents one generation version of an AiSummary field.
-        # Returned by generateAiSummary — tracks the prompt, output, token usage, and status.
-        class AiSummaryVersion < Logic::BaseModel
-          passkey :id
-          passthrough :aiSummary, :status, :prompt
-          passthrough :inputTokens, :outputTokens, :totalTokens
-          passthrough :resourceType # "field" | "stage" | "page"
-          passarray :ratings        # [[user_id, score], ...]
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        # Represents one generation version of an AiSummary field.
+        # Returned by generateAiSummary — tracks the prompt, output, token usage, and status.
+        class AiSummaryVersion < Logic::BaseModel
+          passkey :id
+          passthrough :aiSummary, :status, :prompt
+          passthrough :inputTokens, :outputTokens, :totalTokens
+          passthrough :resourceType # "field" | "stage" | "page"
+          passarray :ratings        # [[user_id, score], ...]
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/file_container.rb

@@ -1,14 +1,14 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Base
-        class FileContainer < Logic::BaseModel
-          passkey :id
-          passthrough :name, :activeName
-          passthrough :fileSize, :token, :activeVersionId
-          passarray :tags
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        class FileContainer < Logic::BaseModel
+          passkey :id
+          passthrough :name, :activeName
+          passthrough :fileSize, :token, :activeVersionId
+          passarray :tags
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/location_classification_type.rb

@@ -1,15 +1,15 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Base
-        class LocationClassificationType < Logic::BaseModel
-          root!
-
-          passkey :id
-          passthrough :name
-          passboolean :active
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        class LocationClassificationType < Logic::BaseModel
+          root!
+
+          passkey :id
+          passthrough :name
+          passboolean :active
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/location_structure.rb

@@ -1,27 +1,27 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Base
-        class LocationStructure < Interface::LocationStructure::Nodes
-          read_only!
-
-          class_resolver :location_node_class, Base::LocationNode
-          class_resolver :draft_class, "Base::LocationStructure::Draft"
-
-          passkey :id
-          passthrough :name, :weight
-          passboolean :archived, :published, :visitorManagementEnabled
-          embeds_one :updatedAt, klass: Base::DateTime
-
-          embeds_many :drafts, klass: :draft_class, order_key: :createdAt
-
-          def draft?
-            false
-          end
-        end
-      end
-    end
-  end
-end
-
-require_relative 'location_structure/draft'
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        class LocationStructure < Interface::LocationStructure::Nodes
+          read_only!
+
+          class_resolver :location_node_class, Base::LocationNode
+          class_resolver :draft_class, "Base::LocationStructure::Draft"
+
+          passkey :id
+          passthrough :name, :weight
+          passboolean :archived, :published, :visitorManagementEnabled
+          embeds_one :updatedAt, klass: Base::DateTime
+
+          embeds_many :drafts, klass: :draft_class, order_key: :createdAt
+
+          def draft?
+            false
+          end
+        end
+      end
+    end
+  end
+end
+
+require_relative 'location_structure/draft'

data/lib/ecoportal/api/graphql/base/organization.rb

@@ -1,15 +1,15 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Base
-        class Organization < Logic::BaseModel
-          root!
-
-          passkey :id
-          passthrough :name, :companyName
-          passthrough :logoUrl, read_only: true
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        class Organization < Logic::BaseModel
+          root!
+
+          passkey :id
+          passthrough :name, :companyName
+          passthrough :logoUrl, read_only: true
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page/task.rb

@@ -0,0 +1,24 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        module Page
+          # A page TASK — the `item` of the review-task mutations (`TaskInterface`:
+          # CompletePage / InComment / ReviewPage). Read-only.
+          #
+          # This is NOT a page: the page it belongs to is `subject` (a PageUnion). The
+          # review-task payloads used to type `item` as `Model::PageUnion`, which never
+          # matched the schema (see `Fragment :PageTaskFields`).
+          class Task < Logic::BaseModel
+            read_only!
+
+            passkey     :id
+            passthrough :__typename, :stageId, :relativeStatus, :taskNotes
+            passboolean :complete, :overdue, :escalated
+            passdate    :createdAt, :completedAt, :due
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page.rb

@@ -1,16 +1,17 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Base
-        module Page
-        end
-      end
-    end
-  end
-end
-
-require_relative 'page/basic'
-require_relative 'page/data_field'
-require_relative 'page/section'
-require_relative 'page/section_collection'
-require_relative 'page/phased'
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        module Page
+        end
+      end
+    end
+  end
+end
+
+require_relative 'page/basic'
+require_relative 'page/data_field'
+require_relative 'page/section'
+require_relative 'page/section_collection'
+require_relative 'page/phased'
+require_relative 'page/task'

data/lib/ecoportal/api/graphql/base/template.rb

@@ -0,0 +1,35 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        # Namespace for the narrow template-side types.
+        #
+        # ★ Note the platform asymmetry: in most of this gem a "template" IS a page (a page with
+        # `template: true`), which is why `Query::Templates` and most `Payload::Template::*`
+        # resolve to `Model::PageUnion`. The two types here are the exceptions — distinct schema
+        # types returned by specific template mutations.
+        module Template
+          # `item` of `updateTemplateInformation` (schema type `Template`). Read-only.
+          class Information < Logic::BaseModel
+            read_only!
+
+            passkey     :id
+            passthrough :description, :aiDescription, :templateType, :templateContainerUid
+            passboolean :active, :public, :creatorEnabled, :creatorEditable
+            passarray   :folders
+          end
+
+          # `item` of `createTemplateRelatedPage` / `destroyTemplateRelatedPage`
+          # (schema type `RelatedPages`) — a related-pages CONFIG entry, not a page. Read-only.
+          class RelatedPages < Logic::BaseModel
+            read_only!
+
+            passkey     :id
+            passthrough :title, :registerId
+            passboolean :hasInaccessibleVariables
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base.rb

@@ -1,35 +1,37 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Base
-      end
-    end
-  end
-end
-
-require_relative 'base/date_time'
-require_relative 'base/page_info'
-require_relative 'base/location_classification_type'
-require_relative 'base/location_node'
-require_relative 'base/location_structure'
-require_relative 'base/person_member'
-require_relative 'base/file_attachment'
-require_relative 'base/file_container'
-require_relative 'base/field'
-require_relative 'base/page'
-require_relative 'base/resource'
-require_relative 'base/action_category'
-require_relative 'base/action'
-require_relative 'base/contractor_entity'
-require_relative 'base/preview_page'
-require_relative 'base/delta_result'
-require_relative 'base/organization'
-
-require_relative 'base/register'
-require_relative 'base/preset_view'
-
-require_relative 'base/ai_summary_version'
-
-require_relative 'base/force'
-require_relative 'base/pages_workflow'
-require_relative 'base/kickstand'
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+      end
+    end
+  end
+end
+
+require_relative 'base/date_time'
+require_relative 'base/page_info'
+require_relative 'base/location_classification_type'
+require_relative 'base/location_node'
+require_relative 'base/location_structure'
+require_relative 'base/person_member'
+require_relative 'base/file_attachment'
+require_relative 'base/file_container'
+require_relative 'base/field'
+require_relative 'base/page'
+require_relative 'base/resource'
+require_relative 'base/action_category'
+require_relative 'base/action'
+require_relative 'base/contractor_entity'
+require_relative 'base/preview_page'
+require_relative 'base/delta_result'
+require_relative 'base/organization'
+
+require_relative 'base/register'
+require_relative 'base/preset_view'
+
+require_relative 'base/ai_summary_version'
+
+require_relative 'base/force'
+require_relative 'base/pages_workflow'
+require_relative 'base/kickstand'
+
+require_relative 'base/template'

data/lib/ecoportal/api/graphql/builder/contractor_entity.rb

@@ -1,41 +1,41 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Builder
-        class ContractorEntity
-          attr_reader :client
-
-          def initialize(client)
-            @client = client
-          end
-
-          def create(**kargs, &block)
-            createMutation.query(**kargs, &block)
-          end
-
-          def update(**kargs, &block)
-            updateMutation.query(**kargs, &block)
-          end
-
-          def destroy(**kargs, &block)
-            destroyMutation.query(**kargs, &block)
-          end
-
-          private
-
-          def createMutation
-            Mutation::ContractorEntity::Create.new(client)
-          end
-
-          def updateMutation
-            Mutation::ContractorEntity::Update.new(client)
-          end
-
-          def destroyMutation
-            Mutation::ContractorEntity::Destroy.new(client)
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Builder
+        class ContractorEntity
+          attr_reader :client
+
+          def initialize(client)
+            @client = client
+          end
+
+          def create(**kargs, &block)
+            createMutation.query(**kargs, &block)
+          end
+
+          def update(**kargs, &block)
+            updateMutation.query(**kargs, &block)
+          end
+
+          def destroy(**kargs, &block)
+            destroyMutation.query(**kargs, &block)
+          end
+
+          private
+
+          def createMutation
+            Mutation::ContractorEntity::Create.new(client)
+          end
+
+          def updateMutation
+            Mutation::ContractorEntity::Update.new(client)
+          end
+
+          def destroyMutation
+            Mutation::ContractorEntity::Destroy.new(client)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/compat/response.rb

@@ -1,35 +1,35 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Compat
-        # Wraps a GraphQL mutation payload to expose the v2-compatible response interface.
-        # Scripts check .success? and .status after update/create operations.
-        class Response
-          def initialize(payload)
-            @payload = payload
-          end
-
-          def success?
-            @payload.success?
-          end
-
-          def error?
-            @payload.error?
-          end
-
-          def status
-            @payload.error? ? :error : :ok
-          end
-
-          def body
-            @payload.error_doc
-          end
-
-          def item
-            @payload.item
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Compat
+        # Wraps a GraphQL mutation payload to expose the v2-compatible response interface.
+        # Scripts check .success? and .status after update/create operations.
+        class Response
+          def initialize(payload)
+            @payload = payload
+          end
+
+          def success?
+            @payload.success?
+          end
+
+          def error?
+            @payload.error?
+          end
+
+          def status
+            @payload.error? ? :error : :ok
+          end
+
+          def body
+            @payload.error_doc
+          end
+
+          def item
+            @payload.item
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/connection/action.rb

@@ -1,11 +1,11 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Connection
-        class Action < Logic::Connection
-          class_resolver :node_class, Model::Action
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Connection
+        class Action < Logic::Connection
+          class_resolver :node_class, Model::Action
+        end
+      end
+    end
+  end
+end