@gradientedge/cdk-utils 9.63.0 → 9.65.0

package/dist/src/lib/azure/common/construct.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommonAzureConstruct = void 0;
 const provider_1 = require("@cdktf/provider-azurerm/lib/provider");
 const provider_2 = require("../.gen/providers/azapi/provider");
+const cdktf_local_exec_1 = require("cdktf-local-exec");
 const data_azurerm_client_config_1 = require("@cdktf/provider-azurerm/lib/data-azurerm-client-config");
 const cdktf_1 = require("cdktf");
 const common_1 = require("../../common");
@@ -52,6 +53,7 @@ class CommonAzureConstruct extends cdktf_1.TerraformStack {
         this.determineTenantId();
         new provider_2.AzapiProvider(this, `${this.id}-azapi-provider`, this.props);
         new provider_1.AzurermProvider(this, `${this.id}-provider`, this.props);
+        new cdktf_local_exec_1.Provider(this, `${this.id}-local-exec-provider`);
     }
     /**
      * @summary Determine the fully qualified domain name based on domainName & subDomain

package/dist/src/lib/azure/services/api-management/main.js

@@ -216,10 +216,107 @@ class AzureApiManagementManager {
             (0, utils_1.createAzureTfOutput)(`${id}-${operation.displayName}-${operation.method}-apimOperationOperationId`, scope, apimOperation.operationId);
             (0, utils_1.createAzureTfOutput)(`${id}-${operation.displayName}-${operation.method}-apimOperationFriendlyUniqueId`, scope, apimOperation.friendlyUniqueId);
             (0, utils_1.createAzureTfOutput)(`${id}-${operation.displayName}-${operation.method}-apimOperationId`, scope, apimOperation.id);
+            // Define Caching Policy if enabled
+            let cacheInboundPolicy = '';
+            let cacheOutboundPolicy = '';
+            if (props.caching?.enabled === true) {
+                if (operation.method === 'get') {
+                    cacheInboundPolicy = `<!-- Generate a comprehensive custom cache key (without query params or Accept header) -->
+              <set-variable name="customCacheKey" value="@{
+                  // Instance identification
+                  
+                  // API identification
+                  string apiName = context.Api.Name.Replace(" ", "").ToLower();
+                  string apiVersion = context.Api.Version ?? "v1";
+                  
+                  // Full path construction (without query parameters)
+                  string fullPath = context.Request.Url.Path.ToLower();
+                                    
+                  // Construct final cache key (no Accept header needed for JSON-only APIs)
+                  return $"{apiName}:{apiVersion}:{fullPath}";
+              }" />
+              <set-variable name="bypassCache" value="@(context.Request.Headers.GetValueOrDefault("X-Bypass-Cache", "false").ToLower())" />
+
+              <choose>
+                  <when condition="@((string)context.Variables["bypassCache"] != "true")">
+                      <!-- Attempt to retrieve cached response -->
+                      <cache-lookup-value key="@((string)context.Variables["customCacheKey"])" variable-name="cachedResponse" />
+
+                      <!-- If cache hit, return cached response -->
+                      <choose>
+                          <when condition="@(context.Variables.ContainsKey("cachedResponse"))">
+                              <return-response>
+                                  <set-status code="200" reason="OK" />
+                                  <set-header name="Content-Type" exists-action="override">
+                                      <value>application/json</value>
+                                  </set-header>
+                                  <set-header name="X-Apim-Cache-Status" exists-action="override">
+                                      <value>HIT</value>
+                                  </set-header>
+                                  <set-header name="X-Apim-Cache-Key" exists-action="override">
+                                      <value>@((string)context.Variables["customCacheKey"])</value>
+                                  </set-header>
+                                  <set-body>@((string)context.Variables["cachedResponse"])</set-body>
+                              </return-response>
+                          </when>
+                      </choose>
+                  </when>
+              </choose>`;
+                    cacheOutboundPolicy = `<choose>
+                  <when condition="@((string)context.Variables["bypassCache"] != "true")">
+                      <!-- Store the response body in cache -->
+                      <choose>
+                          <when condition="@(context.Response.StatusCode == 200)">
+                              <cache-store-value key="@((string)context.Variables["customCacheKey"])" value="@(context.Response.Body.As<string>(preserveContent: true))" duration="${props.caching.ttl ?? 900}" />
+                              <!-- Add cache status header -->
+                              <set-header name="X-Apim-Cache-Status" exists-action="override">
+                                  <value>MISS</value>
+                              </set-header>
+                          </when>
+                      </choose>
+                      <!-- Add debug headers -->
+                      <set-header name="X-Apim-Cache-Key" exists-action="override">
+                          <value>@((string)context.Variables["customCacheKey"])</value>
+                      </set-header>
+                      <set-header name="X-Apim-API-Name" exists-action="override">
+                          <value>@(context.Api.Name)</value>
+                      </set-header>
+                  </when>
+              </choose>`;
+                }
+                if (operation.method === 'post') {
+                    cacheInboundPolicy = `<!-- Generate a comprehensive custom cache key (without query params or Accept header) -->
+              <set-variable name="customCacheKey" value="@{
+                  // Instance identification
+                  
+                  // API identification
+                  string apiName = context.Api.Name.Replace(" ", "").ToLower();
+                  string apiVersion = context.Api.Version ?? "v1";
+                  
+                  // Full path construction (without query parameters)
+                  string fullPath = context.Request.Url.Path.ToLower();
+                                    
+                  // Construct final cache key (no Accept header needed for JSON-only APIs)
+                  return $"{apiName}:{apiVersion}:{fullPath}";
+              }" />
+              <set-variable name="clearCache" value="@(context.Request.Headers.GetValueOrDefault("X-Apim-Clear-Cache", "false").ToLower())" />
+
+              <!-- Allow admin to clear specific cache entries -->
+              <choose>
+                  <when condition="@((string)context.Variables["clearCache"] == "true")">
+                      <cache-remove-value key="@((string)context.Variables["customCacheKey"])" />
+                      <return-response>
+                          <set-status code="200" reason="OK" />
+                          <set-body>Cache entry removed successfully</set-body>
+                      </return-response>
+                  </when>
+              </choose>`;
+                }
+            }
             const policyXmlContent = `<policies>
         <inbound>
           <base />
-          ${operation.cacheInboundPolicy ?? ''}
+          ${cacheInboundPolicy}
           ${props.commonInboundPolicyXml ?? ''}
         </inbound>
         <backend>
@@ -227,7 +324,7 @@ class AzureApiManagementManager {
         </backend>
         <outbound>
           <base />
-          ${operation.cacheOutboundPolicy ?? ''}
+          ${cacheOutboundPolicy ?? ''}
           ${props.commonOutboundPolicyXml ?? ''}
         </outbound>
         <on-error>

package/dist/src/lib/azure/services/api-management/types.d.ts

@@ -14,11 +14,14 @@ export interface ApiManagementApiProps extends ApiManagementApiConfig {
     operations: ApiManagementApiOperationProps[];
     commonInboundPolicyXml: string;
     commonOutboundPolicyXml: string;
+    caching?: ApiManagementApiCaching;
 }
 export interface ApiManagementV2Props extends ApiManagementConfig {
     body: any;
 }
 export interface ApiManagementApiOperationProps extends ApiManagementApiOperationConfig {
-    cacheInboundPolicy: string;
-    cacheOutboundPolicy: string;
+}
+export interface ApiManagementApiCaching {
+    enabled: boolean;
+    ttl?: number;
 }

package/dist/src/lib/azure/services/function/main.js

@@ -5,7 +5,6 @@ const data_azurerm_resource_group_1 = require("@cdktf/provider-azurerm/lib/data-
 const linux_function_app_1 = require("@cdktf/provider-azurerm/lib/linux-function-app");
 const function_app_function_1 = require("@cdktf/provider-azurerm/lib/function-app-function");
 const function_app_flex_consumption_1 = require("@cdktf/provider-azurerm/lib/function-app-flex-consumption");
-const cdktf_local_exec_1 = require("cdktf-local-exec");
 const utils_1 = require("../../utils");
 /**
  * @classdesc Provides operations on Azure Functions
@@ -113,29 +112,6 @@ class AzureFunctionManager {
                 environment: scope.props.stage,
             },
         });
-        new cdktf_local_exec_1.Provider(scope, `${id}-local-exec-provider`);
-        // Deploy function app zip package with up to 3 retry attempts.
-        // This handles transient issues like HTTP 503s returned from the Azure Kudu deployment endpoint.
-        new cdktf_local_exec_1.LocalExec(scope, `${id}-function-app-deploy`, {
-            triggers: {
-                hash: props.sourceCodeHash,
-            },
-            command: `
-        set -e
-        MAX_RETRIES=3
-        RETRY_COUNT=0
-        until az functionapp deployment source config-zip --resource-group "${resourceGroup.name}" --name "${functionApp.name}" --src "${props.deploySource}"; do
-          RETRY_COUNT=$((RETRY_COUNT+1))
-          echo "Deployment attempt $RETRY_COUNT failed. Retrying in 10 seconds..."
-          if [ "$RETRY_COUNT" -ge "$MAX_RETRIES" ]; then
-            echo "Deployment failed after $MAX_RETRIES attempts."
-            exit 1
-          fi
-          sleep 10
-        done
-        echo "Deployment succeeded."
-      `,
-        });
         return functionApp;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "9.63.0",
+  "version": "9.65.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {

package/src/lib/azure/common/construct.ts

@@ -1,5 +1,6 @@
 import { AzurermProvider } from '@cdktf/provider-azurerm/lib/provider'
 import { AzapiProvider } from '../.gen/providers/azapi/provider'
+import { Provider } from 'cdktf-local-exec'
 import { DataAzurermClientConfig } from '@cdktf/provider-azurerm/lib/data-azurerm-client-config'
 import { AzurermBackend, TerraformStack } from 'cdktf'
 import { Construct } from 'constructs'
@@ -72,6 +73,7 @@ export class CommonAzureConstruct extends TerraformStack {
 
     new AzapiProvider(this, `${this.id}-azapi-provider`, this.props)
     new AzurermProvider(this, `${this.id}-provider`, this.props)
+    new Provider(this, `${this.id}-local-exec-provider`)
   }
 
   /**

package/src/lib/azure/services/api-management/main.ts

@@ -272,10 +272,110 @@ export class AzureApiManagementManager {
       )
       createAzureTfOutput(`${id}-${operation.displayName}-${operation.method}-apimOperationId`, scope, apimOperation.id)
 
+      // Define Caching Policy if enabled
+      let cacheInboundPolicy = ''
+      let cacheOutboundPolicy = ''
+
+      if (props.caching?.enabled === true) {
+        if (operation.method === 'get') {
+          cacheInboundPolicy = `<!-- Generate a comprehensive custom cache key (without query params or Accept header) -->
+              <set-variable name="customCacheKey" value="@{
+                  // Instance identification
+                  
+                  // API identification
+                  string apiName = context.Api.Name.Replace(" ", "").ToLower();
+                  string apiVersion = context.Api.Version ?? "v1";
+                  
+                  // Full path construction (without query parameters)
+                  string fullPath = context.Request.Url.Path.ToLower();
+                                    
+                  // Construct final cache key (no Accept header needed for JSON-only APIs)
+                  return $"{apiName}:{apiVersion}:{fullPath}";
+              }" />
+              <set-variable name="bypassCache" value="@(context.Request.Headers.GetValueOrDefault("X-Bypass-Cache", "false").ToLower())" />
+
+              <choose>
+                  <when condition="@((string)context.Variables["bypassCache"] != "true")">
+                      <!-- Attempt to retrieve cached response -->
+                      <cache-lookup-value key="@((string)context.Variables["customCacheKey"])" variable-name="cachedResponse" />
+
+                      <!-- If cache hit, return cached response -->
+                      <choose>
+                          <when condition="@(context.Variables.ContainsKey("cachedResponse"))">
+                              <return-response>
+                                  <set-status code="200" reason="OK" />
+                                  <set-header name="Content-Type" exists-action="override">
+                                      <value>application/json</value>
+                                  </set-header>
+                                  <set-header name="X-Apim-Cache-Status" exists-action="override">
+                                      <value>HIT</value>
+                                  </set-header>
+                                  <set-header name="X-Apim-Cache-Key" exists-action="override">
+                                      <value>@((string)context.Variables["customCacheKey"])</value>
+                                  </set-header>
+                                  <set-body>@((string)context.Variables["cachedResponse"])</set-body>
+                              </return-response>
+                          </when>
+                      </choose>
+                  </when>
+              </choose>`
+          cacheOutboundPolicy = `<choose>
+                  <when condition="@((string)context.Variables["bypassCache"] != "true")">
+                      <!-- Store the response body in cache -->
+                      <choose>
+                          <when condition="@(context.Response.StatusCode == 200)">
+                              <cache-store-value key="@((string)context.Variables["customCacheKey"])" value="@(context.Response.Body.As<string>(preserveContent: true))" duration="${props.caching.ttl ?? 900}" />
+                              <!-- Add cache status header -->
+                              <set-header name="X-Apim-Cache-Status" exists-action="override">
+                                  <value>MISS</value>
+                              </set-header>
+                          </when>
+                      </choose>
+                      <!-- Add debug headers -->
+                      <set-header name="X-Apim-Cache-Key" exists-action="override">
+                          <value>@((string)context.Variables["customCacheKey"])</value>
+                      </set-header>
+                      <set-header name="X-Apim-API-Name" exists-action="override">
+                          <value>@(context.Api.Name)</value>
+                      </set-header>
+                  </when>
+              </choose>`
+        }
+
+        if (operation.method === 'post') {
+          cacheInboundPolicy = `<!-- Generate a comprehensive custom cache key (without query params or Accept header) -->
+              <set-variable name="customCacheKey" value="@{
+                  // Instance identification
+                  
+                  // API identification
+                  string apiName = context.Api.Name.Replace(" ", "").ToLower();
+                  string apiVersion = context.Api.Version ?? "v1";
+                  
+                  // Full path construction (without query parameters)
+                  string fullPath = context.Request.Url.Path.ToLower();
+                                    
+                  // Construct final cache key (no Accept header needed for JSON-only APIs)
+                  return $"{apiName}:{apiVersion}:{fullPath}";
+              }" />
+              <set-variable name="clearCache" value="@(context.Request.Headers.GetValueOrDefault("X-Apim-Clear-Cache", "false").ToLower())" />
+
+              <!-- Allow admin to clear specific cache entries -->
+              <choose>
+                  <when condition="@((string)context.Variables["clearCache"] == "true")">
+                      <cache-remove-value key="@((string)context.Variables["customCacheKey"])" />
+                      <return-response>
+                          <set-status code="200" reason="OK" />
+                          <set-body>Cache entry removed successfully</set-body>
+                      </return-response>
+                  </when>
+              </choose>`
+        }
+      }
+
       const policyXmlContent = `<policies>
         <inbound>
           <base />
-          ${operation.cacheInboundPolicy ?? ''}
+          ${cacheInboundPolicy}
           ${props.commonInboundPolicyXml ?? ''}
         </inbound>
         <backend>
@@ -283,7 +383,7 @@ export class AzureApiManagementManager {
         </backend>
         <outbound>
           <base />
-          ${operation.cacheOutboundPolicy ?? ''}
+          ${cacheOutboundPolicy ?? ''}
           ${props.commonOutboundPolicyXml ?? ''}
         </outbound>
         <on-error>

package/src/lib/azure/services/api-management/types.ts

@@ -16,13 +16,16 @@ export interface ApiManagementApiProps extends ApiManagementApiConfig {
   operations: ApiManagementApiOperationProps[]
   commonInboundPolicyXml: string
   commonOutboundPolicyXml: string
+  caching?: ApiManagementApiCaching
 }
 
 export interface ApiManagementV2Props extends ApiManagementConfig {
   body: any
 }
 
-export interface ApiManagementApiOperationProps extends ApiManagementApiOperationConfig {
-  cacheInboundPolicy: string
-  cacheOutboundPolicy: string
+export interface ApiManagementApiOperationProps extends ApiManagementApiOperationConfig {}
+
+export interface ApiManagementApiCaching {
+  enabled: boolean
+  ttl?: number
 }

package/src/lib/azure/services/function/main.ts

@@ -2,7 +2,6 @@ import { DataAzurermResourceGroup } from '@cdktf/provider-azurerm/lib/data-azure
 import { LinuxFunctionApp } from '@cdktf/provider-azurerm/lib/linux-function-app'
 import { FunctionAppFunction } from '@cdktf/provider-azurerm/lib/function-app-function'
 import { FunctionAppFlexConsumption } from '@cdktf/provider-azurerm/lib/function-app-flex-consumption'
-import { LocalExec, Provider } from 'cdktf-local-exec'
 import { CommonAzureConstruct } from '../../common'
 import { createAzureTfOutput } from '../../utils'
 import { FunctionAppProps, FunctionProps, FunctionAppFlexConsumptionProps } from './types'
@@ -126,30 +125,6 @@ export class AzureFunctionManager {
       },
     })
 
-    new Provider(scope, `${id}-local-exec-provider`)
-    // Deploy function app zip package with up to 3 retry attempts.
-    // This handles transient issues like HTTP 503s returned from the Azure Kudu deployment endpoint.
-    new LocalExec(scope, `${id}-function-app-deploy`, {
-      triggers: {
-        hash: props.sourceCodeHash,
-      },
-      command: `
-        set -e
-        MAX_RETRIES=3
-        RETRY_COUNT=0
-        until az functionapp deployment source config-zip --resource-group "${resourceGroup.name}" --name "${functionApp.name}" --src "${props.deploySource}"; do
-          RETRY_COUNT=$((RETRY_COUNT+1))
-          echo "Deployment attempt $RETRY_COUNT failed. Retrying in 10 seconds..."
-          if [ "$RETRY_COUNT" -ge "$MAX_RETRIES" ]; then
-            echo "Deployment failed after $MAX_RETRIES attempts."
-            exit 1
-          fi
-          sleep 10
-        done
-        echo "Deployment succeeded."
-      `,
-    })
-
     return functionApp
   }
 }