Skip to content

feat(gui-client): rename IPC service to Tunnel service#9154

Merged
thomaseizinger merged 31 commits into
mainfrom
chore/rename-ipc-service
May 19, 2025
Merged

feat(gui-client): rename IPC service to Tunnel service#9154
thomaseizinger merged 31 commits into
mainfrom
chore/rename-ipc-service

Conversation

@thomaseizinger
Copy link
Copy Markdown
Member

@thomaseizinger thomaseizinger commented May 15, 2025

The name IPC service is not very descriptive. By nature of being separate processes, we need to use IPC to communicate between them. The important thing is that the service process has control over the tunnel. Therefore, we rename everything to "Tunnel service".

The only part that is not changed are historic changelog entries.

Resolves: #9048

@thomaseizinger thomaseizinger requested review from Copilot and jamilbk May 15, 2025 07:30
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR renames references from "IPC service" to "Tunnel service" to better reflect the service’s role in managing the tunnel control for the GUI client. Key changes include updating comments, error messages, and build scripts to reflect the new service name.

Reviewed Changes

Copilot reviewed 39 out of 39 changed files in this pull request and generated no comments.

Show a summary per file
File Description
rust/gui-client/src-tauri/src/lib.rs Updated comments to reference Tunnel service
rust/gui-client/src-tauri/src/ipc/windows.rs Updated inline comments from IPC to Tunnel service
rust/gui-client/src-tauri/src/ipc/linux.rs Updated documentation comments to reference Tunnel
rust/gui-client/src-tauri/src/ipc.rs Updated error messages and test comments accordingly
rust/gui-client/src-tauri/src/gui/system_tray.rs Updated comments to reflect the new service naming
rust/gui-client/src-tauri/src/elevation.rs Updated comments to mention Tunnel services
rust/gui-client/src-tauri/src/deep_link.rs Updated comments to reference Tunnel service
rust/gui-client/src-tauri/src/controller.rs Updated logging messages and notifications
rust/gui-client/src-tauri/src/clear_logs.rs Updated inline comments to reflect Tunnel service
rust/gui-client/src-tauri/rpm_files/firezone-gui-client.spec Updated binary and file paths for the Tunnel service
rust/gui-client/src-tauri/deb_files/prerm Updated service name in the pre-removal script
rust/gui-client/src-tauri/deb_files/postinst Updated service name in the post-installation script
rust/gui-client/src-tauri/deb_files/firezone-tunnel-service.service Updated service configuration details
rust/gui-client/docs/manual_testing.md Updated test cases to refer to Tunnel service
rust/gui-client/build.sh Updated build script paths and comments
rust/client-shared/src/callbacks.rs Updated documentation comments to reference Tunnel service
rust/bin-shared/src/known_dirs/windows.rs Updated inline comments describing service config paths
rust/bin-shared/src/known_dirs/linux.rs Updated inline comments describing service config paths
rust/bin-shared/src/dns_control.rs Updated TODO comments to reference Tunnel service
rust/bin-shared/src/device_id.rs Updated error context message for service config paths
Comments suppressed due to low confidence (1)

rust/gui-client/src-tauri/src/ipc.rs:32

  • The error message now refers to an IPC socket instead of a Tunnel service. Consider if this terminology should be updated further for consistency with the new naming convention.
#[error("Couldn't find IPC socket `{0}`")]

@thomaseizinger thomaseizinger force-pushed the chore/rename-ipc-service branch from c954424 to 22bb8c7 Compare May 15, 2025 07:35
@thomaseizinger

This comment was marked as outdated.

@thomaseizinger thomaseizinger force-pushed the chore/rename-ipc-service branch 3 times, most recently from eed1009 to afdf2bc Compare May 15, 2025 08:16
@thomaseizinger

This comment was marked as outdated.

@thomaseizinger thomaseizinger force-pushed the chore/rename-ipc-service branch from afdf2bc to be42257 Compare May 16, 2025 00:37
@vercel
Copy link
Copy Markdown

vercel Bot commented May 16, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
firezone ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 19, 2025 9:39am

@thomaseizinger
Copy link
Copy Markdown
Member Author

Copy link
Copy Markdown
Member

@jamilbk jamilbk left a comment

Choose a reason for hiding this comment

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

Isn't this a breaking change? What will happen to the old files on disk?

@thomaseizinger
Copy link
Copy Markdown
Member Author

thomaseizinger commented May 16, 2025

Isn't this a breaking change? What will happen to the old files on disk?

See all the changes I am making to the install scripts. I've already tested Ubuntu and Windows and the new installer scripts handle the rename gracefully and successfully. Old files no longer listed in a package are automatically removed by package managers.

Still need to test rpm but I don't have a VM for that yet ...

@thomaseizinger
Copy link
Copy Markdown
Member Author

thomaseizinger commented May 19, 2025

@thomaseizinger thomaseizinger added this pull request to the merge queue May 19, 2025
Merged via the queue into main with commit 1bdba36 May 19, 2025
111 checks passed
@thomaseizinger thomaseizinger deleted the chore/rename-ipc-service branch May 19, 2025 10:05
@thomaseizinger
Copy link
Copy Markdown
Member Author

@oddlama FYI: With the next release of the GUI client (1.4.14), the background service binary changes names which likely affects the Nix package. Nothing else changes though so should be pretty easy.

@oddlama
Copy link
Copy Markdown
Contributor

oddlama commented May 21, 2025

Thanks for the heads-up! Will keep that in mind

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.

refactor: rename "IPC service" to "tunnel service" everywhere

4 participants