Skip to content

Commit

Permalink
Merge pull request #14 from jhoward-lm/utility-functions
Browse files Browse the repository at this point in the history
  • Loading branch information
@jhoward-lm
jhoward-lm authored Jun 22, 2024
2 parents 32a66cb + 70be21d commit c783d13
Show file tree
Hide file tree
Showing 33 changed files with 1,099 additions and 573 deletions.
133 changes: 98 additions & 35 deletions backends/ent/retrieve.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
package ent

import (
"errors"
"fmt"
"time"

Expand All @@ -15,11 +16,16 @@ import (

"github.com/protobom/storage/internal/backends/ent"
"github.com/protobom/storage/internal/backends/ent/document"
"github.com/protobom/storage/internal/backends/ent/metadata"
"github.com/protobom/storage/internal/backends/ent/externalreference"
)

var (
errMultipleDocuments = errors.New("multiple documents matching ID")
errMissingDocument = errors.New("no documents matching IDs")
)

// Retrieve implements the storage.Retriever interface.
func (backend *Backend) Retrieve(id string, _ *storage.RetrieveOptions) (*sbom.Document, error) {
func (backend *Backend) Retrieve(id string, _ *storage.RetrieveOptions) (doc *sbom.Document, err error) {
if backend.client == nil {
return nil, fmt.Errorf("%w", errUninitializedClient)
}
Expand All @@ -28,50 +34,107 @@ func (backend *Backend) Retrieve(id string, _ *storage.RetrieveOptions) (*sbom.D
backend.Options = NewBackendOptions()
}

entDoc, err := backend.client.Document.Query().
Where(document.HasMetadataWith(metadata.IDEQ(id))).
switch documents, getDocsErr := backend.GetDocumentsByID(id); {
case getDocsErr != nil:
err = fmt.Errorf("querying documents: %w", getDocsErr)
case len(documents) == 0:
err = fmt.Errorf("%w %s", errMissingDocument, id)
case len(documents) > 1:
err = fmt.Errorf("%w %s", errMultipleDocuments, id)
default:
doc = documents[0]
}

return
}

func (backend *Backend) GetDocumentsByID(ids ...string) ([]*sbom.Document, error) {
documents := []*sbom.Document{}

query := backend.client.Document.Query().
WithMetadata().
WithNodeList().
Only(backend.ctx)
if err != nil {
return nil, fmt.Errorf("eager loading document edges: %w", err)
WithNodeList()

if len(ids) > 0 {
query.Where(document.IDIn(ids...))
}

entDoc.Edges.Metadata, err = entDoc.QueryMetadata().
WithAuthors().
WithDocumentTypes().
WithTools().
Only(backend.ctx)
entDocs, err := query.All(backend.ctx)
if err != nil {
return nil, fmt.Errorf("eager loading metadata edges: %w", err)
return nil, fmt.Errorf("querying documents table: %w", err)
}

entDoc.Edges.NodeList, err = entDoc.QueryNodeList().
WithNodes().
Only(backend.ctx)
if err != nil {
return nil, fmt.Errorf("eager loading node list edges: %w", err)
for _, entDoc := range entDocs {
entDoc.Edges.Metadata, err = entDoc.QueryMetadata().
WithAuthors().
WithDocumentTypes().
WithTools().
Only(backend.ctx)
if err != nil {
return nil, fmt.Errorf("eager loading metadata edges: %w", err)
}

entDoc.Edges.NodeList, err = entDoc.QueryNodeList().
WithNodes().
Only(backend.ctx)
if err != nil {
return nil, fmt.Errorf("eager loading node list edges: %w", err)
}

// Eager-load the nodes edges of the node list.
entDoc.Edges.NodeList.Edges.Nodes, err = entDoc.Edges.NodeList.QueryNodes().
WithEdgeTypes().
WithExternalReferences().
WithHashes().
WithIdentifiers().
WithNodes().
WithOriginators().
WithPrimaryPurpose().
WithSuppliers().
All(backend.ctx)
if err != nil {
return nil, fmt.Errorf("eager loading node edges: %w", err)
}

documents = append(documents, &sbom.Document{
Metadata: entMetadataToProtobom(entDoc.Edges.Metadata),
NodeList: entNodeListToProtobom(entDoc.Edges.NodeList),
})
}

return documents, nil
}

func (backend *Backend) GetExternalReferencesByDocumentID(
id string, types ...string,
) ([]*sbom.ExternalReference, error) {
query := backend.client.Document.Query().
Where(document.IDEQ(id)).
QueryNodeList().
QueryNodes().
QueryExternalReferences()

if len(types) > 0 {
refTypes := []externalreference.Type{}

for idx := range types {
refType := externalreference.Type(types[idx])
if err := externalreference.TypeValidator(refType); err != nil {
return nil, fmt.Errorf("%s: %w", types[idx], err)
}

refTypes = append(refTypes, refType)
}

query.Where(externalreference.TypeIn(refTypes...))
}

// Eager-load the nodes edges of the node list.
entDoc.Edges.NodeList.Edges.Nodes, err = entDoc.Edges.NodeList.QueryNodes().
WithEdgeTypes().
WithExternalReferences().
WithHashes().
WithIdentifiers().
WithNodes().
WithOriginators().
WithPrimaryPurpose().
WithSuppliers().
All(backend.ctx)
entExtRefs, err := query.All(backend.ctx)
if err != nil {
return nil, fmt.Errorf("eager loading node edges: %w", err)
return nil, fmt.Errorf("querying external references: %w", err)
}

return &sbom.Document{
Metadata: entMetadataToProtobom(entDoc.Edges.Metadata),
NodeList: entNodeListToProtobom(entDoc.Edges.NodeList),
}, nil
return entExtRefsToProtobom(entExtRefs), nil
}

func entExtRefsToProtobom(entRefs ent.ExternalReferences) []*sbom.ExternalReference {
Expand Down
52 changes: 26 additions & 26 deletions backends/ent/store.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,18 +55,18 @@ func (backend *Backend) Store(doc *sbom.Document, opts *storage.StoreOptions) er
return fmt.Errorf("ent.Document: %w", err)
}

if err := backend.StoreMetadata(doc.Metadata); err != nil {
if err := backend.saveMetadata(doc.Metadata); err != nil {
return err
}

if err := backend.StoreNodeList(doc.NodeList); err != nil {
if err := backend.saveNodeList(doc.NodeList); err != nil {
return err
}

return nil
}

func (backend *Backend) StoreDocumentTypes(docTypes []*sbom.DocumentType) error {
func (backend *Backend) saveDocumentTypes(docTypes []*sbom.DocumentType) error {
if backend.client == nil {
return fmt.Errorf("%w", errUninitializedClient)
}
Expand All @@ -92,7 +92,7 @@ func (backend *Backend) StoreDocumentTypes(docTypes []*sbom.DocumentType) error
return nil
}

func (backend *Backend) StoreEdges(edges []*sbom.Edge) error {
func (backend *Backend) saveEdges(edges []*sbom.Edge) error {
if backend.client == nil {
return fmt.Errorf("%w", errUninitializedClient)
}
Expand All @@ -114,7 +114,7 @@ func (backend *Backend) StoreEdges(edges []*sbom.Edge) error {
return nil
}

func (backend *Backend) StoreExternalReferences(refs []*sbom.ExternalReference) error {
func (backend *Backend) saveExternalReferences(refs []*sbom.ExternalReference) error {
if backend.client == nil {
return fmt.Errorf("%w", errUninitializedClient)
}
Expand All @@ -137,15 +137,15 @@ func (backend *Backend) StoreExternalReferences(refs []*sbom.ExternalReference)

backend.ctx = context.WithValue(backend.ctx, externalReferenceIDKey{}, id)

if err := backend.StoreHashesEntries(ref.Hashes); err != nil {
if err := backend.saveHashesEntries(ref.Hashes); err != nil {
return err
}
}

return nil
}

func (backend *Backend) StoreHashesEntries(hashes map[int32]string) error {
func (backend *Backend) saveHashesEntries(hashes map[int32]string) error {
if backend.client == nil {
return fmt.Errorf("%w", errUninitializedClient)
}
Expand Down Expand Up @@ -178,7 +178,7 @@ func (backend *Backend) StoreHashesEntries(hashes map[int32]string) error {
return nil
}

func (backend *Backend) StoreIdentifiersEntries(idents map[int32]string) error {
func (backend *Backend) saveIdentifiersEntries(idents map[int32]string) error {
if backend.client == nil {
return fmt.Errorf("%w", errUninitializedClient)
}
Expand Down Expand Up @@ -207,7 +207,7 @@ func (backend *Backend) StoreIdentifiersEntries(idents map[int32]string) error {
return nil
}

func (backend *Backend) StoreMetadata(md *sbom.Metadata) error {
func (backend *Backend) saveMetadata(md *sbom.Metadata) error {
if backend.client == nil {
return fmt.Errorf("%w", errUninitializedClient)
}
Expand All @@ -227,22 +227,22 @@ func (backend *Backend) StoreMetadata(md *sbom.Metadata) error {

backend.ctx = context.WithValue(backend.ctx, metadataIDKey{}, md.Id)

if err := backend.StorePersons(md.Authors); err != nil {
if err := backend.savePersons(md.Authors); err != nil {
return err
}

if err := backend.StoreDocumentTypes(md.DocumentTypes); err != nil {
if err := backend.saveDocumentTypes(md.DocumentTypes); err != nil {
return err
}

if err := backend.StoreTools(md.Tools); err != nil {
if err := backend.saveTools(md.Tools); err != nil {
return err
}

return nil
}

func (backend *Backend) StoreNodeList(nodeList *sbom.NodeList) error {
func (backend *Backend) saveNodeList(nodeList *sbom.NodeList) error {
if backend.client == nil {
return fmt.Errorf("%w", errUninitializedClient)
}
Expand All @@ -261,19 +261,19 @@ func (backend *Backend) StoreNodeList(nodeList *sbom.NodeList) error {

backend.ctx = context.WithValue(backend.ctx, nodeListIDKey{}, id)

if err := backend.StoreNodes(nodeList.Nodes); err != nil {
if err := backend.saveNodes(nodeList.Nodes); err != nil {
return err
}

// Update nodes of this node list with their typed edges.
if err := backend.StoreEdges(nodeList.Edges); err != nil {
if err := backend.saveEdges(nodeList.Edges); err != nil {
return err
}

return nil
}

func (backend *Backend) StoreNodes(nodes []*sbom.Node) error { //nolint:cyclop
func (backend *Backend) saveNodes(nodes []*sbom.Node) error { //nolint:cyclop
if backend.client == nil {
return fmt.Errorf("%w", errUninitializedClient)
}
Expand All @@ -288,35 +288,35 @@ func (backend *Backend) StoreNodes(nodes []*sbom.Node) error { //nolint:cyclop

backend.ctx = context.WithValue(backend.ctx, nodeIDKey{}, n.Id)

if err := backend.StoreExternalReferences(n.ExternalReferences); err != nil {
if err := backend.saveExternalReferences(n.ExternalReferences); err != nil {
return err
}

if err := backend.StorePersons(n.Originators); err != nil {
if err := backend.savePersons(n.Originators); err != nil {
return err
}

if err := backend.StorePersons(n.Suppliers); err != nil {
if err := backend.savePersons(n.Suppliers); err != nil {
return err
}

if err := backend.StorePurposes(n.PrimaryPurpose); err != nil {
if err := backend.savePurposes(n.PrimaryPurpose); err != nil {
return err
}

if err := backend.StoreHashesEntries(n.Hashes); err != nil {
if err := backend.saveHashesEntries(n.Hashes); err != nil {
return err
}

if err := backend.StoreIdentifiersEntries(n.Identifiers); err != nil {
if err := backend.saveIdentifiersEntries(n.Identifiers); err != nil {
return err
}
}

return nil
}

func (backend *Backend) StorePersons(persons []*sbom.Person) error {
func (backend *Backend) savePersons(persons []*sbom.Person) error {
if backend.client == nil {
return fmt.Errorf("%w", errUninitializedClient)
}
Expand Down Expand Up @@ -344,15 +344,15 @@ func (backend *Backend) StorePersons(persons []*sbom.Person) error {

backend.ctx = context.WithValue(backend.ctx, contactOwnerIDKey{}, id)

if err := backend.StorePersons(p.Contacts); err != nil {
if err := backend.savePersons(p.Contacts); err != nil {
return err
}
}

return nil
}

func (backend *Backend) StorePurposes(purposes []sbom.Purpose) error {
func (backend *Backend) savePurposes(purposes []sbom.Purpose) error {
if backend.client == nil {
return fmt.Errorf("%w", errUninitializedClient)
}
Expand Down Expand Up @@ -381,7 +381,7 @@ func (backend *Backend) StorePurposes(purposes []sbom.Purpose) error {
return nil
}

func (backend *Backend) StoreTools(tools []*sbom.Tool) error {
func (backend *Backend) saveTools(tools []*sbom.Tool) error {
if backend.client == nil {
return fmt.Errorf("%w", errUninitializedClient)
}
Expand Down
2 changes: 1 addition & 1 deletion internal/backends/ent/externalreference/externalreference.go
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit c783d13

Please sign in to comment.