mirror of
https://gh.wpcy.net/https://github.com/discourse/discourse.git
synced 2026-05-27 15:41:10 +08:00
09d6010c7b
### Background In #36061, dependent site settings were introduced through the `depends_on` key. This is used internally to construct a dependency graph and sort settings in order-of-dependency before bulk updates. However, no safeguards were introduced to avoid circular dependencies. This means a `TSort::Cyclic` could come along and ruin the day at arbitrary points during runtime. ### What is this change? This change does two things: 1. Rescue, format, and re-raise `TSort::Cyclic` exceptions. 2. Eagerly order settings on app reload to catch cyclic dependencies up-front.
73 lines
2.2 KiB
Ruby
Vendored
73 lines
2.2 KiB
Ruby
Vendored
# frozen_string_literal: true
|
|
|
|
RSpec.describe SiteSettings::DependencyGraph do
|
|
let(:depencency_graph) { described_class.new(dependencies) }
|
|
|
|
# Dependency graph:
|
|
#
|
|
# quux foo
|
|
# /
|
|
# qux bar
|
|
# \ /
|
|
# baz
|
|
let(:dependencies) { { foo: [], bar: [:foo], baz: %i[bar qux], qux: [], quux: [] } }
|
|
|
|
describe "#order" do
|
|
it "topologically sorts the dependencies" do
|
|
expect(depencency_graph.order).to match_array(%i[foo qux bar baz quux])
|
|
end
|
|
|
|
context "with circular dependencies" do
|
|
let(:dependencies) { { foo: [:bar], bar: [:foo] } }
|
|
|
|
it "raises an exception" do
|
|
expect { depencency_graph.order }.to raise_error(
|
|
described_class::CircularDependency,
|
|
<<~MESSAGE,
|
|
Circular dependencies in site settings:
|
|
|
|
foo <-> bar
|
|
MESSAGE
|
|
)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe "#dependents" do
|
|
it "returns settings that directly depend on the given setting" do
|
|
expect(depencency_graph.dependents(:foo)).to contain_exactly(:bar)
|
|
end
|
|
|
|
it "returns multiple dependents when several settings depend on the same one" do
|
|
expect(depencency_graph.dependents(:qux)).to contain_exactly(:baz)
|
|
end
|
|
|
|
it "returns an empty array for a setting with no dependents" do
|
|
expect(depencency_graph.dependents(:baz)).to eq([])
|
|
end
|
|
|
|
it "returns an empty array for a setting not in the graph" do
|
|
expect(depencency_graph.dependents(:nonexistent)).to eq([])
|
|
end
|
|
|
|
context "with a shared dependency" do
|
|
let(:dependencies) { { a: [], b: [:a], c: [:a], d: [:a] } }
|
|
|
|
it "returns all settings that depend on the shared dependency" do
|
|
expect(depencency_graph.dependents(:a)).to contain_exactly(:b, :c, :d)
|
|
end
|
|
end
|
|
|
|
context "with mixed string and symbol keys (matches real usage)" do
|
|
let(:dependencies) { { enable_foo: [], bar: %w[enable_foo], baz: %w[enable_foo] } }
|
|
|
|
it "finds dependents when called with a string" do
|
|
expect(depencency_graph.dependents("enable_foo")).to contain_exactly(:bar, :baz)
|
|
end
|
|
|
|
it "finds dependents when called with a symbol" do
|
|
expect(depencency_graph.dependents(:enable_foo)).to contain_exactly(:bar, :baz)
|
|
end
|
|
end
|
|
end
|
|
end
|
