Add the Blossom media server list (kind 10063)

This commit is contained in:
raucao committed 2026-11-18 22:19:46 +04:00
1 parent 23898ae0a0
commit 5edbd3aed1
13 files changed
+459 -4

No files matched your search

@@ -0,0 +1,58 @@
<div class="w-[72vw] md:w-[500px]">
<h3 class="mb-6">Edit media servers</h3>
<%= form_with url: "#", local: true,
html: { data: {
controller: "media-server-list-editor",
action: "submit->media-server-list-editor#save"
} } do |f| %>
<ul data-media-server-list-editor-target="list" class="mb-4 space-y-2">
<% @servers.each do |server| %>
<li class="flex gap-x-2 items-center">
<div class="relative grow">
<% if server[:added] %>
<input type="text" name="server_urls[]" value="<%= server[:url] %>"
data-added-value="<%= server[:url] %>"
data-action="input->media-server-list-editor#checkAdded"
class="w-full pr-16 border-emerald-500 ring-1 ring-emerald-500 focus:border-emerald-500 focus:ring-emerald-500 bg-emerald-50/20" />
<span class="absolute inset-y-0 right-2.5 flex items-center pointer-events-none"
data-media-server-list-editor-target="addedBadge">
<span class="rounded-full bg-emerald-100 px-2 py-0.5 text-xs font-semibold text-emerald-800">
added
</span>
</span>
<% else %>
<input type="text" name="server_urls[]" value="<%= server[:url] %>" class="w-full" />
<% end %>
</div>
<button type="button" class="btn-md btn-icon btn-outline text-red-700 shrink-0"
data-action="click->media-server-list-editor#remove" title="Remove media server">
<%= render partial: "icons/trash-2", locals: { custom_class: "h-4 w-4" } %>
</button>
</li>
<% end %>
</ul>
<template data-media-server-list-editor-target="template">
<li class="flex gap-x-2 items-center">
<div class="relative grow">
<input type="text" name="server_urls[]" value="" class="w-full" />
</div>
<button type="button" class="btn-md btn-icon btn-outline text-red-700 shrink-0"
data-action="click->media-server-list-editor#remove" title="Remove media server">
<%= render partial: "icons/trash-2", locals: { custom_class: "h-4 w-4" } %>
</button>
</li>
</template>
<button type="button" class="btn-md btn-gray w-full mb-6"
data-action="click->media-server-list-editor#add">
<%= render partial: "icons/plus", locals: { custom_class: "h-4 w-4 inline mr-1" } %>
Add media server
</button>
<p class="error-msg mt-2 mb-4 hidden" data-media-server-list-editor-target="error"></p>
<%= f.submit "Save media servers", class: "btn-md btn-blue w-full",
data: { :'media-server-list-editor-target' => "submit" } %>
<% end %>
</div>
@@ -0,0 +1,31 @@
# frozen_string_literal: true
module Settings
class NostrEditMediaServersComponent < ViewComponent::Base
def initialize(media_list_event: nil)
@media_list_event = media_list_event
@servers = build_servers
end
private
def build_servers
site_server = Setting.nostr_blossom_server_url
if @media_list_event.blank?
return [] if site_server.blank?
[{ url: site_server, added: true }]
else
existing = @media_list_event["tags"]
.select { |t| t.is_a?(Array) && t[0] == "server" }
.map { |t| { url: t[1], added: false } }
if site_server.present? && existing.none? { |s| s[:url] == site_server }
existing.unshift({ url: site_server, added: true })
end
existing
end
end
end
end
@@ -0,0 +1,18 @@
<% @statuses.each do |status| %>
<%= render StatusTextComponent.new(
text: status[:text],
icon_name: status[:icon_name],
icon_color: status[:icon_color]
) %>
<% end %>
<div class="mt-8" data-controller="modal" data-action="keydown.esc->modal#close">
<button data-action="click->modal#open" class="btn-md btn-blue w-full sm:w-auto">
<%= @button_text %>
</button>
<%= render ModalComponent.new(show_close_button: false) do %>
<%= render Settings::NostrEditMediaServersComponent.new(
media_list_event: @media_list_event
) %>
<% end %>
</div>
@@ -0,0 +1,56 @@
# frozen_string_literal: true
module Settings
class NostrMediaServerStatusComponent < ViewComponent::Base
def initialize(media_list_event:, server_url: Setting.nostr_blossom_server_url)
@media_list_event = media_list_event
@server_url = server_url
@server_host = server_host(server_url)
@statuses = []
if media_list_event.present?
@statuses.push({
text: "You have a media server list configured",
icon_name: "check-circle",
icon_color: "emerald-500"
})
if @server_url.present?
if server_urls(media_list_event).include?(@server_url)
@statuses.push({
text: "The <strong>#{@server_host}</strong> media server is part of your list",
icon_name: "check-circle",
icon_color: "emerald-500"
})
else
@statuses.push({
text: "<strong>#{@server_host}</strong> is missing from your media server list",
icon_name: "alert-octagon",
icon_color: "amber-500"
})
end
end
else
@statuses.push({
text: "We could not find a media server list for your public key",
icon_name: "alert-octagon",
icon_color: "amber-500"
})
end
@button_text = (media_list_event.present? ? "Edit media servers" : "Set up media servers")
end
private
def server_host(url)
URI.parse(url).host
rescue URI::InvalidURIError
nil
end
def server_urls(event)
event["tags"].select { |t| t.is_a?(Array) && t[0] == "server" }.map { |t| t[1] }
end
end
end
+12 -1
View File
@@ -179,11 +179,22 @@ class SettingsController < ApplicationController
pubkey: @user.nostr_pubkey, kind: NostrManagerService::PROFILE_KIND, relays: relays
)
Rails.cache.write(nostr_metadata_cache_key("profile"), profile, expires_in: 5.minutes)
render json: { next: "render", event_id: profile&.dig("id") }
render json: { next: "blossom", event_id: profile&.dig("id") }
when "blossom"
write_relays = Rails.cache.read(nostr_metadata_cache_key("write_relays")) || []
relays = write_relays.any? ? write_relays : discovery_relay_urls
media_list = NostrManager::DiscoverUserEvent.call(
pubkey: @user.nostr_pubkey, kind: NostrManagerService::MEDIA_SERVER_LIST_KIND,
relays: relays
)
Rails.cache.write(nostr_metadata_cache_key("blossom"), media_list, expires_in: 5.minutes)
render json: { next: "render", event_id: media_list&.dig("id") }
when "render", nil
@nip65_event = Rails.cache.read(nostr_metadata_cache_key("nip65"))
@profile = Rails.cache.read(nostr_metadata_cache_key("profile"))
@media_list = Rails.cache.read(nostr_metadata_cache_key("blossom"))
render partial: "nostr_metadata", formats: :html
else
@@ -0,0 +1,118 @@
import { Controller } from "@hotwired/stimulus"
import { signAndPublish, hasNostrExtension } from "lib/nostr_publish"
const MEDIA_SERVER_LIST_KIND = 10063
const SERVER_URL_PATTERN = /^https?:\/\/.+/i
export default class extends Controller {
static targets = [ "list", "template", "addedBadge", "error", "submit" ]
add (event) {
event.preventDefault()
const row = this.templateTarget.content.cloneNode(true)
this.listTarget.appendChild(row)
this.clearError()
}
remove (event) {
event.preventDefault()
event.target.closest("li").remove()
this.clearError()
}
checkAdded (event) {
const input = event.target
const addedValue = input.dataset.addedValue
if (!addedValue) return
const container = input.closest(".relative")
const badge = container?.querySelector("[data-media-server-list-editor-target='addedBadge']")
const addedClasses = [
"border-emerald-500", "ring-1", "ring-emerald-500",
"focus:border-emerald-500", "focus:ring-emerald-500",
"bg-emerald-50/20"
]
if (input.value.trim() === addedValue.trim()) {
input.classList.add(...addedClasses)
if (badge) badge.classList.remove("hidden")
} else {
input.classList.remove(...addedClasses)
if (badge) badge.classList.add("hidden")
}
}
async save (event) {
event.preventDefault()
this.clearError()
const servers = this.servers()
if (servers.length === 0) {
this.showError("Please add at least one media server.")
return
}
if (!servers.every((url) => SERVER_URL_PATTERN.test(url))) {
this.showError("Media server URLs must start with http:// or https://.")
return
}
if (!hasNostrExtension()) {
this.showError("No Nostr extension (NIP-07) found.")
return
}
this.setBusy(true)
try {
const signedEvent = await signAndPublish({
kind: MEDIA_SERVER_LIST_KIND,
created_at: Math.floor(Date.now() / 1000),
tags: servers.map((url) => ["server", url]),
content: ""
})
this.element.dispatchEvent(new CustomEvent("nostr:publish", {
bubbles: true,
detail: { kind: MEDIA_SERVER_LIST_KIND, eventId: signedEvent.id }
}))
} catch (error) {
this.showError(error.message)
} finally {
this.setBusy(false)
}
}
servers () {
return Array.from(this.listTarget.querySelectorAll("li"))
.map((row) => {
const input = row.querySelector("input[name='server_urls[]']")
return input ? input.value.trim() : ""
})
.filter((url) => url.length > 0)
}
setBusy (busy) {
if (!this.hasSubmitTarget) return
if (busy) {
this.submitTarget.dataset.originalValue = this.submitTarget.value
this.submitTarget.disabled = true
this.submitTarget.value = "Saving…"
} else {
this.submitTarget.disabled = false
this.submitTarget.value = this.submitTarget.dataset.originalValue || this.submitTarget.value
}
}
showError (message) {
if (!this.hasErrorTarget) return
this.errorTarget.textContent = message
this.errorTarget.classList.remove("hidden")
}
clearError () {
if (!this.hasErrorTarget) return
this.errorTarget.textContent = ""
this.errorTarget.classList.add("hidden")
}
}
@@ -2,7 +2,7 @@ import { Controller } from "@hotwired/stimulus"
const REFRESH_ATTEMPTS = 5
const REFRESH_DELAY = 2000
const STEP_FOR_KIND = { 10002: "relays", 0: "profile" }
const STEP_FOR_KIND = { 10002: "relays", 0: "profile", 10063: "blossom" }
export default class extends Controller {
static targets = [ "status", "loading", "content" ]
+1 -1
View File
@@ -5,7 +5,7 @@ class NostrManagerService < ApplicationService
RELAY_LIST_KIND = 10002
MEDIA_SERVER_LIST_KIND = 10063
METADATA_CACHE_SUFFIXES = %w[nip65 write_relays profile].freeze
METADATA_CACHE_SUFFIXES = %w[nip65 write_relays profile blossom].freeze
MAX_RELAY_LIST_SIZE = 10
@@ -23,3 +23,10 @@
nip65_event: @nip65_event
) %>
</section>
<section class="mb-8 sm:mb-12">
<h3>Media servers</h3>
<%= render Settings::NostrMediaServerStatusComponent.new(
media_list_event: @media_list
) %>
</section>
@@ -0,0 +1,83 @@
# frozen_string_literal: true
require "rails_helper"
RSpec.describe Settings::NostrEditMediaServersComponent, type: :component do
before do
allow(Setting).to receive(:nostr_blossom_server_url).and_return("https://blossom.example.com")
end
it "wires the form to the media server list editor" do
rendered = render_inline(described_class.new(media_list_event: nil))
form = rendered.css("form").first
expect(form["data-controller"]).to eq("media-server-list-editor")
expect(form["data-action"]).to include("submit->media-server-list-editor#save")
expect(rendered.css("[data-media-server-list-editor-target='error']")).to be_present
expect(rendered.css("[data-media-server-list-editor-target='submit']")).to be_present
end
describe "when user has no media server list" do
it "prepends the site media server marked as added" do
rendered = render_inline(described_class.new(media_list_event: nil))
list = rendered.css("[data-media-server-list-editor-target='list']").first
inputs = list.css("input[name='server_urls[]']").map { |el| el["value"] }
expect(inputs).to eq(["https://blossom.example.com"])
badges = rendered.css("span.rounded-full").select { |el| el.text.strip == "added" }
expect(badges.size).to eq(1)
end
end
describe "when user has an existing media server list without the site server" do
let(:media_list_event) do
{
"kind" => 10063,
"tags" => [["server", "https://cdn.example.com"]]
}
end
it "prepends the site server as added, preserving existing servers" do
rendered = render_inline(described_class.new(media_list_event: media_list_event))
list = rendered.css("[data-media-server-list-editor-target='list']").first
inputs = list.css("input[name='server_urls[]']").map { |el| el["value"] }
expect(inputs).to eq(["https://blossom.example.com", "https://cdn.example.com"])
badges = rendered.css("span.rounded-full").select { |el| el.text.strip == "added" }
expect(badges.size).to eq(1)
end
end
describe "when user already has the site server" do
let(:media_list_event) do
{
"kind" => 10063,
"tags" => [
["server", "https://blossom.example.com"],
["server", "https://cdn.example.com"]
]
}
end
it "renders servers without any added badges" do
rendered = render_inline(described_class.new(media_list_event: media_list_event))
badges = rendered.css("span.rounded-full").select { |el| el.text.strip == "added" }
expect(badges).to be_empty
end
end
describe "when no site media server is configured" do
before { allow(Setting).to receive(:nostr_blossom_server_url).and_return(nil) }
it "renders an empty list" do
rendered = render_inline(described_class.new(media_list_event: nil))
list = rendered.css("[data-media-server-list-editor-target='list']").first
expect(list.css("input[name='server_urls[]']")).to be_empty
end
end
end
@@ -0,0 +1,43 @@
# frozen_string_literal: true
require "rails_helper"
RSpec.describe Settings::NostrMediaServerStatusComponent, type: :component do
let(:server_url) { "https://blossom.example.com" }
def render_status(media_list_event:)
render_inline(
described_class.new(media_list_event: media_list_event, server_url: server_url)
)
end
describe "without a media server list" do
it "reports that no list was found and offers setup" do
rendered = render_status(media_list_event: nil)
expect(rendered.text).to include("We could not find a media server list")
expect(rendered.text).to include("Set up media servers")
end
end
describe "with the site server in the list" do
let(:media_list_event) { { "tags" => [["server", server_url]] } }
it "reports that the site server is part of the list" do
rendered = render_status(media_list_event: media_list_event)
expect(rendered.text).to include("is part of your list")
expect(rendered.text).to include("Edit media servers")
end
end
describe "without the site server in the list" do
let(:media_list_event) { { "tags" => [["server", "https://cdn.example.com"]] } }
it "reports that the site server is missing" do
rendered = render_status(media_list_event: media_list_event)
expect(rendered.text).to include("is missing from your media server list")
end
end
end
@@ -81,6 +81,21 @@ RSpec.describe "Settings::NostrEvents", type: :request do
end
end
it "accepts a media server list event" do
event = signed_event(
kind: NostrManagerService::MEDIA_SERVER_LIST_KIND,
tags: [["server", "https://blossom.example.com"]]
)
expect(NostrPublishUserEventJob).to receive(:perform_later) do |args|
expect(args[:event]["kind"]).to eq(NostrManagerService::MEDIA_SERVER_LIST_KIND)
expect(args[:event]["tags"]).to eq([["server", "https://blossom.example.com"]])
end
post_signed_event(event)
expect(response).to have_http_status(:ok)
end
context "when the account has no public key" do
before { allow_any_instance_of(User).to receive(:nostr_pubkey).and_return(nil) }
+16 -1
View File
@@ -225,7 +225,7 @@ RSpec.describe "Settings", type: :request do
end
context "with step=profile" do
it "discovers the profile and asks to render next" do
it "discovers the profile and asks for the media server list next" do
expect(NostrManager::DiscoverUserEvent).to receive(:call)
.with(pubkey: "abc123", kind: NostrManagerService::PROFILE_KIND,
relays: discovery_relays)
@@ -234,6 +234,21 @@ RSpec.describe "Settings", type: :request do
get nostr_metadata_settings_path(step: "profile"),
headers: { "HTTP_ACCEPT" => "application/json" }
expect(response).to have_http_status(:ok)
expect(JSON.parse(response.body)).to eq("next" => "blossom", "event_id" => nil)
end
end
context "with step=blossom" do
it "discovers the media server list and asks to render next" do
expect(NostrManager::DiscoverUserEvent).to receive(:call)
.with(pubkey: "abc123", kind: NostrManagerService::MEDIA_SERVER_LIST_KIND,
relays: discovery_relays)
.and_return(nil)
get nostr_metadata_settings_path(step: "blossom"),
headers: { "HTTP_ACCEPT" => "application/json" }
expect(response).to have_http_status(:ok)
expect(JSON.parse(response.body)).to eq("next" => "render", "event_id" => nil)
end