Fixes #37623 - Use html format in react controller to allow for ics domains

[chris1984]

Credit to @hao-yu for finding the fix. If you have a host with a domain extension .ics the all hosts pages fails to render the host (even the legacy UI) because rails is trying to ics as a format.

Testing steps:

1. Register a host with a name like foo.example.ics
2. Try to view the host in the UI and watch it fail
3. Apply PR
4. View the host and see that it shows up

Screenshots before and after:

Based on my understanding, I think it should not break anything because there is only one view in react directory:

ls -lrt /usr/share/foreman/app/views/react/
total 0
-rw-r--r--. 1 root root 0 Jan 31 16:40 index.html.erb

[ekohl]

It took me a while to figure out why it's changing the format because first I thought you meant the Foreman server hostname, but the URL is then https://foreman.example.com/new/hosts/host.example.ics.

[chris1984]

Updated to what @swimlappy used. Screenshot showing it's working:

[chris1984]

I got a different test failure locally for the webpack, so wonder if it's a transient failure:

Finished tests in 1674.866192s, 0.1128 tests/s, 0.3594 assertions/s.


Error:
HostJSTest::new host details page#test_0004_edit page:
Capybara::Ambiguous: Ambiguous match, found 2 elements matching visible button "Edit" that is not disabled
    test/integration/host_js_test.rb:99:in `block (2 levels) in <class:HostJSTest>'

Failure:
SmartProxyJSTest#test_0003_edit page [test/integration/smart_proxy_js_test.rb:29]
Minitest::Assertion: expected "/smart_proxies" to equal "/smart_proxies/980190962-DHCP%20Proxy"

189 tests, 602 assertions, 1 failures, 1 errors, 0 skips

Can you try kicking them again, I don't have perms to do so.

[ekohl]

Can you please at least expand the commit message to describe why this is needed, but even better if you write a test for it.

[chris1984]

Can you please at least expand the commit message to describe why this is needed, but even better if you write a test for it.

@ekohl I updated the PR title and commit message, I am not having good luck getting a test to work in the webpack:compile integration tests. Is it ok with just the updated commit message?

[chris1984]

@ekohl can this one get a review next week? We want to target it for Satellite 6.16, and it would be nice to get in if possible before branching.

[ekohl]

For the commit message I'd recommend reading https://cbea.ms/git-commit/#why-not-how. Using the body to at least describe the use case is really helpful because you a simple git blame can help you figure out why that was in the future.

As for testing, I can write a very simple reproducer with:

require 'integration_test_helper'

class HostDetailIntegrationTest < ActionDispatch::IntegrationTest
  test "host with .ics extension" do
    domain = FactoryBot.create(:domain, name: 'example.ics')
    host = FactoryBot.create(:host, domain: domain)
    visit host_details_page_path(host)
  end
end

That shows me in current develop:

Error:
HostDetailIntegrationTest#test_0001_host with .ics extension:
ActionView::MissingTemplate: Missing template react/index with {:locale=>[:en], :formats=>[:ics], :variants=>[], :handlers=>[:raw, :erb, :html, :builder, :ruby, :rabl]}. Searched in:
  * "/home/ekohl/dev/foreman/app/views"
  * "/home/ekohl/.rbenv/versions/3.0.4/lib/ruby/gems/3.0.0/gems/apipie-dsl-2.6.2/app/views"
  * "/home/ekohl/.rbenv/versions/3.0.4/lib/ruby/gems/3.0.0/gems/apipie-rails-1.4.2/app/views"

    app/controllers/react_controller.rb:7:in `index'
    app/controllers/concerns/foreman/controller/timezone.rb:10:in `set_timezone'
    app/models/concerns/foreman/thread_session.rb:32:in `clear_thread'
    app/controllers/concerns/foreman/controller/topbar_sweeper.rb:12:in `set_topbar_sweeper_controller'
    lib/foreman/middleware/libvirt_connection_cleaner.rb:9:in `call'
    lib/foreman/middleware/telemetry.rb:10:in `call'
    lib/foreman/middleware/logging_context_session.rb:22:in `call'
    lib/foreman/middleware/logging_context_request.rb:11:in `call'
    test/integration/host_detail_test.rb:7:in `block in <class:HostDetailIntegrationTest>'

And when I check out your PR it passes.

[chris1984]

@ekohl thanks for the help with the test, I have added a test and read the link you sent me and made a better commit message. Let me know how it looks when you get time, please. I will start using that when making commit messages to provide better context about my changes in future pr's

[chris1984]

@ekohl how does this look? I didn't see a block that it should fit in but did see another test outside of a block so put it after that one or did you want me to make a block such as view hosts and then put the test inside that?

Are you able to rekick the test:katello one that had an issue, I don't have perms to restart the job. Looks like the test failures are unrelated, failing vcr tests with ACS

[ekohl]

did you want me to make a block such as view hosts and then put the test inside that?

This is what I indeed had intended.

[chris1984]

Updated, went with:

describe "view host page" do
  test "host with .ics extension" do
    domain = FactoryBot.create(:domain, name: 'example.ics')
    host = FactoryBot.create(:host, domain: domain)
    visit host_details_page_path(host)
  end
end

[ekohl]

Thanks!