Merge pull request #749 from code0-tech/748-add-urls-to-application-settings

Taucher2003 · web-flow · commit 130ef068fb90 · 2025-12-13T21:56:51.000+01:00
Add urls to application settings
diff --git a/app/graphql/types/application_settings_type.rb b/app/graphql/types/application_settings_type.rb
@@ -17,6 +17,18 @@ class ApplicationSettingsType < Types::BaseObject
           null: false,
           description: 'Shows if admin status can be queried by non-administrators'
 
+    field :terms_and_conditions_url, String,
+          null: true,
+          description: 'URL to the terms and conditions page'
+
+    field :privacy_url, String,
+          null: true,
+          description: 'URL to the privacy policy page'
+
+    field :legal_notice_url, String,
+          null: true,
+          description: 'URL to the legal notice page'
+
     field :identity_providers, Types::IdentityProviderType.connection_type,
           null: false,
           description: 'List of configured identity providers'
diff --git a/app/graphql/types/application_type.rb b/app/graphql/types/application_type.rb
@@ -10,6 +10,18 @@ class ApplicationType < Types::BaseObject
     field :settings, Types::ApplicationSettingsType, null: true,
                                                      description: 'Global application settings'
 
+    field :privacy_url, String,
+          null: true,
+          description: 'URL to the privacy policy page'
+
+    field :terms_and_conditions_url, String,
+          null: true,
+          description: 'URL to the terms and conditions page'
+
+    field :legal_notice_url, String,
+          null: true,
+          description: 'URL to the legal notice page'
+
     expose_abilities %i[
       create_organization
       create_runtime
@@ -26,5 +38,17 @@ def metadata
     def settings
       ApplicationSetting.current
     end
+
+    def privacy_url
+      ApplicationSetting.current.privacy_url
+    end
+
+    def terms_and_conditions_url
+      ApplicationSetting.current.terms_and_conditions_url
+    end
+
+    def legal_notice_url
+      ApplicationSetting.current.legal_notice_url
+    end
   end
 end
diff --git a/app/models/application_setting.rb b/app/models/application_setting.rb
@@ -12,9 +12,13 @@ class ApplicationSetting < ApplicationRecord
     organization_creation_restricted: 2,
     identity_providers: 3,
     admin_status_visible: 4,
+    terms_and_conditions_url: 5,
+    privacy_url: 6,
+    legal_notice_url: 7,
   }.with_indifferent_access
 
   BOOLEAN_OPTIONS = %i[user_registration_enabled organization_creation_restricted admin_status_visible].freeze
+  URL_OPTIONS = %i[terms_and_conditions_url privacy_url legal_notice_url].freeze
 
   enum :setting, SETTINGS
 
@@ -31,7 +35,17 @@ class ApplicationSetting < ApplicationRecord
     validates :value, inclusion: { in: [false, true] }, if: :"#{option}?"
   end
 
+  URL_OPTIONS.each do |option|
+    validates :value,
+              length: { maximum: 2048 },
+              format: URI::DEFAULT_PARSER.make_regexp(%w[http https]),
+              allow_nil: true,
+              if: :"#{option}?"
+  end
+
   def validate_value
+    return if URL_OPTIONS.map(&:to_s).include?(setting) && value.nil?
+
     errors.add(:value, :blank) if value.nil?
   end
 
diff --git a/db/fixtures/01_application_settings.rb b/db/fixtures/01_application_settings.rb
@@ -19,3 +19,18 @@
   s.setting = :admin_status_visible
   s.value = true
 end
+
+ApplicationSetting.seed_once :setting do |s|
+  s.setting = :terms_and_conditions_url
+  s.value = nil
+end
+
+ApplicationSetting.seed_once :setting do |s|
+  s.setting = :privacy_url
+  s.value = nil
+end
+
+ApplicationSetting.seed_once :setting do |s|
+  s.setting = :legal_notice_url
+  s.value = nil
+end
diff --git a/db/migrate/20251202205431_allow_null_value_in_application_settings.rb b/db/migrate/20251202205431_allow_null_value_in_application_settings.rb
@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AllowNullValueInApplicationSettings < Code0::ZeroTrack::Database::Migration[1.0]
+  def change
+    change_column_null :application_settings, :value, true
+  end
+end
diff --git a/db/schema_migrations/20251202205431 b/db/schema_migrations/20251202205431
@@ -0,0 +1 @@
+787d8a891ddc9e2e8292c54595ed167491cc7a58b493c946edc0684b9977094b
diff --git a/db/structure.sql b/db/structure.sql
@@ -59,7 +59,7 @@ ALTER SEQUENCE active_storage_variant_records_id_seq OWNED BY active_storage_var
 CREATE TABLE application_settings (
     id bigint NOT NULL,
     setting integer NOT NULL,
-    value jsonb NOT NULL,
+    value jsonb,
     created_at timestamp with time zone NOT NULL,
     updated_at timestamp with time zone NOT NULL
 );
diff --git a/docs/graphql/object/application.md b/docs/graphql/object/application.md
@@ -8,7 +8,10 @@ Represents the application instance
 
 | Name | Type | Description |
 |------|------|-------------|
+| `legalNoticeUrl` | [`String`](../scalar/string.md) | URL to the legal notice page |
 | `metadata` | [`Metadata!`](../object/metadata.md) | Metadata about the application |
+| `privacyUrl` | [`String`](../scalar/string.md) | URL to the privacy policy page |
 | `settings` | [`ApplicationSettings`](../object/applicationsettings.md) | Global application settings |
+| `termsAndConditionsUrl` | [`String`](../scalar/string.md) | URL to the terms and conditions page |
 | `userAbilities` | [`ApplicationUserAbilities!`](../object/applicationuserabilities.md) | Abilities for the current user on this Application |
 
diff --git a/docs/graphql/object/applicationsettings.md b/docs/graphql/object/applicationsettings.md
@@ -10,6 +10,9 @@ Represents the application settings
 |------|------|-------------|
 | `adminStatusVisible` | [`Boolean!`](../scalar/boolean.md) | Shows if admin status can be queried by non-administrators |
 | `identityProviders` | [`IdentityProviderConnection!`](../object/identityproviderconnection.md) | List of configured identity providers |
+| `legalNoticeUrl` | [`String`](../scalar/string.md) | URL to the legal notice page |
 | `organizationCreationRestricted` | [`Boolean!`](../scalar/boolean.md) | Shows if organization creation is restricted to administrators |
+| `privacyUrl` | [`String`](../scalar/string.md) | URL to the privacy policy page |
+| `termsAndConditionsUrl` | [`String`](../scalar/string.md) | URL to the terms and conditions page |
 | `userRegistrationEnabled` | [`Boolean!`](../scalar/boolean.md) | Shows if user registration is enabled |
 
diff --git a/spec/graphql/types/application_settings_type_spec.rb b/spec/graphql/types/application_settings_type_spec.rb
@@ -9,6 +9,9 @@
       organizationCreationRestricted
       identityProviders
       adminStatusVisible
+      termsAndConditionsUrl
+      privacyUrl
+      legalNoticeUrl
     ]
   end
 
diff --git a/spec/graphql/types/application_type_spec.rb b/spec/graphql/types/application_type_spec.rb
@@ -7,6 +7,9 @@
     %w[
       settings
       metadata
+      privacyUrl
+      termsAndConditionsUrl
+      legalNoticeUrl
       user_abilities
     ]
   end
diff --git a/spec/models/application_setting_spec.rb b/spec/models/application_setting_spec.rb
@@ -21,9 +21,53 @@
     subject(:setting) { create(:application_setting, setting: :user_registration_enabled, value: true) }
 
     it { is_expected.to validate_presence_of(:setting) }
-    it { is_expected.to validate_presence_of(:value) }
+
+    context 'when not a url option' do
+      subject { build(:application_setting, setting: :user_registration_enabled, value: nil) }
+
+      it { is_expected.not_to be_valid }
+    end
 
     it { is_expected.to validate_uniqueness_of(:setting).ignoring_case_sensitivity }
+
+    context 'when validating url options' do
+      described_class::URL_OPTIONS.each do |option|
+        context "with #{option}" do
+          context 'with a long valid url' do
+            subject { create(:application_setting, setting: option, value: "http://#{'a' * 2030}.com") }
+
+            it { is_expected.to be_valid }
+          end
+
+          context 'when the value is too long' do
+            subject { build(:application_setting, setting: option, value: "http://#{'a' * 2049}.com") }
+
+            it { is_expected.not_to be_valid }
+          end
+
+          context 'with invalid url' do
+            subject(:setting) { build(:application_setting, setting: option, value: 'invalid-url') }
+
+            it 'is invalid' do
+              expect(setting).not_to be_valid
+            end
+          end
+
+          context 'with valid url' do
+            subject { create(:application_setting, setting: option, value: 'https://example.com') }
+
+            it { is_expected.to be_valid }
+          end
+
+          context 'with nil value' do
+            subject { create(:application_setting, setting: option, value: nil) }
+
+            it { is_expected.to be_valid }
+          end
+        end
+      end
+    end
+
     it { is_expected.to allow_values(*described_class::BOOLEAN_OPTIONS).for(:setting) }
 
     it 'allows identity providers' do
@@ -134,12 +178,12 @@
         expect(setting.errors.added?(:value, :missing_oidc_configuration_keys)).to be true
       end
     end
-  end
 
-  context 'when validating default settings' do
-    described_class.find_each do |setting|
-      it "#{setting.setting} is valid" do
-        expect(setting).to be_valid
+    context 'when validating default settings' do
+      described_class.find_each do |setting|
+        it "#{setting.setting} is valid" do
+          expect(setting).to be_valid
+        end
       end
     end
   end

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+787d8a891ddc9e2e8292c54595ed167491cc7a58b493c946edc0684b9977094b`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,9 @@`
`9`	`9`	`organizationCreationRestricted`
`10`	`10`	`identityProviders`
`11`	`11`	`adminStatusVisible`
	`12`	`+ termsAndConditionsUrl`
	`13`	`+ privacyUrl`
	`14`	`+ legalNoticeUrl`
`12`	`15`	`]`
`13`	`16`	`end`
`14`	`17`