Address minor mobile deployment bugs

[transphorm]

Summary

• add APP_NAME constant and use for Slack artifact titles
• note only external TestFlight groups are allowed
• validate Slack channel ID before uploading
• add cleanup script for local iOS builds
• document cleanup step and TestFlight group requirement
• test Slack validation and cleanup script

Testing

• node --test scripts/tests/cleanup-ios-build.test.cjs
• RBENV_VERSION=3.2.3 bundle exec ruby -Itest fastlane/test/helpers_test.rb

---

https://chatgpt.com/codex/tasks/task_b_686b04f3a6a4832d900d3fbf37d81004

Summary by CodeRabbit

• New Features

  • Introduced a cleanup script to reset the Xcode project after local iOS builds.
  • Slack notifications for build status now display the app's display name.
  • Added post-deployment iOS build cleanup step to improve deployment reliability.

• Bug Fixes

  • Improved error handling when uploading files to Slack, ensuring a valid channel ID is provided.

• Documentation

  • Enhanced local iOS deployment instructions, including post-deployment cleanup steps and clarification on TestFlight group usage.

• Tests

  • Added tests for the new cleanup script, Slack upload error handling, app name resolution logic, and deployment cleanup functions.

[coderabbitai]

Walkthrough

This update introduces a new cleanup script for iOS build artifacts, enhances documentation for local iOS deployment, clarifies TestFlight group usage, and improves Slack notification logic by introducing a unified app name constant. Additional validation is added for Slack uploads, and new tests are provided for both the Slack helper and the cleanup script. The local deployment script is refactored to ensure cleanup runs post-deployment with proper error handling and testability.

Changes

File(s)	Change Summary
app/fastlane/DEV.md	Enhanced local iOS deployment docs: added cleanup script step; clarified IOS_TESTFLIGHT_GROUPS usage.
app/fastlane/Fastfile	Introduced APP_NAME constant for notifications; updated TestFlight group comment; refactored titles.
app/fastlane/helpers/slack.rb	Added validation for empty channel_id in upload_file_to_slack.
app/fastlane/test/helpers_test.rb	Added tests for missing Slack channel ID, missing Slack token, and deploy source messages in Slack uploads.
app/fastlane/test/app_name_test.rb	New tests verifying app name resolution from env variable, app.json, and fallback default.
app/scripts/cleanup-ios-build.sh	New script to reset Xcode project file and clean build artifacts post-local build.
app/scripts/tests/cleanup-ios-build.test.cjs	Tests for cleanup script validating version extraction, reset, and error handling.
app/scripts/mobile-deploy-confirm.cjs	Refactored local deployment to run iOS cleanup post-deploy; improved error handling and exports.
app/scripts/tests/mobile-deploy-confirm-module.test.cjs	Unit tests for deployment and cleanup functions with execSync stubbing and call verification.
.coderabbit.yaml	Added GitHub checks timeout configuration under reviews.tools.github-checks.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant LocalMachine
    participant Git
    participant XcodeProject

    User->>LocalMachine: Run local iOS deployment (fastlane)
    LocalMachine->>XcodeProject: Build and modify project.pbxproj
    User->>LocalMachine: Run cleanup-ios-build.sh
    LocalMachine->>Git: git checkout project.pbxproj
    LocalMachine->>XcodeProject: Extract version info
    LocalMachine->>XcodeProject: Update version fields (MARKETING_VERSION, CURRENT_PROJECT_VERSION)
    LocalMachine-->>User: Project file reset, artifacts cleaned

Loading

sequenceDiagram
    participant Fastlane
    participant SlackHelper
    participant SlackAPI

    Fastlane->>SlackHelper: upload_file_to_slack(file, channel_id)
    SlackHelper->>SlackHelper: Validate SLACK_API_TOKEN
    SlackHelper->>SlackHelper: Validate channel_id
    alt channel_id missing
        SlackHelper-->>Fastlane: Raise error "Missing SLACK_CHANNEL_ID"
    else channel_id present
        SlackHelper->>SlackAPI: Upload file
        SlackAPI-->>SlackHelper: Response
        SlackHelper-->>Fastlane: Success/Error
    end

Loading

Possibly related PRs

• Add tests for minor deployment fixes #750: Shares the same AppNameTest suite and refactors mobile-deploy-confirm.cjs for exported functions and testability, indicating direct overlap in deployment and app naming logic.

Poem

🛠️
A script to clean, a test to check,
iOS builds now bounce right back.
Slack gets wiser, errors caught,
Notifications named as they ought.
Docs improved, instructions clear—
Ship with confidence, engineers!
🚀

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 3

🧹 Nitpick comments (2)

app/scripts/tests/cleanup-ios-build.test.cjs (1)

35-36: Consider adding error handling for script execution.

While the test works well, consider wrapping the script execution in a try-catch to provide better error messages if the script fails:

-    execSync(`IOS_PROJECT_NAME=${projectName} bash ${SCRIPT}`);
-    process.chdir(cwd);
+    try {
+      execSync(`IOS_PROJECT_NAME=${projectName} bash ${SCRIPT}`);
+    } finally {
+      process.chdir(cwd);
+    }

app/fastlane/Fastfile (1)

274-274: Remove trailing comma for consistency.

Same styling issue as the iOS notification - remove the trailing comma for cleaner code.

-        title: "#{APP_NAME}-#{package_version}-#{version_code}.aab",
+        title: "#{APP_NAME}-#{package_version}-#{version_code}.aab"

The consistent use of APP_NAME across both platforms is good for maintaining uniform artifact naming.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f98beea and 9e2441a.

📒 Files selected for processing (6)

• app/fastlane/DEV.md (2 hunks)
• app/fastlane/Fastfile (4 hunks)
• app/fastlane/helpers/slack.rb (1 hunks)
• app/fastlane/test/helpers_test.rb (1 hunks)
• app/scripts/cleanup-ios-build.sh (1 hunks)
• app/scripts/tests/cleanup-ios-build.test.cjs (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (2)

app/fastlane/test/helpers_test.rb (1)

app/fastlane/helpers/slack.rb (1)

• upload_file_to_slack (5-24)

app/fastlane/helpers/slack.rb (1)

app/fastlane/helpers/common.rb (1)

• report_error (18-22)

🪛 RuboCop (1.75.5)

app/fastlane/Fastfile

[convention] 74-74: Avoid comma after the last parameter of a method call.

(Style/TrailingCommaInArguments)

---

[convention] 274-274: Avoid comma after the last parameter of a method call.

(Style/TrailingCommaInArguments)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: type-check
• GitHub Check: test
• GitHub Check: build
• GitHub Check: lint

🔇 Additional comments (8)

app/fastlane/helpers/slack.rb (1)

8-8: Excellent defensive programming!

This validation enhancement follows the established pattern and improves robustness by catching missing channel IDs early. The error message is clear and consistent with the existing token validation.

app/scripts/cleanup-ios-build.sh (2)

18-22: Good sed compatibility handling!

The GNU/BSD sed detection and handling is well-implemented. This ensures the script works across different Unix-like systems.

---

3-3: Excellent error handling setup.

Using set -euo pipefail provides strict error handling that will catch issues early and prevent silent failures.

app/fastlane/DEV.md (2)

119-123: Clear and actionable documentation.

The addition of the cleanup step is well-documented and provides clear instructions for users to avoid committing build artifacts after local iOS deployments.

---

227-227: Important clarification for TestFlight usage.

Specifying "external" TestFlight groups is crucial as it clarifies the deployment target and aligns with Fastlane's upload_to_testflight action requirements.

app/fastlane/test/helpers_test.rb (1)

331-343: Well-structured test with proper cleanup.

The test effectively validates the new channel_id validation logic. Good use of ensure block for cleanup and proper exception testing with assert_raises.

app/scripts/tests/cleanup-ios-build.test.cjs (1)

22-36: Comprehensive test setup and execution.

The test properly simulates a real environment with git repository setup and validates the script's core functionality. Good use of temporary directories and proper cleanup.

app/fastlane/Fastfile (1)

62-62: Good clarification on TestFlight group requirements.

This comment clarification aligns with security best practices by explicitly stating the TestFlight group constraint, which helps prevent accidental deployment to internal groups.

[transphorm]

@coderabbitai full review

[coderabbitai]

✅ Actions performed

Full review triggered.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

app/scripts/tests/mobile-deploy-confirm-module.test.cjs (1)

1-49: Comprehensive test coverage with good dependency injection.

The tests properly cover both the conditional cleanup execution (iOS vs Android) and the deployment workflow integration. The use of dependency injection for execSync and cleanup functions ensures isolated testing.

Consider applying the optional chain suggestion from static analysis for line 15:

-    assert(called && called.includes('cleanup-ios-build.sh'));
+    assert(called?.includes('cleanup-ios-build.sh'));

app/fastlane/Fastfile (1)

70-70: Remove trailing commas and excellent notification enhancements

The addition of deployment source information and APP_NAME usage in Slack notifications provides valuable context. However, please remove the trailing commas for style consistency:

       distribute_external: true,
       # Only external TestFlight groups are valid here
       groups: ENV["IOS_TESTFLIGHT_GROUPS"].split(","),
       changelog: "",
-      skip_waiting_for_build_processing: false,
+      skip_waiting_for_build_processing: false
     ) if result[:should_upload]

     # Notify Slack about the new build
     if ENV["SLACK_CHANNEL_ID"]
       deploy_source = Fastlane::Helpers.is_ci_environment? ? "GitHub Workflow" : "Local Deploy"
       Fastlane::Helpers.upload_file_to_slack(
         file_path: result[:ipa_path],
         channel_id: ENV["SLACK_CHANNEL_ID"],
         initial_comment: "🍎 iOS v#{package_version} (Build #{result[:build_number]}) deployed to TestFlight via #{deploy_source}",
-        title: "#{APP_NAME}-#{package_version}-#{result[:build_number]}.ipa",
+        title: "#{APP_NAME}-#{package_version}-#{result[:build_number]}.ipa"
       )

And in the Android section:

       Fastlane::Helpers.upload_file_to_slack(
         file_path: android_aab_path,
         channel_id: ENV["SLACK_CHANNEL_ID"],
         initial_comment: "🤖 Android v#{package_version} (Build #{version_code}) deployed to #{target_platform} via #{deploy_source}",
-        title: "#{APP_NAME}-#{package_version}-#{version_code}.aab",
+        title: "#{APP_NAME}-#{package_version}-#{version_code}.aab"
       )

Also applies to: 75-81, 276-282

app/fastlane/test/helpers_test.rb (1)

331-380: Well-structured Slack validation tests with minor style fix needed

The new test methods provide excellent coverage for:

• Channel ID validation
• Token validation
• Deploy source message variations

Please remove the trailing comma on line 371:

         Fastlane::Helpers.upload_file_to_slack(
           file_path: file.path,
           channel_id: "C123",
-          initial_comment: "Deploy via #{deploy_source}",
+          initial_comment: "Deploy via #{deploy_source}"
         )

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f98beea and 54cbfda.

📒 Files selected for processing (10)

• .coderabbit.yaml (1 hunks)
• app/fastlane/DEV.md (2 hunks)
• app/fastlane/Fastfile (3 hunks)
• app/fastlane/helpers/slack.rb (1 hunks)
• app/fastlane/test/app_name_test.rb (1 hunks)
• app/fastlane/test/helpers_test.rb (1 hunks)
• app/scripts/cleanup-ios-build.sh (1 hunks)
• app/scripts/mobile-deploy-confirm.cjs (6 hunks)
• app/scripts/tests/cleanup-ios-build.test.cjs (1 hunks)
• app/scripts/tests/mobile-deploy-confirm-module.test.cjs (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

app/fastlane/helpers/slack.rb (1)

app/fastlane/helpers/common.rb (1)

• report_error (18-22)

🪛 RuboCop (1.75.5)

app/fastlane/Fastfile

[convention] 70-70: Avoid comma after the last parameter of a method call.

(Style/TrailingCommaInArguments)

---

[convention] 80-80: Avoid comma after the last parameter of a method call.

(Style/TrailingCommaInArguments)

---

[convention] 281-281: Avoid comma after the last parameter of a method call.

(Style/TrailingCommaInArguments)

app/fastlane/test/helpers_test.rb

[convention] 371-371: Avoid comma after the last parameter of a method call.

(Style/TrailingCommaInArguments)

🪛 Biome (1.9.4)

app/scripts/tests/mobile-deploy-confirm-module.test.cjs

[error] 15-15: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

🔇 Additional comments (11)

app/fastlane/helpers/slack.rb (1)

8-8: LGTM! Excellent defensive validation.

The channel ID validation follows the same robust pattern as the existing token validation and prevents potential runtime errors during Slack uploads. The error messaging is clear and consistent.

.coderabbit.yaml (1)

18-20: Well-configured timeout for mobile deployments.

The 5-minute timeout for GitHub checks is appropriate for mobile deployment workflows that involve building, code signing, and uploading to app stores. This prevents premature timeouts during longer deployment processes.

app/fastlane/DEV.md (2)

119-124: Excellent documentation for build artifact cleanup.

This clear instruction to run the cleanup script after local iOS deployments helps prevent accidental commits of build artifacts. The placement right after the deployment section makes it easy to follow.

---

227-227: Important clarification about TestFlight groups.

Specifying that only external TestFlight groups are valid helps prevent configuration errors and aligns with the FastLane upload_to_testflight action requirements.

app/scripts/cleanup-ios-build.sh (1)

1-31: Robust cleanup script with excellent error handling.

This script demonstrates strong security and reliability practices:

• Strict error handling with set -euo pipefail prevents silent failures
• Input validation for project file existence and version extraction
• Cross-platform compatibility handling GNU vs BSD sed differences
• Safe git operations using git checkout to reset changes
• Clear error messaging for debugging failed operations

The implementation addresses the mobile deployment requirement to clean up build artifacts while maintaining project integrity.

app/fastlane/Fastfile (1)

67-68: Comment clarification improves deployment understanding

The updated comment explicitly stating "Only external TestFlight groups are valid here" helps prevent deployment errors and aligns with the documentation updates.

app/fastlane/test/app_name_test.rb (1)

1-58: Comprehensive test coverage for APP_NAME resolution logic

Excellent test implementation that covers all three scenarios of the APP_NAME constant:

• Environment variable precedence
• Valid app.json parsing
• Fallback behavior with proper error message verification

The test isolation with temp directories and environment cleanup is well-implemented.

app/scripts/tests/cleanup-ios-build.test.cjs (1)

1-88: Thorough test coverage for iOS build cleanup script

Excellent test implementation covering:

• Successful cleanup with version preservation
• Error handling for missing project files
• Error handling for malformed version information

The use of temporary directories and git operations for realistic testing is well done.

app/scripts/mobile-deploy-confirm.cjs (3)

5-5: Well-implemented iOS cleanup functionality with proper error handling

The new performIOSBuildCleanup function:

• Correctly checks platform before running
• Handles errors gracefully without blocking deployment
• Provides clear user feedback

The change from const to let for execSync enables proper testing through dependency injection.

Also applies to: 421-445

---

456-498: Robust deployment flow with guaranteed cleanup execution

Excellent improvements to executeLocalFastlaneDeployment:

• Success tracking ensures proper exit codes
• finally block guarantees cleanup runs regardless of deployment outcome
• Error handling deferred until after cleanup

This pattern ensures build artifacts are cleaned up even if deployment fails.

---

579-595: Smart module pattern enables comprehensive testing

The conditional export pattern allows the module to function both as a CLI tool and as a testable module. The setter functions for dependency injection are a clean approach for mocking in tests.