Add a nodeinfo endpoint (#12002)
* Add nodeinfo endpoint * dont commit stuff from my local dev * consistant naming since we implimented 2.1 schema * Add some additional node info stuff * Add nodeinfo endpoint * dont commit stuff from my local dev * consistant naming since we implimented 2.1 schema * expanding this to include federation info * codeclimate feedback * CC feedback * using activeserializers seems like a good idea... * get rid of draft 2.1 version * Reimplement 2.1, also fix metaData -> metadata * Fix metaData -> metadata here too * Fix nodeinfo 2.1 tests * Implement cache for monthly user aggregate * Useless * Remove ostatus from the list of supported protocols * Fix nodeinfo's open_registration reading obsolete setting variable * Only serialize domain blocks with user-facing limitations * Do not needlessly list noop severity in nodeinfo * Only serialize domain blocks info in nodeinfo when they are set to be displayed to everyone * Enable caching for nodeinfo endpoints * Fix rendering nodeinfo * CodeClimate fixes * Please CodeClimate * Change InstancePresenter#active_user_count_months for clarity * Refactor NodeInfoSerializer#metadata * Remove nodeinfo 2.1 support as the schema doesn't exist * Clean-up
This commit is contained in:
parent
15b3eeb326
commit
5f69eb89e2
9 changed files with 121 additions and 3 deletions
19
app/controllers/well_known/nodeinfo_controller.rb
Normal file
19
app/controllers/well_known/nodeinfo_controller.rb
Normal file
|
@ -0,0 +1,19 @@
|
||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
module WellKnown
|
||||||
|
class NodeInfoController < ActionController::Base
|
||||||
|
include CacheConcern
|
||||||
|
|
||||||
|
before_action { response.headers['Vary'] = 'Accept' }
|
||||||
|
|
||||||
|
def index
|
||||||
|
expires_in 3.days, public: true
|
||||||
|
render_with_cache json: {}, serializer: NodeInfo::DiscoverySerializer, adapter: NodeInfo::Adapter, expires_in: 3.days, root: 'nodeinfo'
|
||||||
|
end
|
||||||
|
|
||||||
|
def show
|
||||||
|
expires_in 30.minutes, public: true
|
||||||
|
render_with_cache json: {}, serializer: NodeInfo::Serializer, adapter: NodeInfo::Adapter, expires_in: 30.minutes, root: 'nodeinfo'
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
|
@ -1,7 +1,7 @@
|
||||||
# frozen_string_literal: true
|
# frozen_string_literal: true
|
||||||
|
|
||||||
class ActivityTracker
|
class ActivityTracker
|
||||||
EXPIRE_AFTER = 90.days.seconds
|
EXPIRE_AFTER = 6.months.seconds
|
||||||
|
|
||||||
class << self
|
class << self
|
||||||
include Redisable
|
include Redisable
|
||||||
|
|
7
app/lib/nodeinfo/adapter.rb
Normal file
7
app/lib/nodeinfo/adapter.rb
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
class NodeInfo::Adapter < ActiveModelSerializers::Adapter::Attributes
|
||||||
|
def self.default_key_transform
|
||||||
|
:camel_lower
|
||||||
|
end
|
||||||
|
end
|
|
@ -20,8 +20,8 @@ class InstancePresenter
|
||||||
Rails.cache.fetch('user_count') { User.confirmed.joins(:account).merge(Account.without_suspended).count }
|
Rails.cache.fetch('user_count') { User.confirmed.joins(:account).merge(Account.without_suspended).count }
|
||||||
end
|
end
|
||||||
|
|
||||||
def active_user_count
|
def active_user_count(weeks = 4)
|
||||||
Rails.cache.fetch('active_user_count') { Redis.current.pfcount(*(0..3).map { |i| "activity:logins:#{i.weeks.ago.utc.to_date.cweek}" }) }
|
Rails.cache.fetch('active_user_count') { Redis.current.pfcount(*(0...weeks).map { |i| "activity:logins:#{i.weeks.ago.utc.to_date.cweek}" }) }
|
||||||
end
|
end
|
||||||
|
|
||||||
def status_count
|
def status_count
|
||||||
|
|
11
app/serializers/nodeinfo/discovery_serializer.rb
Normal file
11
app/serializers/nodeinfo/discovery_serializer.rb
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
class NodeInfo::DiscoverySerializer < ActiveModel::Serializer
|
||||||
|
include RoutingHelper
|
||||||
|
|
||||||
|
attribute :links
|
||||||
|
|
||||||
|
def links
|
||||||
|
[{ rel: 'http://nodeinfo.diaspora.software/ns/schema/2.0', href: nodeinfo_schema_url }]
|
||||||
|
end
|
||||||
|
end
|
41
app/serializers/nodeinfo/serializer.rb
Normal file
41
app/serializers/nodeinfo/serializer.rb
Normal file
|
@ -0,0 +1,41 @@
|
||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
class NodeInfo::Serializer < ActiveModel::Serializer
|
||||||
|
include RoutingHelper
|
||||||
|
|
||||||
|
attributes :version, :software, :protocols, :usage
|
||||||
|
|
||||||
|
def version
|
||||||
|
'2.0'
|
||||||
|
end
|
||||||
|
|
||||||
|
def software
|
||||||
|
{ name: 'mastodon', version: Mastodon::Version.to_s }
|
||||||
|
end
|
||||||
|
|
||||||
|
def services
|
||||||
|
{ outbound: [], inbound: [] }
|
||||||
|
end
|
||||||
|
|
||||||
|
def protocols
|
||||||
|
%w(activitypub)
|
||||||
|
end
|
||||||
|
|
||||||
|
def usage
|
||||||
|
{
|
||||||
|
users: {
|
||||||
|
total: instance_presenter.user_count,
|
||||||
|
active_month: instance_presenter.active_user_count(4),
|
||||||
|
active_halfyear: instance_presenter.active_user_count(24),
|
||||||
|
},
|
||||||
|
|
||||||
|
local_posts: instance_presenter.status_count,
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
def instance_presenter
|
||||||
|
@instance_presenter ||= InstancePresenter.new
|
||||||
|
end
|
||||||
|
end
|
|
@ -18,4 +18,5 @@ ActiveSupport::Inflector.inflections(:en) do |inflect|
|
||||||
inflect.acronym 'PubSubHubbub'
|
inflect.acronym 'PubSubHubbub'
|
||||||
inflect.acronym 'ActivityStreams'
|
inflect.acronym 'ActivityStreams'
|
||||||
inflect.acronym 'JsonLd'
|
inflect.acronym 'JsonLd'
|
||||||
|
inflect.acronym 'NodeInfo'
|
||||||
end
|
end
|
||||||
|
|
|
@ -24,10 +24,13 @@ Rails.application.routes.draw do
|
||||||
end
|
end
|
||||||
|
|
||||||
get '.well-known/host-meta', to: 'well_known/host_meta#show', as: :host_meta, defaults: { format: 'xml' }
|
get '.well-known/host-meta', to: 'well_known/host_meta#show', as: :host_meta, defaults: { format: 'xml' }
|
||||||
|
get '.well-known/nodeinfo', to: 'well_known/nodeinfo#index', as: :nodeinfo, defaults: { format: 'json' }
|
||||||
get '.well-known/webfinger', to: 'well_known/webfinger#show', as: :webfinger
|
get '.well-known/webfinger', to: 'well_known/webfinger#show', as: :webfinger
|
||||||
get '.well-known/change-password', to: redirect('/auth/edit')
|
get '.well-known/change-password', to: redirect('/auth/edit')
|
||||||
get '.well-known/keybase-proof-config', to: 'well_known/keybase_proof_config#show'
|
get '.well-known/keybase-proof-config', to: 'well_known/keybase_proof_config#show'
|
||||||
|
|
||||||
|
get '/nodeinfo/2.0', to: 'well_known/nodeinfo#show', as: :nodeinfo_schema
|
||||||
|
|
||||||
get 'manifest', to: 'manifests#show', defaults: { format: 'json' }
|
get 'manifest', to: 'manifests#show', defaults: { format: 'json' }
|
||||||
get 'intent', to: 'intents#show'
|
get 'intent', to: 'intents#show'
|
||||||
get 'custom.css', to: 'custom_css#show', as: :custom_css
|
get 'custom.css', to: 'custom_css#show', as: :custom_css
|
||||||
|
|
36
spec/controllers/well_known/nodeinfo_controller_spec.rb
Normal file
36
spec/controllers/well_known/nodeinfo_controller_spec.rb
Normal file
|
@ -0,0 +1,36 @@
|
||||||
|
require 'rails_helper'
|
||||||
|
|
||||||
|
describe WellKnown::NodeInfoController, type: :controller do
|
||||||
|
render_views
|
||||||
|
|
||||||
|
describe 'GET #index' do
|
||||||
|
it 'returns json document pointing to node info' do
|
||||||
|
get :index
|
||||||
|
|
||||||
|
expect(response).to have_http_status(200)
|
||||||
|
expect(response.content_type).to eq 'application/json'
|
||||||
|
|
||||||
|
json = body_as_json
|
||||||
|
|
||||||
|
expect(json[:links]).to be_an Array
|
||||||
|
expect(json[:links][0][:rel]).to eq 'http://nodeinfo.diaspora.software/ns/schema/2.0'
|
||||||
|
expect(json[:links][0][:href]).to include 'nodeinfo/2.0'
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe 'GET #show' do
|
||||||
|
it 'returns json document with node info properties' do
|
||||||
|
get :show
|
||||||
|
|
||||||
|
expect(response).to have_http_status(200)
|
||||||
|
expect(response.content_type).to eq 'application/json'
|
||||||
|
|
||||||
|
json = body_as_json
|
||||||
|
|
||||||
|
expect(json[:version]).to eq '2.0'
|
||||||
|
expect(json[:usage]).to be_a Hash
|
||||||
|
expect(json[:software]).to be_a Hash
|
||||||
|
expect(json[:protocols]).to be_an Array
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
Loading…
Reference in a new issue