chore: Add test workflow for swift log #6945

itaybre · 2025-12-01T20:12:58Z

Adds:

Adds a common workflow for 3rd party integrations
Adds a script to easy testing SPM packages
Adds a workflow for SwiftLog

github-actions · 2025-12-01T21:07:11Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	1225.96 ms	1259.34 ms	33.38 ms
Size	24.14 KiB	1.02 MiB	1016.90 KiB

Baseline results on branch: feat/add-swift-log-integration

Startup times

Revision	Plain	With Sentry	Diff
`b06a366`	1212.46 ms	1242.20 ms	29.74 ms
`e39cfe2`	1196.87 ms	1216.73 ms	19.87 ms
`587a9b5`	1213.80 ms	1250.94 ms	37.14 ms

App size

Revision	Plain	With Sentry	Diff
`b06a366`	24.14 KiB	1.02 MiB	1016.90 KiB
`e39cfe2`	24.14 KiB	1.02 MiB	1016.90 KiB
`587a9b5`	24.14 KiB	1.02 MiB	1016.89 KiB

Previous results on branch: itay/add_ci_tests

Startup times

Revision	Plain	With Sentry	Diff
`cfb43c4`	1209.69 ms	1247.80 ms	38.11 ms
`61ec528`	1224.52 ms	1228.96 ms	4.43 ms
`458120a`	1227.60 ms	1264.52 ms	36.92 ms

App size

Revision	Plain	With Sentry	Diff
`cfb43c4`	24.14 KiB	1.02 MiB	1016.90 KiB
`61ec528`	24.14 KiB	1.01 MiB	1012.90 KiB
`458120a`	24.14 KiB	1.02 MiB	1016.89 KiB

scripts/integration-xcodebuild.sh

.github/workflows/integrations-swift-log.yml

philipphofmann

Thanks, I added a few comments.

.github/workflows/integrations-common.yml

philipphofmann · 2025-12-04T13:43:08Z

scripts/integration-xcodebuild.sh

+#!/bin/bash
+set -euxo pipefail
+
+# Disable SC1091 because it won't work with pre-commit


m: This script is quite similar to sentry-xcodebuild.sh. I would really appreciate if we don't have all of that logic duplicated.

philipphofmann · 2025-12-04T13:45:06Z

.github/workflows/integrations-common.yml

+        default: macos-26
+        type: string
+
+jobs:


m: There are many similarities to unit-test-common.yml. Can't we reuse unit-test-common.yml instead of having plenty of code duplicated?

philipphofmann · 2025-12-04T13:51:43Z

scripts/use-local-sentry-dependency.sh

+# Script to replace sentry-cocoa remote dependency with local path in integration packages
+# This is useful for CI testing where we want to test integrations against the current code


m: I think this could be part of https://github.com/getsentry/sentry-cocoa/blob/main/scripts/prepare-package.sh

I can move if there, but the only similarity is that both scripts manipulate Package.swift
But they are not so similar in which modifications they do

codecov · 2025-12-04T19:36:25Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.065%. Comparing base (2077ce0) to head (250507b).
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@                         Coverage Diff                          @@
##           feat/add-swift-log-integration     #6945       +/-   ##
====================================================================
- Coverage                          85.069%   85.065%   -0.004%     
====================================================================
  Files                                 453       453               
  Lines                               27681     27681               
  Branches                            12167     12170        +3     
====================================================================
- Hits                                23548     23547        -1     
- Misses                               4087      4090        +3     
+ Partials                               46        44        -2

see 5 files with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2077ce0...250507b. Read the comment docs.

scripts/prepare-package.sh

 fi

+if is_enabled "$UPDATE_PATH_TO_SENTRY_COCOA"; then
+  sed -i '' 's|\.package(url: "https://github\.com/getsentry/sentry-cocoa", from: "[^"]*")|.package(path: "'../../../'")|g' "$PACKAGE_FILE"


.github/workflows/unit-test-common.yml

          XCODE_VERSION: ${{ inputs.xcode }}
          DEVICE_NAME: ${{ inputs.device }}
          OS_VERSION: ${{ inputs.test-destination-os }}
-        run: ./scripts/ci-boot-simulator.sh --xcode "$XCODE_VERSION" --device "$DEVICE_NAME" --os-version "$OS_VERSION"
+        run: ${{ inputs.path_to_scripts_folder }}/ci-boot-simulator.sh --xcode "$XCODE_VERSION" --device "$DEVICE_NAME" --os-version "$OS_VERSION"

      # We split building and running tests in two steps so we know how long running the tests takes.
      - name: Build Tests
+        working-directory: ${{ inputs.working_directory }}
        id: build_tests
        env:
          PLATFORM: ${{ inputs.platform }}


scripts/prepare-package.sh

+if is_enabled "$UPDATE_PATH_TO_SENTRY_COCOA"; then
+  sed -i '' 's|\.package(url: "https://github\.com/getsentry/sentry-cocoa", from: "[^"]*")|.package(path: "'../../../'")|g' "$PACKAGE_FILE"
+fi


.github/workflows/integrations-swift-log.yml

+    with:
+      name: SwiftLog
+      scheme: SentrySwiftLog
+      working_directory: integrations/logs/sentry-cocoa-swiftlog
+      path_to_scripts_folder: ../../../scripts
+      xcode: ${{ matrix.xcode }}
+      test-destination-os: ${{ matrix.test-destination-os }}
+      device: ${{ matrix.device }}
+      platform: ${{ matrix.platform }}
+      runs-on: ${{ matrix.macos_version }}
+      timeout: 10


cursor · 2025-12-04T19:50:18Z

scripts/prepare-package.sh

 fi

+if is_enabled "$UPDATE_PATH_TO_SENTRY_COCOA"; then
+  sed -i '' 's|\.package(url: "https://github\.com/getsentry/sentry-cocoa", from: "[^"]*")|.package(path: "'../../../'")|g' "$PACKAGE_FILE"


Bug: Sed produces invalid Swift syntax with literal quotes

The sed command at line 143 produces invalid Swift package path syntax. The replacement pattern '.package(path: "'../../../'")' will generate .package(path: "'../../../'") in the Package.swift file, where the path string contains literal single quote characters. Swift package paths require just the path without extra quotes, like .package(path: "../../../"). The literal single quotes will cause the package resolution to fail because it will look for a directory named '../../../' instead of ../../../.

cursor · 2025-12-04T19:50:18Z

.github/workflows/unit-test-common.yml

        if: always()
        with:
-          report_paths: "build/reports/junit.xml"
+          report_paths: "${{ inputs.working_directory }}/build/reports/junit.xml"


Bug: Empty working_directory creates invalid absolute path prefix

The report_paths value "${{ inputs.working_directory }}/build/reports/junit.xml" will produce /build/reports/junit.xml when working_directory is not provided (defaults to empty string). This changes a relative path to an absolute path starting with /, breaking existing callers of unit-test-common.yml that don't specify working_directory (like fast-pr-checks.yml and test.yml). The previous value was simply "build/reports/junit.xml" without the prefix.

cursor · 2025-12-04T19:50:18Z

scripts/sentry-xcodebuild.sh

+        -S|--spm-project)
+            SPM_PROJECT="true"
+            shift 1
+            ;;


Bug: Argument parsing mismatch for spm-project flag

The --spm-project option's usage documentation (line 40) indicates it accepts a <bool> argument, but the implementation unconditionally sets SPM_PROJECT="true" and only does shift 1 instead of shift 2. All other options in this script read $2 and shift by 2. If a user runs --spm-project false following the documented interface, the variable is incorrectly set to "true" and then "false" is left as the next argument, causing an "Unknown option" error.

…paration

…uring testing

sentry · 2025-12-04T19:55:08Z

.github/workflows/integrations-swift-log.yml

+    uses: ./.github/workflows/unit-test-common.yml
+    with:
+      name: SwiftLog
+      scheme: SentrySwiftLog
+      working_directory: integrations/logs/sentry-cocoa-swiftlog
+      path_to_scripts_folder: ../../../scripts
+      xcode: ${{ matrix.xcode }}
+      test-destination-os: ${{ matrix.test-destination-os }}
+      device: ${{ matrix.device }}
+      platform: ${{ matrix.platform }}
+      runs-on: ${{ matrix.macos_version }}


Bug: sentry-xcodebuild.sh incorrectly adds -workspace Sentry.xcworkspace when testing SPM packages due to a missing --spm-project flag.
_{Severity: CRITICAL | Confidence: High}

🔍 Detailed Analysis

The integrations-swift-log.yml workflow calls unit-test-common.yml to test an SPM package. However, unit-test-common.yml does not expose an input parameter to indicate an SPM project. Consequently, sentry-xcodebuild.sh is executed without the --spm-project true flag, causing it to incorrectly add -workspace Sentry.xcworkspace to xcodebuild arguments. This will fail because the SPM package directory (integrations/logs/sentry-cocoa-swiftlog/) does not contain a Sentry.xcworkspace file.

💡 Suggested Fix

Add an is_spm_project boolean input to unit-test-common.yml, pass it to sentry-xcodebuild.sh, and update integrations-swift-log.yml to pass is_spm_project: true.

🤖 Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: .github/workflows/integrations-swift-log.yml#L71-L85 Potential issue: The `integrations-swift-log.yml` workflow calls `unit-test-common.yml` to test an SPM package. However, `unit-test-common.yml` does not expose an input parameter to indicate an SPM project. Consequently, `sentry-xcodebuild.sh` is executed without the `--spm-project true` flag, causing it to incorrectly add `-workspace Sentry.xcworkspace` to `xcodebuild` arguments. This will fail because the SPM package directory (`integrations/logs/sentry-cocoa-swiftlog/`) does not contain a `Sentry.xcworkspace` file.

_{Did we get this right? 👍 / 👎 to inform future reviews.}
_{Reference ID: 5615901}

sentry · 2025-12-04T19:55:08Z

.github/workflows/unit-test-common.yml

        default: false
        type: boolean

+      working_directory:


Bug: Missing default for working_directory in unit-test-common.yml breaks existing callers and causes workflow failures.
_{Severity: CRITICAL | Confidence: High}

🔍 Detailed Analysis

The unit-test-common.yml workflow's working_directory input is required: false but lacks a default: value. Existing callers, such as test.yml, do not provide this parameter. When working_directory is an empty string, critical steps like ls -la ${{ inputs.working_directory }} will fail with ls: cannot access '': No such file or directory. Additionally, the report_paths for JUnit reports will incorrectly resolve to /build/reports/junit.xml, causing the report action to fail.

💡 Suggested Fix

Add a default: value to the working_directory input in unit-test-common.yml or update all existing callers (e.g., test.yml) to provide this parameter.

🤖 Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: .github/workflows/unit-test-common.yml#L72 Potential issue: The `unit-test-common.yml` workflow's `working_directory` input is `required: false` but lacks a `default:` value. Existing callers, such as `test.yml`, do not provide this parameter. When `working_directory` is an empty string, critical steps like `ls -la ${{ inputs.working_directory }}` will fail with `ls: cannot access '': No such file or directory`. Additionally, the `report_paths` for JUnit reports will incorrectly resolve to `/build/reports/junit.xml`, causing the report action to fail.

_{Did we get this right? 👍 / 👎 to inform future reviews.}
_{Reference ID: 5615901}

…/sentry-cocoa into itay/add_ci_tests

cursor · 2025-12-04T19:57:39Z

.github/workflows/unit-test-common.yml

+        run: |
+          ls -la .
+          ls -la sentry-cocoa
+          ls -la ${{ inputs.working_directory }}


Bug: Debug step will fail when sentry-cocoa directory missing

A debugging step named "Test" was accidentally committed to the workflow. The ls -la sentry-cocoa command will fail for any workflow invocation that doesn't have a sentry-cocoa directory present in the checkout, which includes existing workflows like test.yml and fast-pr-checks.yml that call this reusable workflow.

cursor · 2025-12-04T19:57:39Z

.github/workflows/integrations-swift-log.yml

+      device: ${{ matrix.device }}
+      platform: ${{ matrix.platform }}
+      runs-on: ${{ matrix.macos_version }}
+      timeout: 10


Bug: Missing secrets inheritance for codecov token access

The test-integration job is missing secrets: inherit when calling the unit-test-common.yml reusable workflow. Other callers like test.yml and fast-pr-checks.yml include this directive. Without it, unit-test-common.yml cannot access secrets.CODECOV_TOKEN, causing the codecov upload steps to fail or behave unexpectedly.

github-actions · 2025-12-04T20:31:11Z

🚨 Detected changes in high risk code 🚨

High-risk code can easily blow up and is hard to test. We had severe bugs in the past. Be extra careful when changing these files, and have an extra careful look at these:

.github/file-filters.yml

itaybre added 3 commits December 1, 2025 17:11

chore: Add test workflow for swift log

f4c75d2

Add macOS version

5c5779f

Remove file-filter

01001dc

itaybre added the ready-to-merge Use this label to trigger all PR workflows label Dec 1, 2025

Update integration's package to use local path

2e9908c

itaybre marked this pull request as ready for review December 3, 2025 13:44

itaybre requested review from noahsmartin, philipphofmann and philprime as code owners December 3, 2025 13:44

github-actions bot mentioned this pull request Dec 3, 2025

chore: Add test workflow for swift log #6973

Open

cursor bot reviewed Dec 3, 2025

View reviewed changes

scripts/integration-xcodebuild.sh Outdated Show resolved Hide resolved

.github/workflows/integrations-swift-log.yml Show resolved Hide resolved

itaybre added 2 commits December 3, 2025 17:10

Fix example commands

b00d89e

Add SPM test to required checks

c0d95c7

philipphofmann reviewed Dec 4, 2025

View reviewed changes

itaybre added 4 commits December 4, 2025 15:40

Update sentry-xcodebuild.sh to be compatible with SPM packages

6516a2e

Add --update-path-to-sentry-cocoa to prepare-package.sh

7ab3886

Improve script

77e3f6e

Reuse existing unit-test-common.yml

6636b7b

sentry bot reviewed Dec 4, 2025

View reviewed changes

scripts/prepare-package.sh Outdated

fi

if is_enabled "$UPDATE_PATH_TO_SENTRY_COCOA"; then

sed -i '' 's|\.package(url: "https://github\.com/getsentry/sentry-cocoa", from: "[^"]*")|.package(path: "'../../../'")|g' "$PACKAGE_FILE"

This comment was marked as outdated.

Sign in to view

itaybre added 3 commits December 4, 2025 16:37

Fix path

a12905b

Update GitHub Actions workflow to use 'runs-on' for macOS version

6ed3e63

Remove unnecesary files

bb5691d

sentry bot reviewed Dec 4, 2025

View reviewed changes

Add missing parameters

8171057

sentry bot reviewed Dec 4, 2025

View reviewed changes

cursor bot reviewed Dec 4, 2025

View reviewed changes

itaybre added 2 commits December 4, 2025 16:51

Update GitHub Actions workflow to correct script path for package pre…

870d82f

…paration

Add debugging steps to unit-test-common.yml for improved visibility d…

14d9475

…uring testing

itaybre marked this pull request as draft December 4, 2025 19:52

sentry bot reviewed Dec 4, 2025

View reviewed changes

Merge branch 'feat/add-swift-log-integration' of github.com:getsentry…

91ec7b7

…/sentry-cocoa into itay/add_ci_tests

cursor bot reviewed Dec 4, 2025

View reviewed changes

itaybre added 5 commits December 4, 2025 16:58

Update paths

b063217

Update path

e7db089

Update path in prepare-package.sh for Sentry Cocoa package reference

4162a71

Add support for testing SPM packages in CI workflows

2fd7b3f

Add comment

250507b

		# Script to replace sentry-cocoa remote dependency with local path in integration packages
		# This is useful for CI testing where we want to test integrations against the current code

Uh oh!

chore: Add test workflow for swift log #6945

Are you sure you want to change the base?

chore: Add test workflow for swift log #6945

Conversation

itaybre commented Dec 1, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Performance metrics 🚀

Baseline results on branch: feat/add-swift-log-integration

Startup times

App size

Previous results on branch: itay/add_ci_tests

Startup times

App size

Uh oh!

Uh oh!

Uh oh!

philipphofmann left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

philipphofmann Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

philipphofmann Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

philipphofmann Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

itaybre Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

cursor bot Dec 4, 2025

Choose a reason for hiding this comment

Bug: Sed produces invalid Swift syntax with literal quotes

Uh oh!

cursor bot Dec 4, 2025

Choose a reason for hiding this comment

Bug: Empty working_directory creates invalid absolute path prefix

Uh oh!

cursor bot Dec 4, 2025

Choose a reason for hiding this comment

Bug: Argument parsing mismatch for spm-project flag

Uh oh!

sentry bot Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

sentry bot Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

cursor bot Dec 4, 2025

Choose a reason for hiding this comment

Bug: Debug step will fail when sentry-cocoa directory missing

Uh oh!

cursor bot Dec 4, 2025

Choose a reason for hiding this comment

Bug: Missing secrets inheritance for codecov token access

Uh oh!

github-actions bot commented Dec 4, 2025

🚨 Detected changes in high risk code 🚨

Uh oh!

Reviewers

itaybre commented Dec 1, 2025 •

edited by github-actions bot

Loading

github-actions bot commented Dec 1, 2025 •

edited

Loading

philipphofmann Dec 4, 2025 •

edited

Loading

philipphofmann Dec 4, 2025 •

edited

Loading

codecov bot commented Dec 4, 2025 •

edited

Loading