executor.go

// Copyright (c) 2020 Gitpod GmbH. All rights reserved.
// Licensed under the GNU Affero General Public License (AGPL).
// See License.AGPL.txt in the project root for license information.

package executor

import (
	"context"
	"encoding/json"
	"io"

	"google.golang.org/protobuf/encoding/protojson"

	csapi "github.com/gitpod-io/gitpod/content-service/api"
	"github.com/gitpod-io/gitpod/content-service/pkg/initializer"
	"github.com/gitpod-io/gitpod/content-service/pkg/storage"
)

type config struct {
	URLs       map[string]string `json:"urls,omitempty"`
	Req        json.RawMessage   `json:"req,omitempty"`
	FromBackup string            `json:"fromBackupURL,omitempty"`
}

// PrepareFromBackup produces executor config to restore a backup
func PrepareFromBackup(url string) ([]byte, error) {
	return json.Marshal(config{
		FromBackup: url,
	})
}

// Prepare writes the config required by Execute to a stream
func Prepare(req *csapi.WorkspaceInitializer, urls map[string]string) ([]byte, error) {
	ilr, err := protojson.Marshal(req)
	if err != nil {
		return nil, err
	}

	return json.Marshal(config{
		URLs: urls,
		Req:  json.RawMessage(string(ilr)),
	})
}

// Execute runs an initializer to place content in destination based on the configuration read
// from the cfgin stream.
func Execute(ctx context.Context, destination string, cfgin io.Reader, forceGitUser bool, opts ...initializer.InitializeOpt) (src csapi.WorkspaceInitSource, err error) {
	var cfg config
	err = json.NewDecoder(cfgin).Decode(&cfg)
	if err != nil {
		return "", err
	}

	var (
		rs  storage.DirectDownloader
		ilr initializer.Initializer
	)
	if cfg.FromBackup == "" {
		var req csapi.WorkspaceInitializer
		err = protojson.Unmarshal(cfg.Req, &req)
		if err != nil {
			return "", err
		}

		rs = &storage.NamedURLDownloader{URLs: cfg.URLs}
		ilr, err = initializer.NewFromRequest(ctx, destination, rs, &req, initializer.NewFromRequestOpts{
			ForceGitpodUserForGit: forceGitUser,
		})
		if err != nil {
			return "", err
		}
	} else {
		rs = &storage.NamedURLDownloader{
			URLs: map[string]string{
				storage.DefaultBackup: cfg.FromBackup,
			},
		}
		ilr = &initializer.EmptyInitializer{}
	}

	src, stats, err := initializer.InitializeWorkspace(ctx, destination, rs, append(opts, initializer.WithInitializer(ilr))...)
	if err != nil {
		return "", err
	}

	err = initializer.PlaceWorkspaceReadyFile(ctx, destination, src, stats, initializer.GitpodUID, initializer.GitpodGID)
	if err != nil {
		return src, err
	}

	return src, nil
}