@stacksjs/cloud 0.62.0 → 0.63.0

package/src/cloud/cdn.ts

@@ -13,7 +13,6 @@ import {
   aws_route53_targets as targets,
 } from 'aws-cdk-lib'
 import type { ApplicationLoadBalancer } from 'aws-cdk-lib/aws-elasticloadbalancingv2'
-import * as kinesis from 'aws-cdk-lib/aws-kinesis'
 import type { Construct } from 'constructs'
 import type { EnvKey } from '../../../../env'
 import type { NestedCloudProps } from '../types'
@@ -22,6 +21,7 @@ export interface CdnStackProps extends NestedCloudProps {
   certificate: acm.Certificate
   logBucket: s3.Bucket
   publicBucket: s3.Bucket
+  docsBucket?: s3.Bucket
   firewall: wafv2.CfnWebACL
   originRequestFunction: lambda.Function
   zone: route53.IHostedZone
@@ -39,7 +39,7 @@ export class CdnStack {
   cdnCachePolicy: cloudfront.CachePolicy
   apiCachePolicy: cloudfront.CachePolicy | undefined
   vanityUrl: string
-  realtimeLogConfig: cloudfront.RealtimeLogConfig
+  realtimeLogConfig!: cloudfront.RealtimeLogConfig
   props: CdnStackProps
 
   constructor(scope: Construct, props: CdnStackProps) {
@@ -57,12 +57,12 @@ export class CdnStack {
     })
 
     // Step 1: Create a Kinesis Firehose delivery stream for the logs
-    const logStream = new kinesis.Stream(scope, 'StacksCdnRealtimeLogStream', {
-      streamName: 'StacksCdnRealtimeLogStream',
-      retentionPeriod: Duration.days(1),
-      shardCount: 1,
-      encryption: kinesis.StreamEncryption.UNENCRYPTED,
-    })
+    // const logStream = new kinesis.Stream(scope, 'StacksCdnRealtimeLogStream', {
+    //   streamName: 'StacksCdnRealtimeLogStream',
+    //   retentionPeriod: Duration.days(1),
+    //   shardCount: 1,
+    //   encryption: kinesis.StreamEncryption.UNENCRYPTED,
+    // })
 
     // Create an IAM role for CloudFront to write logs to Kinesis Firehose
     // new iam.Role(scope, 'LoggingRole', {
@@ -80,20 +80,20 @@ export class CdnStack {
     // })
 
     // TODO: make this configurable
-    this.realtimeLogConfig = new cloudfront.RealtimeLogConfig(scope, 'StacksRealTimeLogConfig', {
-      endPoints: [cloudfront.Endpoint.fromKinesisStream(logStream)],
-      fields: [
-        'timestamp',
-        'c-ip',
-        'cs-method',
-        'cs-uri-stem',
-        'cs-uri-query',
-        'cs-referer',
-        'cs-user-agent',
-        'sc-status',
-      ],
-      samplingRate: 100, // Adjust the sampling rate as needed
-    })
+    // this.realtimeLogConfig = new cloudfront.RealtimeLogConfig(scope, 'StacksRealTimeLogConfig', {
+    //   endPoints: [cloudfront.Endpoint.fromKinesisStream(logStream)],
+    //   fields: [
+    //     'timestamp',
+    //     'c-ip',
+    //     'cs-method',
+    //     'cs-uri-stem',
+    //     'cs-uri-query',
+    //     'cs-referer',
+    //     'cs-user-agent',
+    //     'sc-status',
+    //   ],
+    //   samplingRate: 100, // Adjust the sampling rate as needed
+    // })
 
     // the actual CDN distribution
     this.distribution = new cloudfront.Distribution(scope, 'Cdn', {
@@ -111,7 +111,7 @@ export class CdnStack {
       enableIpv6: true,
 
       defaultBehavior: {
-        origin: new origins.S3Origin(props.publicBucket, {
+        origin: new origins.S3Origin(config.app.docMode ? (props.docsBucket as s3.Bucket) : props.publicBucket, {
           originAccessIdentity: this.originAccessIdentity,
         }),
         edgeLambdas: [
@@ -125,7 +125,7 @@ export class CdnStack {
         cachedMethods: this.cachedMethods(),
         viewerProtocolPolicy: cloudfront.ViewerProtocolPolicy.REDIRECT_TO_HTTPS,
         cachePolicy: this.cdnCachePolicy,
-        realtimeLogConfig: this.realtimeLogConfig,
+        // realtimeLogConfig: this.realtimeLogConfig,
       },
 
       additionalBehaviors: this.additionalBehaviors(scope, props),
@@ -233,22 +233,19 @@ export class CdnStack {
   }
 
   shouldDeployApi() {
-    return config.api?.deploy
+    return config.cloud.api?.deploy
   }
 
   apiBehaviorOptions(scope: Construct, props: CdnStackProps): Record<string, cloudfront.BehaviorOptions> {
-    const hostname = `api.${props.domain}`
-
-    const origin = () => {
-      return new origins.HttpOrigin(hostname, {
-        originPath: '/',
-        protocolPolicy: cloudfront.OriginProtocolPolicy.HTTPS_ONLY,
-      })
-    }
+    const hostname = `api.${props.domain}` // TODO: make `api` configurable
+    const origin = new origins.HttpOrigin(hostname, {
+      originPath: '/',
+      protocolPolicy: cloudfront.OriginProtocolPolicy.HTTPS_ONLY,
+    })
 
     return {
       '/api': {
-        origin: origin(),
+        origin,
         compress: true,
         allowedMethods: cloudfront.AllowedMethods.ALLOW_ALL,
         cachedMethods: cloudfront.CachedMethods.CACHE_GET_HEAD_OPTIONS,
@@ -256,8 +253,9 @@ export class CdnStack {
         viewerProtocolPolicy: cloudfront.ViewerProtocolPolicy.REDIRECT_TO_HTTPS,
         realtimeLogConfig: this.realtimeLogConfig,
       },
+
       '/api/*': {
-        origin: origin(),
+        origin,
         compress: true,
         allowedMethods: cloudfront.AllowedMethods.ALLOW_ALL,
         cachedMethods: cloudfront.CachedMethods.CACHE_GET_HEAD_OPTIONS,
@@ -268,13 +266,17 @@ export class CdnStack {
     }
   }
 
-  docsBehaviorOptions(props: CdnStackProps): Record<string, cloudfront.BehaviorOptions> {
+  docsBehaviorOptions(docsBucket?: s3.Bucket): Record<string, cloudfront.BehaviorOptions> {
+    if (!docsBucket) return {}
+
+    const origin = new origins.S3Origin(docsBucket, {
+      originAccessIdentity: this.originAccessIdentity,
+      originPath: '/',
+    })
+
     return {
       '/docs': {
-        origin: new origins.S3Origin(props.publicBucket, {
-          originAccessIdentity: this.originAccessIdentity,
-          originPath: '/docs',
-        }),
+        origin,
         compress: true,
         allowedMethods: this.allowedMethodsFromString(config.cloud.cdn?.allowedMethods),
         cachedMethods: this.cachedMethodsFromString(config.cloud.cdn?.cachedMethods),
@@ -282,11 +284,9 @@ export class CdnStack {
         cachePolicy: cloudfront.CachePolicy.CACHING_OPTIMIZED,
         realtimeLogConfig: this.realtimeLogConfig,
       },
+
       '/docs/*': {
-        origin: new origins.S3Origin(props.publicBucket, {
-          originAccessIdentity: this.originAccessIdentity,
-          originPath: '/docs',
-        }),
+        origin,
         compress: true,
         allowedMethods: this.allowedMethodsFromString(config.cloud.cdn?.allowedMethods),
         cachedMethods: this.cachedMethodsFromString(config.cloud.cdn?.cachedMethods),
@@ -372,7 +372,7 @@ export class CdnStack {
   }
 
   shouldDeployDocs() {
-    return hasFiles(p.projectPath('docs'))
+    return hasFiles(p.projectPath('docs')) && !config.app.docMode
   }
 
   additionalBehaviors(scope: Construct, props: CdnStackProps): Record<string, cloudfront.BehaviorOptions> {
@@ -406,9 +406,9 @@ export class CdnStack {
 
     // if docMode is used, we don't need to add a behavior for the docs
     // because the docs will be the root of the site
-    if (this.shouldDeployDocs() && !config.app.docMode) {
+    if (this.shouldDeployDocs()) {
       behaviorOptions = {
-        ...this.docsBehaviorOptions(props),
+        ...this.docsBehaviorOptions(props.docsBucket),
         ...behaviorOptions,
       }
     }

package/src/cloud/compute.ts

@@ -49,9 +49,14 @@ export class ComputeStack {
       },
     })
 
+    // const assetImage = new ecr_assets.DockerImageAsset(scope, 'DockerImageAsset', {
+    //   directory: p.frameworkCloudPath(),
+    // })
+
     const container = this.taskDefinition.addContainer('WebServerContainer', {
       containerName: `${props.appName}-${props.appEnv}-api`,
-      image: ecs.ContainerImage.fromAsset(p.frameworkPath('server')),
+      // image: ecs.ContainerImage.fromDockerImageAsset(assetImage),
+      image: ecs.ContainerImage.fromAsset(p.frameworkCloudPath()),
       logging: new ecs.AwsLogDriver({
         streamPrefix: `${props.appName}-${props.appEnv}-web-server-logs`,
         logGroup: new LogGroup(scope, 'StacksApiLogs', {
@@ -217,8 +222,12 @@ export class ComputeStack {
       },
     })
 
-    secrets.grantRead(service.taskDefinition.executionRole)
-    container.addEnvironment('SECRETS_ARN', secrets.secretArn)
+    if (service.taskDefinition.executionRole) {
+      secrets.grantRead(service.taskDefinition.executionRole)
+      container.addEnvironment('SECRETS_ARN', secrets.secretArn)
+    } else {
+      throw new Error('Service task execution role is undefined.')
+    }
 
     const apiPrefix = 'api'
     new Output(scope, 'ApiUrl', {

package/src/cloud/deployment.ts

@@ -1,5 +1,7 @@
 import { config } from '@stacksjs/config'
-import { websiteSourceHash } from '@stacksjs/utils'
+import { path as p } from '@stacksjs/path'
+import { hasFiles } from '@stacksjs/storage'
+import { docsSourceHash, websiteSourceHash } from '@stacksjs/utils'
 import type { aws_cloudfront as cloudfront, aws_s3 as s3 } from 'aws-cdk-lib'
 import { AssetHashType, aws_s3_deployment as s3deploy } from 'aws-cdk-lib'
 import type { Construct } from 'constructs'
@@ -7,6 +9,7 @@ import type { NestedCloudProps } from '../types'
 
 export interface DeploymentStackProps extends NestedCloudProps {
   publicBucket: s3.Bucket
+  docsBucket?: s3.Bucket
   privateBucket: s3.Bucket
   cdn: cloudfront.Distribution
 }
@@ -14,17 +17,17 @@ export interface DeploymentStackProps extends NestedCloudProps {
 export class DeploymentStack {
   privateSource: string
   docsSource: string
-  websiteSource: string
+  publicSource: string
 
   constructor(scope: Construct, props: DeploymentStackProps) {
     // following paths are relative to where the command is run from
     this.privateSource = '../../private'
     this.docsSource = '../docs/dist/'
-    this.websiteSource = config.app.docMode === true ? this.docsSource : '../views/dist/'
+    this.publicSource = config.app.docMode === true ? this.docsSource : '../views/web/dist/'
 
     new s3deploy.BucketDeployment(scope, 'Website', {
       sources: [
-        s3deploy.Source.asset(this.websiteSource, {
+        s3deploy.Source.asset(this.publicSource, {
           assetHash: websiteSourceHash(),
           assetHashType: AssetHashType.CUSTOM,
         }),
@@ -34,9 +37,32 @@ export class DeploymentStack {
       distributionPaths: ['/*'],
     })
 
-    new s3deploy.BucketDeployment(scope, 'PrivateFiles', {
-      sources: [s3deploy.Source.asset(this.privateSource)],
-      destinationBucket: props.privateBucket,
-    })
+    if (this.shouldDeployDocs()) {
+      // if docs should be deployed, add it to the deployment
+      new s3deploy.BucketDeployment(scope, 'Docs', {
+        sources: [
+          s3deploy.Source.asset(this.docsSource, {
+            assetHash: docsSourceHash(),
+            assetHashType: AssetHashType.CUSTOM,
+          }),
+        ],
+        destinationBucket: props.docsBucket as s3.Bucket,
+        distribution: props.cdn,
+        distributionPaths: ['/docs/*'],
+      })
+    }
+
+    if (hasFiles(this.privateSource)) {
+      new s3deploy.BucketDeployment(scope, 'PrivateFiles', {
+        sources: [s3deploy.Source.asset(this.privateSource)],
+        destinationBucket: props.privateBucket,
+      })
+    } else {
+      console.error(`The path ${this.privateSource} does not have any files`)
+    }
+  }
+
+  shouldDeployDocs() {
+    return hasFiles(p.projectPath('docs')) && !config.app.docMode
   }
 }

package/src/cloud/docs.ts

@@ -16,7 +16,8 @@ export class DocsStack {
 
   constructor(scope: Construct, props: DocsStackProps) {
     // if docsPrefix is not set, then we know we are in docsMode and the documentation lives at the root of the domain
-    const docsPrefix = config.app.docMode ? '' : config.docs.base
+    const docsPrefix = 'docs'
+    // const docsPrefix = config.app.docMode ? '' : config.docs.base
 
     // this edge function ensures pretty docs urls
     // soon to be reused for our Meema features

package/src/cloud/index.ts

@@ -34,9 +34,9 @@ export class Cloud extends Stack {
   permissions: PermissionsStack
   ai: AiStack
   cli: CliStack
-  api!: ComputeStack
+  api?: ComputeStack
   cdn!: CdnStack
-  queue!: QueueStack
+  queue?: QueueStack
   deployment!: DeploymentStack
   scope: Construct
   props: CloudOptions
@@ -92,8 +92,9 @@ export class Cloud extends Stack {
   // we use an async init() method here because we need to wait for the
 
   async init() {
-    if (config.api?.deploy) {
-      const props = this.props
+    const props = this.props
+
+    if (this.shouldDeployApi()) {
       this.api = new ComputeStack(this, {
         ...props,
         vpc: this.network.vpc,
@@ -109,27 +110,33 @@ export class Cloud extends Stack {
       })
 
       await this.queue.init()
+    }
 
-      this.cdn = new CdnStack(this, {
-        ...props,
-        publicBucket: this.storage.publicBucket,
-        logBucket: this.storage.logBucket,
-        certificate: this.security.certificate,
-        firewall: this.security.firewall,
-        originRequestFunction: this.docs.originRequestFunction,
-        zone: this.dns.zone,
-        cliSetupUrl: this.cli.cliSetupUrl,
-        askAiUrl: this.ai.askAiUrl,
-        summarizeAiUrl: this.ai.summarizeAiUrl,
-        lb: this.api?.lb,
-      })
+    this.cdn = new CdnStack(this, {
+      ...props,
+      publicBucket: this.storage.publicBucket,
+      docsBucket: this.storage.docsBucket,
+      logBucket: this.storage.logBucket,
+      certificate: this.security.certificate,
+      firewall: this.security.firewall,
+      originRequestFunction: this.docs.originRequestFunction,
+      zone: this.dns.zone,
+      cliSetupUrl: this.cli.cliSetupUrl,
+      askAiUrl: this.ai.askAiUrl,
+      summarizeAiUrl: this.ai.summarizeAiUrl,
+      lb: this.api?.lb,
+    })
 
-      this.deployment = new DeploymentStack(this, {
-        ...props,
-        publicBucket: this.storage.publicBucket,
-        privateBucket: this.storage.privateBucket,
-        cdn: this.cdn.distribution,
-      })
-    }
+    this.deployment = new DeploymentStack(this, {
+      ...props,
+      publicBucket: this.storage.publicBucket,
+      privateBucket: this.storage.privateBucket,
+      docsBucket: this.storage.docsBucket,
+      cdn: this.cdn.distribution,
+    })
+  }
+
+  shouldDeployApi() {
+    return config.cloud.api?.deploy
   }
 }

package/src/cloud/queue.ts

@@ -25,7 +25,7 @@ export class QueueStack {
   async init() {
     const jobsDir = path.jobsPath()
     const actionsDir = path.appPath('Actions')
-    const ormActionDir = path.projectStoragePath('framework/orm/Actions')
+    const ormActionDir = path.builtUserActionsPath('src')
 
     const jobFiles = await fs.readdir(jobsDir)
     const actionFiles = await fs.readdir(actionsDir)
@@ -47,7 +47,7 @@ export class QueueStack {
     for (const ormFile of ormActionFiles) {
       if (!ormFile.endsWith('.ts')) continue
 
-      const ormActionPath = path.projectStoragePath(`framework/orm/Actions/${ormFile}`)
+      const ormActionPath = path.builtUserActionsPath(ormFile)
 
       // Await the loading of the job module
       const ormAction = await this.loadModule(ormActionPath)
@@ -60,8 +60,6 @@ export class QueueStack {
 
       const actionPath = path.appPath(`Actions/${file}`)
 
-      console.log(actionPath)
-
       // Await the loading of the job module
       const action = await this.loadModule(actionPath)
       this.createQueueRule(action, file)

package/src/cloud/router-layer/nodejs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stacks-router-layer",
-  "version": "0.62.0",
+  "version": "0.63.0",
   "description": "",
   "author": "",
   "license": "MIT",
@@ -10,6 +10,6 @@
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "dependencies": {
-    "@stacksjs/router": "^0.61.24"
+    "@stacksjs/router": "^0.62.0"
   }
 }

package/src/cloud/security.ts

@@ -69,9 +69,9 @@ export class SecurityStack {
         name: 'CountryRule',
         priority: priorities.length,
         statement: {
-          // geoMatchStatement: {
-          //   countryCodes: config.security.firewall.countryCodes,
-          // },
+          geoMatchStatement: {
+            countryCodes: config.security.firewall.countryCodes as string[],
+          },
         },
         action: {
           block: {},
@@ -130,7 +130,7 @@ export class SecurityStack {
               searchString: 'true',
               textTransformations: [
                 {
-                  priority: index,
+                  priority: 0,
                   type: 'NONE',
                 },
               ],

package/src/cloud/storage.ts

@@ -1,3 +1,5 @@
+import { path as p } from '@stacksjs/path'
+import { hasFiles } from '@stacksjs/storage'
 import type { aws_kms as kms } from 'aws-cdk-lib'
 import { RemovalPolicy, Tags, aws_backup as backup, aws_iam as iam, aws_s3 as s3 } from 'aws-cdk-lib'
 import type { Construct } from 'constructs'
@@ -10,6 +12,7 @@ export interface StorageStackProps extends NestedCloudProps {
 export class StorageStack {
   publicBucket: s3.Bucket
   privateBucket: s3.Bucket
+  docsBucket?: s3.Bucket
   logBucket: s3.Bucket
   bucketPrefix: string
   vault: backup.BackupVault
@@ -29,6 +32,18 @@ export class StorageStack {
 
     Tags.of(this.publicBucket).add('daily-backup', 'true')
 
+    if (this.shouldDeployDocs()) {
+      this.docsBucket = new s3.Bucket(scope, 'DocsBucket', {
+        bucketName: `${this.bucketPrefix}-docs-${props.timestamp}`,
+        versioned: true,
+        autoDeleteObjects: true,
+        removalPolicy: RemovalPolicy.DESTROY,
+        encryption: s3.BucketEncryption.S3_MANAGED,
+      })
+
+      Tags.of(this.docsBucket).add('weekly-backup', 'true')
+    }
+
     this.privateBucket = new s3.Bucket(scope, 'PrivateBucket', {
       bucketName: `${this.bucketPrefix}-private-${props.timestamp}`,
       versioned: true,
@@ -165,4 +180,8 @@ export class StorageStack {
 
     return backupRole
   }
+
+  shouldDeployDocs() {
+    return hasFiles(p.projectPath('docs')) || config.app.docMode
+  }
 }

package/src/helpers.ts

@@ -160,7 +160,7 @@ export async function getJumpBoxInstanceId(name?: string) {
     ],
   })
 
-  if (data.Reservations?.[0].Instances?.[0]) return data.Reservations[0].Instances[0].InstanceId
+  if (data.Reservations?.[0]?.Instances?.[0]) return data.Reservations[0].Instances[0].InstanceId
 
   return undefined
 }
@@ -537,7 +537,7 @@ export async function getJumpBoxSecurityGroupName() {
   const ec2 = new EC2({ region: 'us-east-1' })
   const data = await ec2.describeInstances({ InstanceIds: [jumpBoxId] })
 
-  if (data.Reservations?.[0].Instances?.[0]) {
+  if (data.Reservations?.[0]?.Instances?.[0]) {
     const instance = data.Reservations[0].Instances[0]
     const securityGroups = instance.SecurityGroups
 
@@ -551,7 +551,7 @@ export async function getSecurityGroupFromInstanceId(instanceId: string) {
   const ec2 = new EC2({ region: 'us-east-1' })
   const data = await ec2.describeInstances({ InstanceIds: [instanceId] })
 
-  if (data.Reservations?.[0].Instances?.[0]) {
+  if (data.Reservations?.[0]?.Instances?.[0]) {
     const instance = data.Reservations[0].Instances[0]
     const securityGroups = instance.SecurityGroups
 
@@ -606,6 +606,12 @@ export async function getOrCreateTimestamp(): Promise<string> {
   }
 }
 
+// get the CloudFront distribution ID of the current stack
+export async function getCloudFrontDistributionId(): Promise<string> {
+  return ''
+  //   return await runCommand(`aws cloudfront list-distributions --query "DistributionList.Items[?Origins.Items[0].DomainName=='${config.app.url}'].Id"`)
+}
+
 // function isProductionEnv(env: string) {
 //   return env === 'production' || env === 'prod'
 // }
@@ -622,5 +628,5 @@ export async function getOrCreateTimestamp(): Promise<string> {
 //   catch (error) {
 //     console.error('Error fetching buckets', error)
 //     return `${prefix}-${timestamp}`
-//   }
+// }
 // }