[ws-daemon] Fix workspace location for log backup (#18401)

* [ws-daemon] Fix workspace location for log backup

* Update integration test to check for uploaded logs

Author: WVerlaek

components/ws-daemon/pkg/controller/workspace_controller.go

@@ -293,10 +293,9 @@ func (wsc *WorkspaceController) handleWorkspaceStop(ctx context.Context, ws *wor
 			WorkspaceID: ws.Spec.Ownership.WorkspaceID,
 			InstanceID:  ws.Name,
 		},
-		WorkspaceLocation: ws.Spec.WorkspaceLocation,
-		SnapshotName:      snapshotName,
-		BackupLogs:        ws.Spec.Type == workspacev1.WorkspaceTypePrebuild,
-		UpdateGitStatus:   ws.Spec.Type == workspacev1.WorkspaceTypeRegular,
+		SnapshotName:    snapshotName,
+		BackupLogs:      ws.Spec.Type == workspacev1.WorkspaceTypePrebuild,
+		UpdateGitStatus: ws.Spec.Type == workspacev1.WorkspaceTypeRegular,
 	})
 
 	err = retry.RetryOnConflict(retryParams, func() error {

components/ws-daemon/pkg/controller/workspace_operations.go

@@ -97,11 +97,10 @@ type InitOptions struct {
 }
 
 type BackupOptions struct {
-	Meta              WorkspaceMeta
-	WorkspaceLocation string
-	BackupLogs        bool
-	UpdateGitStatus   bool
-	SnapshotName      string
+	Meta            WorkspaceMeta
+	BackupLogs      bool
+	UpdateGitStatus bool
+	SnapshotName    string
 }
 
 func NewWorkspaceOperations(config content.Config, provider *WorkspaceProvider, reg prometheus.Registerer) (WorkspaceOperations, error) {
@@ -231,7 +230,7 @@ func (wso *DefaultWorkspaceOperations) BackupWorkspace(ctx context.Context, opts
 	}
 
 	if opts.BackupLogs {
-		err := wso.uploadWorkspaceLogs(ctx, opts)
+		err := wso.uploadWorkspaceLogs(ctx, opts, ws.Location)
 		if err != nil {
 			// we do not fail the workspace yet because we still might succeed with its content!
 			glog.WithError(err).WithFields(ws.OWI()).Error("log backup failed")
@@ -345,9 +344,9 @@ func ensureCleanSlate(location string) error {
 	return nil
 }
 
-func (wso *DefaultWorkspaceOperations) uploadWorkspaceLogs(ctx context.Context, opts BackupOptions) (err error) {
+func (wso *DefaultWorkspaceOperations) uploadWorkspaceLogs(ctx context.Context, opts BackupOptions, location string) (err error) {
 	// currently we're only uploading prebuild log files
-	logFiles, err := logs.ListPrebuildLogFiles(ctx, opts.WorkspaceLocation)
+	logFiles, err := logs.ListPrebuildLogFiles(ctx, location)
 	if err != nil {
 		return err
 	}

test/pkg/integration/apis.go

@@ -1106,6 +1106,7 @@ func (c *ComponentAPI) ClearImageBuilderClientCache() {
 type ContentService interface {
 	csapi.ContentServiceClient
 	csapi.WorkspaceServiceClient
+	csapi.HeadlessLogServiceClient
 }
 
 func (c *ComponentAPI) ContentService() (ContentService, error) {
@@ -1141,11 +1142,13 @@ func (c *ComponentAPI) ContentService() (ContentService, error) {
 	type cs struct {
 		csapi.ContentServiceClient
 		csapi.WorkspaceServiceClient
+		csapi.HeadlessLogServiceClient
 	}
 
 	c.contentServiceStatus.ContentService = cs{
-		ContentServiceClient:   csapi.NewContentServiceClient(conn),
-		WorkspaceServiceClient: csapi.NewWorkspaceServiceClient(conn),
+		ContentServiceClient:     csapi.NewContentServiceClient(conn),
+		WorkspaceServiceClient:   csapi.NewWorkspaceServiceClient(conn),
+		HeadlessLogServiceClient: csapi.NewHeadlessLogServiceClient(conn),
 	}
 
 	return c.contentServiceStatus.ContentService, nil

test/tests/components/ws-manager/prebuild_test.go

@@ -264,6 +264,9 @@ func TestOpenWorkspaceFromPrebuild(t *testing.T) {
 						}
 
 						t.Logf("prebuild snapshot: %s", prebuildSnapshot)
+
+						// check the prebuild logs have been uploaded
+						checkPrebuildLogUploaded(t, ctx, api, ws)
 					}()
 
 					// launch the workspace from prebuild
@@ -692,6 +695,25 @@ func checkGitFolderPermission(t *testing.T, rsa *integration.RpcClient, workspac
 	}
 }
 
+func checkPrebuildLogUploaded(t *testing.T, ctx context.Context, api *integration.ComponentAPI, ws *integration.LaunchWorkspaceDirectlyResult) {
+	cs, err := api.ContentService()
+	if err != nil {
+		t.Fatal(err)
+	}
+	resp, err := cs.ListLogs(ctx, &csapi.ListLogsRequest{
+		WorkspaceId: ws.LastStatus.Metadata.MetaId,
+		InstanceId:  ws.Req.Id,
+		OwnerId:     ws.LastStatus.Metadata.Owner,
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+	if len(resp.TaskId) == 0 {
+		t.Fatal("no logs found")
+	}
+	t.Logf("found logs (task ids: %v)", resp.TaskId)
+}
+
 func findSnapshotFromStoppedWs(t *testing.T, ctx context.Context, lastStatus *wsmanapi.WorkspaceStatus) (string, *wsmanapi.VolumeSnapshotInfo, error) {
 	if lastStatus == nil {
 		return "", nil, fmt.Errorf("did not get last workspace status")