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.

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

Conversation

compnerd
Copy link
Member

@compnerd compnerd commented Nov 8, 2024

This package is not very Windows friendly. A partial port was attempted but revealed further Unixisms that will be difficult to port. There are alternative packages for benchmarking, e.g. google/swift-benchmark which may be a better choice.

@ktoso
Copy link
Collaborator

ktoso commented Nov 8, 2024

Removing the benchmark plugin just like that is not okey.

You can conditionalize it on being built in windows for example, but just removing like that isn't very helpful, we do want this plugin.

@compnerd
Copy link
Member Author

compnerd commented Nov 8, 2024

Conditionalised behind SWIFT_JAVA_ENABLE_BENCHMARKING that you can set to TRUE, YES, or 1 to enable or FALSE, NO, or 0 to disable.

@compnerd compnerd marked this pull request as ready for review November 8, 2024 23:37
This package is not very Windows friendly. A partial port was attempted
but revealed further Unixisms that will be difficult to port. There are
alternative packages for benchmarking, e.g. google/swift-benchmark which
may be a better choice.
Comment on lines +42 to +51
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'")
}
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants