Gitea Snap update issue #16209

[OleHusgaard]

Fixes #16209 for new repositories created. The problem is that hooks in new repositories created when running in snap include the snap revision in the path. As the snap is refreshed the hooks eventually break.
This pull request does not fix repositories already created. Here a good workaround has been suggested by JensTheCoder.
Please be aware that I am a newbie to both gitea, snap and golang.

[codecov-commenter]

Codecov Report

Merging #17157 (2df0e4c) into main (f2e7d54) will decrease coverage by 0.01%.
The diff coverage is 55.10%.

@@            Coverage Diff             @@
##             main   #17157      +/-   ##
==========================================
- Coverage   45.31%   45.30%   -0.02%     
==========================================
  Files         773      774       +1     
  Lines       86873    87056     +183     
==========================================
+ Hits        39366    39440      +74     
- Misses      41151    41230      +79     
- Partials     6356     6386      +30     

Impacted Files	Coverage Δ
cmd/admin.go	0.00% <0.00%> (ø)
models/action.go	48.86% <0.00%> (ø)
models/avatar.go	35.38% <0.00%> (ø)
models/error.go	39.83% <ø> (+0.29%)	⬆️
models/fixture_generation.go	70.00% <0.00%> (ø)
models/gpg_key_verify.go	13.46% <0.00%> (ø)
models/issue_lock.go	0.00% <0.00%> (ø)
models/migrate.go	0.00% <0.00%> (ø)
models/pull_sign.go	37.64% <0.00%> (ø)
models/repo_archiver.go	6.25% <0.00%> (ø)
... and 204 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 74542ad...2df0e4c. Read the comment docs.

[wxiaoguang]

Can you write more comments here? It will be easier for other people to understand what the issue is and how it is fixed.

[OleHusgaard]

I added comments about the problem, and how it is fixed,

[wxiaoguang]

Thank you, it's clear for me. I think we should be more careful here:

1. We should check whether the current path really exists and is valid. If not, an ERROR log should be reported, and fallback to use old AppPath.
2. We should output an INFO level log to tell users that we are in SNAP and have changed the AppPath for this purpose. Or users may be confused by this behavior (it will be very hard to debug)

[techknowlogick]

Here is the solution I was talking about in the issue ticket:

replace var appPath string with

appPath := AppPath

if appPath != "" {
	return appPath, nil
}

then put the following in the snapcraft yaml above the make build command

export LDFLAGS="-X \"code.gitea.io/gitea/modules/setting.AppPath=/var/snap/gitea/current/gitea\" ${LDFLAGS}"

(note: I'm not 100% sure the above filepath is correct, please ensure it is correct)

[wxiaoguang]

then put the following in the snapcraft yaml above the make build command

export LDFLAGS="-X \"code.gitea.io/gitea/modules/setting.AppPath=/var/snap/gitea/current/gitea\" ${LDFLAGS}"

@techknowlogick It's not a good idea to hard code the path in source code when building, what if sys admin changed the snap path ... Can we find someway to pass the AppPath by environment variables provided by snap system?

I have no experience with snap, but I think there should be some way: https://snapcraft.io/docs/environment-variables , https://snapcraft.io/docs/parts-environment-variables .

[techknowlogick]

@wxiaoguang yeah, we could do similarly to the getWorkPath function, where if os.LookupEnv("GITEA_WORK_DIR"); is set, then it'll return the value of that env var (except of course it wouldn't be the that exact env var).

[OleHusgaard]

@wxiaoguang yeah, we could do similarly to the getWorkPath function, where if os.LookupEnv("GITEA_WORK_DIR"); is set, then it'll return the value of that env var (except of course it wouldn't be the that exact env var).

@techknowlogick I like this approach, as it would be cleaner and simpler than my hack. However we still have to get the right path, which it does not look like snap is providing. But we could derive it from the other snap variables by adding something like this to the snap environment:
GITEA_APP_PATH: "$(echo "$SNAP/$SNAP_NAME"|sed "s/$SNAP_REVISION/current/")"

Should I try this approach instead?

[techknowlogick]

@OleHusgaard oh yea! That's a great approach, thanks :)

[wxiaoguang]

The problem should have been fixed by

• Sync gitea app path for git hooks and authorized keys when starting #17335