[Fastlane.Swift] Allow overriding LaneFileProtocol lifecycles when subclassing LaneFile #20563

SvenTiigi · 2022-08-16T09:06:25Z

Checklist

I've run bundle exec rspec from the root directory to see all new and existing tests pass
I've followed the fastlane code style and run bundle exec rubocop -a to ensure the code style is valid
I see several green ci/circleci builds in the "All checks have passed" section of my PR (connect CircleCI to GitHub if not)
I've read the Contribution Guidelines
I've updated the documentation if necessary.

Motivation and Context

Resolves #21849

When using Fastlane.Swift in the context of a Swift Package the LaneFileProtocol lifecycles such as beforeAll, onError and afterAll can not be overridden by a subclass of LaneFile.

Package.swift

// swift-tools-version: 5.6

import PackageDescription

let package = Package(
    name: "FastlaneSwiftPackage",
    products: [
        .executable(
            name: "FastlaneSwiftPackage",
            targets: [
                "FastlaneSwiftPackage"
            ]
        )
    ],
    dependencies: [
        .package(
            url: "https://github.com/fastlane/fastlane",
            .exact("2.209.0")
        )
    ],
    targets: [
        .executableTarget(
            name: "FastlaneSwiftPackage",
            dependencies: [
                .product(
                    name: "Fastlane",
                    package: "fastlane"
                )
            ]
        )
    ]
)

import Foundation
import Fastlane

@main
class Fastfile: LaneFile {
    
    static func main() {
        Main().run(with: Fastfile())
    }
    
    // ❌ Method does not override any method from its superclass
    override func beforeAll(
        with lane: String
    ) {
        super.beforeAll(with: lane)
    }
    
    // ❌ Overriding non-open instance method outside of its defining module
    override func onError(
        currentLane: String,
        errorInfo: String,
        errorClass: String?,
        errorMessage: String?
    ) {
        super.onError(
            currentLane: currentLane,
            errorInfo: errorInfo,
            errorClass: errorClass,
            errorMessage: errorMessage
        )
    }
    
    // ❌ Method does not override any method from its superclass
    override func afterAll(
        with lane: String
    ) {
        super.afterAll(with: lane)
    }
    
}

Description

This PR changes the modifier of the onError function of the LaneFile from public to open to fix the Overriding non-open instance method outside of its defining module error (b9dba0a).

Additionally, the beforeAll and afterAll lifecycles have been added as open functions to the LaneFile to fix the Method does not override any method from its superclass error (f4f5380).

Allowing subclasses to override the onError function

Allowing subclasses to override the lifecycles

karthiikmk · 2022-12-05T17:31:55Z

Hi SvenTiigi, I have a quick doubt, I have made a new executable package by adding Fastlane spm as dependency.
I couldn't find any documentation on integrating the newly created executable package in my Xcode project to run the lanes.

Mostly I could find fastlane init swift which asked me to configure fastlane in my root folder with the new Fastfile.swift.
It would be really help if you share any example project or documentation to overriding
FastlaneRunner -project ./fastlane/swift/FastlaneSwiftRunner/FastlaneSwiftRunner.xcodeprojto my new executable package runner.

New exec Package.swift with my custom lanes.

let package = Package(
    name: "fastlaneRunner",
    products: [
        .executable(name: "fastlaneRunner", targets: ["fastlaneRunner"])
    ],
    dependencies: [
        .package(url: "https://github.com/fastlane/fastlane", .upToNextMinor(from: .init(2, 179, 0)))
    ],
    targets: [
        .executableTarget(
            name: "fastlaneRunner",
            dependencies: [
                .product(name: "Fastlane", package: "fastlane") 
            ],
            path: "Sources"
        )
    ]
)

pchmelar · 2023-02-07T13:33:23Z

Just bumped into this as I'm experimenting with Fastlane.swift via SPM.
Would be helpful to merge this, so we can define custom beforeAll / afterAll etc
@joshdholtz What do you think? 🙂

@karthikAdaptavant Not sure if I get your question, but you can either integrate the fastlaneRunner package with other packages in your project, or you can simply run the executable via swift run fastlaneRunner lane [yourLane] - see docs here https://docs.fastlane.tools/getting-started/ios/fastlane-swift/

pchmelar · 2023-07-12T18:52:56Z

I just discovered that when swift run fastlaneRunner lane [yourLane] fails with some error the exit code is 0. This present a serious issue when running on CI, as the job fails, but a pipeline doesn't stop. The solution would be to handle this in onError, but that's not possible when using Fastlane.swift via SPM. 😥

So.. can we please merge this PR? It's just a simple change. cc @mollyIV @janpio @joshdholtz

pchmelar · 2024-01-17T09:24:59Z

Bump, can we please merge this? It's the only major issue preventing us from using Fastlane.swift in production 😿
cc @mollyIV @janpio @joshdholtz

lacostej

Thanks for the nagging :)

Looks good to me, but I am not a Swift user, so I'll ask others in the team to review as well.

Thanks for your patience!

SvenTiigi · 2024-02-04T08:30:44Z

Just a small hint regarding the attached issue #21849:
This PR does not directly resolve the issue that when running Fastlane.swift via SPM e.g. swift run MyFastlaneSwiftExecutable lane myLane the execution always exits with a zero success code even when an error occurred.

So in addition to this PR it would be great to add an appropriate invocation of exit(EXIT_FAILURE) or fatalError around the following lines of code wrapped in a #if SWIFT_PACKAGE since this problem does not occur when running Fastlane.Swift via the "traditional" Fastlane Swift Runner started via the fastlane CLI.

fastlane/fastlane/swift/LaneFileProtocol.swift

Lines 144 to 149 in 26b695f

    
           if !LaneFile.onErrorCalled.contains(lane) { 
        
               fastfileInstance.afterAll(with: lane) 
        
           } 
        
           log(message: "Done running lane: \(lane) 🚀") 
        
           return true

There is a similar open PR #20552 to this problem.

rogerluan · 2024-02-10T14:16:23Z

@SvenTiigi thanks for all this valuable info 🙌 I like your approach to restrict the changes in the PR #20552 to Swift Packages only, do you think they work, though? I found this: https://forums.swift.org/t/unable-to-compile-swift-package-when-used-in-xcode/36081

SvenTiigi · 2024-02-10T14:31:37Z

@rogerluan since the #if SWIFT_PACKAGE preprocessor macro is already used in the LaneFileProtocol.swift file I think it should work properly 🤔

mwhrtin · 2024-02-21T08:22:06Z

This PR is not getting the attention it needs considering the issues it fixes, so I just want to chime in that we're also waiting on this. 🙂

We've also been experimenting with Fastlane.swift through SPM and the issues this PR is taking care of are the ones that are currently blocking us from trying it out in a live environment.

SvenTiigi · 2024-04-09T19:02:59Z

@rogerluan Do you have any updates on this PR's status?

pchmelar · 2024-04-27T08:46:37Z

@rogerluan @lacostej Can we please merge this? 🙏 Is there anything that needs to be done?

pchmelar · 2024-09-26T08:07:22Z

bump

mollyIV

Thanks for your contribution and so sorry it took sooo long to get to review it.

The changes are looking good. I was playing with it a bit and didn't spot any issues.

🚀 🚀

taquitos · 2024-09-28T14:42:06Z

Love it.

SvenTiigi added 2 commits August 16, 2022 09:51

Refactored onError to be open instead of public

b9dba0a

Allowing subclasses to override the onError function

Added beforeAll and afterAll lifecycles

f4f5380

Allowing subclasses to override the lifecycles

fastlane-bot added the status: needs-attention label Aug 30, 2022

pchmelar mentioned this pull request Feb 9, 2023

Use Fastlane.swift 🚀 MateeDevs/devstack-native-app#68

Merged

rogerluan added the topic: swift label Dec 27, 2023

pchmelar mentioned this pull request Feb 2, 2024

[Fastlane.Swift] When FastlaneRunner fails, the exit code is 0 instead of 1 #21849

Closed

4 tasks

lacostej approved these changes Feb 2, 2024

View reviewed changes

pchmelar mentioned this pull request Apr 29, 2024

✨ [KMM, AN, iOS] Shared error message mapping with Moko MateeDevs/devstack-native-app#100

Merged

pchmelar mentioned this pull request May 14, 2024

[Fastlane.Swift] Unusable for CI builds #22023

Open

4 tasks

mollyIV approved these changes Sep 28, 2024

View reviewed changes

mollyIV merged commit af0c597 into fastlane:master Sep 28, 2024

github-actions bot mentioned this pull request Oct 3, 2024

Version bump to 2.224.0 #22278

Merged

SvenTiigi mentioned this pull request Oct 4, 2024

[Fastlane.swift] fix issue where failing lanes would exit with a success exit code #20552

Open

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Fastlane.Swift] Allow overriding LaneFileProtocol lifecycles when subclassing LaneFile #20563

[Fastlane.Swift] Allow overriding LaneFileProtocol lifecycles when subclassing LaneFile #20563

Uh oh!

SvenTiigi commented Aug 16, 2022 •

edited by lacostej

Loading

Uh oh!

karthiikmk commented Dec 5, 2022 •

edited

Loading

Uh oh!

pchmelar commented Feb 7, 2023

Uh oh!

pchmelar commented Jul 12, 2023

Uh oh!

pchmelar commented Jan 17, 2024

Uh oh!

lacostej left a comment

Uh oh!

SvenTiigi commented Feb 4, 2024

Uh oh!

rogerluan commented Feb 10, 2024

Uh oh!

SvenTiigi commented Feb 10, 2024

Uh oh!

mwhrtin commented Feb 21, 2024

Uh oh!

SvenTiigi commented Apr 9, 2024

Uh oh!

pchmelar commented Apr 27, 2024

Uh oh!

pchmelar commented Sep 26, 2024

Uh oh!

mollyIV left a comment

Uh oh!

taquitos commented Sep 28, 2024

Uh oh!

Uh oh!

[Fastlane.Swift] Allow overriding LaneFileProtocol lifecycles when subclassing LaneFile #20563

[Fastlane.Swift] Allow overriding LaneFileProtocol lifecycles when subclassing LaneFile #20563

Uh oh!

Conversation

SvenTiigi commented Aug 16, 2022 • edited by lacostej Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Motivation and Context

Description

Uh oh!

karthiikmk commented Dec 5, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pchmelar commented Feb 7, 2023

Uh oh!

pchmelar commented Jul 12, 2023

Uh oh!

pchmelar commented Jan 17, 2024

Uh oh!

lacostej left a comment

Choose a reason for hiding this comment

Uh oh!

SvenTiigi commented Feb 4, 2024

Uh oh!

rogerluan commented Feb 10, 2024

Uh oh!

SvenTiigi commented Feb 10, 2024

Uh oh!

mwhrtin commented Feb 21, 2024

Uh oh!

SvenTiigi commented Apr 9, 2024

Uh oh!

pchmelar commented Apr 27, 2024

Uh oh!

pchmelar commented Sep 26, 2024

Uh oh!

mollyIV left a comment

Choose a reason for hiding this comment

Uh oh!

taquitos commented Sep 28, 2024

Uh oh!

Uh oh!

SvenTiigi commented Aug 16, 2022 •

edited by lacostej

Loading

karthiikmk commented Dec 5, 2022 •

edited

Loading