aerospace: add workspace-to-monitor-force-assignment option and fix on-window-detected type

[thuvasooriya]

trying to fix #1142

this might be redundant or even extra since i found out later that we already have #1168
fixes the error for most of my use cases not sure if there are any other issues.

let me know if there is some changes that i should make for this to be merged.

[thuvasooriya]

This one solves the issue #1142 and implements [workspace-to-monitor-force-assignment]
@Enzime

[Enzime]

Can you remove all the formatting changes?

Can you update the tests as well?

[Enzime]

Can you update the settings above and use the new option you added and set on-window-detected maybe with the example value?

[Enzime]

Can you replace this check with something that actually checks the contents of $conf to see that it is setting the settings correctly like:

nix-darwin/tests/services-skhd.nix

Line 20 in c6b65d9

grep "alt + shift - r : chunkc quit" ${config.out}/etc/skhdrc

[thuvasooriya]

i was doubtful of the initial implementation of the testing as well, unfortunately I didn't know much about it, I'll try this weekend to replicate the skhd one.

[z0al]

Works locally for me. Thanks @thuvasooriya for taking care of this

[z0al]

Is there any reason for types.anything instead of a proper sub module?

[talhaHavadar]

I did try to come up with something more restricted (not much really) in #1168 but don't have much knowledge about aerospace and possible values of this toml table so we kind of backed up to accept everything. Just leaving it here in case we want to play with it a bit.

  callbackConf =
    with lib.types;
    oneOf [
      bool
      int
      float
      str
      path
      attrs
    ]
    // {
      description = "AeroSpace config callback (bool, int, float, str, path or attrs)";
    };
...
            on-window-detected = lib.mkOption {
              type = listOf (attrsOf (either callbackConf (listOf callbackConf)));
...

[z0al]

don't have much knowledge about aerospace and possible values of this toml table

Looking at the code & docs I believe:
1.run command is an array of strings and it's required.
2. if.app-id, if.workspace, if.window-title-regex-substring and if.app-name-regex-substring are all optional and of type string
3. if.during-aerospace-startup is a boolean and optional
4. check-further-callbacks is optional and of type boolean

I will leave it to @thuvasooriya if they want to add proper typing here. Otherwise, I can follow up with a PR once this is merged.

[thuvasooriya]

Thankyou for the valuable PR @talhaHavadar, and @z0al for taking the time to go through the docs. This was my first Nix contribution ever so I didn't want to mess around too much.
My initial solution before I saw #1168 was

              type = listOf (attrsOf (oneOf [
                bool
                str
                attrs
              ]));

which was not rigid in terms of types but then I changed it according to the suggestion made by @Enzime in #1168.
I'll see if I can come up with anything better. Thanks again.

[thuvasooriya]

thuvasooriya@49c1990
let me know if this can be merged to this PR @Enzime @z0al
Tried to whip something up from the above doc description, not sure if it handles all the edge cases. but works with the test cases and my config

edit: submodule types cause some issues with aerospace on-window-detected due to null values not available in TOML, the redundant default values of other if fields are conflicting or rather manipulating the functionality. Further testing and information about the actual types and handling of fields in aerospace is required to implement this properly.

I think this PR is in a good working condition. I think @z0al can try to crack the proper types when time allows. Not sure how much of a help this thuvasooriya@49c1990 can be but hope it helps.

@Enzime let me know if any further changes are required to this PR. Thanks.

[thuvasooriya]

You can try to filter the config of null values before passing the settings totoml.generate

This is what i was looking for.. Thx!
I was going to do this but then thought, maybe I'm just dumb and a better way exists in nix. Guess this is the way to go.

[z0al]

I'm a nix noob myself but that's what I see being done in nixpkgs.

[thuvasooriya]

unfortunately replicating the filter is somewhat troublesome for me.
my guess is that the list of submodules is not playing nicely with filterAttrs.
I tried the following and still get the above error: cannot convert data to TOML,
meaning the null is not filtered.

I tried the default functions, filterAttrs, filterAttrsRecursive
Then I tried to implement a custom function to iterate over each item in the submodule list. Which doesn't work either. Maybe there is some obvious mistake that I'm overlooking.
Any help or direction would be appreciated. @Enzime @z0al

  filterOptionalFields = value:
    if lib.isAttrs value then
      let
        filteredAttrs = lib.mapAttrs (_: v: filterOptionalFields v) value;
        nonNullAttrs = lib.filterAttrs (_: v: v != null) value;
      in
        filteredAttrs // nonNullAttrs
    else if lib.isList value then
      lib.filter (x: x != null) (map filterOptionalFields value)
    else
      value;
  # filterOptionalFields = lib.filterAttrsRecursive (_: v: v != null);
  configFile = format.generate "aerospace.toml" (filterOptionalFields cfg.settings);

[z0al]

Ah, I see. My bad. I didn't know that filterAttrsRecursive doesn't handle the case of lists.

Here is a custom implementation that works. I took the original filterAttrsRecursive code and added a condition for lists + changed the predicate signature to accept only values.

  # Code needs proper formatting
  filterAttrsRecursive =
    pred:
    set:
    lib.listToAttrs (
      lib.concatMap
        (name:
        let v = set.${name}; in
        if pred v then [
          (lib.nameValuePair name (
            if lib.isAttrs v then filterAttrsRecursive pred v
            else if lib.isList v then
              (
                map
                  (i:
                  if lib.isAttrs i then
                    filterAttrsRecursive pred i
                  else i)
                  (lib.filter pred v)
              )
            else v
          ))
        ] else [ ]
        )
        (lib.attrNames set)
    );
  filterNulls = filterAttrsRecursive (v: v != null);
  configFile = format.generate "aerospace.toml" (filterNulls cfg.settings);

Let's hope that Enzime has a trick up their sleeve so we don't have to keep this custom function :)

P.S. Don't forget to change all optional attributes to default to null even things like check-further-callbacks as Aerospace behaves differently when it's set to false vs left out.

[thuvasooriya]

cool! it works! thanks.
merged the changes, and yes every optional is set to null by default.

[thuvasooriya]

@Enzime just made a small change to detect window-title-regex-substring not being present, and added example configs for all the other callback examples. if we have to do this properly then we should check how the whole file is output in order to check the presence or absence of certain troublemakers.

This works flawless for now. Let me know if you want anything else for this to be merged.

[yzx9]

Hello, just checking in—any updates? I really need this!

[thuvasooriya]

@Enzime pinging again just in case you missed this. I hope this has no blockers for a merge.

[Enzime]

Can you squash all the commits and rebase this on top of master?

[thuvasooriya]

@Enzime can you confirm this is what you requested? never done this sort of thing before

[Enzime]

LGTM

Thanks for the contribution