Merge pull request 'Allow editing and resetting of all admin setting strings' (#137) from feature/admin_settings into master

Reviewed-on: #137
Reviewed-by: greg <greg@noreply.kosmos.org>

Dockerfile

@@ -9,9 +9,9 @@ RUN curl -fsSL https://deb.nodesource.com/setup_lts.x | bash -
 RUN apt-get update && apt-get install -y nodejs
 
 WORKDIR /akkounts
-COPY Gemfile /akkounts/Gemfile
+
-COPY Gemfile.lock /akkounts/Gemfile.lock
+COPY ["Gemfile", "Gemfile.lock", "package.json", "./"]
-COPY package.json /akkounts/package.json
+
 RUN bundle install
 RUN gem install foreman
 RUN npm install -g yarn

README.md

@@ -14,7 +14,6 @@ so:
 
 1. Make sure [Docker Compose is installed][1] and Docker is running (included in
    Docker Desktop)
-2. Uncomment the `redis`, `web`, and `sidekiq` sections in `docker-compose.yml`
 3. Run `docker compose up` and wait until 389ds announces its successful start
    in the log output
 4. `docker-compose exec ldap dsconf localhost backend create --suffix="dc=kosmos,dc=org" --be-name="dev"`
@@ -53,12 +52,14 @@ Running all specs:
 
 ### Docker (Compose)
 
-There is a working Docker Compose config file, which allows you to spin up both
+There is a working Docker Compose config file, which define a number of services including
 an app server for Rails as well as a local 389ds (LDAP) server.
 
-By default, `docker-compose up` will only start the LDAP server, listening on
+For Rails developers, you probably just want to start the LDAP server: `docker-compose up ldap`, 
-port 389 on your machine. Uncomment other services in `docker-compose.yml` if
+listening on port 389 on your machine. 
-you want to use them.
+
+You can pick and choose your services adding them by name (listed in `docker-compose.yml`) at 
+the end of the docker compose command. eg. `docker compose up ldap redis`
 
 #### LDAP server
 

app/components/form_elements/fieldset_component.html.erb

@@ -1,4 +1,6 @@
-<%= tag.public_send(@tag, class: "mb-6 last:mb-0") do %>
+<%= tag.public_send(@tag, class: "mb-6 last:mb-0", data: {
+      :'field-name' => @field_name
+    }) do %>
   <% if @positioning == :vertical %>
   <label class="block">
     <p class="font-bold <%= @descripton.present? ? "mb-1" : "mb-2" %>">
@@ -9,7 +11,21 @@
       <%= @descripton %>
     </p>
     <% end %>
-    <%= content %>
+
+    <%= tag.p class: "flex gap-x-1", data: {
+                controller: @resettable ? "settings--resettable-field" : nil,
+              } do %>
+      <%= content %>
+      <% if @resettable %>
+        <button type="button"
+                class="relative grow-0 shrink-0 btn-md btn-outline text-red-700"
+                title="Reset to default value"
+                data-settings--resettable-field-target="resetButton"
+                data-action="settings--resettable-field#resetField">
+          Reset
+        </button>
+      <% end %>
+    <% end %>
   </label>
   <% elsif @positioning == :horizontal %>
   <label class="block flex items-center justify-between">

app/components/form_elements/fieldset_component.rb

@@ -2,11 +2,15 @@
 
 module FormElements
   class FieldsetComponent < ViewComponent::Base
-    def initialize(tag: "li", positioning: :vertical, title:, description: nil)
+    def initialize(tag: "li", positioning: :vertical,
+                   title:, description: nil,
+                   field_name: nil, resettable: false)
       @tag         = tag
       @positioning = positioning
       @title       = title
       @descripton  = description
+      @field_name  = field_name
+      @resettable  = resettable
     end
   end
 end

app/components/form_elements/fieldset_resettable_setting_component.html.erb

@@ -0,0 +1,13 @@
+<%= render FormElements::FieldsetComponent.new(
+      title: @title,
+      description: @description,
+      field_name: "setting_#{@key.to_s}",
+      resettable: @resettable
+    ) do %>
+  <%= method("#{@type}_field").call :setting, @key,
+    value: Setting.public_send(@key),
+    data: {
+      :'default-value' => Setting.get_field(@key)[:default]
+    },
+    class: "w-full" %>
+<% end %>

app/components/form_elements/fieldset_resettable_setting_component.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module FormElements
+  class FieldsetResettableSettingComponent < ViewComponent::Base
+    def initialize(tag: "li", key:, type: :text, title:, description: nil)
+      @tag         = tag
+      @positioning = :vertical
+      @title       = title
+      @descripton  = description
+      @key         = key.to_sym
+      @type        = type
+      @resettable  = is_resettable?(@key)
+    end
+
+    def is_resettable?(key)
+      default_value = Setting.get_field(key)[:default]
+      default_value.present? && (default_value != Setting.send(key))
+    end
+  end
+end

app/javascript/controllers/settings/resettable_field_controller.js

@@ -0,0 +1,10 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = [ "resetButton" ]
+
+  resetField () {
+    const inputEl = this.element.querySelector('input')
+    inputEl.value = inputEl.dataset.defaultValue
+  }
+}

app/models/setting.rb

@@ -29,6 +29,7 @@ class Setting < RailsSettings::Base
 
   field :xmpp_default_rooms, type: :array, default: []
   field :xmpp_autojoin_default_rooms, type: :boolean, default: false
+  field :xmpp_notifications_from_address, type: :string, default: primary_domain
 
   #
   # Sentry
@@ -41,13 +42,13 @@ class Setting < RailsSettings::Base
   # Discourse
   #
 
-  field :discourse_public_url, type: :string, readonly: true,
+  field :discourse_public_url, type: :string,
     default: ENV["DISCOURSE_PUBLIC_URL"].presence
 
   field :discourse_enabled, type: :boolean,
     default: (ENV["DISCOURSE_PUBLIC_URL"].present?.to_s || false)
 
-  field :discourse_connect_secret, type: :string, readonly: true,
+  field :discourse_connect_secret, type: :string,
     default: ENV["DISCOURSE_CONNECT_SECRET"].presence
 
   #
@@ -57,10 +58,10 @@ class Setting < RailsSettings::Base
   field :ejabberd_enabled, type: :boolean,
     default: (ENV["EJABBERD_API_URL"].present?.to_s || false)
 
-  field :ejabberd_api_url, type: :string, readonly: true,
+  field :ejabberd_api_url, type: :string,
     default: ENV["EJABBERD_API_URL"].presence
 
-  field :ejabberd_admin_url, type: :string, readonly: true,
+  field :ejabberd_admin_url, type: :string,
     default: ENV["EJABBERD_ADMIN_URL"].presence
 
   field :ejabberd_buddy_roster, type: :string,
@@ -70,7 +71,7 @@ class Setting < RailsSettings::Base
   # Gitea
   #
 
-  field :gitea_public_url, type: :string, readonly: true,
+  field :gitea_public_url, type: :string,
     default: ENV["GITEA_PUBLIC_URL"].presence
 
   field :gitea_enabled, type: :boolean,
@@ -80,7 +81,7 @@ class Setting < RailsSettings::Base
   # Lightning Network
   #
 
-  field :lndhub_api_url, type: :string, readonly: true,
+  field :lndhub_api_url, type: :string,
     default: ENV["LNDHUB_API_URL"].presence
 
   field :lndhub_enabled, type: :boolean,
@@ -89,7 +90,7 @@ class Setting < RailsSettings::Base
   field :lndhub_admin_enabled, type: :boolean,
     default: (ENV["LNDHUB_ADMIN_UI"] || false)
 
-  field :lndhub_public_key, type: :string, readonly: true,
+  field :lndhub_public_key, type: :string,
     default: (ENV["LNDHUB_PUBLIC_KEY"] || "")
 
   field :lndhub_keysend_enabled, type: :boolean,
@@ -99,7 +100,7 @@ class Setting < RailsSettings::Base
   # Mastodon
   #
 
-  field :mastodon_public_url, type: :string, readonly: true,
+  field :mastodon_public_url, type: :string,
     default: ENV["MASTODON_PUBLIC_URL"].presence
 
   field :mastodon_enabled, type: :boolean,
@@ -109,7 +110,7 @@ class Setting < RailsSettings::Base
   # MediaWiki
   #
 
-  field :mediawiki_public_url, type: :string, readonly: true,
+  field :mediawiki_public_url, type: :string,
     default: ENV["MEDIAWIKI_PUBLIC_URL"].presence
 
   field :mediawiki_enabled, type: :boolean,

app/views/admin/settings/services/_discourse.html.erb

@@ -8,16 +8,15 @@
     description: "Discourse configuration present and features enabled"
   ) %>
 <% if Setting.discourse_enabled? %>
-  <%= render FormElements::FieldsetComponent.new(title: "Public URL") do %>
+  <%= render FormElements::FieldsetResettableSettingComponent.new(
-    <%= f.text_field :discourse_public_url,
+        key: :discourse_public_url,
-      value: Setting.discourse_public_url,
+        title: "Public URL"
-      class: "w-full", disabled: true %>
+      ) %>
-  <% end %>
+  <%= render FormElements::FieldsetResettableSettingComponent.new(
-  <%= render FormElements::FieldsetComponent.new(title: "Connect secret") do %>
+        key: :discourse_connect_secret,
-    <%= f.password_field :discourse_connect_secret,
+        type: :password,
-      value: Setting.discourse_connect_secret,
+        title: "Connect secret"
-      class: "w-full", disabled: true %>
+      ) %>
-  <% end %>
 <% end %>
 </ul>
 <% if Setting.discourse_enabled? %>

app/views/admin/settings/services/_ejabberd.html.erb

@@ -8,16 +8,14 @@
     description: "ejabberd configuration present and features enabled"
   ) %>
 <% if Setting.ejabberd_enabled? %>
-  <%= render FormElements::FieldsetComponent.new(title: "API URL") do %>
+  <%= render FormElements::FieldsetResettableSettingComponent.new(
-    <%= f.text_field :ejabberd_api_url,
+        key: :ejabberd_api_url,
-      value: Setting.ejabberd_api_url,
+        title: "API URL"
-      class: "w-full", disabled: true %>
+      ) %>
-  <% end %>
+  <%= render FormElements::FieldsetResettableSettingComponent.new(
-  <%= render FormElements::FieldsetComponent.new(title: "Admin URL") do %>
+        key: :ejabberd_admin_url,
-    <%= f.text_field :ejabberd_admin_url,
+        title: "Admin URL"
-      value: Setting.ejabberd_admin_url,
+      ) %>
-      class: "w-full", disabled: true %>
-  <% end %>
 </ul>
 <h3 class="mt-10">User default settings</h3>
 <ul role="list">
@@ -37,12 +35,24 @@
     title: "Auto-join default rooms",
     description: "Automatically join above default rooms in chat clients"
   ) %>
-  <%= render FormElements::FieldsetComponent.new(
+  <%= render FormElements::FieldsetResettableSettingComponent.new(
+        key: :ejabberd_buddy_roster,
         title: "Contact roster name",
         description: "Used when exchanging contacts after signup from invitation"
+      ) %>
+</ul>
+<h3 class="mt-10">Notifications</h3>
+<ul role="list">
+  <%= render FormElements::FieldsetComponent.new(
+        title: "From address",
+        description: "Address (JID) of the account notifications are sent from",
+        resettable: Setting.get_field(:xmpp_notifications_from_address)[:default] != Setting.xmpp_notifications_from_address
       ) do %>
-    <%= f.text_field :ejabberd_buddy_roster,
+    <%= f.text_field :xmpp_notifications_from_address,
-      value: Setting.ejabberd_buddy_roster,
+      value: Setting.xmpp_notifications_from_address,
+      data: {
+        :'default-value' => Setting.get_field(:xmpp_notifications_from_address)[:default]
+      },
       class: "w-full" %>
   <% end %>
 <% end %>

app/views/admin/settings/services/_gitea.html.erb

@@ -8,10 +8,9 @@
     description: "Gitea configuration present and features enabled"
   ) %>
   <% if Setting.gitea_enabled? %>
-    <%= render FormElements::FieldsetComponent.new(title: "Public URL") do %>
+    <%= render FormElements::FieldsetResettableSettingComponent.new(
-      <%= f.text_field :gitea_public_url,
+          key: :gitea_public_url,
-        value: Setting.gitea_public_url,
+          title: "Public URL"
-        class: "w-full", disabled: true %>
+        ) %>
-    <% end %>
   <% end %>
 </ul>

app/views/admin/settings/services/_lndhub.html.erb

@@ -8,11 +8,10 @@
     description: "LNDHub configuration present and wallet features enabled"
   ) %>
   <% if Setting.lndhub_enabled? %>
-    <%= render FormElements::FieldsetComponent.new(title: "API URL") do %>
+    <%= render FormElements::FieldsetResettableSettingComponent.new(
-      <%= f.text_field :lndhub_api_url,
+          key: :lndhub_api_url,
-        value: Setting.lndhub_api_url,
+          title: "API URL"
-        class: "w-full", disabled: true %>
+        ) %>
-    <% end %>
   <% end %>
   <%= render FormElements::FieldsetToggleComponent.new(
     form: f,
@@ -29,10 +28,10 @@
     description: "Allow users to receive invoice-less payments to their Lightning Address"
   ) %>
   <% if Setting.lndhub_keysend_enabled? %>
-    <%= render FormElements::FieldsetComponent.new(title: "Public key", description: "The public key of the Lightning node used by LNDHub") do %>
+    <%= render FormElements::FieldsetResettableSettingComponent.new(
-      <%= f.text_field :lndhub_public_key,
+          key: :lndhub_public_key,
-        value: Setting.lndhub_public_key,
+          title: "Public key",
-        class: "w-full", disabled: true %>
+          description: "The public key of the Lightning node used by LNDHub"
-    <% end %>
+        ) %>
   <% end %>
 </ul>

app/views/admin/settings/services/_mastodon.html.erb

@@ -8,10 +8,9 @@
     description: "Mastodon configuration present and features enabled"
   ) %>
   <% if Setting.mastodon_enabled? %>
-    <%= render FormElements::FieldsetComponent.new(title: "Public URL") do %>
+    <%= render FormElements::FieldsetResettableSettingComponent.new(
-      <%= f.text_field :mastodon_public_url,
+          key: :mastodon_public_url,
-        value: Setting.mastodon_public_url,
+          title: "Public URL"
-        class: "w-full", disabled: true %>
+        ) %>
-    <% end %>
   <% end %>
 </ul>

app/views/admin/settings/services/_mediawiki.html.erb

@@ -8,10 +8,9 @@
     description: "MediaWiki configuration present and features enabled"
   ) %>
   <% if Setting.mediawiki_enabled? %>
-    <%= render FormElements::FieldsetComponent.new(title: "Public URL") do %>
+    <%= render FormElements::FieldsetResettableSettingComponent.new(
-      <%= f.text_field :mediawiki_public_url,
+          key: :mediawiki_public_url,
-        value: Setting.mediawiki_public_url,
+          title: "Public URL"
-        class: "w-full", disabled: true %>
+        ) %>
-    <% end %>
   <% end %>
 </ul>

app/views/admin/settings/services/_remotestorage.html.erb

@@ -1,4 +1,5 @@
 <h3>RemoteStorage</h3>
+<p class="text-red-600 mb-8">Feature currently in development.</p>
 <ul role="list">
   <%= render FormElements::FieldsetToggleComponent.new(
     form: f,
@@ -8,10 +9,9 @@
     description: "RemoteStorage configuration present and features enabled"
   ) %>
   <% if Setting.remotestorage_enabled? %>
-    <%= render FormElements::FieldsetComponent.new(title: "Storage URL") do %>
+    <%= render FormElements::FieldsetResettableSettingComponent.new(
-      <%= f.text_field :rs_storage_url,
+          key: :rs_storage_url,
-        value: Setting.rs_storage_url,
+          title: "Storage URL"
-        class: "w-full", disabled: true %>
+        ) %>
-    <% end %>
   <% end %>
 </ul>

docker-compose.yml

@@ -12,57 +12,60 @@ services:
       DS_DM_PASSWORD: passthebutter
       SUFFIX_NAME: "dc=kosmos,dc=org"
 
-  # redis:
+  redis:
-  #   restart: always
+    restart: always
-  #   image: redis:7-alpine
+    image: redis:7-alpine
-  #   networks:
+    networks:
-  #     - internal_network
+      - internal_network
-  #   healthcheck:
+    healthcheck:
-  #     test: ['CMD', 'redis-cli', 'ping']
+      test: ['CMD', 'redis-cli', 'ping']
-  #   volumes:
+    volumes:
-  #     - ./tmp/redis:/data
+      - ./tmp/redis:/data
 
-  # web:
+  web:
-  #   build: .
+    build: .
-  #   tty: true
+    tty: true
-  #   command: bash -c "rm -f /akkounts/tmp/pids/server.pid; bin/dev"
+    command: bash -c "rm -f /akkounts/tmp/pids/server.pid; bin/dev"
-  #   volumes:
+    volumes:
-  #     - .:/akkounts
+      - .:/akkounts
-  #   networks:
+      - /akkounts/node_modules
-  #     - external_network
+    networks:
-  #     - internal_network
+      - external_network
-  #   ports:
+      - internal_network
-  #     - "3000:3000"
+    ports:
-  #   environment:
+      - "3000:3000"
-  #     RAILS_ENV: development
+    environment:
-  #     REDIS_URL: redis://redis:6379/0
+      RAILS_ENV: development
-  #     LDAP_HOST: ldap
+      PRIMARY_DOMAIN: kosmos.org
-  #     LDAP_PORT: 3389
+      REDIS_URL: redis://redis:6379/0
-  #     LDAP_ADMIN_PASSWORD: passthebutter
+      LDAP_HOST: ldap
-  #     LDAP_USE_TLS: "false"
+      LDAP_PORT: 3389
-  #   depends_on:
+      LDAP_ADMIN_PASSWORD: passthebutter
-  #     - ldap
+      LDAP_USE_TLS: "false"
-  #     - redis
+    depends_on:
+      - ldap
+      - redis
 
-  # sidekiq:
+  sidekiq:
-  #   build: .
+    build: .
-  #   command: bash -c "bundle exec sidekiq -C config/sidekiq.yml"
+    command: bash -c "bundle exec sidekiq -C config/sidekiq.yml"
-  #   volumes:
+    volumes:
-  #     - .:/akkounts
+      - .:/akkounts
-  #   networks:
+    networks:
-  #     - internal_network
+      - internal_network
-  #   environment:
+    environment:
-  #     RAILS_ENV: development
+      RAILS_ENV: development
-  #     REDIS_URL: redis://redis:6379/0
+      PRIMARY_DOMAIN: kosmos.org
-  #     LDAP_HOST: ldap
+      REDIS_URL: redis://redis:6379/0
-  #     LDAP_PORT: 3389
+      LDAP_HOST: ldap
-  #     LDAP_ADMIN_PASSWORD: passthebutter
+      LDAP_PORT: 3389
-  #     LDAP_USE_TLS: "false"
+      LDAP_ADMIN_PASSWORD: passthebutter
-  #     LAUNCHY_DRY_RUN: true
+      LDAP_USE_TLS: "false"
-  #     BROWSER: /dev/null
+      LAUNCHY_DRY_RUN: true
-  #   depends_on:
+      BROWSER: /dev/null
-  #     - ldap
+    depends_on:
-  #     - redis
+      - ldap
+      - redis
 
   # phpldapadmin:
   #   image: osixia/phpldapadmin:0.9.0

spec/features/admin/settings_spec.rb

@@ -26,16 +26,14 @@ RSpec.describe 'Admin/global settings', type: :feature do
       expect(current_url).to eq(admin_settings_services_url(params: { s: "discourse" }))
     end
 
-    scenario "View ejabberd settings" do
+    scenario "View service settings" do
       visit admin_settings_services_path(params: { s: "ejabberd" })
 
       expect(page).to have_content("Enable ejabberd integration")
-      expect(page).to have_field("API URL",
+      expect(page).to have_field("API URL", with: "http://xmpp.example.com/api")
-        with: "http://xmpp.example.com/api",
-        disabled: true)
     end
 
-    scenario "Disable ejabberd integration" do
+    scenario "Disable a service integration" do
       visit admin_settings_services_path(params: { s: "ejabberd" })
       expect(page).to have_checked_field("setting[ejabberd_enabled]")
 
@@ -47,25 +45,15 @@ RSpec.describe 'Admin/global settings', type: :feature do
       expect(page).to_not have_field("API URL", disabled: true)
     end
 
-    scenario "View remoteStorage settings" do
+    scenario "Resettable fields" do
-      visit admin_settings_services_path(params: { s: "remotestorage" })
+      visit admin_settings_services_path(params: { s: "ejabberd" })
+      expect(page).to have_field("API URL", with: "http://xmpp.example.com/api")
+      expect(page).to_not have_css('input#setting_ejabberd_api_url+button')
 
-      expect(page).to have_content("Enable RemoteStorage integration")
+      Setting.ejabberd_api_url = "http://example.com/foo"
-      expect(page).to have_field("Storage URL",
+      visit admin_settings_services_path(params: { s: "ejabberd" })
-        with: "https://storage.kosmos.org",
+      expect(page).to have_field("API URL", with: "http://example.com/foo")
-        disabled: true)
+      expect(page).to have_css('input#setting_ejabberd_api_url+button')
-    end
-
-    scenario "Disable remoteStorage integration" do
-      visit admin_settings_services_path(params: { s: "remotestorage" })
-      expect(page).to have_checked_field("setting[remotestorage_enabled]")
-
-      uncheck "setting[remotestorage_enabled]"
-      click_button "Save"
-
-      expect(current_url).to eq(admin_settings_services_url(params: { s: "remotestorage" }))
-      expect(page).to_not have_checked_field("setting[remotestorage_enabled]")
-      expect(page).to_not have_field("Storage URL", disabled: true)
     end
   end
 end