Skip to content

A platform for community discussion. Free, open, simple.

DEV: Finish extracting rails spec helpers (#40552)

Jarek Radosz960f34da9d79
diff --git a/spec/rails_helper.rb b/spec/rails_helper.rb
index ef1ab3f4928..ea8609c154b 100644
--- a/spec/rails_helper.rb
+++ b/spec/rails_helper.rb
@@ -23,43 +23,8 @@ require "mocha/api"
require "certified"
require "webmock/rspec"
-CHROME_REMOTE_DEBUGGING_PORT = (ENV["CHROME_REMOTE_DEBUGGING_PORT"] || 50_062).to_s
-CHROME_REMOTE_DEBUGGING_ADDRESS = ENV["CHROME_REMOTE_DEBUGGING_ADDRESS"] || "127.0.0.1"
-
require_relative "support/server_error_tracking"
-class PlaywrightLogger
- attr_reader :logs
-
- def initialize(page)
- @logs = []
-
- page.on(
- "console",
- ->(msg) do
- @logs << {
- level: msg.type,
- message: msg.text,
- timestamp: Time.now.to_i * 1000,
- source: "console-api",
- }
- end,
- )
-
- page.on(
- "pageerror",
- ->(error) do
- @logs << {
- level: "error",
- message: error.message,
- timestamp: Time.now.to_i * 1000,
- source: "pageerror-api",
- }
- end,
- )
- end
-end
-
ENV["RAILS_ENV"] ||= "test"
ENV["ENABLE_LOGSTASH_LOGGER"] ||= "1"
require File.expand_path("../../config/environment", __FILE__)
@@ -101,83 +66,6 @@ if ENV["LOAD_PLUGINS"] == "1"
Dir[Rails.root.join("plugins/*/spec/system/page_objects/**/*.rb")].each { |f| require f }
end
-SiteSetting.automatically_download_gravatars = false
-
-module TestSetup
- # This is run before each test and before each before_all block
- def self.test_setup(x = nil)
- RateLimiter.disable
- PostActionNotifier.disable
- SearchIndexer.disable
- UserActionManager.disable
- NotificationEmailer.disable
- SiteIconManager.disable
- WordWatcher.disable_cache
- UpcomingChanges.clear_caches!
-
- SiteSetting.provider.all.each { |setting| SiteSetting.remove_override!(setting.name) }
-
- # Set some standard overrides for tests. Some for performance, some to make the tests easier,
- # and some because their default was changed, and we didn't want to refactor all the relevant specs.
- {
- s3_upload_bucket: "bucket",
- min_post_length: 5,
- min_first_post_length: 5,
- min_personal_message_post_length: 10,
- download_remote_images_to_local: false,
- unique_posts_mins: 0,
- max_consecutive_replies: 0,
- allow_uncategorized_topics: true,
- }.each { |k, v| SiteSetting.set(k, v) }
-
- SiteSetting.refresh!(refresh_site_settings: false, refresh_theme_site_settings: true)
- SiteSetting.refresh_site_setting_group_ids!
-
- # very expensive IO operations
- SiteSetting.automatically_download_gravatars = false
-
- Discourse.clear_readonly!
- Sidekiq::Worker.clear_all
-
- I18n.locale = SiteSettings::DefaultsProvider::DEFAULT_LOCALE
-
- # Database is rolled back between specs, but I18n override cache doesn't.
- # Flush it if there were any TranslationOverrides created.
- overrides_by_site = I18n.instance_variable_get(:@overrides_by_site) || {}
- I18n.reload! if overrides_by_site.values.flat_map(&:values).any?(&:any?)
-
- RspecErrorTracker.clear_exceptions
-
- if $test_cleanup_callbacks
- $test_cleanup_callbacks.reverse_each(&:call)
- $test_cleanup_callbacks = nil
- end
-
- # in test this is very expensive, we explicitly enable when needed
- Topic.update_featured_topics = false
-
- # Running jobs are expensive and most of our tests are not concern with
- # code that runs inside jobs. run_later! means they are put on the redis
- # queue and never processed.
- Jobs.run_later!
-
- # Don't track ApplicationRequests in test mode unless opted in
- ApplicationRequest.disable
-
- # Don't queue badge grant in test mode
- BadgeGranter.disable_queue
-
- OmniAuth.config.test_mode = false
-
- Middleware::AnonymousCache.disable_anon_cache
- BlockRequestsMiddleware.allow_requests!
- BlockRequestsMiddleware.current_example_location = nil
- ApplicationSerializer.fragment_cache.clear
- end
-end
-
-BROWSER_READ_TIMEOUT = 30
-
RSpec.configure do |config|
config.expect_with :rspec do |c|
c.syntax = :expect
@@ -204,6 +92,9 @@ RSpec.configure do |config|
config.include FastImageHelpers
config.include ServiceMatchers
config.include I18nHelpers
+ config.include TimeHelpers
+ config.include AuthHelpers
+ config.include LoggingHelpers
config.order = "random"
config.infer_spec_type_from_file_location!
@@ -251,44 +142,9 @@ RSpec.configure do |config|
end
config.before(:suite) do
- CachedCounting.disable
-
- begin
- ActiveRecord::Migration.check_all_pending!
- rescue ActiveRecord::PendingMigrationError
- raise "There are pending migrations, run RAILS_ENV=test bin/rake db:migrate"
- end
-
- Sidekiq.default_configuration.error_handlers.clear
-
- # No-op handler to suppress Sidekiq's `p ["!!!!!", ex]` fallback.
- Sidekiq.default_configuration.error_handlers << ->(_ex, _ctx, _config) {}
-
- # Quiet seed-fu output produced by specs that call `Model.seed`.
- SeedFu.quiet = true
-
- # json-schema's MultiJSON support is deprecated.
- JSON::Validator.use_multi_json = false
-
- # Ugly, but needed until we have a user creator
- User.skip_callback(:create, :after, :ensure_in_trust_level_group)
-
- DiscoursePluginRegistry.reset! if ENV["LOAD_PLUGINS"] != "1"
- Discourse.current_user_provider = TestCurrentUserProvider
- Discourse::Application.load_tasks
-
- SystemThemesManager.clear_system_theme_user_history!
- ThemeField.delete_all
- ThemeSettingsMigration.delete_all
- JavascriptCache.delete_all
- ThemeSiteSetting.delete_all
- SiteSetting.refresh!
-
# Rebase the seeded DB settings as defaults, then swap in the in-memory provider.
TestLocalProcessProvider.install!
- DiscourseConnectHelpers.provider_port = 9100 + ENV["TEST_ENV_NUMBER"].to_i
-
WebMock.disable_net_connect!(
allow_localhost: true,
allow: [
@@ -298,360 +154,31 @@ RSpec.configure do |config|
].compact,
)
- if ENV["CAPYBARA_DEFAULT_MAX_WAIT_TIME"].present?
- Capybara.default_max_wait_time = ENV["CAPYBARA_DEFAULT_MAX_WAIT_TIME"].to_i
- else
- Capybara.default_max_wait_time = 4
- end
-
- Capybara.threadsafe = true
- Capybara.disable_animation = true
-
- # Click offsets is calculated from top left of element
- Capybara.w3c_click_offset = false
-
- Capybara.configure do |capybara_config|
- capybara_config.server_host = ENV["CAPYBARA_SERVER_HOST"].presence || "localhost"
-
- capybara_config.server_port =
- (ENV["CAPYBARA_SERVER_PORT"].presence || "31_337").to_i + ENV["TEST_ENV_NUMBER"].to_i
- end
-
- module IgnoreServerCapturedErrors
- def raise_server_error!
- super
- rescue EOFError, Errno::ECONNRESET, Errno::EPIPE, Errno::ENOTCONN
- # Ignore these exceptions - caused by client. Handled by the app server in dev/prod
- end
- end
-
- Capybara::Session.class_eval { prepend IgnoreServerCapturedErrors }
-
- module CapybaraTimeoutExtension
- class CapybaraTimedOut < StandardError
- attr_reader :cause
-
- def initialize(wait_time, cause)
- @cause = cause
- super "This spec passed, but capybara waited for the full wait duration (#{wait_time}s) at least once. " +
- "This will slow down the test suite. " +
- "Beware of negating the result of RSpec matchers."
- end
- end
-
- def synchronize(seconds = nil, errors: nil)
- return super if session.synchronized # Nested synchronize. We only want our logic on the outermost call.
-
- mb_behind = nil
-
- begin
- super
- rescue StandardError => e
- raise unless catch_error?(e, errors) && seconds != 0
-
- # On timeout, give a pending MessageBus publish one chance to land,
- # then retry the matcher once. Cap the retry's wait so the original
- # wait + flush + retry can't blow PER_SPEC_TIMEOUT_SECONDS.
- if mb_behind.nil? && MessageBusTestSync.pending?
- mb_behind = MessageBusTestSync.flush!(session, timeout: 2)
- seconds = 5
- retry
- end
-
- if mb_behind&.any?
- warn "[MessageBusTestSync] client never caught up on: #{mb_behind.inspect}"
- end
-
- # This error will only have been raised if the timer expired
- effective_seconds =
- [nil, true].include?(seconds) ? session_options.default_max_wait_time : seconds
- timeout_error = CapybaraTimedOut.new(effective_seconds, e)
- if RSpec.current_example
- # Store timeout for later, we'll only raise it if the test otherwise passes
- RSpec.current_example.metadata[:_capybara_timeout_exception] ||= timeout_error
-
- if RSpec.current_example.metadata[:dump_threads_on_failure]
- RSpec.current_example.metadata[:_capybara_server_threads_backtraces] = Thread
- .list
- .reduce([]) { |array, thread| array << thread.backtrace }
- .uniq
- end
-
- raise # re-raise original error
- else
- # Outside an example... maybe a `before(:all)` hook?
- raise timeout_error
- end
- end
- end
- end
-
- Capybara::Node::Base.prepend(CapybaraTimeoutExtension)
-
- config.before(:each) do |example|
- if example.metadata[:type] != :system
- EmberCli.stubs(:read_manifest!).returns(nil)
- EmberCli.stubs(:script_chunks).returns({})
- end
- end
-
- config.before(:each, type: :system) { MessageBusTestSync.start }
- config.after(:each, type: :system) { MessageBusTestSync.stop }
-
+ # Registering this from inside before(:suite) makes it run at the end of the
+ # before(:each) chain. It must run after the specs' `sign_in`, so the auth
+ # cookie is made using the correct (current) time.
config.before(:each, type: :system) do |example|
- # Only set ENV["EMBER_RAISE_ON_DEPRECATION"] if not already set
- if ENV["EMBER_RAISE_ON_DEPRECATION"].nil?
- example_file_path = example.metadata[:rerun_file_path]
-
- if example_file_path
- match =
- example_file_path.to_s.match(
- %r{^#{Regexp.escape(Rails.root.to_s)}/(plugins|themes|spec)/([^/]+)/},
- )
-
- if match
- should_set_raise_on_deprecation =
- begin
- type_dir, extension_name = match.captures
-
- case type_dir
- when "spec"
- true
- when "plugins"
- Discourse.preinstalled_plugins.any? { |p| p.directory_name == extension_name }
- when "themes"
- # Preinstalled themes don't have a .git directory
- !Rails.root.join(type_dir, extension_name, ".git").exist?
- end
- end
-
- ENV["EMBER_RAISE_ON_DEPRECATION"] = "1" if should_set_raise_on_deprecation
- end
- end
- end
-
if example.metadata[:time]
freeze_time(example.metadata[:time])
BrowserTime.freeze(page, example.metadata[:time])
end
end
- module CapybaraPlaywrightBasePatch
- private
-
- def execute_async_client_settled_script(session)
- result = session.evaluate_async_script(<<~JS)
- const done = arguments[0];
-
- if (window.clientSettled) {
- window.clientSettled(#{Capybara.default_max_wait_time * 1000})
- .then(done)
- .catch((error) => { done(error.message) });
- } else {
- done();
- }
- JS
-
- raise result if result.is_a? String
- end
-
- def wait_for_client_settled(method_name)
- session = @driver.send(:session)
-
- if ENV["CAPYBARA_PLAYWRIGHT_DEBUG_CLIENT_SETTLED"].present?
- now = Time.now.to_f
- puts "[#{now}] #{method_name}: START"
- execute_async_client_settled_script(session)
- puts "[#{Time.now.to_f}] #{method_name}: END IN #{Time.now.to_f - now}"
- else
- execute_async_client_settled_script(session)
- end
- end
- end
-
- module CapybaraPlaywrightNodePatch
- include CapybaraPlaywrightBasePatch
-
- NODE_METHODS_TO_PATCH = %i[
- click
- right_click
- double_click
- send_keys
- hover
- drag_to
- scroll_by
- scroll_to
- trigger
- set
- select_option
- unselect_option
- ]
-
- NODE_METHODS_TO_PATCH.each do |method_name|
- define_method(method_name) do |*args, **options|
- result = super(*args, **options)
- wait_for_client_settled(method_name)
- result
- end
- end
- end
-
- module CapybaraPlaywrightBrowserPatch
- include CapybaraPlaywrightBasePatch
-
- METHODS_TO_PATCH = %i[visit go_back go_forward refresh resize_window_to]
-
- METHODS_TO_PATCH.each do |method_name|
- define_method(method_name) do |*args, **options|
- result = super(*args, **options)
- wait_for_ember_boot
- wait_for_client_settled(method_name)
- result
- end
- end
-
- private
-
- # `<discourse-assets>` is only present on Ember pages; `ember-application`
- # is added to the root element (`#main`) once Ember mounts.
- def wait_for_ember_boot
- session = @driver.send(:session)
- return if session.has_no_css?("discourse-assets", wait: 0, visible: :all)
- session.assert_selector("#main.ember-application", visible: :all)
- end
- end
-
- Capybara::Playwright::Node.prepend(CapybaraPlaywrightNodePatch)
- Capybara::Playwright::Browser.prepend(CapybaraPlaywrightBrowserPatch)
-
- module PlaywrightErrorPatch
- def message
- msg = super
- if msg.include?("Please run the following command to download new browsers:")
- replacement = "pnpm playwright-install"
- msg.sub("playwright install".ljust(replacement.size), replacement)
- else
- msg
- end
- end
- end
- Playwright::Error.prepend(PlaywrightErrorPatch)
-
- config.after(:each, type: :system) do |example|
- # If test passed, but we had a capybara finder timeout, raise it now
- if example.exception.nil? &&
- (capybara_timeout_error = example.metadata[:_capybara_timeout_exception])
- raise capybara_timeout_error
- end
- end
-
- if ENV["CI"].present?
- [
- [PostAction, :post_action_type_id],
- [Reviewable, :target_id],
- [ReviewableHistory, :reviewable_id],
- [ReviewableScore, :reviewable_id],
- [ReviewableScore, :reviewable_score_type],
- [SidebarSectionLink, :linkable_id],
- [SidebarSectionLink, :sidebar_section_id],
- [User, :last_seen_reviewable_id],
- [User, :required_fields_version],
- ].each do |model, column|
- DB.exec("ALTER TABLE #{model.table_name} ALTER #{column} TYPE bigint")
- model.reset_column_information
- end
-
- # Sets sequence's value to be greater than the max value that an INT column can hold. This is done to prevent
- # type mismatches for foreign keys that references a column of type BIGINT. We set the value to 10_000_000_000
- # instead of 2**31-1 so that the values are easier to read.
- DB
- .query("SELECT sequence_name FROM information_schema.sequences WHERE data_type = 'bigint'")
- .each do |row|
- DB.exec "SELECT setval('#{row.sequence_name}', GREATEST((SELECT last_value FROM #{row.sequence_name}), 10000000000))"
- end
- end
-
# Prevents 500 errors for site setting URLs pointing to test.localhost in system specs.
SiteIconManager.clear_cache!
end
config.after(:suite) { Downloads.clear }
- config.before :each do
- # This allows DB.transaction_open? to work in tests. See lib/mini_sql_multisite_connection.rb
- DB.test_transaction = ActiveRecord::Base.connection.current_transaction
- TestSetup.test_setup
- end
+ config.before(:each) { TestSetup.test_setup }
# Match the request hostname to the value in `database.yml`
config.before(:each, type: %i[request multisite system]) { host! "test.localhost" }
- system_tests_initialized = false
-
config.before(:each, type: :system) do |example|
- if !system_tests_initialized
- # On Rails 7, we have seen instances of deadlocks between the lock in [ActiveRecord::ConnectionAdapters::AbstractAdapter](https://github.com/rails/rails/blob/9d1673853f13cd6f756315ac333b20d512db4d58/activerecord/lib/active_record/connection_adapters/abstract_adapter.rb#L86)
- # and the lock in [ActiveRecord::ModelSchema](https://github.com/rails/rails/blob/9d1673853f13cd6f756315ac333b20d512db4d58/activerecord/lib/active_record/model_schema.rb#L550).
- # To work around this problem, we are going to preload all the model schemas before running any system tests so that
- # the lock in ActiveRecord::ModelSchema is not acquired at runtime. This is a temporary workaround while we report
- # the issue to the Rails.
- ActiveRecord::Base.connection.data_sources.map do |table|
- ActiveRecord::Base.connection.schema_cache.add(table)
- end
-
- system_tests_initialized = true
- end
-
- driver_options = {
- browser_type: :chromium,
- channel: :chromium,
- headless: (ENV["PLAYWRIGHT_HEADLESS"].presence || ENV["SELENIUM_HEADLESS"].presence) != "0",
- args: apply_base_chrome_args,
- acceptDownloads: true,
- downloadsPath: Downloads::FOLDER,
- slowMo: ENV["PLAYWRIGHT_SLOW_MO_MS"].to_i, # https://playwright.dev/docs/api/class-browsertype#browser-type-launch-option-slow-mo
- playwright_cli_executable_path: "./node_modules/.bin/playwright",
- logger: Logger.new(IO::NULL),
- # NOTE: timezoneId is NOT set here because the driver is cached and reused,
- # so only the first test's timezone would be applied. Instead, we use CDP
- # to override the timezone per-test in the before(:each) hook below.
- colorScheme: example.metadata[:color_scheme],
- }
-
- if ENV["CAPYBARA_REMOTE_DRIVER_URL"].present?
- driver_options[:browser] = :remote
- driver_options[:url] = ENV["CAPYBARA_REMOTE_DRIVER_URL"]
- end
-
- Capybara.register_driver(:playwright_mobile_chrome) do |app|
- Capybara::Playwright::Driver.new(
- app,
- **driver_options,
- deviceScaleFactor: 3,
- isMobile: true,
- hasTouch: true,
- userAgent:
- "Mozilla/5.0 (iPhone; CPU iPhone OS 16_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.4 Mobile/15E148 Safari/604.1",
- defaultBrowserType: "webkit",
- viewport: ENV["PLAYWRIGHT_NO_VIEWPORT"] == "1" ? nil : { width: 390, height: 664 },
- )
- end
-
- Capybara.register_driver(:playwright_chrome) do |app|
- Capybara::Playwright::Driver.new(
- app,
- **driver_options,
- viewport: ENV["PLAYWRIGHT_NO_VIEWPORT"] == "1" ? nil : { width: 1400, height: 1400 },
- )
- end
-
- Capybara.default_driver = :playwright_chrome
-
- driver = [:playwright]
- driver << :mobile if example.metadata[:mobile]
- driver << :chrome
-
- driven_by driver.join("_").to_sym
+ SystemDrivers.preload_model_schemas!
+ SystemDrivers.register!(color_scheme: example.metadata[:color_scheme])
+ driven_by SystemDrivers.driver_for(example)
setup_system_test
@@ -662,26 +189,8 @@ RSpec.configure do |config|
# they click things in the composer.
SiteSetting.educate_until_posts = 0
- if example.metadata[:video]
- Capybara.current_session.driver.on_save_screenrecord do |video|
- saved_path =
- File.join(
- Capybara.save_path,
- "#{example.metadata[:full_description].parameterize}-screenrecord.webm",
- )
-
- FileUtils.mv(video, saved_path)
-
- if !ENV["CI"]
- puts "\n🎥 Recorded video for: #{example.metadata[:full_description]}\n"
- puts "#{saved_path}\n"
- end
- end
- end
-
- if example.metadata[:trace]
- page.driver.start_tracing(screenshots: true, snapshots: true, sources: true)
- end
+ SystemArtifacts.record_video(example)
+ SystemArtifacts.start_trace(page, example)
page.driver.with_playwright_page do |pw_page|
$playwright_logger = PlaywrightLogger.new(pw_page)
@@ -692,9 +201,22 @@ RSpec.configure do |config|
end
end
- config.after :each do |example|
+ config.before(:each) do |example|
+ if example.metadata[:type] != :system
+ EmberCli.stubs(:read_manifest!).returns(nil)
+ EmberCli.stubs(:script_chunks).returns({})
+ end
+ end
+
+ config.before(:each, type: :system) { MessageBusTestSync.start }
+
+ config.before(:each, type: :system) do |example|
+ EmberDeprecations.set_raise_on_deprecation!(example)
+ end
+
+ config.after(:each) do |example|
if example.exception && RspecErrorTracker.exceptions.present?
- lines = (RSpec.current_example.metadata[:extra_failure_lines] ||= +"")
+ lines = (example.metadata[:extra_failure_lines] ||= +"")
RspecErrorTracker.append_failure_dump(lines)
end
@@ -707,88 +229,25 @@ RSpec.configure do |config|
end
config.after(:each, type: :system) do |example|
- if example.metadata[:trace]
- path =
- File.join(
- Capybara.save_path,
- "#{example.metadata[:full_description].parameterize}-trace.zip",
- )
- page.driver.stop_tracing(path:)
-
- if !ENV["CI"]
- puts "\n🧭 Recorded trace for: #{example.metadata[:full_description]}\n"
- puts "Open with `pnpm playwright show-trace #{path}`\n"
- end
- end
+ SystemArtifacts.stop_trace(page, example)
- lines = RSpec.current_example.metadata[:extra_failure_lines]
+ lines = example.metadata[:extra_failure_lines]
if example.exception &&
- (
- backtraces = RSpec.current_example.metadata[:_capybara_server_threads_backtraces]
- ).present?
- lines << "~~~~~~~ SERVER THREADS BACKTRACES ~~~~~~~"
-
- backtraces.each_with_index do |backtrace, index|
- lines << "\n" if index != 0
- backtrace.each { |line| lines << line }
- end
-
- lines << "~~~~~~~ END SERVER THREADS BACKTRACES ~~~~~~~"
- lines << "\n"
+ (backtraces = example.metadata[:_capybara_server_threads_backtraces]).present?
+ CapybaraTimeoutExtension.append_server_thread_backtraces(lines, backtraces)
end
# Recommended that this is not disabled, since it makes debugging
# failed system tests a lot trickier.
- if ENV["PLAYWRIGHT_DISABLE_VERBOSE_JS_LOGS"].blank? && $playwright_logger
- if example.exception
- lines << "~~~~~~~ JS LOGS ~~~~~~~"
-
- if $playwright_logger.logs.empty?
- lines << "(no logs)"
- else
- $playwright_logger.logs.each do |log|
- # System specs are full of image load errors that are just noise, no need
- # to log this.
- if (
- log[:message].include?("Failed to load resource: net::ERR_CONNECTION_REFUSED") &&
- (log[:message].include?("uploads") || log[:message].include?("images"))
- ) || log[:message].include?("favicon.ico")
- next
- end
-
- lines << log[:message]
- end
- end
-
- lines << "~~~~~ END JS LOGS ~~~~~"
- end
+ if ENV["PLAYWRIGHT_DISABLE_VERBOSE_JS_LOGS"].blank? && $playwright_logger && example.exception
+ $playwright_logger.append_failure_logs(lines)
end
- deprecation_error =
- $playwright_logger
- &.logs
- &.filter_map do |log|
- if log[:level] == "trace"
- error = JSON.parse(log[:message][/^fatal_deprecation:(.+)$/, 1])
- "~~~~~~~ JS ERROR ~~~~~~~\n#{error}\n~~~~~ END JS ERROR ~~~~~"
- end
- end
- &.first
-
+ deprecation_error = EmberDeprecations.fatal_error($playwright_logger&.logs)
expect(deprecation_error).to be_nil, deprecation_error
- expected_deprecations = RSpec.current_example.metadata[:expected_js_deprecations] || []
-
- $playwright_logger&.logs&.each do |log|
- next if log[:level] != "count"
- deprecation_id = log[:message][/^deprecation_id:(.+?):\s*\d+$/, 1]
- next if deprecation_id.nil?
- next if expected_deprecations.include?(deprecation_id)
-
- deprecations = RSpec.current_example.metadata[:js_deprecations] ||= Hash.new(0)
- deprecations[deprecation_id] += 1
- end
+ EmberDeprecations.record_counts($playwright_logger&.logs, example.metadata)
page.execute_script("if (typeof MessageBus !== 'undefined') { MessageBus.stop(); }")
@@ -798,99 +257,17 @@ RSpec.configure do |config|
Capybara.reset_session!
MessageBus.backend_instance.reset! # Clears all existing backlog from memory backend
end
-end
-
-def before_next_spec(&callback)
- ($test_cleanup_callbacks ||= []) << callback
-end
-
-def global_setting(name, value)
- SiteSetting.hidden_settings_provider.remove_hidden(name)
- SiteSetting.shadowed_settings.delete(name)
- GlobalSetting.reset_s3_cache!
-
- GlobalSetting.stubs(name).returns(value)
-
- before_next_spec do
- SiteSetting.hidden_settings_provider.remove_hidden(name)
- SiteSetting.shadowed_settings.delete(name)
- GlobalSetting.reset_s3_cache!
- end
-end
-
-def set_cdn_url(cdn_url)
- global_setting :cdn_url, cdn_url
- Rails.configuration.action_controller.asset_host = cdn_url
- ActionController::Base.asset_host = cdn_url
-
- before_next_spec do
- Rails.configuration.action_controller.asset_host = nil
- ActionController::Base.asset_host = nil
- end
-end
-
-def has_trigger?(trigger_name)
- DB.exec(<<~SQL) != 0
- SELECT 1
- FROM INFORMATION_SCHEMA.TRIGGERS
- WHERE trigger_name = '#{trigger_name}'
- SQL
-end
-
-def stub_deprecated_settings!(override:)
- SiteSetting.load_settings("#{Rails.root.join("spec/fixtures/site_settings/deprecated_test.yml")}")
-
- stub_const(
- SiteSettings::DeprecatedSettings,
- "SETTINGS",
- [["old_one", "new_one", override, "0.0.1"]],
- ) do
- SiteSetting.setup_deprecated_methods
- yield
- end
-
- defaults = SiteSetting.defaults.instance_variable_get(:@defaults)
- defaults.each { |_, hash| hash.delete(:old_one) }
- defaults.each { |_, hash| hash.delete(:new_one) }
-end
-
-def apply_base_chrome_args(args = [])
- base_args = %w[
- --disable-search-engine-choice-screen
- --no-sandbox
- --disable-dev-shm-usage
- --mute-audio
- --remote-allow-origins=*
- --disable-smooth-scrolling
- ]
-
- if !ENV["CI"]
- base_args << "--remote-debugging-port=" + CHROME_REMOTE_DEBUGGING_PORT
- base_args << "--remote-debugging-address=" + CHROME_REMOTE_DEBUGGING_ADDRESS
- end
-
- resolver_rules = ["MAP test.localhost:80 127.0.0.1:#{Capybara.server_port}"]
- if ENV["CI"]
- # Bypass the OS resolver for localhost lookups inside the browser.
- resolver_rules.push("MAP localhost [::1]", "MAP *.localhost [::1]")
- end
- base_args << "--host-resolver-rules=#{resolver_rules.join(",")}"
- # A file that contains just a list of paths like so:
- #
- # /home/me/.config/google-chrome/Default/Extensions/bmdblncegkenkacieihfhpjfppoconhi/4.9.1_0
- #
- # These paths can be found for each individual extension via the
- # chrome://extensions/ page.
- if ENV["CHROME_LOAD_EXTENSIONS_MANIFEST"].present?
- File
- .readlines(ENV["CHROME_LOAD_EXTENSIONS_MANIFEST"])
- .each { |path| base_args << "--load-extension=#{path}" }
- end
+ # Registered last so that, running in reverse order, it executes before the
+ # teardown hook above. `MessageBusTestSync.stop` must come before the timeout
+ # re-raise, otherwise the raise would skip it.
+ config.after(:each, type: :system) do |example|
+ MessageBusTestSync.stop
- if ENV["CHROME_DISABLE_FORCE_DEVICE_SCALE_FACTOR"].blank?
- base_args << "--force-device-scale-factor=1"
+ # If test passed, but we had a capybara finder timeout, raise it now
+ if example.exception.nil? &&
+ (capybara_timeout_error = example.metadata[:_capybara_timeout_exception])
+ raise capybara_timeout_error
+ end
end
-
- base_args + args
end
diff --git a/spec/support/auth_helpers.rb b/spec/support/auth_helpers.rb
index 954b3c41521..6507c1d7206 100644
--- a/spec/support/auth_helpers.rb
+++ b/spec/support/auth_helpers.rb
@@ -61,5 +61,3 @@ module AuthHelpers
str
end
end
-
-RSpec.configure { |config| config.include(AuthHelpers) }
diff --git a/spec/support/discourse_connect_support_helpers.rb b/spec/support/discourse_connect_support_helpers.rb
index 5fbbc7eac60..22185fbef41 100644
--- a/spec/support/discourse_connect_support_helpers.rb
+++ b/spec/support/discourse_connect_support_helpers.rb
@@ -71,3 +71,9 @@ module DiscourseConnectHelpers
false
end
end
+
+RSpec.configure do |config|
+ config.before(:suite) do
+ DiscourseConnectHelpers.provider_port = 9100 + ENV["TEST_ENV_NUMBER"].to_i
+ end
+end
diff --git a/spec/support/helpers.rb b/spec/support/helpers.rb
index 43838b2ddda..1f5c980cc9c 100644
--- a/spec/support/helpers.rb
+++ b/spec/support/helpers.rb
@@ -382,6 +382,14 @@ module Helpers
)
end
+ def has_trigger?(trigger_name)
+ DB.exec(<<~SQL) != 0
+ SELECT 1
+ FROM INFORMATION_SCHEMA.TRIGGERS
+ WHERE trigger_name = '#{trigger_name}'
+ SQL
+ end
+
private
def directory_from_caller
diff --git a/spec/support/logging_helpers.rb b/spec/support/logging_helpers.rb
index 4b20860b9b8..3ece9388c90 100644
--- a/spec/support/logging_helpers.rb
+++ b/spec/support/logging_helpers.rb
@@ -20,8 +20,6 @@ module LoggingHelpers
end
end
-RSpec.configure { |config| config.include(LoggingHelpers) }
-
# Block direct assignment to Rails.logger in tests; use `track_log_messages` instead.
def Rails.logger=(logger)
raise "Setting Rails.logger is not allowed as it can lead to unexpected behavior in tests. Use `fake_logger = track_log_messages { ... }` instead."
diff --git a/spec/support/computed_style_matcher.rb b/spec/support/matchers/computed_style_matcher.rb
similarity index 100%
rename from spec/support/computed_style_matcher.rb
rename to spec/support/matchers/computed_style_matcher.rb
diff --git a/spec/support/dom_matcher.rb b/spec/support/matchers/dom_matcher.rb
similarity index 100%
rename from spec/support/dom_matcher.rb
rename to spec/support/matchers/dom_matcher.rb
diff --git a/spec/support/match_html_matcher.rb b/spec/support/matchers/match_html_matcher.rb
similarity index 100%
rename from spec/support/match_html_matcher.rb
rename to spec/support/matchers/match_html_matcher.rb
diff --git a/spec/support/negated_matcher.rb b/spec/support/matchers/negated_matcher.rb
similarity index 100%
rename from spec/support/negated_matcher.rb
rename to spec/support/matchers/negated_matcher.rb
diff --git a/spec/support/problem_check_matcher.rb b/spec/support/matchers/problem_check_matcher.rb
similarity index 100%
rename from spec/support/problem_check_matcher.rb
rename to spec/support/matchers/problem_check_matcher.rb
diff --git a/spec/support/rate_limit_matcher.rb b/spec/support/matchers/rate_limit_matcher.rb
similarity index 100%
rename from spec/support/rate_limit_matcher.rb
rename to spec/support/matchers/rate_limit_matcher.rb
diff --git a/spec/support/service_matchers.rb b/spec/support/matchers/service_matchers.rb
similarity index 100%
rename from spec/support/service_matchers.rb
rename to spec/support/matchers/service_matchers.rb
diff --git a/spec/support/time_matcher.rb b/spec/support/matchers/time_matcher.rb
similarity index 100%
rename from spec/support/time_matcher.rb
rename to spec/support/matchers/time_matcher.rb
diff --git a/spec/support/ts_vector_matcher.rb b/spec/support/matchers/ts_vector_matcher.rb
similarity index 100%
rename from spec/support/ts_vector_matcher.rb
rename to spec/support/matchers/ts_vector_matcher.rb
diff --git a/spec/support/prefabrication.rb b/spec/support/prefabrication.rb
index 00535bdc5aa..67fe1a092ac 100644
--- a/spec/support/prefabrication.rb
+++ b/spec/support/prefabrication.rb
@@ -15,12 +15,7 @@ else
require "test_prof/recipes/rspec/let_it_be"
require "test_prof/before_all/adapters/active_record"
- TestProf::BeforeAll.configure do |config|
- config.after(:begin) do
- DB.test_transaction = ActiveRecord::Base.connection.current_transaction
- TestSetup.test_setup
- end
- end
+ TestProf::BeforeAll.configure { |config| config.after(:begin) { TestSetup.test_setup } }
module Prefabrication
def fab!(name, fabricator_name = nil, **opts, &blk)
diff --git a/spec/support/site_settings_helpers.rb b/spec/support/site_settings_helpers.rb
index 686749d0ec9..d6abe2e3fbe 100644
--- a/spec/support/site_settings_helpers.rb
+++ b/spec/support/site_settings_helpers.rb
@@ -14,4 +14,48 @@ module SiteSettingsHelpers
end
end
end
+
+ def global_setting(name, value)
+ SiteSetting.hidden_settings_provider.remove_hidden(name)
+ SiteSetting.shadowed_settings.delete(name)
+ GlobalSetting.reset_s3_cache!
+
+ GlobalSetting.stubs(name).returns(value)
+
+ before_next_spec do
+ SiteSetting.hidden_settings_provider.remove_hidden(name)
+ SiteSetting.shadowed_settings.delete(name)
+ GlobalSetting.reset_s3_cache!
+ end
+ end
+
+ def set_cdn_url(cdn_url)
+ global_setting :cdn_url, cdn_url
+ Rails.configuration.action_controller.asset_host = cdn_url
+ ActionController::Base.asset_host = cdn_url
+
+ before_next_spec do
+ Rails.configuration.action_controller.asset_host = nil
+ ActionController::Base.asset_host = nil
+ end
+ end
+
+ def stub_deprecated_settings!(override:)
+ SiteSetting.load_settings(
+ "#{Rails.root.join("spec/fixtures/site_settings/deprecated_test.yml")}",
+ )
+
+ stub_const(
+ SiteSettings::DeprecatedSettings,
+ "SETTINGS",
+ [["old_one", "new_one", override, "0.0.1"]],
+ ) do
+ SiteSetting.setup_deprecated_methods
+ yield
+ end
+
+ defaults = SiteSetting.defaults.instance_variable_get(:@defaults)
+ defaults.each { |_, hash| hash.delete(:old_one) }
+ defaults.each { |_, hash| hash.delete(:new_one) }
+ end
end
diff --git a/spec/support/site_settings_provider.rb b/spec/support/site_settings_provider.rb
index 81881720d60..c0d2c94d0c9 100644
--- a/spec/support/site_settings_provider.rb
+++ b/spec/support/site_settings_provider.rb
@@ -20,6 +20,9 @@ class TestLocalProcessProvider < SiteSettings::LocalProcessProvider
SiteSetting.defaults.set_regardless_of_locale(k, v) if SiteSetting.respond_to? k
end
+ # Gravatar downloads hit the network, so force the default off.
+ SiteSetting.defaults.set_regardless_of_locale(:automatically_download_gravatars, false)
+
SiteSetting.provider = new
end
end
diff --git a/spec/support/suite_setup.rb b/spec/support/suite_setup.rb
new file mode 100644
index 00000000000..81543e33db7
--- /dev/null
+++ b/spec/support/suite_setup.rb
@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# One-time suite bootstrap: disable expensive subsystems, check for pending
+# migrations, (on CI) widen INT foreign-key columns to BIGINT, quiet noisy
+# output, wire the test current-user provider, and reset themes.
+RSpec.configure do |config|
+ config.before(:suite) do
+ CachedCounting.disable
+
+ begin
+ ActiveRecord::Migration.check_all_pending!
+ rescue ActiveRecord::PendingMigrationError
+ raise "There are pending migrations, run RAILS_ENV=test bin/rake db:migrate"
+ end
+
+ # On CI, widen the INT columns referenced by BIGINT foreign keys and bump
+ # their sequences past the INT max so the types line up.
+ if ENV["CI"].present?
+ [
+ [PostAction, :post_action_type_id],
+ [Reviewable, :target_id],
+ [ReviewableHistory, :reviewable_id],
+ [ReviewableScore, :reviewable_id],
+ [ReviewableScore, :reviewable_score_type],
+ [SidebarSectionLink, :linkable_id],
+ [SidebarSectionLink, :sidebar_section_id],
+ [User, :last_seen_reviewable_id],
+ [User, :required_fields_version],
+ ].each do |model, column|
+ DB.exec("ALTER TABLE #{model.table_name} ALTER #{column} TYPE bigint")
+ model.reset_column_information
+ end
+
+ # Sets sequence's value to be greater than the max value that an INT column can hold. This is done to prevent
+ # type mismatches for foreign keys that references a column of type BIGINT. We set the value to 10_000_000_000
+ # instead of 2**31-1 so that the values are easier to read.
+ DB
+ .query("SELECT sequence_name FROM information_schema.sequences WHERE data_type = 'bigint'")
+ .each do |row|
+ DB.exec "SELECT setval('#{row.sequence_name}', GREATEST((SELECT last_value FROM #{row.sequence_name}), 10000000000))"
+ end
+ end
+
+ Sidekiq.default_configuration.error_handlers.clear
+
+ # No-op handler to suppress Sidekiq's `p ["!!!!!", ex]` fallback.
+ Sidekiq.default_configuration.error_handlers << ->(_ex, _ctx, _config) {}
+
+ # Quiet seed-fu output produced by specs that call `Model.seed`.
+ SeedFu.quiet = true
+
+ # json-schema's MultiJSON support is deprecated.
+ JSON::Validator.use_multi_json = false
+
+ # Ugly, but needed until we have a user creator
+ User.skip_callback(:create, :after, :ensure_in_trust_level_group)
+
+ DiscoursePluginRegistry.reset! if ENV["LOAD_PLUGINS"] != "1"
+ Discourse.current_user_provider = TestCurrentUserProvider
+ Discourse::Application.load_tasks
+
+ SystemThemesManager.clear_system_theme_user_history!
+ ThemeField.delete_all
+ ThemeSettingsMigration.delete_all
+ JavascriptCache.delete_all
+ ThemeSiteSetting.delete_all
+ SiteSetting.refresh!
+ end
+end
diff --git a/spec/support/system/artifacts.rb b/spec/support/system/artifacts.rb
new file mode 100644
index 00000000000..605b571659e
--- /dev/null
+++ b/spec/support/system/artifacts.rb
@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Per-example debugging artifacts for system specs, captured when the example is
+# tagged `video: true` or `trace: true`.
+module SystemArtifacts
+ # Save a screen recording for the example.
+ def self.record_video(example)
+ return unless example.metadata[:video]
+
+ Capybara.current_session.driver.on_save_screenrecord do |video|
+ saved_path =
+ File.join(
+ Capybara.save_path,
+ "#{example.metadata[:full_description].parameterize}-screenrecord.webm",
+ )
+
+ FileUtils.mv(video, saved_path)
+
+ if !ENV["CI"]
+ puts "\n🎥 Recorded video for: #{example.metadata[:full_description]}\n"
+ puts "#{saved_path}\n"
+ end
+ end
+ end
+
+ # Start a Playwright trace for the example.
+ def self.start_trace(page, example)
+ return unless example.metadata[:trace]
+
+ page.driver.start_tracing(screenshots: true, snapshots: true, sources: true)
+ end
+
+ # Stop and save the Playwright trace (paired with start_trace).
+ def self.stop_trace(page, example)
+ return unless example.metadata[:trace]
+
+ path =
+ File.join(Capybara.save_path, "#{example.metadata[:full_description].parameterize}-trace.zip")
+ page.driver.stop_tracing(path:)
+
+ if !ENV["CI"]
+ puts "\n🧭 Recorded trace for: #{example.metadata[:full_description]}\n"
+ puts "Open with `pnpm playwright show-trace #{path}`\n"
+ end
+ end
+end
diff --git a/spec/support/system/capybara_patches.rb b/spec/support/system/capybara_patches.rb
new file mode 100644
index 00000000000..76aab5ddc11
--- /dev/null
+++ b/spec/support/system/capybara_patches.rb
@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+# Monkey patches for the Capybara/Playwright drivers used in system specs. The
+# target classes are loaded at boot (capybara-playwright-driver, playwright),
+# so these prepends run safely at load time.
+
+module IgnoreServerCapturedErrors
+ def raise_server_error!
+ super
+ rescue EOFError, Errno::ECONNRESET, Errno::EPIPE, Errno::ENOTCONN
+ # Ignore these exceptions - caused by client. Handled by the app server in dev/prod
+ end
+end
+
+Capybara::Session.class_eval { prepend IgnoreServerCapturedErrors }
+
+module CapybaraTimeoutExtension
+ class CapybaraTimedOut < StandardError
+ attr_reader :cause
+
+ def initialize(wait_time, cause)
+ @cause = cause
+ super "This spec passed, but capybara waited for the full wait duration (#{wait_time}s) at least once. " +
+ "This will slow down the test suite. " +
+ "Beware of negating the result of RSpec matchers."
+ end
+ end
+
+ def synchronize(seconds = nil, errors: nil)
+ return super if session.synchronized # Nested synchronize. We only want our logic on the outermost call.
+
+ mb_behind = nil
+
+ begin
+ super
+ rescue StandardError => e
+ raise unless catch_error?(e, errors) && seconds != 0
+
+ # On timeout, give a pending MessageBus publish one chance to land,
+ # then retry the matcher once. Cap the retry's wait so the original
+ # wait + flush + retry can't blow PER_SPEC_TIMEOUT_SECONDS.
+ if mb_behind.nil? && MessageBusTestSync.pending?
+ mb_behind = MessageBusTestSync.flush!(session, timeout: 2)
+ seconds = 5
+ retry
+ end
+
+ warn "[MessageBusTestSync] client never caught up on: #{mb_behind.inspect}" if mb_behind&.any?
+
+ # This error will only have been raised if the timer expired
+ effective_seconds =
+ [nil, true].include?(seconds) ? session_options.default_max_wait_time : seconds
+ timeout_error = CapybaraTimedOut.new(effective_seconds, e)
+ if RSpec.current_example
+ # Store timeout for later, we'll only raise it if the test otherwise passes
+ RSpec.current_example.metadata[:_capybara_timeout_exception] ||= timeout_error
+
+ if RSpec.current_example.metadata[:dump_threads_on_failure]
+ RSpec.current_example.metadata[:_capybara_server_threads_backtraces] = Thread
+ .list
+ .reduce([]) { |array, thread| array << thread.backtrace }
+ .uniq
+ end
+
+ raise # re-raise original error
+ else
+ # Outside an example... maybe a `before(:all)` hook?
+ raise timeout_error
+ end
+ end
+ end
+
+ # Appends the server-thread backtraces captured above (for
+ # `dump_threads_on_failure` specs) to a failure-output buffer.
+ def self.append_server_thread_backtraces(lines, backtraces)
+ lines << "~~~~~~~ SERVER THREADS BACKTRACES ~~~~~~~"
+
+ backtraces.each_with_index do |backtrace, index|
+ lines << "\n" if index != 0
+ backtrace.each { |line| lines << line }
+ end
+
+ lines << "~~~~~~~ END SERVER THREADS BACKTRACES ~~~~~~~"
+ lines << "\n"
+ end
+end
+
+Capybara::Node::Base.prepend(CapybaraTimeoutExtension)
+
+module CapybaraPlaywrightBasePatch
+ private
+
+ def execute_async_client_settled_script(session)
+ result = session.evaluate_async_script(<<~JS)
+ const done = arguments[0];
+
+ if (window.clientSettled) {
+ window.clientSettled(#{Capybara.default_max_wait_time * 1000})
+ .then(done)
+ .catch((error) => { done(error.message) });
+ } else {
+ done();
+ }
+ JS
+
+ raise result if result.is_a? String
+ end
+
+ def wait_for_client_settled(method_name)
+ session = @driver.send(:session)
+
+ if ENV["CAPYBARA_PLAYWRIGHT_DEBUG_CLIENT_SETTLED"].present?
+ now = Time.now.to_f
+ puts "[#{now}] #{method_name}: START"
+ execute_async_client_settled_script(session)
+ puts "[#{Time.now.to_f}] #{method_name}: END IN #{Time.now.to_f - now}"
+ else
+ execute_async_client_settled_script(session)
+ end
+ end
+end
+
+module CapybaraPlaywrightNodePatch
+ include CapybaraPlaywrightBasePatch
+
+ NODE_METHODS_TO_PATCH = %i[
+ click
+ right_click
+ double_click
+ send_keys
+ hover
+ drag_to
+ scroll_by
+ scroll_to
+ trigger
+ set
+ select_option
+ unselect_option
+ ]
+
+ NODE_METHODS_TO_PATCH.each do |method_name|
+ define_method(method_name) do |*args, **options|
+ result = super(*args, **options)
+ wait_for_client_settled(method_name)
+ result
+ end
+ end
+end
+
+module CapybaraPlaywrightBrowserPatch
+ include CapybaraPlaywrightBasePatch
+
+ METHODS_TO_PATCH = %i[visit go_back go_forward refresh resize_window_to]
+
+ METHODS_TO_PATCH.each do |method_name|
+ define_method(method_name) do |*args, **options|
+ result = super(*args, **options)
+ wait_for_ember_boot
+ wait_for_client_settled(method_name)
+ result
+ end
+ end
+
+ private
+
+ # `<discourse-assets>` is only present on Ember pages; `ember-application`
+ # is added to the root element (`#main`) once Ember mounts.
+ def wait_for_ember_boot
+ session = @driver.send(:session)
+ return if session.has_no_css?("discourse-assets", wait: 0, visible: :all)
+ session.assert_selector("#main.ember-application", visible: :all)
+ end
+end
+
+Capybara::Playwright::Node.prepend(CapybaraPlaywrightNodePatch)
+Capybara::Playwright::Browser.prepend(CapybaraPlaywrightBrowserPatch)
+
+module PlaywrightErrorPatch
+ def message
+ msg = super
+ if msg.include?("Please run the following command to download new browsers:")
+ replacement = "pnpm playwright-install"
+ msg.sub("playwright install".ljust(replacement.size), replacement)
+ else
+ msg
+ end
+ end
+end
+Playwright::Error.prepend(PlaywrightErrorPatch)
diff --git a/spec/support/system/driver.rb b/spec/support/system/driver.rb
new file mode 100644
index 00000000000..09bfaca22ec
--- /dev/null
+++ b/spec/support/system/driver.rb
@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+# Playwright/Chrome driver setup for system specs: the remote-debugging endpoint,
+# the Chrome launch args, and driver registration.
+CHROME_REMOTE_DEBUGGING_PORT = (ENV["CHROME_REMOTE_DEBUGGING_PORT"] || 50_062).to_s
+CHROME_REMOTE_DEBUGGING_ADDRESS = ENV["CHROME_REMOTE_DEBUGGING_ADDRESS"] || "127.0.0.1"
+
+module SystemDrivers
+ # On Rails 7, we have seen instances of deadlocks between the lock in [ActiveRecord::ConnectionAdapters::AbstractAdapter](https://github.com/rails/rails/blob/9d1673853f13cd6f756315ac333b20d512db4d58/activerecord/lib/active_record/connection_adapters/abstract_adapter.rb#L86)
+ # and the lock in [ActiveRecord::ModelSchema](https://github.com/rails/rails/blob/9d1673853f13cd6f756315ac333b20d512db4d58/activerecord/lib/active_record/model_schema.rb#L550).
+ # To work around this problem, we are going to preload all the model schemas before running any system tests so that
+ # the lock in ActiveRecord::ModelSchema is not acquired at runtime. This is a temporary workaround while we report
+ # the issue to the Rails.
+ def self.preload_model_schemas!
+ return if @schemas_preloaded
+
+ ActiveRecord::Base.connection.data_sources.each do |table|
+ ActiveRecord::Base.connection.schema_cache.add(table)
+ end
+
+ @schemas_preloaded = true
+ end
+
+ # Builds the registered driver name for the example (mobile vs desktop chrome).
+ def self.driver_for(example)
+ driver = [:playwright]
+ driver << :mobile if example.metadata[:mobile]
+ driver << :chrome
+ driver.join("_").to_sym
+ end
+
+ def self.register!(color_scheme:)
+ driver_options = {
+ browser_type: :chromium,
+ channel: :chromium,
+ headless: (ENV["PLAYWRIGHT_HEADLESS"].presence || ENV["SELENIUM_HEADLESS"].presence) != "0",
+ args: apply_base_chrome_args,
+ acceptDownloads: true,
+ downloadsPath: Downloads::FOLDER,
+ slowMo: ENV["PLAYWRIGHT_SLOW_MO_MS"].to_i, # https://playwright.dev/docs/api/class-browsertype#browser-type-launch-option-slow-mo
+ playwright_cli_executable_path: "./node_modules/.bin/playwright",
+ logger: Logger.new(IO::NULL),
+ # NOTE: timezoneId is NOT set here because the driver is cached and reused,
+ # so only the first test's timezone would be applied. Instead, we use CDP
+ # to override the timezone per-test in the system before(:each) hook.
+ colorScheme: color_scheme,
+ }
+
+ if ENV["CAPYBARA_REMOTE_DRIVER_URL"].present?
+ driver_options[:browser] = :remote
+ driver_options[:url] = ENV["CAPYBARA_REMOTE_DRIVER_URL"]
+ end
+
+ Capybara.register_driver(:playwright_mobile_chrome) do |app|
+ Capybara::Playwright::Driver.new(
+ app,
+ **driver_options,
+ deviceScaleFactor: 3,
+ isMobile: true,
+ hasTouch: true,
+ userAgent:
+ "Mozilla/5.0 (iPhone; CPU iPhone OS 16_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.4 Mobile/15E148 Safari/604.1",
+ defaultBrowserType: "webkit",
+ viewport: ENV["PLAYWRIGHT_NO_VIEWPORT"] == "1" ? nil : { width: 390, height: 664 },
+ )
+ end
+
+ Capybara.register_driver(:playwright_chrome) do |app|
+ Capybara::Playwright::Driver.new(
+ app,
+ **driver_options,
+ viewport: ENV["PLAYWRIGHT_NO_VIEWPORT"] == "1" ? nil : { width: 1400, height: 1400 },
+ )
+ end
+
+ Capybara.default_driver = :playwright_chrome
+ end
+
+ def self.apply_base_chrome_args(args = [])
+ base_args = %w[
+ --disable-search-engine-choice-screen
+ --no-sandbox
+ --disable-dev-shm-usage
+ --mute-audio
+ --remote-allow-origins=*
+ --disable-smooth-scrolling
+ ]
+
+ if !ENV["CI"]
+ base_args << "--remote-debugging-port=" + CHROME_REMOTE_DEBUGGING_PORT
+ base_args << "--remote-debugging-address=" + CHROME_REMOTE_DEBUGGING_ADDRESS
+ end
+
+ resolver_rules = ["MAP test.localhost:80 127.0.0.1:#{Capybara.server_port}"]
+ if ENV["CI"]
+ # Bypass the OS resolver for localhost lookups inside the browser.
+ resolver_rules.push("MAP localhost [::1]", "MAP *.localhost [::1]")
+ end
+ base_args << "--host-resolver-rules=#{resolver_rules.join(",")}"
+
+ # A file that contains just a list of paths like so:
+ #
+ # /home/me/.config/google-chrome/Default/Extensions/bmdblncegkenkacieihfhpjfppoconhi/4.9.1_0
+ #
+ # These paths can be found for each individual extension via the
+ # chrome://extensions/ page.
+ if ENV["CHROME_LOAD_EXTENSIONS_MANIFEST"].present?
+ File
+ .readlines(ENV["CHROME_LOAD_EXTENSIONS_MANIFEST"])
+ .each { |path| base_args << "--load-extension=#{path}" }
+ end
+
+ if ENV["CHROME_DISABLE_FORCE_DEVICE_SCALE_FACTOR"].blank?
+ base_args << "--force-device-scale-factor=1"
+ end
+
+ base_args + args
+ end
+ private_class_method :apply_base_chrome_args
+end
+
+RSpec.configure do |config|
+ config.before(:suite) do
+ if ENV["CAPYBARA_DEFAULT_MAX_WAIT_TIME"].present?
+ Capybara.default_max_wait_time = ENV["CAPYBARA_DEFAULT_MAX_WAIT_TIME"].to_i
+ else
+ Capybara.default_max_wait_time = 4
+ end
+
+ Capybara.threadsafe = true
+ Capybara.disable_animation = true
+
+ # Click offsets is calculated from top left of element
+ Capybara.w3c_click_offset = false
+
+ Capybara.configure do |capybara_config|
+ capybara_config.server_host = ENV["CAPYBARA_SERVER_HOST"].presence || "localhost"
+
+ capybara_config.server_port =
+ (ENV["CAPYBARA_SERVER_PORT"].presence || "31_337").to_i + ENV["TEST_ENV_NUMBER"].to_i
+ end
+ end
+end
diff --git a/spec/support/system/ember_deprecations.rb b/spec/support/system/ember_deprecations.rb
new file mode 100644
index 00000000000..72ae24afc17
--- /dev/null
+++ b/spec/support/system/ember_deprecations.rb
@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# JS deprecation enforcement for system specs: opt core/preinstalled
+# plugins/themes into raising on Ember deprecations, surface fatal deprecations,
+# and count non-fatal ones.
+module EmberDeprecations
+ # Raise on Ember deprecations only for code we own (core specs, preinstalled
+ # plugins, preinstalled themes), unless the caller already set the flag.
+ def self.set_raise_on_deprecation!(example)
+ return unless ENV["EMBER_RAISE_ON_DEPRECATION"].nil?
+
+ example_file_path = example.metadata[:rerun_file_path]
+ return if example_file_path.nil?
+
+ match =
+ example_file_path.to_s.match(
+ %r{^#{Regexp.escape(Rails.root.to_s)}/(plugins|themes|spec)/([^/]+)/},
+ )
+ return if match.nil?
+
+ type_dir, extension_name = match.captures
+
+ should_set =
+ case type_dir
+ when "spec"
+ true
+ when "plugins"
+ Discourse.preinstalled_plugins.any? { |p| p.directory_name == extension_name }
+ when "themes"
+ # Preinstalled themes don't have a .git directory
+ !Rails.root.join(type_dir, extension_name, ".git").exist?
+ end
+
+ ENV["EMBER_RAISE_ON_DEPRECATION"] = "1" if should_set
+ end
+
+ # Formatted error for the first fatal JS deprecation in the logs, or nil.
+ def self.fatal_error(logs)
+ logs
+ &.filter_map do |log|
+ if log[:level] == "trace"
+ error = JSON.parse(log[:message][/^fatal_deprecation:(.+)$/, 1])
+ "~~~~~~~ JS ERROR ~~~~~~~\n#{error}\n~~~~~ END JS ERROR ~~~~~"
+ end
+ end
+ &.first
+ end
+
+ # Count non-fatal deprecation_id counts into the example metadata, excluding
+ # any the spec opted into via `expected_js_deprecations`.
+ def self.record_counts(logs, metadata)
+ expected = metadata[:expected_js_deprecations] || []
+
+ logs&.each do |log|
+ next if log[:level] != "count"
+ deprecation_id = log[:message][/^deprecation_id:(.+?):\s*\d+$/, 1]
+ next if deprecation_id.nil?
+ next if expected.include?(deprecation_id)
+
+ deprecations = metadata[:js_deprecations] ||= Hash.new(0)
+ deprecations[deprecation_id] += 1
+ end
+ end
+end
diff --git a/spec/support/system/playwright_logger.rb b/spec/support/system/playwright_logger.rb
new file mode 100644
index 00000000000..196b37f6ea1
--- /dev/null
+++ b/spec/support/system/playwright_logger.rb
@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# Captures browser console messages and page errors during system specs
+# and dumps them into the failure output.
+class PlaywrightLogger
+ attr_reader :logs
+
+ def initialize(page)
+ @logs = []
+
+ page.on(
+ "console",
+ ->(msg) do
+ @logs << {
+ level: msg.type,
+ message: msg.text,
+ timestamp: Time.now.to_i * 1000,
+ source: "console-api",
+ }
+ end,
+ )
+
+ page.on(
+ "pageerror",
+ ->(error) do
+ @logs << {
+ level: "error",
+ message: error.message,
+ timestamp: Time.now.to_i * 1000,
+ source: "pageerror-api",
+ }
+ end,
+ )
+ end
+
+ # Appends the captured console/page-error messages to a failure-output buffer,
+ # skipping image/favicon load noise that's expected in system specs.
+ def append_failure_logs(lines)
+ lines << "~~~~~~~ JS LOGS ~~~~~~~"
+
+ if logs.empty?
+ lines << "(no logs)"
+ else
+ logs.each do |log|
+ if (
+ log[:message].include?("Failed to load resource: net::ERR_CONNECTION_REFUSED") &&
+ (log[:message].include?("uploads") || log[:message].include?("images"))
+ ) || log[:message].include?("favicon.ico")
+ next
+ end
+
+ lines << log[:message]
+ end
+ end
+
+ lines << "~~~~~ END JS LOGS ~~~~~"
+ end
+end
diff --git a/spec/support/test_setup.rb b/spec/support/test_setup.rb
new file mode 100644
index 00000000000..10e954d8599
--- /dev/null
+++ b/spec/support/test_setup.rb
@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# Per-test global-state reset, run before every example and every before_all
+# block. `before_next_spec` queues one-shot cleanups that TestSetup drains here.
+
+module TestSetup
+ # This is run before each test and before each before_all block
+ def self.test_setup(x = nil)
+ # This allows DB.transaction_open? to work in tests. See lib/mini_sql_multisite_connection.rb
+ DB.test_transaction = ActiveRecord::Base.connection.current_transaction
+
+ RateLimiter.disable
+ PostActionNotifier.disable
+ SearchIndexer.disable
+ UserActionManager.disable
+ NotificationEmailer.disable
+ SiteIconManager.disable
+ WordWatcher.disable_cache
+ UpcomingChanges.clear_caches!
+
+ SiteSetting.provider.all.each { |setting| SiteSetting.remove_override!(setting.name) }
+
+ # Set some standard overrides for tests. Some for performance, some to make the tests easier,
+ # and some because their default was changed, and we didn't want to refactor all the relevant specs.
+ {
+ s3_upload_bucket: "bucket",
+ min_post_length: 5,
+ min_first_post_length: 5,
+ min_personal_message_post_length: 10,
+ download_remote_images_to_local: false,
+ unique_posts_mins: 0,
+ max_consecutive_replies: 0,
+ allow_uncategorized_topics: true,
+ }.each { |k, v| SiteSetting.set(k, v) }
+
+ SiteSetting.refresh!(refresh_site_settings: false, refresh_theme_site_settings: true)
+ SiteSetting.refresh_site_setting_group_ids!
+
+ # very expensive IO operations
+ SiteSetting.automatically_download_gravatars = false
+
+ Discourse.clear_readonly!
+ Sidekiq::Worker.clear_all
+
+ I18n.locale = SiteSettings::DefaultsProvider::DEFAULT_LOCALE
+
+ # Database is rolled back between specs, but I18n override cache doesn't.
+ # Flush it if there were any TranslationOverrides created.
+ overrides_by_site = I18n.instance_variable_get(:@overrides_by_site) || {}
+ I18n.reload! if overrides_by_site.values.flat_map(&:values).any?(&:any?)
+
+ RspecErrorTracker.clear_exceptions
+
+ if $test_cleanup_callbacks
+ $test_cleanup_callbacks.reverse_each(&:call)
+ $test_cleanup_callbacks = nil
+ end
+
+ # in test this is very expensive, we explicitly enable when needed
+ Topic.update_featured_topics = false
+
+ # Running jobs are expensive and most of our tests are not concern with
+ # code that runs inside jobs. run_later! means they are put on the redis
+ # queue and never processed.
+ Jobs.run_later!
+
+ # Don't track ApplicationRequests in test mode unless opted in
+ ApplicationRequest.disable
+
+ # Don't queue badge grant in test mode
+ BadgeGranter.disable_queue
+
+ OmniAuth.config.test_mode = false
+
+ Middleware::AnonymousCache.disable_anon_cache
+ BlockRequestsMiddleware.allow_requests!
+ BlockRequestsMiddleware.current_example_location = nil
+ ApplicationSerializer.fragment_cache.clear
+ end
+end
+
+def before_next_spec(&callback)
+ ($test_cleanup_callbacks ||= []) << callback
+end
diff --git a/spec/support/time_helpers.rb b/spec/support/time_helpers.rb
index b0a331fc0b1..9e6e9f09ac8 100644
--- a/spec/support/time_helpers.rb
+++ b/spec/support/time_helpers.rb
@@ -58,8 +58,6 @@ module TimeHelpers
end
end
-RSpec.configure { |config| config.include(TimeHelpers) }
-
module BrowserTime
# Install the clock at the desired time and immediately resume it so
# the browser starts at `time` but `Date.now()` keeps advancing with the