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.

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

chore!: remove type from datamanager #394

Merged
merged 10 commits into from
Mar 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Empty file added changes/.gitkeep
Empty file.
1 change: 1 addition & 0 deletions changes/394.changed
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- BREAKING: remove `type` from `datamanager` table ([https://github.com/Substra/orchestrator/pull/394](https://github.com/Substra/orchestrator/pull/394))
476 changes: 235 additions & 241 deletions docs/schemas/standalone-database.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion e2e/client/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,6 @@ func (c *TestClient) RegisterDataManager(o *DataManagerOptions) *asset.DataManag
Checksum: "1d55e9c55fa7ad6b6a49ad79da897d58be7ce8b76f92ced4c20f361ba3a0af6e",
StorageAddress: "http://somewhere.local/opener" + uuid.NewString(),
},
Type: "test",
LogsPermission: o.LogsPermission,
}
c.logger.Debug().Interface("datamanager", newDm).Msg("registering datamanager")
Expand Down
1 change: 0 additions & 1 deletion lib/asset/datamanager_validation.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ func (d *NewDataManager) Validate() error {
validation.Field(&d.Description, validation.Required),
validation.Field(&d.Opener, validation.Required),
validation.Field(&d.Metadata, validation.By(validateMetadata)),
validation.Field(&d.Type, validation.Required, validation.Length(1, 30)),
validation.Field(&d.LogsPermission, validation.Required),
)
}
Expand Down
2 changes: 0 additions & 2 deletions lib/asset/datamanager_validation_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ func TestDataManagerValidate(t *testing.T) {
NewPermissions: validPermissions,
Description: validAddressable,
Opener: validAddressable,
Type: "test",
LogsPermission: validPermissions,
}, false},
"valid": {&NewDataManager{
Expand All @@ -44,7 +43,6 @@ func TestDataManagerValidate(t *testing.T) {
NewPermissions: validPermissions,
Description: validAddressable,
Opener: validAddressable,
Type: "test",
LogsPermission: validPermissions,
}, true},
}
Expand Down
1 change: 0 additions & 1 deletion lib/service/datamanager.go
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,6 @@ func (s *DataManagerService) RegisterDataManager(d *asset.NewDataManager, owner
Description: d.GetDescription(),
Opener: d.GetOpener(),
Metadata: d.GetMetadata(),
Type: d.GetType(),
CreationDate: timestamppb.New(s.GetTimeService().GetTransactionTime()),
}

Expand Down
2 changes: 0 additions & 2 deletions lib/service/datamanager_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ func TestRegisterDataManager(t *testing.T) {
Name: "test datamanager",
Description: description,
Opener: opener,
Type: "test dm",
NewPermissions: newPerms,
LogsPermission: newLogsPerm,
}
Expand All @@ -62,7 +61,6 @@ func TestRegisterDataManager(t *testing.T) {
Permissions: perms,
Description: description,
Opener: opener,
Type: "test dm",
CreationDate: timestamppb.New(time.Unix(1337, 0)),
LogsPermission: logsPerm,
}
Expand Down
14 changes: 6 additions & 8 deletions server/standalone/dbal/datamanager.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ type sqlDataManager struct {
Permissions asset.Permissions
Description asset.Addressable
Opener asset.Addressable
Type string
CreationDate time.Time
LogsPermission asset.Permission
Metadata map[string]string
Expand All @@ -34,7 +33,6 @@ func (dm *sqlDataManager) toDataManager() *asset.DataManager {
Permissions: &dm.Permissions,
Description: &dm.Description,
Opener: &dm.Opener,
Type: dm.Type,
CreationDate: timestamppb.New(dm.CreationDate),
LogsPermission: &dm.LogsPermission,
Metadata: dm.Metadata,
Expand All @@ -55,8 +53,8 @@ func (d *DBAL) AddDataManager(datamanager *asset.DataManager) error {

stmt := getStatementBuilder().
Insert("datamanagers").
Columns("key", "channel", "name", "owner", "permissions", "description", "opener", "type", "creation_date", "logs_permission", "metadata").
Values(datamanager.Key, d.channel, datamanager.Name, datamanager.Owner, datamanager.Permissions, datamanager.Description.StorageAddress, datamanager.Opener.StorageAddress, datamanager.Type, datamanager.CreationDate.AsTime(), datamanager.LogsPermission, datamanager.Metadata)
Columns("key", "channel", "name", "owner", "permissions", "description", "opener", "creation_date", "logs_permission", "metadata").
Values(datamanager.Key, d.channel, datamanager.Name, datamanager.Owner, datamanager.Permissions, datamanager.Description.StorageAddress, datamanager.Opener.StorageAddress, datamanager.CreationDate.AsTime(), datamanager.LogsPermission, datamanager.Metadata)

return d.exec(stmt)
}
Expand All @@ -82,7 +80,7 @@ func (d *DBAL) DataManagerExists(key string) (bool, error) {
// GetDataManager implements persistence.DataManagerDBAL
func (d *DBAL) GetDataManager(key string) (*asset.DataManager, error) {
stmt := getStatementBuilder().
Select("key", "name", "owner", "permissions", "description_address", "description_checksum", "opener_address", "opener_checksum", "type", "creation_date", "logs_permission", "metadata").
Select("key", "name", "owner", "permissions", "description_address", "description_checksum", "opener_address", "opener_checksum", "creation_date", "logs_permission", "metadata").
From("expanded_datamanagers").
Where(sq.Eq{"channel": d.channel, "key": key})

Expand All @@ -92,7 +90,7 @@ func (d *DBAL) GetDataManager(key string) (*asset.DataManager, error) {
}

dm := new(sqlDataManager)
err = row.Scan(&dm.Key, &dm.Name, &dm.Owner, &dm.Permissions, &dm.Description.StorageAddress, &dm.Description.Checksum, &dm.Opener.StorageAddress, &dm.Opener.Checksum, &dm.Type, &dm.CreationDate, &dm.LogsPermission, &dm.Metadata)
err = row.Scan(&dm.Key, &dm.Name, &dm.Owner, &dm.Permissions, &dm.Description.StorageAddress, &dm.Description.Checksum, &dm.Opener.StorageAddress, &dm.Opener.Checksum, &dm.CreationDate, &dm.LogsPermission, &dm.Metadata)

if err != nil {
if errors.Is(err, pgx.ErrNoRows) {
Expand All @@ -112,7 +110,7 @@ func (d *DBAL) QueryDataManagers(p *common.Pagination) ([]*asset.DataManager, co
}

stmt := getStatementBuilder().
Select("key", "name", "owner", "permissions", "description_address", "description_checksum", "opener_address", "opener_checksum", "type", "creation_date", "logs_permission", "metadata").
Select("key", "name", "owner", "permissions", "description_address", "description_checksum", "opener_address", "opener_checksum", "creation_date", "logs_permission", "metadata").
From("expanded_datamanagers").
Where(sq.Eq{"channel": d.channel}).
OrderByClause("creation_date ASC, key").
Expand All @@ -132,7 +130,7 @@ func (d *DBAL) QueryDataManagers(p *common.Pagination) ([]*asset.DataManager, co
for rows.Next() {
dm := new(sqlDataManager)

err = rows.Scan(&dm.Key, &dm.Name, &dm.Owner, &dm.Permissions, &dm.Description.StorageAddress, &dm.Description.Checksum, &dm.Opener.StorageAddress, &dm.Opener.Checksum, &dm.Type, &dm.CreationDate, &dm.LogsPermission, &dm.Metadata)
err = rows.Scan(&dm.Key, &dm.Name, &dm.Owner, &dm.Permissions, &dm.Description.StorageAddress, &dm.Description.Checksum, &dm.Opener.StorageAddress, &dm.Opener.Checksum, &dm.CreationDate, &dm.LogsPermission, &dm.Metadata)
if err != nil {
return nil, "", err
}
Expand Down
6 changes: 3 additions & 3 deletions server/standalone/dbal/datamanager_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ import (
)

func makeDataManagerRows() *pgxmock.Rows {
return pgxmock.NewRows([]string{"key", "name", "owner", "permissions", "description_address", "description_checksum", "opener_address", "opener_checksum", "type", "creation_date", "logs_permission", "metadata"}).
AddRow("key1", "name", "owner", []byte("{}"), "https://example.com/desc", "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", "https://example.com/chksm", "993b6d90e0ed15d80e7e39c6fb298855d9544420be07faec52935649780e8f19", "", time.Unix(12, 0), []byte("{}"), map[string]string{}).
AddRow("key2", "name", "owner", []byte("{}"), "https://example.com/desc", "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", "https://example.com/chksm", "993b6d90e0ed15d80e7e39c6fb298855d9544420be07faec52935649780e8f19", "", time.Unix(12, 0), []byte("{}"), map[string]string{})
return pgxmock.NewRows([]string{"key", "name", "owner", "permissions", "description_address", "description_checksum", "opener_address", "opener_checksum", "creation_date", "logs_permission", "metadata"}).
AddRow("key1", "name", "owner", []byte("{}"), "https://example.com/desc", "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", "https://example.com/chksm", "993b6d90e0ed15d80e7e39c6fb298855d9544420be07faec52935649780e8f19", time.Unix(12, 0), []byte("{}"), map[string]string{}).
AddRow("key2", "name", "owner", []byte("{}"), "https://example.com/desc", "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", "https://example.com/chksm", "993b6d90e0ed15d80e7e39c6fb298855d9544420be07faec52935649780e8f19", time.Unix(12, 0), []byte("{}"), map[string]string{})
}

func TestQueryDataManagers(t *testing.T) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
SELECT execute($$
DROP VIEW IF EXISTS expanded_datamanagers;
CREATE VIEW expanded_datamanagers AS
SELECT key,
name,
owner,
channel,
permissions,
description AS description_address,
desc_add.checksum AS description_checksum,
opener AS opener_address,
opener_add.checksum AS opener_checksum,
creation_date,
logs_permission,
metadata
FROM datamanagers
JOIN addressables desc_add ON datamanagers.description = desc_add.storage_address
JOIN addressables opener_add ON datamanagers.opener = opener_add.storage_address;

ALTER TABLE datamanagers
DROP COLUMN type;

UPDATE events SET asset = asset - 'type'
WHERE asset_kind = 'ASSET_DATA_MANAGER';

$$) WHERE column_exists('public', 'datamanagers', 'type');
Loading