Merge pull request #61281 from LucianoPAlmeida/fix-it-edit-platform

[Diagnostics] Suggest platform correction based on known platforms edit distance

Author: swift-ci

include/swift/AST/PlatformKind.h

@@ -41,9 +41,10 @@ StringRef platformString(PlatformKind platform);
 /// or None if such a platform kind does not exist.
 Optional<PlatformKind> platformFromString(StringRef Name);
 
-/// Returns a valid platform string if the candidate string would be a valid
-/// platform string if its case were adjusted (e.g. "macos" -> "macOS").
-Optional<StringRef> caseCorrectedPlatformString(StringRef candidate);
+/// Returns a valid platform string that is closest to the candidate string
+/// based on edit distance. Returns \c None if the closest valid platform
+/// distance is not within a minimum threshold.
+Optional<StringRef> closestCorrectedPlatformString(StringRef candidate);
 
 /// Returns a human-readable version of the platform name as a string, suitable
 /// for emission in diagnostics (e.g., "macOS").

lib/AST/PlatformKind.cpp

@@ -58,13 +58,28 @@ Optional<PlatformKind> swift::platformFromString(StringRef Name) {
       .Default(Optional<PlatformKind>());
 }
 
-Optional<StringRef> swift::caseCorrectedPlatformString(StringRef candidate) {
+Optional<StringRef> swift::closestCorrectedPlatformString(StringRef candidate) {
+  auto lowerCasedCandidate = candidate.lower();
+  auto lowerCasedCandidateRef = StringRef(lowerCasedCandidate);
+  auto minDistance = std::numeric_limits<unsigned int>::max();
+  Optional<StringRef> result = None;
 #define AVAILABILITY_PLATFORM(X, PrettyName)                                   \
-  if (candidate.compare_insensitive(#X) == 0) {                                \
-    return StringRef(#X);                                                      \
+  {                                                                            \
+    auto platform = StringRef(#X);                                             \
+    auto distance = lowerCasedCandidateRef.edit_distance(platform.lower());    \
+    if (distance == 0) {                                                       \
+      return platform;                                                         \
+    }                                                                          \
+    if (distance < minDistance) {                                              \
+      minDistance = distance;                                                  \
+      result = platform;                                                       \
+    }                                                                          \
   }
 #include "swift/AST/PlatformKinds.def"
-  return None;
+  // If the most similar platform distance is greater than this threshold,
+  // it's not similar enough to be suggested as correction.
+  const unsigned int distanceThreshold = 5;
+  return (minDistance < distanceThreshold) ? result : None;
 }
 
 static bool isApplicationExtensionPlatform(PlatformKind Platform) {

lib/Parse/ParseDecl.cpp

@@ -567,7 +567,7 @@ ParserResult<AvailableAttr> Parser::parseExtendedAvailabilitySpecList(
   if (AnyArgumentInvalid)
     return nullptr;
   if (!PlatformKind.hasValue()) {
-    if (auto CorrectedPlatform = caseCorrectedPlatformString(Platform)) {
+    if (auto CorrectedPlatform = closestCorrectedPlatformString(Platform)) {
       diagnose(PlatformLoc, diag::attr_availability_suggest_platform, Platform,
                AttrName, *CorrectedPlatform)
           .fixItReplace(SourceRange(PlatformLoc), *CorrectedPlatform);
@@ -1845,7 +1845,7 @@ ParserStatus Parser::parsePlatformVersionInList(StringRef AttrName,
   consumeToken();
 
   if (!MaybePlatform.hasValue()) {
-    if (auto correctedPlatform = caseCorrectedPlatformString(platformText)) {
+    if (auto correctedPlatform = closestCorrectedPlatformString(platformText)) {
       diagnose(PlatformLoc, diag::attr_availability_suggest_platform,
                platformText, AttrName, *correctedPlatform)
           .fixItReplace(SourceRange(PlatformLoc), *correctedPlatform);

lib/Parse/ParseExpr.cpp

@@ -3953,7 +3953,7 @@ Parser::parsePlatformVersionConstraintSpec() {
 
   if (!Platform.hasValue() || Platform.getValue() == PlatformKind::none) {
     if (auto CorrectedPlatform =
-            caseCorrectedPlatformString(PlatformIdentifier.str())) {
+            closestCorrectedPlatformString(PlatformIdentifier.str())) {
       diagnose(PlatformLoc, diag::avail_query_suggest_platform_name,
                PlatformIdentifier, *CorrectedPlatform)
           .fixItReplace(PlatformLoc, *CorrectedPlatform);

test/Parse/availability_query.swift

@@ -49,6 +49,15 @@ if #available(iDishwasherOS 10.51, *) { // expected-warning {{unrecognized platf
 if #available(macos 10.51, *) { // expected-warning {{unrecognized platform name 'macos'; did you mean 'macOS'?}} {{15-20=macOS}}
 }
 
+if #available(mscos 10.51, *) { // expected-warning {{unrecognized platform name 'mscos'; did you mean 'macOS'?}} {{15-20=macOS}}
+}
+
+if #available(macoss 10.51, *) { // expected-warning {{unrecognized platform name 'macoss'; did you mean 'macOS'?}} {{15-21=macOS}}
+}
+
+if #available(mac 10.51, *) { // expected-warning {{unrecognized platform name 'mac'; did you mean 'macOS'?}} {{15-18=macOS}}
+}
+
 if #available(OSX 10.51, OSX 10.52, *) {  // expected-error {{version for 'macOS' already specified}}
 }
 

test/Parse/availability_query_unavailability.swift

@@ -46,6 +46,15 @@ if #unavailable(iDishwasherOS 10.51) { // expected-warning {{unrecognized platfo
 if #unavailable(macos 10.51) { // expected-warning {{unrecognized platform name 'macos'; did you mean 'macOS'?}} {{17-22=macOS}}
 }
 
+if #unavailable(mscos 10.51) { // expected-warning {{unrecognized platform name 'mscos'; did you mean 'macOS'?}} {{17-22=macOS}}
+}
+
+if #unavailable(macoss 10.51) { // expected-warning {{unrecognized platform name 'macoss'; did you mean 'macOS'?}} {{17-23=macOS}}
+}
+
+if #unavailable(mac 10.51) { // expected-warning {{unrecognized platform name 'mac'; did you mean 'macOS'?}} {{17-20=macOS}}
+}
+
 if #unavailable(OSX 10.51, OSX 10.52) {  // expected-error {{version for 'macOS' already specified}}
 }
 

test/Sema/diag_originally_definedin.swift

@@ -31,6 +31,26 @@ public func macroUnknown() {}
 // expected-error@-1 {{expected at least one platform version in '@_originallyDefinedIn' attribute}}
 public func incorrectPlatformCase() {}
 
+@available(macOS 10.9, *)
+@_originallyDefinedIn(module: "original", mscos 10.13) // expected-warning {{unknown platform 'mscos' for attribute '@_originallyDefinedIn'; did you mean 'macOS'?}} {{43-48=macOS}}
+// expected-error@-1 {{expected at least one platform version in '@_originallyDefinedIn' attribute}}
+public func incorrectPlatformSimilar1() {}
+
+@available(macOS 10.9, *)
+@_originallyDefinedIn(module: "original", macoss 10.13) // expected-warning {{unknown platform 'macoss' for attribute '@_originallyDefinedIn'; did you mean 'macOS'?}} {{43-49=macOS}}
+// expected-error@-1 {{expected at least one platform version in '@_originallyDefinedIn' attribute}}
+public func incorrectPlatformSimilar2() {}
+
+@available(macOS 10.9, *)
+@_originallyDefinedIn(module: "original", mac 10.13) // expected-warning {{unknown platform 'mac' for attribute '@_originallyDefinedIn'; did you mean 'macOS'?}} {{43-46=macOS}}
+// expected-error@-1 {{expected at least one platform version in '@_originallyDefinedIn' attribute}}
+public func incorrectPlatformSimilar3() {}
+
+@available(macOS 10.9, *)
+@_originallyDefinedIn(module: "original", notValid 10.13) // expected-warning {{unknown platform 'notValid' for attribute '@_originallyDefinedIn'}} {{none}}
+// expected-error@-1 {{expected at least one platform version in '@_originallyDefinedIn' attribute}}
+public func incorrectPlatformNotSimilar() {}
+
 @available(macOS 10.9, *)
 @_originallyDefinedIn(module: "original", swift 5.1) // expected-warning {{unknown platform 'swift' for attribute '@_originallyDefinedIn'}}
 // expected-error@-1 {{expected at least one platform version in '@_originallyDefinedIn' attribute}}

test/attr/attr_availability.swift

@@ -23,6 +23,18 @@ func unavailable_bad_platform() {}
 @available(macos, unavailable) // expected-warning {{unknown platform 'macos' for attribute 'available'; did you mean 'macOS'?}} {{12-17=macOS}}
 func incorrect_platform_case() {}
 
+@available(mscos, unavailable) // expected-warning {{unknown platform 'mscos' for attribute 'available'; did you mean 'macOS'?}} {{12-17=macOS}}
+func incorrect_platform_similar1() {}
+
+@available(macoss, unavailable) // expected-warning {{unknown platform 'macoss' for attribute 'available'; did you mean 'macOS'?}} {{12-18=macOS}}
+func incorrect_platform_similar2() {}
+
+@available(mac, unavailable) // expected-warning {{unknown platform 'mac' for attribute 'available'; did you mean 'macOS'?}} {{12-15=macOS}}
+func incorrect_platform_similar3() {}
+
+@available(notValid, unavailable) // expected-warning {{unknown platform 'notValid' for attribute 'available'}} {{none}}
+func incorrect_platform_not_similar() {}
+
 // Handle unknown platform.
 @available(HAL9000, unavailable) // expected-warning {{unknown platform 'HAL9000'}}
 func availabilityUnknownPlatform() {}
@@ -234,6 +246,10 @@ func shortFormWithTwoUnrecognizedPlatforms() {
 func shortFormWithTwoPlatformsIncorrectCase() {
 }
 
+@available(os 8.0, *)
+// expected-warning@-1 {{unrecognized platform name 'os'; did you mean 'iOS'?}} {{12-14=iOS}}
+func iosIsClosestThanMacOS() {}
+
 // Make sure that even after the parser hits an unrecognized
 // platform it validates the availability.
 @available(iOS 8.0, iDishwasherOS 22.0, iOS 9.0, *)

test/attr/attr_backDeploy.swift

@@ -257,6 +257,10 @@ public func transparentFunc() {}
 @_backDeploy(before: macos 12.0, iOS 15.0) // expected-warning {{unknown platform 'macos' for attribute '@_backDeploy'; did you mean 'macOS'?}} {{22-27=macOS}}
 public func incorrectPlatformCaseFunc() {}
 
+@available(macOS 11.0, iOS 14.0, *)
+@_backDeploy(before: mscos 12.0, iOS 15.0) // expected-warning {{unknown platform 'mscos' for attribute '@_backDeploy'; did you mean 'macOS'?}} {{22-27=macOS}}
+public func incorrectPlatformSimilarFunc() {}
+
 @available(macOS 11.0, *)
 @_backDeploy(before: macOS 12.0, unknownOS 1.0) // expected-warning {{unknown platform 'unknownOS' for attribute '@_backDeploy'}}
 public func unknownOSFunc() {}

test/attr/spi_available.swift

@@ -14,3 +14,6 @@ public class SPIClass4 {} // expected-warning {{symbols that are @_spi_available
 
 @_spi_available(macos 10.15, *) // expected-warning {{unrecognized platform name 'macos'; did you mean 'macOS'?}} {{17-22=macOS}}
 public class SPIClass5 {}
+
+@_spi_available(mscos 10.15, *) // expected-warning {{unrecognized platform name 'mscos'; did you mean 'macOS'?}} {{17-22=macOS}}
+public class SPIClass6 {}