@adobe/aio-lib-db 0.1.0-beta.2 → 0.1.0-beta.4

package/README.md

@@ -39,7 +39,12 @@ __OW_API_KEY=user:password
 
 ### Basic Usage
 
-> When calling `libDb.init()`, you can pass `{ region: '<region>>' }` to specify the region where your database is provisioned.  
+> When calling `libDb.init()`, you can pass `{ region: '<region>>' }` to specify the region where your database is provisioned, or if region is defined in `app.config.yaml` of aio app, then `libDb.init()` will initialize in specified region.
+> 
+> **Note:** region defined in `app.config.yaml` holds preference over passed in config param.
+> 
+> If region is not specified in any of the above ways, it falls back to default.
+> 
 > Valid regions are `amer` (default), `emea`, and `apac`.
 
 ```javascript

package/lib/DbBase.js

@@ -14,6 +14,7 @@ const { pingApi, provisionStatusApi, provisionRequestApi, deleteDatabaseApi } =
 const DbClient = require('./DbClient')
 const DbError = require("./DbError")
 const { getAxiosClient } = require("../utils/axiosUtils")
+const { getRegionFromAppConfig } = require("../utils/manifestUtils")
 const {
   ALLOWED_REGIONS, STAGE_ENV, STAGE_ENDPOINT, PROD_ENDPOINT_RUNTIME, PROD_ENDPOINT_EXTERNAL
 } = require("./constants")
@@ -86,7 +87,15 @@ class DbBase {
   static async init(config = {}) {
     const namespace = config.namespace || process.env.__OW_NAMESPACE
     const apikey = config.apikey || process.env.__OW_API_KEY
-    const region = config.region || ALLOWED_REGIONS[getCliEnv()].at(0)
+    let aioAppRegion = null
+    
+    try {
+      aioAppRegion = getRegionFromAppConfig(process.cwd())
+    } catch (e) {
+      throw new DbError(`Error reading region from app config: ${e.message}`)
+    }
+
+    const region = aioAppRegion || config.region || ALLOWED_REGIONS[getCliEnv()].at(0)
     return new DbBase(region, namespace, apikey)
   }
 

package/lib/api/db.js

@@ -10,6 +10,8 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 const { apiPost, apiGet } = require("../../utils/apiRequest")
+const { writeRegionToAppConfig } = require("../../utils/manifestUtils")
+const logger = require('@adobe/aio-lib-core-logging')('@adobe/aio-lib-db', { provider: 'debug' })
 
 /**
  * Make a post request to the App Builder Database Service db API and return the result
@@ -46,7 +48,17 @@ async function getDbApi(db, endpoint) {
  * @throws {DbError}
  */
 async function provisionRequest(db) {
-  return await postDbApi(db, db.axiosClient, 'provision/request')
+  const response = await postDbApi(db, db.axiosClient, 'provision/request')
+
+  // Update app.config.yaml with the region after successful provision request
+  try {
+    writeRegionToAppConfig(process.cwd(), db.region)
+    logger.info(`Updated app.config.yaml with region: ${db.region}`)
+  } catch (error) {
+    logger.warn(`Failed to update app.config.yaml: ${error.message}`)
+  }
+
+  return response
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/aio-lib-db",
-  "version": "0.1.0-beta.2",
+  "version": "0.1.0-beta.4",
   "description": "An abstraction on top of Document DB storage",
   "main": "index.js",
   "scripts": {
@@ -16,11 +16,13 @@
   ],
   "contributors": [],
   "dependencies": {
+    "@adobe/aio-lib-core-logging": "^3.0.2",
     "@adobe/aio-lib-env": "^3.0.1",
     "axios": "^1.8.4",
     "bson": "^6.10.3",
     "dotenv": "^17.0.0",
     "http-cookie-agent": "^6.0.8",
+    "js-yaml": "^4.1.0",
     "tough-cookie": "^5.1.2"
   },
   "devDependencies": {

package/utils/ejsonHandler.js

@@ -35,6 +35,10 @@ function transformBsonPrimitives(obj) {
     })
   }
   else if (typeof obj === 'object') {
+    // If the type was recognized by the parser, any properties should also have been handled so return it as-is
+    const objName = obj?.constructor?.name
+    if (objName && objName !== 'Object') return obj
+
     const mapped = {}
     Object.keys(obj).forEach((key) => {
       mapped[key] = transformBsonPrimitives(obj[key])

package/utils/manifestUtils.js

@@ -0,0 +1,141 @@
+/*
+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.
+*/
+const fs = require('fs')
+const path = require('path')
+const yaml = require('js-yaml')
+
+
+/**
+ * Walk upwards from startDir looking for the filename. Returns the absolute
+ * path to the first match or null if none found.
+ *
+ * @param {string} startDir - Starting directory for search
+ * @param {string} filename - Filename to search for
+ * @returns {string|null} Absolute path to file or null if not found
+ */
+function getFilePath(startDir, filename) {
+  if (!startDir || typeof startDir !== 'string') return null
+  if (!filename || typeof filename !== 'string') return null
+  
+  let dir = path.resolve(startDir)
+  const root = path.parse(dir).root
+  while (true) {
+    const manifestPath = path.join(dir, filename)
+    if (fs.existsSync(manifestPath)) return manifestPath
+    if (dir === root) break
+    dir = path.dirname(dir)
+  }
+  return null
+}
+
+/**
+ * Read and parse YAML configuration file
+ *
+ * @param {string} filePath - Path to YAML file
+ * @returns {Object} Parsed YAML content or empty object if file doesn't exist
+ */
+function readYamlConfig(filePath) {
+  if (!fs.existsSync(filePath)) return {}
+  const content = fs.readFileSync(filePath, 'utf8')
+  return yaml.load(content)
+}
+
+/**
+ * Read `app.config.yaml` (if present) and return the `runtimeManifest` object
+ * or null if not found.
+ *
+ * @param {string} startDir - Starting directory to search from
+ * @returns {Object|null} Runtime manifest object or null if not found
+ */
+function getRuntimeManifestFromAppConfig(startDir) {
+  const APP_CONFIG_FILE = 'app.config.yaml'
+  const appConfigPath = getFilePath(startDir, APP_CONFIG_FILE)
+  if (!appConfigPath) return null
+  const parsed = readYamlConfig(appConfigPath)
+  
+  // Return runtimeManifest from application.runtimeManifest
+  return parsed?.application?.runtimeManifest || null
+}
+
+/**
+ * Extract region from app config manifest
+ *
+ * @param {string} startDir - Starting directory to search from
+ * @returns {string|null} Region string or null if not found
+ */
+function getRegionFromAppConfig(startDir) {
+  const runtimeManifest = getRuntimeManifestFromAppConfig(startDir)
+  return runtimeManifest?.database?.region || null
+}
+
+/**
+ * Write database configuration to existing app.config.yaml
+ *
+ * @param {string} startDir - Starting directory to search from
+ * @param {string} region - Database region
+ * @returns {boolean} True if region was written, false if file not found
+ * @throws {Error} If file operations fail (read/write/parse errors)
+ */
+function writeRegionToAppConfig(startDir, region) {
+  const APP_CONFIG_FILE = 'app.config.yaml'
+  const appConfigPath = getFilePath(startDir, APP_CONFIG_FILE)
+
+  // Return false if no app.config.yaml exists
+  if (!appConfigPath) {
+    return false
+  }
+
+  // Read existing config
+  const existingConfig = readYamlConfig(appConfigPath)
+
+  // Get current auto-provision value from runtimeManifest.database
+  const currentAutoProv = existingConfig?.application?.runtimeManifest?.database?.['auto-provision']
+
+  // Determine auto-provision value:
+  // - If true, keep it true
+  // - If false or not present, set to false
+  const autoProvision = currentAutoProv === true ? true : false
+
+  // Ensure nested structure exists and add region + auto-provision inside runtimeManifest
+  const config = {
+    ...existingConfig,
+    application: {
+      ...existingConfig?.application,
+      runtimeManifest: {
+        ...existingConfig?.application?.runtimeManifest,
+        database: {
+          ...existingConfig?.application?.runtimeManifest?.database,
+          'auto-provision': autoProvision,
+          region: region
+        }
+      }
+    }
+  }
+
+  // Write updated config back to file
+  const yamlContent = yaml.dump(config, {
+    defaultFlowStyle: false,
+    lineWidth: -1
+  })
+
+  fs.writeFileSync(appConfigPath, yamlContent, 'utf8')
+  return true
+
+}
+
+module.exports = {
+  getFilePath,
+  readYamlConfig,
+  getRuntimeManifestFromAppConfig,
+  getRegionFromAppConfig,
+  writeRegionToAppConfig
+}