Skip to content

[Vertex AI] Silence SafetyRating: Comparable warning in tests #13635

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 13, 2024
Merged

[Vertex AI] Silence SafetyRating: Comparable warning in tests #13635

merged 1 commit into from
Sep 13, 2024

Conversation

andrewheard
Copy link
Contributor

Silenced the followed warning on on extension SafetyRating: Comparable:

Extension declares a conformance of imported type 'SafetyRating' to imported protocol 'Comparable'; this will not behave correctly if the owners of 'FirebaseVertexAI' introduce this conformance in the future

SafetyRating does not have a natural ordering because its property let category: SafetySetting.HarmCategory does not (e.g., dangerousContent can't be compared as being greater than or equal to harassment):

firebase-ios-sdk/FirebaseVertexAI/Sources/Safety.swift

Lines 84 to 102 in 9e53732

public enum HarmCategory: String, Sendable {
/// Unknown. A new server value that isn't recognized by the SDK.
case unknown = "HARM_CATEGORY_UNKNOWN"
/// Unspecified by the server.
case unspecified = "HARM_CATEGORY_UNSPECIFIED"
/// Harassment content.
case harassment = "HARM_CATEGORY_HARASSMENT"
/// Negative or harmful comments targeting identity and/or protected attributes.
case hateSpeech = "HARM_CATEGORY_HATE_SPEECH"
/// Contains references to sexual acts or other lewd content.
case sexuallyExplicit = "HARM_CATEGORY_SEXUALLY_EXPLICIT"
/// Promotes or enables access to harmful goods, services, or activities.
case dangerousContent = "HARM_CATEGORY_DANGEROUS_CONTENT"
}

For this reason, it is reasonable to assume that we will not add Comparable conformance to SafetyRating in the SDK and the warning can be ignored with Swift.Comparable in the unit-test.

Note: Swift.Comparable is equivalent to @retroactive Comparable but is supported prior to Swift 6 (see SE-0364 for more details).

#no-changelog

@andrewheard andrewheard requested a review from ncooke3 September 13, 2024 16:14
ncooke3
ncooke3 approved these changes Sep 13, 2024
View reviewed changes
Copy link
Member

@ncooke3 ncooke3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice summary of the issue!

@andrewheard andrewheard merged commit e81ea8e into main Sep 13, 2024
32 checks passed
@andrewheard andrewheard deleted the ah/vertex-ext-warn branch September 13, 2024 18:56
This was referenced Sep 30, 2024
Closed
Merged
Merged
@firebase firebase locked and limited conversation to collaborators Oct 14, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@ncooke3 ncooke3 ncooke3 approved these changes

Assignees
No one assigned
Labels
api: firebaseai
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@andrewheard @ncooke3 @google-oss-bot