Melhorias e refatoração em várias classes

Adicionadas explicações e comentários em `RefreshSPOLists.cs`, `ActivitiesDQ.cs`, `Context.cs`, `InvoiceRequestDQ.cs`, `TimesheetDQ.cs`, `SPOList.cs`, `SPOUser.cs`, `RefreshSQLLists.cs`, `SQLInteraction.cs` e `ConfigHelper.cs`.

A lógica de verificação de argumentos, tratamento de exceções e inicialização de listas foi aprimorada. A modularidade do código foi melhorada com a adição de métodos e a legibilidade foi aumentada através de comentários explicativos.

Author: kill74

SPOtoSQL-Snapshots/ConsoleApp1/SPODataQuality/RefreshSPOLists.cs

@@ -10,82 +10,98 @@ namespace Bring.SPODataQuality
 {
     internal class RefreshSPOLists
     {
+        // Main entry point of the application, executed when the program starts
         private static void Main(string[] args)
         {
             try
             {
+                // Print debug information and the current timestamp
                 Console.WriteLine("DEBUG: Iniciando Main");
                 Console.WriteLine("CURRENT TIME: " + DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fff"));
 
+                // Retrieve SharePoint credentials (username and password) from a configuration source
                 var (username, password) = ConfigurationReader.GetSharePointCredentials();
-                SPOUser spoUser = new SPOUser(username, password);
+                SPOUser spoUser = new SPOUser(username, password); // Create a SharePoint user object
                 Console.WriteLine("DEBUG: SPOUser criado");
 
+                // Initialize two SharePoint list objects and assign the user credentials to them
                 var list1 = new SPOList();
                 list1.SPOUser = spoUser;
                 Console.WriteLine("DEBUG: Primeiro SPOList configurado");
 
                 var list2 = new SPOList();
                 list2.SPOUser = spoUser;
                 Console.WriteLine("DEBUG: Segundo SPOList configurado");
+
+                // Check if command-line arguments are provided
                 if ((uint)args.Length > 0U)
                 {
-                    string lower = args[0].ToLower();
+                    string lower = args[0].ToLower(); // Convert the first argument to lowercase
                     Console.WriteLine("DEBUG: Argumento recebido - " + lower);
 
-                    if (!(lower == "daily"))
+                    // Decide which update to perform based on the argument
+                    if (lower == "daily")
                     {
-                        if (lower == "monthly")
-                        {
-                            Console.WriteLine("DEBUG: Executando monthly");
-                            RefreshSQLLists.SPOtoSQLUpdate(false);
-                        }
-                        else
-                        {
-                            Console.WriteLine("Unrecognized argument, please use daily or monthly as the argument");
-                        }
+                        // Perform a daily update from SharePoint to SQL Server
+                        Console.WriteLine("DEBUG: Executando daily");
+                        RefreshSQLLists.SPOtoSQLUpdate(true);
+                    }
+                    else if (lower == "monthly")
+                    {
+                        // Perform a monthly update from SharePoint to SQL Server
+                        Console.WriteLine("DEBUG: Executando monthly");
+                        RefreshSQLLists.SPOtoSQLUpdate(false);
                     }
                     else
                     {
-                        Console.WriteLine("DEBUG: Executando daily");
-                        RefreshSQLLists.SPOtoSQLUpdate(true);
+                        // Handle unrecognized arguments
+                        Console.WriteLine("Unrecognized argument, please use daily or monthly as the argument");
                     }
                 }
 
+                // Indicate the end of processing
                 Console.WriteLine("End of requests.");
                 Console.WriteLine();
             }
             catch (Exception ex)
             {
+                // Catch and display any errors that occur during execution
                 Console.WriteLine("An error occurred: " + ex.Message);
             }
         }
 
+        // Method to retrieve and display all lists from a specific SharePoint site
         public static void GetAllLists()
         {
             Console.WriteLine("DEBUG: Entrando em GetAllLists");
+            // Get SharePoint credentials
             var (username, password) = ConfigurationReader.GetSharePointCredentials();
             SPOUser spoUser = new SPOUser(username, password);
+            // Set up a context for the SharePoint site named "seed"
             Context context = new Context()
             {
                 Site = "seed",
                 SPOUser = spoUser
             };
+            // Iterate through all lists in the SharePoint site
             foreach (List allList in (ClientObjectCollection<List>)context.GetAllLists())
             {
                 Console.WriteLine("DEBUG: Carregando lista - " + allList.Title);
+                // Load the IsSystemList property to determine if the list is a system list
                 context.Ctx.Load<List>(allList, new Expression<Func<List, object>>[1]
                 {
                     (Expression<Func<List, object>>) (l => (object) l.IsSystemList)
                 });
-                context.Ctx.ExecuteQuery();
+                context.Ctx.ExecuteQuery(); // Execute the query to retrieve the data
                 Console.WriteLine("List Name: " + allList.Title + "; is: " + allList.IsSystemList.ToString());
             }
         }
 
+        // Debugging method to inspect the properties of a specific SharePoint list
         private static void SPODebug(string listName, string ctxURL, SPOUser user)
         {
             Console.WriteLine("DEBUG: Entrando em SPODebug");
+            // Create a SharePoint list object with a CAML query limiting to 1 item
             SPOList spoList = new SPOList
             {
                 Name = listName,
@@ -95,78 +111,94 @@ private static void SPODebug(string listName, string ctxURL, SPOUser user)
             };
 
             Console.WriteLine("DEBUG: Executando Build");
-            spoList.Build();
+            spoList.Build(); // Build the list to load its data
 
             Console.WriteLine("DEBUG: Executando PropsToString");
+            // Print the properties of the first item in the list for debugging
             spoList.PropsToString(spoList.ItemCollection[0]);
         }
 
+        // Method to synchronize data from a source SharePoint list to a destination list
         private static void RefreshListsSPO(SPOList sourceList, SPOList destList)
         {
             try
             {
                 Console.WriteLine("DEBUG: Iniciando RefreshListsSPO");
 
+                // Build the source list to load its data
                 sourceList.Build();
                 Console.WriteLine("DEBUG: sourceList.Build concluído");
 
+                // Build the destination list to load its data
                 destList.Build();
                 Console.WriteLine("DEBUG: destList.Build concluído");
 
-                int num1 = 0;
-                int num2 = 0;
+                int num1 = 0; // Last ID in source list
+                int num2 = 0; // Last ID in destination list
 
+                // Get the field mappings between the source and destination lists
                 string[,] actualFields = GetActualFields(sourceList, destList);
                 Console.WriteLine("DEBUG: Campos obtidos");
 
+                // Determine the last ID in the source list
                 if ((uint)sourceList.ItemCollection.Count > 0U)
                     num1 = (int)sourceList.ItemCollection[sourceList.ItemCollection.Count - 1]["ID"];
+                // Determine the last ID in the destination list
                 if ((uint)destList.ItemCollection.Count > 0U)
                     num2 = (int)destList.ItemCollection[destList.ItemCollection.Count - 1]["ID"];
 
+                // If the destination list has fewer items, add new items to match the source
                 if (num2 < num1)
                 {
                     Console.WriteLine("DEBUG: Adicionando novos itens");
                     do
                     {
-                        destList.AddItem();
+                        destList.AddItem(); // Add a new item to the destination list
                         ++num2;
                     }
                     while (num2 < num1);
 
                     Console.WriteLine("Adding new items...");
-                    destList.Update();
+                    destList.Update(); // Update the destination list with the new items
                     Console.WriteLine("Done adding items.");
                 }
 
+                // Update existing items in the destination list with data from the source
                 for (int index1 = 0; index1 < sourceList.ItemCollection.Count; ++index1)
                 {
                     int id = (int)sourceList.ItemCollection[index1]["ID"];
+                    // Copy field values from source to destination based on the field mappings
                     for (int index2 = 0; index2 < actualFields.Length / 2; ++index2)
                         destList.ItemCollection.GetById(id)[actualFields[index2, 0]] = sourceList.ItemCollection[index1][actualFields[index2, 1]];
-                    destList.ItemCollection.GetById(id).Update();
+                    destList.ItemCollection.GetById(id).Update(); // Update the item in the destination list
                 }
 
+                // Execute the query to apply all changes to the SharePoint site
                 destList.Ctx.ExecuteQuery();
                 Console.WriteLine(sourceList.Site + " " + sourceList.Name + " -> " + destList.Site + " " + destList.Name + ": Done!");
             }
             catch (Exception ex)
             {
+                // Catch and display any errors during the sync process
                 Console.WriteLine("ERROR in RefreshListsSPO: " + ex.Message);
             }
         }
 
+        // Helper method to create a mapping of fields between two lists based on their titles
         private static string[,] GetActualFields(SPOList listone, SPOList listtwo)
         {
             Console.WriteLine("DEBUG: Entrando em GetActualFields");
 
+            // Get fields from both lists
             List<Field> fields1 = GetFields(listone);
             List<Field> fields2 = GetFields(listtwo);
 
+            // Create a 2D array to store the field mappings (internal names)
             string[,] strArray = new string[fields1.Count, 2];
             int index1 = 0;
             int index2 = 0;
 
+            // Match fields by title and store their internal names
             foreach (Field field1 in fields1)
             {
                 Field field2;
@@ -175,36 +207,39 @@ private static void RefreshListsSPO(SPOList sourceList, SPOList destList)
                     field2 = fields2[index2];
                     if (field1.Title == field2.Title)
                     {
-                        strArray[index1, 0] = field2.InternalName;
-                        strArray[index1, 1] = field1.InternalName;
+                        strArray[index1, 0] = field2.InternalName; // Destination field
+                        strArray[index1, 1] = field1.InternalName; // Source field
                         Console.WriteLine($"DEBUG: Match found - {field1.Title}");
                     }
                     ++index2;
                 }
                 while (field1.Title != field2.Title && index2 < fields2.Count);
 
                 ++index1;
-                index2 = 0;
+                index2 = 0; // Reset index2 for the next field
             }
 
-            return strArray;
+            return strArray; // Return the field mappings
         }
 
+        // Helper method to retrieve fields from a SharePoint list, excluding base type fields except "Title"
         private static List<Field> GetFields(SPOList list)
         {
             Console.WriteLine("DEBUG: Entrando em GetFields");
 
             List<Field> fieldList = new List<Field>();
+            // Iterate through all fields in the list
             foreach (Field field in (ClientObjectCollection<Field>)list.Fields)
             {
+                // Include fields that are not from the base type or are the "Title" field
                 if (!field.FromBaseType || field.InternalName == "Title")
                 {
                     fieldList.Add(field);
                     Console.WriteLine($"DEBUG: Campo adicionado - {field.Title}");
                 }
             }
 
-            return fieldList;
+            return fieldList; // Return the list of fields
         }
     }
 }

SPOtoSQL-Snapshots/ConsoleApp1/Sharepoint/ActivitiesDQ.cs

@@ -1,34 +1,57 @@
-// Decompiled with JetBrains decompiler
-// Type: Bring.Sharepoint.ActivitiesDQ
-// Assembly: ConsoleApp1, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null
-// MVID: 2529ACA9-9F81-4C49-8E47-E8B02D261367
-// Assembly location: C:\Users\KEVIN\Desktop\Visual Studio\SPtoSP\ConsoleApp1.exe
-
-using Microsoft.SharePoint.Client;
+using Microsoft.SharePoint.Client;
 
 namespace Bring.Sharepoint
 {
-  internal class ActivitiesDQ
-  {
-    public SPOUser Me { get; set; }
-
-    public bool UpdateIDs()
+    /// <summary>
+    /// Handles backfilling the '_OpportunityID' field on 'activities' items
+    /// when it is currently null, by copying the value from 'OpportunityID'.
+    /// </summary>
+    internal class ActivitiesDQ
     {
-      string str = "<View><Query><Where><IsNull><FieldRef Name ='_OpportunityID' /></IsNull></Where></Query></View>";
-      SPOList spoList1 = new SPOList();
-      spoList1.Name = "activities";
-      spoList1.Site = "wolf";
-      spoList1.SPOUser = this.Me;
-      spoList1.CAMLQuery = str;
-      SPOList spoList2 = spoList1;
-      spoList2.Build();
-      foreach (ListItem listItem in (ClientObjectCollection<ListItem>) spoList2.ItemCollection)
-      {
-        listItem["_OpportunityID"] = listItem["OpportunityID"];
-        listItem.Update();
-      }
-      spoList2.Ctx.ExecuteQuery();
-      return true;
+        /// <summary>
+        /// The current SharePoint user context, used for list operations.
+        /// </summary>
+        public SPOUser Me { get; set; }
+
+        /// <summary>
+        /// Queries the 'activities' list for items where '_OpportunityID' is null,
+        /// then updates each item's '_OpportunityID' field to match 'OpportunityID'.
+        /// </summary>
+        /// <returns>Always returns true if execution completes without exception.</returns>
+        public bool UpdateIDs()
+        {
+            // Define a CAML query to find items lacking the custom _OpportunityID field
+            string camlQuery =
+                "<View>"
+              + "<Query><Where><IsNull>"
+              + "<FieldRef Name='_OpportunityID' />"
+              + "</IsNull></Where></Query>"
+              + "</View>";
+
+            // Initialize the SPOList wrapper for the 'activities' list
+            var activitiesList = new SPOList
+            {
+                Name = "activities",
+                Site = "wolf",
+                SPOUser = this.Me,
+                CAMLQuery = camlQuery
+            };
+
+            // Retrieve matching items from SharePoint
+            activitiesList.Build();
+
+            // Iterate through each item, copying OpportunityID into _OpportunityID
+            foreach (ListItem item in activitiesList.ItemCollection)
+            {
+                // Copy the existing 'OpportunityID' value into the '_OpportunityID' field
+                item["_OpportunityID"] = item["OpportunityID"];
+                item.Update();
+            }
+
+            // Commit all pending updates to SharePoint in a single batch
+            activitiesList.Ctx.ExecuteQuery();
+
+            return true;
+        }
     }
-  }
 }