-
Notifications
You must be signed in to change notification settings - Fork 271
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(operator): Add support for properly configuring the CORS allowed origins header #5906
Changes from 2 commits
3382f2c
16c411b
15a5a64
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
package io.apicurio.registry.operator.feat; | ||
|
||
import io.apicurio.registry.operator.EnvironmentVariables; | ||
import io.apicurio.registry.operator.api.v1.ApicurioRegistry3; | ||
import io.apicurio.registry.operator.api.v1.ApicurioRegistry3Spec; | ||
import io.apicurio.registry.operator.api.v1.spec.ComponentSpec; | ||
import io.apicurio.registry.operator.resource.ResourceFactory; | ||
import io.apicurio.registry.operator.utils.IngressUtils; | ||
import io.fabric8.kubernetes.api.model.EnvVar; | ||
import io.fabric8.kubernetes.api.model.EnvVarBuilder; | ||
|
||
import java.util.Arrays; | ||
import java.util.LinkedHashMap; | ||
import java.util.Optional; | ||
import java.util.Set; | ||
import java.util.TreeSet; | ||
|
||
/** | ||
* Helper class used to handle CORS related configuration. | ||
*/ | ||
public class Cors { | ||
/** | ||
* Configure the QUARKUS_HTTP_CORS_ORIGINS environment variable with the following: | ||
* <ul> | ||
* <li>Add the ingress host</li> | ||
* <li>Include anything specifically configured for QUARKUS_HTTP_CORS_ORIGINS in the "env" section</li> | ||
* </ul> | ||
* | ||
* @param primary | ||
* @param envVars | ||
*/ | ||
public static void configureAllowedOrigins(ApicurioRegistry3 primary, | ||
LinkedHashMap<String, EnvVar> envVars) { | ||
TreeSet<String> allowedOrigins = new TreeSet<>(); | ||
|
||
// If the QUARKUS_HTTP_CORS_ORIGINS env var is configured in the "env" section of the CR, | ||
// then make sure to add those configured values to the set of allowed origins we want to | ||
// configure. | ||
Optional.ofNullable(primary.getSpec()).map(ApicurioRegistry3Spec::getApp).map(ComponentSpec::getEnv) | ||
.ifPresent(env -> { | ||
env.stream().filter( | ||
envVar -> envVar.getName().equals(EnvironmentVariables.QUARKUS_HTTP_CORS_ORIGINS)) | ||
.forEach(envVar -> { | ||
Optional.ofNullable(envVar.getValue()).ifPresent(envVarValue -> { | ||
Arrays.stream(envVarValue.split(",")).forEach(allowedOrigins::add); | ||
}); | ||
}); | ||
}); | ||
|
||
// If there is a configured Ingress host for the UI or the Studio UI, add them to the allowed origins. | ||
Set.of(ResourceFactory.COMPONENT_UI, ResourceFactory.COMPONENT_STUDIO_UI).forEach(component -> { | ||
String host = IngressUtils.getConfiguredHost(component, primary); | ||
if (host != null) { | ||
allowedOrigins.add("http://" + host); | ||
allowedOrigins.add("https://" + host); | ||
} | ||
}); | ||
|
||
if (allowedOrigins.isEmpty()) { | ||
allowedOrigins.add("*"); | ||
} | ||
|
||
// Join the values in allowedOrigins into a String and set it as the new value of the env var. | ||
String envVarValue = String.join(",", allowedOrigins); | ||
envVars.put(EnvironmentVariables.QUARKUS_HTTP_CORS_ORIGINS, new EnvVarBuilder() | ||
.withName(EnvironmentVariables.QUARKUS_HTTP_CORS_ORIGINS).withValue(envVarValue).build()); | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,6 +24,14 @@ public class Mapper { | |
YAML_MAPPER.configure(FAIL_ON_UNKNOWN_PROPERTIES, true); | ||
} | ||
|
||
public static <T> T deserialize(String data, Class<T> klass) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Similar functionality is already in There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same answer as above. |
||
try { | ||
return YAML_MAPPER.readValue(data, klass); | ||
} catch (JsonProcessingException ex) { | ||
throw new OperatorException("Could not deserialize resource.", ex); | ||
} | ||
} | ||
|
||
public static String toYAML(Object value) { | ||
try { | ||
return YAML_MAPPER.writeValueAsString(value); | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
package io.apicurio.registry.operator.unit; | ||
|
||
import io.apicurio.registry.operator.EnvironmentVariables; | ||
import io.apicurio.registry.operator.OperatorException; | ||
import io.apicurio.registry.operator.api.v1.ApicurioRegistry3; | ||
import io.apicurio.registry.operator.feat.Cors; | ||
import io.apicurio.registry.operator.utils.Mapper; | ||
import io.fabric8.kubernetes.api.model.EnvVar; | ||
import org.assertj.core.api.Assertions; | ||
import org.junit.jupiter.api.Test; | ||
|
||
import java.nio.charset.Charset; | ||
import java.util.LinkedHashMap; | ||
import java.util.Set; | ||
|
||
public class CorsTest { | ||
|
||
private static final String DEFAULT = """ | ||
apiVersion: registry.apicur.io/v1 | ||
kind: ApicurioRegistry3 | ||
metadata: | ||
name: simple | ||
spec: {} | ||
"""; | ||
|
||
private static final String WITH_INGRESS = """ | ||
apiVersion: registry.apicur.io/v1 | ||
kind: ApicurioRegistry3 | ||
metadata: | ||
name: simple | ||
spec: | ||
app: | ||
ingress: | ||
host: simple-app.apps.cluster.example | ||
ui: | ||
ingress: | ||
host: simple-ui.apps.cluster.example | ||
"""; | ||
|
||
private static final String WITH_ENV_VAR = """ | ||
apiVersion: registry.apicur.io/v1 | ||
kind: ApicurioRegistry3 | ||
metadata: | ||
name: simple | ||
spec: | ||
app: | ||
env: | ||
- name: QUARKUS_HTTP_CORS_ORIGINS | ||
value: https://ui.example.org | ||
"""; | ||
|
||
private static final String WITH_ENV_VAR_AND_INGRESS = """ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we should use the files in (BTW similarly I have an aspiration to eventually do the same thing for the registry examples and run them as tests). There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I was having trouble getting those resources to load in a unit test vs an IT test (the context classloader is different). I didn't want to duplicate the resource loading, but I can of course. I'll go ahead and move these into |
||
apiVersion: registry.apicur.io/v1 | ||
kind: ApicurioRegistry3 | ||
metadata: | ||
name: simple | ||
spec: | ||
app: | ||
ingress: | ||
host: simple-app.apps.cluster.example | ||
env: | ||
- name: QUARKUS_HTTP_CORS_ORIGINS | ||
value: https://ui.example.org | ||
ui: | ||
ingress: | ||
host: simple-ui.apps.cluster.example | ||
"""; | ||
|
||
@Test | ||
public void testConfigureAllowedOrigins() throws Exception { | ||
doTestAllowedOrigins(DEFAULT, "*"); | ||
doTestAllowedOrigins(WITH_INGRESS, "http://simple-ui.apps.cluster.example", | ||
"https://simple-ui.apps.cluster.example"); | ||
doTestAllowedOrigins(WITH_ENV_VAR, "https://ui.example.org"); | ||
doTestAllowedOrigins(WITH_ENV_VAR_AND_INGRESS, "http://simple-ui.apps.cluster.example", | ||
"https://simple-ui.apps.cluster.example", "https://ui.example.org"); | ||
} | ||
|
||
private void doTestAllowedOrigins(String cr, String... values) { | ||
ApicurioRegistry3 registry = Mapper.deserialize(cr, ApicurioRegistry3.class); | ||
|
||
LinkedHashMap<String, EnvVar> envVars = new LinkedHashMap<>(); | ||
Cors.configureAllowedOrigins(registry, envVars); | ||
Assertions.assertThat(envVars.keySet()).contains(EnvironmentVariables.QUARKUS_HTTP_CORS_ORIGINS); | ||
String allowedOriginsValue = envVars.get(EnvironmentVariables.QUARKUS_HTTP_CORS_ORIGINS).getValue(); | ||
Set<String> allowedOrigins = Set.of(allowedOriginsValue.split(",")); | ||
Assertions.assertThat(allowedOrigins).containsExactlyInAnyOrder(values); | ||
} | ||
|
||
public static String load(String path) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Similar functionality is already in There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The resource loading in |
||
try (var stream = Thread.currentThread().getContextClassLoader().getResourceAsStream(path)) { | ||
return new String(stream.readAllBytes(), Charset.defaultCharset()); | ||
} catch (Exception ex) { | ||
throw new OperatorException("Could not read resource: " + path, ex); | ||
} | ||
} | ||
|
||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a valid functionality, but I think we should follow a principle regarding configuration in the
env
section:The user should be able to completely override any env. variable set by the operator. i.e. we should not touch variables set by the user, and they should override the ones set by the operator.
The advantage of this is that (together with PTS), there is a workaround for users to handle most situations even if there is a bug in the operator (e.g. setting an incorrect env. var value), or there is some circumstance we were not able to predict. This is also simple to explain to the users.
Disadvantage might be a slight decrease in user experience, where the operator could do more things automatically, but I don't think this would affect a lot of feature.
WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: The method
io.apicurio.registry.operator.resource.app.AppDeploymentResource#addEnvVar
is designed to do this, and we should consolidate a way env. vars are added to a handful of methods, maybe inEnvironmentVariables
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you mean that the value configured in the
env
section should take precedent (override) the rest of the logic? I can see why that makes sense. Please confirm and I'll change it.