swiftlint analyze appears to stop collecting after 12 files with Swift 5.10 #5517

chandlerwall · 2024-03-30T16:49:21Z

New Issue Checklist

Updated SwiftLint to the latest version
I searched for existing GitHub issues

Describe the bug

After upgrading to Xcode 15.3 and Swift 5.10, swiftlint analyze appears to stop collecting files. For my environment, the console output stops updating after collecting 12 files. If I adjust included or excluded to 12 or fewer files, I can reliably avoid the issue.

Complete output when running SwiftLint, including the stack trace and command used

MusicStacks-lint > swiftlint analyze --compiler-log-path .build/build.log
Analyzing Swift files in current working directory
Collecting 'View+hidden.swift' (2/30)
Collecting 'SomethingsWrong.swift' (1/30)
Collecting 'View+foregroundStyle.swift' (4/30)
Collecting 'View+dimensionOverlay.swift' (5/30)
Collecting 'ShowInMusicMenuButton.swift' (3/30)
Collecting 'Modules/Sources/StyleGuide/_exported.swift' (6/30)
Collecting 'View+firstTextCenterline.swift' (8/30)
Collecting 'ToolbarMenuButton.swift' (9/30)
Collecting 'ExplicitTitle.swift' (7/30)
Collecting 'View+enabled.swift' (10/30)
Collecting 'HeaderTitle.swift' (11/30)
Collecting 'LabelStyle.swift' (12/30)

Environment

SwiftLint version (run swiftlint version to be sure)?

0.53.0
Installation method used (Homebrew, CocoaPods, building from source, etc)?

Homebrew

Paste your configuration file:

included:
- iOS
- Modules

# only_rules:
#   - trailing_comma

disabled_rules:
  # - empty_enum_arguments
  - identifier_name # TODO: reconsider as warning to improve clarity of names
  - line_length
  - redundant_string_enum_value
  - todo
  - trailing_comma
  - type_name # TODO: reconsider as warning to improve clarity of names

opt_in_rules:
  - direct_return
  # - explicit_type_interface
  - implicit_return
  - sorted_imports

analyzer_rules:
  - capture_variable
  - explicit_self # --fix
  - unused_declaration
  # - unused_import # --fix

cyclomatic_complexity:
  warning: 11
  error: 29

force_cast:
  severity: warning

force_try:
  severity: warning

function_body_length:
  warning: 75
  # error: 100

nesting:
  type_level:
    warning: 3

type_body_length:
  warning: 300
  error: 500

# trailing_comma:
#   mandatory_comma: true

Are you using nested configurations?

No

Which Xcode version are you using (check xcodebuild -version)?

$ xcodebuild -version
Xcode 15.3
Build version 15E204a

$ swiftc --version
swift-driver version: 1.90.11.1 Apple Swift version 5.10 (swiftlang-5.10.0.13 clang-1500.3.9.4)
Target: arm64-apple-macosx14.0

Do you have a sample that shows the issue? Run echo "[string here]" | swiftlint lint --no-cache --use-stdin --enable-all-rules
to quickly test if your example is really demonstrating the issue. If your example is more
complex, you can use swiftlint lint --path [file here] --no-cache --enable-all-rules.

The issue is not related to a specific pattern of code.

The text was updated successfully, but these errors were encountered:

chandlerwall · 2024-03-30T17:10:15Z

I checked out SwiftLint's source to debug the issue a bit and found the cause: SwiftLintCore.SwiftVersion does not compare string versions reliably, preventing version-specific workarounds from being applied.

SwiftLint/Source/SwiftLintCore/Models/SwiftVersion.swift

Lines 5 to 17 in 6d2e582

    
           public struct SwiftVersion: RawRepresentable, Codable, Comparable { 
        
               public typealias RawValue = String 
        
               public let rawValue: String 
        
               public init(rawValue: String) { 
        
                   self.rawValue = rawValue 
        
               } 
        
               public static func < (lhs: SwiftVersion, rhs: SwiftVersion) -> Bool { 
        
                   return lhs.rawValue < rhs.rawValue 
        
               } 
        
           }

For Swift 5.10, version-specific workarounds are not applied correctly. Specifically, LintableFilesVisitor.parallel is assigned true instead of false when SwiftVersion.current < .fiveDotSix returns an incorrect value.

SwiftLint/Source/swiftlint/Helpers/LintableFilesVisitor.swift

Lines 99 to 108 in 6d2e582

    
           if let compilerInvocations { 
        
               self.mode = .analyze(allCompilerInvocations: compilerInvocations) 
        
               // SourceKit had some changes in 5.6 that makes it ~100x more expensive 
        
               // to process files concurrently. By processing files serially, it's 
        
               // only 2x slower than before. 
        
               self.parallel = SwiftVersion.current < .fiveDotSix 
        
           } else { 
        
               self.mode = .lint 
        
               self.parallel = true 
        
           }

I replaced SwiftVersion with the following:

/// A value describing the version of the Swift compiler.
public struct SwiftVersion: RawRepresentable, Codable, Comparable, Sendable {
    public typealias RawValue = String

    public let rawValue: String

    public init(rawValue: String) {
        self.rawValue = rawValue
    }

  public static func < (lhs: SwiftVersion, rhs: SwiftVersion) -> Bool {
      func versionComponents(from version: String) -> [Int] {
          return version.components(separatedBy: ".").compactMap { Int($0) }
      }

      let lhsComponents = versionComponents(from: lhs.rawValue)
      let rhsComponents = versionComponents(from: rhs.rawValue)

      for (lhsComponent, rhsComponent) in zip(lhsComponents, rhsComponents) {
          if lhsComponent < rhsComponent {
              return true
          } else if lhsComponent > rhsComponent {
              return false
          }
      }

      return lhsComponents.count < rhsComponents.count
  }
}

Note: I used Claude to implement static func < (lhs:rhs:). I wanted to save time while troubleshooting. The implementation may or may not handle edge cases correctly. I only verified the implementation for my environment.

With the changes in place, I'm able to run swiftlint analyze on a larger set of files. The run below was limited to 30 files. I also verified the result on a run with 350+ files.

Analyzing Swift files in current working directory
Collecting 'Modules/Sources/StyleGuide/_exported.swift' (1/30)
Collecting 'SomethingsWrong.swift' (2/30)
Collecting 'ToolbarMenuButton.swift' (3/30)
Collecting 'ShowInMusicMenuButton.swift' (4/30)
Collecting 'View+hidden.swift' (5/30)
Collecting 'View+foregroundStyle.swift' (6/30)
Collecting 'View+dimensionOverlay.swift' (7/30)
Collecting 'View+enabled.swift' (8/30)
Collecting 'View+firstTextCenterline.swift' (9/30)
Collecting 'HeaderTitle.swift' (10/30)
Collecting 'ExplicitTitle.swift' (11/30)
Collecting 'LabelStyle.swift' (12/30)
Collecting 'StyleGuide.swift' (13/30)
Collecting 'ActiveTrackIcon.swift' (14/30)
Collecting 'FontPreview.swift' (15/30)
Collecting 'CountsView.swift' (16/30)
Collecting 'NoSearchResults.swift' (17/30)
Collecting 'LibraryIcon.swift' (18/30)
Collecting 'PresentationState.swift' (19/30)
Collecting 'AlertPresentation.swift' (20/30)
Collecting 'ConfirmationDialogPresentation.swift' (21/30)
Collecting 'Symbol.swift' (22/30)
Collecting 'SearchControllerProxy.swift' (23/30)
Collecting 'EnvironmentAction.swift' (24/30)
Collecting 'Resolvable.swift' (25/30)
Collecting 'SearchableUIHostingController.swift' (26/30)
Collecting 'SearchScope.swift' (27/30)
Collecting 'RelativeTimeframe.swift' (28/30)
Collecting 'SimilarityResult.swift' (29/30)
Collecting 'Counts.swift' (30/30)
Analyzing 'Modules/Sources/StyleGuide/_exported.swift' (1/30)
Analyzing 'SomethingsWrong.swift' (2/30)
Analyzing 'ToolbarMenuButton.swift' (3/30)
Analyzing 'ShowInMusicMenuButton.swift' (4/30)
Analyzing 'View+hidden.swift' (5/30)
Analyzing 'View+foregroundStyle.swift' (6/30)
Analyzing 'View+dimensionOverlay.swift' (7/30)
Analyzing 'View+enabled.swift' (8/30)
Analyzing 'View+firstTextCenterline.swift' (9/30)
Analyzing 'HeaderTitle.swift' (10/30)
Analyzing 'ExplicitTitle.swift' (11/30)
Analyzing 'LabelStyle.swift' (12/30)
Analyzing 'StyleGuide.swift' (13/30)
Analyzing 'ActiveTrackIcon.swift' (14/30)
Analyzing 'FontPreview.swift' (15/30)
Analyzing 'CountsView.swift' (16/30)
Analyzing 'NoSearchResults.swift' (17/30)
Analyzing 'LibraryIcon.swift' (18/30)
Analyzing 'PresentationState.swift' (19/30)
Analyzing 'AlertPresentation.swift' (20/30)
Analyzing 'ConfirmationDialogPresentation.swift' (21/30)
Analyzing 'Symbol.swift' (22/30)
Analyzing 'SearchControllerProxy.swift' (23/30)
Analyzing 'EnvironmentAction.swift' (24/30)
Analyzing 'Resolvable.swift' (25/30)
Analyzing 'SearchableUIHostingController.swift' (26/30)
Analyzing 'SearchScope.swift' (27/30)
Analyzing 'RelativeTimeframe.swift' (28/30)
Analyzing 'SimilarityResult.swift' (29/30)
Analyzing 'Counts.swift' (30/30)
Done analyzing! Found 0 violations, 0 serious in 30 files.

SimplyDanny · 2024-03-30T17:12:37Z

Can the stop of analysis be associated with a specific file maybe?

chandlerwall · 2024-03-30T17:23:30Z

Can the stop of analysis be associated with a specific file maybe?

I started my troubleshooting by adjusting included and excluded to find a problematic file. I started with a small number of files and gradually included more files until the issue occurred. I thought I found the problematic file. I added more files and noticed the issue again. I tested different combinations and realized I could move "problematic" files from excluded to included without triggering the issue. As long as I keep the file count very low, the command finished. As soon as I added an extra file, the command chokes.

SimplyDanny · 2024-03-30T17:46:09Z

Forget my previous question. You were obviously a little faster with the detailed report of your investigation. I didn't notice it while crafting my message.

Your reasoning makes a lot of sense. Looks like SwiftVersion wasn't developed with version components >9 in mind or the implementors didn't expect such high numbers.

Would you like to open a PR to fix the comparison algorithm?

chandlerwall · 2024-03-30T20:18:18Z

Yes, I will prepare a PR with a fix for the comparison algorithm. Appreciate the quick responses!

NachoSoto · 2024-04-04T03:47:39Z

I'm seeing the exact same thing. For me it stops after 14 files, no matter what file that is.

chandlerwall changed the title ~~swiftlint analyze appears to stop collecting files with Swift 5.10~~ swiftlint analyze appears to stop collecting after 12 files with Swift 5.10 Mar 30, 2024

SimplyDanny added the bug Unexpected and reproducible misbehavior. label Mar 30, 2024

chandlerwall mentioned this issue Apr 4, 2024

Refactor SwiftVersion to support numeric version comparisons #5526

Merged

SimplyDanny closed this as completed in #5526 May 1, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

swiftlint analyze appears to stop collecting after 12 files with Swift 5.10 #5517

swiftlint analyze appears to stop collecting after 12 files with Swift 5.10 #5517

chandlerwall commented Mar 30, 2024 •

edited

Loading

chandlerwall commented Mar 30, 2024 •

edited

Loading

SimplyDanny commented Mar 30, 2024

chandlerwall commented Mar 30, 2024

SimplyDanny commented Mar 30, 2024

chandlerwall commented Mar 30, 2024

NachoSoto commented Apr 4, 2024

swiftlint analyze appears to stop collecting after 12 files with Swift 5.10 #5517

swiftlint analyze appears to stop collecting after 12 files with Swift 5.10 #5517

Comments

chandlerwall commented Mar 30, 2024 • edited Loading

New Issue Checklist

Describe the bug

Complete output when running SwiftLint, including the stack trace and command used

Environment

chandlerwall commented Mar 30, 2024 • edited Loading

SimplyDanny commented Mar 30, 2024

chandlerwall commented Mar 30, 2024

SimplyDanny commented Mar 30, 2024

chandlerwall commented Mar 30, 2024

NachoSoto commented Apr 4, 2024

chandlerwall commented Mar 30, 2024 •

edited

Loading

chandlerwall commented Mar 30, 2024 •

edited

Loading