Update/1.10.0

.circleci/config.yml

@@ -1,7 +1,7 @@
 version: 2.1
 
 orbs:
-  secops: apollo/[email protected].0
+  secops: apollo/[email protected].7
 
 workflows:
   security-scans:
@@ -13,3 +13,9 @@ workflows:
             - secops-oidc
           git-base-revision: <<#pipeline.git.base_revision>><<pipeline.git.base_revision>><</pipeline.git.base_revision >>
           git-revision: << pipeline.git.revision >>
+      - secops/semgrep:
+          context:
+            - secops-oidc
+            - github-orb
+          git-base-revision: <<#pipeline.git.base_revision>><<pipeline.git.base_revision>><</pipeline.git.base_revision >>
+          fail-on-findings: true

.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# This file was automatically generated by the Apollo SecOps team
+# Please customize this file as needed prior to merging.
+
+* @apollographql/client-swift

.github/workflows/issue-close-user-survey.yml

@@ -0,0 +1,27 @@
+name: Issue Close User Survey
+
+on:
+  issues:
+    types: [closed]
+
+jobs:
+  user-survey-comment:
+    permissions:
+      issues: write
+    runs-on: ubuntu-latest
+    if: github.repository == 'apollographql/apollo-ios'
+    steps:
+      - run: |
+          if [ "$AUTHOR" == "MEMBER" ] && (( $COMMENTS == 0 )); then
+            echo "Issue opened by member with no comments, skipping user survey."
+          else
+            gh issue comment "$NUMBER" --body "$BODY"
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GH_REPO: ${{ github.repository }}
+          NUMBER: ${{ github.event.issue.number }}
+          COMMENTS: ${{ github.event.issue.comments }}
+          AUTHOR: ${{ github.event.issue.author_association }}
+          BODY: >
+            Do you have any feedback for the maintainers? Please tell us by taking a [one-minute survey](https://docs.google.com/forms/d/e/1FAIpQLSczNDXfJne3ZUOXjk9Ursm9JYvhTh1_nFTDfdq3XBAFWCzplQ/viewform?usp=pp_url&entry.1170701325=Apollo+iOS&entry.204965213=GitHub+Issue). Your responses will help us understand Apollo iOS usage and allow us to serve you better.

.github/workflows/prometheus-project-add.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Add to project
-      uses: actions/add-to-project@v0.4.0
+      uses: actions/add-to-project@v1.0.0
       with:
         project-url: https://github.com/orgs/apollographql/projects/21
         github-token: ${{ secrets.PROMETHEUS_PROJECT_ACCESS_SECRET }}

Apollo.podspec

@@ -13,6 +13,7 @@ Pod::Spec.new do |s|
   s.osx.deployment_target = '10.14'
   s.tvos.deployment_target = '12.0'
   s.watchos.deployment_target = '5.0'
+  s.visionos.deployment_target = '1.0'
 
   cli_binary_name = 'apollo-ios-cli'
   s.preserve_paths = [cli_binary_name]
@@ -22,20 +23,27 @@ Pod::Spec.new do |s|
 
   s.subspec 'Core' do |ss|
     ss.source_files = 'Sources/Apollo/**/*.swift','Sources/ApolloAPI/**/*.swift'
+    ss.resource_bundles = {'Apollo' => ['Sources/Apollo/Resources/PrivacyInfo.xcprivacy']}
   end
 
   # Apollo provides exactly one persistent cache out-of-the-box, as a reasonable default choice for
   # those who require cache persistence. Third-party caches may use different storage mechanisms.
   s.subspec 'SQLite' do |ss|
     ss.source_files = 'Sources/ApolloSQLite/*.swift'
     ss.dependency 'Apollo/Core'
-    ss.dependency 'SQLite.swift', '~>0.13.1'
+    ss.dependency 'SQLite.swift', '~>0.15.1'
+    ss.resource_bundles = {
+      'ApolloSQLite' => ['Sources/ApolloSQLite/Resources/PrivacyInfo.xcprivacy']
+    }
   end
 
   # Websocket and subscription support based on Starscream
   s.subspec 'WebSocket' do |ss|
     ss.source_files = 'Sources/ApolloWebSocket/**/*.swift'
     ss.dependency 'Apollo/Core'
+    ss.resource_bundles = {
+      'ApolloWebSocket' => ['Sources/ApolloWebSocket/Resources/PrivacyInfo.xcprivacy']
+    }
   end
 
 end

CHANGELOG.md

@@ -1,5 +1,75 @@
 # Change Log
 
+## v1.10.0
+
+### New
+
+- **Added support for visionOS ([#3320](https://github.com/apollographql/apollo-ios/issues/3320)):** All the dependecies that Apollo iOS requires have been updated to add support for visionOS, so we can now add official support for visionOS too. See PR [#333](https://github.com/apollographql/apollo-ios-dev/pull/333).
+
+### Improvement
+
+- **Add Sendable conformance to some basic SchemaTypes:** This adds `Sendable` conformance to the some of the generated schema types. This does not mean that all of the generated code is safe to use yet with complete concurrency checking of Swift 5.10 but it gets us closer to that goal. See PR [#322](https://github.com/apollographql/apollo-ios-dev/pull/322). _Thanks to [@bdbergeron](https://github.com/bdbergeron) for the contributon._
+
+## v1.9.3
+
+### Fixed
+
+- **Fix injecting of context for UploadRequest:** Any request context passed into an upload request was not being added to the HTTP request and would not be available to the interceptor chain. See PR ([#302](https://github.com/apollographql/apollo-ios-dev/pull/302)). _Thanks to [@RobertDresler](https://github.com/RobertDresler) for the contribution._
+- **Added support for SPM Package.resolved format version 3 ([#3355](https://github.com/apollographql/apollo-ios/issues/3355)):** When using Xcode 15.3 the codegen CLI would fail the `generate` command with an error stating the Package.resolve file version is unsupported. Version 3 is now accepted as a valid file format for the codegen version checker. See PR ([#304](https://github.com/apollographql/apollo-ios-dev/pull/304)).
+- **PrivacyInfo.xcprivacy file is invalid for Apollo and ApolloApi ([#3359](https://github.com/apollographql/apollo-ios/issues/3359)):** We received reports that when submitting to the App Store the submission would fail with an error stating that the privacy manifests were invalid. We identified the error and updated the privacy files. See PR ([#309](https://github.com/apollographql/apollo-ios-dev/pull/309)). _Thanks to [@azilbershtein](https://github.com/azilbershtein) for raising the issue._
+
+### Improvement
+
+- **Provide a direct means to observe changes in ApolloStore:** `ApolloStore` now exposes it's subscriber mechanism publicly. This means you can now observe and receive notifications about changes to the store. See PR ([#300](https://github.com/apollographql/apollo-ios-dev/pull/300)). _Thanks to [@jamesonwilliams](https://github.com/jamesonwilliams) for the contribution._
+- **Remove redundant iteration in EntitySelectionTree merging algorithm:** The conditions for merging selections were revisited and we identified, and removed, a redundant iteration. This is a significant performance improvement as it removes an entire additional iteration through all the conditional scopes in the tree. See PR ([#308](https://github.com/apollographql/apollo-ios-dev/pull/308)).
+
+## v1.9.2
+
+### Fixed
+
+- **Backwards Compatibility issues in 1.9.1:** 1.9.1 introduced a minor breaking change for some users who were creating a custom implementaiton of `ApolloClientProtocol`. Sorry about that! This patch release fixed the compatiblity. See PR [#290](https://github.com/apollographql/apollo-ios-dev/pull/290). _Thanks to [@michaelloo](https://github.com/michaelloo) for raising the issue._
+
+### Improvement
+
+- **Session and task descriptions parameters added to `URLSessionClient` ([#286](https://github.com/apollographql/apollo-ios-dev/pull/286)):** The `URLSessionClient` now allows you to set a `sessionDescription` on the session and `taskDescription` on each task. These are helpful when debugging, especially when analyzing HTTP traffic with Instruments. _Thanks to [@hishma](https://github.com/hishma) for the contribution._
+
+## v1.9.1
+
+### Fixed
+
+- **`SelectionSet` generated initializers don't compile with `self` parameter ([#3330](https://github.com/apollographql/apollo-ios/issues/3330)):** Selection set initializers now use a local property name when the external property name is a Swift reserved word; see PR [#257](https://github.com/apollographql/apollo-ios-dev/pull/257). _Thanks to [@grantjbutler](https://github.com/grantjbutler) for raising the issue._
+- **asXXXXXXX property on a union never returning `nil` if selection set empty ([#3326](https://github.com/apollographql/apollo-ios/issues/3326)):** - The codegen logic to determine whether a selection set is composite or not has been improved to handle the case when `__typename` was the only field in the selection set; see PR [#261](https://github.com/apollographql/apollo-ios-dev/pull/261). _Thanks to [@vincentisambart](https://github.com/vincentisambart) for raising the issue._
+
+### Improvement
+
+- **Feature/ContextIdentifier for the mutate queries ([#281](https://github.com/apollographql/apollo-ios-dev/pull/281)):** Mutation operations can now be given a context identifier to be used later in the request. _Thanks to [@VladimirK-ah](https://github.com/VladimirK-ah) for the contribution._
+
+## v1.9.0
+
+### Improvement
+
+- **New import directive for operations:** GraphQL operations now support a directive to control custom module import statements in the generated file. Any operation that includes the directive `@import(module:)`, on the defintion line, with a supplied `String` as the module name will have that module used in a Swift `import` statement at the top of the operation file and any referenced fragments. _Thank you to [@hemel](https://github.com/hemel) for the contribution ([#236](https://github.com/apollographql/apollo-ios-dev/pull/236) / [#245](https://github.com/apollographql/apollo-ios-dev/pull/245))._
+
+### Fixed
+
+- **The `fragmentDefinition` remains in all generated fragments when `operationDocumentFormat` does not include `.definition` ([#3282](https://github.com/apollographql/apollo-ios/issues/3282)):** Code generation will now only generate definitions in fragment files if the `operationDocumentFormat` config contains the `.definition` value ([#218](https://github.com/apollographql/apollo-ios-dev/pull/218)). _Thank you to [@jimisaacs](https://github.com/jimisaacs) for raising the issue._
+- **Custom scalar file header comment ([#3323](https://github.com/apollographql/apollo-ios/issues/3323)):** The header comment for generated custom scalar files was incorrectly changed to state that the output "should not be edited" but the file content could still be edited and would not be overwritten. The header comment has been changed back to state that the contents will be preserved during subsequent codegen executions. _Thank you to [@matsudamper](https://github.com/matsudamper) for raising the issue and the contribution to fix it ([#243](https://github.com/apollographql/apollo-ios-dev/pull/243))._
+
+### Changed
+
+- **WebSocket disconnection errors are no longer printed to stdout ([#3325](https://github.com/apollographql/apollo-ios/issues/3325)):** See PR ([#253](https://github.com/apollographql/apollo-ios-dev/pull/253)) _Thank you to [@sgade](https://github.com/sgade) for raising the issue._
+
+## v1.8.0
+
+### Fixed
+- **Duplicate `@defer` directive error ([#235](https://github.com/apollographql/apollo-ios-dev/pull/235)):** When executing codegen against Apollo Router and a schema that supports the `@defer` directive it would fail with an error stating the directive is duplicated.
+
+### Improvement
+
+- **Added `InputObject`` casing strategy ([#137](https://github.com/apollographql/apollo-ios-dev/pull/137)):** We've added a new casing strategy option for InputObjects which mimics the behaviour of the enum case conversion strategy. _Thank you to [@alexifrim](https://github.com/alexifrim) for raising this in issue [#3257](https://github.com/apollographql/apollo-ios/issues/3257)._
+- **Added `GraphQLResult` conversion extension ([#139](https://github.com/apollographql/apollo-ios-dev/pull/139)):** `GraphQLResult` response data can now be easily converted into a JSON dictionary. This is useful for taking server response data and serializing it into a JSON dictionary which can then be used in a test suite.
+- **Codegen performance improvements ([#152](https://github.com/apollographql/apollo-ios-dev/pull/152)):** There has been a bunch of refactoring work to prepare for future codegen features but we've also managed to squeeze out some performance improvements.
+
 ## v1.7.1
 
 ### Fixed

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.7
+// swift-tools-version:5.9
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
@@ -9,7 +9,8 @@ let package = Package(
     .iOS(.v12),
     .macOS(.v10_14),
     .tvOS(.v12),
-    .watchOS(.v5)
+    .watchOS(.v5),
+    .visionOS(.v1),
   ],
   products: [
     .library(name: "Apollo", targets: ["Apollo"]),
@@ -23,30 +24,42 @@ let package = Package(
   dependencies: [
     .package(
       url: "https://github.com/stephencelis/SQLite.swift.git",
-      .upToNextMajor(from: "0.13.1")),
+      .upToNextMajor(from: "0.15.1")),
   ],
   targets: [
     .target(
       name: "Apollo",
       dependencies: [
         "ApolloAPI"
+      ],
+      resources: [
+        .copy("Resources/PrivacyInfo.xcprivacy")
       ]
     ),
     .target(
       name: "ApolloAPI",
-      dependencies: []
+      dependencies: [],
+      resources: [
+        .copy("Resources/PrivacyInfo.xcprivacy")
+      ]
     ),
     .target(
       name: "ApolloSQLite",
       dependencies: [
         "Apollo",
         .product(name: "SQLite", package: "SQLite.swift"),
+      ],
+      resources: [
+        .copy("Resources/PrivacyInfo.xcprivacy")
       ]
     ),
     .target(
       name: "ApolloWebSocket",
       dependencies: [
         "Apollo"
+      ],
+      resources: [
+        .copy("Resources/PrivacyInfo.xcprivacy")
       ]
     ),
     .target(
@@ -74,7 +87,8 @@ let package = Package(
           verb: "apollo-cli-install",
           description: "Installs the Apollo iOS Command line interface."),
         permissions: [
-          .writeToPackageDirectory(reason: "Creates a symbolic link to the CLI executable in your project directory."),
+          .writeToPackageDirectory(reason: "Downloads and unzips the CLI executable into your project directory."),
+          .allowNetworkConnections(scope: .all(ports: []), reason: "Downloads the Apollo iOS CLI executable from the GitHub Release.")
         ]),
       dependencies: [],
       path: "Plugins/InstallCLI"

Plugins/InstallCLI/InstallCLIPluginCommand.swift

@@ -5,34 +5,17 @@ import PackagePlugin
 struct InstallCLIPluginCommand: CommandPlugin {
 
   func performCommand(context: PackagePlugin.PluginContext, arguments: [String]) async throws {
-    var apolloDirectoryPath: Path? = nil
     let dependencies = context.package.dependencies
-    dependencies.forEach { dep in
+    try dependencies.forEach { dep in
       if dep.package.displayName == "Apollo" {
-          apolloDirectoryPath = dep.package.directory
+        let process = Process()
+        let path = try context.tool(named: "sh").path
+        process.executableURL = URL(fileURLWithPath: path.string)
+        process.arguments = ["\(dep.package.directory)/scripts/download-cli.sh", context.package.directory.string]
+        try process.run()
+        process.waitUntilExit()
       }
     }
-
-    guard let apolloPath = apolloDirectoryPath else {
-      fatalError("No Apollo dependency directory path")
-    }
-
-    let process = Process()
-    let tarPath = try context.tool(named: "tar").path
-    process.executableURL = URL(fileURLWithPath: tarPath.string)
-    process.arguments = ["-xvf", "\(apolloPath)/CLI/apollo-ios-cli.tar.gz"]
-    try process.run()
-    process.waitUntilExit()
-  }
-
-  func createSymbolicLink(from: PackagePlugin.Path, to: PackagePlugin.Path) throws {
-    let task = Process()
-    task.standardInput = nil
-    task.environment = ProcessInfo.processInfo.environment
-    task.arguments = ["-c", "ln -f -s '\(from.string)' '\(to.string)'"]
-    task.executableURL = URL(fileURLWithPath: "/bin/zsh")
-    try task.run()
-    task.waitUntilExit()
   }
 
 }
@@ -47,9 +30,9 @@ extension InstallCLIPluginCommand: XcodeCommandPlugin {
     print("Installing Apollo CLI Plugin to Xcode project \(context.xcodeProject.displayName)")
     let apolloPath = "\(context.pluginWorkDirectory)/../../checkouts/apollo-ios"
     let process = Process()
-    let tarPath = try context.tool(named: "tar").path
-    process.executableURL = URL(fileURLWithPath: tarPath.string)
-    process.arguments = ["-xvf", "\(apolloPath)/CLI/apollo-ios-cli.tar.gz"]
+    let path = try context.tool(named: "sh").path
+    process.executableURL = URL(fileURLWithPath: path.string)
+    process.arguments = ["\(apolloPath)/scripts/download-cli.sh", context.xcodeProject.directory.string]
     try process.run()
     process.waitUntilExit()
   }

README.md

@@ -26,6 +26,10 @@
   </a>
 </p>
 
+| ☑️  Apollo Clients User Survey |
+| :----- |
+| What do you like best about Apollo iOS? What needs to be improved? Please tell us by taking a [one-minute survey](https://docs.google.com/forms/d/e/1FAIpQLSczNDXfJne3ZUOXjk9Ursm9JYvhTh1_nFTDfdq3XBAFWCzplQ/viewform?usp=pp_url&entry.1170701325=Apollo+iOS&entry.204965213=Readme). Your responses will help us understand Apollo iOS usage and allow us to serve you better. |
+
 ### Apollo iOS is a strongly-typed, caching GraphQL client, written in Swift
 
 It allows you to execute queries and mutations against a GraphQL server, and returns results as query-specific Swift types. This means you don’t have to deal with parsing JSON, or passing around dictionaries and making clients cast values to the right type manually. You also don't have to write model types yourself, because these are generated from the GraphQL definitions your UI uses.