cc-backend/pkg/archive/archive.go

// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
// All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
package archive

import (
	"encoding/json"
	"fmt"

	"github.com/ClusterCockpit/cc-backend/internal/config"
	"github.com/ClusterCockpit/cc-backend/internal/graph/model"
	"github.com/ClusterCockpit/cc-backend/pkg/schema"
)

type ArchiveBackend interface {
	Init(rawConfig json.RawMessage) error

	// replaces previous loadMetaJson
	LoadJobMeta(job *schema.Job) (schema.JobMeta, error)

	// replaces previous loadFromArchive
	LoadJobData(job *schema.Job) (schema.JobData, error)

	LoadClusterCfg(name string) (model.Cluster, error)

	StoreMeta(jobMeta *schema.JobMeta) error

	Import(jobMeta *schema.JobMeta, jobData *schema.JobData) error

	Iter() <-chan *schema.JobMeta
}

var ar ArchiveBackend

func Init() error {
	if config.Keys.Archive != nil {
		var kind struct {
			Kind string `json:"kind"`
		}
		if err := json.Unmarshal(config.Keys.Archive, &kind); err != nil {
			return err
		}

		switch kind.Kind {
		case "file":
			ar = &FsArchive{}
		// case "s3":
		// 	ar = &S3Archive{}
		default:
			return fmt.Errorf("unkown archive backend '%s''", kind.Kind)
		}

		if err := ar.Init(config.Keys.Archive); err != nil {
			return err
		}
	}
	return initClusterConfig()
}

func GetHandle() ArchiveBackend {
	return ar
}

// Helper to metricdata.LoadAverages().
func LoadAveragesFromArchive(job *schema.Job, metrics []string, data [][]schema.Float) error {
	metaFile, err := ar.LoadJobMeta(job)
	if err != nil {
		return err
	}

	for i, m := range metrics {
		if stat, ok := metaFile.Statistics[m]; ok {
			data[i] = append(data[i], schema.Float(stat.Avg))
		} else {
			data[i] = append(data[i], schema.NaN)
		}
	}

	return nil
}

func GetStatistics(job *schema.Job) (map[string]schema.JobStatistics, error) {
	metaFile, err := ar.LoadJobMeta(job)
	if err != nil {
		return nil, err
	}

	return metaFile.Statistics, nil
}

func Import(job *schema.JobMeta, jobData *schema.JobData) error {
	return ar.Import(job, jobData)
}

// If the job is archived, find its `meta.json` file and override the tags list
// in that JSON file. If the job is not archived, nothing is done.
func UpdateTags(job *schema.Job, tags []*schema.Tag) error {
	if job.State == schema.JobStateRunning {
		return nil
	}

	jobMeta, err := ar.LoadJobMeta(job)
	if err != nil {
		return err
	}

	jobMeta.Tags = make([]*schema.Tag, 0)
	for _, tag := range tags {
		jobMeta.Tags = append(jobMeta.Tags, &schema.Tag{
			Name: tag.Name,
			Type: tag.Type,
		})
	}

	return ar.StoreMeta(&jobMeta)
}