Method CreatePlan

backend/api/v1/plan_service.go:167–228

CreatePlan creates a new plan.

(ctx context.Context, request *connect.Request[v1pb.CreatePlanRequest])

// CreatePlan creates a new plan.
func (s *PlanService) CreatePlan(ctx context.Context, request *connect.Request[v1pb.CreatePlanRequest]) (*connect.Response[v1pb.Plan], error) {
	req := request.Msg
	user, ok := GetUserFromContext(ctx)
	if !ok {
		return nil, connect.NewError(connect.CodeInternal, errors.New("user not found"))
	}
	projectID, err := common.GetProjectID(req.Parent)
	if err != nil {
		return nil, connect.NewError(connect.CodeInvalidArgument, err)
	}
	project, err := s.store.GetProject(ctx, &store.FindProjectMessage{
		Workspace:  common.GetWorkspaceIDFromContext(ctx),
		ResourceID: &projectID,
	})
	if err != nil {
		return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to get project"))
	}
	if project == nil {
		return nil, connect.NewError(connect.CodeNotFound, errors.Errorf("project not found for id: %v", projectID))
	}

	trimmedTitle := strings.TrimSpace(req.Plan.Title)
	if project.Setting.EnforceIssueTitle && trimmedTitle == "" {
		return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("project %q requires a manual plan title (enforce_issue_title is enabled)", req.Parent))
	}

	// Validate plan specs
	databaseGroup, err := validateSpecs(ctx, s.store, projectID, req.Plan.Specs)
	if err != nil {
		return nil, connect.NewError(connect.CodeInvalidArgument, errors.Wrapf(err, "failed to validate plan specs"))
	}

	planMessage := &store.PlanMessage{
		ProjectID:   projectID,
		Name:        trimmedTitle,
		Description: req.Plan.Description,
		Config:      convertPlan(req.Plan),
	}

	plan, err := s.store.CreatePlan(ctx, planMessage, user.Email)
	if err != nil {
		return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to create plan"))
	}

	planCheckRun, err := getPlanCheckRunFromPlan(ctx, s.store, project, plan, databaseGroup)
	if err != nil {
		return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to get plan check run for plan"))
	}
	if planCheckRun != nil {
		if err := s.store.CreatePlanCheckRun(ctx, planCheckRun); err != nil {
			return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to create plan check run"))
		}
	}
	// Tickle plan check scheduler.
	s.bus.PlanCheckTickleChan <- 0

	convertedPlan, err := convertToPlan(ctx, s.store, plan)
	if err != nil {