[BaseController] Localize OPTIONS (allow optional user auth)

[NickLaMuro]

This allows translating of OPTION data if a user is logged in.

To achieve this, the commit does a few things:

• Split up .require_api_user_or_token to pull out the "authentication" step into it's own method: .authenticate_user
• Create a new method called .optional_api_user_or_token for only OPTIONS requests
  • Logs in a user in on OPTIONS calls, but no-op if it fails
  • in otherwords: if you don't pass auth, still work as we did, but allow a user to log in and retrieve settings

By doing this, we can make sure that :set_gettext_locale can have a user if one is provided, and allow translations to be processed further down the line.

FYI

There are places where we are using _N() instead of _(), which will cause some of the translations to still result in English:

https://github.com/ManageIQ/manageiq-providers-kubernetes/blob/9b5b107dfcf702901683f02ac19263e2730d217a/app/models/manageiq/providers/kubernetes/container_manager/options.rb#L5-L13

This probably should be addressed, but can be handled on a case by case basis.

Links

• Partially addresses: DDF schema parameters are not getting translated in api response. #1042

Testing/QA

The spec in spec/requests/providers_spec.rb is a pretty good framework for seeing if this works:

• Update your user record to use a different locale ("es" for Spanish)

• Get an API auth token

• curl the OPTIONS endpoint:

  $ curl -X OPTIONS "localhost:3000?type=ManageIQ::Providers::Openstack::CloudManager"
  

(the curl above is missing some options for auth. I use miqperf from manageiq-performance myself so I don't have to worry about these options)

[NickLaMuro]

@miq-bot add_label bug
@miq-bot assign @Fryguy

@Fryguy assigning you as you seem familiar with this code, but feel free to delegate to someone else.

[NickLaMuro]

cc @kavyanekkalapu

[Fryguy]

wow this is cool...great work @NickLaMuro

[Fryguy]

Wondering if we should cross repo test this

[NickLaMuro]

@Fryguy not opposed to it. Do you have some repos in mind where this makes sense? Not sure what might be using the API in their specs myself. Maybe the UI I guess?

[kavyanekkalapu]

@NickLaMuro I verified the fix, it is working , tomorrow i will try to do more testing on other pages, i am not sure if we are calling options in all pages or not, Thank you.

[NickLaMuro]

@miq-bot cross-repo-test ManageIQ/manageiq-ui-clasic

[Fryguy]

wondering if we should log this more as a warning, since it's not really an error.

[NickLaMuro]

Yeah, I just threw something in there for getting something pushed up, but definitely wasn't satisfied when I wrote it.

We can absolutely change it to a warning. I will see if there is a method for this somewhere. Happy to change anything else with this if you can think of anything better as well.

[Fryguy]

One minor comment

[NickLaMuro]

@Fryguy let me know if that phrasing change is also good.

[miq-bot]

Checked commit NickLaMuro@e8de60d with ruby 2.6.3, rubocop 1.13.0, haml-lint 0.35.0, and yamllint
3 files checked, 0 offenses detected
Everything looks fine. 🍰

[Fryguy]

Backported to morphy in commit 5e6b5e0.

commit 5e6b5e0c52c6593018c428bdee727e0e16d32f09
Author: Jason Frey <[email protected]>
Date:   Thu Jun 10 16:58:58 2021 -0400

    Merge pull request #1043 from NickLaMuro/option-request-localization
    
    [BaseController] Localize OPTIONS (allow optional user auth)
    
    (cherry picked from commit b44f339a6f099941781523860cb9375c5e49066b)