+ + #{id(file)} + +
+ HTML + end + end + ) + end + end + + private_constant(:BaseMiddleware) end end end diff --git a/lib/app_profiler/viewer/middleware/firefox.rb b/lib/app_profiler/viewer/middleware/firefox.rb new file mode 100644 index 00000000..3b2ec9c1 --- /dev/null +++ b/lib/app_profiler/viewer/middleware/firefox.rb @@ -0,0 +1,68 @@ +# frozen_string_literal: true + +require "app_profiler/yarn/command" +require "app_profiler/yarn/with_firefox_profiler" + +module AppProfiler + module Viewer + class FirefoxRemoteViewer < BaseViewer + class Middleware < BaseMiddleware + include Yarn::WithFirefoxProfile + + def initialize(app) + super + @firefox_profiler = Rack::File.new( + File.join(AppProfiler.root, "node_modules/firefox-profiler/dist") + ) + end + + def call(env) + request = Rack::Request.new(env) + @app.call(env) if request.path_info.end_with?(AppProfiler::StackprofProfile::FILE_EXTENSION) + # Firefox profiler *really* doesn't like for /from-url/ to be at any other mount point + # so with this enabled, we take over both /app_profiler and /from-url in the app in development. + return from(env, Regexp.last_match(1)) if request.path_info =~ %r(\A/from-url(.*)\z) + return viewer(env, Regexp.last_match(1)) if request.path_info =~ %r(\A/app_profiler/firefox/viewer/(.*)\z) + return show(env, Regexp.last_match(1)) if request.path_info =~ %r(\A/app_profiler/firefox/(.*)\z) + + super + end + + protected + + attr_reader(:firefox_profiler) + + def viewer(env, path) + setup_yarn unless yarn_setup + + if path.end_with?(AppProfiler::VernierProfile::FILE_EXTENSION) + proto = env["rack.url_scheme"] + host = env["HTTP_HOST"] + source = "#{proto}://#{host}/app_profiler/firefox/#{path}" + + target = "/from-url/#{CGI.escape(source)}" + + [302, { "Location" => target }, []] + else + env[Rack::PATH_INFO] = path.delete_prefix("/app_profiler") + firefox_profiler.call(env) + end + end + + def from(env, path) + setup_yarn unless yarn_setup + index = File.read(File.join(AppProfiler.root, "node_modules/firefox-profiler/dist/index.html")) + [200, { "Content-Type" => "text/html" }, [index]] + end + + def show(_env, name) + profile = profile_files.find do |file| + id(file) == name + end || raise(ArgumentError) + + [200, { "Content-Type" => "application/json" }, [profile.read]] + end + end + end + end +end diff --git a/lib/app_profiler/viewer/middleware/speedscope.rb b/lib/app_profiler/viewer/middleware/speedscope.rb new file mode 100644 index 00000000..cdc19429 --- /dev/null +++ b/lib/app_profiler/viewer/middleware/speedscope.rb @@ -0,0 +1,56 @@ +# frozen_string_literal: true + +require "app_profiler/yarn/command" +require "app_profiler/yarn/with_speedscope" + +module AppProfiler + module Viewer + class SpeedscopeRemoteViewer < BaseViewer + class Middleware < BaseMiddleware + include Yarn::WithSpeedscope + + def initialize(app) + super + @speedscope = Rack::File.new( + File.join(AppProfiler.root, "node_modules/speedscope/dist/release") + ) + end + + def call(env) + request = Rack::Request.new(env) + @app.call(env) if request.path_info.end_with?(AppProfiler::VernierProfile::FILE_EXTENSION) + return viewer(env, Regexp.last_match(1)) if request.path_info =~ %r(\A/app_profiler/speedscope/viewer/(.*)\z) + return show(env, Regexp.last_match(1)) if request.path_info =~ %r(\A/app_profiler/speedscope/(.*)\z) + + super + end + + protected + + attr_reader(:speedscope) + + def viewer(env, path) + setup_yarn unless yarn_setup + + if path.end_with?(AppProfiler::StackprofProfile::FILE_EXTENSION) + source = "/app_profiler/speedscope/#{path}" + target = "/app_profiler/speedscope/viewer/index.html#profileURL=#{CGI.escape(source)}" + + [302, { "Location" => target }, []] + else + env[Rack::PATH_INFO] = path.delete_prefix("/app_profiler/speedscope") + speedscope.call(env) + end + end + + def show(_env, name) + profile = profile_files.find do |file| + id(file) == name + end || raise(ArgumentError) + + [200, { "Content-Type" => "application/json" }, [profile.read]] + end + end + end + end +end diff --git a/lib/app_profiler/viewer/remote/firefox.rb b/lib/app_profiler/viewer/remote/firefox.rb new file mode 100644 index 00000000..2099dd55 --- /dev/null +++ b/lib/app_profiler/viewer/remote/firefox.rb @@ -0,0 +1,33 @@ +# frozen_string_literal: true + +require "app_profiler/viewer/middleware/firefox" + +module AppProfiler + module Viewer + class FirefoxRemoteViewer < BaseViewer + NAME = "firefox" + + class << self + def view(profile, params = {}) + new(profile).view(**params) + end + end + + def initialize(profile) + super() + @profile = profile + end + + def view(response: nil, autoredirect: nil, async: false) + id = Middleware.id(@profile.file) + + if response && response[0].to_i < 500 + response[1]["Location"] = "/app_profiler/#{NAME}/viewer/#{id}" + response[0] = 303 + else + AppProfiler.logger.info("[Profiler] Profile available at /app_profiler/#{id}\n") + end + end + end + end +end diff --git a/lib/app_profiler/viewer/speedscope_remote_viewer.rb b/lib/app_profiler/viewer/remote/speedscope.rb similarity index 76% rename from lib/app_profiler/viewer/speedscope_remote_viewer.rb rename to lib/app_profiler/viewer/remote/speedscope.rb index ced8bbce..4b72fca5 100644 --- a/lib/app_profiler/viewer/speedscope_remote_viewer.rb +++ b/lib/app_profiler/viewer/remote/speedscope.rb @@ -1,11 +1,12 @@ # frozen_string_literal: true -require "app_profiler/viewer/speedscope_remote_viewer/base_middleware" -require "app_profiler/viewer/speedscope_remote_viewer/middleware" +require "app_profiler/viewer/middleware/speedscope" module AppProfiler module Viewer class SpeedscopeRemoteViewer < BaseViewer + NAME = "speedscope" + class << self def view(profile, params = {}) new(profile).view(**params) @@ -21,7 +22,7 @@ def view(response: nil, autoredirect: nil, async: false) id = Middleware.id(@profile.file) if response && response[0].to_i < 500 - response[1]["Location"] = "/app_profiler/#{id}" + response[1]["Location"] = "/app_profiler/#{NAME}/viewer/#{id}" response[0] = 303 else AppProfiler.logger.info("[Profiler] Profile available at /app_profiler/#{id}\n") diff --git a/lib/app_profiler/viewer/speedscope_viewer.rb b/lib/app_profiler/viewer/speedscope.rb similarity index 100% rename from lib/app_profiler/viewer/speedscope_viewer.rb rename to lib/app_profiler/viewer/speedscope.rb diff --git a/lib/app_profiler/viewer/speedscope_remote_viewer/base_middleware.rb b/lib/app_profiler/viewer/speedscope_remote_viewer/base_middleware.rb deleted file mode 100644 index a6fba235..00000000 --- a/lib/app_profiler/viewer/speedscope_remote_viewer/base_middleware.rb +++ /dev/null @@ -1,102 +0,0 @@ -# frozen_string_literal: true - -gem "rails-html-sanitizer", ">= 1.6.0" -require "rails-html-sanitizer" - -module AppProfiler - module Viewer - class SpeedscopeRemoteViewer < BaseViewer - class BaseMiddleware - class Sanitizer < Rails::HTML::Sanitizer.best_supported_vendor.safe_list_sanitizer - self.allowed_tags = Set.new([ - "strong", "em", "b", "i", "p", "code", "pre", "tt", "samp", "kbd", "var", "sub", - "sup", "dfn", "cite", "big", "small", "address", "hr", "br", "div", "span", "h1", - "h2", "h3", "h4", "h5", "h6", "ul", "ol", "li", "dl", "dt", "dd", "abbr", "acronym", - "a", "img", "blockquote", "del", "ins", "script", - ]) - end - - private_constant(:Sanitizer) - - def self.id(file) - file.basename.to_s.delete_suffix(".json") - end - - def initialize(app) - @app = app - end - - def call(env) - request = Rack::Request.new(env) - - return index(env) if request.path_info =~ %r(\A/app_profiler/?\z) - return viewer(env, Regexp.last_match(1)) if request.path_info =~ %r(\A/app_profiler/viewer/(.*)\z) - return show(env, Regexp.last_match(1)) if request.path_info =~ %r(\A/app_profiler/(.*)\z) - - @app.call(env) - end - - protected - - def id(file) - self.class.id(file) - end - - def profile_files - AppProfiler.profile_root.glob("**/*.json") - end - - def render(html) - [ - 200, - { "Content-Type" => "text/html" }, - [ - +<<~HTML, - - - -- - #{id(file)} - -
- HTML - end - end - ) - end - - def show(env, id) - raise NotImplementedError - end - end - - private_constant(:BaseMiddleware) - end - end -end diff --git a/lib/app_profiler/viewer/speedscope_remote_viewer/middleware.rb b/lib/app_profiler/viewer/speedscope_remote_viewer/middleware.rb deleted file mode 100644 index 516f83b9..00000000 --- a/lib/app_profiler/viewer/speedscope_remote_viewer/middleware.rb +++ /dev/null @@ -1,58 +0,0 @@ -# frozen_string_literal: true - -require "app_profiler/yarn/command" -require "app_profiler/yarn/with_speedscope" - -module AppProfiler - module Viewer - class SpeedscopeRemoteViewer < BaseViewer - class Middleware < BaseMiddleware - include Yarn::WithSpeedscope - - def initialize(app) - super - @speedscope = Rack::File.new( - File.join(AppProfiler.root, "node_modules/speedscope/dist/release") - ) - end - - protected - - attr_reader(:speedscope) - - def viewer(env, path) - setup_yarn unless yarn_setup - env[Rack::PATH_INFO] = path.delete_prefix("/app_profiler") - - speedscope.call(env) - end - - def show(_env, name) - profile = profile_files.find do |file| - id(file) == name - end || raise(ArgumentError) - - render( - <<~HTML - - HTML - ) - end - end - end - end -end diff --git a/lib/app_profiler/yarn/command.rb b/lib/app_profiler/yarn/command.rb index 3866325a..a1800302 100644 --- a/lib/app_profiler/yarn/command.rb +++ b/lib/app_profiler/yarn/command.rb @@ -7,13 +7,16 @@ class YarnError < StandardError; end VALID_COMMANDS = [ ["which", "yarn"], + ["which", "gcloud"], ["yarn", "init", "--yes"], ["yarn", "add", "speedscope", "--dev", "--ignore-workspace-root-check"], ["yarn", "run", "speedscope", /.*\.json/], + ["yarn", "add", "--dev", %r{.*/firefox-profiler}], + ["yarn", "--cwd", %r{.*/firefox-profiler}], + ["yarn", "--cwd", %r{.*/firefox-profiler}, "build-prod"], ] private_constant(:VALID_COMMANDS) - mattr_accessor(:yarn_setup, default: false) def yarn(command, *options) setup_yarn unless yarn_setup @@ -29,6 +32,14 @@ def setup_yarn yarn("init", "--yes") unless package_json_exists? end + def yarn_setup + @yarn_initialized || false + end + + def yarn_setup=(state) + @yarn_initialized = state + end + private def ensure_command_valid(command) @@ -39,6 +50,8 @@ def ensure_command_valid(command) def valid_command?(command) VALID_COMMANDS.any? do |valid_command| + next unless valid_command.size == command.size + valid_command.zip(command).all? do |valid_part, part| part.match?(valid_part) end @@ -55,7 +68,7 @@ def ensure_yarn_installed MSG ) end - self.yarn_setup = true + @yarn_initialized = true end def package_json_exists? diff --git a/lib/app_profiler/yarn/with_firefox_profiler.rb b/lib/app_profiler/yarn/with_firefox_profiler.rb new file mode 100644 index 00000000..f0d5d8ce --- /dev/null +++ b/lib/app_profiler/yarn/with_firefox_profiler.rb @@ -0,0 +1,124 @@ +# frozen_string_literal: true + +require "rubygems/package" +require "zlib" +require "open-uri" + +module AppProfiler + module Yarn + module WithFirefoxProfile + include Command + class CommandError < StandardError; end + + INSTALL_DIRECTORY = "./tmp" + + def setup_yarn + super + return if firefox_profiler_added? + + fetch_firefox_profiler + end + + private + + def firefox_profiler_added? + AppProfiler.root.join("node_modules/firefox-profiler/dist").exist? + end + + def github_source? + AppProfiler.gecko_viewer_package.start_with?("https://github.com") + end + + def compiled_source? + AppProfiler.gecko_viewer_package.start_with?("https://") && + AppProfiler.gecko_viewer_package.end_with?("_compiled.tar.gz") + end + + def append_auth_header(opts) + if AppProfiler.gecko_viewer_package.start_with?("https://storage.googleapis.com/") + exec("which", "gcloud", silent: true) do + raise( + CommandError, + <<~MSG.squish + `gcloud` command not found, but gcloud auth required. + Please install `gcloud` or make it available in PATH. + MSG + ) + end + + opts["Authorization"] = "Bearer " + %x(gcloud auth print-access-token) + end + end + + def fetch_firefox_profiler + dir = INSTALL_DIRECTORY + + if github_source? + fetch_from_github(dir) + elsif compiled_source? + fetch_pre_compiled("#{dir}/firefox-profiler") + else + raise ArgumentError, "#{AppProfiler.gecko_viewer_package} is not a valid source for firefox profiler" + end + + yarn("add", "--dev", "#{dir}/firefox-profiler") + end + + def fetch_pre_compiled(dir) + opts = {} + append_auth_header(opts) + tar_gz_file = URI.parse(AppProfiler.gecko_viewer_package).open(opts) + + Gem::Package::TarReader.new(Zlib::GzipReader.open(tar_gz_file)) do |tar| + tar.each do |entry| + next if entry.directory? + + target_file = File.join(dir, entry.full_name) + + FileUtils.mkdir_p(File.dirname(target_file)) + + File.open(target_file, "wb") do |f| + f.write(entry.read) + end + end + end + end + + def fetch_from_github(dir) + repo, branch = AppProfiler.gecko_viewer_package.to_s.split("#") + + FileUtils.mkdir_p(dir) + Dir.chdir(dir) do + clone_args = ["git", "clone", repo, "firefox-profiler"] + clone_args.push("--branch=#{branch}") unless branch.nil? || branch&.empty? + system(*clone_args) + package_contents = File.read("firefox-profiler/package.json") + package_json = JSON.parse(package_contents) + package_json["name"] ||= "firefox-profiler" + package_json["version"] ||= "0.0.1" + File.write("firefox-profiler/package.json", package_json.to_json) + end + yarn("--cwd", "#{dir}/firefox-profiler") + + patch_firefox_profiler(dir) + yarn("--cwd", "#{dir}/firefox-profiler", "build-prod") + patch_file("#{dir}/firefox-profiler/dist/index.html", 'href="locales/en-US/app.ftl"', + 'href="/app_profiler/firefox/viewer/locales/en-US/app.ftl"') + end + + def patch_firefox_profiler(dir) + # Patch the publicPath so that the app can be "mounted" at the right location + patch_file("#{dir}/firefox-profiler/webpack.config.js", "publicPath: '/'", + "publicPath: '/app_profiler/firefox/viewer/'") + patch_file("#{dir}/firefox-profiler/src/app-logic/l10n.js", "fetch(`/locales/", + "fetch(`/app_profiler/firefox/viewer/locales/") + end + + def patch_file(file, find, replace) + contents = File.read(file) + new_contents = contents.gsub(find, replace) + File.write(file, new_contents) + end + end + end +end diff --git a/lib/tasks/firefox_profiler_compile.rake b/lib/tasks/firefox_profiler_compile.rake new file mode 100644 index 00000000..6a9b20fb --- /dev/null +++ b/lib/tasks/firefox_profiler_compile.rake @@ -0,0 +1,87 @@ +# frozen_string_literal: true + +require "rubygems/package" +require "zlib" +require "fileutils" + +require "app_profiler" +require "app_profiler/yarn/command" +require "app_profiler/yarn/with_firefox_profiler" + +# The bundle is already compiled, so we can ignore most of the source contents +PACKAGE_INCLUDE = [ + /^package\.json$/, + /^dist/, +].freeze + +# Hack to make the package.json more portable by removing some constraints +# contains arrays of diggable hash keys +DELETE_KEYS = [ + ["engines"], + ["scripts", "preinstall"], +] + +class CompileShim + include AppProfiler::Yarn::WithFirefoxProfile +end + +namespace :firefox_profiler do + desc "Compile firefox profiler" + task :compile do + AppProfiler.root = Pathname.getwd + CompileShim.new.setup_yarn + end + desc "Package firefox profiler" + task package: :compile do + package_directory("node_modules/firefox-profiler", "out.tar.gz") + end +end + +def package_directory(source_dir, output) + File.open(output, "wb") do |tar_gz_file| + Zlib::GzipWriter.wrap(tar_gz_file) do |gzip_file| + Dir.chdir(source_dir) do + Gem::Package::TarWriter.new(gzip_file) do |tar| + Dir["**/*", ".*/**/*"].each do |file| + next unless PACKAGE_INCLUDE.any? { |pattern| file =~ pattern } + + mode = File.stat(file).mode + + if File.directory?(file) + tar.mkdir(file, mode) + else + fp = File.open(file, "rb") + fp = prune_keys(fp) if file == "package.json" + tar.add_file_simple(file, mode, fp.size) do |tar_file| + IO.copy_stream(fp, tar_file) + end + fp.close + end + end + end + end + end + end +end + +def prune_keys(orig_fp) + package_contents = JSON.parse(orig_fp.read) + orig_fp.close + DELETE_KEYS.each do |keys| + next unless package_contents.dig(*keys) + + to_delete = keys.pop + if keys.empty? + package_contents.delete(to_delete) + else + nested_hash = package_contents.dig(*keys) + nested_hash.delete(to_delete) + end + end + tmp = Tempfile.new("relaxed_package.json") + tmp.unlink + tmp.write(JSON.dump(package_contents)) + tmp.flush + tmp.rewind + tmp +end diff --git a/test/app_profiler/backend/stackprof_backend_test.rb b/test/app_profiler/backend/stackprof_backend_test.rb new file mode 100644 index 00000000..605161fa --- /dev/null +++ b/test/app_profiler/backend/stackprof_backend_test.rb @@ -0,0 +1,193 @@ +# frozen_string_literal: true + +require "test_helper" + +module AppProfiler + class StackprofBackendTest < TestCase + def setup + AppProfiler.backend = AppProfiler::StackprofBackend + end + + def teardown + AppProfiler.clear + end + + test ".run prints error when failed" do + AppProfiler.logger.expects(:info).with { |value| value =~ /failed to start the profiler/ } + profile = AppProfiler.run(mode: :unsupported) do + sleep(0.1) + end + + assert_nil(profile) + end + + test ".run raises when yield raises" do + error = StandardError.new("An error occurred.") + exception = assert_raises(StandardError) do + AppProfiler.profiler.run(stackprof_profile) do + assert_predicate(AppProfiler.profiler, :running?) + raise error + end + end + + assert_equal(error, exception) + assert_not_predicate(AppProfiler.profiler, :running?) + end + + test ".run does not stop the profiler when it is already running" do + AppProfiler.logger.expects(:info).never + + assert_equal(true, AppProfiler.profiler.send(:start, stackprof_profile)) + + profile = AppProfiler.profiler.run(stackprof_profile) do + sleep(0.1) + end + + assert_nil(profile) + assert_predicate(AppProfiler.profiler, :running?) + ensure + AppProfiler.profiler.stop + end + + test ".run uses cpu profile by default" do + profile = AppProfiler.profiler.run(stackprof_profile) do + sleep(0.1) + end + + assert_instance_of(AppProfiler::StackprofProfile, profile) + assert_equal(:cpu, profile[:mode]) + assert_equal(1000, profile[:interval]) + end + + test ".run assigns metadata to profiles" do + profile = AppProfiler.profiler.run(stackprof_profile(metadata: { id: "wowza", context: "bar" })) do + sleep(0.1) + end + + assert_instance_of(AppProfiler::StackprofProfile, profile) + assert_equal("wowza", profile.id) + assert_equal("bar", profile.context) + end + + test ".run cpu profile" do + profile = AppProfiler.profiler.run(stackprof_profile(mode: :cpu, interval: 2000)) do + sleep(0.1) + end + + assert_instance_of(AppProfiler::StackprofProfile, profile) + assert_equal(:cpu, profile[:mode]) + assert_equal(2000, profile[:interval]) + end + + test ".run wall profile" do + profile = AppProfiler.profiler.run(stackprof_profile(mode: :wall, interval: 2000)) do + sleep(0.1) + end + + assert_instance_of(AppProfiler::StackprofProfile, profile) + assert_equal(:wall, profile[:mode]) + assert_equal(2000, profile[:interval]) + end + + test ".run object profile" do + profile = AppProfiler.profiler.run(stackprof_profile(mode: :object, interval: 2)) do + sleep(0.1) + end + + assert_instance_of(AppProfiler::StackprofProfile, profile) + assert_equal(:object, profile[:mode]) + assert_equal(2, profile[:interval]) + end + + test ".start uses cpu profile by default" do + AppProfiler.profiler.start(stackprof_profile) + AppProfiler.profiler.stop + + profile = AppProfiler.profiler.results + + assert_instance_of(AppProfiler::StackprofProfile, profile) + assert_equal(:cpu, profile[:mode]) + assert_equal(1000, profile[:interval]) + end + + test ".start assigns metadata to profiles" do + AppProfiler.profiler.start(stackprof_profile(metadata: { id: "wowza", context: "bar" })) + AppProfiler.profiler.stop + + profile = AppProfiler.profiler.results + + assert_instance_of(AppProfiler::StackprofProfile, profile) + assert_equal("wowza", profile.id) + assert_equal("bar", profile.context) + end + + test ".start cpu profile" do + AppProfiler.profiler.start(stackprof_profile(mode: :cpu, interval: 2000)) + AppProfiler.profiler.stop + + profile = AppProfiler.profiler.results + + assert_instance_of(AppProfiler::StackprofProfile, profile) + assert_equal(:cpu, profile[:mode]) + assert_equal(2000, profile[:interval]) + end + + test ".start wall profile" do + AppProfiler.profiler.start(stackprof_profile(mode: :wall, interval: 2000)) + AppProfiler.profiler.stop + + profile = AppProfiler.profiler.results + + assert_instance_of(AppProfiler::StackprofProfile, profile) + assert_equal(:wall, profile[:mode]) + assert_equal(2000, profile[:interval]) + end + + test ".start object profile" do + AppProfiler.profiler.start(stackprof_profile(mode: :object, interval: 2)) + AppProfiler.profiler.stop + + profile = AppProfiler.profiler.results + + assert_instance_of(AppProfiler::StackprofProfile, profile) + assert_equal(:object, profile[:mode]) + assert_equal(2, profile[:interval]) + end + + test ".stop" do + StackProf.expects(:stop) + AppProfiler.stop + end + + test ".results prints error when failed" do + AppProfiler.profiler.expects(:backend_results).returns({}) + AppProfiler.logger.expects(:info).with { |value| value =~ /failed to obtain the profile/ } + + assert_nil(AppProfiler.profiler.results) + end + + test ".results returns nil when profiling is still active" do + AppProfiler.profiler.run(stackprof_profile) do + assert_nil(AppProfiler.profiler.results) + end + end + + test ".start, .stop, and .results interact well" do + AppProfiler.logger.expects(:info).never + + assert_equal(true, AppProfiler.profiler.start(stackprof_profile)) + assert_equal(false, AppProfiler.profiler.start(stackprof_profile)) + assert_equal(true, AppProfiler.profiler.send(:running?)) + assert_nil(AppProfiler.profiler.results) + assert_equal(true, AppProfiler.profiler.stop) + assert_equal(false, AppProfiler.profiler.stop) + assert_equal(false, AppProfiler.profiler.send(:running?)) + + profile = AppProfiler.profiler.results + assert_instance_of(AppProfiler::StackprofProfile, profile) + assert_predicate(profile, :valid?) + + assert_nil(AppProfiler.profiler.results) + end + end +end diff --git a/test/app_profiler/backend/vernier_backend_test.rb b/test/app_profiler/backend/vernier_backend_test.rb new file mode 100644 index 00000000..6f81f79f --- /dev/null +++ b/test/app_profiler/backend/vernier_backend_test.rb @@ -0,0 +1,206 @@ +# frozen_string_literal: true + +require "test_helper" + +return unless defined?(AppProfiler::VernierBackend::NAME) + +module AppProfiler + class VernierBackendTest < TestCase + def setup + AppProfiler.clear + @orig_backend = AppProfiler.backend + AppProfiler.backend = AppProfiler::VernierBackend + end + + def teardown + AppProfiler.backend = @orig_backend + AppProfiler.clear + end + + test ".run prints error when failed" do + AppProfiler.logger.expects(:info).with { |value| value =~ /failed to start the profiler/ } + profile = AppProfiler.profiler.run(mode: :unsupported) do + sleep(0.1) + end + + assert_nil(profile) + end + + test ".run raises when yield raises" do + error = StandardError.new("An error occurred.") + exception = assert_raises(StandardError) do + AppProfiler.profiler.run(vernier_params) do + assert_predicate(AppProfiler.profiler, :running?) + raise error + end + end + + assert_equal(error, exception) + assert_not_predicate(AppProfiler.profiler, :running?) + end + + test ".run does not stop the profiler when it is already running" do + AppProfiler.logger.expects(:info).never + + assert_equal(true, AppProfiler.profiler.send(:start, vernier_params)) + + profile = AppProfiler.profiler.run(vernier_params) do + sleep(0.1) + end + + assert_nil(profile) + assert_predicate(AppProfiler.profiler, :running?) + ensure + AppProfiler.profiler.stop + end + + test ".run uses wall profile by default" do + profile = AppProfiler.profiler.run do + sleep(0.1) + end + + assert_instance_of(AppProfiler::VernierProfile, profile) + assert_equal(:wall, profile[:meta][:mode]) + # assert_equal(1000, profile[:interval]) # TODO https://github.com/jhawthorn/vernier/issues/30 + end + + test ".run assigns metadata to profiles" do + profile = AppProfiler.profiler.run( + vernier_params(metadata: { + id: "wowza", + context: "bar", + extrameta: "spam", + }) + ) do + sleep(0.1) + end + + assert_instance_of(AppProfiler::VernierProfile, profile) + assert_equal("wowza", profile.id) + assert_equal("bar", profile.context) + assert_equal("spam", profile[:meta][:extrameta]) + end + + test ".run wall profile" do + profile = AppProfiler.profiler.run(vernier_params(mode: :wall, interval: 2000)) do + sleep(0.1) + end + + assert_instance_of(AppProfiler::VernierProfile, profile) + assert_equal(:wall, profile[:meta][:mode]) + # assert_equal(2000, profile[:interval]) # TODO as above + end + + test ".run retained profile" do + retained = [] + objects = 10 + profile = AppProfiler.profiler.run(vernier_params(mode: :retained)) do + objects.times do + retained << Object.new + end + end + + assert_instance_of(AppProfiler::VernierProfile, profile) + assert_equal(:retained, profile[:meta][:mode]) + + num_samples = profile[:threads].flat_map { _1[:samples] }.sum { |s| s[:length] } + assert_operator(num_samples, :>=, objects) + end + + test ".run works for supported modes" do + profile = AppProfiler.profiler.run(vernier_params(mode: :wall)) do + sleep(0.1) + end + refute_equal(false, profile) + + profile = AppProfiler.profiler.run(vernier_params(mode: :retained)) do + sleep(0.1) + end + refute_equal(false, profile) + end + + test ".run fails for unsupported modes" do + unsupported_modes = [:cpu, :object, :garbage, :unsupported] + + unsupported_modes.each do |unsupported| + profile = AppProfiler.profiler.run(vernier_params(mode: unsupported)) do + sleep(0.1) + end + assert_nil(profile) + end + end + + test ".start uses wall profile by default" do + AppProfiler.profiler.start + AppProfiler.profiler.stop + + profile = AppProfiler.profiler.results + + assert_instance_of(AppProfiler::VernierProfile, profile) + assert_equal(:wall, profile[:meta][:mode]) + # assert_equal(1000, profile[:interval]) + end + + test ".start assigns metadata to profiles" do + AppProfiler.profiler.start(vernier_params(metadata: { id: "wowza", context: "bar" })) + AppProfiler.profiler.stop + + profile = AppProfiler.profiler.results + + assert_instance_of(AppProfiler::VernierProfile, profile) + assert_equal("wowza", profile.id) + assert_equal("bar", profile.context) + end + + test ".start wall profile" do + AppProfiler.profiler.start(vernier_params(mode: :wall, interval: 2000)) + AppProfiler.profiler.stop + + profile = AppProfiler.profiler.results + + assert_instance_of(AppProfiler::VernierProfile, profile) + assert_equal(:wall, profile[:meta][:mode]) + # assert_equal(2000, profile[:interval]) + end + + test ".stop" do + AppProfiler.start + AppProfiler::VernierBackend.any_instance.expects(:stop) + AppProfiler.stop + ensure + AppProfiler::VernierBackend.any_instance.unstub(:stop) + AppProfiler.stop + end + + test ".results prints error when failed" do + AppProfiler.profiler.expects(:backend_results).returns({}) + AppProfiler.logger.expects(:info).with { |value| value =~ /failed to obtain the profile/ } + + assert_nil(AppProfiler.profiler.results) + end + + test ".results returns nil when profiling is still active" do + AppProfiler.profiler.run do + assert_nil(AppProfiler.profiler.results) + end + end + + test ".start, .stop, and .results interact well" do + AppProfiler.logger.expects(:info).never + + assert_equal(true, AppProfiler.profiler.start) + assert_equal(false, AppProfiler.profiler.start) + assert_equal(true, AppProfiler.profiler.send(:running?)) + assert_nil(AppProfiler.profiler.results) + assert_equal(true, AppProfiler.profiler.stop) + assert_equal(false, AppProfiler.profiler.stop) + assert_equal(false, AppProfiler.profiler.send(:running?)) + + profile = AppProfiler.profiler.results + assert_instance_of(AppProfiler::VernierProfile, profile) + assert_predicate(profile, :valid?) + + assert_nil(AppProfiler.profiler.results) + end + end +end diff --git a/test/app_profiler/backend_test.rb b/test/app_profiler/backend_test.rb new file mode 100644 index 00000000..02f11d6f --- /dev/null +++ b/test/app_profiler/backend_test.rb @@ -0,0 +1,67 @@ +# frozen_string_literal: true + +require "test_helper" + +module AppProfiler + class BackendTest < TestCase + test ".backend= fails to update the backend if already profiling" do + skip("Vernier not supported") unless defined?(AppProfiler::VernierBackend::NAME) + assert(AppProfiler.backend = AppProfiler::StackprofBackend) + AppProfiler.start + assert(AppProfiler.running?) + assert_raises(BackendError) { AppProfiler.backend = AppProfiler::VernierBackend } + ensure + AppProfiler.stop + end + + test ".backend= updates the backend if not already profiling" do + orig_backend = AppProfiler.backend + skip("Vernier not supported") unless defined?(AppProfiler::VernierBackend::NAME) + refute(AppProfiler.running?) + assert(AppProfiler.backend = AppProfiler::StackprofBackend) + assert_equal(AppProfiler.backend, AppProfiler::StackprofBackend) + refute(AppProfiler.running?) + assert(AppProfiler.backend = AppProfiler::VernierBackend) + assert_equal(AppProfiler.backend, AppProfiler::VernierBackend) + ensure + AppProfiler.backend = orig_backend + end + + test ".backend= accepts a string with the backend name" do + orig_backend = AppProfiler.backend + skip("Vernier not supported") unless defined?(AppProfiler::VernierBackend::NAME) + refute(AppProfiler.running?) + assert(AppProfiler.backend = AppProfiler::StackprofBackend::NAME) + assert_equal(AppProfiler.backend, AppProfiler::StackprofBackend) + refute(AppProfiler.running?) + assert(AppProfiler.backend = AppProfiler::VernierBackend::NAME) + assert_equal(AppProfiler.backend, AppProfiler::VernierBackend) + ensure + AppProfiler.backend = orig_backend + end + + test ".backend= accepts a backend class" do + orig_backend = AppProfiler.backend + skip("Vernier not supported") unless defined?(AppProfiler::VernierBackend::NAME) + refute(AppProfiler.running?) + assert(AppProfiler.backend = AppProfiler::StackprofBackend) + assert_equal(AppProfiler.backend, AppProfiler::StackprofBackend) + refute(AppProfiler.running?) + assert(AppProfiler.backend = AppProfiler::VernierBackend) + assert_equal(AppProfiler.backend, AppProfiler::VernierBackend) + ensure + AppProfiler.backend = orig_backend + end + + test ".backend_for= provides the backend class given a string" do + assert_equal(AppProfiler::StackprofBackend, AppProfiler.backend_for(AppProfiler::StackprofBackend::NAME)) + return unless defined?(AppProfiler::VernierBackend::NAME) + + assert_equal(AppProfiler::VernierBackend, AppProfiler.backend_for(AppProfiler::VernierBackend::NAME)) + end + + test ".backend_for= raises if an unknown backend is requested" do + assert_raises(BackendError) { AppProfiler.backend_for("not a real backend") } + end + end +end diff --git a/test/app_profiler/middleware/upload_action_test.rb b/test/app_profiler/middleware/upload_action_test.rb index f17f7953..003bf36b 100644 --- a/test/app_profiler/middleware/upload_action_test.rb +++ b/test/app_profiler/middleware/upload_action_test.rb @@ -6,12 +6,12 @@ module AppProfiler class Middleware class UploadActionTest < AppProfiler::TestCase setup do - @profile = Profile.new(stackprof_profile) + @profile = StackprofProfile.new(stackprof_profile) @response = [200, {}, ["OK"]] end test ".cleanup" do - Profiler.expects(:results).returns(@profile) + AppProfiler.profiler.expects(:results).returns(@profile) assert_nothing_raised do UploadAction.cleanup end diff --git a/test/app_profiler/middleware/view_action_test.rb b/test/app_profiler/middleware/view_action_test.rb index ed9fc984..4460af3d 100644 --- a/test/app_profiler/middleware/view_action_test.rb +++ b/test/app_profiler/middleware/view_action_test.rb @@ -6,12 +6,12 @@ module AppProfiler class Middleware class ViewActionTest < AppProfiler::TestCase setup do - @profile = Profile.new(stackprof_profile) + @profile = StackprofProfile.new(stackprof_profile) @response = [200, {}, ["OK"]] end test ".cleanup" do - Profiler.expects(:results).returns(@profile) + AppProfiler.profiler.expects(:results).returns(@profile) @profile.expects(:view) ViewAction.cleanup diff --git a/test/app_profiler/middleware_test.rb b/test/app_profiler/middleware_test.rb index c5a80301..cc25457c 100644 --- a/test/app_profiler/middleware_test.rb +++ b/test/app_profiler/middleware_test.rb @@ -20,8 +20,8 @@ class MiddlewareTest < TestCase end end - AppProfiler::Parameters::MODES.each do |mode| - test "profile mode #{mode} is supported" do + AppProfiler::StackprofBackend::AVAILABLE_MODES.each do |mode| + test "profile mode #{mode} is supported by stackprof backend" do assert_profiles_dumped do assert_profiles_uploaded do middleware = AppProfiler::Middleware.new(app_env) @@ -31,6 +31,43 @@ class MiddlewareTest < TestCase end end + if defined?(AppProfiler::VernierBackend::NAME) + AppProfiler::VernierBackend::AVAILABLE_MODES.each do |mode| + test "profile mode #{mode} is supported by vernier backend" do + assert_profiles_dumped do + assert_profiles_uploaded do + middleware = AppProfiler::Middleware.new(app_env) + middleware.call(mock_request_env(path: "/?profile=#{mode}&backend=vernier")) + end + end + end + end + end + + if defined?(AppProfiler::VernierBackend::NAME) + test "the backend can be toggled between requests" do + assert_profiles_dumped(3) do + assert_profiles_uploaded do + middleware = AppProfiler::Middleware.new(app_env) + middleware.call(mock_request_env(path: "/?profile=wall&backend=stackprof")) + end + + assert_profiles_uploaded do + middleware = AppProfiler::Middleware.new(app_env) + middleware.call(mock_request_env(path: "/?profile=wall&backend=vernier")) + end + + assert_profiles_uploaded do + middleware = AppProfiler::Middleware.new(app_env) + middleware.call(mock_request_env(path: "/?profile=wall&backend=stackprof")) + end + + assert_equal(2, tmp_profiles.count { |p| p.to_s =~ /#{AppProfiler::StackprofProfile::FILE_EXTENSION}$/ }) + assert_equal(1, tmp_profiles.count { |p| p.to_s =~ /#{AppProfiler::VernierProfile::FILE_EXTENSION}$/ }) + end + end + end + test "profile interval is supported" do assert_profiles_dumped do assert_profiles_uploaded do @@ -145,7 +182,7 @@ class MiddlewareTest < TestCase end end - AppProfiler::Parameters::MODES.each do |mode| + AppProfiler::StackprofBackend::AVAILABLE_MODES.each do |mode| test "profile mode #{mode} through headers is supported" do assert_profiles_dumped do assert_profiles_uploaded do @@ -157,6 +194,20 @@ class MiddlewareTest < TestCase end end + if defined?(AppProfiler::VernierBackend::NAME) + AppProfiler::VernierBackend::AVAILABLE_MODES.each do |mode| + test "profile mode #{mode} is supported through headers by vernier backend" do + assert_profiles_dumped do + assert_profiles_uploaded do + middleware = AppProfiler::Middleware.new(app_env) + opt = { AppProfiler.request_profile_header => "mode=#{mode};backend=vernier" } + middleware.call(mock_request_env(opt: opt)) + end + end + end + end + end + test "profile interval through headers is supported" do assert_profiles_dumped do assert_profiles_uploaded do @@ -259,7 +310,7 @@ class MiddlewareTest < TestCase test "#after_profile called with env and profile data" do request_env = mock_request_env(path: "/?profile=cpu") AppProfiler.middleware.any_instance.expects(:after_profile).with do |env, profile| - request_env == env && profile.is_a?(AppProfiler::Profile) + request_env == env && profile.is_a?(AppProfiler::AbstractProfile) end.returns(false) middleware = AppProfiler::Middleware.new(app_env) middleware.call(request_env) @@ -278,7 +329,7 @@ class MiddlewareTest < TestCase end.returns(true) AppProfiler.middleware.any_instance.expects(:after_profile).with do |env, profile| - return false unless request_env == env && profile.is_a?(AppProfiler::Profile) + return false unless request_env == env && profile.is_a?(AppProfiler::AbstractProfile) profile[:metadata][:test_key] == "test_value" end.returns(true) diff --git a/test/app_profiler/profile_test.rb b/test/app_profiler/profile/stackprof_test.rb similarity index 68% rename from test/app_profiler/profile_test.rb rename to test/app_profiler/profile/stackprof_test.rb index d66f34e6..264d91fa 100644 --- a/test/app_profiler/profile_test.rb +++ b/test/app_profiler/profile/stackprof_test.rb @@ -3,17 +3,17 @@ require "test_helper" module AppProfiler - class ProfileTest < TestCase + class StackprofProfileTest < TestCase test ".from_stackprof raises ArgumentError when mode is not present" do error = assert_raises(ArgumentError) do profile_without_mode = stackprof_profile.tap { |data| data.delete(:mode) } - Profile.from_stackprof(profile_without_mode) + AbstractProfile.from_stackprof(profile_without_mode) end assert_equal("invalid profile data", error.message) end test ".from_stackprof assigns id and context metadata" do - profile = Profile.from_stackprof(stackprof_profile(metadata: { id: "foo", context: "bar" })) + profile = AbstractProfile.from_stackprof(stackprof_profile(metadata: { id: "foo", context: "bar" })) assert_equal("foo", profile.id) assert_equal("bar", profile.context) @@ -23,20 +23,20 @@ class ProfileTest < TestCase SecureRandom.expects(:hex).returns("mock") params_without_id = stackprof_profile.tap { |data| data[:metadata].delete(:id) } - profile = Profile.from_stackprof(params_without_id) + profile = AbstractProfile.from_stackprof(params_without_id) assert_equal("mock", profile.id) end test ".from_stackprof removes id and context metadata from profile data" do - profile = Profile.from_stackprof(stackprof_profile(metadata: { id: "foo", context: "bar" })) + profile = AbstractProfile.from_stackprof(stackprof_profile(metadata: { id: "foo", context: "bar" })) assert_not_operator(profile[:metadata], :key?, :id) assert_not_operator(profile[:metadata], :key?, :context) end test "#id" do - profile = Profile.new(stackprof_profile, id: "pass") + profile = StackprofProfile.new(stackprof_profile, id: "pass") assert_equal("pass", profile.id) end @@ -44,7 +44,7 @@ class ProfileTest < TestCase test "#id is random hex by default" do SecureRandom.expects(:hex).returns("mock") - profile = Profile.new(stackprof_profile) + profile = StackprofProfile.new(stackprof_profile) assert_equal("mock", profile.id) end @@ -52,46 +52,45 @@ class ProfileTest < TestCase test "#id is random hex when passed as empty string" do SecureRandom.expects(:hex).returns("mock") - profile = Profile.new(stackprof_profile, id: "") + profile = StackprofProfile.new(stackprof_profile, id: "") assert_equal("mock", profile.id) end test "#context" do - profile = Profile.new(stackprof_profile, context: "development") + profile = StackprofProfile.new(stackprof_profile, context: "development") assert_equal("development", profile.context) end test "#valid? is false when mode is not present" do - profile = Profile.new({}) + profile = StackprofProfile.new({}) assert_not_predicate(profile, :valid?) end test "#valid? is true when mode is present" do - profile = Profile.new({ mode: :cpu }) + profile = StackprofProfile.new({ mode: :cpu }) assert_predicate(profile, :valid?) end test "#mode" do - profile = Profile.new(stackprof_profile(mode: "object")) + profile = StackprofProfile.new(stackprof_profile(mode: "object")) assert_equal("object", profile.mode) end test "#view" do - profile = Profile.new(stackprof_profile) + profile = StackprofProfile.new(stackprof_profile) - AppProfiler.stubs(:viewer).returns(Viewer::SpeedscopeViewer) Viewer::SpeedscopeViewer.expects(:view).with(profile) profile.view end test "#upload" do - profile = Profile.new(stackprof_profile) + profile = StackprofProfile.new(stackprof_profile) AppProfiler.stubs(:storage).returns(MockStorage) MockStorage.expects(:upload).with(profile).returns("some data") @@ -100,7 +99,7 @@ class ProfileTest < TestCase end test "#upload returns nil if an error was raised" do - profile = Profile.new(stackprof_profile) + profile = StackprofProfile.new(stackprof_profile) AppProfiler.storage.stubs(:upload).raises(StandardError, "upload error") @@ -109,14 +108,14 @@ class ProfileTest < TestCase test "#file creates json file" do profile_data = stackprof_profile(mode: "wall") - profile = Profile.new(profile_data) + profile = StackprofProfile.new(profile_data) assert_match(/.*\.json/, profile.file.to_s) assert_equal(profile_data, JSON.parse(profile.file.read, symbolize_names: true)) end test "#file creates file only once" do - profile = Profile.new(stackprof_profile) + profile = StackprofProfile.new(stackprof_profile) assert_predicate(profile.file, :exist?) @@ -125,28 +124,21 @@ class ProfileTest < TestCase assert_not_predicate(profile.file, :exist?) end - test "#to_h returns profile data" do - profile_data = stackprof_profile - profile = Profile.new(profile_data) - - assert_equal(profile_data, profile.to_h) - end - test "#[] forwards to profile data" do - profile = Profile.new(stackprof_profile(interval: 10_000)) + profile = StackprofProfile.new(stackprof_profile(interval: 10_000)) assert_equal(10_000, profile[:interval]) end test "#path raises an UnsafeFilename exception given chars not in allow list" do - assert_raises(AppProfiler::Profile::UnsafeFilename) do - profile = Profile.from_stackprof(stackprof_profile(metadata: { id: "|`@${}", context: "bar" })) + assert_raises(AppProfiler::AbstractProfile::UnsafeFilename) do + profile = AbstractProfile.from_stackprof(stackprof_profile(metadata: { id: "|`@${}", context: "bar" })) profile.file end end test "#file uses custom profile_file_prefix block when provided" do - profile = Profile.new(stackprof_profile) + profile = StackprofProfile.new(stackprof_profile) AppProfiler.stubs(:profile_file_prefix).returns(-> { "want-something-different" }) assert_match(/want-something-different-/, File.basename(profile.file.to_s)) @@ -154,7 +146,7 @@ class ProfileTest < TestCase test "#file uses default prefix format when no custom profile_file_prefix block is provided" do travel_to Time.zone.local(2022, 10, 06, 12, 11, 10) do - profile = Profile.new(stackprof_profile) + profile = StackprofProfile.new(stackprof_profile) assert_match(/^20221006-121110/, File.basename(profile.file.to_s)) end end diff --git a/test/app_profiler/profile/vernier_test.rb b/test/app_profiler/profile/vernier_test.rb new file mode 100644 index 00000000..8b5d9242 --- /dev/null +++ b/test/app_profiler/profile/vernier_test.rb @@ -0,0 +1,132 @@ +# frozen_string_literal: true + +require "test_helper" + +module AppProfiler + class VernierProfileTest < TestCase + test ".from_vernier assigns id and context metadata" do + profile = AbstractProfile.from_vernier(vernier_profile(meta: { id: "foo", context: "bar" })) + + assert_equal("foo", profile.id) + assert_equal("bar", profile.context) + end + + test ".from_vernier assigns random id when id is not present" do + SecureRandom.expects(:hex).returns("mock") + + params_without_id = vernier_profile(vernier_params).tap { |data| data[:meta].delete(:id) } + profile = AbstractProfile.from_vernier(params_without_id) + + assert_equal("mock", profile.id) + end + + test "#id" do + profile = VernierProfile.new(vernier_profile, id: "pass") + + assert_equal("pass", profile.id) + end + + test "#id is random hex by default" do + SecureRandom.expects(:hex).returns("mock") + + profile = VernierProfile.new(vernier_profile) + + assert_equal("mock", profile.id) + end + + test "#id is random hex when passed as empty string" do + SecureRandom.expects(:hex).returns("mock") + + profile = VernierProfile.new(vernier_profile, id: "") + + assert_equal("mock", profile.id) + end + + test "#context" do + profile = VernierProfile.new(vernier_profile, context: "development") + + assert_equal("development", profile.context) + end + + test "#valid? is true when mode is present" do + profile = VernierProfile.new(vernier_profile({ mode: :cpu })) + + assert_predicate(profile, :valid?) + end + + test "#mode" do + profile = VernierProfile.new(vernier_profile(meta: { mode: "retained" })) + + assert_equal("retained", profile.mode) + end + + test "#upload" do + profile = VernierProfile.new(vernier_profile) + + AppProfiler.stubs(:storage).returns(MockStorage) + MockStorage.expects(:upload).with(profile).returns("some data") + + assert_equal("some data", profile.upload) + end + + test "#upload returns nil if an error was raised" do + profile = VernierProfile.new(vernier_profile) + + AppProfiler.storage.stubs(:upload).raises(StandardError, "upload error") + + assert_nil(profile.upload) + end + + test "#file creates json file" do + profile_data = vernier_profile(mode: "wall") + profile = VernierProfile.new(profile_data) + + assert_match(/.*\.json/, profile.file.to_s) + assert_equal(profile_data.to_h, JSON.parse(profile.file.read, symbolize_names: true)) + end + + test "#file creates file only once" do + profile = VernierProfile.new(vernier_profile) + + assert_predicate(profile.file, :exist?) + + profile.file.delete + + assert_not_predicate(profile.file, :exist?) + end + + test "#to_h returns profile data" do + profile_data = vernier_profile + profile = VernierProfile.new(profile_data) + + assert_equal(profile_data.to_h, profile.to_h) + end + + test "#[] forwards to profile metadata" do + profile = VernierProfile.new(vernier_profile(meta: { interval: 10_000 })) + + assert_equal(10_000, profile[:meta][:interval]) + end + + test "#path raises an UnsafeFilename exception given chars not in allow list" do + assert_raises(AppProfiler::AbstractProfile::UnsafeFilename) do + profile = AbstractProfile.from_vernier(vernier_profile(meta: { id: "|`@${}", context: "bar" })) + profile.file + end + end + + test "#file uses custom profile_file_prefix block when provided" do + profile = VernierProfile.new(vernier_profile) + + AppProfiler.stubs(:profile_file_prefix).returns(-> { "want-something-different" }) + assert_match(/want-something-different-/, File.basename(profile.file.to_s)) + end + + test "#file uses default prefix format when no custom profile_file_prefix block is provided" do + travel_to Time.zone.local(2022, 10, 06, 12, 11, 10) do + profile = VernierProfile.new(vernier_profile) + assert_match(/^20221006-121110/, File.basename(profile.file.to_s)) + end + end + end +end diff --git a/test/app_profiler/profiler_test.rb b/test/app_profiler/profiler_test.rb deleted file mode 100644 index c902729a..00000000 --- a/test/app_profiler/profiler_test.rb +++ /dev/null @@ -1,185 +0,0 @@ -# frozen_string_literal: true - -require "test_helper" - -module AppProfiler - class ProfilerTest < TestCase - test ".run prints error when failed" do - AppProfiler.logger.expects(:info).with { |value| value =~ /failed to start the profiler/ } - profile = Profiler.run(mode: :unsupported) do - sleep(0.1) - end - - assert_nil(profile) - end - - test ".run raises when yield raises" do - error = StandardError.new("An error occurred.") - exception = assert_raises(StandardError) do - Profiler.run(stackprof_profile) do - assert_predicate(Profiler, :running?) - raise error - end - end - - assert_equal(error, exception) - assert_not_predicate(Profiler, :running?) - end - - test ".run does not stop the profiler when it is already running" do - AppProfiler.logger.expects(:info).never - - assert_equal(true, Profiler.send(:start, stackprof_profile)) - - profile = Profiler.run(stackprof_profile) do - sleep(0.1) - end - - assert_nil(profile) - assert_predicate(Profiler, :running?) - ensure - StackProf.stop - end - - test ".run uses cpu profile by default" do - profile = Profiler.run(stackprof_profile) do - sleep(0.1) - end - - assert_instance_of(AppProfiler::Profile, profile) - assert_equal(:cpu, profile[:mode]) - assert_equal(1000, profile[:interval]) - end - - test ".run assigns metadata to profiles" do - profile = Profiler.run(stackprof_profile(metadata: { id: "wowza", context: "bar" })) do - sleep(0.1) - end - - assert_instance_of(AppProfiler::Profile, profile) - assert_equal("wowza", profile.id) - assert_equal("bar", profile.context) - end - - test ".run cpu profile" do - profile = Profiler.run(stackprof_profile(mode: :cpu, interval: 2000)) do - sleep(0.1) - end - - assert_instance_of(AppProfiler::Profile, profile) - assert_equal(:cpu, profile[:mode]) - assert_equal(2000, profile[:interval]) - end - - test ".run wall profile" do - profile = Profiler.run(stackprof_profile(mode: :wall, interval: 2000)) do - sleep(0.1) - end - - assert_instance_of(AppProfiler::Profile, profile) - assert_equal(:wall, profile[:mode]) - assert_equal(2000, profile[:interval]) - end - - test ".run object profile" do - profile = Profiler.run(stackprof_profile(mode: :object, interval: 2)) do - sleep(0.1) - end - - assert_instance_of(AppProfiler::Profile, profile) - assert_equal(:object, profile[:mode]) - assert_equal(2, profile[:interval]) - end - - test ".start uses cpu profile by default" do - Profiler.start(stackprof_profile) - Profiler.stop - - profile = Profiler.results - - assert_instance_of(AppProfiler::Profile, profile) - assert_equal(:cpu, profile[:mode]) - assert_equal(1000, profile[:interval]) - end - - test ".start assigns metadata to profiles" do - Profiler.start(stackprof_profile(metadata: { id: "wowza", context: "bar" })) - Profiler.stop - - profile = Profiler.results - - assert_instance_of(AppProfiler::Profile, profile) - assert_equal("wowza", profile.id) - assert_equal("bar", profile.context) - end - - test ".start cpu profile" do - Profiler.start(stackprof_profile(mode: :cpu, interval: 2000)) - Profiler.stop - - profile = Profiler.results - - assert_instance_of(AppProfiler::Profile, profile) - assert_equal(:cpu, profile[:mode]) - assert_equal(2000, profile[:interval]) - end - - test ".start wall profile" do - Profiler.start(stackprof_profile(mode: :wall, interval: 2000)) - Profiler.stop - - profile = Profiler.results - - assert_instance_of(AppProfiler::Profile, profile) - assert_equal(:wall, profile[:mode]) - assert_equal(2000, profile[:interval]) - end - - test ".start object profile" do - Profiler.start(stackprof_profile(mode: :object, interval: 2)) - Profiler.stop - - profile = Profiler.results - - assert_instance_of(AppProfiler::Profile, profile) - assert_equal(:object, profile[:mode]) - assert_equal(2, profile[:interval]) - end - - test ".stop" do - StackProf.expects(:stop) - AppProfiler.stop - end - - test ".results prints error when failed" do - Profiler.expects(:stackprof_results).returns({}) - AppProfiler.logger.expects(:info).with { |value| value =~ /failed to obtain the profile/ } - - assert_nil(Profiler.results) - end - - test ".results returns nil when profiling is still active" do - Profiler.run(stackprof_profile) do - assert_nil(Profiler.results) - end - end - - test ".start, .stop, and .results interact well" do - AppProfiler.logger.expects(:info).never - - assert_equal(true, Profiler.start(stackprof_profile)) - assert_equal(false, Profiler.start(stackprof_profile)) - assert_equal(true, Profiler.send(:running?)) - assert_nil(Profiler.results) - assert_equal(true, Profiler.stop) - assert_equal(false, Profiler.stop) - assert_equal(false, Profiler.send(:running?)) - - profile = Profiler.results - assert_instance_of(AppProfiler::Profile, profile) - assert_predicate(profile, :valid?) - - assert_nil(Profiler.results) - end - end -end diff --git a/test/app_profiler/request_parameters_test.rb b/test/app_profiler/request_parameters_test.rb index 544dc2f2..19215305 100644 --- a/test/app_profiler/request_parameters_test.rb +++ b/test/app_profiler/request_parameters_test.rb @@ -19,8 +19,8 @@ class RequestParametersTest < TestCase test "#valid? returns false when interval is less than allowed" do AppProfiler.logger.expects(:info).never - AppProfiler::Parameters::MIN_INTERVALS.each do |mode, interval| - interval -= 1 + AppProfiler::StackprofBackend::AVAILABLE_MODES.each do |mode| + interval = AppProfiler::Parameters::MIN_INTERVALS[mode.to_s] - 1 params = request_params(headers: { AppProfiler.request_profile_header => "mode=#{mode};interval=#{interval}", }) @@ -50,7 +50,8 @@ class RequestParametersTest < TestCase end test "#to_h return correct hash when request parameters are ok" do - AppProfiler::Parameters::DEFAULT_INTERVALS.each do |mode, interval| + AppProfiler::StackprofBackend::AVAILABLE_MODES.each do |mode| + interval = AppProfiler::Parameters::DEFAULT_INTERVALS[mode.to_s] params = request_params(headers: { AppProfiler.request_profile_header => "mode=#{mode};interval=#{interval};context=test;ignore_gc=1", "HTTP_X_REQUEST_ID" => "123", diff --git a/test/app_profiler/run_test.rb b/test/app_profiler/run_test.rb index b0d1a04f..a7a713a4 100644 --- a/test/app_profiler/run_test.rb +++ b/test/app_profiler/run_test.rb @@ -4,16 +4,16 @@ module AppProfiler class RunTest < TestCase - test ".run delegates to Profiler.run" do - Profiler.expects(:run) + test ".run delegates to profiler.run" do + AppProfiler.profiler.expects(:run) AppProfiler.run do sleep 0.1 end end - test ".start delegates to Profiler.start" do - Profiler.expects(:start) + test ".start delegates to profiler.start" do + AppProfiler.profiler.expects(:start) AppProfiler.start end @@ -23,7 +23,21 @@ class RunTest < TestCase sleep 0.1 profile = AppProfiler.stop - assert_instance_of(Profile, profile) + assert_instance_of(StackprofProfile, profile) + end + + test ".run sets the backend then returns to the previous value" do + orig_backend = AppProfiler.backend + skip("Vernier not supported") unless defined?(AppProfiler::VernierBackend::NAME) + + assert_equal(AppProfiler.backend, AppProfiler::StackprofBackend) + refute(AppProfiler.running?) + AppProfiler.run(backend: AppProfiler::VernierBackend) do + assert_equal(AppProfiler::VernierBackend, AppProfiler.backend) + end + assert_equal(AppProfiler.backend, AppProfiler::StackprofBackend) + ensure + AppProfiler.backend = orig_backend end end end diff --git a/test/app_profiler/storage/google_cloud_storage_test.rb b/test/app_profiler/storage/google_cloud_storage_test.rb index 073035cf..76192ae6 100644 --- a/test/app_profiler/storage/google_cloud_storage_test.rb +++ b/test/app_profiler/storage/google_cloud_storage_test.rb @@ -54,7 +54,7 @@ def teardown end test ".process_queue is a no-op when nothing to upload" do - Profile.any_instance.expects(:upload).never + StackprofProfile.any_instance.expects(:upload).never GoogleCloudStorage.send(:process_queue) end @@ -87,7 +87,7 @@ def teardown AppProfiler.upload_queue_max_length.times do GoogleCloudStorage.enqueue_upload(profile_from_stackprof) end - dropped_profile = Profile.from_stackprof(profile_from_stackprof) + dropped_profile = AbstractProfile.from_stackprof(profile_from_stackprof) AppProfiler.logger.expects(:info).with { |value| value =~ /upload queue is full/ } @called = false @@ -124,7 +124,7 @@ def with_stubbed_process_queue_thread end def profile_from_stackprof - Profile.from_stackprof(stackprof_profile(metadata: { id: "bar" })) + AbstractProfile.from_stackprof(stackprof_profile(metadata: { id: "bar" })) end def json_test_file diff --git a/test/app_profiler/viewer/remote/firefox_viewer_test.rb b/test/app_profiler/viewer/remote/firefox_viewer_test.rb new file mode 100644 index 00000000..baf8b1e7 --- /dev/null +++ b/test/app_profiler/viewer/remote/firefox_viewer_test.rb @@ -0,0 +1,42 @@ +# frozen_string_literal: true + +require "test_helper" + +module AppProfiler + module Viewer + class FirefoxRemoteViewerTest < TestCase + test ".view initializes and calls #view" do + FirefoxRemoteViewer.any_instance.expects(:view) + + profile = VernierProfile.new(vernier_profile) + FirefoxRemoteViewer.view(profile) + end + + test "#view logs middleware URL" do + profile = VernierProfile.new(vernier_profile) + + viewer = FirefoxRemoteViewer.new(profile) + id = FirefoxRemoteViewer::Middleware.id(profile.file) + + AppProfiler.logger.expects(:info).with( + "[Profiler] Profile available at /app_profiler/#{id}\n" + ) + + viewer.view + end + + test "#view with response redirects to URL" do + response = [200, {}, ["OK"]] + profile = VernierProfile.new(vernier_profile) + + viewer = FirefoxRemoteViewer.new(profile) + id = FirefoxRemoteViewer::Middleware.id(profile.file) + + viewer.view(response: response) + + assert_equal(303, response[0]) + assert_equal("/app_profiler/firefox/viewer/#{id}", response[1]["Location"]) + end + end + end +end diff --git a/test/app_profiler/viewer/remote/middleware/firefox_middleware_test.rb b/test/app_profiler/viewer/remote/middleware/firefox_middleware_test.rb new file mode 100644 index 00000000..d31a3c1c --- /dev/null +++ b/test/app_profiler/viewer/remote/middleware/firefox_middleware_test.rb @@ -0,0 +1,116 @@ +# frozen_string_literal: true + +require "test_helper" + +module AppProfiler + module Viewer + class FirefoxRemoteViewer + class MiddlewareTest < TestCase + setup do + @app = Middleware.new( + proc { [200, { "Content-Type" => "text/plain" }, ["Hello world!"]] } + ) + end + + test ".id" do + profile = VernierProfile.new(vernier_profile) + profile_id = profile.file.basename.to_s + + assert_equal(profile_id, Middleware.id(profile.file)) + end + + test "#call index" do + profiles = Array.new(3) { VernierProfile.new(vernier_profile).tap(&:file) } + + code, content_type, html = @app.call({ "PATH_INFO" => "/app_profiler" }) + html = html.first + + assert_equal(200, code) + assert_equal({ "Content-Type" => "text/html" }, content_type) + assert_match(%r(