WayfireWM / WayfireWM/wayfire

Provide a better way to let the user understand that setting options via IPC will make subsequent config file changes ineffective

Open
#2,707 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement idea low-priority
Dominant language
C++
Stars
3.1k
Forks
237
Avg merge
1h 43m
Merged PRs (30d)
1

Description

Describe the bug

    this->plugins_opt.set_callback([=] ()
    {
        /* reload when config reload has finished */
        idle_reload_plugins.run_once([&] () { reload_dynamic_plugins(); });
    });

Plugin reload/enable/disable will stop working after using set_option_values.

To Reproduce
Steps to reproduce the behavior:

def verify_required_wayfire_plugins():
    required_plugins = {
        "stipc",
        "ipc",
        "ipc-rules",
        "resize",
        "window-rules",
        "wsets",
        "session-lock",
        "wm-actions",
        "move",
        "vswitch",
        "grid",
        "place",
        "scale",
    }

    enabled_plugins = sock.get_option_value("core/plugins")["value"].split()

    for plugin_name in required_plugins:
        if plugin_name not in enabled_plugins:
            enabled_plugins.append(plugin_name)

    sock.set_option_values({"core/plugins": " ".join(enabled_plugins)})

verify_required_wayfire_plugins()

disable or enable a plugin in wayfire.ini

Expected behavior
plugin-loader should at least LOGE the reason why the plugins can't reload/enable/disable.

Suggestion
reload_config_signal somewhere in set_config_options will set a callback LOGI with the options that can't be modified by wayfire.ini

Why consider the Suggestion
It took me a while to find the issue, others might face the same problem without knowing the cause, some others could set random plugins options and complain later why these options is not changing through wayfire.ini.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing set_option_values through set_config_options and the plugin-loader path, including the reload_config_signal callback and reload_dynamic_plugins. Reproduce the sequence with the supplied verify_required_wayfire_plugins example, then confirm that changing wayfire.ini reports which options cannot be modified and explains why plugin reload, enable, or disable does not take effect.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, python
Domain
api, backend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.