playground/backend/internal/db/dto/precompiled_object.go

// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements.  See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to You under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance with
// the License.  You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package dto

import (
	pb "beam.apache.org/playground/backend/internal/api/v1"
	"beam.apache.org/playground/backend/internal/db/entity"
)

type ObjectInfo struct {
	Name            string
	CloudPath       string
	Description     string
	Type            pb.PrecompiledObjectType
	Categories      []string
	PipelineOptions string
	Link            string
	UrlVCS          string
	UrlNotebook     string
	Multifile       bool
	ContextLine     int32
	DefaultExample  bool
	Sdk             pb.Sdk
	Complexity      pb.Complexity
	Tags            []string
	Datasets        []*pb.Dataset
}

type PrecompiledObjects []ObjectInfo
type CategoryToPrecompiledObjects map[string]PrecompiledObjects
type SdkToCategories map[string]CategoryToPrecompiledObjects

type CatalogDTO struct {
	Examples              []*entity.ExampleEntity
	Snippets              []*entity.SnippetEntity
	Files                 []*entity.FileEntity
	SdkCatalog            []*entity.SDKEntity
	DatasetBySnippetIDMap map[string][]*DatasetDTO
}

type DefaultExamplesDTO struct {
	Examples []*entity.ExampleEntity
	Snippets []*entity.SnippetEntity
	Files    []*entity.FileEntity
}

func (c *CatalogDTO) GetSdkCatalogAsMap() map[string]string {
	sdkToExample := make(map[string]string)
	for _, sdk := range c.SdkCatalog {
		sdkToExample[sdk.Name] = sdk.DefaultExample
	}
	return sdkToExample
}

type ExampleDTO struct {
	Example            *entity.ExampleEntity
	Snippet            *entity.SnippetEntity
	Files              []*entity.FileEntity
	DefaultExampleName string
	Datasets           []*DatasetDTO
}

func (e *ExampleDTO) HasMultiFiles() bool {
	return e.Snippet.NumberOfFiles > 1
}

func (e *ExampleDTO) IsDefault() bool {
	return e.Example.Name == e.DefaultExampleName
}

func (e *ExampleDTO) GetType() pb.PrecompiledObjectType {
	return pb.PrecompiledObjectType(pb.PrecompiledObjectType_value[e.Example.Type])
}

func (e *ExampleDTO) GetContextLine() int32 {
	return e.Files[0].CntxLine
}

func (e *ExampleDTO) GetSDK() pb.Sdk {
	return pb.Sdk(pb.Sdk_value[e.Example.Sdk.Name])
}

func (e *ExampleDTO) GetComplexity() pb.Complexity {
	return pb.Complexity(pb.Complexity_value[e.Snippet.Complexity])
}

func (e *ExampleDTO) GetDatasets() []*pb.Dataset {
	datasetsDTO := e.Datasets
	if len(datasetsDTO) != 0 {
		result := make([]*pb.Dataset, 0, len(datasetsDTO))
		for _, dto := range datasetsDTO {
			result = append(result, &pb.Dataset{
				Type:        dto.Emulator,
				Options:     dto.Config,
				DatasetPath: dto.Path,
			})
		}
		return result
	}
	return make([]*pb.Dataset, 0)
}