@adobe/aio-cli-plugin-app-storage 1.0.3 → 1.2.0-pre.2025-11-18.sha-9c4079ac

package/src/commands/app/db/stats.js

@@ -0,0 +1,87 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+import { DBBaseCommand } from '../../../DBBaseCommand.js'
+import chalk from 'chalk'
+import { prettyJson } from '../../../utils/output.js'
+
+export class Stats extends DBBaseCommand {
+  async run () {
+    try {
+      this.log(chalk.blue('Fetching database statistics...'))
+
+      const client = await this.db.connect()
+      const stats = await client.dbStats()
+
+      this.debugLogger?.info?.('Database statistics retrieved:', stats)
+
+      const result = {
+        ...stats,
+        namespace: this.rtNamespace,
+        timestamp: new Date().toISOString()
+      }
+
+      this.displayStats(stats)
+
+      return result
+    } catch (error) {
+      this.debugLogger?.error?.('Stats command error:', error)
+
+      this.log(chalk.red('Failed to retrieve database statistics'))
+      this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+      this.log(chalk.dim(`   Error: ${error.message}`))
+
+      this.error(`Failed to fetch database statistics: ${error.message}`)
+    }
+  }
+
+  displayStats (stats) {
+    this.log(chalk.green('Database Statistics:'))
+    this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+
+    if (stats && typeof stats === 'object') {
+      // Format and display stats in a readable way
+      Object.entries(stats).forEach(([key, value]) => {
+        this.log(chalk.dim(`   ${key}: ${this.formatValue(value)}`))
+      })
+    } else {
+      this.log(chalk.dim(`   Raw Stats: ${this.formatValue(stats)}`))
+    }
+
+    this.log('')
+    this.log(chalk.dim(`   Retrieved: ${new Date().toLocaleString()}`))
+  }
+
+  formatValue (value) {
+    if (typeof value === 'number') {
+      // Format large numbers with commas
+      return value.toLocaleString()
+    }
+    if (typeof value === 'object' && value !== null) {
+      return `\n${prettyJson(value)}`
+    }
+    return String(value)
+  }
+}
+
+Stats.description = 'Get statistics about your App Builder database'
+
+Stats.examples = [
+  '$ aio app db stats',
+  '$ aio app db stats --json'
+]
+
+Stats.flags = {
+  ...DBBaseCommand.flags
+}
+
+Stats.args = {}

package/src/commands/app/db/status.js

@@ -0,0 +1,159 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+import { DBBaseCommand } from '../../../DBBaseCommand.js'
+import { Flags } from '@oclif/core'
+import chalk from 'chalk'
+import { DB_STATUS } from '../../../constants/db.js'
+
+export class Status extends DBBaseCommand {
+  async run () {
+    const { watch } = this.flags
+
+    this.debugLogger?.info?.('Checking database provisioning status')
+
+    if (watch) {
+      return this.watchStatus()
+    } else {
+      return this.checkStatus()
+    }
+  }
+
+  async checkStatus () {
+    try {
+      this.log(chalk.blue('Checking database provisioning status...'))
+
+      const provisionStatusResponse = await this.db.provisionStatus()
+      this.debugLogger?.info?.('Status result:', provisionStatusResponse)
+
+      this.displayStatus(provisionStatusResponse)
+
+      return {
+        ...provisionStatusResponse,
+        namespace: this.rtNamespace,
+        timestamp: new Date().toISOString()
+      }
+    } catch (error) {
+      this.debugLogger?.error?.('Status command error:', error)
+
+      if (error.httpStatusCode === 404) {
+        this.log(chalk.yellow('No database has been provisioned for this workspace'))
+        this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+        this.log(chalk.dim(`   Status: ${DB_STATUS.NOT_PROVISIONED}`))
+
+        return {
+          status: DB_STATUS.NOT_PROVISIONED,
+          namespace: this.rtNamespace,
+          timestamp: new Date().toISOString()
+        }
+      }
+
+      this.error(`Failed to check database status: ${error.message}`)
+    }
+  }
+
+  async watchStatus () {
+    this.log(chalk.blue('Watching database provisioning status (press Ctrl+C to stop)...'))
+
+    let previousStatus = null
+    const checkInterval = 3000 // 3 seconds
+
+    const watchLoop = async () => {
+      try {
+        const provisionStatusResponse = await this.db.provisionStatus()
+
+        // Only display if status changed
+        if (previousStatus?.status !== provisionStatusResponse?.status) {
+          this.log(chalk.dim(`\n[${new Date().toLocaleTimeString()}]`))
+          this.displayStatus(provisionStatusResponse, false) // Don't show timestamp in watch mode
+          previousStatus = provisionStatusResponse
+
+          // Stop watching if provisioning is complete or failed
+          const currentStatus = provisionStatusResponse.status?.toUpperCase()
+          if (currentStatus !== DB_STATUS.REQUESTED && currentStatus !== DB_STATUS.PROCESSING) {
+            this.log(chalk.dim('\nStopping watch mode.'))
+            return provisionStatusResponse
+          }
+        }
+
+        // Schedule next check
+        setTimeout(watchLoop, checkInterval)
+      } catch (error) {
+        this.debugLogger?.error?.('Watch status error:', error)
+        this.log(chalk.red(`\n[${new Date().toLocaleTimeString()}] Error: ${error.message}`))
+
+        // Continue watching despite errors
+        setTimeout(watchLoop, checkInterval)
+      }
+    }
+
+    // Start watching
+    return watchLoop()
+  }
+
+  displayStatus (provisionStatusResponse, showTimestamp = true) {
+    const currentStatus = provisionStatusResponse.status.toUpperCase()
+    const statusColor = this.getStatusColor(currentStatus)
+
+    this.log(statusColor(`Database Status: ${currentStatus}`))
+    this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+
+    if (provisionStatusResponse.message) {
+      this.log(chalk.dim(`   Message: ${provisionStatusResponse.message}`))
+    }
+
+    if (provisionStatusResponse.submitted) {
+      this.log(chalk.dim(`   Submitted: ${new Date(provisionStatusResponse.submitted).toLocaleString()}`))
+    }
+
+    if (showTimestamp) {
+      this.log(chalk.dim(`   Checked: ${new Date().toLocaleString()}`))
+    }
+  }
+
+  /* istanbul ignore next */
+  getStatusColor (statusValue) {
+    const status = statusValue.toUpperCase()
+    switch (status) {
+      case DB_STATUS.PROVISIONED:
+        return chalk.green
+      case DB_STATUS.REQUESTED:
+      case DB_STATUS.PROCESSING:
+        return chalk.yellow
+      case DB_STATUS.FAILED:
+      case DB_STATUS.REJECTED:
+        return chalk.red
+      case DB_STATUS.NOT_PROVISIONED:
+        return chalk.blue
+      default:
+        return chalk.gray
+    }
+  }
+}
+
+Status.description = 'Check the provisioning status of your App Builder database'
+
+Status.examples = [
+  '$ aio app db status',
+  '$ aio app db status --watch',
+  '$ aio app db status --json'
+]
+
+Status.flags = {
+  ...DBBaseCommand.flags,
+  watch: Flags.boolean({
+    description: 'Watch for status changes (press Ctrl+C to stop)',
+    default: false
+  })
+}
+
+Status.args = {}

package/src/commands/app/state/delete.js

@@ -10,12 +10,12 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 import chalk from 'chalk'
-import { BaseCommand } from '../../../BaseCommand.js'
+import { StateBaseCommand } from '../../../StateBaseCommand.js'
 import { Args, Flags } from '@oclif/core'
 
 const MAX_ARGV_NO_CONFIRM = 5
 
-export class Delete extends BaseCommand {
+export class Delete extends StateBaseCommand {
   async run () {
     const { match, force } = this.flags
     const { argv: keysToDelete } = await this.parse(Delete)
@@ -100,7 +100,7 @@ Delete.args = {
 }
 
 Delete.flags = {
-  ...BaseCommand.flags,
+  ...StateBaseCommand.flags,
   match: Flags.string({
     description: '[use with caution!] deletes ALL key-values matching the provided glob-like pattern',
     required: false

package/src/commands/app/state/get.js

@@ -10,10 +10,10 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 import chalk from 'chalk'
-import { BaseCommand } from '../../../BaseCommand.js'
+import { StateBaseCommand } from '../../../StateBaseCommand.js'
 import { Args } from '@oclif/core'
 
-export class Get extends BaseCommand {
+export class Get extends StateBaseCommand {
   async run () {
     const ret = await this.state.get(this.args.key)
 

package/src/commands/app/state/list.js

@@ -9,14 +9,14 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
-import { BaseCommand } from '../../../BaseCommand.js'
+import { StateBaseCommand } from '../../../StateBaseCommand.js'
 import { Flags } from '@oclif/core'
 import chalk from 'chalk'
 
 const MAX_KEYS = 5000
 const COUNT_HINT = 500 // per iteration
 
-export class List extends BaseCommand {
+export class List extends StateBaseCommand {
   async run () {
     const allKeys = []
 
@@ -55,7 +55,7 @@ List.examples = [
 ]
 
 List.flags = {
-  ...BaseCommand.flags,
+  ...StateBaseCommand.flags,
   match: Flags.string({
     name: 'match',
     char: 'm',

package/src/commands/app/state/put.js

@@ -9,12 +9,12 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
-import { BaseCommand } from '../../../BaseCommand.js'
+import { StateBaseCommand } from '../../../StateBaseCommand.js'
 import { Args, Flags } from '@oclif/core'
-import { DEFAULT_TTL_SECONDS } from '../../../constants.js'
+import { DEFAULT_TTL_SECONDS } from '../../../constants/state.js'
 import chalk from 'chalk'
 
-export class Put extends BaseCommand {
+export class Put extends StateBaseCommand {
   async run () {
     const { key, value } = this.args
     const { json, ttl } = this.flags
@@ -55,7 +55,7 @@ Put.args = {
 }
 
 Put.flags = {
-  ...BaseCommand.flags,
+  ...StateBaseCommand.flags,
   ttl: Flags.integer({
     char: 't',
     description: 'Time to live in seconds. Default is 86400 (24 hours), max is 31536000 (1 year).',

package/src/commands/app/state/stats.js

@@ -9,9 +9,9 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
-import { BaseCommand } from '../../../BaseCommand.js'
+import { StateBaseCommand } from '../../../StateBaseCommand.js'
 
-export class Stats extends BaseCommand {
+export class Stats extends StateBaseCommand {
   async run () {
     const ret = await this.state.stats()
     this.log(

package/src/constants/db.js

@@ -0,0 +1,32 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+export const DB_STATUS = {
+  PROVISIONED: 'PROVISIONED',
+  REQUESTED: 'REQUESTED',
+  PROCESSING: 'PROCESSING',
+  FAILED: 'FAILED',
+  REJECTED: 'REJECTED',
+  NOT_PROVISIONED: 'NOT_PROVISIONED',
+  DELETED: 'DELETED',
+  UNKNOWN: 'UNKNOWN'
+}
+
+// Region constants for db are separate from state in case they diverge in the future
+export const CONFIG_DB_REGION = 'db.region'
+export const DEFAULT_REGION = 'amer'
+export const AVAILABLE_REGIONS = {
+  prod: ['amer', 'emea', 'apac'],
+  stage: ['amer', 'amer2']
+}
+
+export const CONFIG_DB_ENDPOINT = 'db.endpoint'

package/src/constants/global.js

@@ -0,0 +1,14 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+export const CONFIG_RUNTIME_NAMESPACE = 'runtime.namespace'
+export const CONFIG_RUNTIME_AUTH = 'runtime.auth'

package/src/{constants.js → constants/state.js}

@@ -11,6 +11,9 @@ governing permissions and limitations under the License.
 */
 
 // state.region is a new configuration (env=AIO_STATE_REGION)
+// Region constants for state are separate from db in case they diverge in the future
 export const CONFIG_STATE_REGION = 'state.region'
+export const DEFAULT_REGION = 'amer'
+export const AVAILABLE_REGIONS = ['amer', 'emea', 'apac']
 
 export const DEFAULT_TTL_SECONDS = 60 * 60 * 24 // 24 hours

package/src/utils/inputValidation.js

@@ -0,0 +1,74 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+/**
+ * Helper to verify the argument/option input is a javascript or json object
+ * Returns the object if valid, or throws an error if invalid
+ *
+ * @param {object|string} input - The input to validate
+ * @param {string=} label - Optional label for an error message, such as the argument/option name
+ * @returns {object} - The validated object
+ */
+export function asObject (input, label = undefined) {
+  label = label ? `${label}: ` : ''
+  if (typeof input === 'object' && input !== null && !Array.isArray(input)) {
+    return input
+  }
+  if (typeof input !== 'string' || input.trim().length === 0) {
+    throw new Error(`${label}Value '${input}' is not a JSON object`)
+  }
+
+  let result
+  try {
+    result = JSON.parse(input)
+  } catch (e) {
+    e.message = `${label}JSON parse error: ${e.message}`
+    throw e
+  }
+  if (typeof result !== 'object' || result === null || Array.isArray(result)) {
+    throw new Error(`${label}Value '${input}' is not a JSON object`)
+  }
+
+  return result
+}
+
+/**
+ * Helper to verify the argument/option input is a non-empty string
+ * Throws an error if the input is not a string with length > 0
+ * Does not check for whitespace-only strings, call `trim()` when passing the input if needed
+ *
+ * @param {string} input - The input to validate
+ * @param {string=} label - Optional label for an error message, such as the argument/option name
+ * @returns {string} - The validated non-empty string
+ */
+export function isNonEmptyString (input, label = undefined) {
+  label = label ? `${label}: ` : ''
+  if (typeof input !== 'string' || input.length === 0) {
+    throw new Error(`${label}Must be a non-empty string`)
+  }
+  return input
+}
+
+/**
+ * Determine if a runtime namespace corresponds to a production workspace.
+ * production if optional prefix<development-> + orgId + projectName with no trailing workspace suffix.
+ *
+ * @param {string} namespace - The runtime namespace to check
+ * @returns {boolean} - True if the namespace is a production workspace, false otherwise
+ */
+export function isProductionNamespace (namespace) {
+  if (typeof namespace !== 'string' || !namespace.trim()) {
+    throw new Error('Invalid runtime namespace')
+  }
+  const PROD_NS_REGEX = /^(?:development-)?\d+-[a-z0-9]+$/i
+  return PROD_NS_REGEX.test(namespace)
+}

package/src/utils/output.js

@@ -0,0 +1,35 @@
+/*
+Copyright 2024 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+/**
+ * Prettifies json for readable log output
+ *
+ * @param {*} val - The value to pretty print as JSON.
+ * @param {number} indent - The number of spaces to indent the entire output.
+ * @returns {string} - The pretty printed JSON string.
+ */
+export function prettyJson (val, indent = 5) {
+  let out
+  if (typeof val === 'string') {
+    try {
+      out = JSON.stringify(JSON.parse(val), null, 2)
+    } catch (e) {
+      out = val // If parsing fails, return the original string
+    }
+  } else {
+    out = JSON.stringify(val, null, 2)
+  }
+  if (indent) {
+    out = out.replace(/^/gm, ' '.repeat(indent))
+  }
+  return out
+}