Move jobs to their own APIs

coder · kylecarbs · Feb 12, 2022 · Feb 10, 2022 · Feb 10, 2022 · Feb 10, 2022
commit a8d00d82fe80e1e947ed290dc3ff846dd677b236
diff --git a/cli/projectcreate.go b/cli/projectcreate.go
@@ -139,7 +139,8 @@ func validateProjectVersionSource(cmd *cobra.Command, client *codersdk.Client, o
 		return nil, err
 	}
 
-	job, err := client.CreateProjectVersionImportProvisionerJob(cmd.Context(), organization.Name, coderd.CreateProjectImportJobRequest{
+	before := time.Now()
+	job, err := client.CreateProjectImportJob(cmd.Context(), organization.Name, coderd.CreateProjectImportJobRequest{
 		StorageMethod:   database.ProvisionerStorageMethodFile,
 		StorageSource:   resp.Hash,
 		Provisioner:     provisioner,
@@ -148,10 +149,8 @@ func validateProjectVersionSource(cmd *cobra.Command, client *codersdk.Client, o
 	if err != nil {
 		return nil, err
 	}
-
 	spin.Suffix = " Waiting for the import to complete..."
-
-	logs, err := client.FollowProvisionerJobLogsAfter(cmd.Context(), organization.Name, job.ID, time.Time{})
+	logs, err := client.ProjectImportJobLogsAfter(cmd.Context(), organization.Name, job.ID, before)
 	if err != nil {
 		return nil, err
 	}
@@ -164,16 +163,15 @@ func validateProjectVersionSource(cmd *cobra.Command, client *codersdk.Client, o
 		logBuffer = append(logBuffer, log)
 	}
 
-	job, err = client.ProvisionerJob(cmd.Context(), organization.Name, job.ID)
+	job, err = client.ProjectImportJob(cmd.Context(), organization.Name, job.ID)
 	if err != nil {
 		return nil, err
 	}
-
-	parameterSchemas, err := client.ProvisionerJobParameterSchemas(cmd.Context(), organization.Name, job.ID)
+	parameterSchemas, err := client.ProjectImportJobSchemas(cmd.Context(), organization.Name, job.ID)
 	if err != nil {
 		return nil, err
 	}
-	parameterValues, err := client.ProvisionerJobParameterValues(cmd.Context(), organization.Name, job.ID)
+	parameterValues, err := client.ProjectImportJobParameters(cmd.Context(), organization.Name, job.ID)
 	if err != nil {
 		return nil, err
 	}
@@ -218,7 +216,7 @@ func validateProjectVersionSource(cmd *cobra.Command, client *codersdk.Client, o
 
 	_, _ = fmt.Fprintf(cmd.OutOrStdout(), "%s Successfully imported project source!\n", color.HiGreenString("✓"))
 
-	resources, err := client.ProvisionerJobResources(cmd.Context(), organization.Name, job.ID)
+	resources, err := client.ProjectImportJobResources(cmd.Context(), organization.Name, job.ID)
 	if err != nil {
 		return nil, err
 	}

diff --git a/cli/workspacecreate.go b/cli/workspacecreate.go
@@ -64,15 +64,15 @@ func workspaceCreate() *cobra.Command {
 			if err != nil {
 				return err
 			}
-			parameterSchemas, err := client.ProvisionerJobParameterSchemas(cmd.Context(), organization.Name, projectVersion.ImportJobID)
+			parameterSchemas, err := client.ProjectImportJobSchemas(cmd.Context(), organization.Name, projectVersion.ImportJobID)
 			if err != nil {
 				return err
 			}
-			parameterValues, err := client.ProvisionerJobParameterValues(cmd.Context(), organization.Name, projectVersion.ImportJobID)
+			parameterValues, err := client.ProjectImportJobParameters(cmd.Context(), organization.Name, projectVersion.ImportJobID)
 			if err != nil {
 				return err
 			}
-			resources, err := client.ProvisionerJobResources(cmd.Context(), organization.Name, projectVersion.ImportJobID)
+			resources, err := client.ProjectImportJobResources(cmd.Context(), organization.Name, projectVersion.ImportJobID)
 			if err != nil {
 				return err
 			}
@@ -108,7 +108,7 @@ func workspaceCreate() *cobra.Command {
 				return err
 			}
 
-			logs, err := client.FollowProvisionerJobLogsAfter(cmd.Context(), organization.Name, history.ProvisionJobID, time.Time{})
+			logs, err := client.WorkspaceProvisionJobLogsAfter(cmd.Context(), organization.Name, history.ProvisionJobID, time.Time{})
 			if err != nil {
 				return err
 			}

diff --git a/cli/workspacecreate_test.go b/cli/workspacecreate_test.go
@@ -17,7 +17,7 @@ func TestWorkspaceCreate(t *testing.T) {
 		client := coderdtest.New(t)
 		user := coderdtest.CreateInitialUser(t, client)
 		_ = coderdtest.NewProvisionerDaemon(t, client)
-		job := coderdtest.CreateProjectImportProvisionerJob(t, client, user.Organization, &echo.Responses{
+		job := coderdtest.CreateProjectImportJob(t, client, user.Organization, &echo.Responses{
 			Parse: echo.ParseComplete,
 			Provision: []*proto.Provision_Response{{
 				Type: &proto.Provision_Response_Complete{
@@ -30,7 +30,7 @@ func TestWorkspaceCreate(t *testing.T) {
 				},
 			}},
 		})
-		coderdtest.AwaitProvisionerJob(t, client, user.Organization, job.ID)
+		coderdtest.AwaitProjectImportJob(t, client, user.Organization, job.ID)
 		project := coderdtest.CreateProject(t, client, user.Organization, job.ID)
 		cmd, root := clitest.New(t, "workspaces", "create", project.Name)
 		clitest.SetupConfig(t, client, root)

diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -107,27 +107,38 @@ func New(options *Options) http.Handler {
 			r.Post("/", api.postFiles)
 		})
 
-		r.Route("/provisioners", func(r chi.Router) {
-			r.Route("/daemons", func(r chi.Router) {
-				r.Get("/", api.provisionerDaemons)
-				r.Get("/serve", api.provisionerDaemonsServe)
+		r.Route("/projectimport/{organization}", func(r chi.Router) {
+			r.Use(
+				httpmw.ExtractAPIKey(options.Database, nil),
+				httpmw.ExtractOrganizationParam(options.Database),
+			)
+			r.Post("/", api.postProjectImportByOrganization)
+			r.Route("/{provisionerjob}", func(r chi.Router) {
+				r.Use(httpmw.ExtractProvisionerJobParam(options.Database))
+				r.Get("/", api.provisionerJobByID)
+				r.Get("/schemas", api.projectImportJobSchemasByID)
+				r.Get("/parameters", api.projectImportJobParametersByID)
+				r.Get("/resources", api.projectImportJobResourcesByID)
+				r.Get("/logs", api.provisionerJobLogsByID)
 			})
-			r.Route("/jobs/{organization}", func(r chi.Router) {
-				r.Use(
-					httpmw.ExtractAPIKey(options.Database, nil),
-					httpmw.ExtractOrganizationParam(options.Database),
-				)
-				r.Post("/import", api.postProvisionerImportJobByOrganization)
-				r.Route("/{provisionerjob}", func(r chi.Router) {
-					r.Use(httpmw.ExtractProvisionerJobParam(options.Database))
-					r.Get("/", api.provisionerJobByOrganization)
-					r.Get("/schemas", api.provisionerJobParameterSchemasByID)
-					r.Get("/computed", api.provisionerJobComputedParametersByID)
-					r.Get("/resources", api.provisionerJobResourcesByID)
-					r.Get("/logs", api.provisionerJobLogsByID)
-				})
+		})
+
+		r.Route("/workspaceprovision/{organization}", func(r chi.Router) {
+			r.Use(
+				httpmw.ExtractAPIKey(options.Database, nil),
+				httpmw.ExtractOrganizationParam(options.Database),
+			)
+			r.Route("/{provisionerjob}", func(r chi.Router) {
+				r.Use(httpmw.ExtractProvisionerJobParam(options.Database))
+				r.Get("/", api.provisionerJobByID)
+				r.Get("/logs", api.provisionerJobLogsByID)
 			})
 		})
+
+		r.Route("/provisioners/daemons", func(r chi.Router) {
+			r.Get("/", api.provisionerDaemons)
+			r.Get("/serve", api.provisionerDaemonsServe)
+		})
 	})
 	r.NotFound(site.Handler(options.Logger).ServeHTTP)
 	return r

diff --git a/coderd/coderdtest/coderdtest.go b/coderd/coderdtest/coderdtest.go
@@ -28,8 +28,8 @@ import (
 	"github.com/coder/coder/provisionersdk/proto"
 )
 
-// New constructs a new coderd test instance. This returned Server
-// should contain no side-effects.
+// New constructs an in-memory coderd instance and returns
+// the connected client.
 func New(t *testing.T) *codersdk.Client {
 	// This can be hotswapped for a live database instance.
 	db := databasefake.New()
@@ -121,15 +121,15 @@ func CreateInitialUser(t *testing.T, client *codersdk.Client) coderd.CreateIniti
 	return req
 }
 
-// CreateProjectImportProvisionerJob creates a project import provisioner job
+// CreateProjectImportJob creates a project import provisioner job
 // with the responses provided. It uses the "echo" provisioner for compatibility
 // with testing.
-func CreateProjectImportProvisionerJob(t *testing.T, client *codersdk.Client, organization string, res *echo.Responses) coderd.ProvisionerJob {
+func CreateProjectImportJob(t *testing.T, client *codersdk.Client, organization string, res *echo.Responses) coderd.ProvisionerJob {
 	data, err := echo.Tar(res)
 	require.NoError(t, err)
 	file, err := client.UploadFile(context.Background(), codersdk.ContentTypeTar, data)
 	require.NoError(t, err)
-	job, err := client.CreateProjectVersionImportProvisionerJob(context.Background(), organization, coderd.CreateProjectImportJobRequest{
+	job, err := client.CreateProjectImportJob(context.Background(), organization, coderd.CreateProjectImportJobRequest{
 		StorageSource: file.Hash,
 		StorageMethod: database.ProvisionerStorageMethodFile,
 		Provisioner:   database.ProvisionerTypeEcho,
@@ -149,12 +149,24 @@ func CreateProject(t *testing.T, client *codersdk.Client, organization string, j
 	return project
 }
 
-// AwaitProvisionerJob awaits for a job to reach completed status.
-func AwaitProvisionerJob(t *testing.T, client *codersdk.Client, organization string, job uuid.UUID) coderd.ProvisionerJob {
+// AwaitProjectImportJob awaits for an import job to reach completed status.
+func AwaitProjectImportJob(t *testing.T, client *codersdk.Client, organization string, job uuid.UUID) coderd.ProvisionerJob {
 	var provisionerJob coderd.ProvisionerJob
 	require.Eventually(t, func() bool {
 		var err error
-		provisionerJob, err = client.ProvisionerJob(context.Background(), organization, job)
+		provisionerJob, err = client.ProjectImportJob(context.Background(), organization, job)
+		require.NoError(t, err)
+		return provisionerJob.Status.Completed()
+	}, 3*time.Second, 25*time.Millisecond)
+	return provisionerJob
+}
+
+// AwaitWorkspaceProvisionJob awaits for a workspace provision job to reach completed status.
+func AwaitWorkspaceProvisionJob(t *testing.T, client *codersdk.Client, organization string, job uuid.UUID) coderd.ProvisionerJob {
+	var provisionerJob coderd.ProvisionerJob
+	require.Eventually(t, func() bool {
+		var err error
+		provisionerJob, err = client.WorkspaceProvisionJob(context.Background(), organization, job)
 		require.NoError(t, err)
 		return provisionerJob.Status.Completed()
 	}, 3*time.Second, 25*time.Millisecond)

diff --git a/coderd/coderdtest/coderdtest_test.go b/coderd/coderdtest/coderdtest_test.go
@@ -22,15 +22,15 @@ func TestNew(t *testing.T) {
 	client := coderdtest.New(t)
 	user := coderdtest.CreateInitialUser(t, client)
 	closer := coderdtest.NewProvisionerDaemon(t, client)
-	job := coderdtest.CreateProjectImportProvisionerJob(t, client, user.Organization, nil)
-	coderdtest.AwaitProvisionerJob(t, client, user.Organization, job.ID)
+	job := coderdtest.CreateProjectImportJob(t, client, user.Organization, nil)
+	coderdtest.AwaitProjectImportJob(t, client, user.Organization, job.ID)
 	project := coderdtest.CreateProject(t, client, user.Organization, job.ID)
 	workspace := coderdtest.CreateWorkspace(t, client, "me", project.ID)
 	history, err := client.CreateWorkspaceHistory(context.Background(), "me", workspace.Name, coderd.CreateWorkspaceHistoryRequest{
 		ProjectVersionID: project.ActiveVersionID,
 		Transition:       database.WorkspaceTransitionStart,
 	})
 	require.NoError(t, err)
-	coderdtest.AwaitProvisionerJob(t, client, user.Organization, history.ProvisionJobID)
+	coderdtest.AwaitWorkspaceProvisionJob(t, client, user.Organization, history.ProvisionJobID)
 	closer.Close()
 }
diff --git a/coderd/parameters.go b/coderd/parameters.go