fix: export database options and customScripts safely (#1095)

* fix: handle optional database options and customScripts safely

* fix: ensure options are handled correctly when undefined in database handlers

* fix: format path construction for improved readability in database dump tests

Author: kushalshit27

src/context/directory/handlers/databases.ts

@@ -54,15 +54,15 @@ function getDatabase(
   const database = {
     ...metaData,
     options: {
-      //@ts-ignore because this code exists currently, but still needs to be understood if it is correct or not
-      ...metaData.options,
-      //@ts-ignore because this code exists currently, but still needs to be understood if it is correct or not
-      ...(metaData.customScripts && { customScripts: metaData.customScripts }),
+      // @ts-ignore because this code exists currently, but still needs to be understood if it is correct or not
+      ...(metaData.options || {}),
+      // @ts-ignore because this code exists currently, but still needs to be understood if it is correct or not
+      ...(metaData?.customScripts && { customScripts: metaData?.customScripts }),
     },
   };
 
   // If any customScripts configured then load content of files
-  if (database.options.customScripts) {
+  if (database.options?.customScripts) {
     Object.entries(database.options.customScripts).forEach(([name, script]: [string, string]) => {
       if (!constants.DATABASE_SCRIPTS.includes(name)) {
         // skip invalid keys in customScripts object
@@ -128,18 +128,18 @@ async function dump(context: DirectoryContext): Promise<void> {
         ),
       }),
       options: {
-        ...database.options,
+        ...(database.options || {}),
         // customScripts option only written if there are scripts
-        ...(database.options.customScripts && {
+        ...(database.options?.customScripts && {
           customScripts: Object.entries(database.options.customScripts)
-            //@ts-ignore because we'll fix this in subsequent PR
+            // @ts-ignore because we'll fix this in subsequent PR
             .sort(sortCustomScripts)
             .reduce((scripts, [name, script]) => {
               // Dump custom script to file
               const scriptName = sanitize(`${name}.js`);
               const scriptFile = path.join(dbFolder, scriptName);
               log.info(`Writing ${scriptFile}`);
-              //@ts-ignore because we'll fix this in subsequent PR
+              // @ts-ignore because we'll fix this in subsequent PR
               fs.writeFileSync(scriptFile, script);
               scripts[name] = `./${scriptName}`;
               return scripts;

src/context/yaml/handlers/databases.ts

@@ -19,9 +19,9 @@ async function parse(context: YAMLContext): Promise<ParsedDatabases> {
       ...databases.map((database) => ({
         ...database,
         options: {
-          ...database.options,
+          ...(database.options || {}),
           // customScripts option only written if there are scripts
-          ...(database.options.customScripts && {
+          ...(database.options?.customScripts && {
             customScripts: Object.entries(database.options.customScripts).reduce(
               (scripts, [name, script]) => ({
                 ...scripts,
@@ -54,9 +54,9 @@ async function dump(context: YAMLContext): Promise<ParsedDatabases> {
           enabled_clients: mapClientID2NameSorted(database.enabled_clients, clients || []),
         }),
         options: {
-          ...database.options,
+          ...(database.options || {}),
           // customScripts option only written if there are scripts
-          ...(database.options.customScripts && {
+          ...(database.options?.customScripts && {
             customScripts: Object.entries(database.options.customScripts)
               //@ts-ignore because we'll fix this in subsequent PR
               .sort(sortCustomScripts)

test/context/directory/databases.test.js

@@ -327,4 +327,31 @@ describe('#directory context databases', () => {
       scriptValidate
     );
   });
+
+  it('should dump database with undefined options', async () => {
+    cleanThenMkdir(dbDumpDir);
+    const context = new Context({ AUTH0_INPUT_FILE: dbDumpDir }, mockMgmtClient());
+
+    context.assets.databases = [
+      {
+        name: 'users-no-options',
+        enabled_clients: [],
+        // options field intentionally missing
+        strategy: 'auth0',
+      },
+    ];
+
+    await handler.dump(context);
+    const scriptsFolder = path.join(
+      dbDumpDir,
+      constants.DATABASE_CONNECTIONS_DIRECTORY,
+      'users-no-options'
+    );
+    expect(loadJSON(path.join(scriptsFolder, 'database.json'))).to.deep.equal({
+      name: 'users-no-options',
+      enabled_clients: [],
+      options: {}, // should be empty object when options is undefined
+      strategy: 'auth0',
+    });
+  });
 });

test/context/yaml/databases.test.js

@@ -256,4 +256,33 @@ describe('#YAML context databases', () => {
       scriptValidate
     );
   });
+
+  it('should dump database with undefined options', async () => {
+    cleanThenMkdir(dbDumpDir);
+    const context = new Context(
+      { AUTH0_INPUT_FILE: path.join(dbDumpDir, 'tenant.yaml') },
+      mockMgmtClient()
+    );
+
+    context.assets.databases = [
+      {
+        name: 'users-no-options',
+        enabled_clients: [],
+        // options field intentionally missing
+        strategy: 'auth0',
+      },
+    ];
+
+    const dumped = await handler.dump(context);
+    expect(dumped).to.deep.equal({
+      databases: [
+        {
+          name: 'users-no-options',
+          enabled_clients: [],
+          options: {}, // should be empty object when options is undefined
+          strategy: 'auth0',
+        },
+      ],
+    });
+  });
 });