Fixes #38530 - proxy the flatpak index #54

ianballou · 2025-06-24T21:46:39Z

Serves the Flatpak index at /index/static.

Also prepares the code to filter the index based on the authenticated client. Includes sample code.

This will require a change to the Apache config: theforeman/puppet-foreman_proxy_content#522

ekohl · 2025-06-25T10:12:54Z

lib/smart_proxy_container_gateway/container_gateway_main.rb

+        query = ""
+        unless params.empty?
+          query_parts = params.map { |key, value| "#{key}=#{value}" }
+          query = "?#{query_parts.join('&')}"
+        end
+        uri = URI.parse("#{@pulp_endpoint}/pulpcore_registry/index/static#{query}")


I'd like the parameters to be escaped. I'd suggest this:

Suggested change

query = ""

unless params.empty?

query_parts = params.map { |key, value| "#{key}=#{value}" }

query = "?#{query_parts.join('&')}"

end

uri = URI.parse("#{@pulp_endpoint}/pulpcore_registry/index/static#{query}")

uri = URI.parse("#{@pulp_endpoint}/pulpcore_registry/index/static")

uri.query = params.map { |k, v| "#{URI.encode_uri_component(k)}=#{URI.encode_uri_component(v)}" }.join('&') if params.any?

I really wish there was a method similar to URI.encode_www_form that uses URI.encode_uri_component and accepts a hash, but I can't find it.

And the tags method probably needs the same fixes.

I was surprised too that there wasn't a cleaner way to build the URL with the query from a hash with escaping.

I swear I saw it used somewhere because I too thought there must be an easy way, but I couldn't find it. Feels so stupid because it's so extremely common.

Time to enhance encode_www_form with an escape arg...

Ugh - encode_uri_component doesn't seem to exist before Ruby 3.1

I wonder if the + that encode_www_form uses for spaces is okay.

ekohl · 2025-06-26T21:19:29Z

lib/smart_proxy_container_gateway/container_gateway_api.rb

      inject_attr :container_gateway_main_impl, :container_gateway_main

+      get '/index/static/?' do
+        # TODO: filter out repositories that are not tied to the (optional) authenticated host


What's the plan with this TODO?

After this merges we're going to implement filtering the index by host. Originally I was thinking of doing that at the same time but it depends on another PR, so I'm just saving my code for the next developer who comes by.

ekohl · 2025-06-26T21:20:22Z

lib/smart_proxy_container_gateway/container_gateway_api.rb

+        # end
+
+        # pulp_index = JSON.parse(pulp_response.body)
+        # pulp_index["Results"] = pulp_index["Results"].select { |result| catalog.include?(result["Name"]) }


I wonder if it's cheaper to inline the change

Suggested change

# pulp_index["Results"] = pulp_index["Results"].select { |result| catalog.include?(result["Name"]) }

# pulp_index["Results"].select! { |result| catalog.include?(result["Name"]) }

Yeah, that should be a bit better.

ianballou · 2025-06-26T21:59:29Z

lib/smart_proxy_container_gateway/container_gateway_main.rb

+      def flatpak_static_index(headers, params = {})
+        uri = URI.parse("#{@pulp_endpoint}/pulpcore_registry/index/static")
+        unless params.empty?
+          uri.query = URI.encode_www_form(params)


For now, I'm going with encode_www_form since encode_uri_component isn't available in the versions of Ruby we use (3.0).

I found https://bibwild.wordpress.com/2023/02/14/escaping-encoding-uri-components-in-ruby-3-2/ as a very good write up of he mess. encode_www_form is invalid because it encodes a space as + instead of %20. It points to the very unlikely ERB::Util.url_encode as a cross version compatible API.

I did some research before and + subbed for seems to be regarded as safe in the query string, at least according to forums. This misguidance is probably what blog refers to in the "Why is this so confusing and weird?" section. Even then it wasn't super clear - I might've just stumbled upon some forums that were more misguided than others :)

Anyway, it's clear that %20 is most correct. I'd much prefer supporting getting away from using + chars in a strange way.
Including ERB for this does feel a little odd, but it sounds safe enough.

Updated to use ERB::Util.url_encode

sjha4 · 2025-06-27T18:32:15Z

Functionally this is working well..Tested adding proxy as the flatpak remote and able to install apps with basic auth.

sjha4

Ack..This has been working well in my testing..

ianballou · 2025-07-14T15:37:55Z

Since there is an ACK and the previous comments have generally been addressed: merging.

pr-processor bot added the Not yet reviewed label Jun 24, 2025

ianballou mentioned this pull request Jun 24, 2025

Add Apache proxy for flatpak index theforeman/puppet-foreman_proxy_content#522

Merged

vsedmik mentioned this pull request Jun 25, 2025

Extend capsule flatpak endpint parametrization SatelliteQE/robottelo#18807

Merged

ekohl suggested changes Jun 25, 2025

View reviewed changes

pr-processor bot added Waiting on contributor and removed Not yet reviewed labels Jun 25, 2025

ianballou force-pushed the 38530-capsule-static-index branch from 19292ee to 6867afd Compare June 26, 2025 20:41

pr-processor bot added Needs re-review and removed Waiting on contributor Needs re-review labels Jun 26, 2025

ianballou force-pushed the 38530-capsule-static-index branch from 6867afd to e69ca68 Compare June 26, 2025 20:55

ekohl reviewed Jun 26, 2025

View reviewed changes

ianballou force-pushed the 38530-capsule-static-index branch from e69ca68 to 244ca24 Compare June 26, 2025 21:57

ianballou commented Jun 26, 2025

View reviewed changes

ianballou force-pushed the 38530-capsule-static-index branch from 244ca24 to 3e6a1a4 Compare June 27, 2025 18:59

Fixes #38530 - proxy the flatpak index

e3a167f

ianballou force-pushed the 38530-capsule-static-index branch from 3e6a1a4 to e3a167f Compare June 30, 2025 15:03

ianballou requested a review from ekohl June 30, 2025 15:04

sjha4 approved these changes Jul 14, 2025

View reviewed changes

ianballou merged commit 783c450 into Katello:main Jul 14, 2025
12 checks passed

ianballou deleted the 38530-capsule-static-index branch July 14, 2025 15:38

	# pulp_index["Results"] = pulp_index["Results"].select { \|result\| catalog.include?(result["Name"]) }
	# pulp_index["Results"].select! { \|result\| catalog.include?(result["Name"]) }

Fixes #38530 - proxy the flatpak index #54

Fixes #38530 - proxy the flatpak index #54

Conversation

ianballou commented Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ianballou Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ianballou Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ianballou Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sjha4 commented Jun 27, 2025

Uh oh!

sjha4 left a comment

Choose a reason for hiding this comment

Uh oh!

ianballou commented Jul 14, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ianballou commented Jun 24, 2025 •

edited

Loading

ianballou Jun 26, 2025 •

edited

Loading

ianballou Jun 26, 2025 •

edited

Loading

ianballou Jun 27, 2025 •

edited

Loading