mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-02-12 04:40:36 +00:00
ed63f06d79
This PR does three things: - First it moves the inline web app manifest into its own route `/manifest.json` - Secondly, it add a setting `pwa.STANDALONE` that can be set to `true` if one wants users to be allowed to "install" forgejo as an pwa into their browser. This usually means an "install app" button, which essentially just creates an shortcut to use a single-tab window for browsing the app / forgejo. - Thirdly since we have now an extra route, it checks if someone placed a `public/manifest.json` in forgejo's custom path; if yes, it's content is served instead. This allows more customization without the need on our side to completly implement every nuance of web app manifests. This closes issue #2638 ### Tests - I added test coverage for Go changes... - [x] in their respective `*_test.go` for unit tests. ### Documentation - [x] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs/pulls/1669) to explain to Forgejo users how to use this change. ### Release notes - [ ] I do not want this change to show in the release notes. - [ ] I want the title to show in the release notes with a link to this pull request. - [x] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title. <!--start release-notes-assistant--> ## Release notes <!--URL:https://codeberg.org/forgejo/forgejo--> - Features - [PR](https://codeberg.org/forgejo/forgejo/pulls/5384): <!--number 5384 --><!--line 0 --><!--description W2FsbG93IGZvcmdlam8gdG8gcnVuIGFzIGEgcHdhIHN0YW5kYWxvbmUgYXBwbGljYXRpb24gJiBvdmVycmlkZSBvZiB0aGUgd2ViYXBwIG1hbmlmZXN0Lmpzb24gdmlhIHRoZSBhIGN1c3RvbSBmaWxlIGluIGBwdWJsaWMvbWFuaWZlc3QuanNvbmBdKGh0dHBzOi8vY29kZWJlcmcub3JnL2Zvcmdlam8vZm9yZ2Vqby9wdWxscy81Mzg0KQ==-->[allow forgejo to run as a pwa standalone application & override of the webapp manifest.json via the a custom file in `public/manifest.json`](https://codeberg.org/forgejo/forgejo/pulls/5384)<!--description--> <!--end release-notes-assistant--> Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/5384 Reviewed-by: Otto <otto@codeberg.org> Reviewed-by: Lucas <sclu1034@noreply.codeberg.org> Co-authored-by: Mai-Lapyst <mai-lapyst@noreply.codeberg.org> Co-committed-by: Mai-Lapyst <mai-lapyst@noreply.codeberg.org>
126 lines
3.7 KiB
Go
126 lines
3.7 KiB
Go
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// Copyright 2025 The Forgejo Authors. All rights reserved
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package setting
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"forgejo.org/modules/json"
|
|
"forgejo.org/modules/test"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestMakeAbsoluteAssetURL(t *testing.T) {
|
|
assert.Equal(t, "https://localhost:2345", MakeAbsoluteAssetURL("https://localhost:1234", "https://localhost:2345"))
|
|
assert.Equal(t, "https://localhost:2345", MakeAbsoluteAssetURL("https://localhost:1234/", "https://localhost:2345"))
|
|
assert.Equal(t, "https://localhost:2345", MakeAbsoluteAssetURL("https://localhost:1234/", "https://localhost:2345/"))
|
|
assert.Equal(t, "https://localhost:1234/foo", MakeAbsoluteAssetURL("https://localhost:1234", "/foo"))
|
|
assert.Equal(t, "https://localhost:1234/foo", MakeAbsoluteAssetURL("https://localhost:1234/", "/foo"))
|
|
assert.Equal(t, "https://localhost:1234/foo", MakeAbsoluteAssetURL("https://localhost:1234/", "/foo/"))
|
|
assert.Equal(t, "https://localhost:1234/foo", MakeAbsoluteAssetURL("https://localhost:1234/foo", "/foo"))
|
|
assert.Equal(t, "https://localhost:1234/foo", MakeAbsoluteAssetURL("https://localhost:1234/foo/", "/foo"))
|
|
assert.Equal(t, "https://localhost:1234/foo", MakeAbsoluteAssetURL("https://localhost:1234/foo/", "/foo/"))
|
|
assert.Equal(t, "https://localhost:1234/bar", MakeAbsoluteAssetURL("https://localhost:1234/foo", "/bar"))
|
|
assert.Equal(t, "https://localhost:1234/bar", MakeAbsoluteAssetURL("https://localhost:1234/foo/", "/bar"))
|
|
assert.Equal(t, "https://localhost:1234/bar", MakeAbsoluteAssetURL("https://localhost:1234/foo/", "/bar/"))
|
|
}
|
|
|
|
func TestMakeManifestData(t *testing.T) {
|
|
jsonBytes, err := GetManifestJSON()
|
|
require.NoError(t, err)
|
|
assert.True(t, json.Valid(jsonBytes))
|
|
}
|
|
|
|
func TestMakeManifestDataStandalone(t *testing.T) {
|
|
defer test.MockVariableValue(&PWA.Standalone, true)()
|
|
|
|
jsonBytes, err := GetManifestJSON()
|
|
require.NoError(t, err)
|
|
assert.True(t, json.Valid(jsonBytes))
|
|
assert.Contains(t, string(jsonBytes), `"standalone"`)
|
|
}
|
|
|
|
func TestLoadServiceDomainListsForFederation(t *testing.T) {
|
|
oldAppURL := AppURL
|
|
oldFederation := Federation
|
|
oldService := Service
|
|
|
|
defer func() {
|
|
AppURL = oldAppURL
|
|
Federation = oldFederation
|
|
Service = oldService
|
|
}()
|
|
|
|
cfg, err := NewConfigProviderFromData(`
|
|
[federation]
|
|
ENABLED = true
|
|
[service]
|
|
EMAIL_DOMAIN_ALLOWLIST = *.allow.random
|
|
EMAIL_DOMAIN_BLOCKLIST = *.block.random
|
|
`)
|
|
|
|
require.NoError(t, err)
|
|
loadServerFrom(cfg)
|
|
loadFederationFrom(cfg)
|
|
loadServiceFrom(cfg)
|
|
|
|
assert.True(t, match(Service.EmailDomainAllowList, "d1.allow.random"))
|
|
assert.True(t, match(Service.EmailDomainAllowList, "localhost"))
|
|
}
|
|
|
|
func TestLoadServiceDomainListsNoFederation(t *testing.T) {
|
|
oldAppURL := AppURL
|
|
oldFederation := Federation
|
|
oldService := Service
|
|
|
|
defer func() {
|
|
AppURL = oldAppURL
|
|
Federation = oldFederation
|
|
Service = oldService
|
|
}()
|
|
|
|
cfg, err := NewConfigProviderFromData(`
|
|
[federation]
|
|
ENABLED = false
|
|
[service]
|
|
EMAIL_DOMAIN_ALLOWLIST = *.allow.random
|
|
EMAIL_DOMAIN_BLOCKLIST = *.block.random
|
|
`)
|
|
|
|
require.NoError(t, err)
|
|
loadServerFrom(cfg)
|
|
loadFederationFrom(cfg)
|
|
loadServiceFrom(cfg)
|
|
|
|
assert.True(t, match(Service.EmailDomainAllowList, "d1.allow.random"))
|
|
}
|
|
|
|
func TestLoadServiceDomainListsFederationEmptyAllowList(t *testing.T) {
|
|
oldAppURL := AppURL
|
|
oldFederation := Federation
|
|
oldService := Service
|
|
|
|
defer func() {
|
|
AppURL = oldAppURL
|
|
Federation = oldFederation
|
|
Service = oldService
|
|
}()
|
|
|
|
cfg, err := NewConfigProviderFromData(`
|
|
[federation]
|
|
ENABLED = true
|
|
[service]
|
|
EMAIL_DOMAIN_BLOCKLIST = *.block.random
|
|
`)
|
|
|
|
require.NoError(t, err)
|
|
loadServerFrom(cfg)
|
|
loadFederationFrom(cfg)
|
|
loadServiceFrom(cfg)
|
|
|
|
assert.Empty(t, Service.EmailDomainAllowList)
|
|
}
|