Installation Guide for Fullstory SwiftUI Automatic Selector Preview

Repeat this step for every Xcode Target that contains custom SwiftUI Views (structs that implement the View protocol). This step does not instrument Swift Packages - please use the steps for Build Phase, below, to instrument packages.

1. In the project navigator, select your App’s Project, then select your Target in the editor panel
2. Open the Build Rules tab, click the + button (next to "All") to add a rule to the top

   • Choose to process Swift source files using Custom script and paste the script below, including all quotes, as a single line, to run FullStorySwiftUITransformer in Fullstory SDK's tools folder (sample below shows when Fullstory is added via Swift Package Manager):

     "${BUILD_DIR%Build/*}SourcePackages/artifacts/fullstory-swift-package-ios/FullStory/tools/FullStorySwiftUITransformer" "$SCRIPT_INPUT_FILE" "$DERIVED_FILE_DIR/${INPUT_FILE_BASE}_transformed.swift"

   • Under "Output Files" section of the rule, click + and edit the rule to say $(DERIVED_FILE_DIR)/$(INPUT_FILE_BASE)_transformed.swift
3. Click the + button again to add another rule above the one you just added.
   • Choose Process  > Source files with names matching: enter *_transformed.swift.
   • Choose Using > Swift Compiler.

4. Resulting Build Rules should look like below (note that the ordering is important).

   

5. Run the Build and in the Build output, you should see your source being transformed and the transformed source files generated by Swift compiler:

   

   Note that FullStorySwiftUITransformer generates new source files that are not checked into the source repository. Because of this, debugging breakpoints added to the original source will not be hit. If this is not desired, one way to work around this is to remove the build step in a Git branch, and checkout this branch whenever debugging is needed. (Make sure to rebase the branch as needed to keep it up to date!)

6. The Build output pane in Xcode will allow you to view the transformed files (e.g. go to All Messages and double-click on a Compile MyView_transformed.swift message).

   

   The instructions above add the _transformed suffix to each file's name before the file extension; for example, MyView.swift becomes MyView_transformed.swift. This will change the way the files are reported by any tools that use the compiled file names, for example, in crash reports. However, the FullStorySwiftUITransformer should preserve the existing line numbers of your files for crash reporting or other purposes. In addition, type names will remain the same, and the only change to a variable is made to the body property of each SwiftUI View struct.

   You may use a different suffix than _transformed if you wish, as long as it will uniquely identify transformed SwiftUI files. For example, if none of your SwiftUI files end in an underscore _ , you could make the suffix just the underscore character.

With this method, you can support Swift Packages and/or Debug Breakpoints by pre-transforming the source in your project, which means all transformations will remain in your source repository. All transformations live within /*Fullstory_XFORM_start*/ and /*Fullstory_XFORM_end*/ for easy identification and removal, if needed. The Build phase can transform the Swift Package source artifacts and/or pre-transform the source in your project.

1. In the project navigator, select your App’s Project, then select your Target in the editor panel
2. Open the Build Phases tab, click the + button to add a New Run Script Phase
3. Drag the phase to the top of the list of phases, before Compile Sources

4. To transform Swift Packages, paste the script below, including all quotes, as a single line, to run FullStorySwiftUITransformer in Fullstory SDK's tools folder (sample below shows when Fullstory is added via Swift Package Manager):

   find "${BUILD_DIR%Build/*}SourcePackages/checkouts" -type f -name "*.swift" | tr \\n \\0 | xargs -S 1048576 -P $(sysctl -n hw.ncpu) -0 -n 1 -I % "${BUILD_DIR%Build/*}SourcePackages/artifacts/fullstory-swift-package-ios/FullStory/tools/FullStorySwiftUITransformer" "%" "%"

5. To transform your project's source code, similarly paste the script below, including all quotes, as a single line:

   find . -type f -name "*.swift" | tr \\n \\0 | xargs -S 1048576 -P $(sysctl -n hw.ncpu) -0 -n 1 -I % "${BUILD_DIR%Build/*}SourcePackages/artifacts/fullstory-swift-package-ios/FullStory/tools/FullStorySwiftUITransformer" "%" "%"

In addition, when transforming Swift Packages, it may help to reset package caches before building. Otherwise, your app may build with a cached copy of the package instead of the transformed package source.