Added ability to hide "End-to-End Attribute Flows" sections.

The "Hide Default Sync Rules" option selection now hides the OOB rules when not only the rule is not changed at all but also when only precedence number or tag is changed (due to upgrade / forest addition).

The visibility control checkboxes are now enabled only after the browser loads the report completely.

Author: NileshGhodekar

ChangeLog.md

@@ -5,7 +5,18 @@ All notable changes to AADConnectConfigDocumenter project will be documented in
 ### Version [Unreleased]
 
 * Support for adding report metadata to include section / concept contents.
-* Support for ignoring change to OOB rules if only precedence number is changed (due to upgrade / forest addition).
+
+------------
+
+### Version 1.18.0302.0
+
+#### Changed
+- The "Hide Default Sync Rules" option selection now hides the OOB rules when not only the rule is not changed at all but also when only precedence number or tag is changed (due to upgrade / forest addition). 
+- The visibility control checkboxes are now enabled only after the browser loads the report completely. 
+
+#### Added
+- Added ability to hide "End-to-End Attribute Flows" sections.
+
 ------------
 
 ### Version 1.18.0131.0

src/AzureADConnectSyncDocumenter/ConnectorDocumenter.cs

@@ -1022,6 +1022,13 @@ protected void ProcessConnectorAttributeFlowsSummary()
 
             try
             {
+                this.ReportWriter.WriteBeginTag("div");
+                this.ReportWriter.WriteAttribute("class", "EndToEndFlowsSummary");
+                this.ReportWriter.Write(HtmlTextWriter.TagRightChar);
+                this.ReportToCWriter.WriteBeginTag("div");
+                this.ReportToCWriter.WriteAttribute("class", "EndToEndFlowsSummary");
+                this.ReportToCWriter.Write(HtmlTextWriter.TagRightChar);
+
                 var sectionTitle = "End-to-End Attribute Flows Summary";
 
                 Logger.Instance.WriteInfo("Processing " + sectionTitle + ".");
@@ -1063,6 +1070,9 @@ orderby objectType
             }
             finally
             {
+                this.ReportWriter.WriteEndTag("div");
+                this.ReportToCWriter.WriteEndTag("div");
+
                 Logger.Instance.WriteMethodExit();
             }
         }
@@ -1411,6 +1421,12 @@ orderby outboundSyncRulePrecedence
                                     var outboundSyncRuleGuid = (string)outboundSyncRule.Element("id");
                                     var outboundConnectorGuid = ((string)outboundSyncRule.Element("connector") ?? string.Empty).ToUpperInvariant();
                                     var outboundConnectorName = (string)config.XPathSelectElement(Documenter.GetConnectorXmlRootXPath(pilotConfig) + "/ma-data[translate(id, '" + Documenter.LowercaseLetters + "', '" + Documenter.UppercaseLetters + "') = '" + outboundConnectorGuid + "']/name");
+                                    if (string.IsNullOrEmpty(outboundConnectorName))
+                                    {
+                                        Logger.Instance.WriteWarning(string.Format(CultureInfo.InvariantCulture, "Unable to dereferece connector: '{0}'. The documentation of outbound flows will be skipped for this connector. PilotConfig: '{1}'.", outboundConnectorGuid, pilotConfig));
+                                        continue;
+                                    }
+
                                     ++outboundSyncRuleRank; // Used only for sorting, not displayed on the report
 
                                     var targetAttributeMapping = outboundSyncRule.XPathSelectElement("attribute-mappings/mapping[./src/attr = '" + metaverseAttribute + "' or contains(expression, '[" + metaverseAttribute + "]')]");
@@ -1881,6 +1897,12 @@ orderby inboundSyncRulePrecedence
                                         var inboundSyncRuleGuid = (string)inboundSyncRule.Element("id");
                                         var inboundConnectorGuid = ((string)inboundSyncRule.Element("connector") ?? string.Empty).ToUpperInvariant();
                                         var inboundConnectorName = (string)config.XPathSelectElement(Documenter.GetConnectorXmlRootXPath(pilotConfig) + "/ma-data[translate(id, '" + Documenter.LowercaseLetters + "', '" + Documenter.UppercaseLetters + "') = '" + inboundConnectorGuid + "']/name");
+                                        if (string.IsNullOrEmpty(inboundConnectorName))
+                                        {
+                                            Logger.Instance.WriteWarning(string.Format(CultureInfo.InvariantCulture, "Unable to dereferece connector: '{0}'. The documentation of inbound flows will be skipped for this connector. PilotConfig: '{1}'.", inboundConnectorGuid, pilotConfig));
+                                            continue;
+                                        }
+
                                         ++inboundSyncRuleRank; // Used only for sorting, not displayed on the report
 
                                         var metaverseAttributeMapping = inboundSyncRule.XPathSelectElement("attribute-mappings/mapping[dest = '" + metaverseAttribute + "' or contains(expression, '[" + metaverseAttribute + "]')]");

src/AzureADConnectSyncDocumenter/Documenter.cs

@@ -1470,6 +1470,7 @@ protected void WriteDocumenterInfo()
                 this.ReportWriter.WriteBeginTag("input");
                 this.ReportWriter.WriteAttribute("type", "checkbox");
                 this.ReportWriter.WriteAttribute("id", "OnlyShowChanges");
+                this.ReportWriter.WriteAttribute("disabled", null);
                 this.ReportWriter.WriteAttribute("onclick", "ToggleVisibility();");
                 this.ReportWriter.WriteLine(HtmlTextWriter.SelfClosingTagEnd);
 
@@ -1491,9 +1492,21 @@ protected void WriteDocumenterInfo()
                 this.ReportWriter.WriteBeginTag("input");
                 this.ReportWriter.WriteAttribute("type", "checkbox");
                 this.ReportWriter.WriteAttribute("id", "HideDefaultSyncRules");
+                this.ReportWriter.WriteAttribute("disabled", null);
                 this.ReportWriter.WriteAttribute("onclick", "ToggleDefaultRuleVisibility();");
                 this.ReportWriter.WriteLine(HtmlTextWriter.SelfClosingTagEnd);
 
+                this.ReportWriter.WriteFullBeginTag("strong");
+                this.ReportWriter.Write("Hide End-to-end Summary Flows:");
+                this.ReportWriter.WriteEndTag("strong");
+
+                this.ReportWriter.WriteBeginTag("input");
+                this.ReportWriter.WriteAttribute("type", "checkbox");
+                this.ReportWriter.WriteAttribute("id", "HideEndToEndFlowsSummary");
+                this.ReportWriter.WriteAttribute("disabled", null);
+                this.ReportWriter.WriteAttribute("onclick", "ToggleEndToEndFlowsSummaryVisibility();");
+                this.ReportWriter.WriteLine(HtmlTextWriter.SelfClosingTagEnd);
+
                 this.WriteBreakTag();
 
                 this.ReportWriter.WriteFullBeginTag("strong");

src/AzureADConnectSyncDocumenter/MetaverseDocumenter.cs

@@ -434,6 +434,12 @@ orderby precedence
                         var connector = ((string)syncRule.Element("connector") ?? string.Empty).ToUpperInvariant();
 
                         var connectorName = (string)config.XPathSelectElement(Documenter.GetConnectorXmlRootXPath(pilotConfig) + "/ma-data[translate(id, '" + Documenter.LowercaseLetters + "', '" + Documenter.UppercaseLetters + "') = '" + connector + "']/name");
+                        if (string.IsNullOrEmpty(connectorName))
+                        {
+                            Logger.Instance.WriteWarning(string.Format(CultureInfo.InvariantCulture, "Unable to dereferece connector: '{0}'. The documentation of inbound flows will be skipped for this connector. PilotConfig: '{1}'.", connector, pilotConfig));
+                            continue;
+                        }
+
                         var syncRuleName = (string)syncRule.Element("name");
                         row2[2] = connectorName;
                         row2[3] = syncRuleName;
@@ -594,11 +600,17 @@ private void PrintMetaverseObjectType()
 
                 this.WriteSectionHeader(sectionTitle, 4);
 
+                this.ReportWriter.WriteBeginTag("div");
+                this.ReportWriter.WriteAttribute("class", "EndToEndFlowsSummary");
+                this.ReportWriter.Write(HtmlTextWriter.TagRightChar);
+
                 var headerTable = this.GetMetaverseObjectTypeHeaderTable();
                 this.WriteTable(this.DiffgramDataSet.Tables[0], headerTable, HtmlTableSize.Huge);
             }
             finally
             {
+                this.ReportWriter.WriteEndTag("div");
+
                 this.ResetDiffgram(); // reset the diffgram variables
                 Logger.Instance.WriteMethodExit();
             }
@@ -838,14 +850,19 @@ private void FillMetaverseObjectDeletionRuleDataSet(string objectType, bool pilo
                     var deletionRuleGuid = (string)deletionRule.Element("id");
                     var deletionRuleLinkType = (string)deletionRule.Element("linkType");
                     var connectorGuid = (string)deletionRule.Element("connector");
-                    var connectorName = from connectorData in config.XPathSelectElements(Documenter.GetConnectorXmlRootXPath(pilotConfig) + "/ma-data")
+                    var connectorName = (from connectorData in config.XPathSelectElements(Documenter.GetConnectorXmlRootXPath(pilotConfig) + "/ma-data")
                                         where ((string)connectorData.Element("id") ?? string.Empty).Equals(connectorGuid, StringComparison.OrdinalIgnoreCase)
-                                        select (string)connectorData.Element("name");
+                                        select (string)connectorData.Element("name")).FirstOrDefault();
+                    if (string.IsNullOrEmpty(connectorName))
+                    {
+                        Logger.Instance.WriteWarning(string.Format(CultureInfo.InvariantCulture, "Unable to dereferece connector: '{0}'. The documentation of deletion rules will be skipped for this connector. PilotConfig: '{1}'.", connectorGuid, pilotConfig));
+                        continue;
+                    }
 
                     var row2 = table2.NewRow();
 
                     row2[0] = objectType;
-                    row2[1] = connectorName.FirstOrDefault();
+                    row2[1] = connectorName;
                     row2[2] = connectorGuid;
 
                     // Expected that this is likely to result in Contraint violation
@@ -858,7 +875,7 @@ private void FillMetaverseObjectDeletionRuleDataSet(string objectType, bool pilo
                     var row3 = table3.NewRow();
 
                     row3[0] = objectType;
-                    row3[1] = connectorName.FirstOrDefault();
+                    row3[1] = connectorName;
                     row3[2] = deletionRuleName;
                     row3[3] = deletionRuleLinkType;
                     row3[4] = connectorGuid;

src/AzureADConnectSyncDocumenter/Scripts/Documenter.js

@@ -1,4 +1,10 @@
-function ToggleVisibility() {
+window.onload = function (e) {
+    document.getElementById("OnlyShowChanges").disabled = false;
+    document.getElementById("HideDefaultSyncRules").disabled = false;
+    document.getElementById("HideEndToEndFlowsSummary").disabled = false;
+}
+
+function ToggleVisibility() {
     var x = document.getElementById("OnlyShowChanges");
     var elements = document.getElementsByClassName("CanHide");
     for (var i = 0; i < elements.length; ++i) {
@@ -33,6 +39,19 @@ function ToggleDefaultRuleVisibility() {
     }
 }
 
+function ToggleEndToEndFlowsSummaryVisibility() {
+    var x = document.getElementById("HideEndToEndFlowsSummary");
+    var elements = document.getElementsByClassName("EndToEndFlowsSummary");
+    for (var i = 0; i < elements.length; ++i) {
+        if (x.checked == true) {
+            elements[i].style.display = "none";
+        }
+        else {
+            elements[i].style.display = "";
+        }
+    }
+}
+
 function DownloadScript(downloadLink) {
     var scripts = document.getElementsByClassName("PowerShellScript");
     var data = "";

src/AzureADConnectSyncDocumenter/StyleCop.Cache

@@ -246,7 +246,7 @@
     <timestamps>
       <styleCop>2016/11/09 21:13:02.000</styleCop>
       <settingsFile>2017/04/16 06:55:54.094</settingsFile>
-      <sourceFile>2018/01/31 18:50:34.544</sourceFile>
+      <sourceFile>2018/03/02 08:48:07.208</sourceFile>
       <parser>2016/11/09 21:13:02.000</parser>
       <StyleCop.CSharp.DocumentationRules>2016/11/09 21:13:02.000</StyleCop.CSharp.DocumentationRules>
       <StyleCop.CSharp.DocumentationRules.FilesHashCode>-277821146</StyleCop.CSharp.DocumentationRules.FilesHashCode>
@@ -269,7 +269,7 @@
     <timestamps>
       <styleCop>2016/11/09 21:13:02.000</styleCop>
       <settingsFile>2017/04/16 06:55:54.094</settingsFile>
-      <sourceFile>2018/01/31 18:52:05.258</sourceFile>
+      <sourceFile>2018/03/02 09:55:34.888</sourceFile>
       <parser>2016/11/09 21:13:02.000</parser>
       <StyleCop.CSharp.DocumentationRules>2016/11/09 21:13:02.000</StyleCop.CSharp.DocumentationRules>
       <StyleCop.CSharp.DocumentationRules.FilesHashCode>-277821146</StyleCop.CSharp.DocumentationRules.FilesHashCode>
@@ -430,7 +430,7 @@
     <timestamps>
       <styleCop>2016/11/09 21:13:02.000</styleCop>
       <settingsFile>2017/04/16 06:55:54.094</settingsFile>
-      <sourceFile>2018/01/31 16:43:17.242</sourceFile>
+      <sourceFile>2018/03/02 08:52:22.581</sourceFile>
       <parser>2016/11/09 21:13:02.000</parser>
       <StyleCop.CSharp.DocumentationRules>2016/11/09 21:13:02.000</StyleCop.CSharp.DocumentationRules>
       <StyleCop.CSharp.DocumentationRules.FilesHashCode>-277821146</StyleCop.CSharp.DocumentationRules.FilesHashCode>
@@ -499,7 +499,7 @@
     <timestamps>
       <styleCop>2016/11/09 21:13:02.000</styleCop>
       <settingsFile>2017/04/16 06:55:54.094</settingsFile>
-      <sourceFile>2018/01/31 18:43:31.852</sourceFile>
+      <sourceFile>2018/02/04 13:41:17.230</sourceFile>
       <parser>2016/11/09 21:13:02.000</parser>
       <StyleCop.CSharp.DocumentationRules>2016/11/09 21:13:02.000</StyleCop.CSharp.DocumentationRules>
       <StyleCop.CSharp.DocumentationRules.FilesHashCode>-277821146</StyleCop.CSharp.DocumentationRules.FilesHashCode>
@@ -522,7 +522,7 @@
     <timestamps>
       <styleCop>2016/11/09 21:13:02.000</styleCop>
       <settingsFile>2017/04/16 06:55:54.094</settingsFile>
-      <sourceFile>2018/01/31 19:27:13.692</sourceFile>
+      <sourceFile>2018/03/02 08:36:53.915</sourceFile>
       <parser>2016/11/09 21:13:02.000</parser>
       <StyleCop.CSharp.DocumentationRules>2016/11/09 21:13:02.000</StyleCop.CSharp.DocumentationRules>
       <StyleCop.CSharp.DocumentationRules.FilesHashCode>-277821146</StyleCop.CSharp.DocumentationRules.FilesHashCode>

src/AzureADConnectSyncDocumenter/SyncRuleDocumenter.cs

@@ -54,7 +54,12 @@ internal class SyncRuleDocumenter : ConnectorDocumenter
         private SyncRuleReportType syncRuleReportType;
 
         /// <summary>
-        /// Indicates if the the synchronization rule is inferred as a default sync rule can be made invisible
+        /// Indicates if the synchronization rule is inferred as a default sync rule
+        /// </summary>
+        private bool defaultSyncRule;
+
+        /// <summary>
+        /// Indicates if the default synchronization rule has to be visible all the time
         /// </summary>
         private bool defaultSyncRuleVisibility;
 
@@ -76,6 +81,7 @@ public SyncRuleDocumenter(XElement pilotXml, XElement productionXml, string sync
             {
                 this.SyncRuleName = syncRuleName;
                 this.SyncRuleGuid = syncRuleGuid;
+                this.defaultSyncRule = false;
                 this.defaultSyncRuleVisibility = false;
                 this.ReportFileName = Documenter.GetTempFilePath(this.SyncRuleGuid + ".tmp.html");
                 this.ReportToCFileName = Documenter.GetTempFilePath(this.SyncRuleGuid + ".TOC.tmp.html");
@@ -195,7 +201,19 @@ public Tuple<string, string> GetReport(SyncRuleReportType reportType)
                     this.ProcessConnectorSyncRuleTransformations();
                 }
 
-                var noHide = this.DiffgramDataSets.Any(dataSet => !(bool)dataSet.ExtendedProperties[Documenter.CanHide]);
+                // for default rule it can be hidden if the only change is to the precedence number
+                if (this.defaultSyncRule)
+                {
+                    var filterExpression = "[Column2] <> 'Precedence' AND [Column2] <> 'Tag' AND [" + Documenter.OldColumnPrefix + "Column3] <> [Column3]";
+                    var defaultSyncRuleDescriptionChanged = this.DiffgramDataSets.Count > 0 && this.DiffgramDataSets[0].Tables[0].Select(filterExpression).Count() != 0;
+                    var defaultSyncRuleScopingFilterChanged = this.DiffgramDataSets.Count > 1 && !(bool)this.DiffgramDataSets[1].ExtendedProperties[Documenter.CanHide];
+                    var defaultSyncRuleJoinRulesChanged = this.DiffgramDataSets.Count > 2  && !(bool)this.DiffgramDataSets[2].ExtendedProperties[Documenter.CanHide];
+                    var defaultSyncRuleTransformationsChanged = this.DiffgramDataSets.Count > 3 && !(bool)this.DiffgramDataSets[3].ExtendedProperties[Documenter.CanHide];
+
+                    this.defaultSyncRuleVisibility = defaultSyncRuleDescriptionChanged || defaultSyncRuleScopingFilterChanged || defaultSyncRuleJoinRulesChanged || defaultSyncRuleTransformationsChanged;
+                }
+
+                var noHide = this.defaultSyncRule ? this.defaultSyncRuleVisibility != false : this.DiffgramDataSets.Any(dataSet => !(bool)dataSet.ExtendedProperties[Documenter.CanHide]);
 
                 if (noHide)
                 {
@@ -236,7 +254,7 @@ public Tuple<string, string> GetReport(SyncRuleReportType reportType)
                 }
                 finally
                 {
-                    if (!this.defaultSyncRuleVisibility)
+                    if (this.defaultSyncRule && this.defaultSyncRuleVisibility == false)
                     {
                         this.ReportWriter.WriteEndTag("div");
                         this.ReportToCWriter.WriteEndTag("div");
@@ -279,7 +297,7 @@ private void WriteSyncRuleReportHeader()
                 this.ReportWriter = new XhtmlTextWriter(new StreamWriter(this.ReportFileName));
                 this.ReportToCWriter = new XhtmlTextWriter(new StreamWriter(this.ReportToCFileName));
 
-                if (!this.defaultSyncRuleVisibility)
+                if (this.defaultSyncRule && this.defaultSyncRuleVisibility == false)
                 {
                     this.ReportWriter.WriteBeginTag("div");
                     this.ReportWriter.WriteAttribute("class", "DefaultRuleCanHide");
@@ -390,21 +408,7 @@ private void FillConnectorSyncRuleDescriptionDataSet(bool pilotConfig)
                         var table = dataSet.Tables[0];
 
                         this.syncRuleDirection = (SyncRuleDirection)Enum.Parse(typeof(SyncRuleDirection), (string)syncRule.Element("direction"), true);
-                        var defaultSyncRule = ((string)syncRule.Element("immutable-tag") ?? string.Empty).StartsWith("Microsoft.", StringComparison.OrdinalIgnoreCase);
-
-                        // Only turn the visibility on and never off.
-                        if (this.defaultSyncRuleVisibility == false)
-                        {
-                            this.defaultSyncRuleVisibility = !defaultSyncRule;
-                        }
-
-                        // Any disabled rule will also be always visible.
-                        // Ideally we should have any unsupported customisation to default sync rule always visible
-                        // as well but for now depend on the PowerShell script to flag that
-                        if (((string)syncRule.Element("disabled") ?? string.Empty).Equals("true", StringComparison.OrdinalIgnoreCase))
-                        {
-                            this.defaultSyncRuleVisibility = true;
-                        }
+                        this.defaultSyncRule = ((string)syncRule.Element("immutable-tag") ?? string.Empty).StartsWith("Microsoft.", StringComparison.OrdinalIgnoreCase);
 
                         var setting = (string)syncRule.Element("name");
                         Documenter.AddRow(table, new object[] { 0, "Name", setting });
@@ -456,11 +460,6 @@ private void FillConnectorSyncRuleDescriptionDataSet(bool pilotConfig)
 
                         table.AcceptChanges();
                     }
-                    else
-                    {
-                        // The missing rule in either of the environments will make the rule always visible
-                        this.defaultSyncRuleVisibility = true;
-                    }
                 }
             }
             finally