Initiating a Locale/Language with empty language code/script/region results in an unreasonable locale. (#1102)

* Initiating a Locale/Language with empty language code/script/region results in an unreasonable locale.

Here are some examples:

```swift
print(Locale(languageCode: "", script: "", languageRegion: "").identifier) // "-_"

let languageComponents = Locale.Language.Components(language: .init(identifier:""))
print(Locale(languageComponents: languageComponents).identifier) // "-Latn"
```

Fix this by handling empty identifiers passed in at initialization time correctly.

resolves 132353443

* Use `isEmpty` check for empty strings

Author: itingliu

Sources/FoundationEssentials/Locale/Locale+Language.swift

@@ -38,11 +38,11 @@ extension Locale {
                 if let languageCode = languageCode {
                     result += languageCode._normalizedIdentifier
                 }
-                if let script = script {
+                if let script = script, !script.identifier.isEmpty {
                     result += "-"
                     result += script._normalizedIdentifier
                 }
-                if let region = region {
+                if let region = region, !region.identifier.isEmpty {
                     result += "_"
                     result += region._normalizedIdentifier
                 }

Sources/FoundationInternationalization/Locale/Locale+Components_ICU.swift

@@ -525,6 +525,11 @@ extension Locale.Language {
     public var minimalIdentifier : String {
         let componentsIdentifier = components.identifier
 
+        guard !componentsIdentifier.isEmpty else {
+            // Just return "". Nothing to reduce.
+            return componentsIdentifier
+        }
+
         let localeIDWithLikelySubtags = _withFixedCharBuffer { buffer, size, status in
             return uloc_minimizeSubtags(componentsIdentifier, buffer, size, &status)
         }
@@ -543,6 +548,11 @@ extension Locale.Language {
     /// Returns a BCP-47 identifier that always includes the script: "zh-Hant-TW", "en-Latn-US"
     public var maximalIdentifier : String {
         let id = components.identifier
+        guard !id.isEmpty else {
+            // Just return "" instead of trying to fill it up
+            return id
+        }
+
         let localeIDWithLikelySubtags = _withFixedCharBuffer { buffer, size, status in
             return uloc_addLikelySubtags(id, buffer, size, &status)
         }

Tests/FoundationInternationalizationTests/LocaleTests.swift

@@ -165,6 +165,14 @@ final class LocaleTests : XCTestCase {
             return Locale.Components(identifier: "")
         }
 
+        verify(cldr: "root", bcp47: "und", icu: "") {
+            return Locale.Components(languageCode: "", script: "", languageRegion: "")
+        }
+
+        verify(cldr: "root", bcp47: "und", icu: "") {
+            return Locale.Components(languageCode: nil, script: nil, languageRegion: nil)
+        }
+
         verify(cldr: "und_US", bcp47: "und-US", icu: "_US") {
             return Locale.Components(languageRegion: .unitedStates)
         }
@@ -370,6 +378,110 @@ final class LocaleTests : XCTestCase {
         let result = Locale.identifier(fromWindowsLocaleCode: -1)
         XCTAssertNil(result)
     }
+
+    func test_emptyComponents() throws {
+
+        let emptyLocale = Locale(identifier: "")
+        XCTAssertEqual(emptyLocale.language.languageCode, nil)
+        XCTAssertEqual(emptyLocale.language.script, nil)
+        XCTAssertEqual(emptyLocale.language.region, nil)
+        XCTAssertEqual(emptyLocale.language.maximalIdentifier, "")
+        XCTAssertEqual(emptyLocale.language.minimalIdentifier, "")
+        XCTAssertEqual(emptyLocale.identifier, "")
+
+        let localeFromEmptyComp = Locale(components: Locale.Components(identifier: ""))
+        XCTAssertEqual(localeFromEmptyComp.language.languageCode, nil)
+        XCTAssertEqual(localeFromEmptyComp.language.script, nil)
+        XCTAssertEqual(localeFromEmptyComp.language.region, nil)
+        XCTAssertEqual(localeFromEmptyComp.language.maximalIdentifier, "")
+        XCTAssertEqual(localeFromEmptyComp.language.minimalIdentifier, "")
+        XCTAssertEqual(localeFromEmptyComp.identifier, "")
+
+        let localeFromEmptyLanguageComponent = Locale(languageComponents: .init(identifier: ""))
+        XCTAssertEqual(localeFromEmptyLanguageComponent.language.languageCode, nil)
+        XCTAssertEqual(localeFromEmptyLanguageComponent.language.script, nil)
+        XCTAssertEqual(localeFromEmptyLanguageComponent.language.region, nil)
+        XCTAssertEqual(localeFromEmptyLanguageComponent.language.maximalIdentifier, "")
+        XCTAssertEqual(localeFromEmptyLanguageComponent.language.minimalIdentifier, "")
+        XCTAssertEqual(localeFromEmptyLanguageComponent.identifier, "")
+
+        let localeFromEmptyLanguageComponentIndividual = Locale(languageComponents: .init(languageCode: "", script: "", region: ""))
+        XCTAssertEqual(localeFromEmptyLanguageComponentIndividual.language.languageCode, nil)
+        XCTAssertEqual(localeFromEmptyLanguageComponentIndividual.language.script, nil)
+        XCTAssertEqual(localeFromEmptyLanguageComponentIndividual.language.region, nil)
+        XCTAssertEqual(localeFromEmptyLanguageComponentIndividual.language.maximalIdentifier, "")
+        XCTAssertEqual(localeFromEmptyLanguageComponentIndividual.language.minimalIdentifier, "")
+        XCTAssertEqual(localeFromEmptyLanguageComponentIndividual.identifier, "")
+
+        let localeFromEmptyIndividualLanguageComponent = Locale(languageCode: "", script: "", languageRegion: "")
+        XCTAssertEqual(localeFromEmptyIndividualLanguageComponent.language.languageCode, nil)
+        XCTAssertEqual(localeFromEmptyIndividualLanguageComponent.language.script, nil)
+        XCTAssertEqual(localeFromEmptyIndividualLanguageComponent.language.region, nil)
+        XCTAssertEqual(localeFromEmptyIndividualLanguageComponent.language.maximalIdentifier, "")
+        XCTAssertEqual(localeFromEmptyIndividualLanguageComponent.language.minimalIdentifier, "")
+        XCTAssertEqual(localeFromEmptyIndividualLanguageComponent.identifier, "")
+
+        // Locale.Component
+        let compFromEmptyLocale = Locale.Components(locale: emptyLocale)
+        XCTAssertEqual(compFromEmptyLocale.languageComponents.languageCode, nil)
+        XCTAssertEqual(compFromEmptyLocale.languageComponents.script, nil)
+        XCTAssertEqual(compFromEmptyLocale.languageComponents.region, nil)
+
+        let emptyComp = Locale.Components(identifier: "")
+        XCTAssertEqual(emptyComp.languageComponents.languageCode, nil)
+        XCTAssertEqual(emptyComp.languageComponents.script, nil)
+        XCTAssertEqual(emptyComp.languageComponents.region, nil)
+
+        // Language
+        let emptyLanguage = Locale.Language(identifier: "")
+        XCTAssertEqual(emptyLanguage.languageCode, nil)
+        XCTAssertEqual(emptyLanguage.script, nil)
+        XCTAssertEqual(emptyLanguage.region, nil)
+        XCTAssertEqual(emptyLanguage.maximalIdentifier, "")
+        XCTAssertEqual(emptyLanguage.minimalIdentifier, "")
+
+        let languageFromEmptyComponents = Locale.Language(components: .init(identifier: ""))
+        XCTAssertEqual(languageFromEmptyComponents.languageCode, nil)
+        XCTAssertEqual(languageFromEmptyComponents.script, nil)
+        XCTAssertEqual(languageFromEmptyComponents.region, nil)
+        XCTAssertEqual(languageFromEmptyComponents.maximalIdentifier, "")
+        XCTAssertEqual(languageFromEmptyComponents.minimalIdentifier, "")
+
+        let languageFromEmptyComponents2 = Locale.Language(components: .init(languageCode: "", script: "", region: ""))
+        XCTAssertEqual(languageFromEmptyComponents2.languageCode, "")
+        XCTAssertEqual(languageFromEmptyComponents2.script, "")
+        XCTAssertEqual(languageFromEmptyComponents2.region, "")
+        XCTAssertEqual(languageFromEmptyComponents2.maximalIdentifier, "")
+        XCTAssertEqual(languageFromEmptyComponents2.minimalIdentifier, "")
+
+        // Language.Component
+        let languageCompFromEmptyLanguage = Locale.Language.Components(language: Locale.Language(identifier: ""))
+        XCTAssertEqual(languageCompFromEmptyLanguage.languageCode, nil)
+        XCTAssertEqual(languageCompFromEmptyLanguage.script, nil)
+        XCTAssertEqual(languageCompFromEmptyLanguage.region, nil)
+
+        let emptyLanguageComponents = Locale.Language.Components(identifier: "")
+        XCTAssertEqual(emptyLanguageComponents.languageCode, nil)
+        XCTAssertEqual(emptyLanguageComponents.script, nil)
+        XCTAssertEqual(emptyLanguageComponents.region, nil)
+
+        let emptyLanguageComponents2 = Locale.Language.Components(languageCode: "", script: "", region: "")
+        XCTAssertEqual(emptyLanguageComponents2.languageCode, "")
+        XCTAssertEqual(emptyLanguageComponents2.script, "")
+        XCTAssertEqual(emptyLanguageComponents2.region, "")
+    }
+
+    func test_nilComponents() {
+        let nilLanguageComponents = Locale.Language.Components(languageCode: nil, script: nil, region: nil)
+        XCTAssertEqual(nilLanguageComponents.languageCode, nil)
+        XCTAssertEqual(nilLanguageComponents.script, nil)
+        XCTAssertEqual(nilLanguageComponents.region, nil)
+
+        let nilLanguage = Locale.Language(languageCode: nil, script: nil, region: nil)
+        XCTAssertEqual(nilLanguage.languageCode, nil)
+        XCTAssertEqual(nilLanguage.script, nil)
+        XCTAssertEqual(nilLanguage.region, nil)
+    }
 }
 
 final class LocalePropertiesTests : XCTestCase {
@@ -417,6 +529,8 @@ final class LocalePropertiesTests : XCTestCase {
         verify(components: Locale.Components(languageCode: "zh", script: "Hant", languageRegion: "TW"), identifier: "zh_TW")
         verify(components: Locale.Components(languageCode: "zh", script: "Hans", languageRegion: "TW"), identifier: "zh-Hans_TW")
 
+        verify(components: .init(languageCode: "", script: "", languageRegion: ""), identifier: "")
+
         var custom = Locale.Components(languageCode: "en", languageRegion: "US")
         custom.measurementSystem = .metric
         custom.currency = "GBP"