Skip to content

[v3 alpha] docs: add note that internal service methods are not included in generated bindings#3982

Merged
leaanthony merged 1 commit into
wailsapp:v3-alphafrom
ekkohnet:v3-alpha-docs-service-methods-bindings-note
Jan 5, 2025
Merged

[v3 alpha] docs: add note that internal service methods are not included in generated bindings#3982
leaanthony merged 1 commit into
wailsapp:v3-alphafrom
ekkohnet:v3-alpha-docs-service-methods-bindings-note

Conversation

@ekkohnet

@ekkohnet ekkohnet commented Jan 4, 2025 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Description

Adds a small note to the Learn/Services page that calls out the OnStartup, OnShutdown, and ServeHTTP internal methods are not included when the service's bindings are generated.

I was refactoring my own version of services into these new lifecycle methods and tested the bindings generation to ensure these methods were not exposed to the frontend. I think this would be good to call out in the docs so others are aware these are treated differently than regular bound methods.

wails/v3/internal/generator/collect/service.go

Line 57 in 91a9929

func isInternalServiceMethod(method *types.Func) bool {

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?

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

If you checked Linux, please specify the distro and version.

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

  • Documentation
    • Updated services documentation in Wails v3 to clarify service implementation details
    • Added note explaining which service methods are not exposed to the frontend

@coderabbitai

coderabbitai Bot commented Jan 4, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Walkthrough

The documentation for Wails v3 services has been updated with a clarifying note about method bindings. The update focuses on explaining which service methods are not exposed to the frontend, specifically highlighting that OnStartup, OnShutdown, and ServeHTTP methods are not included in the generated bindings. This change provides additional context about service method exposure without altering the fundamental service implementation or registration process.

Changes

File Change Summary
docs/src/content/docs/learn/services.mdx Added a note clarifying that certain service methods (OnStartup, OnShutdown, ServeHTTP) are not included in frontend bindings

Poem

🐰 A Rabbit's Ode to Service Clarity

In Wails v3, services shine bright,
Some methods hidden from frontend's sight
OnStartup, ServeHTTP stay behind the scene
Not bound, but working, if you know what I mean!
A documentation tweak, simple and neat 🔍

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 91a9929 and 20f0067.

📒 Files selected for processing (1)
  • docs/src/content/docs/learn/services.mdx (1 hunks)
🔇 Additional comments (2)
docs/src/content/docs/learn/services.mdx (2)

57-58: LGTM! Clear introduction to the optional methods section.

The introduction line provides a good context for the following sections about lifecycle methods.

59-62: LGTM! Well-placed and clear documentation about method exposure.

The note effectively communicates which methods are not exposed to the frontend through bindings. This is valuable information for developers implementing services.

A few positive points about this addition:

  • Placement is logical - right before the detailed method descriptions
  • Uses the correct MDX note syntax
  • Clearly lists all internal methods that are not exposed

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>, 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.

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
leaanthony approved these changes Jan 5, 2025
View reviewed changes

@leaanthony leaanthony left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks!

@leaanthony leaanthony merged commit 98c4089 into wailsapp:v3-alpha Jan 5, 2025
@coderabbitai coderabbitai Bot mentioned this pull request Jan 18, 2025
Merged
16 tasks
@coderabbitai coderabbitai Bot mentioned this pull request Feb 13, 2025
Merged
15 tasks
@coderabbitai coderabbitai Bot mentioned this pull request Jul 7, 2025
Merged
Grantmartin2002 pushed a commit to Grantmartin2002/wails that referenced this pull request Apr 29, 2026
@ekkohnet
[v3 alpha] docs: add note that internal service methods are not inclu…
3dabf8d 
…ded in generated bindings (wailsapp#3982)

add note that internal service methods are not bound
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@leaanthony leaanthony leaanthony approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ekkohnet @leaanthony