Prepare Version 1.0 RC 1 (#2512)

CHANGELOG.md

@@ -1,5 +1,37 @@
 # Change Log
 
+## v1.0.0-rc.1 - Release Candidate #1
+
+This is the first Release Candidate for Apollo iOS 1.0. The Release Candidate is a fully featured and code-complete representation of the final 1.0 version. This includes full feature parity with the 0.x.x releases.
+
+API breaking changes are not expected between the Release Candidate and the General Availability (GA) release. The only code changes will be non-breaking bug fixes due to user feedback. The Release Candidate does not have complete documentation or usage guides, which will be completed prior to GA.
+
+This first major version will include a new code generation engine, better generated models, and many syntax and performance improvements across the entire library. The primary goal of Apollo iOS 1.0 is to stabilize the API of the model layer and provide a foundation for future feature additions and evolution of the library.
+
+* **New: Option to Include Deprecated Input Arguments on Fields During Schema Download** Thanks to [@dave-perry](https://github.com/dave-perry) for this addition!
+* **Fixed: Code Generation Config JSON File Compatibility** 
+  * Previously, the `apollo-codegen-config.json` file used by the Apollo CLI needed to contain values for all optional fields. When new codegen options were added, this would cause errors until all newly added options has values provided. 
+  * The `Codable` implementation for the `ApolloCodgenConfiguration` has been implemented manually to prevent this. Now, only required fields must be provided, all optional fields can be omitted from the config file safely. 
+  * The CLI's `init` command also now generates a template config file with only the required fields.
+* **Fixed: Swift Keywords are escaped when used as names of Input Parameters**
+* **Fixed: Compilation Error when using `@skip` and `@include` conditions on the same field**
+* **Fixed: Added permissions request to SPM Code Generation Plugin**
+  * When running the code generation plugin, you will be prompted to give permission for the plugin to write to the package directory.
+  * This permission check can be avoided by passing the `--allow-writing-to-package-directory` flag when executing the plugin command.
+* **Fixed: APQ Operations Will no Longer be Retried when Unrecognized if using `.persistedOperationsOnly`**
+  * `.persistedOperationsOnly` is for use with allow-listed operations only. If an operation identifier is not recognized by the server, there is no way to register the operation in this configuration.   
+* **Breaking: Updated `ApolloAPI` internal metadata properties to be `__` prefixed.**
+  * Generated GraphQL files expose certain properties/functions that are consumed by the `Apollo` library during GraphQL Execution. These members must be public in order to be exposed to `Apollo`, but are not intended for external consumption. We have added underscore prefixes to each of these members to signify that intention, using `__` for GraphQL Metadata (in alignment with the GraphQL Specification) and `_` for `Apollo`'s utility and helper functions.
+  * The affected signatures are:
+    * `SelectionSet.schema` -> `SelectionSet.__schema`
+    * `SelectionSet.selection` -> `SelectionSet.__selection`
+    * `JSONEncodable.jsonValue` -> `JSONEncodable._jsonValue`
+    * `JSONDecodable.init(jsonValue:)` -> `JSONDecodable.init(_jsonValue:)`
+    * `AnyHashableConvertible.asAnyHashable` -> `AnyHashableConvertible._asAnyHashable`
+    * `OutputTypeConvertible.asOutputType` -> `OutputTypeConvertible._asOutputType`
+    * `GraphQLOperation.variables` -> `GraphQLOperation._variables`
+    * `LocalCacheMutation.variables` -> `LocalCacheMutation._variables`
+
 ## v1.0.0-beta.4
 
 This is the fourth Beta Release of Apollo iOS 1.0. The Beta version has full feature parity with the 0.x.x releases. The API is expected to be mostly stable. Some breaking changes may occur due to user feedback prior to General Availability (GA) Release. The Beta does not have complete documentation or usage guides, which will be completed prior to GA.

Configuration/Shared/Project-Version.xcconfig

@@ -1 +1 @@
-CURRENT_PROJECT_VERSION = 1.0.0-beta.4
+CURRENT_PROJECT_VERSION = 1.0.0-rc.1

Sources/AnimalKingdomAPI/AnimalKingdomAPI/Package.swift

@@ -14,7 +14,7 @@ let package = Package(
     .library(name: "AnimalKingdomAPI", targets: ["AnimalKingdomAPI"]),
   ],
   dependencies: [
-    .package(url: "https://github.com/apollographql/apollo-ios.git", from: "1.0.0-beta.4"),
+    .package(url: "https://github.com/apollographql/apollo-ios.git", from: "1.0.0-rc.1"),
   ],
   targets: [
     .target(

Sources/ApolloCodegenLib/Templates/SwiftPackageManagerModuleTemplate.swift

@@ -34,7 +34,7 @@ struct SwiftPackageManagerModuleTemplate: TemplateRenderer {
         .library(name: "\(casedModuleName)", targets: ["\(casedModuleName)"]),
       ],
       dependencies: [
-        .package(url: "https://github.com/apollographql/apollo-ios.git", from: "1.0.0-beta.4"),
+        .package(url: "https://github.com/apollographql/apollo-ios.git", from: "1.0.0-rc.1"),
       ],
       targets: [
         .target(

Sources/GitHubAPI/GitHubAPI/Package.swift

@@ -14,7 +14,7 @@ let package = Package(
     .library(name: "GitHubAPI", targets: ["GitHubAPI"]),
   ],
   dependencies: [
-    .package(url: "https://github.com/apollographql/apollo-ios.git", from: "1.0.0-beta.4"),
+    .package(url: "https://github.com/apollographql/apollo-ios.git", from: "1.0.0-rc.1"),
   ],
   targets: [
     .target(

Sources/StarWarsAPI/StarWarsAPI/Package.swift

@@ -14,7 +14,7 @@ let package = Package(
     .library(name: "StarWarsAPI", targets: ["StarWarsAPI"]),
   ],
   dependencies: [
-    .package(url: "https://github.com/apollographql/apollo-ios.git", from: "1.0.0-beta.4"),
+    .package(url: "https://github.com/apollographql/apollo-ios.git", from: "1.0.0-rc.1"),
   ],
   targets: [
     .target(

Sources/SubscriptionAPI/SubscriptionAPI/Package.swift

@@ -14,7 +14,7 @@ let package = Package(
     .library(name: "SubscriptionAPI", targets: ["SubscriptionAPI"]),
   ],
   dependencies: [
-    .package(url: "https://github.com/apollographql/apollo-ios.git", from: "1.0.0-beta.4"),
+    .package(url: "https://github.com/apollographql/apollo-ios.git", from: "1.0.0-rc.1"),
   ],
   targets: [
     .target(

Sources/UploadAPI/UploadAPI/Package.swift

@@ -14,7 +14,7 @@ let package = Package(
     .library(name: "UploadAPI", targets: ["UploadAPI"]),
   ],
   dependencies: [
-    .package(url: "https://github.com/apollographql/apollo-ios.git", from: "1.0.0-beta.4"),
+    .package(url: "https://github.com/apollographql/apollo-ios.git", from: "1.0.0-rc.1"),
   ],
   targets: [
     .target(

Sources/apollo-ios-cli/main.swift

@@ -6,7 +6,7 @@ struct Apollo_iOS_CLI: ParsableCommand {
   static var configuration = CommandConfiguration(
     commandName: "apollo-ios-cli",
     abstract: "A command line utility for Apollo iOS code generation.",
-    version: "1.0.0-beta.4",
+    version: "1.0.0-rc.1",
     subcommands: [
       CodegenCLI.Initialize.self,
       CodegenCLI.Generate.self,

Tests/ApolloCodegenTests/CodeGeneration/Templates/SwiftPackageManagerModuleTemplateTests.swift

@@ -121,7 +121,7 @@ class SwiftPackageManagerModuleTemplateTests: XCTestCase {
 
     let expected = """
       dependencies: [
-        .package(url: "https://github.com/apollographql/apollo-ios.git", from: "1.0.0-beta.4"),
+        .package(url: "https://github.com/apollographql/apollo-ios.git", from: "1.0.0-rc.1"),
       ],
     """
     // when

Tests/TestCodeGenConfigurations/EmbeddedInTarget-InSchemaModule/Sources/MySwiftPackage/Fragments/ClassroomPetDetails.graphql.swift

@@ -42,7 +42,7 @@ public extension MyGraphQLSchema {
     public init(data: DataDict) { __data = data }
 
     public static var __parentType: ParentType { MyGraphQLSchema.Unions.ClassroomPet }
-    public static var selections: [Selection] { [
+    public static var __selections: [Selection] { [
       .inlineFragment(AsAnimal.self),
       .inlineFragment(AsPet.self),
       .inlineFragment(AsWarmBlooded.self),
@@ -66,7 +66,7 @@ public extension MyGraphQLSchema {
       public init(data: DataDict) { __data = data }
 
       public static var __parentType: ParentType { MyGraphQLSchema.Interfaces.Animal }
-      public static var selections: [Selection] { [
+      public static var __selections: [Selection] { [
         .field("species", String.self),
       ] }
 
@@ -81,7 +81,7 @@ public extension MyGraphQLSchema {
       public init(data: DataDict) { __data = data }
 
       public static var __parentType: ParentType { MyGraphQLSchema.Interfaces.Pet }
-      public static var selections: [Selection] { [
+      public static var __selections: [Selection] { [
         .field("humanName", String?.self),
       ] }
 
@@ -96,7 +96,7 @@ public extension MyGraphQLSchema {
       public init(data: DataDict) { __data = data }
 
       public static var __parentType: ParentType { MyGraphQLSchema.Interfaces.WarmBlooded }
-      public static var selections: [Selection] { [
+      public static var __selections: [Selection] { [
         .field("laysEggs", Bool.self),
       ] }
 
@@ -112,7 +112,7 @@ public extension MyGraphQLSchema {
       public init(data: DataDict) { __data = data }
 
       public static var __parentType: ParentType { MyGraphQLSchema.Objects.Cat }
-      public static var selections: [Selection] { [
+      public static var __selections: [Selection] { [
         .field("bodyTemperature", Int.self),
         .field("isJellicle", Bool.self),
       ] }
@@ -132,7 +132,7 @@ public extension MyGraphQLSchema {
       public init(data: DataDict) { __data = data }
 
       public static var __parentType: ParentType { MyGraphQLSchema.Objects.Bird }
-      public static var selections: [Selection] { [
+      public static var __selections: [Selection] { [
         .field("wingspan", Double.self),
       ] }
 
@@ -150,7 +150,7 @@ public extension MyGraphQLSchema {
       public init(data: DataDict) { __data = data }
 
       public static var __parentType: ParentType { MyGraphQLSchema.Objects.PetRock }
-      public static var selections: [Selection] { [
+      public static var __selections: [Selection] { [
         .field("favoriteToy", String.self),
       ] }
 

Tests/TestCodeGenConfigurations/EmbeddedInTarget-InSchemaModule/Sources/MySwiftPackage/Fragments/ClassroomPetDetailsCCN.graphql.swift

@@ -24,7 +24,7 @@ public extension MyGraphQLSchema {
     public init(data: DataDict) { __data = data }
 
     public static var __parentType: ParentType { MyGraphQLSchema.Unions.ClassroomPet }
-    public static var selections: [Selection] { [
+    public static var __selections: [Selection] { [
       .inlineFragment(AsAnimal.self),
     ] }
 
@@ -38,7 +38,7 @@ public extension MyGraphQLSchema {
       public init(data: DataDict) { __data = data }
 
       public static var __parentType: ParentType { MyGraphQLSchema.Interfaces.Animal }
-      public static var selections: [Selection] { [
+      public static var __selections: [Selection] { [
         .field("height", Height.self),
       ] }
 
@@ -52,7 +52,7 @@ public extension MyGraphQLSchema {
         public init(data: DataDict) { __data = data }
 
         public static var __parentType: ParentType { MyGraphQLSchema.Objects.Height }
-        public static var selections: [Selection] { [
+        public static var __selections: [Selection] { [
           .field("inches", Int.self),
         ] }
 

Tests/TestCodeGenConfigurations/EmbeddedInTarget-InSchemaModule/Sources/MySwiftPackage/Fragments/DogFragment.graphql.swift

@@ -18,7 +18,7 @@ public extension MyGraphQLSchema {
     public init(data: DataDict) { __data = data }
 
     public static var __parentType: ParentType { MyGraphQLSchema.Objects.Dog }
-    public static var selections: [Selection] { [
+    public static var __selections: [Selection] { [
       .field("species", String.self),
     ] }
 

Tests/TestCodeGenConfigurations/EmbeddedInTarget-InSchemaModule/Sources/MySwiftPackage/Fragments/HeightInMeters.graphql.swift

@@ -21,7 +21,7 @@ public extension MyGraphQLSchema {
     public init(data: DataDict) { __data = data }
 
     public static var __parentType: ParentType { MyGraphQLSchema.Interfaces.Animal }
-    public static var selections: [Selection] { [
+    public static var __selections: [Selection] { [
       .field("height", Height.self),
     ] }
 
@@ -35,7 +35,7 @@ public extension MyGraphQLSchema {
       public init(data: DataDict) { __data = data }
 
       public static var __parentType: ParentType { MyGraphQLSchema.Objects.Height }
-      public static var selections: [Selection] { [
+      public static var __selections: [Selection] { [
         .field("meters", Int.self),
       ] }
 

Tests/TestCodeGenConfigurations/EmbeddedInTarget-InSchemaModule/Sources/MySwiftPackage/Fragments/PetDetails.graphql.swift

@@ -23,7 +23,7 @@ public extension MyGraphQLSchema {
     public init(data: DataDict) { __data = data }
 
     public static var __parentType: ParentType { MyGraphQLSchema.Interfaces.Pet }
-    public static var selections: [Selection] { [
+    public static var __selections: [Selection] { [
       .field("humanName", String?.self),
       .field("favoriteToy", String.self),
       .field("owner", Owner?.self),
@@ -41,7 +41,7 @@ public extension MyGraphQLSchema {
       public init(data: DataDict) { __data = data }
 
       public static var __parentType: ParentType { MyGraphQLSchema.Objects.Human }
-      public static var selections: [Selection] { [
+      public static var __selections: [Selection] { [
         .field("firstName", String.self),
       ] }
 

Tests/TestCodeGenConfigurations/EmbeddedInTarget-InSchemaModule/Sources/MySwiftPackage/Fragments/WarmBloodedDetails.graphql.swift

@@ -19,7 +19,7 @@ public extension MyGraphQLSchema {
     public init(data: DataDict) { __data = data }
 
     public static var __parentType: ParentType { MyGraphQLSchema.Interfaces.WarmBlooded }
-    public static var selections: [Selection] { [
+    public static var __selections: [Selection] { [
       .field("bodyTemperature", Int.self),
       .fragment(HeightInMeters.self),
     ] }

Tests/TestCodeGenConfigurations/EmbeddedInTarget-InSchemaModule/Sources/MySwiftPackage/LocalCacheMutations/AllAnimalsLocalCacheMutation.graphql.swift

@@ -16,7 +16,7 @@ public extension MyGraphQLSchema {
       public init(data: DataDict) { __data = data }
 
       public static var __parentType: ParentType { MyGraphQLSchema.Objects.Query }
-      public static var selections: [Selection] { [
+      public static var __selections: [Selection] { [
         .field("allAnimals", [AllAnimal].self),
       ] }
 
@@ -33,7 +33,7 @@ public extension MyGraphQLSchema {
         public init(data: DataDict) { __data = data }
 
         public static var __parentType: ParentType { MyGraphQLSchema.Interfaces.Animal }
-        public static var selections: [Selection] { [
+        public static var __selections: [Selection] { [
           .field("species", String.self),
           .field("skinCovering", GraphQLEnum<SkinCovering>?.self),
           .inlineFragment(AsBird.self),
@@ -61,7 +61,7 @@ public extension MyGraphQLSchema {
           public init(data: DataDict) { __data = data }
 
           public static var __parentType: ParentType { MyGraphQLSchema.Objects.Bird }
-          public static var selections: [Selection] { [
+          public static var __selections: [Selection] { [
             .field("wingspan", Double.self),
           ] }
 

Tests/TestCodeGenConfigurations/EmbeddedInTarget-InSchemaModule/Sources/MySwiftPackage/LocalCacheMutations/PetDetailsMutation.graphql.swift

@@ -21,7 +21,7 @@ public extension MyGraphQLSchema {
     public init(data: DataDict) { __data = data }
 
     public static var __parentType: ParentType { MyGraphQLSchema.Interfaces.Pet }
-    public static var selections: [Selection] { [
+    public static var __selections: [Selection] { [
       .field("owner", Owner?.self),
     ] }
 
@@ -38,7 +38,7 @@ public extension MyGraphQLSchema {
       public init(data: DataDict) { __data = data }
 
       public static var __parentType: ParentType { MyGraphQLSchema.Objects.Human }
-      public static var selections: [Selection] { [
+      public static var __selections: [Selection] { [
         .field("firstName", String.self),
       ] }
 

Tests/TestCodeGenConfigurations/EmbeddedInTarget-InSchemaModule/Sources/MySwiftPackage/Operations/Mutations/PetAdoptionMutation.graphql.swift

@@ -27,14 +27,14 @@ public extension MyGraphQLSchema {
       self.input = input
     }
 
-    public var variables: Variables? { ["input": input] }
+    public var __variables: Variables? { ["input": input] }
 
     public struct Data: MyGraphQLSchema.SelectionSet {
       public let __data: DataDict
       public init(data: DataDict) { __data = data }
 
       public static var __parentType: ParentType { MyGraphQLSchema.Objects.Mutation }
-      public static var selections: [Selection] { [
+      public static var __selections: [Selection] { [
         .field("adoptPet", AdoptPet.self, arguments: ["input": .variable("input")]),
       ] }
 
@@ -48,7 +48,7 @@ public extension MyGraphQLSchema {
         public init(data: DataDict) { __data = data }
 
         public static var __parentType: ParentType { MyGraphQLSchema.Interfaces.Pet }
-        public static var selections: [Selection] { [
+        public static var __selections: [Selection] { [
           .field("id", ID.self),
           .field("humanName", String?.self),
         ] }

Tests/TestCodeGenConfigurations/EmbeddedInTarget-InSchemaModule/Sources/MySwiftPackage/Operations/Queries/AllAnimalsCCNQuery.graphql.swift

@@ -31,7 +31,7 @@ public extension MyGraphQLSchema {
       public init(data: DataDict) { __data = data }
 
       public static var __parentType: ParentType { MyGraphQLSchema.Objects.Query }
-      public static var selections: [Selection] { [
+      public static var __selections: [Selection] { [
         .field("allAnimals", [AllAnimal].self),
       ] }
 
@@ -45,7 +45,7 @@ public extension MyGraphQLSchema {
         public init(data: DataDict) { __data = data }
 
         public static var __parentType: ParentType { MyGraphQLSchema.Interfaces.Animal }
-        public static var selections: [Selection] { [
+        public static var __selections: [Selection] { [
           .field("height", Height?.self),
         ] }
 
@@ -59,7 +59,7 @@ public extension MyGraphQLSchema {
           public init(data: DataDict) { __data = data }
 
           public static var __parentType: ParentType { MyGraphQLSchema.Objects.Height }
-          public static var selections: [Selection] { [
+          public static var __selections: [Selection] { [
             .field("feet", Int?.self),
             .field("inches", Int.self),
           ] }