feat: register custom code

cmd/customcode.go

@@ -0,0 +1,174 @@
+package cmd
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/speakeasy-api/speakeasy/internal/charm/styles"
+	"github.com/speakeasy-api/speakeasy/internal/utils"
+	"github.com/speakeasy-api/speakeasy/internal/model"
+	"github.com/speakeasy-api/speakeasy/internal/model/flag"
+	"github.com/speakeasy-api/speakeasy/internal/registercustomcode"
+	"github.com/speakeasy-api/speakeasy/internal/log"
+	"github.com/speakeasy-api/speakeasy/internal/env"
+
+	"github.com/speakeasy-api/speakeasy/internal/run"
+	"go.uber.org/zap"
+)
+
+type RegisterCustomCodeFlags struct {
+	Show    bool   `json:"show"`
+	Resolve bool   `json:"resolve"`
+	Apply bool   `json:"apply-only"`
+	ApplyReverse bool	`json:"apply-reverse"`
+	LatestHash bool   `json:"latest-hash"`
+	InstallationURL	string	`json:"installationURL"`
+	InstallationURLs   map[string]string `json:"installationURLs"`
+	Repo               string            `json:"repo"`
+	RepoSubdir         string            `json:"repo-subdir"`
+	RepoSubdirs        map[string]string `json:"repo-subdirs"`
+	SkipVersioning     bool              `json:"skip-versioning"`
+	Output             string            `json:"output"`
+	SetVersion         string            `json:"set-version"`
+
+}
+
+var registerCustomCodeCmd = &model.ExecutableCommand[RegisterCustomCodeFlags]{
+	Usage:  "customcode",
+	Short:  "Register custom code with the OpenAPI generation system.",
+	Long:   `Register custom code with the OpenAPI generation system.`,
+	Run:    registerCustomCode,
+	Flags:  []flag.Flag{
+		flag.BooleanFlag{
+			Name:        "show",
+			Shorthand:   "s",
+			Description: "show custom code patches",
+		},
+		flag.BooleanFlag{
+			Name:        "resolve",
+			Description: "enter conflict resolution mode after a failed generation",
+		},
+		flag.BooleanFlag{
+			Name:        "apply-only",
+			Shorthand:   "a",
+			Description: "apply existing custom code patches without running generation",
+		},
+		flag.BooleanFlag{
+			Name:		 "latest-hash",
+			Description: "show the latest commit hash from gen.lock that contains custom code changes",
+		},
+		flag.StringFlag{
+			Name:        "installationURL",
+			Shorthand:   "i",
+			Description: "the language specific installation URL for installation instructions if the SDK is not published to a package manager",
+		},
+		flag.MapFlag{
+			Name:        "installationURLs",
+			Description: "a map from target ID to installation URL for installation instructions if the SDK is not published to a package manager",
+		},
+		flag.StringFlag{
+			Name:        "repo",
+			Shorthand:   "r",
+			Description: "the repository URL for the SDK, if the published (-p) flag isn't used this will be used to generate installation instructions",
+		},
+		flag.EnumFlag{
+			Name:          "output",
+			Shorthand:     "o",
+			Description:   "What to output while running",
+			AllowedValues: []string{"summary", "mermaid", "console"},
+			DefaultValue:  "summary",
+		},
+	},
+}
+
+func registerCustomCode(ctx context.Context, flags RegisterCustomCodeFlags) error {
+	logger := log.From(ctx).With(zap.String("method", "RegisterCustomCode"))
+
+	// If --show flag is provided, show existing customcode
+	if flags.Show {
+		wf, _, err := utils.GetWorkflowAndDir()
+		if err != nil {
+			return fmt.Errorf("Could not find workflow file")
+		}
+		var allErrors []error
+		for targetName, target := range wf.Targets {
+			logger.Info("Showing target", zap.String("target_name", targetName))
+			if err := registercustomcode.ShowCustomCodePatch(ctx, target); err != nil {
+				allErrors = append(allErrors, fmt.Errorf("target %s: %w", targetName, err))
+			}
+		}
+		if len(allErrors) > 0 {
+			return fmt.Errorf("errors occurred: %v", allErrors)
+		}
+		return nil
+	}
+
+	// If --resolve flag is provided, enter conflict resolution mode
+	if flags.Resolve {
+		return registercustomcode.ResolveCustomCodeConflicts(ctx)
+	}
+
+	// If --apply-only flag is provided, only apply existing patches
+	if flags.Apply {
+		wf, _, err := utils.GetWorkflowAndDir()
+		if err != nil {
+			return fmt.Errorf("Could not find workflow file")
+		}
+		for targetName, target := range wf.Targets {
+			fmt.Println("Applying target ", targetName)
+			registercustomcode.ApplyCustomCodePatch(ctx, target)
+		}
+		return nil
+	}
+
+	// If --latest-hash flag is provided, show the commit hash from gen.lock
+	if flags.LatestHash {
+		return registercustomcode.ShowLatestCommitHash(ctx)
+	}
+
+	// Call the registercustomcode functionality
+	return registercustomcode.RegisterCustomCode(ctx, func(targetName string) error {
+		opts := []run.Opt{
+			run.WithTarget(targetName),
+			run.WithRepo(flags.Repo),
+			run.WithRepoSubDirs(flags.RepoSubdirs),
+			run.WithInstallationURLs(flags.InstallationURLs),
+			run.WithSkipVersioning(true),
+			run.WithSkipApplyCustomCode(),
+		}
+		workflow, err := run.NewWorkflow(
+			ctx,
+			opts...,
+		)
+		defer func() {
+			// we should leave temp directories for debugging if run fails
+			if env.IsGithubAction() {
+				workflow.Cleanup()
+			}
+		}()
+
+		switch flags.Output {
+			case "summary":
+				err = workflow.RunWithVisualization(ctx)
+				if err != nil {
+					return err
+				}
+			case "mermaid":
+				err = workflow.Run(ctx)
+				workflow.RootStep.Finalize(err == nil)
+				mermaid, err := workflow.RootStep.ToMermaidDiagram()
+				if err != nil {
+					return err
+				}
+				log.From(ctx).Println("\n" + styles.MakeSection("Mermaid diagram of workflow", mermaid, styles.Colors.Blue))
+			case "console":
+				err = workflow.Run(ctx)
+				// workflow.RootStep.Finalize(err == nil)
+				if err != nil {
+					return err
+				}
+		}
+		return nil
+	}, )
+
+}

cmd/quickstart.go

@@ -484,6 +484,10 @@ func retryWithSampleSpec(ctx context.Context, workflowFile *workflow.Workflow, i
 		run.WithTarget(initialTarget),
 		run.WithShouldCompile(!skipCompile),
 	)
+	if err != nil {
+		return false, err
+	}
+	wf.FromQuickstart = true
 
 	// Execute the workflow based on output mode
 	switch output {

cmd/root.go

@@ -95,7 +95,9 @@ func Init(version, artifactArch string) {
 
 	addCommand(rootCmd, AskCmd)
 	addCommand(rootCmd, reproCmd)
+	addCommand(rootCmd, registerCustomCodeCmd)
 	pullInit()
+	// addCommand(rootCmd, pullCmd)
 }
 
 func addCommand(cmd *cobra.Command, command model.Command) {
@@ -110,6 +112,7 @@ func addCommand(cmd *cobra.Command, command model.Command) {
 func CmdForTest(version, artifactArch string) *cobra.Command {
 	setupRootCmd(version, artifactArch)
 
+
 	return rootCmd
 }
 

cmd/run.go

@@ -34,6 +34,7 @@ type RunFlags struct {
 	SkipTesting        bool              `json:"skip-testing"`
 	SkipVersioning     bool              `json:"skip-versioning"`
 	SkipUploadSpec     bool              `json:"skip-upload-spec"`
+	SkipCustomCode     bool              `json:"skip-custom-code"`
 	FrozenWorkflowLock bool              `json:"frozen-workflow-lockfile"`
 	Force              bool              `json:"force"`
 	Output             string            `json:"output"`
@@ -125,6 +126,10 @@ var runCmd = &model.ExecutableCommand[RunFlags]{
 			Name:        "skip-upload-spec",
 			Description: "skip uploading the spec to the registry",
 		},
+		flag.BooleanFlag{
+			Name:        "skip-custom-code",
+			Description: "skip applying custom code patches during generation",
+		},
 		flag.BooleanFlag{
 			Name:         "frozen-workflow-lockfile",
 			Description:  "executes using the stored inputs from the workflow.lock, such that no OAS change occurs",
@@ -355,6 +360,10 @@ func runNonInteractive(ctx context.Context, flags RunFlags) error {
 		run.WithSkipCleanup(), // The studio won't work if we clean up before it launches
 	}
 
+	if flags.SkipCustomCode {
+		opts = append(opts, run.WithSkipApplyCustomCode())
+	}
+
 	if flags.Minimal {
 		opts = append(opts, minimalOpts...)
 	}
@@ -413,6 +422,10 @@ func runInteractive(ctx context.Context, flags RunFlags) error {
 		run.WithSkipCleanup(), // The studio won't work if we clean up before it launches
 	}
 
+	if flags.SkipCustomCode {
+		opts = append(opts, run.WithSkipApplyCustomCode())
+	}
+
 	if flags.Minimal {
 		opts = append(opts, minimalOpts...)
 	}

go.mod

@@ -6,6 +6,8 @@ replace github.com/pb33f/doctor => github.com/speakeasy-api/doctor v0.20.0-fixva
 
 replace github.com/pb33f/libopenapi => github.com/speakeasy-api/libopenapi v0.21.9-fixhiddencomps-fixed
 
+replace github.com/speakeasy-api/openapi-generation/v2 => ../openapi-generation
+
 require (
 	github.com/AlekSi/pointer v1.2.0
 	github.com/KimMachineGun/automemlimit v0.7.1