fix(apis)!: overwrite api host when provided in config (#245)

# What
- When a custom host is configured, overwrite the host in the api
integration (bring back the parameter mapping method introduced in #229)
- Include origin_path in cloudfront ingest api behavior. Note: this path
will not work until the root_path is changed to `api/ingest` in the
ingest api
- Domain construct now only generates custom subdomains for endpoints
when configured (existing stacks must provide new configuration
variable). _Note: indentation changes that wrap all subdomain constructs
make the change appear larger than they really are. The change removes
an unused shared subdomain construct and only generates api-specific
subdomains when create subdomains configuration is true._

## Environment variable changes
### New
`VEDA_CUSTOM_DOMAIN` optional configuration to provide a complete url
for host overrides in lambda APIs (i.e. `dev.somedomain.com`)
### Removed
`VEDA_DOMAIN_SHARED_SUBDOMAIN` is no longer used (logic is managed with
custom subdomains config below)
### New+Breaking
`VEDA_DOMAIN_CREATE_CUSTOM_SUBDOMAINS` boolean defaults false. Existing
deployments with custom subdomains for each raster and stac api
endpoints need to set this variable to TRUE.

Author: anayeaye

.example.env

@@ -28,3 +28,4 @@ STAC_BROWSER_BUCKET=
 STAC_URL=
 CERT_ARN=
 VEDA_CLOUDFRONT=
+VEDA_CUSTOM_HOST=

domain/infrastructure/config.py

@@ -14,9 +14,12 @@ class vedaDomainSettings(BaseSettings):
     hosted_zone_name: Optional[str] = Field(
         None, description="Custom domain name, i.e. veda-backend.xyz"
     )
-    shared_subdomain: bool = Field(
+    create_custom_subdomains: bool = Field(
         False,
-        description="Create a subdomain for app stage to used for all endpoints, i.e. <stage>.veda-backend.com/api/raster",
+        description=(
+            "When true and hosted zone config is provided, create a unique subdomain for stac and raster apis. "
+            "For example <stage>-stac.<hosted_zone_name> and <stage>-raster.<hosted_zone_name>"
+        ),
     )
     api_prefix: Optional[str] = Field(
         None,

domain/infrastructure/construct.py

@@ -30,10 +30,8 @@ def __init__(
         self.stac_domain_name = None
         self.raster_domain_name = None
 
-        if (
-            veda_domain_settings.hosted_zone_id
-            and veda_domain_settings.hosted_zone_name
-        ):
+        if veda_domain_settings.create_custom_subdomains:
+
             # If alternative custom domain provided, use it instead of the default
             if alt_domain is True:
                 hosted_zone_name = veda_domain_settings.alt_hosted_zone_name
@@ -57,84 +55,65 @@ def __init__(
                 ),
             )
 
-            # Either create one subdomain to share for all endpoints or create a unique subdomain for each
-
-            if not veda_domain_settings.shared_subdomain:
-                # Use custom api prefix if provided or deployment stage if not
-                if veda_domain_settings.api_prefix:
-                    raster_url_prefix = (
-                        f"{veda_domain_settings.api_prefix.lower()}-raster"
-                    )
-                    stac_url_prefix = f"{veda_domain_settings.api_prefix.lower()}-stac"
-                else:
-                    raster_url_prefix = f"{stage.lower()}-raster"
-                    stac_url_prefix = f"{stage.lower()}-stac"
-                raster_domain_name = f"{raster_url_prefix}.{hosted_zone_name}"
-                stac_domain_name = f"{stac_url_prefix}.{hosted_zone_name}"
-
-                self.raster_domain_name = aws_apigatewayv2_alpha.DomainName(
-                    self,
-                    "rasterApiCustomDomain",
-                    domain_name=raster_domain_name,
-                    certificate=certificate,
-                )
-
-                aws_route53.ARecord(
-                    self,
-                    "raster-api-dns-record",
-                    zone=hosted_zone,
-                    target=aws_route53.RecordTarget.from_alias(
-                        aws_route53_targets.ApiGatewayv2DomainProperties(
-                            regional_domain_name=self.raster_domain_name.regional_domain_name,
-                            regional_hosted_zone_id=self.raster_domain_name.regional_hosted_zone_id,
-                        )
-                    ),
-                    # Note: CDK will append the hosted zone name (eg: `veda-backend.xyz` to this record name)
-                    record_name=raster_url_prefix,
-                )
+            # Use custom api prefix if provided or deployment stage if not
+            if veda_domain_settings.api_prefix:
+                raster_url_prefix = f"{veda_domain_settings.api_prefix.lower()}-raster"
+                stac_url_prefix = f"{veda_domain_settings.api_prefix.lower()}-stac"
+            else:
+                raster_url_prefix = f"{stage.lower()}-raster"
+                stac_url_prefix = f"{stage.lower()}-stac"
+            raster_domain_name = f"{raster_url_prefix}.{hosted_zone_name}"
+            stac_domain_name = f"{stac_url_prefix}.{hosted_zone_name}"
 
-                self.stac_domain_name = aws_apigatewayv2_alpha.DomainName(
-                    self,
-                    "stacApiCustomDomain",
-                    domain_name=stac_domain_name,
-                    certificate=certificate,
-                )
+            self.raster_domain_name = aws_apigatewayv2_alpha.DomainName(
+                self,
+                "rasterApiCustomDomain",
+                domain_name=raster_domain_name,
+                certificate=certificate,
+            )
 
-                aws_route53.ARecord(
-                    self,
-                    "stac-api-dns-record",
-                    zone=hosted_zone,
-                    target=aws_route53.RecordTarget.from_alias(
-                        aws_route53_targets.ApiGatewayv2DomainProperties(
-                            regional_domain_name=self.stac_domain_name.regional_domain_name,
-                            regional_hosted_zone_id=self.stac_domain_name.regional_hosted_zone_id,
-                        )
-                    ),
-                    # Note: CDK will append the hosted zone name (eg: `veda-backend.xyz` to this record name)
-                    record_name=stac_url_prefix,
-                )
+            aws_route53.ARecord(
+                self,
+                "raster-api-dns-record",
+                zone=hosted_zone,
+                target=aws_route53.RecordTarget.from_alias(
+                    aws_route53_targets.ApiGatewayv2DomainProperties(
+                        regional_domain_name=self.raster_domain_name.regional_domain_name,
+                        regional_hosted_zone_id=self.raster_domain_name.regional_hosted_zone_id,
+                    )
+                ),
+                # Note: CDK will append the hosted zone name (eg: `veda-backend.xyz` to this record name)
+                record_name=raster_url_prefix,
+            )
 
-                CfnOutput(
-                    self,
-                    "raster-api",
-                    value=f"https://{raster_url_prefix}.{hosted_zone_name}/docs",
-                )
-                CfnOutput(
-                    self,
-                    "stac-api",
-                    value=f"https://{stac_url_prefix}.{hosted_zone_name}/",
-                )
+            self.stac_domain_name = aws_apigatewayv2_alpha.DomainName(
+                self,
+                "stacApiCustomDomain",
+                domain_name=stac_domain_name,
+                certificate=certificate,
+            )
 
-            if veda_domain_settings.shared_subdomain:
-                self.shared_sub_domain_name = aws_apigatewayv2_alpha.DomainName(
-                    self,
-                    "cfSharedApiCustomDomain",
-                    domain_name=f"{stage}.{hosted_zone_name}",
-                    certificate=certificate,
-                )
+            aws_route53.ARecord(
+                self,
+                "stac-api-dns-record",
+                zone=hosted_zone,
+                target=aws_route53.RecordTarget.from_alias(
+                    aws_route53_targets.ApiGatewayv2DomainProperties(
+                        regional_domain_name=self.stac_domain_name.regional_domain_name,
+                        regional_hosted_zone_id=self.stac_domain_name.regional_hosted_zone_id,
+                    )
+                ),
+                # Note: CDK will append the hosted zone name (eg: `veda-backend.xyz` to this record name)
+                record_name=stac_url_prefix,
+            )
 
-                CfnOutput(
-                    self,
-                    "shared-sub-domain-name",
-                    value=f"https://{stage}.{hosted_zone_name}/",
-                )
+            CfnOutput(
+                self,
+                "raster-api",
+                value=f"https://{raster_url_prefix}.{hosted_zone_name}/docs",
+            )
+            CfnOutput(
+                self,
+                "stac-api",
+                value=f"https://{stac_url_prefix}.{hosted_zone_name}/",
+            )

raster_api/infrastructure/config.py

@@ -74,6 +74,11 @@ class vedaRasterSettings(BaseSettings):
         description="Optional root path for all api endpoints",
     )
 
+    custom_host: str = Field(
+        None,
+        description="Complete url of custom host including subdomain. When provided, override host in api integration",
+    )
+
     class Config:
         """model config"""
 

raster_api/infrastructure/construct.py

@@ -87,6 +87,14 @@ def __init__(
             )
 
         integration_kwargs = dict(handler=veda_raster_function)
+        if veda_raster_settings.custom_host:
+            integration_kwargs[
+                "parameter_mapping"
+            ] = aws_apigatewayv2_alpha.ParameterMapping().overwrite_header(
+                "host",
+                aws_apigatewayv2_alpha.MappingValue(veda_raster_settings.custom_host),
+            )
+
         raster_api_integration = (
             aws_apigatewayv2_integrations_alpha.HttpLambdaIntegration(
                 construct_id,

routes/infrastructure/construct.py

@@ -86,6 +86,7 @@ def __init__(
                         origin=origins.HttpOrigin(
                             urlparse(veda_route_settings.ingest_url).hostname,
                             origin_id="ingest-api",
+                            origin_path=f"/{stage}",
                         ),
                         cache_policy=cf.CachePolicy.CACHING_DISABLED,
                         allowed_methods=cf.AllowedMethods.ALLOW_ALL,

stac_api/infrastructure/config.py

@@ -23,6 +23,11 @@ class vedaSTACSettings(BaseSettings):
         description="Optional path prefix to add to all api endpoints",
     )
 
+    custom_host: str = Field(
+        None,
+        description="Complete url of custom host including subdomain. When provided, override host in api integration",
+    )
+
     class Config:
         """model config"""
 

stac_api/infrastructure/construct.py

@@ -81,6 +81,13 @@ def __init__(
         )
 
         integration_kwargs = dict(handler=lambda_function)
+        if veda_stac_settings.custom_host:
+            integration_kwargs[
+                "parameter_mapping"
+            ] = aws_apigatewayv2_alpha.ParameterMapping().overwrite_header(
+                "host",
+                aws_apigatewayv2_alpha.MappingValue(veda_stac_settings.custom_host),
+            )
         stac_api_integration = (
             aws_apigatewayv2_integrations_alpha.HttpLambdaIntegration(
                 construct_id,