ags: 1.8.2 -> 2.2.1 #373562

PerchunPak · 2025-01-13T21:38:19Z

https://github.com/Aylur/ags: Scaffolding CLI for Astal+TypeScript

This is basically a complete rewrite (as upstream was rewritten in Go). It is required for #350324, I also built a completely functioning version of hyprpanel using this, so it totally works!

Also, it is almost 1 to 1 copy of the upstream Nix implementation, but this is much more versatile.

Closes #306446

Things done

CC @FliegendeWurst @foo-dogsquared @JohnRTitor

Add a 👍 reaction to pull requests you find important.

PerchunPak · 2025-01-13T21:39:00Z

pkgs/by-name/ag/ags/package.nix

+  ldflags = [
+    "-s"
+    "-w"
+    "-X main.astalGjs=${astal.gjs}/share/astal/gjs"


BTW, because of this single line I wasted an entire day

PerchunPak · 2025-01-13T21:50:34Z

`nixpkgs-review` result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 373562

`x86_64-linux`

✅ 1 package built:

ags

`aarch64-linux`

✅ 1 package built:

ags

pkgs/by-name/ag/ags/bundle.nix

JohnRTitor

Please also add a release-notes, prompting users to switch to ags_1 if they want to retain compatibility with previous config.

As this is a backwards incompatible change, we should not backport it.

nixos/doc/manual/release-notes/rl-2505.section.md

Don't block

JohnRTitor · 2025-01-14T14:41:08Z

I'll get to reviewing Friday of next week.

(Will be busy for work for the next week till the weekend)

If anyone wants to review this and merge, they can go ahead.

pkgs/by-name/ag/ags/package.nix

JohnRTitor · 2025-01-14T17:10:09Z

pkgs/by-name/ag/ags/package.nix


  meta = {
+    description = "Scaffolding CLI for Astal+TypeScript";


As per https://github.com/NixOS/nixpkgs/pull/373562/files#r1914975896

Something like "Typescript frontend of Widget system powered by Astal"

You can put more details/explain in longDescription

I find your description a bit difficult to follow without any background context. In comparison, the description from upstream seems a bit clearer in this regard.

I don't know, "Scaffolding CLI for Astal", doesn't seem to explain its purpose. On a quick search if someone wants a widget system, ags won't appear.

Astal is the widget system, this is just a CLI for it

I tried to revise the description for astal and ags a bit more, check now

JohnRTitor · 2025-01-18T06:32:49Z

nixos/doc/manual/release-notes/rl-2505.section.md

@@ -212,6 +212,8 @@
  [v1.7.0](https://github.com/jtroo/kanata/releases/tag/v1.7.0)
  for more information.

+- `ags` was updated to v2, which is brand new project with different goals. If you still need v1, use `ags_1`.


You definitely should explain a bit here.

Is it better now?

pkgs/by-name/ag/ags/bundle.nix

JohnRTitor · 2025-01-18T06:43:26Z

pkgs/by-name/ag/ags/package.nix

+    writers.writeNu "datadirs"
+      # nu
+      ''
+        $env.XDG_DATA_DIRS
+        | split row ":"
+        | filter { $"($in)/gir-1.0" | path exists }
+        | str join ":"
+      '';


As I understand this, this just gets XDG_DATA_DIRS at build time and extracts the needed paths from there and puts it in the file?

So this depends on builder's XDG_DATA_DIRS info? Isn't that impure/not reproducible?

Kind of. Environment variables are secured by Nix sandbox, but this hard-codes library paths to one that are used in build time. However, I am unsure how to get those directories in runtime, and this seems like a bug that should be handled by upstream.

I am worried that some dirs/paths from builder/Hydra may not exist in local machine.

@Aylur .

It is very much a hack.
I could not find a way to reference the gir-1.0 paths at runtime so I ended up doing this. It is only polluted at build time with references to glib based libraries and even if something leaks into it from the outside environment it does not have any effect as this is only used to generate types for LSPs. It does not have an effect at runtime.

The function that uses this variable is called in ags init and ags types, so it is pretty much a runtime thing

@Aylur

@Aylur, fmt.Println(os.Getenv("XDG_DATA_DIRS")) has /nix/store/g8lbqn7mw42pddh57bz9570sfc7fajkf-ags-2.2.1/share as a first item

Aylur/ags#673

At this point I am tempted to @jtojnar for intel.

Hard to say what is the proper solution without knowing why does the program need access to GIR files at runtime. Typically, those are used at build time to generate bindings modules for static languages, and our gobject-introspection setup hook already populates XDG_DATA_DIRS at build time from dependencies:

nixpkgs/pkgs/development/libraries/gobject-introspection/setup-hook.sh

Lines 8 to 10 in cf577e4

if [ -d "$1/share/gir-1.0" ]; then

addToSearchPath XDG_DATA_DIRS $1/share

fi

As @PerchunPak says, this is not a problem with reproducibility thanks to the sandbox. The main issue would be that it might pick up GIR files pointing to typelibs for build platform when doing a cross-compilation but this software looks complex enough that cross-compilation will probably be broken in multiple different ways anyway so I would not worry about it. You can try strictDeps = true for peace of mind.

I also do not understand the reason for a custom environment variable rather than just using XDG_DATA_DIRS (following XDG basedir spec) + GI_GIR_PATH.

We might want to switch the setup hook to the latter to make GIR paths easier to pick up.

@jtojnar, this is a build tool, so we need GIR files to generate types while user develops their application.

And it fails with strictDeps = true. But because ags.bundle (the thing that developer would use) causes a rebuild of ags, it should not be a problem (unless many edge-cases, of course).

So, there is no better solution than what we already have...

pkgs/by-name/ag/ags/package.nix

JohnRTitor · 2025-01-27T11:58:04Z

I like the upstream approach, perhaps we can use that? (Aylur/ags#673)

PerchunPak commented Jan 13, 2025

View reviewed changes

PerchunPak force-pushed the ags branch from 3d34731 to 901b623 Compare January 13, 2025 21:41

github-actions bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 labels Jan 13, 2025

nix-owners bot requested review from JohnRTitor and foo-dogsquared January 13, 2025 21:49

PerchunPak mentioned this pull request Jan 13, 2025

Package request: hyprpanel #350324

Open

JohnRTitor reviewed Jan 14, 2025

View reviewed changes

pkgs/by-name/ag/ags/bundle.nix Show resolved Hide resolved

JohnRTitor previously requested changes Jan 14, 2025

View reviewed changes

PerchunPak force-pushed the ags branch 2 times, most recently from 421966a to 83bd23a Compare January 14, 2025 07:08

github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: documentation This PR adds or changes documentation 8.has: changelog labels Jan 14, 2025

JohnRTitor reviewed Jan 14, 2025

View reviewed changes

nixos/doc/manual/release-notes/rl-2505.section.md Outdated Show resolved Hide resolved

PerchunPak force-pushed the ags branch from 83bd23a to ff7f70b Compare January 14, 2025 08:38

github-actions bot removed 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: documentation This PR adds or changes documentation 8.has: changelog labels Jan 14, 2025

PerchunPak changed the title ~~ags: 1.8.2 -> 2.2.1~~ ags-cli: init at 2.2.1 Jan 14, 2025

PerchunPak force-pushed the ags branch from ff7f70b to 83bd23a Compare January 14, 2025 10:30

PerchunPak changed the title ~~ags-cli: init at 2.2.1~~ ags: 1.8.2 -> 2.2.1 Jan 14, 2025

github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: documentation This PR adds or changes documentation 8.has: changelog labels Jan 14, 2025

JohnRTitor self-assigned this Jan 14, 2025

FliegendeWurst reviewed Jan 14, 2025

View reviewed changes

pkgs/by-name/ag/ags/package.nix Outdated Show resolved Hide resolved

PerchunPak force-pushed the ags branch from 83bd23a to fdbffc7 Compare January 14, 2025 17:06

JohnRTitor reviewed Jan 14, 2025

View reviewed changes

PerchunPak force-pushed the ags branch 2 times, most recently from 9b190b5 to f3a8a14 Compare January 14, 2025 17:45

nix-owners bot requested review from hsjobeki, GetPsyched and fricklerhandwerk January 14, 2025 17:47

github-actions bot added 10.rebuild-darwin: 1-10 and removed 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin labels Jan 14, 2025

JohnRTitor reviewed Jan 18, 2025

View reviewed changes

pkgs/by-name/ag/ags/bundle.nix Outdated Show resolved Hide resolved

JohnRTitor reviewed Jan 18, 2025

View reviewed changes

pkgs/by-name/ag/ags/package.nix Outdated Show resolved Hide resolved

PerchunPak force-pushed the ags branch from f3a8a14 to e51bb16 Compare January 18, 2025 07:12

PerchunPak added 2 commits January 18, 2025 08:41

astal.io: revise description

47cf5b2

ags: rename to ags_1

24e50b3

PerchunPak force-pushed the ags branch from e51bb16 to 4d62e09 Compare January 18, 2025 07:41

PerchunPak mentioned this pull request Jan 20, 2025

nix: remove XDG_DATA_DIR env reference Aylur/ags#673

Merged

ags: init at 2.2.1

2a4ce90

PerchunPak force-pushed the ags branch from 4d62e09 to 2a4ce90 Compare January 26, 2025 11:53

github-actions bot added the 10.rebuild-darwin: 1 label Jan 26, 2025

jtojnar mentioned this pull request Jan 26, 2025

Patch gobjectIntrospection to use GI_GIR_PATH #32790

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ags: 1.8.2 -> 2.2.1 #373562

ags: 1.8.2 -> 2.2.1 #373562

PerchunPak commented Jan 13, 2025 •

edited

Loading

PerchunPak Jan 13, 2025

PerchunPak commented Jan 13, 2025

JohnRTitor left a comment

JohnRTitor commented Jan 14, 2025

JohnRTitor Jan 14, 2025 •

edited

Loading

PerchunPak Jan 14, 2025

JohnRTitor Jan 18, 2025

PerchunPak Jan 18, 2025

PerchunPak Jan 18, 2025

JohnRTitor Jan 18, 2025

PerchunPak Jan 18, 2025

JohnRTitor Jan 18, 2025 •

edited

Loading

PerchunPak Jan 18, 2025

JohnRTitor Jan 18, 2025 •

edited

Loading

Aylur Jan 19, 2025

PerchunPak Jan 19, 2025

PerchunPak Jan 20, 2025

Aylur Jan 20, 2025

JohnRTitor Jan 21, 2025

jtojnar Jan 26, 2025

PerchunPak Jan 26, 2025

JohnRTitor commented Jan 27, 2025


		meta = {
		description = "Scaffolding CLI for Astal+TypeScript";

	if [ -d "$1/share/gir-1.0" ]; then
	addToSearchPath XDG_DATA_DIRS $1/share
	fi

ags: 1.8.2 -> 2.2.1 #373562

Are you sure you want to change the base?

ags: 1.8.2 -> 2.2.1 #373562

Conversation

PerchunPak commented Jan 13, 2025 • edited Loading

Things done

Choose a reason for hiding this comment

PerchunPak commented Jan 13, 2025

nixpkgs-review result

x86_64-linux

aarch64-linux

JohnRTitor left a comment

Choose a reason for hiding this comment

JohnRTitor commented Jan 14, 2025

JohnRTitor Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JohnRTitor Jan 18, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JohnRTitor Jan 18, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JohnRTitor commented Jan 27, 2025

PerchunPak commented Jan 13, 2025 •

edited

Loading

`nixpkgs-review` result

`x86_64-linux`

`aarch64-linux`

JohnRTitor Jan 14, 2025 •

edited

Loading

JohnRTitor Jan 18, 2025 •

edited

Loading

JohnRTitor Jan 18, 2025 •

edited

Loading