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

Added possibility to specify platform for dev command #3245

Closed
wants to merge 6 commits into from
Closed

Added possibility to specify platform for dev command #3245

wants to merge 6 commits into from

Conversation

PylotLight
Copy link
Contributor

@PylotLight PylotLight commented Feb 8, 2024

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration using wails doctor.

  • Windows
  • macOS
  • Linux

Test Configuration

Please paste the output of wails doctor. If you are unable to run this command, please describe your environment in as much detail as possible.

Checklist:

  • I have updated website/src/pages/changelog.mdx with details of this PR
  • My code follows the general coding style of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Summary by CodeRabbit

  • New Features
    • Added support for a DryRun option in the build process, allowing users to simulate builds without executing them.
  • Refactor
    • Simplified the logic for parsing platform targets in the build command, enhancing code readability and maintainability.

This update fixes a previously broken loop which causes build to not build properly
Here we update parseTargets func to grab the parsed platform and arch and parse them back up instead of validating supported platforms here as that is already done elsewhere.
Copy link
Contributor

coderabbitai bot commented Feb 8, 2024

Warning

Rate Limit Exceeded

@PylotLight has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 28 minutes and 15 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 775b0b2 and dea4036.

Walkthrough

The recent update introduces a DryRun flag for controlling build execution in the build process, alongside adjustments for handling NSIS flags, refining the build flow and output messages. Additionally, the parsing logic for platform targets in flags/common.go has been streamlined. This refactoring enhances the readability and maintainability by simplifying the process of parsing and constructing platform and architecture targets.

Changes

Files Change Summary
v2/cmd/wails/build.go Added DryRun flag logic, conditions for DryRun and NSIS, and adjusted output message handling.
v2/cmd/wails/.../common.go Simplified logic in parseTargets for better readability and maintainability in parsing platform targets.

🐇✨
In the code, a rabbit hopped,
With DryRun and targets, it stopped.
It parsed and it built, with ease and with grace,
In Wails' world, it found its place.
🌟🚀

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

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>.
    • Generate unit-tests for this file.
  • 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 generate unit tests for this file.
    • @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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@PylotLight
Copy link
Contributor Author

I already have this changelog item, so not sure if we just update that or not add a changelog for this bug fix of that PR.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between e29b375 and 8505774.
Files selected for processing (2)
  • v2/cmd/wails/build.go (1 hunks)
  • v2/cmd/wails/flags/common.go (1 hunks)
Additional comments: 1
v2/cmd/wails/build.go (1)
  • 236-245: The logic for generating an NSIS installer when the NSIS flag is set appears correct. Ensure that the prerequisites for NSIS installer generation, such as the presence of NSIS software and correct configuration, are documented or checked within the code to avoid runtime errors.

Comment on lines 65 to 80
func parseTargets(platforms string) TargetsCollection {
platformList := strings.Split(platforms, ",")

var targets []Target

for _, platform := range platformList {
parts := strings.Split(platform, "/")
if len(parts) == 1 {
architecture := defaultTarget().Arch
targets = append(targets, Target{Platform: parts[0], Arch: architecture})
} else if len(parts) == 2 {
targets = append(targets, Target{Platform: parts[0], Arch: parts[1]})
}
}

result = append(result, target)
})

return result
return targets
Copy link
Contributor

Choose a reason for hiding this comment

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

The refactoring of parseTargets improves readability and maintainability. However, consider handling unexpected formats more robustly, such as entries with more than one '/' character, which could lead to incorrect parsing without any error or warning.

Comment on lines 211 to 233
if !f.DryRun {
// Start Time
start := time.Now()

compiledBinary, err := build.Build(buildOptions)
if err != nil {
pterm.Error.Println(err.Error())
return err
}

buildOptions.IgnoreFrontend = true
buildOptions.CleanBinDirectory = false

// Output stats
buildOptions.Logger.Println(fmt.Sprintf("Built '%s' in %s.\n", compiledBinary, time.Since(start).Round(time.Millisecond).String()))

outputBinaries[buildOptions.Platform+"/"+buildOptions.Arch] = compiledBinary
} else {
pterm.Info.Println("Dry run: skipped build.")
}

buildOptions.IgnoreFrontend = true
buildOptions.CleanBinDirectory = false

// Output stats
buildOptions.Logger.Println(fmt.Sprintf("Built '%s' in %s.\n", compiledBinary, time.Since(start).Round(time.Millisecond).String()))

outputBinaries[buildOptions.Platform+"/"+buildOptions.Arch] = compiledBinary
} else {
pterm.Info.Println("Dry run: skipped build.")
}

if f.DryRun {
return nil
}

if f.NSIS {
amd64Binary := outputBinaries["windows/amd64"]
arm64Binary := outputBinaries["windows/arm64"]
if amd64Binary == "" && arm64Binary == "" {
return fmt.Errorf("cannot build nsis installer - no windows targets")

if f.DryRun {
return nil
Copy link
Contributor

Choose a reason for hiding this comment

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

The implementation of the DryRun flag correctly skips the build process when set. However, consider moving the check for DryRun to an earlier stage in the function to avoid unnecessary processing before deciding not to perform the build.

@PylotLight PylotLight changed the title Fix dev platform bugs Added possibility to specify platform for dev command Feb 9, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 8505774 and 775b0b2.
Files selected for processing (2)
  • v2/cmd/wails/build.go (1 hunks)
  • v2/cmd/wails/flags/common.go (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • v2/cmd/wails/build.go
  • v2/cmd/wails/flags/common.go

@PylotLight PylotLight closed this by deleting the head repository Feb 9, 2024
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.

1 participant