Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: optional attributes when getting graph #76

Merged
merged 4 commits into from
Jul 25, 2024
Merged

feat: optional attributes when getting graph #76

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
626ce47
chore: regenerate proto
irainia Jul 25, 2024
c78f89c
feat: implement optional attributes
irainia Jul 25, 2024
4a7b474
chore: update proton commit
irainia Jul 25, 2024
3134bfd
test: add unit test for no attributes selection
irainia Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ help: ##@help show this help
NAME="github.com/goto/compass"
VERSION=$(shell git describe --always --tags 2>/dev/null)
COVERFILE="/tmp/compass.coverprofile"
PROTON_COMMIT := "eaca9798d1c1d7b3101ec1259c7e5fb949afba28"
PROTON_COMMIT := "fe99cc96e060085d6052096e9ba59b4038c691c6"

TOOLS_MOD_DIR = ./tools
TOOLS_DIR = $(abspath ./.tools)
Expand Down
5 changes: 3 additions & 2 deletions core/asset/lineage.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ const (
)

type LineageQuery struct {
Level int
Direction LineageDirection
Level int
Direction LineageDirection
WithAttributes bool
}

//go:generate mockery --name=LineageRepository -r --case underscore --with-expecter --structname=LineageRepository --filename=lineage_repository.go --output=./mocks
Expand Down
7 changes: 7 additions & 0 deletions core/asset/service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,13 @@ func (s *Service) GetLineage(ctx context.Context, urn string, query LineageQuery
return Lineage{}, fmt.Errorf("get lineage: get graph edges: %w", err)
}

if !query.WithAttributes {
return Lineage{
Edges: edges,
NodeAttrs: make(map[string]NodeAttributes),
}, nil
}

urns := newUniqueStrings(len(edges))
urns.add(urn)
for _, edge := range edges {
Expand Down
28 changes: 22 additions & 6 deletions core/asset/service_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -807,6 +807,7 @@ func TestService_GetLineage(t *testing.T) {
type testCase struct {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's add another test case with withAttribute false

Description string
ID string
Query asset.LineageQuery
Setup func(context.Context, *mocks.AssetRepository, *mocks.DiscoveryRepository, *mocks.LineageRepository)
Expected asset.Lineage
Err error
Expand All @@ -816,8 +817,11 @@ func TestService_GetLineage(t *testing.T) {
{
Description: `should return error if the GetGraph function return error`,
ID: assetID,
Query: asset.LineageQuery{
WithAttributes: true,
},
Setup: func(ctx context.Context, ar *mocks.AssetRepository, dr *mocks.DiscoveryRepository, lr *mocks.LineageRepository) {
lr.EXPECT().GetGraph(ctx, "urn-source-1", asset.LineageQuery{}).
lr.EXPECT().GetGraph(ctx, "urn-source-1", asset.LineageQuery{WithAttributes: true}).
Return(asset.LineageGraph{}, errors.New("error fetching graph"))
},
Expected: asset.Lineage{},
Expand All @@ -826,8 +830,11 @@ func TestService_GetLineage(t *testing.T) {
{
Description: `should return no error if graph with 0 edges are returned`,
ID: assetID,
Query: asset.LineageQuery{
WithAttributes: true,
},
Setup: func(ctx context.Context, ar *mocks.AssetRepository, dr *mocks.DiscoveryRepository, lr *mocks.LineageRepository) {
lr.EXPECT().GetGraph(ctx, "urn-source-1", asset.LineageQuery{}).
lr.EXPECT().GetGraph(ctx, "urn-source-1", asset.LineageQuery{WithAttributes: true}).
Return(asset.LineageGraph{}, nil)
ar.EXPECT().GetProbesWithFilter(ctx, asset.ProbesFilter{
AssetURNs: []string{"urn-source-1"},
Expand All @@ -840,8 +847,11 @@ func TestService_GetLineage(t *testing.T) {
{
Description: `should return an error if GetProbesWithFilter function returns error`,
ID: assetID,
Query: asset.LineageQuery{
WithAttributes: true,
},
Setup: func(ctx context.Context, ar *mocks.AssetRepository, dr *mocks.DiscoveryRepository, lr *mocks.LineageRepository) {
lr.EXPECT().GetGraph(ctx, "urn-source-1", asset.LineageQuery{}).Return(asset.LineageGraph{
lr.EXPECT().GetGraph(ctx, "urn-source-1", asset.LineageQuery{WithAttributes: true}).Return(asset.LineageGraph{
{Source: "urn-source-1", Target: "urn-target-1", Prop: nil},
{Source: "urn-source-1", Target: "urn-target-2", Prop: nil},
{Source: "urn-target-2", Target: "urn-target-3", Prop: nil},
Expand All @@ -857,8 +867,11 @@ func TestService_GetLineage(t *testing.T) {
{
Description: `should return no error if GetProbesWithFilter function returns 0 probes`,
ID: assetID,
Query: asset.LineageQuery{
WithAttributes: true,
},
Setup: func(ctx context.Context, ar *mocks.AssetRepository, dr *mocks.DiscoveryRepository, lr *mocks.LineageRepository) {
lr.EXPECT().GetGraph(ctx, "urn-source-1", asset.LineageQuery{}).Return(asset.LineageGraph{
lr.EXPECT().GetGraph(ctx, "urn-source-1", asset.LineageQuery{WithAttributes: true}).Return(asset.LineageGraph{
{Source: "urn-source-1", Target: "urn-target-1", Prop: nil},
{Source: "urn-source-1", Target: "urn-target-2", Prop: nil},
{Source: "urn-target-2", Target: "urn-target-3", Prop: nil},
Expand All @@ -881,8 +894,11 @@ func TestService_GetLineage(t *testing.T) {
{
Description: `should return lineage with edges and node attributes`,
ID: assetID,
Query: asset.LineageQuery{
WithAttributes: true,
},
Setup: func(ctx context.Context, ar *mocks.AssetRepository, dr *mocks.DiscoveryRepository, lr *mocks.LineageRepository) {
lr.EXPECT().GetGraph(ctx, "urn-source-1", asset.LineageQuery{}).Return(asset.LineageGraph{
lr.EXPECT().GetGraph(ctx, "urn-source-1", asset.LineageQuery{WithAttributes: true}).Return(asset.LineageGraph{
{Source: "urn-source-1", Target: "urn-target-1", Prop: nil},
{Source: "urn-source-1", Target: "urn-target-2", Prop: nil},
{Source: "urn-target-2", Target: "urn-target-3", Prop: nil},
Expand Down Expand Up @@ -942,7 +958,7 @@ func TestService_GetLineage(t *testing.T) {
LineageRepo: mockLineageRepo,
})

actual, err := svc.GetLineage(ctx, "urn-source-1", asset.LineageQuery{})
actual, err := svc.GetLineage(ctx, "urn-source-1", tc.Query)
if tc.Err == nil {
assert.NoError(t, err)
} else {
Expand Down
10 changes: 8 additions & 2 deletions internal/server/v1beta1/lineage.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,15 @@ func (server *APIServer) GetGraph(ctx context.Context, req *compassv1beta1.GetGr
return nil, status.Error(codes.InvalidArgument, "invalid direction value")
}

withAttributes := true
if req != nil && req.WithAttributes != nil {
withAttributes = *req.WithAttributes
}

lineage, err := server.assetService.GetLineage(ctx, req.GetUrn(), asset.LineageQuery{
Level: int(req.GetLevel()),
Direction: direction,
Level: int(req.GetLevel()),
Direction: direction,
WithAttributes: withAttributes,
})
if err != nil {
return nil, internalServerError(server.logger, err.Error())
Expand Down
2 changes: 1 addition & 1 deletion internal/server/v1beta1/lineage_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ func TestGetLineageGraph(t *testing.T) {
defer mockUserSvc.AssertExpectations(t)
defer mockSvc.AssertExpectations(t)

mockSvc.EXPECT().GetLineage(ctx, nodeURN, asset.LineageQuery{Level: level, Direction: direction}).Return(lineage, nil)
mockSvc.EXPECT().GetLineage(ctx, nodeURN, asset.LineageQuery{Level: level, Direction: direction, WithAttributes: true}).Return(lineage, nil)
mockUserSvc.EXPECT().ValidateUser(ctx, userUUID, "").Return(userID, nil)

handler := NewAPIServer(APIServerDeps{AssetSvc: mockSvc, UserSvc: mockUserSvc, Logger: logger})
Expand Down
4 changes: 4 additions & 0 deletions proto/compass.swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -994,6 +994,10 @@ paths:
in: query
required: false
type: string
- name: with_attributes
in: query
required: false
type: boolean
tags:
- Lineage
- Asset
Expand Down
Loading
Loading