Add icon field to instance endpoint (#30205)

This commit is contained in:
Renaud Chaput 2024-08-22 12:04:27 +02:00 committed by GitHub
parent 376088f6da
commit 4a968cb7a9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 60 additions and 47 deletions

View file

@ -237,22 +237,6 @@ module ApplicationHelper
full_asset_url(instance_presenter.mascot&.file&.url || frontend_asset_path('images/elephant_ui_plane.svg')) full_asset_url(instance_presenter.mascot&.file&.url || frontend_asset_path('images/elephant_ui_plane.svg'))
end end
def instance_presenter
@instance_presenter ||= InstancePresenter.new
end
def favicon_path(size = '48')
instance_presenter.favicon&.file&.url(size)
end
def app_icon_path(size = '48')
instance_presenter.app_icon&.file&.url(size)
end
def use_mask_icon?
instance_presenter.app_icon.blank?
end
private private
def storage_host_var def storage_host_var

View file

@ -13,6 +13,22 @@ module InstanceHelper
safe_join([description_prefix(invite), I18n.t('auth.description.suffix')], ' ') safe_join([description_prefix(invite), I18n.t('auth.description.suffix')], ' ')
end end
def instance_presenter
@instance_presenter ||= InstancePresenter.new
end
def favicon_path(size = '48')
instance_presenter.favicon&.file&.url(size)
end
def app_icon_path(size = '48')
instance_presenter.app_icon&.file&.url(size)
end
def use_mask_icon?
instance_presenter.app_icon.blank?
end
private private
def description_prefix(invite) def description_prefix(invite)

View file

@ -1,7 +1,7 @@
# frozen_string_literal: true # frozen_string_literal: true
class ManifestSerializer < ActiveModel::Serializer class ManifestSerializer < ActiveModel::Serializer
include ApplicationHelper include InstanceHelper
include RoutingHelper include RoutingHelper
include ActionView::Helpers::TextHelper include ActionView::Helpers::TextHelper

View file

@ -7,10 +7,11 @@ class REST::InstanceSerializer < ActiveModel::Serializer
has_one :account, serializer: REST::AccountSerializer has_one :account, serializer: REST::AccountSerializer
end end
include InstanceHelper
include RoutingHelper include RoutingHelper
attributes :domain, :title, :version, :source_url, :description, attributes :domain, :title, :version, :source_url, :description,
:usage, :thumbnail, :languages, :configuration, :usage, :thumbnail, :icon, :languages, :configuration,
:registrations, :api_versions :registrations, :api_versions
has_one :contact, serializer: ContactSerializer has_one :contact, serializer: ContactSerializer
@ -33,6 +34,18 @@ class REST::InstanceSerializer < ActiveModel::Serializer
end end
end end
def icon
SiteUpload::ANDROID_ICON_SIZES.map do |size|
src = app_icon_path(size.to_i)
src = URI.join(root_url, src).to_s if src.present?
{
src: src || frontend_asset_url("icons/android-chrome-#{size}x#{size}.png"),
size: "#{size}x#{size}",
}
end
end
def usage def usage
{ {
users: { users: {

View file

@ -288,33 +288,4 @@ describe ApplicationHelper do
end end
end end
end end
describe 'favicon' do
context 'when an icon exists' do
let!(:favicon) { Fabricate(:site_upload, var: 'favicon') }
let!(:app_icon) { Fabricate(:site_upload, var: 'app_icon') }
it 'returns the URL of the icon' do
expect(helper.favicon_path).to eq(favicon.file.url('48'))
expect(helper.app_icon_path).to eq(app_icon.file.url('48'))
end
it 'returns the URL of the icon with size parameter' do
expect(helper.favicon_path(16)).to eq(favicon.file.url('16'))
expect(helper.app_icon_path(16)).to eq(app_icon.file.url('16'))
end
end
context 'when an icon does not exist' do
it 'returns nil' do
expect(helper.favicon_path).to be_nil
expect(helper.app_icon_path).to be_nil
end
it 'returns nil with size parameter' do
expect(helper.favicon_path(16)).to be_nil
expect(helper.app_icon_path(16)).to be_nil
end
end
end
end end

View file

@ -24,4 +24,33 @@ describe InstanceHelper do
expect(helper.site_hostname).to eq 'example.com' expect(helper.site_hostname).to eq 'example.com'
end end
end end
describe 'favicon' do
context 'when an icon exists' do
let!(:favicon) { Fabricate(:site_upload, var: 'favicon') }
let!(:app_icon) { Fabricate(:site_upload, var: 'app_icon') }
it 'returns the URL of the icon' do
expect(helper.favicon_path).to eq(favicon.file.url('48'))
expect(helper.app_icon_path).to eq(app_icon.file.url('48'))
end
it 'returns the URL of the icon with size parameter' do
expect(helper.favicon_path(16)).to eq(favicon.file.url('16'))
expect(helper.app_icon_path(16)).to eq(app_icon.file.url('16'))
end
end
context 'when an icon does not exist' do
it 'returns nil' do
expect(helper.favicon_path).to be_nil
expect(helper.app_icon_path).to be_nil
end
it 'returns nil with size parameter' do
expect(helper.favicon_path(16)).to be_nil
expect(helper.app_icon_path(16)).to be_nil
end
end
end
end end