appwrite-utils-cli 0.0.12 → 0.0.14

package/dist/migrations/afterImportActions.js

@@ -2,6 +2,7 @@ import { Databases, Storage, InputFile, Query, ID, Client, } from "node-appwrite
 import path from "path";
 import fs from "fs";
 import os from "os";
+import { logger } from "./logging.js";
 const getDatabaseFromConfig = (config) => {
     if (!config.appwriteClient) {
         config.appwriteClient = new Client()
@@ -307,6 +308,7 @@ export const afterImportActions = {
             }
         }
         catch (error) {
+            logger.error(`Error creating file and updating field, params were:\ndbId: ${dbId}, collId: ${collId}, docId: ${docId}, fieldName: ${fieldName}, filePath: ${filePath}, fileName: ${fileName}\n\nError: ${error}`);
             console.error("Error creating file and updating field: ", error);
             console.log(`Params were: dbId: ${dbId}, collId: ${collId}, docId: ${docId}, fieldName: ${fieldName}, filePath: ${filePath}, fileName: ${fileName}`);
         }

package/dist/migrations/importController.js

@@ -119,8 +119,8 @@ export class ImportController {
                 continue;
             console.log(`Processing update definitions for collection ID: ${collection.$id}`);
             await this.processBatch(db, collection, importDef, dataToImport);
-            await setAllPendingAfterImportActionsToReady(this.database, db.$id, collection.$id);
         }
+        await setAllPendingAfterImportActionsToReady(this.database, db.$id, collection.$id);
     }
     async loadData(importDef) {
         const filePath = path.resolve(this.appwriteFolderPath, importDef.filePath);
@@ -158,7 +158,6 @@ export class ImportController {
                 let associatedDoc;
                 if (isMembersCollection &&
                     (finalItem.hasOwnProperty("email") || item.hasOwnProperty("phone"))) {
-                    console.log("Found members collection, creating user...");
                     const usersController = new UsersController(this.config, this.database);
                     const userToCreate = AuthUserCreateSchema.safeParse({
                         ...finalItem,
@@ -172,7 +171,6 @@ export class ImportController {
                     createIdToUse = user.$id;
                     context.docId = createIdToUse;
                     context = { ...context, ...user };
-                    console.log("Created user, deleting keys in finalItem that exist in user...");
                     const associatedDocFound = await this.database.listDocuments(db.$id, context.collId, [Query.equal("$id", createIdToUse)]);
                     if (associatedDocFound.documents.length > 0) {
                         associatedDoc = associatedDocFound.documents[0];
@@ -185,7 +183,6 @@ export class ImportController {
                             deletedKeys.push(key);
                         }
                     });
-                    console.log(`Set createIdToUse to ${createIdToUse}. Deleted keys: ${deletedKeys.join(", ")}.`);
                 }
                 else if (isMembersCollection) {
                     logger.error(`Skipping user & contact creation for ${item} due to lack of email...`);
@@ -201,15 +198,13 @@ export class ImportController {
                     !associatedDoc) {
                     const createdContext = await this.handleCreate(context, finalItem, updateDefs, createIdToUse);
                     context = { ...context, ...createdContext };
-                    logger.info(`Handled create for ${context.docId}}`);
                 }
                 else {
                     const updatedContext = await this.handleUpdate(context, finalItem, importDef);
                     context = { ...context, ...updatedContext };
-                    logger.info(`Handled update for ${context.docId}`);
                 }
                 const afterImportActionContext = structuredClone(context);
-                const attributeMappingsWithActions = this.getAttributeMappingsWithActions(importDef.attributeMappings, context, finalItem);
+                const attributeMappingsWithActions = this.getAttributeMappingsWithActions(importDef.attributeMappings, afterImportActionContext, finalItem);
                 if (attributeMappingsWithActions.some((m) => m.postImportActions)) {
                     logger.info(`Pushing to post-import actions queue for ${context.docId}`);
                     const afterImportOperationContext = ContextObject.parse({
@@ -238,9 +233,6 @@ export class ImportController {
     async handleCreate(context, finalItem, updateDefs, id) {
         const existing = await documentExists(this.database, context.dbId, context.collId, finalItem);
         if (!existing) {
-            if (id) {
-                console.log(`Creating document with provided ID (member): ${id}`);
-            }
             const createdDoc = await this.database.createDocument(context.dbId, context.collId, id || ID.unique(), finalItem);
             context.docId = createdDoc.$id;
             context.createdDoc = createdDoc;
@@ -253,7 +245,6 @@ export class ImportController {
                     }
                 });
             }
-            console.log(`Created document ID: ${createdDoc.$id}`);
             return context;
         }
         else {
@@ -354,13 +345,19 @@ export class ImportController {
             for (const batch of resultsData) {
                 const actionOperation = ContextObject.parse(JSON.parse(batch.data));
                 const { context, finalItem, attributeMappings } = actionOperation;
+                if (finalItem.$id && !context.docId) {
+                    context.docId =
+                        finalItem.$id || context.createdDoc.$id || context.$id || undefined;
+                    logger.info(`Setting docId to ${finalItem.$id} because docId not found in context, batch ${batch.$id}, context is ${JSON.stringify(context)}`);
+                }
                 try {
                     await this.importDataActions.executeAfterImportActions(finalItem, attributeMappings, context);
                     // Mark batch as processed
                     await this.database.deleteDocument("migrations", "batches", batch.$id);
                 }
                 catch (error) {
-                    logger.error(`Failed to execute batch ${batch.$id}:`, error);
+                    logger.error(`Failed to execute batch ${batch.$id}:`, error, "Context is :", context);
+                    await this.database.deleteDocument("migrations", "batches", batch.$id);
                 }
             }
             // After processing all batches, update the operation status

package/dist/migrations/importDataActions.js

@@ -58,7 +58,6 @@ export class ImportDataActions {
         const convertedItem = convertObjectBySchema(item, conversionSchema);
         // Merge the converted item back into the original item object
         Object.assign(item, convertedItem);
-        console.log("Converted item:", item);
         return item;
     }
     /**
@@ -73,7 +72,6 @@ export class ImportDataActions {
             if (!validationActions ||
                 !Array.isArray(validationActions) ||
                 !validationActions.length) {
-                console.warn("No validation actions defined for the item, assuming true");
                 return true; // Assume items without validation actions as valid.
             }
             for (const ruleDef of validationActions) {
@@ -137,7 +135,7 @@ export class ImportDataActions {
                 await actionMethod(this.config, ...resolvedParams);
             }
             catch (error) {
-                logger.error(`Error executing action '${actionName}':`, error);
+                logger.error(`Error executing action '${actionName}' with context:`, context, error);
                 throw new Error(`Execution failed for action '${actionName}': ${error.message}`);
             }
         }

package/dist/migrations/logging.js

@@ -1,7 +1,7 @@
 import winston from "winston";
 export const logger = winston.createLogger({
     level: "info",
-    format: winston.format.prettyPrint(),
+    format: winston.format.json({ space: 2 }),
     defaultMeta: { service: "appwrite-utils-cli" },
     transports: [
         //
@@ -9,6 +9,7 @@ export const logger = winston.createLogger({
         // - Write all logs with importance level of `info` or less to `combined.log`
         //
         new winston.transports.File({ filename: "error.log", level: "error" }),
+        new winston.transports.File({ filename: "warn.log", level: "warn" }),
         new winston.transports.File({ filename: "combined.log" }),
     ],
 });

package/dist/migrations/users.js

@@ -40,7 +40,6 @@ export class UsersController {
         }
     }
     async createUserAndReturn(item) {
-        console.log("Creating user with item", item);
         // Attempt to find an existing user by email or phone.
         let foundUsers = [];
         if (item.email) {
@@ -59,13 +58,11 @@ export class UsersController {
         }
         let userToReturn = foundUsers[0] || undefined;
         if (!userToReturn) {
-            console.log("Creating user cause not found");
             userToReturn = await this.users.create(item.userId || ID.unique(), item.email || undefined, item.phone && item.phone.length < 15 && item.phone.startsWith("+")
                 ? item.phone
                 : undefined, item.password?.toLowerCase() || `changeMe${item.email}`.toLowerCase(), item.name || undefined);
         }
         else {
-            console.log("Updating user cause found");
             // Update user details as necessary, ensuring email uniqueness if attempting an update.
             if (item.email &&
                 item.email !== userToReturn.email &&

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "appwrite-utils-cli",
   "description": "Appwrite Utility Functions to help with database management, data conversion, data import, migrations, and much more. Meant to be used as a CLI tool, I do not recommend installing this in frontend environments.",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "main": "src/main.ts",
   "type": "module",
   "repository": {

package/src/migrations/afterImportActions.ts

@@ -11,6 +11,7 @@ import type { AppwriteConfig } from "./schema.js";
 import path from "path";
 import fs from "fs";
 import os from "os";
+import { logger } from "./logging.js";
 
 const getDatabaseFromConfig = (config: AppwriteConfig) => {
   if (!config.appwriteClient) {
@@ -481,6 +482,9 @@ export const afterImportActions = {
         console.log("Created file from path: ", file.$id);
       }
     } catch (error) {
+      logger.error(
+        `Error creating file and updating field, params were:\ndbId: ${dbId}, collId: ${collId}, docId: ${docId}, fieldName: ${fieldName}, filePath: ${filePath}, fileName: ${fileName}\n\nError: ${error}`
+      );
       console.error("Error creating file and updating field: ", error);
       console.log(
         `Params were: dbId: ${dbId}, collId: ${collId}, docId: ${docId}, fieldName: ${fieldName}, filePath: ${filePath}, fileName: ${fileName}`

package/src/migrations/importController.ts

@@ -199,12 +199,12 @@ export class ImportController {
         `Processing update definitions for collection ID: ${collection.$id}`
       );
       await this.processBatch(db, collection, importDef, dataToImport);
-      await setAllPendingAfterImportActionsToReady(
-        this.database,
-        db.$id,
-        collection.$id
-      );
     }
+    await setAllPendingAfterImportActionsToReady(
+      this.database,
+      db.$id,
+      collection.$id
+    );
   }
 
   async loadData(importDef: ImportDef): Promise<any[]> {
@@ -269,7 +269,6 @@ export class ImportController {
             isMembersCollection &&
             (finalItem.hasOwnProperty("email") || item.hasOwnProperty("phone"))
           ) {
-            console.log("Found members collection, creating user...");
             const usersController = new UsersController(
               this.config,
               this.database
@@ -288,9 +287,6 @@ export class ImportController {
             createIdToUse = user.$id;
             context.docId = createIdToUse;
             context = { ...context, ...user };
-            console.log(
-              "Created user, deleting keys in finalItem that exist in user..."
-            );
             const associatedDocFound = await this.database.listDocuments(
               db.$id,
               context.collId,
@@ -307,11 +303,6 @@ export class ImportController {
                 deletedKeys.push(key);
               }
             });
-            console.log(
-              `Set createIdToUse to ${createIdToUse}. Deleted keys: ${deletedKeys.join(
-                ", "
-              )}.`
-            );
           } else if (isMembersCollection) {
             logger.error(
               `Skipping user & contact creation for ${item} due to lack of email...`
@@ -341,7 +332,6 @@ export class ImportController {
               createIdToUse
             );
             context = { ...context, ...createdContext };
-            logger.info(`Handled create for ${context.docId}}`);
           } else {
             const updatedContext = await this.handleUpdate(
               context,
@@ -349,13 +339,12 @@ export class ImportController {
               importDef
             );
             context = { ...context, ...updatedContext };
-            logger.info(`Handled update for ${context.docId}`);
           }
           const afterImportActionContext = structuredClone(context);
           const attributeMappingsWithActions =
             this.getAttributeMappingsWithActions(
               importDef.attributeMappings,
-              context,
+              afterImportActionContext,
               finalItem
             );
           if (attributeMappingsWithActions.some((m) => m.postImportActions)) {
@@ -404,9 +393,6 @@ export class ImportController {
       finalItem
     );
     if (!existing) {
-      if (id) {
-        console.log(`Creating document with provided ID (member): ${id}`);
-      }
       const createdDoc = await this.database.createDocument(
         context.dbId,
         context.collId,
@@ -428,8 +414,6 @@ export class ImportController {
           }
         });
       }
-
-      console.log(`Created document ID: ${createdDoc.$id}`);
       return context;
     } else {
       console.log("Document already exists, skipping creation.");
@@ -563,6 +547,17 @@ export class ImportController {
       for (const batch of resultsData) {
         const actionOperation = ContextObject.parse(JSON.parse(batch.data));
         const { context, finalItem, attributeMappings } = actionOperation;
+        if (finalItem.$id && !context.docId) {
+          context.docId =
+            finalItem.$id || context.createdDoc.$id || context.$id || undefined;
+          logger.info(
+            `Setting docId to ${
+              finalItem.$id
+            } because docId not found in context, batch ${
+              batch.$id
+            }, context is ${JSON.stringify(context)}`
+          );
+        }
         try {
           await this.importDataActions.executeAfterImportActions(
             finalItem,
@@ -576,7 +571,17 @@ export class ImportController {
             batch.$id
           );
         } catch (error) {
-          logger.error(`Failed to execute batch ${batch.$id}:`, error);
+          logger.error(
+            `Failed to execute batch ${batch.$id}:`,
+            error,
+            "Context is :",
+            context
+          );
+          await this.database.deleteDocument(
+            "migrations",
+            "batches",
+            batch.$id
+          );
         }
       }
 

package/src/migrations/importDataActions.ts

@@ -92,7 +92,6 @@ export class ImportDataActions {
     const convertedItem = convertObjectBySchema(item, conversionSchema);
     // Merge the converted item back into the original item object
     Object.assign(item, convertedItem);
-    console.log("Converted item:", item);
     return item;
   }
 
@@ -114,9 +113,6 @@ export class ImportDataActions {
         !Array.isArray(validationActions) ||
         !validationActions.length
       ) {
-        console.warn(
-          "No validation actions defined for the item, assuming true"
-        );
         return true; // Assume items without validation actions as valid.
       }
       for (const ruleDef of validationActions) {
@@ -223,7 +219,11 @@ export class ImportDataActions {
         );
         await (actionMethod as any)(this.config, ...resolvedParams);
       } catch (error: any) {
-        logger.error(`Error executing action '${actionName}':`, error);
+        logger.error(
+          `Error executing action '${actionName}' with context:`,
+          context,
+          error
+        );
         throw new Error(
           `Execution failed for action '${actionName}': ${error.message}`
         );

package/src/migrations/logging.ts

@@ -2,7 +2,7 @@ import winston from "winston";
 
 export const logger = winston.createLogger({
   level: "info",
-  format: winston.format.prettyPrint(),
+  format: winston.format.json({ space: 2 }),
   defaultMeta: { service: "appwrite-utils-cli" },
   transports: [
     //
@@ -10,6 +10,7 @@ export const logger = winston.createLogger({
     // - Write all logs with importance level of `info` or less to `combined.log`
     //
     new winston.transports.File({ filename: "error.log", level: "error" }),
+    new winston.transports.File({ filename: "warn.log", level: "warn" }),
     new winston.transports.File({ filename: "combined.log" }),
   ],
 });

package/src/migrations/users.ts

@@ -49,8 +49,6 @@ export class UsersController {
   }
 
   async createUserAndReturn(item: AuthUserCreate) {
-    console.log("Creating user with item", item);
-
     // Attempt to find an existing user by email or phone.
     let foundUsers: Models.User<Models.Preferences>[] = [];
     if (item.email) {
@@ -71,7 +69,6 @@ export class UsersController {
     let userToReturn = foundUsers[0] || undefined;
 
     if (!userToReturn) {
-      console.log("Creating user cause not found");
       userToReturn = await this.users.create(
         item.userId || ID.unique(),
         item.email || undefined,
@@ -82,7 +79,6 @@ export class UsersController {
         item.name || undefined
       );
     } else {
-      console.log("Updating user cause found");
       // Update user details as necessary, ensuring email uniqueness if attempting an update.
       if (
         item.email &&