Mark previously deprecated SSL settings as obsolete

[robbavey]

• SSL settings that were marked deprecated in version 3.15.0 are now marked obsolete, and will prevent the plugin from starting.
• These settings are:
  • ca_file, which should be replaced by ssl_certificate_authorities
  • keystore, which should be replaced by ssl_keystore_path
  • keystore_password, which should be replaced by ssl_keystore_password
  • keystore_type, which should be replaced by ssl_keystore_password
  • ssl, which should be replaced by ssl_enabled

Relates: #179

[donoghuc]

The setup of ssl parameters seems a bit complex now:

  def setup_ssl_params!
    # Infer the value if neither the deprecate `ssl` and `ssl_enabled` were set
    infer_ssl_enabled_from_hosts
  end

  def infer_ssl_enabled_from_hosts
    return if original_params.include?('ssl_enabled')

    @ssl_enabled = params['ssl_enabled'] = effectively_ssl?
  end

  def effectively_ssl?
    return true if @ssl_enabled

    hosts = Array(@hosts)
    return false if hosts.nil? || hosts.empty?

    hosts.all? { |host| host && host.to_s.start_with?("https") }
  end

I think that boils down to just:

def setup_ssl!
  return if original_params.include?('ssl_enabled')
  
  @ssl_enabled = if @ssl_enabled
    true
  else
    Array(@hosts).all? { |host| host && host.to_s.start_with?("https") }
  end
  
  params['ssl_enabled'] = @ssl_enabled
end

Though i'm not entirely sure what mutating params does in this. In general the params scope is kind of a mystery to me 😅

[robbavey]

This was about as simple as I could get to:

  def setup_ssl_params!
    # Infer the value if neither `ssl_enabled` was not set
    return if original_params.include?('ssl_enabled')
    params['ssl_enabled'] = @ssl_enabled ||= Array(@hosts).all? { |host| host && host.to_s.start_with?("https") }
  end

[donoghuc]

Looks great!

[robbavey]

Over to @karenzone for doc review

[karenzone]

Line 113: Update links:

• <<plugins-{type}s-{plugin}-ssl_keystore_path>> and/or <<plugins-{type}s-{plugin}-ssl_keystore_password>>

[robbavey]

Ready for another round @karenzone

[karenzone]

LGTM