ngrok-wrapper 0.1.0

data/enabled.yml

@@ -0,0 +1,122 @@
+# These are all the cops that are enabled in the default configuration.
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Performance/AncestorsInclude:
+  Enabled: true
+
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+
+Performance/RedundantSortBlock:
+  Enabled: true
+
+Performance/RedundantStringChars:
+  Enabled: true
+
+Performance/ReverseFirst:
+  Enabled: true
+
+Performance/SortReverse:
+  Enabled: true
+
+Performance/Squeeze:
+  Enabled: true
+
+Performance/StringInclude:
+  Enabled: true
+
+Style/AccessorGrouping:
+  Enabled: true
+  EnforcedStyle: grouped
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/AutoResourceCleanup:
+  Description: 'Suggests the usage of an auto resource cleanup version of a method (if available).'
+  Enabled: true
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+Style/CaseLikeIf:
+  Enabled: true
+
+Style/CollectionMethods:
+  Description: 'Preferred collection methods.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size'
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+  EnforcedStyle: scientific
+
+Style/HashAsLastArrayItem:
+  Enabled: true
+  EnforcedStyle: no_braces
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashLikeCase:
+  Enabled: true
+  MinBranchesCount: 3
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+  SafeForConstants: false
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/Send:
+  Description: 'Prefer `Object#__send__` or `Object#public_send` to `send`, as `send` may overlap with existing methods.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#prefer-public-send'
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/StringMethods:
+  Enabled: true
+  PreferredMethods:
+    intern: to_sym

data/lib/ngrok/wrapper/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ngrok
+  class Wrapper
+    VERSION = '0.1.0'
+  end
+end

data/lib/ngrok/wrapper.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+require_relative 'wrapper/version'
+require 'tempfile'
+
+module Ngrok
+  OPTIONAL_PARAMS = %i[authtoken bind_tls host_header hostname inspect region subdomain].freeze
+
+  class NotFound < StandardError; end
+  class FetchUrlError < StandardError; end
+  class Error < StandardError; end
+
+  class Wrapper
+    class << self
+      attr_reader :pid, :ngrok_url, :ngrok_url_https, :status, :params
+
+      def init(params = {})
+        # map old key 'port' to 'addr' to maintain backwards compatibility with versions 2.0.21 and earlier
+        params[:addr] = params.delete(:port) if params.key?(:port)
+
+        @params = { addr: 3001, timeout: 10, config: '/dev/null' }.merge!(params)
+        @status ||= :stopped # rubocop:disable Naming/MemoizedInstanceVariableName
+      end
+
+      def start(params = {})
+        ensure_binary
+        init(params)
+
+        persistent_ngrok = @params[:persistence] == true
+        # Attempt to read the attributes of an existing process instead of starting a new process.
+        try_params_from_running_ngrok if persistent_ngrok
+
+        spawn_new_ngrok(persistent_ngrok: persistent_ngrok) if stopped?
+
+        @status = :running
+        if persistent_ngrok
+          # Record the attributes of the new process so that it can be reused on a subsequent call.
+          File.write(@persistence_file, { pid: @pid, ngrok_url: @ngrok_url, ngrok_url_https: @ngrok_url_https }.to_json)
+        end
+
+        @ngrok_url
+      end
+
+      def stop
+        if running?
+          Process.kill(9, @pid)
+          @ngrok_url = @ngrok_url_https = @pid = nil
+          @status = :stopped
+        end
+        @status
+      end
+
+      def running?
+        @status == :running
+      end
+
+      def stopped?
+        @status == :stopped
+      end
+
+      def addr
+        @params[:addr]
+      end
+
+      def port
+        return addr if addr.is_a?(Numeric)
+
+        addr.split(':').last.to_i
+      end
+
+      def inherited(subclass)
+        super
+        init
+      end
+
+      private
+
+      def parse_persistence_file
+        JSON.parse(File.read(@persistence_file))
+      rescue StandardError => _e # Catch all possible errors on reading and parsing the file
+        nil
+      end
+
+      def raise_if_similar_ngroks(pid)
+        other_ngrok_on_port = ngrok_process_status_lines.find do |line|
+          # If found an Ngrok process with other pid, tunneling on the port, specified in Ngrok::Wrapper.start params
+          line.include?('ngrok http -log') && !line.start_with?(pid || '') && line.end_with?(addr.to_s)
+        end
+
+        raise Ngrok::Error, "ERROR: Other ngrok instances tunneling to port #{addr} found" if other_ngrok_on_port
+
+        return unless pid
+
+        tunnel_on_other_port = ngrok_process_status_lines.find do |line|
+          # If the line starts with this pid, but the port is other than specified in Ngrok::Wrapper.start params
+          line.include?('ngrok http -log') && line.start_with?(pid) && !line.end_with?(addr.to_s)
+        end
+
+        return unless tunnel_on_other_port
+
+        raise Ngrok::Error, "ERROR: Ngrok pid ##{pid} tunneling on other port #{tunnel_on_other_port.split(':').last}"
+      end
+
+      def ngrok_process_status_lines(refetch: false)
+        return @ngrok_process_status_lines if defined?(@ngrok_process_status_lines) && !refetch
+
+        @ngrok_process_status_lines = (`ps ax | grep "ngrok http"`).split("\n")
+      end
+
+      def try_params_from_running_ngrok
+        @persistence_file = @params[:persistence_file] || "#{File.dirname(@params[:config])}/ngrok-process.json"
+        state = parse_persistence_file
+        return unless (pid = state&.[]('pid'))
+
+        raise_if_similar_ngroks(pid)
+
+        return unless ngrok_running?(pid)
+
+        @status = :running
+        @pid = pid
+        @ngrok_url = state['ngrok_url']
+        @ngrok_url_https = state['ngrok_url_https']
+      end
+
+      def ngrok_running?(pid)
+        ngrok_process_status_lines.find do |line|
+          # If found the Ngrok process with correct pid, tunneling on the port, specified in Ngrok::Wrapper.start params
+          line.include?('ngrok http -log') && line.start_with?(pid) && line.end_with?(addr.to_s)
+        end
+      end
+
+      def spawn_new_ngrok(persistent_ngrok:)
+        raise_if_similar_ngroks(nil)
+        # Prepare the log file into which ngrok output will be redirected in `ngrok_exec_params`
+        @params[:log] = @params[:log] ? File.open(@params[:log], 'w+') : Tempfile.new('ngrok')
+        if persistent_ngrok
+          Process.spawn("exec nohup ngrok http #{ngrok_exec_params} &")
+          @pid = ngrok_process_status_lines(refetch: true)
+                 .find { |line| line.include?('ngrok http -log') && line.end_with?(addr.to_s) }.split[0]
+        else
+          @pid = Process.spawn("exec ngrok http #{ngrok_exec_params}")
+          at_exit { Ngrok::Wrapper.stop }
+        end
+
+        fetch_urls
+      end
+
+      def ngrok_exec_params
+        exec_params = +'-log=stdout -log-level=debug '
+        OPTIONAL_PARAMS.each do |opt|
+          exec_params << "-#{opt.to_s.tr('_', '-')}=#{@params[opt]} " if @params.key?(opt)
+        end
+        exec_params << "-config #{@params[:config]} #{@params[:addr]} > #{@params[:log].path}"
+      end
+
+      def fetch_urls
+        @params[:timeout].times do
+          break if scan_log_for_urls || !@error.empty?
+
+          sleep 1
+          @params[:log].rewind
+        end
+
+        @params[:log].close
+        return if @ngrok_url || @ngrok_url_https
+
+        stop
+        raise FetchUrlError, 'Unable to fetch external url' if @error.empty?
+
+        raise Ngrok::Error, @error.first
+      end
+
+      def scan_log_for_urls
+        log_content = @params[:log].read
+        result = log_content.scan(/URL:(.+)\sProto:(http|https)\s/)
+        unless result.empty?
+          result           = Hash[*result.flatten].invert
+          @ngrok_url       = result['http']
+          @ngrok_url_https = result['https']
+          return true if @ngrok_url || @ngrok_url_https
+        end
+
+        @error = log_content.scan(/msg="command failed" err="([^"]+)"/).flatten
+        false
+      end
+
+      def ensure_binary
+        `ngrok version`
+      rescue Errno::ENOENT
+        raise Ngrok::NotFound, 'Ngrok binary not found'
+      end
+    end
+
+    init
+  end
+end

data/ngrok-wrapper.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = "#{__dir__}/lib"
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require_relative 'lib/ngrok/wrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'ngrok-wrapper'
+  spec.version = Ngrok::Wrapper::VERSION
+  spec.authors = ['Anton Bogdanovich', 'Aureliu Brinzeanu']
+  spec.email = %w[27bogdanovich@gmail.com branzeanu.aurel@gmail.com]
+
+  spec.summary = 'Ngrok-wrapper gem is a ruby wrapper for ngrok2'
+  spec.description = 'Ngrok-wrapper gem is a ruby wrapper for ngrok2'
+  spec.homepage = 'https://github.com/texpert/ngrok-wrapper'
+  spec.required_ruby_version = '>= 2.6.0'
+  spec.license = 'MIT'
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/texpert/ngrok-wrapper'
+  spec.metadata['changelog_uri'] = 'https://github.com/texpert/ngrok-wrapper/blob/main/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'github_changelog_generator'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rspec'
+end

data/sig/ngrok/wrapper.rbs

@@ -0,0 +1,6 @@
+module Ngrok
+  module Wrapper
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

data/spec/fixtures/ngrok.no_auth_token.log

@@ -0,0 +1,43 @@
+t=2022-01-08T22:03:24+0200 lvl=info msg="open config file" path=/Users/thunder/.ngrok2/ngrok.yml err=nil
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="ignoring manifest file with unhandled mimetype" name=vendor.svg ext=.svg
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="ignoring manifest file with unhandled mimetype" name=glyphicons-halflings-regular.svg ext=.svg
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="starting component" obj=app name="signal handler"
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="starting component" obj=app name="Tunnel session"
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="starting component" obj=app name=web
+t=2022-01-08T22:03:24+0200 lvl=info msg="starting web service" obj=web addr=127.0.0.1:4040
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="starting component" obj=app name=updater
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="checking for updates periodically" obj=updater interval=6h0m0s
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="check for update" obj=updater
+t=2022-01-08T22:03:24+0200 lvl=info msg=start pg=/grpc/agent.Web/State id=f491cd33fec883bf
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="open stream" obj=csess id=bee4588e8c6f reqtype=0 err=nil
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="encode request" obj=csess id=bee4588e8c6f sid=3 req="&{Version:[2] ClientID: Extra:{OS:darwin Arch:amd64 Authtoken: Version:2.3.40 Hostname:tunnel.us.ngrok.com UserAgent:ngrok/2 Metadata: Cookie: HeartbeatInterval:10000000000 HeartbeatTolerance:15000000000 Fingerprint:0xc000442c30 UpdateUnsupportedError:0xc0000a52f0 StopUnsupportedError:0xc0000a52e0 RestartUnsupportedError:0xc0000a52d0}}" err=nil
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="decoded response" obj=csess id=bee4588e8c6f sid=3 resp="&{Version:2 ClientID:cb5f5f87e10e18bf4898de4a3a74d14b Error: Extra:{Version:prod Cookie:PrKmFyxHID0adtX44ErfI+A9gur8/kWa$S+hD0y1YuDXBOgvRysUB4wPAqfDnq8qBKSCKIvenBxXk8d0mM20jXvewiT5y+PSeMJ1ev6wrxFlrMho0T2AkG/39mF0QxTCWNgCYrrSK4Q+fRyr7I+7477gVIbVN7HZ0hhaqUK0BFFvIXea531lwDg88oqrW0nvjBqyL1vw3rqowuUc6TB+9+Pc2CPxBY9sERlcvOYkzVSR4bn0mlTG0vBI= AccountName: SessionDuration:7199 PlanName:}}" err=nil
+t=2022-01-08T22:03:24+0200 lvl=info msg="tunnel session started" obj=tunnels.session
+t=2022-01-08T22:03:24+0200 lvl=info msg="client session established" obj=csess id=bd4add4fa19a
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="open stream" obj=csess id=bee4588e8c6f clientid=cb5f5f87e10e18bf4898de4a3a74d14b reqtype=1 err=nil
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="encode request" obj=csess id=bee4588e8c6f clientid=cb5f5f87e10e18bf4898de4a3a74d14b sid=7 req="&{ID: ClientID: Proto:https Opts:0xc0000c4780 Extra:{Token: IPPolicyRef: Metadata:}}" err=nil
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="decoded response" obj=csess id=bee4588e8c6f clientid=cb5f5f87e10e18bf4898de4a3a74d14b sid=7 resp="&{ClientID: URL: Proto: Opts:<nil> Error:Forwarding to local port 443 or a local https:// URL is only available after you sign up.\nSign up at: https://dashboard.ngrok.com/signup\n\nIf you have already signed up, make sure your authtoken is installed.\nYour authtoken is available on your dashboard: https://dashboard.ngrok.com/get-started/your-authtoken\r\n\r\nERR_NGROK_340\r\n Extra:{Token:}}" err=nil
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="start tunnel listen" obj=tunnels.session name=command_line proto=https opts="&{Hostname: Auth: Subdomain: HostHeaderRewrite:false LocalURLScheme:https}" err="Forwarding to local port 443 or a local https:// URL is only available after you sign up.\nSign up at: https://dashboard.ngrok.com/signup\n\nIf you have already signed up, make sure your authtoken is installed.\nYour authtoken is available on your dashboard: https://dashboard.ngrok.com/get-started/your-authtoken\r\n\r\nERR_NGROK_340\r\n"
+t=2022-01-08T22:03:24+0200 lvl=eror msg="session closing" obj=tunnels.session err="Forwarding to local port 443 or a local https:// URL is only available after you sign up.\nSign up at: https://dashboard.ngrok.com/signup\n\nIf you have already signed up, make sure your authtoken is installed.\nYour authtoken is available on your dashboard: https://dashboard.ngrok.com/get-started/your-authtoken\r\n\r\nERR_NGROK_340\r\n"
+t=2022-01-08T22:03:24+0200 lvl=info msg="accept failed" obj=csess id=bd4add4fa19a err="reconnecting session closed"
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="component stopped" obj=app name="Tunnel session" err="Forwarding to local port 443 or a local https:// URL is only available after you sign up.\nSign up at: https://dashboard.ngrok.com/signup\n\nIf you have already signed up, make sure your authtoken is installed.\nYour authtoken is available on your dashboard: https://dashboard.ngrok.com/get-started/your-authtoken\r\n\r\nERR_NGROK_340\r\n"
+t=2022-01-08T22:03:24+0200 lvl=info msg="received stop request" obj=app stopReq="{err:0xc0000a5980 restart:false}"
+t=2022-01-08T22:03:24+0200 lvl=eror msg="terminating with error" obj=app err="Forwarding to local port 443 or a local https:// URL is only available after you sign up.\nSign up at: https://dashboard.ngrok.com/signup\n\nIf you have already signed up, make sure your authtoken is installed.\nYour authtoken is available on your dashboard: https://dashboard.ngrok.com/get-started/your-authtoken\r\n\r\nERR_NGROK_340\r\n"
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="tunnel session closing permanently" obj=tunnels.session err="not reconnecting, session closed by the client side"
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="waiting for all components to stop" obj=app
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="waiting for components to stop" obj=app remaining=3
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="waiting for components to stop" obj=app remaining=2
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="waiting for components to stop" obj=app remaining=1
+t=2022-01-08T22:03:24+0200 lvl=warn msg="failed to check for update" obj=updater err="Post \"https://update.equinox.io/check\": context canceled"
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="component stopped" obj=app name=web err=nil
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="all components stopped" obj=app
+t=2022-01-08T22:03:24+0200 lvl=crit msg="command failed" err="Forwarding to local port 443 or a local https:// URL is only available after you sign up.\nSign up at: https://dashboard.ngrok.com/signup\n\nIf you have already signed up, make sure your authtoken is installed.\nYour authtoken is available on your dashboard: https://dashboard.ngrok.com/get-started/your-authtoken\r\n\r\nERR_NGROK_340\r\n"
+Forwarding to local port 443 or a local https:// URL is only available after you sign up.
+Sign up at: https://dashboard.ngrok.com/signup
+
+If you have already signed up, make sure your authtoken is installed.
+Your authtoken is available on your dashboard: https://dashboard.ngrok.com/get-started/your-authtoken
+
+ERR_NGROK_340
+
+t=2022-01-08T22:03:24+0200 lvl=dbug msg="component stopped" obj=app name="signal handler" err=nil

data/spec/fixtures/ngrok.sample.log

@@ -0,0 +1,34 @@
+t=2022-01-08T20:02:00+0200 lvl=info msg="open config file" path=/Users/thunder/.ngrok2/ngrok.yml err=nil
+t=2022-01-08T20:02:00+0200 lvl=dbug msg="ignoring manifest file with unhandled mimetype" name=glyphicons-halflings-regular.svg ext=.svg
+t=2022-01-08T20:02:00+0200 lvl=dbug msg="ignoring manifest file with unhandled mimetype" name=vendor.svg ext=.svg
+t=2022-01-08T20:02:00+0200 lvl=dbug msg="starting component" obj=app name="signal handler"
+t=2022-01-08T20:02:00+0200 lvl=dbug msg="starting component" obj=app name=web
+t=2022-01-08T20:02:00+0200 lvl=info msg="starting web service" obj=web addr=127.0.0.1:4040
+t=2022-01-08T20:02:00+0200 lvl=dbug msg="starting component" obj=app name="Tunnel session"
+t=2022-01-08T20:02:00+0200 lvl=dbug msg="starting component" obj=app name=updater
+t=2022-01-08T20:02:00+0200 lvl=dbug msg="checking for updates periodically" obj=updater interval=6h0m0s
+t=2022-01-08T20:02:00+0200 lvl=dbug msg="check for update" obj=updater
+t=2022-01-08T20:02:00+0200 lvl=info msg=start pg=/grpc/agent.Web/State id=2bbbb902480eaf60
+t=2022-01-08T20:02:00+0200 lvl=dbug msg="open stream" obj=csess id=722767b16fd7 reqtype=0 err=nil
+t=2022-01-08T20:02:00+0200 lvl=dbug msg="encode request" obj=csess id=722767b16fd7 sid=3 req="&{Version:[2] ClientID: Extra:{OS:darwin Arch:amd64 Authtoken:1gsJ49S2XCIOZM5AMynyeht9w8X_5ABZ98sjGeNwNHDaRPETc Version:2.3.40 Hostname:tunnel.us.ngrok.com UserAgent:ngrok/2 Metadata: Cookie: HeartbeatInterval:10000000000 HeartbeatTolerance:15000000000 Fingerprint:0xc0005870b0 UpdateUnsupportedError:0xc0005827e0 StopUnsupportedError:0xc0005827d0 RestartUnsupportedError:0xc0005827c0}}" err=nil
+t=2022-01-08T20:02:00+0200 lvl=dbug msg="decoded response" obj=csess id=722767b16fd7 sid=3 resp="&{Version:2 ClientID:09923e94929a0b5a25d01d204db8551f Error: Extra:{Version:prod Cookie:HGyjNiaHRPD5FZZ20HIeXaor2I1gELo/$exvZVPin7bk5uy7IStEyr6OD2XJrjatWDP7lRkBf+FuF6IxTsZd+x4npcaHKgRd86EF333l9Ye1Jf/67xcyHtnuQRRRmrtwuBh6s+xIdZEapgYm2+Z7yrXYakItFsvF5V95skLAkOZPfcoYPuo/wJB0oVCbPg1B7KkwB7QhBEUeKysIpzZTY1ZdYp+EWodIiujo6umhCzQaf3XPlHzQ= AccountName:Aurel Brinzeanu SessionDuration:0 PlanName:Free}}" err=nil
+t=2022-01-08T20:02:00+0200 lvl=info msg="tunnel session started" obj=tunnels.session
+t=2022-01-08T20:02:00+0200 lvl=info msg="client session established" obj=csess id=2528230e5df5
+t=2022-01-08T20:02:00+0200 lvl=dbug msg="open stream" obj=csess id=722767b16fd7 clientid=09923e94929a0b5a25d01d204db8551f reqtype=1 err=nil
+t=2022-01-08T20:02:00+0200 lvl=dbug msg="encode request" obj=csess id=722767b16fd7 clientid=09923e94929a0b5a25d01d204db8551f sid=7 req="&{ID: ClientID: Proto:https Opts:0xc00071a690 Extra:{Token: IPPolicyRef: Metadata:}}" err=nil
+t=2022-01-08T20:02:00+0200 lvl=dbug msg="decoded response" obj=csess id=722767b16fd7 clientid=09923e94929a0b5a25d01d204db8551f sid=7 resp="&{ClientID:5dd5645be0454d6f8a1dc5f9130a6d1b URL:https://b1cd-109-185-141-9.ngrok.io Proto:https Opts:map[Auth: BasicAuth:<nil> CircuitBreaker:<nil> Compression:<nil> HostHeaderRewrite:false Hostname:b1cd-109-185-141-9.ngrok.io IPRestriction:<nil> LocalURLScheme:https MutualTLSCA:<nil> OAuth:<nil> ProxyProto:0 RequestHeaders:<nil> ResponseHeaders:<nil> Subdomain: WebhookVerification:<nil> WebsocketTCPConverter:<nil>] Error: Extra:{Token:L+C5Xuf2F8JjA2o8cloUX4NwcMTUo4l0$CkYDAnj+Dm17nYZ1/H/o5wuzNHWDUZqJHU6Omj61l0hf9C3KZ0wtrIDGe9W03+syfaQjYP1UL/BQwxEGReR5UHJpCFUtSmK87vIHrKCsQMnE9Z74FwIKNKXDv59LGSy83OcLyeFvx5GhbqpACeWGJ9u/5nBAG86UP2fAGHCiUYcdmRwpNfygjv/MQazbMAe54YqPn1ZzonDXZy7Lzo9gWUDHqkpuLITDhmEW6RIgz311QpIMRSHb6kfZ2nmfXAZz/2exRPMe9uAYuffJK+zIwX/E3kKCXflrd9+ZJ7cw6Eiaroa5SRl0Tixsp9eWEWl9bn7+ubIfO7lSqd2mDRUKWhm0JgAZJIcGrwL9JZ2EKxgXABoGVKyJ89BJfY+Ok9W1leVxHQ+P1DERjHD8Hxp+MfHCa+fqFxM3UObs2MV0j3DZ7ReengLdamok39Z4yXwjIxxfGyGo86Di9bRDpQKgP49/wdvn4qOdLq9hIrWFqkkP/fGr2Hz3hIwGmjY0xC2Zr9ha7Ik+FoFe4tvhRVinZC9TdrnfkY1wdx2Xel5iAsG13k31FtUdCmzPaRnYBAhxn4xDhX10blULXiE=}}" err=nil
+t=2022-01-08T20:02:00+0200 lvl=dbug msg="start tunnel listen" obj=tunnels.session name=command_line proto=https opts="&{Hostname: Auth: Subdomain: HostHeaderRewrite:false LocalURLScheme:https}" err=nil
+t=2022-01-08T20:02:00+0200 lvl=dbug msg="open stream" obj=csess id=722767b16fd7 clientid=09923e94929a0b5a25d01d204db8551f reqtype=1 err=nil
+t=2022-01-08T20:02:00+0200 lvl=dbug msg="encode request" obj=csess id=722767b16fd7 clientid=09923e94929a0b5a25d01d204db8551f sid=9 req="&{ID: ClientID: Proto:http Opts:0xc00091a0f0 Extra:{Token: IPPolicyRef: Metadata:}}" err=nil
+t=2022-01-08T20:02:00+0200 lvl=dbug msg="no update available" obj=updater
+t=2022-01-08T20:02:01+0200 lvl=dbug msg="decoded response" obj=csess id=722767b16fd7 clientid=09923e94929a0b5a25d01d204db8551f sid=9 resp="&{ClientID:bbde46c7c553a50d47e73f8ed2a5f94f URL:http://b1cd-109-185-141-9.ngrok.io Proto:http Opts:map[Auth: BasicAuth:<nil> CircuitBreaker:<nil> Compression:<nil> HostHeaderRewrite:false Hostname:b1cd-109-185-141-9.ngrok.io IPRestriction:<nil> LocalURLScheme:https MutualTLSCA:<nil> OAuth:<nil> ProxyProto:0 RequestHeaders:<nil> ResponseHeaders:<nil> Subdomain: WebhookVerification:<nil> WebsocketTCPConverter:<nil>] Error: Extra:{Token:ulvkj4ZPhRugBcDpoJTiDaWlhFBKSJje$pNXpffDJJ1LGn6FfYcksW+hS6eaJBI9Ia1e3QkA18EPjQJgH7DTumRRsx/XBXkONc/hK38y5W4pQ6bOwBvKg8Nxf5HJltbvgcTH+Spxitf1/6+LzA8LGX0L6kHS7+sdtshfD8j3CFb1sds1AaP0ZJcxBNLHuALiWLV7VvK1GCas77PydCivnsToPNz35Y8SENtT2w1Ws3d9O55udnDyvrqF5VVLgYkc4jq1NHxbuEETulgva1q6svMX304dIS6H+93PRsAxKwdc/4sMhTCC1e5uYqP639iMlHKoZ9f+vA8pI7jLB+A05s4NapGwfmDeyNyjlu7s8X37VMUlMV49ETWIw71PhhXnT7ydwclxnUy28TGDiiZ/9DIdcmEO5EZulFh4QRfL3WlsAWsvbvpjCUUmJI6ZPwmvfw9nTob+cShTuaDWyFjahk+PgSzisrALFHGuUlyf93YfSA1GzYvofp24UBz5DjfezYx3kC2g6sRkJfKX3KvPgP/pjQhVyRywp7bUEBT7u3EvGh+dy77Nw7+dTpqFRFAOB55go1GvuKdt6vv816xt6FuzRAti13DkVWMxcUfufGULpeA==}}" err=nil
+t=2022-01-08T20:02:01+0200 lvl=dbug msg="start tunnel listen" obj=tunnels.session name="command_line (http)" proto=http opts="&{Hostname:b1cd-109-185-141-9.ngrok.io Auth: Subdomain: HostHeaderRewrite:false LocalURLScheme:https}" err=nil
+t=2022-01-08T20:02:01+0200 lvl=info msg="started tunnel" obj=tunnels name="command_line (http)" addr=https://localhost:3000 url=http://b1cd-109-185-141-9.ngrok.io
+t=2022-01-08T20:02:01+0200 lvl=info msg="started tunnel" obj=tunnels name=command_line addr=https://localhost:3000 url=https://b1cd-109-185-141-9.ngrok.io
+t=2022-01-08T20:02:01+0200 lvl=info msg=start pg=/grpc/agent.Web/State id=e7293c8805b32c56
+t=2022-01-08T20:02:10+0200 lvl=dbug msg="heartbeat received" obj=csess id=722767b16fd7 clientid=09923e94929a0b5a25d01d204db8551f latency_ms=446
+t=2022-01-08T20:02:21+0200 lvl=dbug msg="heartbeat received" obj=csess id=722767b16fd7 clientid=09923e94929a0b5a25d01d204db8551f latency_ms=149
+t=2022-01-08T20:02:31+0200 lvl=dbug msg="heartbeat received" obj=csess id=722767b16fd7 clientid=09923e94929a0b5a25d01d204db8551f latency_ms=155
+t=2022-01-08T20:02:41+0200 lvl=dbug msg="heartbeat received" obj=csess id=722767b16fd7 clientid=09923e94929a0b5a25d01d204db8551f latency_ms=151
+t=2022-01-08T20:02:51+0200 lvl=dbug msg="heartbeat received" obj=csess id=722767b16fd7 clientid=09923e94929a0b5a25d01d204db8551f latency_ms=150
+t=2022-01-08T20:03:01+0200 lvl=dbug msg="heartbeat received" obj=csess id=722767b16fd7 clientid=09923e94929a0b5a25d01d204db8551f latency_ms=149

data/spec/fixtures/ngrok_invalid_auth_token.log

@@ -0,0 +1,37 @@
+t=2022-01-08T22:01:24+0200 lvl=info msg="open config file" path=/Users/thunder/.ngrok2/ngrok.yml err=nil
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="ignoring manifest file with unhandled mimetype" name=glyphicons-halflings-regular.svg ext=.svg
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="ignoring manifest file with unhandled mimetype" name=vendor.svg ext=.svg
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="starting component" obj=app name=web
+t=2022-01-08T22:01:24+0200 lvl=info msg="starting web service" obj=web addr=127.0.0.1:4040
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="starting component" obj=app name=updater
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="starting component" obj=app name="signal handler"
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="starting component" obj=app name="Tunnel session"
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="checking for updates periodically" obj=updater interval=6h0m0s
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="check for update" obj=updater
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="open stream" obj=csess id=a09f6c909db5 reqtype=0 err=nil
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="encode request" obj=csess id=a09f6c909db5 sid=3 req="&{Version:[2] ClientID: Extra:{OS:darwin Arch:amd64 Authtoken:1gsJ49S2XCIOZM5AMynyeht9w8X_5ABZ98sjGeNwNHDaR Version:2.3.40 Hostname:tunnel.us.ngrok.com UserAgent:ngrok/2 Metadata: Cookie: HeartbeatInterval:10000000000 HeartbeatTolerance:15000000000 Fingerprint:0xc000438900 UpdateUnsupportedError:0xc000283190 StopUnsupportedError:0xc000283180 RestartUnsupportedError:0xc000283170}}" err=nil
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="decoded response" obj=csess id=a09f6c909db5 sid=3 resp="&{Version: ClientID: Error:The authtoken you specified does not look like a proper ngrok tunnel authtoken.\nYour authtoken: 1gsJ49S2XCIOZM5AMynyeht9w8X_5ABZ98sjGeNwNHDaR\nInstructions to install your authtoken are on your ngrok dashboard:\nhttps://dashboard.ngrok.com/get-started/your-authtoken\r\n\r\nERR_NGROK_105\r\n Extra:{Version: Cookie: AccountName: SessionDuration:0 PlanName:}}" err=nil
+t=2022-01-08T22:01:24+0200 lvl=eror msg="failed to auth" obj=tunnels.session err="The authtoken you specified does not look like a proper ngrok tunnel authtoken.\nYour authtoken: 1gsJ49S2XCIOZM5AMynyeht9w8X_5ABZ98sjGeNwNHDaR\nInstructions to install your authtoken are on your ngrok dashboard:\nhttps://dashboard.ngrok.com/get-started/your-authtoken\r\n\r\nERR_NGROK_105\r\n"
+t=2022-01-08T22:01:24+0200 lvl=eror msg="failed to reconnect session" obj=csess id=49b66f54e43d err="The authtoken you specified does not look like a proper ngrok tunnel authtoken.\nYour authtoken: 1gsJ49S2XCIOZM5AMynyeht9w8X_5ABZ98sjGeNwNHDaR\nInstructions to install your authtoken are on your ngrok dashboard:\nhttps://dashboard.ngrok.com/get-started/your-authtoken\r\n\r\nERR_NGROK_105\r\n"
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="sleep before reconnect" obj=csess id=49b66f54e43d secs=0
+t=2022-01-08T22:01:24+0200 lvl=eror msg="session closing" obj=tunnels.session err="The authtoken you specified does not look like a proper ngrok tunnel authtoken.\nYour authtoken: 1gsJ49S2XCIOZM5AMynyeht9w8X_5ABZ98sjGeNwNHDaR\nInstructions to install your authtoken are on your ngrok dashboard:\nhttps://dashboard.ngrok.com/get-started/your-authtoken\r\n\r\nERR_NGROK_105\r\n"
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="component stopped" obj=app name="Tunnel session" err="The authtoken you specified does not look like a proper ngrok tunnel authtoken.\nYour authtoken: 1gsJ49S2XCIOZM5AMynyeht9w8X_5ABZ98sjGeNwNHDaR\nInstructions to install your authtoken are on your ngrok dashboard:\nhttps://dashboard.ngrok.com/get-started/your-authtoken\r\n\r\nERR_NGROK_105\r\n"
+t=2022-01-08T22:01:24+0200 lvl=info msg="received stop request" obj=app stopReq="{err:0xc0000a5ad0 restart:false}"
+t=2022-01-08T22:01:24+0200 lvl=eror msg="terminating with error" obj=app err="The authtoken you specified does not look like a proper ngrok tunnel authtoken.\nYour authtoken: 1gsJ49S2XCIOZM5AMynyeht9w8X_5ABZ98sjGeNwNHDaR\nInstructions to install your authtoken are on your ngrok dashboard:\nhttps://dashboard.ngrok.com/get-started/your-authtoken\r\n\r\nERR_NGROK_105\r\n"
+t=2022-01-08T22:01:24+0200 lvl=warn msg="failed to check for update" obj=updater err="Post \"https://update.equinox.io/check\": context canceled"
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="waiting for all components to stop" obj=app
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="waiting for components to stop" obj=app remaining=3
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="waiting for components to stop" obj=app remaining=2
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="waiting for components to stop" obj=app remaining=1
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="component stopped" obj=app name=updater err=nil
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="component stopped" obj=app name="signal handler" err=nil
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="all components stopped" obj=app
+t=2022-01-08T22:01:24+0200 lvl=crit msg="command failed" err="The authtoken you specified does not look like a proper ngrok tunnel authtoken.\nYour authtoken: 1gsJ49S2XCIOZM5AMynyeht9w8X_5ABZ98sjGeNwNHDaR\nInstructions to install your authtoken are on your ngrok dashboard:\nhttps://dashboard.ngrok.com/get-started/your-authtoken\r\n\r\nERR_NGROK_105\r\n"
+The authtoken you specified does not look like a proper ngrok tunnel authtoken.
+Your authtoken: 1gsJ49S2XCIOZM5AMynyeht9w8X_5ABZ98sjGeNwNHDaR
+Instructions to install your authtoken are on your ngrok dashboard:
+https://dashboard.ngrok.com/get-started/your-authtoken
+
+ERR_NGROK_105
+
+t=2022-01-08T22:01:24+0200 lvl=dbug msg="component stopped" obj=app name=web err=nil