@gradientedge/cdk-utils 10.8.0 → 11.1.0

package/src/lib/cloudflare/common/stack.ts

@@ -1,132 +0,0 @@
-import { ComponentResource, ComponentResourceOptions, Config } from '@pulumi/pulumi'
-import appRoot from 'app-root-path'
-import fs from 'fs'
-import _ from 'lodash'
-import path from 'path'
-import { isDevStage } from '../../common/index.js'
-import { CommonCloudflareConstruct } from './construct.js'
-import { CommonCloudflareStackProps } from './types.js'
-
-/**
- * @classdesc Common stack to use as a base for all higher level constructs.
- * @example
- * import { CommonCloudflareStack } from '@gradientedge/cdk-utils'
- *
- * class CustomStack extends CommonCloudflareStack {
- *   constructor(parent: App, name: string, props: StackProps) {
- *     super(parent, name, props)
- *     // provision resources
- *   }
- * }
- */
-export class CommonCloudflareStack extends ComponentResource {
-  construct: CommonCloudflareConstruct
-  props: CommonCloudflareStackProps
-  config: Config
-
-  constructor(name: string, props: CommonCloudflareStackProps, options?: ComponentResourceOptions) {
-    super(`custom:cloudflare:Stack:${name}`, name, props, options)
-
-    /* initialise config */
-    this.config = new Config()
-    this.props = this.determineConstructProps(props)
-  }
-
-  /**
-   * @summary Method to determine the core CDK construct properties injected via context
-   * @param props The stack properties
-   * @returns The stack properties
-   */
-  protected determineConstructProps(props: CommonCloudflareStackProps) {
-    let projectProps: CommonCloudflareStackProps = props
-    if (!projectProps) {
-      const projectPropsPath = path.join(appRoot.path, 'pulumi.json')
-      if (!fs.existsSync(projectPropsPath)) throw `Context properties unavailable in path:${projectPropsPath}`
-
-      const projectPropsBuffer = fs.readFileSync(projectPropsPath)
-      projectProps = JSON.parse(projectPropsBuffer.toString('utf-8'))
-    }
-
-    return {
-      ...props,
-      extraContexts: this.config.getObject('extraContexts'),
-      stage: this.config.require('stage'),
-      stageContextPath: this.config.require('stageContextPath'),
-      ...this.determineExtraContexts(),
-      ...this.determineStageContexts(),
-    }
-  }
-
-  /**
-   * @summary Method to determine extra cdk contexts apart from the main context
-   * - Sets the properties from the extra contexts into cdk node context
-   * - Primary use is to have layered config in separate files to enable easier maintenance and readability
-   */
-  protected determineExtraContexts() {
-    const extraContexts = this.config.getObject('extraContexts')
-    const debug = this.config.getBoolean('debug')
-    if (!extraContexts) {
-      if (debug) console.debug(`No additional contexts provided. Using default context properties`)
-      return {}
-    }
-
-    let extraContextProps: Record<string, any> = {}
-    _.forEach(extraContexts, (context: string) => {
-      const extraContextPath = path.join(appRoot.path, context)
-
-      /* scenario where extra context is configured but absent in file system */
-      if (!fs.existsSync(extraContextPath)) throw `Extra context properties unavailable in path:${extraContextPath}`
-
-      /* read the extra properties */
-      const extraContextPropsBuffer = fs.readFileSync(extraContextPath)
-      if (debug) console.debug(`Adding additional contexts provided in ${extraContextPath}`)
-
-      /* parse as JSON properties */
-      extraContextProps = {
-        ...extraContextProps,
-        ...JSON.parse(extraContextPropsBuffer.toString('utf-8')),
-      }
-    })
-    return extraContextProps
-  }
-
-  /**
-   * @summary Method to determine extra cdk stage contexts apart from the main context
-   * - Sets the properties from the extra stage contexts into cdk node context
-   * - Primary use is to have layered config for each environment which is injected into the context
-   */
-  protected determineStageContexts() {
-    const debug = this.config.getBoolean('debug')
-    const stage = this.config.require('stage')
-    const stageContextPath = this.config.get('stageContextPath')
-    const stageContextFilePath = path.join(appRoot.path, stageContextPath ?? 'env', `${stage}.json`)
-
-    if (isDevStage(stage)) {
-      if (debug) console.debug(`Development stage. Using default stage context properties`)
-    }
-
-    /* alert default context usage when extra stage config is missing */
-    if (!fs.existsSync(stageContextFilePath)) {
-      if (debug) console.debug(`Stage specific context properties unavailable in path:${stageContextFilePath}`)
-      if (debug) console.debug(`Using default stage context properties for ${stage} stage`)
-      return {}
-    }
-
-    /* read the extra properties */
-    const stageContextPropsBuffer = fs.readFileSync(stageContextFilePath)
-    if (debug) console.debug(`Adding additional stage contexts provided in ${stageContextFilePath}`)
-
-    /* parse as JSON properties */
-    return JSON.parse(stageContextPropsBuffer.toString('utf-8'))
-  }
-
-  /**
-   * @summary Determine the fully qualified domain name based on domainName & subDomain
-   */
-  protected fullyQualifiedDomain() {
-    const domainName = this.props.domainName
-    const subDomain = this.props.subDomain
-
-    return subDomain ? `${subDomain}.${domainName}` : domainName
-  }
-}

package/src/lib/cloudflare/common/types.ts

@@ -1,10 +0,0 @@
-import { BaseProps } from '../../common/index.js'
-
-/**
- */
-export interface CommonCloudflareStackProps extends BaseProps {
-  accountId: string
-  apiToken: string
-  resourceGroupName?: string
-  useExistingZone?: boolean
-}

package/src/lib/cloudflare/construct/index.ts

@@ -1,2 +0,0 @@
-export * from './pages-static-site/index.js'
-export * from './worker-site/index.js'

package/src/lib/cloudflare/construct/pages-static-site/index.ts

@@ -1,2 +0,0 @@
-export * from './main.js'
-export * from './types.js'

package/src/lib/cloudflare/construct/pages-static-site/main.ts

@@ -1,188 +0,0 @@
-import * as aws from '@pulumi/aws'
-import * as azure from '@pulumi/azure-native'
-import { DnsRecord, PagesDomain, PagesProject, Zone } from '@pulumi/cloudflare'
-import {
-  PagesProjectDeploymentConfigsPreviewEnvVars,
-  PagesProjectDeploymentConfigsProductionEnvVars,
-} from '@pulumi/cloudflare/types/input.js'
-import { ComponentResourceOptions } from '@pulumi/pulumi'
-import * as std from '@pulumi/std'
-import { CommonCloudflareConstruct } from '../../common/index.js'
-import { CloudflarePagesStaticSiteProps } from './types.js'
-
-/**
- * @classdesc Provides a construct to create and deploy a cloudflare pages static site
- * @example
- * import { CloudflarePagesStaticSite, CloudflareStaticSiteProps } '@gradientedge/cdk-utils'
- * import { Construct } from 'constructs'
- *
- * class CustomConstruct extends CloudflarePagesStaticSite {
- *   constructor(parent: Construct, id: string, props: CloudflareStaticSiteProps) {
- *     super(parent, id, props)
- *     this.props = props
- *     this.id = id
- *     this.initResources()
- *   }
- * }
- */
-export class CloudflarePagesStaticSite extends CommonCloudflareConstruct {
-  declare props: CloudflarePagesStaticSiteProps
-
-  /* static site resources */
-  sitePagesCnameRecord: DnsRecord
-  sitePagesDomain: PagesDomain
-  sitePagesProject: PagesProject
-  siteZone: Zone
-  sitePagesEnvironmentVariables: { [key: string]: PagesProjectDeploymentConfigsProductionEnvVars }
-  sitePagesPreviewEnvironmentVariables: { [key: string]: PagesProjectDeploymentConfigsPreviewEnvVars }
-  sitePagesSecrets: { [key: string]: PagesProjectDeploymentConfigsProductionEnvVars }
-  sitePagesPreviewSecrets: { [key: string]: PagesProjectDeploymentConfigsPreviewEnvVars }
-  siteDeploymentDependsOn: any
-
-  constructor(id: string, props: CloudflarePagesStaticSiteProps, options?: ComponentResourceOptions) {
-    super(id, props)
-    this.props = props
-    this.options = options
-    this.id = id
-  }
-
-  /**
-   * @summary Initialise and provision resources
-   */
-  protected initResources() {
-    this.resolveZone()
-    this.resolveSecrets()
-    this.resolveEnvironmentVariables()
-    this.createProject()
-    this.createDomain()
-    this.createRecord()
-    this.deploySite()
-  }
-
-  /**
-   * @summary Resolve the zone to use for the static site
-   */
-  protected resolveZone() {
-    if (this.props.useExistingZone) {
-      this.siteZone = this.zoneManager.resolveZone(`${this.id}-zone`, this)
-    } else {
-      this.siteZone = this.zoneManager.createZone(`${this.id}-zone`, this, this.props.siteZone)
-    }
-  }
-
-  /**
-   * @summary Resolve the secrets to use for the static site
-   */
-  protected resolveSecrets() {
-    this.props.sitePagesProject = {
-      ...this.props.sitePagesProject,
-      deploymentConfigs: {
-        preview: {
-          envVars: this.sitePagesPreviewSecrets,
-        },
-        production: {
-          envVars: this.sitePagesSecrets,
-        },
-      },
-    }
-  }
-
-  /**
-   * @summary Resolve the environment variables to use for the static site
-   */
-  protected resolveEnvironmentVariables() {
-    this.props.sitePagesProject = {
-      ...this.props.sitePagesProject,
-      deploymentConfigs: {
-        preview: {
-          envVars: this.sitePagesPreviewEnvironmentVariables,
-        },
-        production: {
-          envVars: this.sitePagesEnvironmentVariables,
-        },
-      },
-    }
-  }
-
-  /**
-   * @summary Resolve secrets from AWS Secrets Manager
-   * @param secretName the secret name
-   * @param secretKey the secret key
-   * @returns the secret value
-   */
-  protected resolveSecretFromAWS(secretName: string, secretKey: string) {
-    if (this.config.require('secretsProvider') !== 'aws') return
-    const secret = aws.secretsmanager.getSecretOutput({ name: secretName })
-    const secretVersion = aws.secretsmanager.getSecretVersionOutput({ secretId: secret.id })
-    if (!secretVersion) throw new Error(`Unable to resolve secret:${secretName}`)
-    return std.jsondecodeOutput({ input: secretVersion.secretString })
-  }
-
-  /**
-   * @summary Resolve secrets from Azure Key Vault
-   *
-   * @param resourceGroupName the resource group name where the key vault is located
-   * @param keyVaultName the key vault name
-   * @param secretKey the secret key
-   * @returns the secret value
-   */
-  protected resolveSecretFromAzure(resourceGroupName: string, keyVaultName: string, secretKey: string) {
-    if (this.config.require('secretsProvider') !== 'azure') return
-    const secretValueData = azure.keyvault.getSecretOutput({
-      resourceGroupName,
-      secretName: secretKey,
-      vaultName: keyVaultName,
-    })
-    if (!secretValueData) throw new Error(`Unable to resolve secret:${secretKey}`)
-    return secretValueData.properties?.value
-  }
-
-  /**
-   * @summary Create the pages project
-   */
-  protected createProject() {
-    this.sitePagesProject = this.pageManager.createPagesProject(
-      `${this.id}-site-project`,
-      this,
-      this.props.sitePagesProject
-    )
-  }
-
-  /**
-   * @summary Create the pages domain
-   */
-  protected createDomain() {
-    this.sitePagesDomain = this.pageManager.createPagesDomain(`${this.id}-site-domain`, this, {
-      accountId: this.props.accountId,
-      name: `${this.props.siteSubDomain}.${this.props.domainName}`,
-      projectName: this.sitePagesProject.name,
-    })
-  }
-
-  /**
-   * @summary Create the pages cname record
-   */
-  protected createRecord() {
-    this.sitePagesCnameRecord = this.recordManager.createRecord(`${this.id}-site-record`, this, {
-      ...this.props.siteCnameRecord,
-      name: this.props.siteSubDomain,
-      data: {
-        ...this.props.siteCnameRecord.data,
-        value: `${this.sitePagesProject.name}.pages.dev`,
-      },
-    })
-  }
-
-  /**
-   * @summary Deploy the pages project
-   */
-  protected deploySite() {
-    this.pageManager.deployPagesProject(`${this.id}-deploy`, this, {
-      branch: this.props.siteBranch ?? 'main',
-      directory: this.props.siteAssetDir,
-      message: this.props.siteDeployMessage,
-      projectName: String(this.sitePagesProject.name),
-      dependsOn: this.siteDeploymentDependsOn,
-    })
-  }
-}

package/src/lib/cloudflare/construct/pages-static-site/types.ts

@@ -1,12 +0,0 @@
-import { CommonCloudflareStackProps } from '../../common/index.js'
-import { PagesProjectProps, DnsRecordProps, ZoneProps } from '../../services/index.js'
-
-export interface CloudflarePagesStaticSiteProps extends CommonCloudflareStackProps {
-  siteAssetDir: string
-  siteBranch?: string
-  siteCnameRecord: DnsRecordProps
-  siteDeployMessage: string
-  sitePagesProject: PagesProjectProps
-  siteSubDomain: string
-  siteZone: ZoneProps
-}

package/src/lib/cloudflare/construct/worker-site/index.ts

@@ -1,2 +0,0 @@
-export * from './main.js'
-export * from './types.js'

package/src/lib/cloudflare/construct/worker-site/main.ts

@@ -1,155 +0,0 @@
-import * as aws from '@pulumi/aws'
-import * as azure from '@pulumi/azure-native'
-import { Ruleset, WorkersCustomDomain, WorkersScript, Zone, ZoneSetting } from '@pulumi/cloudflare'
-import { WorkersScriptBinding } from '@pulumi/cloudflare/types/input.js'
-import { ComponentResourceOptions } from '@pulumi/pulumi'
-import * as std from '@pulumi/std'
-import fs from 'fs'
-import { CommonCloudflareConstruct } from '../../common/index.js'
-import { CloudflareWorkerSiteProps } from './types.js'
-
-/**
- * @classdesc Provides a construct to create and deploy a cloudflare worker site
- * @example
- * import { CloudflareWorkerSite, CloudflareWorkerSiteProps } '@gradientedge/cdk-utils'
- * import { Construct } from 'constructs'
- *
- * class CustomConstruct extends CloudflareWorkerSite {
- *   constructor(parent: Construct, id: string, props: CloudflareWorkerSiteProps) {
- *     super(parent, id, props)
- *     this.props = props
- *     this.id = id
- *     this.initResources()
- *   }
- * }
- */
-export class CloudflareWorkerSite extends CommonCloudflareConstruct {
-  declare props: CloudflareWorkerSiteProps
-
-  /* worker site resources */
-  siteZone: Zone
-  siteWorkerScript: WorkersScript
-  siteWorkerDomain: WorkersCustomDomain
-  siteRuleSet: Ruleset
-  siteZoneSetting: ZoneSetting
-  workerPlainTextBindingEnvironmentVariables: WorkersScriptBinding[] = []
-  workerSecretTextBindingEnvironmentVariables: WorkersScriptBinding[] = []
-
-  constructor(id: string, props: CloudflareWorkerSiteProps, options?: ComponentResourceOptions) {
-    super(id, props)
-    this.props = props
-    this.options = options
-    this.id = id
-  }
-
-  /**
-   * @summary Initialise and provision resources
-   */
-  protected initResources() {
-    this.resolveZone()
-    this.resolveEnvironmentVariables()
-    this.createWorker()
-    this.createWorkerDomain()
-    this.createRuleset()
-    this.createZoneSetting()
-  }
-
-  /**
-   * @summary Resolve the zone to use for the worker site
-   */
-  protected resolveZone() {
-    if (this.props.useExistingZone) {
-      this.siteZone = this.zoneManager.resolveZone(`${this.id}-zone`, this)
-    } else {
-      this.siteZone = this.zoneManager.createZone(`${this.id}-zone`, this, this.props.siteZone)
-    }
-  }
-
-  /**
-   * @summary Resolve the environment variables to use for the static site
-   */
-  protected resolveEnvironmentVariables() {
-    this.props.siteWorkerScript = {
-      ...this.props.siteWorkerScript,
-      bindings: this.workerPlainTextBindingEnvironmentVariables.concat(
-        this.workerSecretTextBindingEnvironmentVariables
-      ),
-    }
-  }
-
-  /**
-   * @summary Create the worker
-   */
-  protected createWorker() {
-    const workerContent = fs.readFileSync(this.props.siteWorkerAsset, 'utf-8')
-    this.siteWorkerScript = this.workerManager.createWorkerScript(`${this.id}-worker-script`, this, {
-      ...this.props.siteWorkerScript,
-      content: workerContent,
-    })
-  }
-
-  /**
-   * @summary Create the worker domain
-   */
-  protected createWorkerDomain() {
-    this.siteWorkerDomain = this.workerManager.createWorkerDomain(`${this.id}-worker-domain`, this, {
-      ...this.props.siteWorkerDomain,
-      environment: this.props.siteWorkerDomain.environment ?? 'production',
-      hostname: `${this.props.siteSubDomain}.${this.props.domainName}`,
-      service: this.siteWorkerScript.scriptName,
-    })
-  }
-
-  /**
-   * @summary Resolve secrets from AWS Secrets Manager
-   * @param secretName the secret name
-   * @param secretKey the secret key
-   * @returns the secret value
-   */
-  protected resolveSecretFromAWS(secretName: string, secretKey: string) {
-    if (this.config.require('secretsProvider') !== 'aws') return
-    const secret = aws.secretsmanager.getSecretOutput({ name: secretName })
-    const secretVersion = aws.secretsmanager.getSecretVersionOutput({ secretId: secret.id })
-    if (!secretVersion) throw new Error(`Unable to resolve secret:${secretName}`)
-    return std.jsondecodeOutput({ input: secretVersion.secretString })
-  }
-
-  /**
-   * @summary Resolve secrets from Azure Key Vault
-   *
-   * @param resourceGroupName the resource group name where the key vault is located
-   * @param keyVaultName the key vault name
-   * @param secretKey the secret key
-   * @returns the secret value
-   */
-  protected resolveSecretFromAzure(resourceGroupName: string, keyVaultName: string, secretKey: string) {
-    if (this.config.require('secretsProvider') !== 'azure') return
-    const secretValueData = azure.keyvault.getSecretOutput({
-      resourceGroupName,
-      secretName: secretKey,
-      vaultName: keyVaultName,
-    })
-    if (!secretValueData) throw new Error(`Unable to resolve secret:${secretKey}`)
-    return secretValueData.properties?.value
-  }
-
-  /**
-   * @summary Create the rules
-   */
-  protected createRuleset() {
-    if (!this.props.siteRuleSet) return
-    this.siteRuleSet = this.ruleSetManager.createRuleSet(`${this.id}-rule`, this, this.props.siteRuleSet)
-  }
-
-  /**
-   * @summary Create zone settings override
-   */
-  protected createZoneSetting() {
-    if (!this.props.siteZoneSetting) return
-    this.siteZoneSetting = this.zoneManager.createZoneSetting(
-      `${this.id}-zone-setting`,
-      this,
-      this.props.siteZoneSetting
-    )
-  }
-}

package/src/lib/cloudflare/construct/worker-site/types.ts

@@ -1,18 +0,0 @@
-import { CommonCloudflareStackProps } from '../../common/index.js'
-import {
-  WorkerDomainProps,
-  WorkerScriptProps,
-  RulesetProps,
-  ZoneProps,
-  ZoneSettingProps,
-} from '../../services/index.js'
-
-export interface CloudflareWorkerSiteProps extends CommonCloudflareStackProps {
-  siteSubDomain: string
-  siteZone: ZoneProps
-  siteWorkerScript: WorkerScriptProps
-  siteWorkerDomain: WorkerDomainProps
-  siteWorkerAsset: string
-  siteRuleSet: RulesetProps
-  siteZoneSetting: ZoneSettingProps
-}

package/src/lib/cloudflare/index.ts

@@ -1,4 +0,0 @@
-export * from './common/index.js'
-export * from './construct/index.js'
-export * from './services/index.js'
-export * from './types/index.js'

package/src/lib/cloudflare/services/access/index.ts

@@ -1,2 +0,0 @@
-export * from './main.js'
-export * from './types.js'