initial semantic refactoring

Author: grokspawn

alpha/declcfg/write.go

@@ -33,6 +33,7 @@ func NewMermaidWriter(opts ...MermaidOption) *MermaidWriter {
 	m := &MermaidWriter{
 		MinEdgeName:          minEdgeName,
 		SpecifiedPackageName: specifiedPackageName,
+		UseV0Semantics:       true,
 	}
 
 	for _, opt := range opts {
@@ -53,9 +54,9 @@ func WithSpecifiedPackageName(specifiedPackageName string) MermaidOption {
 	}
 }
 
-func WithV0Semantics() MermaidOption {
+func WithV0Semantics(useV0Semantics bool) MermaidOption {
 	return func(o *MermaidWriter) {
-		o.UseV0Semantics = true
+		o.UseV0Semantics = useV0Semantics
 	}
 }
 
@@ -131,7 +132,8 @@ func (writer *MermaidWriter) WriteChannels(cfg DeclarativeConfig, out io.Writer)
 	}
 
 	var deprecatedPackage string
-	deprecatedChannels := []string{}
+	deprecatedChannelIDs := []string{}
+	decoratedBundleIDs := map[string][]string{"deprecated": {}, "skipped": {}, "deprecatedskipped": {}}
 	linkID := 0
 	skippedLinkIDs := []string{}
 
@@ -154,7 +156,7 @@ func (writer *MermaidWriter) WriteChannels(cfg DeclarativeConfig, out io.Writer)
 			}
 
 			if depByChannel.Has(filteredChannel.Name) {
-				deprecatedChannels = append(deprecatedChannels, channelID)
+				deprecatedChannelIDs = append(deprecatedChannelIDs, channelID)
 			}
 
 			// sort edges by decreasing version
@@ -169,29 +171,44 @@ func (writer *MermaidWriter) WriteChannels(cfg DeclarativeConfig, out io.Writer)
 
 			skippedEntities := sets.Set[string]{}
 
+			const (
+				captureNewEntry = true
+				processExisting = false
+			)
+			handleSemantics := func(edge string, linkID int, captureNew bool) {
+				if writer.UseV0Semantics {
+					if captureNew {
+						if skippedEntities.Has(edge) {
+							skippedLinkIDs = append(skippedLinkIDs, fmt.Sprintf("%d", linkID))
+						} else {
+							skippedEntities.Insert(edge)
+						}
+					} else {
+						if skippedEntities.Has(edge) {
+							skippedLinkIDs = append(skippedLinkIDs, fmt.Sprintf("%d", linkID))
+						}
+					}
+				}
+			}
+
 			for _, ce := range sortedEntries {
-				bundleDecoration := ""
+				entryID := fmt.Sprintf("%s-%s", channelID, ce.Name)
+
+				// mermaid allows specification of only a single decoration class, so any combinations must be independently represented
 				switch {
 				case depByBundle.Has(ce.Name) && skippedEntities.Has(ce.Name):
-					bundleDecoration = ":::depandskip"
+					decoratedBundleIDs["deprecatedskipped"] = append(decoratedBundleIDs["deprecatedskipped"], entryID)
 				case depByBundle.Has(ce.Name):
-					bundleDecoration = ":::deprecated"
+					decoratedBundleIDs["deprecated"] = append(decoratedBundleIDs["deprecated"], entryID)
 				case skippedEntities.Has(ce.Name):
-					bundleDecoration = ":::skipped"
+					decoratedBundleIDs["skipped"] = append(decoratedBundleIDs["skipped"], entryID)
 				}
 
-				entryID := fmt.Sprintf("%s-%s", channelID, ce.Name)
-				fmt.Fprintf(pkgBuilder, "      %s[%q]%s\n", entryID, ce.Name, bundleDecoration)
-
 				if len(ce.Skips) > 0 {
 					for _, s := range ce.Skips {
 						skipsID := fmt.Sprintf("%s-%s", channelID, s)
 						fmt.Fprintf(pkgBuilder, "      %s[%q]-- %s --> %s[%q]\n", skipsID, s, "skip", entryID, ce.Name)
-						if skippedEntities.Has(s) {
-							skippedLinkIDs = append(skippedLinkIDs, fmt.Sprintf("%d", linkID))
-						} else {
-							skippedEntities.Insert(s)
-						}
+						handleSemantics(s, linkID, captureNewEntry)
 						linkID++
 					}
 				}
@@ -202,9 +219,7 @@ func (writer *MermaidWriter) WriteChannels(cfg DeclarativeConfig, out io.Writer)
 							if skipRange(versionMap[edgeName.Name]) {
 								skipRangeID := fmt.Sprintf("%s-%s", channelID, edgeName.Name)
 								fmt.Fprintf(pkgBuilder, "      %s[%q]-- \"%s(%s)\" --> %s[%q]\n", skipRangeID, edgeName.Name, "skipRange", ce.SkipRange, entryID, ce.Name)
-								if skippedEntities.Has(ce.Name) {
-									skippedLinkIDs = append(skippedLinkIDs, fmt.Sprintf("%d", linkID))
-								}
+								handleSemantics(ce.Name, linkID, processExisting)
 								linkID++
 							}
 						}
@@ -216,9 +231,7 @@ func (writer *MermaidWriter) WriteChannels(cfg DeclarativeConfig, out io.Writer)
 				if len(ce.Replaces) > 0 {
 					replacesID := fmt.Sprintf("%s-%s", channelID, ce.Replaces)
 					fmt.Fprintf(pkgBuilder, "      %s[%q]-- %s --> %s[%q]\n", replacesID, ce.Replaces, "replace", entryID, ce.Name)
-					if skippedEntities.Has(ce.Name) {
-						skippedLinkIDs = append(skippedLinkIDs, fmt.Sprintf("%d", linkID))
-					}
+					handleSemantics(ce.Name, linkID, processExisting)
 					linkID++
 				}
 			}
@@ -229,7 +242,7 @@ func (writer *MermaidWriter) WriteChannels(cfg DeclarativeConfig, out io.Writer)
 	_, _ = out.Write([]byte("graph LR\n"))
 	_, _ = out.Write([]byte("  classDef deprecated fill:#E8960F\n"))
 	_, _ = out.Write([]byte("  classDef skipped stroke:#FF0000,stroke-width:4px\n"))
-	_, _ = out.Write([]byte("  classDef depandskip fill:#E8960,stroke:#FF0000,stroke-width:4px\n"))
+	_, _ = out.Write([]byte("  classDef deprecatedskipped fill:#E8960F,stroke:#FF0000,stroke-width:4px\n"))
 	pkgNames := []string{}
 	for pname := range pkgs {
 		pkgNames = append(pkgNames, pname)
@@ -248,12 +261,19 @@ func (writer *MermaidWriter) WriteChannels(cfg DeclarativeConfig, out io.Writer)
 		_, _ = out.Write([]byte(fmt.Sprintf("style %s fill:#989695\n", deprecatedPackage)))
 	}
 
-	if len(deprecatedChannels) > 0 {
-		for _, deprecatedChannel := range deprecatedChannels {
+	if len(deprecatedChannelIDs) > 0 {
+		for _, deprecatedChannel := range deprecatedChannelIDs {
 			_, _ = out.Write([]byte(fmt.Sprintf("style %s fill:#DCD0FF\n", deprecatedChannel)))
 		}
 	}
 
+	// express the decoration classes
+	for key := range decoratedBundleIDs {
+		if len(decoratedBundleIDs[key]) > 0 {
+			_, _ = out.Write([]byte(fmt.Sprintf("class %s %s\n", strings.Join(decoratedBundleIDs[key], ","), key)))
+		}
+	}
+
 	if len(skippedLinkIDs) > 0 {
 		_, _ = out.Write([]byte("linkStyle " + strings.Join(skippedLinkIDs, ",") + " stroke:#FF0000,stroke-width:3px,stroke-dasharray:5;"))
 	}

cmd/opm/alpha/render-graph/cmd.go

@@ -18,6 +18,7 @@ func NewCmd() *cobra.Command {
 		render               action.Render
 		minEdge              string
 		specifiedPackageName string
+		includeV0Semantics   bool
 	)
 	cmd := &cobra.Command{
 		Use:   "render-graph [index-image | fbc-dir]",
@@ -67,13 +68,17 @@ $ opm alpha render-graph quay.io/operatorhubio/catalog:latest | \
 				log.Fatal(err)
 			}
 
-			writer := declcfg.NewMermaidWriter(declcfg.WithMinEdgeName(minEdge), declcfg.WithSpecifiedPackageName(specifiedPackageName))
+			writer := declcfg.NewMermaidWriter(
+				declcfg.WithMinEdgeName(minEdge),
+				declcfg.WithSpecifiedPackageName(specifiedPackageName),
+				declcfg.WithV0Semantics(includeV0Semantics))
 			if err := writer.WriteChannels(*cfg, os.Stdout); err != nil {
 				log.Fatal(err)
 			}
 		},
 	}
 	cmd.Flags().StringVar(&minEdge, "minimum-edge", "", "the channel edge to be used as the lower bound of the set of edges composing the upgrade graph; default is to include all edges")
 	cmd.Flags().StringVarP(&specifiedPackageName, "package-name", "p", "", "a specific package name to filter output; default is to include all packages in reference")
+	cmd.Flags().BoolVar(&includeV0Semantics, "include-v0-semantics", false, "whether to indicate OLMv0 semantics in the output; default is to simply represent the upgrade graph")
 	return cmd
 }