Add additional edition type fields

This expands the edition type to include all the top-level properties
that a content item contains, and most of the nested data. The queries
sent by frontend apps will be able to pare down the data that gets sent
to them from the Publishing API, but we are able to get almost all the
same data as presented by the current content item if required

Some fields are not yet fully implemented:
- `withdrawn_notice` is currently just a nullable String, but will be
  implemented more fully in an upcoming commit
- `details` is currently a generic JSON type as it's an inherently
  flexible object that could have a wide range of fields. It may be
  worth defining more specific types and moving the `details` keys up to
  the top level on each type for each page being built in future. This
  would allow for reduced complexity in querying the required fields.
  We've used JSON to keep it flexible and to allow consumers to fall
  back on these fields if they need to.
- `links` needs further work to query and present the data that is
  currently presented in the content item, so we've left the field off
  for now, rather than adding a non-so-useful placeholder. We'll need to
  add links when we add pages that use links like the ministers index
  page.  It would be good to figure out how we can reduce the need for
  full link expansion and move to a more minimal on-demand version when
  we tackle this piece of work.
- `publishing_scheduled_at` and `scheduled_publishing_delay_seconds` are
  not currently available in Publishing API. They are generated in
  Content Store, so we just return `null` here. If we do need to serve
  these in future, we'd need to find a way of storing these in
  Publishing API, but that's definitely out of scope for now.

Co-authored-by: Ynda Jas <[email protected]>

Author: Gweaton

app/graphql/types/edition_type.rb

@@ -2,6 +2,33 @@
 
 module Types
   class EditionType < Types::BaseObject
-    field :title, String
+    field :analytics_identifier, String
+    field :base_path, String
+    field :content_id, ID
+    field :description, String
+    field :details, GraphQL::Types::JSON, null: false
+    field :document_type, String
+    field :first_published_at, GraphQL::Types::ISO8601DateTime, null: false
+    field :locale, String, null: false
+    field :phase, String, null: false
+    field :public_updated_at, GraphQL::Types::ISO8601DateTime, null: false
+    field :publishing_app, String
+    field :publishing_request_id, String
+    field :publishing_scheduled_at, GraphQL::Types::ISO8601DateTime
+    field :rendering_app, String
+    field :scheduled_publishing_delay_seconds, Int
+    field :schema_name, String
+    field :title, String, null: false
+    field :updated_at, GraphQL::Types::ISO8601DateTime
+    field :withdrawn_notice, String
+
+    # Aliased by field methods for fields that are currently presented in the
+    # content item, but come from Content Store, so we can't provide them here
+    def not_stored_in_publishing_api
+      nil
+    end
+
+    alias_method :publishing_scheduled_at, :not_stored_in_publishing_api
+    alias_method :scheduled_publishing_delay_seconds, :not_stored_in_publishing_api
   end
 end

spec/integration/graphql_spec.rb

@@ -1,7 +1,8 @@
 RSpec.describe "GraphQL" do
   describe "generic edition" do
     before do
-      create(:live_edition, title: "My Generic Edition", base_path: "/my/generic/edition")
+      document = create(:document, content_id: "d53db33f-d4ac-4eb3-839a-d415174eb906")
+      @edition = create(:live_edition, document:, base_path: "/my/generic/edition")
     end
 
     it "exposes generic edition fields" do
@@ -11,6 +12,27 @@
             edition(basePath: \"/my/generic/edition\") {
               ... on Edition {
                 title
+                analyticsIdentifier
+                basePath
+                contentId
+                description
+                details
+                documentType
+                firstPublishedAt
+                locale
+                phase
+                publicUpdatedAt
+                publishingApp
+                publishingRequestId
+                publishingScheduledAt
+                renderingApp
+                scheduledPublishingDelaySeconds
+                schemaName
+                updatedAt
+                withdrawnNotice {
+                  explanation
+                  withdrawnAt
+                }
               }
             }
           }",
@@ -19,12 +41,35 @@
       expected = {
         "data": {
           "edition": {
-            "title": "My Generic Edition",
+            "analyticsIdentifier": @edition.analytics_identifier,
+            "basePath": @edition.base_path,
+            "contentId": @edition.content_id,
+            "description": @edition.description,
+            "details": @edition.details,
+            "documentType": @edition.document_type,
+            "firstPublishedAt": @edition.first_published_at.iso8601,
+            "locale": @edition.locale,
+            "phase": @edition.phase,
+            "publicUpdatedAt": @edition.public_updated_at.iso8601,
+            "publishingApp": @edition.publishing_app,
+            "publishingRequestId": @edition.publishing_request_id,
+            "publishingScheduledAt": nil,
+            "renderingApp": @edition.rendering_app,
+            "scheduledPublishingDelaySeconds": nil,
+            "schemaName": @edition.schema_name,
+            "title": @edition.title,
+            "updatedAt": @edition.updated_at.iso8601,
+            "withdrawnNotice": {
+              "explanation": nil,
+              "withdrawnAt": nil,
+            },
           },
         },
-      }.to_json
+      }
 
-      expect(response.body).to eq(expected)
+      parsed_response = JSON.parse(response.body).deep_symbolize_keys
+
+      expect(parsed_response).to eq(expected)
     end
 
     it "does not expose non-generic edition fields" do