@W-16589742: [iOS] REST wrappers for select SFAP APIs #3801

JohnsonEricAtSalesforce · 2025-01-13T22:03:53Z

🧱 Draft: Only one of the four endpoints is included. We'll review that for a quick look, then add the remaining three 🚧

This adds REST API clients for select sfap_api endpoints to match the Android version in forcedotcom/SalesforceMobileSDK-Android#2644

Only one of the four is included in the draft status. Here's a code sample from how I tested in iOSNativeSwiftTemplate's AppDelegate.

    /// The generation id from the `sfap_api` `generations` endpoint
    private var generationId: String? = nil
    
    /// Fetches generated text from the `sfap_api` "generations" endpoint.
    private func generateText() async {
        do {
            guard let userAccountCurrent = UserAccountManager.shared.currentUserAccount, let restClient = RestClient.restClient(for: userAccountCurrent) else { return }
            
            // Guards.            
            let generationsResponseBody = try await SfapApiClient(
                apiHostName: "dev.api.salesforce.com",
                modelName: "sfdc_ai__DefaultGPT35Turbo",
                restClient: restClient
            ).fetchGeneratedText(
                "Tell me a story about an action movie hero with really, really cool hair."
            )
            
            self.generationId = generationsResponseBody.generation?.id
            print("SFAP_API-TESTS: \(String(describing: generationsResponseBody.generation?.generatedText))")
            print("SFAP_API-TESTS: \(String(describing: generationsResponseBody.sourceJson))")
        } catch let error {
            SFSDKCoreLogger().e(
                SfapApiClient.classForCoder(),
                message: "Cannot fetch generated text due to an error with message '\(error.localizedDescription)'.")
        }
    }

…dates)

bbirman · 2025-01-13T23:09:07Z

libs/SalesforceSDKCore/SalesforceSDKCore/Classes/RestAPI/SfapApi/SfapApiClient.swift

+        // Guards.
+        guard
+            let userAccountCurrent = UserAccountManager.shared.currentUserAccount,
+            let restClient = RestClient.restClient(for: userAccountCurrent) else {


Why is this getting a RestClient based on the current user vs using the RestClient from init?

Good catch. This guard lived somewhere else before I brought it to this file and I forgot to adjust it to scope. Thanks!

bbirman · 2025-01-13T23:29:32Z

libs/SalesforceSDKCore/SalesforceSDKCore/Classes/RestAPI/SfapApi/SfapApiClient.swift

+            let restClient = RestClient.restClient(for: userAccountCurrent) else {
+            throw sfapApiErrorWithMessage("Cannot invoke sfap_api client without a current user account.")}
+
+        guard let modelNameUnwrapped = modelName else {


if you don't want to rename it, I think you could also do guard let modelName { here

bbirman · 2025-01-13T23:37:08Z

libs/SalesforceSDKCore/SalesforceSDKCore/Classes/RestAPI/SfapApi/SfapApiClient.swift

+                do {
+                    return try sfapApiGenerationsResponse.asDecodable(type: SfapApiGenerationsResponseBody.self)
+                } catch let error {
+                    throw sfapApiErrorWithMessage("Cannot JSON decode sfap_api generations response body due to a decoding error with description '\(error.localizedDescription)'.")


I'm a little confused with the error handling, why does the error need to be caught and re-thrown?

I like a re-throw here, also. I'll get that in. Thanks!

bbirman · 2025-01-13T23:58:40Z

libs/SalesforceSDKCore/SalesforceSDKCore/Classes/RestAPI/SfapApi/SfapApiError.swift

+/// @param messageCode The `sfap_api` error code
+/// @param source The original `sfap_api` error response body
+@objc
+public class SfapApiError : NSError, @unchecked Sendable {


Why does this use NSError? Was there an issue with Swift's error type?

Looks like it'd be alright with Swift's error type. I also made some matching changes I used on Android to make the sfap_api errorCode, message, messageCode and the original error response JSON available to the caller. Those were all pull request feedback items on that side, so hopefully those are valuable as matching developer experience here for iOS. Here's a screenshot of what catching an sfap_api error response looks like in the AppDelegate of iOSNativeSwiftTemplate. This specific case shows what would happen in the request had a malformed parameter, for example. sfap_api has a detailed response for that.

…dates)

JohnsonEricAtSalesforce · 2025-01-14T18:12:33Z

libs/SalesforceSDKCore/SalesforceSDKCore/Classes/RestAPI/SfapApi/SfapApiClient.swift

+                underlyingError: _,
+                urlResponse: _
+            ): if let errorResponseData = response as? Data {
+                let sfapApiErrorResponseBody = try JSONDecoder().decode(SfapApiErrorResponseBody.self, from: errorResponseData)


@bbirman - I noticed we have an Error enum here on the iOS side. It looks like we could use .apiFailed as a chance to receive the Data and decode that to the documented error structure in the sfap_api doc and surface any valuable feedback to the client. The other cases could just re-throw. How does that look? On the Android side, we did create a type for the error responses much like this including the original error response's JSON source.

sounds good!

bbirman · 2025-01-14T21:24:06Z

libs/SalesforceSDKCore/SalesforceSDKCore/Classes/RestAPI/SfapApi/SfapApiClient.swift

+import Foundation
+
+@objc(SFApApiClient)
+public class SfapApiClient : NSObject {


not important for the draft but I'm wondering if "Api" should be all caps to match SFRestAPI

@W-16589742: [iOS] REST wrappers for select SFAP APIs

7d974c3

JohnsonEricAtSalesforce self-assigned this Jan 13, 2025

@W-16589742: [iOS] REST wrappers for select SFAP APIs (Self-Review Up…

a401e1a

…dates)

bbirman reviewed Jan 13, 2025

View reviewed changes

bbirman reviewed Jan 14, 2025

View reviewed changes

@W-16589742: [iOS] REST wrappers for select SFAP APIs (Team-Review Up…

70101dc

…dates)

JohnsonEricAtSalesforce commented Jan 14, 2025

View reviewed changes

bbirman reviewed Jan 14, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

@W-16589742: [iOS] REST wrappers for select SFAP APIs #3801

@W-16589742: [iOS] REST wrappers for select SFAP APIs #3801

JohnsonEricAtSalesforce commented Jan 13, 2025 •

edited

Loading

bbirman Jan 13, 2025

JohnsonEricAtSalesforce Jan 14, 2025

bbirman Jan 13, 2025

JohnsonEricAtSalesforce Jan 14, 2025

bbirman Jan 13, 2025

JohnsonEricAtSalesforce Jan 14, 2025

bbirman Jan 13, 2025

JohnsonEricAtSalesforce Jan 14, 2025

JohnsonEricAtSalesforce Jan 14, 2025

bbirman Jan 14, 2025

bbirman Jan 14, 2025

@W-16589742: [iOS] REST wrappers for select SFAP APIs #3801

Are you sure you want to change the base?

@W-16589742: [iOS] REST wrappers for select SFAP APIs #3801

Conversation

JohnsonEricAtSalesforce commented Jan 13, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JohnsonEricAtSalesforce commented Jan 13, 2025 •

edited

Loading