Log page actionsml-qa-logging

Override page object methods to log the actions taken by the methods
before or after the action, as appropriate.

Allow page object action logging to be turned on via a QA_DEBUG env var.
Unlike CHROME_HEADLESS (and the soon to arrive VERBOSE), QA_DEBUG
is false by default.

QA_DEBUG is used instead of just DEBUG because that enables Selenium
debug logging.

Mask passwords entered into fields with a QA selector with 'password'
in the name. Doesn't mask sensitive data entered into any other field.

1 files changed, 100 insertions, 0 deletions

diff --git a/qa/qa/support/page/logging.rb b/qa/qa/support/page/logging.rb
new file mode 100644
index 00000000000..cf5cd3a79f8
--- /dev/null
+++ b/qa/qa/support/page/logging.rb
@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module QA
+  module Support
+    module Page
+      module Logging
+        def refresh
+          log("refreshing #{current_url}")
+
+          super
+        end
+
+        def wait(max: 60, time: 0.1, reload: true)
+          log("with wait: max #{max}; time #{time}; reload #{reload}")
+          now = Time.now
+
+          element = super
+
+          log("ended wait after #{Time.now - now} seconds")
+
+          element
+        end
+
+        def scroll_to(selector, text: nil)
+          msg = "scrolling to :#{selector}"
+          msg += " with text: #{text}" if text
+          log(msg)
+
+          super
+        end
+
+        def asset_exists?(url)
+          exists = super
+
+          log("asset_exists? #{url} returned #{exists}")
+
+          exists
+        end
+
+        def find_element(name)
+          log("finding :#{name}")
+
+          element = super
+
+          log("found :#{name}") if element
+
+          element
+        end
+
+        def all_elements(name)
+          log("finding all :#{name}")
+
+          elements = super
+
+          log("found #{elements.size} :#{name}") if elements
+
+          elements
+        end
+
+        def click_element(name)
+          log("clicking :#{name}")
+
+          super
+        end
+
+        def fill_element(name, content)
+          masked_content = name.to_s.include?('password') ? '*****' : content
+
+          log(%Q(filling :#{name} with "#{masked_content}"))
+
+          super
+        end
+
+        def has_element?(name)
+          found = super
+
+          log("has_element? :#{name} returned #{found}")
+
+          found
+        end
+
+        def within_element(name)
+          log("within element :#{name}")
+
+          element = super
+
+          log("end within element :#{name}")
+
+          element
+        end
+
+        private
+
+        def log(msg)
+          QA::Runtime::Logger.debug(msg)
+        end
+      end
+    end
+  end
+end