add site owner to site struct (#4206)

Adds the owner category to the minified site struct in the m365 service api.  Instead of generating a "SiteByID" func in that layer, the ParseSite func is exported, which allows the user to provide an existing siteable
interface for transformation.

---

#### Does this PR need a docs update or release note?

- [x]  No

#### Type of change

- [x] 🌻 Feature

#### Issue(s)

* #3988 

#### Test Plan

- [x]  Unit test
- [x] 💚 E2E
This commit is contained in:
Keepers 2023-09-08 10:29:36 -06:00 committed by GitHub
parent 35ccb985df
commit ce082162b5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -8,12 +8,22 @@ import (
"github.com/alcionai/corso/src/internal/common/idname" "github.com/alcionai/corso/src/internal/common/idname"
"github.com/alcionai/corso/src/internal/common/ptr" "github.com/alcionai/corso/src/internal/common/ptr"
"github.com/alcionai/corso/src/internal/common/str"
"github.com/alcionai/corso/src/internal/common/tform"
"github.com/alcionai/corso/src/internal/m365/graph" "github.com/alcionai/corso/src/internal/m365/graph"
"github.com/alcionai/corso/src/pkg/account" "github.com/alcionai/corso/src/pkg/account"
"github.com/alcionai/corso/src/pkg/fault" "github.com/alcionai/corso/src/pkg/fault"
"github.com/alcionai/corso/src/pkg/path" "github.com/alcionai/corso/src/pkg/path"
) )
type SiteOwnerType string
const (
SiteOwnerUnknown SiteOwnerType = ""
SiteOwnerUser SiteOwnerType = "user"
SiteOwnerGroup SiteOwnerType = "group"
)
// Site is the minimal information required to identify and display a SharePoint site. // Site is the minimal information required to identify and display a SharePoint site.
type Site struct { type Site struct {
// WebURL is the url for the site, works as an alias for the user name. // WebURL is the url for the site, works as an alias for the user name.
@ -27,6 +37,14 @@ type Site struct {
// user provided when they created the site, though it can be changed across time. // user provided when they created the site, though it can be changed across time.
// Ex: webUrl: https://host.com/sites/TestingSite, displayName: "Testing Site" // Ex: webUrl: https://host.com/sites/TestingSite, displayName: "Testing Site"
DisplayName string DisplayName string
OwnerType SiteOwnerType
// OwnerID may or may not contain the site owner's ID.
// Requires:
// * a discoverable site owner type
// * getByID (the drive expansion doesn't work on paginated data)
// * lucky chance (not all responses contain an owner ID)
OwnerID string
} }
// Sites returns a list of Sites in a specified M365 tenant // Sites returns a list of Sites in a specified M365 tenant
@ -55,26 +73,43 @@ func getAllSites(
ret := make([]*Site, 0, len(sites)) ret := make([]*Site, 0, len(sites))
for _, s := range sites { for _, s := range sites {
ps, err := parseSite(s) ret = append(ret, ParseSite(s))
if err != nil {
return nil, clues.Wrap(err, "parsing siteable")
}
ret = append(ret, ps)
} }
return ret, nil return ret, nil
} }
// parseSite extracts the information from `models.Siteable` we care about // ParseSite extracts the information from `models.Siteable` we care about
func parseSite(item models.Siteable) (*Site, error) { func ParseSite(item models.Siteable) *Site {
s := &Site{ s := &Site{
ID: ptr.Val(item.GetId()), ID: ptr.Val(item.GetId()),
WebURL: ptr.Val(item.GetWebUrl()), WebURL: ptr.Val(item.GetWebUrl()),
DisplayName: ptr.Val(item.GetDisplayName()), DisplayName: ptr.Val(item.GetDisplayName()),
OwnerType: SiteOwnerUnknown,
} }
return s, nil if item.GetDrive() != nil &&
item.GetDrive().GetOwner() != nil &&
item.GetDrive().GetOwner().GetUser() != nil {
s.OwnerType = SiteOwnerUser
s.OwnerID = ptr.Val(item.GetDrive().GetOwner().GetUser().GetId())
}
if _, ok := item.GetAdditionalData()["group"]; ok {
s.OwnerType = SiteOwnerGroup
group, err := tform.AnyValueToT[map[string]any]("group", item.GetAdditionalData())
if err != nil {
return s
}
s.OwnerID, err = str.AnyValueToString("id", group)
if err != nil {
return s
}
}
return s
} }
// SitesMap retrieves all sites in the tenant, and returns two maps: one id-to-webURL, // SitesMap retrieves all sites in the tenant, and returns two maps: one id-to-webURL,