Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: remove package-benchmark from the dependencies #165

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

build: remove package-benchmark from the dependencies #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/pull_request.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ jobs:
# FIXME: Something is off with the format task and it gets "stuck", need to investigate
format_check_enabled: false
license_header_check_project_name: Swift.org
env:
SWIFT_JAVA_ENABLE_BENCHMARKING: NO

test-java:
name: Java tests (swift:${{ matrix.swift_version }} jdk:${{matrix.jdk_vendor}} os:${{ matrix.os_version }})
Expand Down Expand Up @@ -86,6 +88,7 @@ jobs:
image: ${{ (contains(matrix.swift_version, 'nightly') && 'swiftlang/swift') || 'swift' }}:${{ matrix.swift_version }}-${{ matrix.os_version }}
env:
JAVA_HOME: "/usr/lib/jvm/default-jdk"
SWIFT_JAVA_ENABLE_BENCHMARKING: NO
steps:
- uses: actions/checkout@v4
- name: Install System Dependencies
Expand Down
17 changes: 15 additions & 2 deletions Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,17 @@ let javaIncludePath = "\(javaHome)/include"
let javaPlatformIncludePath = "\(javaIncludePath)/win32"
#endif

func sjEnableBenchmarking() -> Bool {
if let value = ProcessInfo.processInfo.environment["SWIFT_JAVA_ENABLE_BENCHMARKING"] {
switch value {
case "TRUE", "YES", "1": return true
case "FALSE", "NO", "0": return false
default: break
}
}
fatalError("Please set 'SWIFT_JAVA_ENABLE_BENCHMARKING' to 'TRUE' or 'FALSE'")
}
Comment on lines +42 to +51
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We shouldn't force all clients to set an environment variable here. I think the best option here is to disable benchmarking on Windows until we find an appropriate solution.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a way to do that within the confines of package.swift? #if os(...) uses the build not the host.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll repeat the request about the "opt out with an env var" on windows.

I don't understand what you meant by it being hard on windows. There is "set ...=..." and surely IDEs can set env when starting processes as well...? Can we do that instead?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, IDEs don't do very well with setting environment variables (at least VSCode in some cases and VS do not). The environment variable setting then permeates into everything and has different syntax in different places. It doesn't fully propagate between subshells, which adds additional surprises. I think that we should either fully drop the benchmarking or require setting the environment everywhere - it avoids any surprises.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then I propose we put the benchmarking into a sub-package that we add in a sub directory. Lemme try that.


let package = Package(
name: "JavaKit",
platforms: [
Expand Down Expand Up @@ -138,8 +149,10 @@ let package = Package(
dependencies: [
.package(url: "https://github.com/swiftlang/swift-syntax.git", branch: "main"),
.package(url: "https://github.com/apple/swift-argument-parser", from: "1.5.0"),
.package(url: "https://github.com/ordo-one/package-benchmark", .upToNextMajor(from: "1.4.0")),
],
] + (sjEnableBenchmarking() ? [
.package(url: "https://github.com/ordo-one/package-benchmark",
.upToNextMajor(from: "1.4.0")),
] : []),
targets: [
.macro(
name: "JavaKitMacros",
Expand Down