contib: add direnv implementation #4

blaggacao · 2023-04-08T19:35:30Z

Without `PRJ_ID`:

$ direnv reload # initial
[ ... ]
direnv: Add to .git/info/exclude: /.config
direnv: Add to .git/info/exclude: /.cache
direnv: Add to .git/info/exclude: /.local/share
direnv: Add to .git/info/exclude: /.local/state
direnv: Add to .git/info/exclude: /.run
direnv: PRJ_ROOT:        /home/blaggacao/src/github.com/paisano-nix/tui
direnv: PRJ_ID:          none
direnv: PRJ_CONFIG_HOME: .config
direnv: PRJ_RUNTIME_DIR: .run
direnv: PRJ_CACHE_HOME:  .cache
direnv: PRJ_DATA_HOME:   .local/share
direnv: PRJ_STATE_HOME:  .local/state
direnv: PRJ_PATH:        .local/bin
[ ... ]

$ direnv reload # subsequent
[ ... ]
direnv: PRJ_ROOT:        /home/blaggacao/src/github.com/paisano-nix/tui
direnv: PRJ_ID:          none
direnv: PRJ_CONFIG_HOME: .config
direnv: PRJ_RUNTIME_DIR: .run
direnv: PRJ_CACHE_HOME:  .cache
direnv: PRJ_DATA_HOME:   .local/share
direnv: PRJ_STATE_HOME:  .local/state
direnv: PRJ_PATH:        .local/bin
[ ... ]

With `PRJ_ID`:

uuidgen > .config/prj_id

$ direnv reload # initial
[ ... ]
direnv: Add to .git/info/exclude: /.config
direnv: Add to .git/info/exclude: /.run
direnv: PRJ_ROOT:        /home/blaggacao/src/github.com/paisano-nix/tui
direnv: PRJ_ID:          44850561-5378-499b-9e95-8549b4bc8596
direnv: PRJ_CONFIG_HOME: .config
direnv: PRJ_RUNTIME_DIR: .run
direnv: PRJ_CACHE_HOME:  /home/blaggacao/.cache/prj/44850561-5378-499b-9e95-8549b4bc8596
direnv: PRJ_DATA_HOME:   /home/blaggacao/.local/share/prj/44850561-5378-499b-9e95-8549b4bc8596
direnv: PRJ_STATE_HOME:  /home/blaggacao/.local/state/prj/44850561-5378-499b-9e95-8549b4bc8596
direnv: PRJ_PATH:        /home/blaggacao/.local/bin/prj/44850561-5378-499b-9e95-8549b4bc8596
[ ... ]

$ direnv reload # subsequent
[ ... ]
direnv: PRJ_ROOT:        /home/blaggacao/src/github.com/paisano-nix/tui
direnv: PRJ_ID:          44850561-5378-499b-9e95-8549b4bc8596
direnv: PRJ_CONFIG_HOME: .config
direnv: PRJ_RUNTIME_DIR: .run
direnv: PRJ_CACHE_HOME:  /home/blaggacao/.cache/prj/44850561-5378-499b-9e95-8549b4bc8596
direnv: PRJ_DATA_HOME:   /home/blaggacao/.local/share/prj/44850561-5378-499b-9e95-8549b4bc8596
direnv: PRJ_STATE_HOME:  /home/blaggacao/.local/state/prj/44850561-5378-499b-9e95-8549b4bc8596
direnv: PRJ_PATH:        /home/blaggacao/.local/bin/prj/44850561-5378-499b-9e95-8549b4bc8596
[ ... ]

Silence, please ...

$ export DIRENV_PRJ_SILENCE=true;

$ direnv reload # initial
[ ... ]
direnv: PRJ_CONFIG_HOME: .config
direnv: PRJ_RUNTIME_DIR: .run
# more if PRJ_ID is not set
[ ... ]

$ direnv reload # subsequent
[ ... ]

zimbatm · 2023-04-10T09:21:28Z

contrib/direnv

+find_prj_config() (
+	local old_pwd
+	while [[ $old_pwd != $PWD ]]; do
+		if [[ -d .config ]]; then


Something I just thought about: this will find the $HOME/.config folder if the repo doesn't hold one. Maybe the existence of the prj_id should be mandated, it would make that more explicit.

Yes, this can be too ambiguous. And I already sort of thought about this problem, but then chose not to address it on the first iteration. But it needs to be addressed before merge.

addressed in 44d2b5f.

@zimbatm is that imlementation good enough for our purpose here?

contrib/direnv

zimbatm · 2023-04-10T09:28:13Z

contrib/direnv

+	: "${XDG_STATE_HOME:=${HOME}/.local/state}"
+	: "${XDG_RUNTIME_DIR:=${HOME}/.local/state}"


On my system, XDG_RUNTIME_DIR is pointing to /run/user/1000

Yes, this is a "deviaton" from the XDG convention.
This is mainly useful for dev services, which can be configured to use it and the user will be able to find it in the same place.

For example mariadb by default can't be killed with CTRL+D so having the pid file at hand may end up being handy for some extra whichcraft. Or another thing could be project-local service sockets....

contrib/direnv

zimbatm · 2023-04-10T14:41:51Z

contrib/direnv

+export PRJ_DATA_HOME
+export PRJ_STATE_HOME
+export PRJ_RUNTIME_DIR


What is the difference between PRJ_DATA_HOME, PRJ_STATE_HOME and PRJ_RUNTIME_DIR?

According to XDG, DATA is for potentially sharable data that is useful independent of the context of the concrete user environment. One example that comes to my mind would be blockchain state. A way to think about it would be a hypothetical user that works on mac and linux interchangeably but shares projects on a NFS. DATA should not hold arch-specific data.

STATE, however, could be a stateful application file (these are rare these days), that don't immediately make sense to share, either because they are arch-specific or their lifetime is bound to the host machine. A better use in most cases would be /tmp, but still, maybe an application stores last startup configuration to resume on. The Paisano TUI/CLI is recording the last executed action there in order to facilitate manual debugging but also because the invocation sequence requires a file proxy at some point. Another state would be the non-atomic bits of a transaction before it becomes settled and moves to DATA.

PRJ_RUNTIME_DIR is usually just pids and sockets.

Removed PRJ_STATE_HOME in 7dfd31d.

But I'm keeping PRJ_RUNTIME_DIR for deveshell services use case ("find their pids easily").

@zimbatm would that be ok (keep PRJ_RUNTIME_DIR)? Would you like me to expand more on the use case?

cscutcher

Stopping by mostly after discovering (I think) some issues with how this code behaves in an environment with linked git worktrees (i.e. created via git worktree add).

Hope it's OK if I made some other related suggestions while I was in the area.

As always, thanks for making the effort and sharing the code!

contrib/direnv

the distinction from PRJ_DATA_HOME is too vague in the repository context

contrib/direnv

zimbatm · 2023-06-25T16:23:24Z

@blaggacao happy to merge this once you tell me it's ready

blaggacao · 2023-06-26T12:56:16Z

@zimbatm I'll bump downstream useages to the tip of this branch and keep running it for a while in real life. It looks like everything is addressed, now, so if that remains true I'll ping you in a couple of weeks. Thank you!

cscutcher

Hopefully, this doesn't cause more problems. I only just noticed the review request and wanted to make sure the lack of change to find_prj_root_with_git was intentional.

contrib/direnv

If users need global shared state, that's what PRJ_ID is for, deviating to XDG directories.

blaggacao · 2023-07-10T22:04:29Z

@zimbatm 9b0ffcd has already propagated for a while ot some real world environments via this facility.

@cscutcher Has been an excellent reviewer. I greatly appreciate your engagement. It would not have been possible to polish this off so fast without your involvement.

All this to say: This is reasonably ready for merge. Should something arise, a fix it shall be.

blaggacao force-pushed the contrib-add-direnv-lib branch from 0613548 to 3c89bd5 Compare April 8, 2023 19:55

blaggacao marked this pull request as ready for review April 8, 2023 20:01

contib: add direnv implementation

cdceb61

blaggacao force-pushed the contrib-add-direnv-lib branch from 3c89bd5 to cdceb61 Compare April 8, 2023 20:22

zimbatm reviewed Apr 10, 2023

View reviewed changes

contrib(direnv): simplify / straighten folder layout by default

1ac38ef

cscutcher reviewed May 13, 2023

View reviewed changes

contrib/direnv Outdated Show resolved Hide resolved

contrib/direnv Outdated Show resolved Hide resolved

contrib/direnv Outdated Show resolved Hide resolved

contrib/direnv Show resolved Hide resolved

cscutcher mentioned this pull request May 13, 2023

Current (c38ef9362) version of numtide/prj-spec/contrib/direnv misbehaves when using linked git worktrees paisano-nix/direnv#2

Open

blaggacao added 4 commits June 20, 2023 17:02

fix: remove pontentially harmful excess convenience

4b57523

chore: remove edge case PRJ_STATE_HOME from the implementation

7dfd31d

the distinction from PRJ_DATA_HOME is too vague in the repository context

fix: root discovery and clarify the discovery routines

3ea5e75

fix: don't detect prj root based on .config if pwd is home

44d2b5f

blaggacao requested review from zimbatm and cscutcher June 20, 2023 22:25

cscutcher reviewed Jun 21, 2023

View reviewed changes

contrib/direnv Outdated Show resolved Hide resolved

cscutcher suggested changes Jun 27, 2023

View reviewed changes

contrib/direnv Outdated Show resolved Hide resolved

contrib/direnv Outdated Show resolved Hide resolved

contrib/direnv Show resolved Hide resolved

contrib/direnv Outdated Show resolved Hide resolved

contrib/direnv Show resolved Hide resolved

blaggacao added 4 commits June 28, 2023 19:29

fix: if in worktree, use that as PRJ_ROOT

440705a

If users need global shared state, that's what PRJ_ID is for, deviating to XDG directories.

chore: appease shellcheck

738a036

fix: cleanup prj state home

acb9f46

fix: don't accidentially assign PRJ_ID

9b0ffcd

cscutcher approved these changes Jul 10, 2023

View reviewed changes

zimbatm merged commit 61f25b0 into numtide:main Jul 11, 2023

blaggacao deleted the contrib-add-direnv-lib branch July 11, 2023 10:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

contib: add direnv implementation #4

contib: add direnv implementation #4

blaggacao commented Apr 8, 2023 •

edited

Loading

zimbatm Apr 10, 2023

blaggacao Apr 10, 2023

blaggacao Jun 20, 2023

zimbatm Apr 10, 2023

blaggacao Apr 10, 2023

zimbatm Apr 10, 2023

blaggacao Apr 10, 2023 •

edited

Loading

blaggacao Apr 10, 2023 •

edited

Loading

blaggacao Jun 20, 2023

blaggacao Jun 20, 2023

cscutcher left a comment

zimbatm commented Jun 25, 2023

blaggacao commented Jun 26, 2023 •

edited

Loading

cscutcher left a comment

blaggacao commented Jul 10, 2023

		: "${XDG_STATE_HOME:=${HOME}/.local/state}"
		: "${XDG_RUNTIME_DIR:=${HOME}/.local/state}"

contib: add direnv implementation #4

contib: add direnv implementation #4

Conversation

blaggacao commented Apr 8, 2023 • edited Loading

Without PRJ_ID:

With PRJ_ID:

Silence, please ...

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

blaggacao Apr 10, 2023 • edited Loading

Choose a reason for hiding this comment

blaggacao Apr 10, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cscutcher left a comment

Choose a reason for hiding this comment

zimbatm commented Jun 25, 2023

blaggacao commented Jun 26, 2023 • edited Loading

cscutcher left a comment

Choose a reason for hiding this comment

blaggacao commented Jul 10, 2023

blaggacao commented Apr 8, 2023 •

edited

Loading

Without `PRJ_ID`:

With `PRJ_ID`:

blaggacao Apr 10, 2023 •

edited

Loading

blaggacao Apr 10, 2023 •

edited

Loading

blaggacao commented Jun 26, 2023 •

edited

Loading