Add cloudfront customizable error response (#14)

* Initial commit

* Adding custom_error_response option

* Fixing input

* map[string] to JSON

* Fixing multiple inputs

* Fixing README

* Bumping README

* Fixing default for custom_error_codes

Author: LeoDiazL

README.md

@@ -56,7 +56,7 @@ jobs:
 
     steps:
     - name: Create deploy-bucket
-      uses: bitovi/[email protected].1
+      uses: bitovi/[email protected].2
       with:
         aws_access_key_id: ${{ secrets.AWS_ACCESS_KEY_ID }}
         aws_secret_access_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
@@ -72,6 +72,68 @@ jobs:
         aws_r53_create_sub_cert: true # Will create and validate a cert for this sub-domain
 ```
 
+### Advanced example
+```yaml
+name: Basic deploy
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  deploy-catalog:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Create deploy-bucket
+        uses: bitovi/[email protected]
+        with:
+          aws_access_key_id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws_secret_access_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws_default_region: us-east-1
+
+          aws_site_source_folder: packages/catalog/dist
+          tf_state_file_name_append: catalog
+
+          tf_action: 'apply'
+          tf_state_bucket: 'some-custom-bucket'
+          tf_state_bucket_destroy: true
+
+          aws_site_cdn_enabled: true
+          aws_site_cdn_custom_error_codes: '[{\"error_caching_min_ttl\":\"0\",\"error_code\":\"403\",\"response_code\":\"200\",\"response_page_path\":\"/index.html\"},{\"error_caching_min_ttl\":\"0\",\"error_code\":\"404\",\"response_code\":\"404\",\"response_page_path\":\"/custom_404.html\"}]'
+
+          aws_r53_domain_name: bitovi-sandbox.com
+          aws_r53_sub_domain_name: catalog-mfe
+          aws_r53_create_sub_cert: true
+
+          aws_site_bucket_name: catalog-mfe
+
+  deploy-marketing:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Create deploy-bucket
+        uses: bitovi/[email protected]
+        with:
+          aws_access_key_id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws_secret_access_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws_default_region: us-east-1
+
+          checkout: false
+          aws_site_source_folder: packages/marketing/dist
+          tf_state_file_name_append: marketing
+
+          tf_action: 'apply'
+          tf_state_bucket: 'some-custom-bucket'
+          tf_state_bucket_destroy: true
+
+          aws_site_cdn_enabled: true
+          aws_site_cdn_custom_error_codes: '[{\"error_caching_min_ttl\":\"0\",\"error_code\":\"403\",\"response_code\":\"200\",\"response_page_path\":\"/index.html\"},{\"error_caching_min_ttl\":\"0\",\"error_code\":\"404\",\"response_code\":\"404\",\"response_page_path\":\"/custom_404.html\"}]'
+
+          aws_r53_domain_name: bitovi-sandbox.com
+          aws_r53_sub_domain_name: marketing-mfe
+          aws_r53_create_sub_cert: true
+
+          aws_site_bucket_name: marketing-mfe
+```
+
 ## Customizing
 
 ### Inputs
@@ -122,6 +184,7 @@ The following inputs can be used as `step.with` keys
 | `aws_site_root_object` | Boolean | Root object to be served as entry-point. Defaults to `index.html`. |
 | `aws_site_bucket_name` | String | AWS S3 bucket name to use for the public files. Defaults to `${org}-${repo}-{branch}-sp`. If using a R53 domain and not a CDN, bucket name will be the FQDN one. See note. |
 | `aws_site_cdn_enabled` | Boolean | Enable or disables the use of CDN. Defaults to `false`. |
+| `aws_site_cdn_custom_error_codes` | JSON | Custom error codes to define in CDN. Like `[{\"error_caching_min_ttl\":\"0\",\"error_code\":\"403\",\"response_code\":\"200\",\"response_page_path\":\"/index.html\"}]`. See [this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudfront_distribution.html#custom-error-response-arguments). |
 <hr/>
 <br/>
 

action.yaml

@@ -33,7 +33,7 @@ inputs:
 
   # Terraform options
   tf_action: 
-    desctiption: 'Option to run Terraform apply / destroy option. Will run plan if nothing defined.'
+    description: 'Option to run Terraform apply / destroy option. Will run plan if nothing defined.'
     required: false
   tf_state_file_name:
     description: 'Change this to be anything you want to. Carefull to be consistent here. A missing file could trigger recreation, or stepping over destruction of non-defined objects.'
@@ -61,6 +61,9 @@ inputs:
   aws_site_cdn_enabled:
     description: 'Enable or disables the use of CDN. Defaults to `false`.'
     required: false
+  aws_site_cdn_custom_error_codes:
+    description: 'Customize error codes, Definition done with JSON variables'
+    required: false
 
   # AWS Route53 Domains and Certificates
   aws_r53_domain_name:
@@ -120,6 +123,7 @@ runs:
         AWS_SITE_ROOT_OBJECT: ${{ inputs.aws_site_root_object }}
         AWS_SITE_BUCKET_NAME: ${{ inputs.aws_site_bucket_name }}
         AWS_SITE_CDN_ENABLED: ${{ inputs.aws_site_cdn_enabled }}
+        AWS_SITE_CDN_CUSTOM_ERROR_CODES: ${{ inputs.aws_site_cdn_custom_error_codes }}
         # AWS Route53 Domains abd Certificates
         AWS_R53_DOMAIN_NAME: ${{ inputs.aws_r53_domain_name }}
         AWS_R53_SUB_DOMAIN_NAME: ${{ inputs.aws_r53_sub_domain_name }}

scripts/generate_deploy.sh

@@ -88,6 +88,7 @@ aws_default_region=$(generate_var aws_default_region $AWS_DEFAULT_REGION)
 aws_site_source_folder="aws_site_source_folder = \"${SOURCE_FILES}\""
 aws_site_bucket_name=$(generate_var aws_site_bucket_name $AWS_SITE_BUCKET_NAME)
 aws_site_cdn_enabled=$(generate_var aws_site_cdn_enabled $AWS_SITE_CDN_ENABLED)
+aws_site_cdn_custom_error_codes=$(generate_var aws_site_cdn_custom_error_codes $AWS_SITE_CDN_CUSTOM_ERROR_CODES)
 aws_site_root_object=$(generate_var aws_site_root_object $AWS_SITE_ROOT_OBJECT)
 aws_r53_domain_name=$(generate_var aws_r53_domain_name $AWS_R53_DOMAIN_NAME)
 aws_r53_root_domain_deploy=$(generate_var aws_r53_root_domain_deploy $AWS_R53_ROOT_DOMAIN_DEPLOY)
@@ -107,6 +108,7 @@ $aws_tf_state_bucket
 $aws_site_source_folder
 $aws_site_bucket_name
 $aws_site_cdn_enabled
+$aws_site_cdn_custom_error_codes
 $aws_site_root_object
 $aws_r53_domain_name
 $aws_r53_sub_domain_name

terraform_code/main.tf

@@ -167,6 +167,17 @@ resource "aws_cloudfront_distribution" "cdn_static_site_default_cert" {
     }
   }
 
+  dynamic "custom_error_response" {
+    for_each = { for idx, val in local.aws_site_cdn_custom_error_codes : idx => val }
+
+    content {
+      error_caching_min_ttl = try(custom_error_response.value.error_caching_min_ttl, null)
+      error_code            = custom_error_response.value.error_code
+      response_code         = try(custom_error_response.value.response_code, null)
+      response_page_path    = try(custom_error_response.value.response_page_path, null)
+    }
+  }
+  
   viewer_certificate {
     cloudfront_default_certificate = true 
   }
@@ -211,6 +222,17 @@ resource "aws_cloudfront_distribution" "cdn_static_site" {
     }
   }
 
+  dynamic "custom_error_response" {
+    for_each = { for idx, val in local.aws_site_cdn_custom_error_codes : idx => val }
+
+    content {
+      error_caching_min_ttl = try(custom_error_response.value.error_caching_min_ttl, null)
+      error_code            = custom_error_response.value.error_code
+      response_code         = try(custom_error_response.value.response_code, null)
+      response_page_path    = try(custom_error_response.value.response_page_path, null)
+    }
+  }
+  
   aliases = [ var.aws_r53_root_domain_deploy ? "${var.aws_r53_domain_name}" : "${var.aws_r53_sub_domain_name}.${var.aws_r53_domain_name}" ]
 
   viewer_certificate {
@@ -389,6 +411,9 @@ locals {
     false
   )
 
+  ### Converting JSON to map of strings as GH Actions don't accept map of strings
+  aws_site_cdn_custom_error_codes = jsondecode(var.aws_site_cdn_custom_error_codes)
+
   ### Try looking up for the cert with different names
   acm_arn = try(data.aws_acm_certificate.issued["domain"].arn, try(data.aws_acm_certificate.issued["wildcard"].arn, data.aws_acm_certificate.issued["sub"].arn, ""))
 

terraform_code/variables.tf

@@ -43,6 +43,12 @@ variable "aws_site_cdn_enabled" {
   default     = false
 }
 
+variable "aws_site_cdn_custom_error_codes" {
+  description = "Custom error codes for site"
+  type        = string
+  default     = "{}"
+}
+
 variable "aws_r53_domain_name" {
   description = "root domain name without any subdomains"
   type        = string