Do not attempt to export fields that cannot be json-encoded

[pbnjay]

Description

Some Go types cannot be converted to JSON, and should be excluded from the binding exports. This was an issue when re-using existing Go types (vs types created specifically for Application IPC) when #3678 was introduced.

Fixes #3809

Type of change

Please select the option that is 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?

Tested against the linked repo in issue #3809 and with some local app repos. Added a line to the test case for #3678 so that it will fail prior to this PR.

The scope of the change should not be OS/architecture dependent.

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

• Bug Fixes

  • Improved JSON field handling to prevent encoding of unsupported types (channels, functions, complex numbers)
  • Enhanced type serialization logic to skip non-serializable field types
  • Resolved cross-compilation failures related to CGO
  • Fixed issues with webview2loader and TypeScript definition for WindowSetSize
  • Corrected build failure for non-JSON encodable Go types

• New Features

  • Updated changelog with new options for setting window class name on Windows
  • Clarified documentation regarding password syntax and installation requirements for Linux

• Tests

  • Updated test struct with a new function field to validate type handling

[coderabbitai]

Walkthrough

The changes modify the JSON field detection logic in the Wails framework's internal binding and typescriptify packages. The modifications prevent function, complex, and channel types from being considered during JSON encoding. This involves updating the hasExportedJSONFields method in the binding package and the getJSONFieldName method in the typescriptify package to explicitly exclude these specific types from serialization. Additionally, a new field has been added to a test struct to facilitate testing.

Changes

File	Change Summary
v2/internal/binding/binding.go	Updated hasExportedJSONFields method to skip JSON encoding for function, complex, and channel types
v2/internal/binding/binding_test/binding_notags_test.go	Added NoFunc field of type func() string to NoFieldTags struct
v2/internal/typescriptify/typescriptify.go	Modified getJSONFieldName to return empty string for function, complex, and channel types
website/src/pages/changelog.mdx	Updated changelog with various modifications and fixes, including handling of non-JSON encodable types

Assessment against linked issues

Objective	Addressed	Explanation
Models.ts generation (#3809)	✅
Prevent JSON encoding of unsupported types	✅

Possibly related PRs

• [V3 Templates] Add Sveltekit and Sveltekit TS templates #3829: The changes in this PR involve modifications to JSON encoding logic, similar to the main PR's updates to the hasExportedJSONFields method, which also refines criteria for JSON serialization by excluding certain types.
• fix: prevent unnecessary redraws during window minimize/restore #3955: This PR addresses flickering issues during window minimize/restore actions, which may relate to the overall handling of window states and could be indirectly connected to the changes in the main PR regarding the handling of data types for JSON encoding.

Suggested labels

awaiting feedback

Suggested reviewers

• leaanthony

Poem

🐰 In the realm of code, where types dance and play,
Channels and functions now gracefully sway.
No longer trapped in JSON's tight embrace,
Our bindings now move with elegant grace.
A rabbit's delight in type's subtle art! 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f9d053a and e8110bc.

📒 Files selected for processing (2)

• v2/internal/binding/binding.go (1 hunks)
• v2/internal/typescriptify/typescriptify.go (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• v2/internal/binding/binding.go
• v2/internal/typescriptify/typescriptify.go

---

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

• 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code 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 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 generate unit testing code.
  • @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.

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. (Beta)
• @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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• 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/schema.v2.json

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.

[leaanthony]

Is this needed?

[pbnjay]

Before this PR, this line would cause the same problem as the issue in 3809. So if it gets reverted then this will trigger the bug again.

[pbnjay]

So not only should it not show up in the test output ~ line 28 of this file, but it would also cause a binding failure.

[pbnjay]

Also added UnsafePointer, now all reflect.Kind types should be either json-encodable or in the skip list.