asxpi/asxpio
asxpi/asxpio
1
0
Fork 0
Code Issues Pull requests Packages 1 Activity Actions

bingo: ping IndexNow when the card changes

Browse source 
A newly recorded incident only showed up in search once a crawler
happened to come back. IndexNow lets Bing, Yandex and the other
participating engines know about changed URLs right away.

Bingo::IndexNow posts the card URLs plus the affected datacenter pages
to api.indexnow.org, in a background thread so admin saves don't wait.
Incidents ping their datacenter. Edits ping the datacenter, or every
page when positions move (create, delete, reorder, sort). A deleted
datacenter's pages are included so the engines see the 404. BingoWeb
serves the key at /<key>.txt.

The key comes from the INDEXNOW Forgejo secret, written to .env as
INDEXNOW_KEY. With no key set this does nothing.

Assisted-by: Claude:opus-5
This commit is contained in:
Sergei Poljanski 2026-10-10 09:42:46 +04:00
commit 26e862ff04
Signed by: asxpi
GPG key ID: 4F8851660FA4121B
6 changed files with 106 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.env.example
View file

@ -22,3 +22,5 @@ MAIL_TO=ie@asxp.io
# BINGO_HOST=bingo.localhost
# Optional second hostname serving the same card.
# BINGO_ALT_HOST=bingo2.localhost
# IndexNow key (8-128 chars, A-Z a-z 0-9 -); unset = no pings, no key file.
# INDEXNOW_KEY=

4
.forgejo/workflows/deploy.yaml
View file

@ -110,11 +110,12 @@ jobs:
ASXPIO_S3_SECRET_KEY: ${{ secrets.ASXPIO_S3_SECRET_KEY }}
LTC_ADDRESS: ${{ secrets.LTC_ADDRESS }}
CRYPTO_ADDRESSES: ${{ secrets.CRYPTO_ADDRESSES }}
INDEXNOW: ${{ secrets.INDEXNOW }}
with:
host: ${{ secrets.DEPLOY_IP }}
username: ${{ secrets.DEPLOY_USER }}
key: ${{ secrets.DEPLOY_SSH_KEY }}
envs: SESSION_SECRET,SMTP_PASSWORD,ADMIN_USER,ADMIN_PASSWORD,ASXPIO_DB_PASSWORD,ASXPIO_S3_ACCESS_KEY,ASXPIO_S3_SECRET_KEY,LTC_ADDRESS,CRYPTO_ADDRESSES
envs: SESSION_SECRET,SMTP_PASSWORD,ADMIN_USER,ADMIN_PASSWORD,ASXPIO_DB_PASSWORD,ASXPIO_S3_ACCESS_KEY,ASXPIO_S3_SECRET_KEY,LTC_ADDRESS,CRYPTO_ADDRESSES,INDEXNOW
script_stop: true
script: |
umask 077
@ -140,6 +141,7 @@ jobs:
LTC_ADDRESS=${LTC_ADDRESS}
CRYPTO_ADDRESSES=${CRYPTO_ADDRESSES}
BINGO_HOST=datacenterbingo.xyz
INDEXNOW_KEY=${INDEXNOW}
EOF
chmod 600 /opt/asxpio/.env

7
bingo_web.rb
View file

@ -188,6 +188,13 @@ class BingoWeb < Sinatra::Base
erb :dc
end
# IndexNow key file: proves to the engines that pings come from us.
get %r{/([A-Za-z0-9-]{8,128})\.txt} do |name|
halt 404 unless name == Bingo::IndexNow.key
content_type 'text/plain'
name
end
# Icons from assets/bingo/ (public/ is asxp.io's). Search engines want
# a crawlable favicon URL; a data: URI doesn't count.
ICONS = { 'favicon.svg' => 'image/svg+xml', 'favicon.ico' => 'image/x-icon',

39
lib/bingo.rb
View file

@ -397,6 +397,45 @@ module Bingo
end
end
# Tells IndexNow engines (Bing, Yandex, Seznam, ...) which bingo URLs
# changed, so new incidents get recrawled within minutes. The key comes
# from INDEXNOW_KEY and BingoWeb serves it at /<key>.txt; without the key
# or BINGO_HOST (dev, tests) this does nothing.
module IndexNow
ENDPOINT = URI('https://api.indexnow.org/indexnow')
module_function
def key = ENV['INDEXNOW_KEY'].to_s[/\A[A-Za-z0-9-]{8,128}\z/]
def host = ENV['BINGO_HOST'].to_s[/\A\S+\z/]
# The card in every locale plus the pages of the given datacenters.
def urls(dcs = [])
paths = LOCALES.map { |l| "/#{l}" } + dcs.flat_map { |dc| LOCALES.map { |l| "/#{l}/dc/#{dc.slug}" } }
paths.map { |p| "https://#{host}#{p}" }
end
def payload(dcs = [])
{ host: host, key: key, keyLocation: "https://#{host}/#{key}.txt", urlList: urls(dcs) }
end
# Fire and forget: an admin save doesn't wait on a third party.
def ping(dcs = [])
return unless key && host
body = JSON.generate(payload(dcs))
Thread.new { deliver(body) }
end
def deliver(body)
res = Net::HTTP.start(ENDPOINT.host, ENDPOINT.port, use_ssl: true, open_timeout: 5, read_timeout: 10) do |http|
http.post(ENDPOINT.path, body, 'Content-Type' => 'application/json; charset=utf-8')
end
$logger.warn("bingo: IndexNow answered #{res.code}") unless res.is_a?(Net::HTTPSuccess)
rescue StandardError => e
$logger.warn("bingo: IndexNow #{e.class}: #{e.message}")
end
end
# Positions stay dense 1..N; the card shows the first SIZE*SIZE, the rest
# wait in reserve. Placing a datacenter inserts it at pos (default: last)
# and shifts everyone after it.

9
lib/bingo_admin.rb
View file

@ -73,6 +73,7 @@ module BingoAdmin
@dc.save
Bingo.place!(@dc, position_param)
audit!('bingo.dc_create', @dc.slug, "##{@dc.refresh.position} #{@dc.name_ru}")
Bingo::IndexNow.ping(Bingo::Datacenter.all) # positions shifted
session[:bingo_flash] = "Added #{@dc.name_ru} at ##{@dc.refresh.position}."
redirect "/admin/bingo/dc/#{@dc.id}"
end
@ -90,8 +91,10 @@ module BingoAdmin
errs = assign_dc(dc)
if errs.empty?
dc.save_changes
Bingo.place!(dc, position_param) if position_param && position_param != dc.position
moved = position_param && position_param != dc.position
Bingo.place!(dc, position_param) if moved
audit!('bingo.dc_update', dc.slug, dc.name_ru)
Bingo::IndexNow.ping(moved ? Bingo::Datacenter.all : [dc])
session[:bingo_flash] = 'Saved.'
else
session[:bingo_flash] = errs.join('; ')
@ -109,6 +112,7 @@ module BingoAdmin
Bingo.renumber!
end
audit!('bingo.dc_delete', dc.slug, "#{dc.name_ru}, #{n} incident(s)")
Bingo::IndexNow.ping([dc, *Bingo::Datacenter.all]) # its pages now 404, the rest moved up
session[:bingo_flash] = "Deleted #{dc.name_ru}#{" and #{n} incident(s)" if n.positive?}."
redirect '/admin/bingo'
end
@ -116,6 +120,7 @@ module BingoAdmin
app.post '/admin/bingo/sort' do
Bingo.sort_by_mw!
audit!('bingo.sort_by_mw')
Bingo::IndexNow.ping(Bingo::Datacenter.all)
session[:bingo_flash] = 'Sorted by MW (unknown last).'
redirect '/admin/bingo'
end
@ -212,6 +217,7 @@ module BingoAdmin
title_uk: blank_nil(params[:title_uk]), url: blank_nil(url)
)
audit!('bingo.incident_create', dc.slug, "#{date} #{params[:kind]}: #{params[:title_ru].strip}")
Bingo::IndexNow.ping([dc])
session[:bingo_flash] = "Incident recorded for #{dc.name_ru}."
else
session[:bingo_flash] = errs.join('; ')
@ -223,6 +229,7 @@ module BingoAdmin
inc = Bingo::Incident[params[:id].to_i]
inc&.destroy # hook bumps the datacenter's updated_at
audit!('bingo.incident_delete', inc&.datacenter&.slug, inc && "#{inc.occurred_on} #{inc.title_ru}")
Bingo::IndexNow.ping([inc.datacenter]) if inc
session[:bingo_flash] = 'Incident deleted.'
redirect '/admin/bingo'
end

47
test/bingo_test.rb
View file

@ -1,4 +1,5 @@
require_relative 'test_helper'
require 'minitest/mock'
class BingoTest < Minitest::Test
include Rack::Test::Methods
@ -288,6 +289,52 @@ class BingoTest < Minitest::Test
assert_includes body, '<div class="dc"><a href="/en/dc/dc-1">DC 1</a>'
end
def with_env(vars)
old = vars.to_h { |k, _| [k, ENV[k]] }
vars.each { |k, v| ENV[k] = v }
yield
ensure
old.each { |k, v| ENV[k] = v }
end
def test_indexnow_key_file
get '/0123456789abcdef.txt'
assert_equal 404, last_response.status
with_env('INDEXNOW_KEY' => '0123456789abcdef') do
get '/0123456789abcdef.txt'
assert last_response.ok?
assert_equal '0123456789abcdef', last_response.body
get '/fedcba9876543210.txt'
assert_equal 404, last_response.status
end
end
def test_indexnow_ping
assert_nil Bingo::IndexNow.ping([@dcs[0]]) # no key: nothing sent
sent = []
with_env('INDEXNOW_KEY' => '0123456789abcdef', 'BINGO_HOST' => 'bingo.example') do
Bingo::IndexNow.stub(:deliver, ->(body) { sent << JSON.parse(body) }) do
Bingo::IndexNow.ping([@dcs[0]]).join
end
end
body = sent.fetch(0)
assert_equal 'bingo.example', body['host']
assert_equal 'https://bingo.example/0123456789abcdef.txt', body['keyLocation']
assert_equal %w[/ru /en /uk /ru/dc/dc-1 /en/dc/dc-1 /uk/dc/dc-1].map { |p| "https://bingo.example#{p}" }, body['urlList']
end
def test_admin_incident_pings_indexnow
@app = AsxpioWeb
token = admin_token
pinged = []
Bingo::IndexNow.stub(:ping, ->(dcs) { pinged << dcs.map(&:slug) }) do
post '/admin/bingo/incidents', { authenticity_token: token, datacenter_id: @dcs[2].id, occurred_on: '2026-10-01',
kind: 'fire', title_ru: 'Пожар' }, admin_env
post "/admin/bingo/incidents/#{Bingo::Incident.first.id}/delete", { authenticity_token: token }, admin_env
end
assert_equal [['dc-3'], ['dc-3']], pinged
end
def test_root_varies_on_language
get '/'
assert_equal 'Accept-Language', last_response.headers['Vary']