Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

refactor: make search worksheets api support pagination (#21063)

ecmadao4ce6eb218eac
diff --git a/backend/api/mcp/gen/openapi.yaml b/backend/api/mcp/gen/openapi.yaml
index 756cc2d2a1..6121308c85 100644
--- a/backend/api/mcp/gen/openapi.yaml
+++ b/backend/api/mcp/gen/openapi.yaml
@@ -7365,6 +7365,44 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/bytebase.v1.Worksheet'
+ /bytebase.v1.WorksheetService/ListWorksheetFolders:
+ post:
+ tags:
+ - bytebase.v1.WorksheetService
+ summary: ListWorksheetFolders
+ description: |-
+ List the caller's worksheet folders.
+ Only folders stored in the caller's worksheet organizer are returned.
+ operationId: bytebase.v1.WorksheetService.ListWorksheetFolders
+ parameters:
+ - name: Connect-Protocol-Version
+ in: header
+ required: true
+ schema:
+ $ref: '#/components/schemas/connect-protocol-version'
+ - name: Connect-Timeout-Ms
+ in: header
+ schema:
+ $ref: '#/components/schemas/connect-timeout-header'
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/bytebase.v1.ListWorksheetFoldersRequest'
+ required: true
+ responses:
+ default:
+ description: Error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/connect.error'
+ "200":
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/bytebase.v1.ListWorksheetFoldersResponse'
/bytebase.v1.WorksheetService/ListWorksheets:
post:
tags:
@@ -9210,11 +9248,38 @@ components:
bytebase.v1.BatchUpdateWorksheetOrganizerRequest:
type: object
properties:
- requests:
- type: array
- items:
- $ref: '#/components/schemas/bytebase.v1.UpdateWorksheetOrganizerRequest'
- title: requests
+ parent:
+ type: string
+ title: parent
+ description: |-
+ The parent resource whose worksheets' organizers are updated.
+ Format: projects/{project}
+ filter:
+ type: string
+ title: filter
+ description: |-
+ To filter the batch update target.
+ The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+ Supported filter:
+ - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
+ - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
+ - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
+ - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
+ - folder: the worksheet organizer folder path, support exact "==" operator.
+ organizer:
+ title: organizer
+ description: The organizer fields to update.
+ $ref: '#/components/schemas/bytebase.v1.WorksheetOrganizer'
+ updateMask:
+ title: update_mask
+ description: |-
+ The list of fields to be updated.
+ Fields are specified relative to the worksheet organizer.
+ Only support update the following fields for now:
+ - `starred`
+ - `folders`
+ $ref: '#/components/schemas/google.protobuf.FieldMask'
title: BatchUpdateWorksheetOrganizerRequest
additionalProperties: false
bytebase.v1.BatchUpdateWorksheetOrganizerResponse:
@@ -9225,6 +9290,10 @@ components:
items:
$ref: '#/components/schemas/bytebase.v1.WorksheetOrganizer'
title: worksheet_organizers
+ updatedCount:
+ type: integer
+ title: updated_count
+ format: int32
title: BatchUpdateWorksheetOrganizerResponse
additionalProperties: false
bytebase.v1.BillingInterval:
@@ -14569,6 +14638,28 @@ components:
title: ListWorkloadIdentitiesResponse
additionalProperties: false
description: Response message for listing workload identities.
+ bytebase.v1.ListWorksheetFoldersRequest:
+ type: object
+ properties:
+ parent:
+ type: string
+ title: parent
+ description: |-
+ The parent resource of the worksheet folders.
+ Format: projects/{project}
+ title: ListWorksheetFoldersRequest
+ additionalProperties: false
+ bytebase.v1.ListWorksheetFoldersResponse:
+ type: object
+ properties:
+ folders:
+ type: array
+ items:
+ $ref: '#/components/schemas/bytebase.v1.WorksheetFolder'
+ title: folders
+ description: The caller's worksheet folders.
+ title: ListWorksheetFoldersResponse
+ additionalProperties: false
bytebase.v1.ListWorksheetsRequest:
type: object
properties:
@@ -17972,17 +18063,37 @@ components:
The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
Supported filter:
+ - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
+ - title: the worksheet title, support "contains" operator.
- creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
- starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
- visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
+ - folder: the worksheet organizer folder path, support "==" operator.
For example:
creator == "users/{email}"
+ title.contains("worksheet title")
creator != "users/{email}"
starred == true
starred == false
visibility in ["PRIVATE", "PROJECT_READ", "PROJECT_WRITE"]
visibility == "PRIVATE"
+ folder == "foo/bar"
+ pageSize:
+ type: integer
+ title: page_size
+ format: int32
+ description: |-
+ The maximum number of worksheets to return. The service may return fewer than
+ this value.
+ If unspecified, at most 10 worksheets will be returned.
+ The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken:
+ type: string
+ title: page_token
+ description: |-
+ A page token, received from a previous `SearchWorksheets` call.
+ Provide this to retrieve the subsequent page.
title: SearchWorksheetsRequest
additionalProperties: false
bytebase.v1.SearchWorksheetsResponse:
@@ -17994,6 +18105,13 @@ components:
$ref: '#/components/schemas/bytebase.v1.Worksheet'
title: worksheets
description: The worksheets that matched the search criteria.
+ nextPageToken:
+ type: string
+ title: next_page_token
+ description: |-
+ A token to retrieve next page of worksheets.
+ Pass this value in the page_token field in the subsequent call to
+ `SearchWorksheets` method to retrieve the next page of worksheets.
title: SearchWorksheetsResponse
additionalProperties: false
bytebase.v1.SemanticTypeSetting:
@@ -20903,6 +21021,28 @@ components:
- PROJECT_READ
- PROJECT_WRITE
- PRIVATE
+ bytebase.v1.WorksheetFolder:
+ type: object
+ properties:
+ folders:
+ type: array
+ items:
+ type: string
+ title: folders
+ description: The folder path segments.
+ category:
+ title: category
+ description: The folder category.
+ $ref: '#/components/schemas/bytebase.v1.WorksheetFolder.Category'
+ title: WorksheetFolder
+ additionalProperties: false
+ bytebase.v1.WorksheetFolder.Category:
+ type: string
+ title: Category
+ enum:
+ - CATEGORY_UNSPECIFIED
+ - MINE
+ - SHARED
bytebase.v1.WorksheetOrganizer:
type: object
properties:
diff --git a/backend/api/v1/worksheet_service.go b/backend/api/v1/worksheet_service.go
index 87258859c0..0c9b8ddd5e 100644
--- a/backend/api/v1/worksheet_service.go
+++ b/backend/api/v1/worksheet_service.go
@@ -4,6 +4,8 @@ import (
"context"
"fmt"
"log/slog"
+ "slices"
+ "strings"
"connectrpc.com/connect"
"github.com/pkg/errors"
@@ -197,6 +199,73 @@ func (s *WorksheetService) ListWorksheets(
}), nil
}
+// ListWorksheetFolders returns the caller's worksheet folders.
+func (s *WorksheetService) ListWorksheetFolders(
+ ctx context.Context,
+ req *connect.Request[v1pb.ListWorksheetFoldersRequest],
+) (*connect.Response[v1pb.ListWorksheetFoldersResponse], error) {
+ request := req.Msg
+ projectID, err := common.GetProjectID(request.Parent)
+ if err != nil {
+ return nil, connect.NewError(connect.CodeInvalidArgument, err)
+ }
+ if projectID == "-" {
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.New(`ListWorksheetFolders does not support parent "projects/-"`))
+ }
+
+ user, ok := GetUserFromContext(ctx)
+ if !ok {
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("user not found"))
+ }
+
+ find := &store.FindWorkSheetMessage{
+ ProjectIDs: []string{projectID},
+ PrincipalEmail: user.Email,
+ }
+ organizerList, err := s.store.ListWorksheetOrganizers(ctx, find)
+ if err != nil {
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to list worksheet folders: %v", err))
+ }
+
+ type worksheetFolder struct {
+ folders []string
+ category v1pb.WorksheetFolder_Category
+ }
+ folderByKey := make(map[string]worksheetFolder)
+ for _, organizer := range organizerList {
+ var category v1pb.WorksheetFolder_Category
+ if organizer.WorksheetCreator == user.Email {
+ category = v1pb.WorksheetFolder_MINE
+ } else {
+ category = v1pb.WorksheetFolder_SHARED
+ }
+ for i := range organizer.Payload.Folders {
+ folders := append([]string(nil), organizer.Payload.Folders[:i+1]...)
+ key := fmt.Sprintf("%d\x00%s", category, strings.Join(folders, "\x00"))
+ folderByKey[key] = worksheetFolder{
+ folders: folders,
+ category: category,
+ }
+ }
+ }
+
+ keys := make([]string, 0, len(folderByKey))
+ for key := range folderByKey {
+ keys = append(keys, key)
+ }
+ slices.Sort(keys)
+ response := &v1pb.ListWorksheetFoldersResponse{
+ Folders: make([]*v1pb.WorksheetFolder, 0, len(keys)),
+ }
+ for _, key := range keys {
+ response.Folders = append(response.Folders, &v1pb.WorksheetFolder{
+ Folders: folderByKey[key].folders,
+ Category: folderByKey[key].category,
+ })
+ }
+ return connect.NewResponse(response), nil
+}
+
// SearchWorksheets returns a list of worksheets based on the search filters.
func (s *WorksheetService) SearchWorksheets(
ctx context.Context,
@@ -212,13 +281,31 @@ func (s *WorksheetService) SearchWorksheets(
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
+ if projectID == "-" {
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.New(`SearchWorksheets does not support parent "projects/-"`))
+ }
+ if request.PageSize < 0 {
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("page size cannot be negative"))
+ }
+
+ offset, err := parseLimitAndOffset(&pageSize{
+ token: request.PageToken,
+ limit: int(request.PageSize),
+ maximum: 1000,
+ })
+ if err != nil {
+ return nil, err
+ }
+ limitPlusOne := offset.limit + 1
worksheetFind := &store.FindWorkSheetMessage{
ProjectIDs: []string{projectID},
PrincipalEmail: user.Email,
+ Limit: &limitPlusOne,
+ Offset: &offset.offset,
}
- filterQ, err := store.GetListSheetFilter(ctx, s.store, user.Email, request.Filter)
+ filterQ, err := store.GetListSheetFilter(ctx, s.store, user.Email, request.Filter, true /* allowTitleContains */)
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
@@ -228,6 +315,13 @@ func (s *WorksheetService) SearchWorksheets(
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to list worksheets: %v", err))
}
+ nextPageToken := ""
+ if len(worksheetList) == limitPlusOne {
+ if nextPageToken, err = offset.getNextPageToken(); err != nil {
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to generate next page token: %v", err))
+ }
+ worksheetList = worksheetList[:offset.limit]
+ }
var v1pbWorksheets []*v1pb.Worksheet
for _, worksheet := range worksheetList {
@@ -243,7 +337,8 @@ func (s *WorksheetService) SearchWorksheets(
v1pbWorksheets = append(v1pbWorksheets, v1pbWorksheet)
}
return connect.NewResponse(&v1pb.SearchWorksheetsResponse{
- Worksheets: v1pbWorksheets,
+ Worksheets: v1pbWorksheets,
+ NextPageToken: nextPageToken,
}), nil
}
@@ -440,13 +535,86 @@ func (s *WorksheetService) BatchUpdateWorksheetOrganizer(
ctx context.Context,
req *connect.Request[v1pb.BatchUpdateWorksheetOrganizerRequest],
) (*connect.Response[v1pb.BatchUpdateWorksheetOrganizerResponse], error) {
- response := &v1pb.BatchUpdateWorksheetOrganizerResponse{}
- for _, updateReq := range req.Msg.GetRequests() {
- updated, err := s.UpdateWorksheetOrganizer(ctx, connect.NewRequest(updateReq))
+ request := req.Msg
+ if request.Organizer == nil {
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("organizer cannot be empty"))
+ }
+ if request.UpdateMask == nil {
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("update mask cannot be empty"))
+ }
+ if len(request.UpdateMask.Paths) == 0 {
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("update mask paths cannot be empty"))
+ }
+
+ projectID, err := common.GetProjectID(request.Parent)
+ if err != nil {
+ return nil, connect.NewError(connect.CodeInvalidArgument, err)
+ }
+ if projectID == "-" {
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("projects/- is not supported for batch update worksheet organizers"))
+ }
+
+ user, ok := GetUserFromContext(ctx)
+ if !ok {
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("user not found"))
+ }
+
+ filterQ, err := store.GetListSheetFilter(ctx, s.store, user.Email, request.Filter, false /* allowTitleContains */)
+ if err != nil {
+ return nil, connect.NewError(connect.CodeInvalidArgument, err)
+ }
+ worksheetList, err := s.store.ListWorkSheets(ctx, &store.FindWorkSheetMessage{
+ ProjectIDs: []string{projectID},
+ PrincipalEmail: user.Email,
+ FilterQ: filterQ,
+ })
+ if err != nil {
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to list worksheets: %v", err))
+ }
+
+ var worksheetIDs []string
+ for _, worksheet := range worksheetList {
+ ok, err := s.canReadWorksheet(ctx, worksheet)
if err != nil {
- return nil, err
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to check access with error: %v", err))
}
- response.WorksheetOrganizers = append(response.WorksheetOrganizers, updated.Msg)
+ if !ok {
+ slog.Warn("cannot access worksheet", slog.String("name", worksheet.Title))
+ continue
+ }
+ worksheetIDs = append(worksheetIDs, worksheet.ResourceID)
+ }
+
+ patch := &store.BatchUpdateWorksheetOrganizerPatch{
+ WorksheetResourceIDs: worksheetIDs,
+ Principal: user.Email,
+ }
+ for _, path := range request.UpdateMask.Paths {
+ switch path {
+ case "starred":
+ starred := request.Organizer.Starred
+ patch.Starred = &starred
+ case "folders":
+ folders := request.Organizer.Folders
+ patch.Folders = &folders
+ default:
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("invalid update mask path %q", path))
+ }
+ }
+
+ organizers, err := s.store.BatchUpdateWorksheetOrganizer(ctx, patch)
+ if err != nil {
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to batch update worksheet organizers: %v", err))
+ }
+ response := &v1pb.BatchUpdateWorksheetOrganizerResponse{
+ UpdatedCount: int32(len(organizers)),
+ }
+ for _, organizer := range organizers {
+ response.WorksheetOrganizers = append(response.WorksheetOrganizers, &v1pb.WorksheetOrganizer{
+ Worksheet: fmt.Sprintf("%s/worksheets/%s", request.Parent, organizer.WorksheetResourceID),
+ Starred: organizer.Payload.Starred,
+ Folders: organizer.Payload.Folders,
+ })
}
return connect.NewResponse(response), nil
}
diff --git a/backend/generated-go/v1/v1connect/worksheet_service.connect.go b/backend/generated-go/v1/v1connect/worksheet_service.connect.go
index a4b9c77d63..3ed79bdfec 100644
--- a/backend/generated-go/v1/v1connect/worksheet_service.connect.go
+++ b/backend/generated-go/v1/v1connect/worksheet_service.connect.go
@@ -43,6 +43,9 @@ const (
// WorksheetServiceListWorksheetsProcedure is the fully-qualified name of the WorksheetService's
// ListWorksheets RPC.
WorksheetServiceListWorksheetsProcedure = "/bytebase.v1.WorksheetService/ListWorksheets"
+ // WorksheetServiceListWorksheetFoldersProcedure is the fully-qualified name of the
+ // WorksheetService's ListWorksheetFolders RPC.
+ WorksheetServiceListWorksheetFoldersProcedure = "/bytebase.v1.WorksheetService/ListWorksheetFolders"
// WorksheetServiceSearchWorksheetsProcedure is the fully-qualified name of the WorksheetService's
// SearchWorksheets RPC.
WorksheetServiceSearchWorksheetsProcedure = "/bytebase.v1.WorksheetService/SearchWorksheets"
@@ -76,6 +79,9 @@ type WorksheetServiceClient interface {
// This is used for listing worksheets in a project, or across all projects by using `projects/-`.
// Permissions required: bb.worksheets.list
ListWorksheets(context.Context, *connect.Request[v1.ListWorksheetsRequest]) (*connect.Response[v1.ListWorksheetsResponse], error)
+ // List the caller's worksheet folders.
+ // Only folders stored in the caller's worksheet organizer are returned.
+ ListWorksheetFolders(context.Context, *connect.Request[v1.ListWorksheetFoldersRequest]) (*connect.Response[v1.ListWorksheetFoldersResponse], error)
// Search for worksheets.
// This is used for finding my worksheets or worksheets shared by other people.
// The sheet accessibility is the same as GetWorksheet().
@@ -131,6 +137,12 @@ func NewWorksheetServiceClient(httpClient connect.HTTPClient, baseURL string, op
connect.WithSchema(worksheetServiceMethods.ByName("ListWorksheets")),
connect.WithClientOptions(opts...),
),
+ listWorksheetFolders: connect.NewClient[v1.ListWorksheetFoldersRequest, v1.ListWorksheetFoldersResponse](
+ httpClient,
+ baseURL+WorksheetServiceListWorksheetFoldersProcedure,
+ connect.WithSchema(worksheetServiceMethods.ByName("ListWorksheetFolders")),
+ connect.WithClientOptions(opts...),
+ ),
searchWorksheets: connect.NewClient[v1.SearchWorksheetsRequest, v1.SearchWorksheetsResponse](
httpClient,
baseURL+WorksheetServiceSearchWorksheetsProcedure,
@@ -169,6 +181,7 @@ type worksheetServiceClient struct {
createWorksheet *connect.Client[v1.CreateWorksheetRequest, v1.Worksheet]
getWorksheet *connect.Client[v1.GetWorksheetRequest, v1.Worksheet]
listWorksheets *connect.Client[v1.ListWorksheetsRequest, v1.ListWorksheetsResponse]
+ listWorksheetFolders *connect.Client[v1.ListWorksheetFoldersRequest, v1.ListWorksheetFoldersResponse]
searchWorksheets *connect.Client[v1.SearchWorksheetsRequest, v1.SearchWorksheetsResponse]
updateWorksheet *connect.Client[v1.UpdateWorksheetRequest, v1.Worksheet]
updateWorksheetOrganizer *connect.Client[v1.UpdateWorksheetOrganizerRequest, v1.WorksheetOrganizer]
@@ -191,6 +204,11 @@ func (c *worksheetServiceClient) ListWorksheets(ctx context.Context, req *connec
return c.listWorksheets.CallUnary(ctx, req)
}
+// ListWorksheetFolders calls bytebase.v1.WorksheetService.ListWorksheetFolders.
+func (c *worksheetServiceClient) ListWorksheetFolders(ctx context.Context, req *connect.Request[v1.ListWorksheetFoldersRequest]) (*connect.Response[v1.ListWorksheetFoldersResponse], error) {
+ return c.listWorksheetFolders.CallUnary(ctx, req)
+}
+
// SearchWorksheets calls bytebase.v1.WorksheetService.SearchWorksheets.
func (c *worksheetServiceClient) SearchWorksheets(ctx context.Context, req *connect.Request[v1.SearchWorksheetsRequest]) (*connect.Response[v1.SearchWorksheetsResponse], error) {
return c.searchWorksheets.CallUnary(ctx, req)
@@ -232,6 +250,9 @@ type WorksheetServiceHandler interface {
// This is used for listing worksheets in a project, or across all projects by using `projects/-`.
// Permissions required: bb.worksheets.list
ListWorksheets(context.Context, *connect.Request[v1.ListWorksheetsRequest]) (*connect.Response[v1.ListWorksheetsResponse], error)
+ // List the caller's worksheet folders.
+ // Only folders stored in the caller's worksheet organizer are returned.
+ ListWorksheetFolders(context.Context, *connect.Request[v1.ListWorksheetFoldersRequest]) (*connect.Response[v1.ListWorksheetFoldersResponse], error)
// Search for worksheets.
// This is used for finding my worksheets or worksheets shared by other people.
// The sheet accessibility is the same as GetWorksheet().
@@ -283,6 +304,12 @@ func NewWorksheetServiceHandler(svc WorksheetServiceHandler, opts ...connect.Han
connect.WithSchema(worksheetServiceMethods.ByName("ListWorksheets")),
connect.WithHandlerOptions(opts...),
)
+ worksheetServiceListWorksheetFoldersHandler := connect.NewUnaryHandler(
+ WorksheetServiceListWorksheetFoldersProcedure,
+ svc.ListWorksheetFolders,
+ connect.WithSchema(worksheetServiceMethods.ByName("ListWorksheetFolders")),
+ connect.WithHandlerOptions(opts...),
+ )
worksheetServiceSearchWorksheetsHandler := connect.NewUnaryHandler(
WorksheetServiceSearchWorksheetsProcedure,
svc.SearchWorksheets,
@@ -321,6 +348,8 @@ func NewWorksheetServiceHandler(svc WorksheetServiceHandler, opts ...connect.Han
worksheetServiceGetWorksheetHandler.ServeHTTP(w, r)
case WorksheetServiceListWorksheetsProcedure:
worksheetServiceListWorksheetsHandler.ServeHTTP(w, r)
+ case WorksheetServiceListWorksheetFoldersProcedure:
+ worksheetServiceListWorksheetFoldersHandler.ServeHTTP(w, r)
case WorksheetServiceSearchWorksheetsProcedure:
worksheetServiceSearchWorksheetsHandler.ServeHTTP(w, r)
case WorksheetServiceUpdateWorksheetProcedure:
@@ -352,6 +381,10 @@ func (UnimplementedWorksheetServiceHandler) ListWorksheets(context.Context, *con
return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.WorksheetService.ListWorksheets is not implemented"))
}
+func (UnimplementedWorksheetServiceHandler) ListWorksheetFolders(context.Context, *connect.Request[v1.ListWorksheetFoldersRequest]) (*connect.Response[v1.ListWorksheetFoldersResponse], error) {
+ return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.WorksheetService.ListWorksheetFolders is not implemented"))
+}
+
func (UnimplementedWorksheetServiceHandler) SearchWorksheets(context.Context, *connect.Request[v1.SearchWorksheetsRequest]) (*connect.Response[v1.SearchWorksheetsResponse], error) {
return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.WorksheetService.SearchWorksheets is not implemented"))
}
diff --git a/backend/generated-go/v1/worksheet_service.pb.go b/backend/generated-go/v1/worksheet_service.pb.go
index 29ddb0cd52..2374dec9e6 100644
--- a/backend/generated-go/v1/worksheet_service.pb.go
+++ b/backend/generated-go/v1/worksheet_service.pb.go
@@ -26,6 +26,55 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
+type WorksheetFolder_Category int32
+
+const (
+ WorksheetFolder_CATEGORY_UNSPECIFIED WorksheetFolder_Category = 0
+ WorksheetFolder_MINE WorksheetFolder_Category = 1
+ WorksheetFolder_SHARED WorksheetFolder_Category = 2
+)
+
+// Enum value maps for WorksheetFolder_Category.
+var (
+ WorksheetFolder_Category_name = map[int32]string{
+ 0: "CATEGORY_UNSPECIFIED",
+ 1: "MINE",
+ 2: "SHARED",
+ }
+ WorksheetFolder_Category_value = map[string]int32{
+ "CATEGORY_UNSPECIFIED": 0,
+ "MINE": 1,
+ "SHARED": 2,
+ }
+)
+
+func (x WorksheetFolder_Category) Enum() *WorksheetFolder_Category {
+ p := new(WorksheetFolder_Category)
+ *p = x
+ return p
+}
+
+func (x WorksheetFolder_Category) String() string {
+ return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
+}
+
+func (WorksheetFolder_Category) Descriptor() protoreflect.EnumDescriptor {
+ return file_v1_worksheet_service_proto_enumTypes[0].Descriptor()
+}
+
+func (WorksheetFolder_Category) Type() protoreflect.EnumType {
+ return &file_v1_worksheet_service_proto_enumTypes[0]
+}
+
+func (x WorksheetFolder_Category) Number() protoreflect.EnumNumber {
+ return protoreflect.EnumNumber(x)
+}
+
+// Deprecated: Use WorksheetFolder_Category.Descriptor instead.
+func (WorksheetFolder_Category) EnumDescriptor() ([]byte, []int) {
+ return file_v1_worksheet_service_proto_rawDescGZIP(), []int{6, 0}
+}
+
type Worksheet_Visibility int32
const (
@@ -65,11 +114,11 @@ func (x Worksheet_Visibility) String() string {
}
func (Worksheet_Visibility) Descriptor() protoreflect.EnumDescriptor {
- return file_v1_worksheet_service_proto_enumTypes[0].Descriptor()
+ return file_v1_worksheet_service_proto_enumTypes[1].Descriptor()
}
func (Worksheet_Visibility) Type() protoreflect.EnumType {
- return &file_v1_worksheet_service_proto_enumTypes[0]
+ return &file_v1_worksheet_service_proto_enumTypes[1]
}
func (x Worksheet_Visibility) Number() protoreflect.EnumNumber {
@@ -78,7 +127,7 @@ func (x Worksheet_Visibility) Number() protoreflect.EnumNumber {
// Deprecated: Use Worksheet_Visibility.Descriptor instead.
func (Worksheet_Visibility) EnumDescriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{12, 0}
+ return file_v1_worksheet_service_proto_rawDescGZIP(), []int{15, 0}
}
type CreateWorksheetRequest struct {
@@ -327,6 +376,151 @@ func (x *ListWorksheetsResponse) GetNextPageToken() string {
return ""
}
+type ListWorksheetFoldersRequest struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ // The parent resource of the worksheet folders.
+ // Format: projects/{project}
+ Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *ListWorksheetFoldersRequest) Reset() {
+ *x = ListWorksheetFoldersRequest{}
+ mi := &file_v1_worksheet_service_proto_msgTypes[4]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *ListWorksheetFoldersRequest) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*ListWorksheetFoldersRequest) ProtoMessage() {}
+
+func (x *ListWorksheetFoldersRequest) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_worksheet_service_proto_msgTypes[4]
+ if x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use ListWorksheetFoldersRequest.ProtoReflect.Descriptor instead.
+func (*ListWorksheetFoldersRequest) Descriptor() ([]byte, []int) {
+ return file_v1_worksheet_service_proto_rawDescGZIP(), []int{4}
+}
+
+func (x *ListWorksheetFoldersRequest) GetParent() string {
+ if x != nil {
+ return x.Parent
+ }
+ return ""
+}
+
+type ListWorksheetFoldersResponse struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ // The caller's worksheet folders.
+ Folders []*WorksheetFolder `protobuf:"bytes,1,rep,name=folders,proto3" json:"folders,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *ListWorksheetFoldersResponse) Reset() {
+ *x = ListWorksheetFoldersResponse{}
+ mi := &file_v1_worksheet_service_proto_msgTypes[5]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *ListWorksheetFoldersResponse) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*ListWorksheetFoldersResponse) ProtoMessage() {}
+
+func (x *ListWorksheetFoldersResponse) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_worksheet_service_proto_msgTypes[5]
+ if x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use ListWorksheetFoldersResponse.ProtoReflect.Descriptor instead.
+func (*ListWorksheetFoldersResponse) Descriptor() ([]byte, []int) {
+ return file_v1_worksheet_service_proto_rawDescGZIP(), []int{5}
+}
+
+func (x *ListWorksheetFoldersResponse) GetFolders() []*WorksheetFolder {
+ if x != nil {
+ return x.Folders
+ }
+ return nil
+}
+
+type WorksheetFolder struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ // The folder path segments.
+ Folders []string `protobuf:"bytes,1,rep,name=folders,proto3" json:"folders,omitempty"`
+ // The folder category.
+ Category WorksheetFolder_Category `protobuf:"varint,2,opt,name=category,proto3,enum=bytebase.v1.WorksheetFolder_Category" json:"category,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *WorksheetFolder) Reset() {
+ *x = WorksheetFolder{}
+ mi := &file_v1_worksheet_service_proto_msgTypes[6]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *WorksheetFolder) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*WorksheetFolder) ProtoMessage() {}
+
+func (x *WorksheetFolder) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_worksheet_service_proto_msgTypes[6]
+ if x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use WorksheetFolder.ProtoReflect.Descriptor instead.
+func (*WorksheetFolder) Descriptor() ([]byte, []int) {
+ return file_v1_worksheet_service_proto_rawDescGZIP(), []int{6}
+}
+
+func (x *WorksheetFolder) GetFolders() []string {
+ if x != nil {
+ return x.Folders
+ }
+ return nil
+}
+
+func (x *WorksheetFolder) GetCategory() WorksheetFolder_Category {
+ if x != nil {
+ return x.Category
+ }
+ return WorksheetFolder_CATEGORY_UNSPECIFIED
+}
+
type UpdateWorksheetRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// The worksheet to update.
@@ -349,7 +543,7 @@ type UpdateWorksheetRequest struct {
func (x *UpdateWorksheetRequest) Reset() {
*x = UpdateWorksheetRequest{}
- mi := &file_v1_worksheet_service_proto_msgTypes[4]
+ mi := &file_v1_worksheet_service_proto_msgTypes[7]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -361,7 +555,7 @@ func (x *UpdateWorksheetRequest) String() string {
func (*UpdateWorksheetRequest) ProtoMessage() {}
func (x *UpdateWorksheetRequest) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[4]
+ mi := &file_v1_worksheet_service_proto_msgTypes[7]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -374,7 +568,7 @@ func (x *UpdateWorksheetRequest) ProtoReflect() protoreflect.Message {
// Deprecated: Use UpdateWorksheetRequest.ProtoReflect.Descriptor instead.
func (*UpdateWorksheetRequest) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{4}
+ return file_v1_worksheet_service_proto_rawDescGZIP(), []int{7}
}
func (x *UpdateWorksheetRequest) GetWorksheet() *Worksheet {
@@ -392,15 +586,35 @@ func (x *UpdateWorksheetRequest) GetUpdateMask() *fieldmaskpb.FieldMask {
}
type BatchUpdateWorksheetOrganizerRequest struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- Requests []*UpdateWorksheetOrganizerRequest `protobuf:"bytes,1,rep,name=requests,proto3" json:"requests,omitempty"`
+ state protoimpl.MessageState `protogen:"open.v1"`
+ // The parent resource whose worksheets' organizers are updated.
+ // Format: projects/{project}
+ Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
+ // To filter the batch update target.
+ // The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+ //
+ // Supported filter:
+ // - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
+ // - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
+ // - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
+ // - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
+ // - folder: the worksheet organizer folder path, support exact "==" operator.
+ Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
+ // The organizer fields to update.
+ Organizer *WorksheetOrganizer `protobuf:"bytes,3,opt,name=organizer,proto3" json:"organizer,omitempty"`
+ // The list of fields to be updated.
+ // Fields are specified relative to the worksheet organizer.
+ // Only support update the following fields for now:
+ // - `starred`
+ // - `folders`
+ UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,4,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
}
func (x *BatchUpdateWorksheetOrganizerRequest) Reset() {
*x = BatchUpdateWorksheetOrganizerRequest{}
- mi := &file_v1_worksheet_service_proto_msgTypes[5]
+ mi := &file_v1_worksheet_service_proto_msgTypes[8]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -412,7 +626,7 @@ func (x *BatchUpdateWorksheetOrganizerRequest) String() string {
func (*BatchUpdateWorksheetOrganizerRequest) ProtoMessage() {}
func (x *BatchUpdateWorksheetOrganizerRequest) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[5]
+ mi := &file_v1_worksheet_service_proto_msgTypes[8]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -425,12 +639,33 @@ func (x *BatchUpdateWorksheetOrganizerRequest) ProtoReflect() protoreflect.Messa
// Deprecated: Use BatchUpdateWorksheetOrganizerRequest.ProtoReflect.Descriptor instead.
func (*BatchUpdateWorksheetOrganizerRequest) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{5}
+ return file_v1_worksheet_service_proto_rawDescGZIP(), []int{8}
+}
+
+func (x *BatchUpdateWorksheetOrganizerRequest) GetParent() string {
+ if x != nil {
+ return x.Parent
+ }
+ return ""
+}
+
+func (x *BatchUpdateWorksheetOrganizerRequest) GetFilter() string {
+ if x != nil {
+ return x.Filter
+ }
+ return ""
+}
+
+func (x *BatchUpdateWorksheetOrganizerRequest) GetOrganizer() *WorksheetOrganizer {
+ if x != nil {
+ return x.Organizer
+ }
+ return nil
}
-func (x *BatchUpdateWorksheetOrganizerRequest) GetRequests() []*UpdateWorksheetOrganizerRequest {
+func (x *BatchUpdateWorksheetOrganizerRequest) GetUpdateMask() *fieldmaskpb.FieldMask {
if x != nil {
- return x.Requests
+ return x.UpdateMask
}
return nil
}
@@ -438,13 +673,14 @@ func (x *BatchUpdateWorksheetOrganizerRequest) GetRequests() []*UpdateWorksheetO
type BatchUpdateWorksheetOrganizerResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
WorksheetOrganizers []*WorksheetOrganizer `protobuf:"bytes,1,rep,name=worksheet_organizers,json=worksheetOrganizers,proto3" json:"worksheet_organizers,omitempty"`
+ UpdatedCount int32 `protobuf:"varint,2,opt,name=updated_count,json=updatedCount,proto3" json:"updated_count,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
}
func (x *BatchUpdateWorksheetOrganizerResponse) Reset() {
*x = BatchUpdateWorksheetOrganizerResponse{}
- mi := &file_v1_worksheet_service_proto_msgTypes[6]
+ mi := &file_v1_worksheet_service_proto_msgTypes[9]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -456,7 +692,7 @@ func (x *BatchUpdateWorksheetOrganizerResponse) String() string {
func (*BatchUpdateWorksheetOrganizerResponse) ProtoMessage() {}
func (x *BatchUpdateWorksheetOrganizerResponse) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[6]
+ mi := &file_v1_worksheet_service_proto_msgTypes[9]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -469,7 +705,7 @@ func (x *BatchUpdateWorksheetOrganizerResponse) ProtoReflect() protoreflect.Mess
// Deprecated: Use BatchUpdateWorksheetOrganizerResponse.ProtoReflect.Descriptor instead.
func (*BatchUpdateWorksheetOrganizerResponse) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{6}
+ return file_v1_worksheet_service_proto_rawDescGZIP(), []int{9}
}
func (x *BatchUpdateWorksheetOrganizerResponse) GetWorksheetOrganizers() []*WorksheetOrganizer {
@@ -479,6 +715,13 @@ func (x *BatchUpdateWorksheetOrganizerResponse) GetWorksheetOrganizers() []*Work
return nil
}
+func (x *BatchUpdateWorksheetOrganizerResponse) GetUpdatedCount() int32 {
+ if x != nil {
+ return x.UpdatedCount
+ }
+ return 0
+}
+
type UpdateWorksheetOrganizerRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// The organizer to update.
@@ -500,7 +743,7 @@ type UpdateWorksheetOrganizerRequest struct {
func (x *UpdateWorksheetOrganizerRequest) Reset() {
*x = UpdateWorksheetOrganizerRequest{}
- mi := &file_v1_worksheet_service_proto_msgTypes[7]
+ mi := &file_v1_worksheet_service_proto_msgTypes[10]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -512,7 +755,7 @@ func (x *UpdateWorksheetOrganizerRequest) String() string {
func (*UpdateWorksheetOrganizerRequest) ProtoMessage() {}
func (x *UpdateWorksheetOrganizerRequest) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[7]
+ mi := &file_v1_worksheet_service_proto_msgTypes[10]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -525,7 +768,7 @@ func (x *UpdateWorksheetOrganizerRequest) ProtoReflect() protoreflect.Message {
// Deprecated: Use UpdateWorksheetOrganizerRequest.ProtoReflect.Descriptor instead.
func (*UpdateWorksheetOrganizerRequest) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{7}
+ return file_v1_worksheet_service_proto_rawDescGZIP(), []int{10}
}
func (x *UpdateWorksheetOrganizerRequest) GetOrganizer() *WorksheetOrganizer {
@@ -563,7 +806,7 @@ type WorksheetOrganizer struct {
func (x *WorksheetOrganizer) Reset() {
*x = WorksheetOrganizer{}
- mi := &file_v1_worksheet_service_proto_msgTypes[8]
+ mi := &file_v1_worksheet_service_proto_msgTypes[11]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -575,7 +818,7 @@ func (x *WorksheetOrganizer) String() string {
func (*WorksheetOrganizer) ProtoMessage() {}
func (x *WorksheetOrganizer) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[8]
+ mi := &file_v1_worksheet_service_proto_msgTypes[11]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -588,7 +831,7 @@ func (x *WorksheetOrganizer) ProtoReflect() protoreflect.Message {
// Deprecated: Use WorksheetOrganizer.ProtoReflect.Descriptor instead.
func (*WorksheetOrganizer) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{8}
+ return file_v1_worksheet_service_proto_rawDescGZIP(), []int{11}
}
func (x *WorksheetOrganizer) GetWorksheet() string {
@@ -623,7 +866,7 @@ type DeleteWorksheetRequest struct {
func (x *DeleteWorksheetRequest) Reset() {
*x = DeleteWorksheetRequest{}
- mi := &file_v1_worksheet_service_proto_msgTypes[9]
+ mi := &file_v1_worksheet_service_proto_msgTypes[12]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -635,7 +878,7 @@ func (x *DeleteWorksheetRequest) String() string {
func (*DeleteWorksheetRequest) ProtoMessage() {}
func (x *DeleteWorksheetRequest) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[9]
+ mi := &file_v1_worksheet_service_proto_msgTypes[12]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -648,7 +891,7 @@ func (x *DeleteWorksheetRequest) ProtoReflect() protoreflect.Message {
// Deprecated: Use DeleteWorksheetRequest.ProtoReflect.Descriptor instead.
func (*DeleteWorksheetRequest) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{9}
+ return file_v1_worksheet_service_proto_rawDescGZIP(), []int{12}
}
func (x *DeleteWorksheetRequest) GetName() string {
@@ -667,25 +910,38 @@ type SearchWorksheetsRequest struct {
// The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
//
// Supported filter:
+ // - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
+ // - title: the worksheet title, support "contains" operator.
// - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
// - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
// - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
+ // - folder: the worksheet organizer folder path, support "==" operator.
//
// For example:
// creator == "users/{email}"
+ // title.contains("worksheet title")
// creator != "users/{email}"
// starred == true
// starred == false
// visibility in ["PRIVATE", "PROJECT_READ", "PROJECT_WRITE"]
// visibility == "PRIVATE"
- Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
+ // folder == "foo/bar"
+ Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
+ // The maximum number of worksheets to return. The service may return fewer than
+ // this value.
+ // If unspecified, at most 10 worksheets will be returned.
+ // The maximum value is 1000; values above 1000 will be coerced to 1000.
+ PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
+ // A page token, received from a previous `SearchWorksheets` call.
+ // Provide this to retrieve the subsequent page.
+ PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
}
func (x *SearchWorksheetsRequest) Reset() {
*x = SearchWorksheetsRequest{}
- mi := &file_v1_worksheet_service_proto_msgTypes[10]
+ mi := &file_v1_worksheet_service_proto_msgTypes[13]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -697,7 +953,7 @@ func (x *SearchWorksheetsRequest) String() string {
func (*SearchWorksheetsRequest) ProtoMessage() {}
func (x *SearchWorksheetsRequest) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[10]
+ mi := &file_v1_worksheet_service_proto_msgTypes[13]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -710,7 +966,7 @@ func (x *SearchWorksheetsRequest) ProtoReflect() protoreflect.Message {
// Deprecated: Use SearchWorksheetsRequest.ProtoReflect.Descriptor instead.
func (*SearchWorksheetsRequest) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{10}
+ return file_v1_worksheet_service_proto_rawDescGZIP(), []int{13}
}
func (x *SearchWorksheetsRequest) GetParent() string {
@@ -727,17 +983,35 @@ func (x *SearchWorksheetsRequest) GetFilter() string {
return ""
}
+func (x *SearchWorksheetsRequest) GetPageSize() int32 {
+ if x != nil {
+ return x.PageSize
+ }
+ return 0
+}
+
+func (x *SearchWorksheetsRequest) GetPageToken() string {
+ if x != nil {
+ return x.PageToken
+ }
+ return ""
+}
+
type SearchWorksheetsResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
// The worksheets that matched the search criteria.
- Worksheets []*Worksheet `protobuf:"bytes,1,rep,name=worksheets,proto3" json:"worksheets,omitempty"`
+ Worksheets []*Worksheet `protobuf:"bytes,1,rep,name=worksheets,proto3" json:"worksheets,omitempty"`
+ // A token to retrieve next page of worksheets.
+ // Pass this value in the page_token field in the subsequent call to
+ // `SearchWorksheets` method to retrieve the next page of worksheets.
+ NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
}
func (x *SearchWorksheetsResponse) Reset() {
*x = SearchWorksheetsResponse{}
- mi := &file_v1_worksheet_service_proto_msgTypes[11]
+ mi := &file_v1_worksheet_service_proto_msgTypes[14]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -749,7 +1023,7 @@ func (x *SearchWorksheetsResponse) String() string {
func (*SearchWorksheetsResponse) ProtoMessage() {}
func (x *SearchWorksheetsResponse) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[11]
+ mi := &file_v1_worksheet_service_proto_msgTypes[14]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -762,7 +1036,7 @@ func (x *SearchWorksheetsResponse) ProtoReflect() protoreflect.Message {
// Deprecated: Use SearchWorksheetsResponse.ProtoReflect.Descriptor instead.
func (*SearchWorksheetsResponse) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{11}
+ return file_v1_worksheet_service_proto_rawDescGZIP(), []int{14}
}
func (x *SearchWorksheetsResponse) GetWorksheets() []*Worksheet {
@@ -772,6 +1046,13 @@ func (x *SearchWorksheetsResponse) GetWorksheets() []*Worksheet {
return nil
}
+func (x *SearchWorksheetsResponse) GetNextPageToken() string {
+ if x != nil {
+ return x.NextPageToken
+ }
+ return ""
+}
+
type Worksheet struct {
state protoimpl.MessageState `protogen:"open.v1"`
// The name of the worksheet resource, generated by the server.
@@ -810,7 +1091,7 @@ type Worksheet struct {
func (x *Worksheet) Reset() {
*x = Worksheet{}
- mi := &file_v1_worksheet_service_proto_msgTypes[12]
+ mi := &file_v1_worksheet_service_proto_msgTypes[15]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -822,7 +1103,7 @@ func (x *Worksheet) String() string {
func (*Worksheet) ProtoMessage() {}
func (x *Worksheet) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[12]
+ mi := &file_v1_worksheet_service_proto_msgTypes[15]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -835,7 +1116,7 @@ func (x *Worksheet) ProtoReflect() protoreflect.Message {
// Deprecated: Use Worksheet.ProtoReflect.Descriptor instead.
func (*Worksheet) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{12}
+ return file_v1_worksheet_service_proto_rawDescGZIP(), []int{15}
}
func (x *Worksheet) GetName() string {
@@ -943,15 +1224,32 @@ const file_v1_worksheet_service_proto_rawDesc = "" +
"\n" +
"worksheets\x18\x01 \x03(\v2\x16.bytebase.v1.WorksheetR\n" +
"worksheets\x12&\n" +
- "\x0fnext_page_token\x18\x02 \x01(\tR\rnextPageToken\"\x90\x01\n" +
+ "\x0fnext_page_token\x18\x02 \x01(\tR\rnextPageToken\":\n" +
+ "\x1bListWorksheetFoldersRequest\x12\x1b\n" +
+ "\x06parent\x18\x01 \x01(\tB\x03\xe0A\x02R\x06parent\"V\n" +
+ "\x1cListWorksheetFoldersResponse\x126\n" +
+ "\afolders\x18\x01 \x03(\v2\x1c.bytebase.v1.WorksheetFolderR\afolders\"\xaa\x01\n" +
+ "\x0fWorksheetFolder\x12\x18\n" +
+ "\afolders\x18\x01 \x03(\tR\afolders\x12A\n" +
+ "\bcategory\x18\x02 \x01(\x0e2%.bytebase.v1.WorksheetFolder.CategoryR\bcategory\":\n" +
+ "\bCategory\x12\x18\n" +
+ "\x14CATEGORY_UNSPECIFIED\x10\x00\x12\b\n" +
+ "\x04MINE\x10\x01\x12\n" +
+ "\n" +
+ "\x06SHARED\x10\x02\"\x90\x01\n" +
"\x16UpdateWorksheetRequest\x129\n" +
"\tworksheet\x18\x01 \x01(\v2\x16.bytebase.v1.WorksheetB\x03\xe0A\x02R\tworksheet\x12;\n" +
"\vupdate_mask\x18\x02 \x01(\v2\x1a.google.protobuf.FieldMaskR\n" +
- "updateMask\"u\n" +
- "$BatchUpdateWorksheetOrganizerRequest\x12M\n" +
- "\brequests\x18\x01 \x03(\v2,.bytebase.v1.UpdateWorksheetOrganizerRequestB\x03\xe0A\x02R\brequests\"{\n" +
+ "updateMask\"\xe1\x01\n" +
+ "$BatchUpdateWorksheetOrganizerRequest\x12\x1b\n" +
+ "\x06parent\x18\x01 \x01(\tB\x03\xe0A\x02R\x06parent\x12\x16\n" +
+ "\x06filter\x18\x02 \x01(\tR\x06filter\x12B\n" +
+ "\torganizer\x18\x03 \x01(\v2\x1f.bytebase.v1.WorksheetOrganizerB\x03\xe0A\x02R\torganizer\x12@\n" +
+ "\vupdate_mask\x18\x04 \x01(\v2\x1a.google.protobuf.FieldMaskB\x03\xe0A\x02R\n" +
+ "updateMask\"\xa0\x01\n" +
"%BatchUpdateWorksheetOrganizerResponse\x12R\n" +
- "\x14worksheet_organizers\x18\x01 \x03(\v2\x1f.bytebase.v1.WorksheetOrganizerR\x13worksheetOrganizers\"\xc7\x01\n" +
+ "\x14worksheet_organizers\x18\x01 \x03(\v2\x1f.bytebase.v1.WorksheetOrganizerR\x13worksheetOrganizers\x12#\n" +
+ "\rupdated_count\x18\x02 \x01(\x05R\fupdatedCount\"\xc7\x01\n" +
"\x1fUpdateWorksheetOrganizerRequest\x12B\n" +
"\torganizer\x18\x01 \x01(\v2\x1f.bytebase.v1.WorksheetOrganizerB\x03\xe0A\x02R\torganizer\x12;\n" +
"\vupdate_mask\x18\x02 \x01(\v2\x1a.google.protobuf.FieldMaskR\n" +
@@ -962,14 +1260,18 @@ const file_v1_worksheet_service_proto_rawDesc = "" +
"\astarred\x18\x02 \x01(\bR\astarred\x12\x18\n" +
"\afolders\x18\x03 \x03(\tR\afolders\"1\n" +
"\x16DeleteWorksheetRequest\x12\x17\n" +
- "\x04name\x18\x01 \x01(\tB\x03\xe0A\x02R\x04name\"N\n" +
+ "\x04name\x18\x01 \x01(\tB\x03\xe0A\x02R\x04name\"\x8a\x01\n" +
"\x17SearchWorksheetsRequest\x12\x1b\n" +
"\x06parent\x18\x01 \x01(\tB\x03\xe0A\x02R\x06parent\x12\x16\n" +
- "\x06filter\x18\x02 \x01(\tR\x06filter\"R\n" +
+ "\x06filter\x18\x02 \x01(\tR\x06filter\x12\x1b\n" +
+ "\tpage_size\x18\x03 \x01(\x05R\bpageSize\x12\x1d\n" +
+ "\n" +
+ "page_token\x18\x04 \x01(\tR\tpageToken\"z\n" +
"\x18SearchWorksheetsResponse\x126\n" +
"\n" +
"worksheets\x18\x01 \x03(\v2\x16.bytebase.v1.WorksheetR\n" +
- "worksheets\"\xd1\x04\n" +
+ "worksheets\x12&\n" +
+ "\x0fnext_page_token\x18\x02 \x01(\tR\rnextPageToken\"\xd1\x04\n" +
"\tWorksheet\x12\x1a\n" +
"\x04name\x18\x01 \x01(\tB\x06\xe0A\x02\xe0A\x05R\x04name\x12\x1d\n" +
"\aproject\x18\x02 \x01(\tB\x03\xe0A\x03R\aproject\x12\x1a\n" +
@@ -993,16 +1295,16 @@ const file_v1_worksheet_service_proto_rawDesc = "" +
"\x16VISIBILITY_UNSPECIFIED\x10\x00\x12\x10\n" +
"\fPROJECT_READ\x10\x01\x12\x11\n" +
"\rPROJECT_WRITE\x10\x02\x12\v\n" +
- "\aPRIVATE\x10\x032\xce\n" +
- "\n" +
+ "\aPRIVATE\x10\x032\xaf\f\n" +
"\x10WorksheetService\x12\x9c\x01\n" +
"\x0fCreateWorksheet\x12#.bytebase.v1.CreateWorksheetRequest\x1a\x16.bytebase.v1.Worksheet\"L\xdaA\x10parent,worksheet\x90\xea0\x02\x82\xd3\xe4\x93\x02/:\tworksheet\"\"/v1/{parent=projects/*}/worksheets\x12\x7f\n" +
"\fGetWorksheet\x12 .bytebase.v1.GetWorksheetRequest\x1a\x16.bytebase.v1.Worksheet\"5\xdaA\x04name\x90\xea0\x02\x82\xd3\xe4\x93\x02$\x12\"/v1/{name=projects/*/worksheets/*}\x12\xa8\x01\n" +
- "\x0eListWorksheets\x12\".bytebase.v1.ListWorksheetsRequest\x1a#.bytebase.v1.ListWorksheetsResponse\"M\xdaA\x06parent\x8a\xea0\x12bb.worksheets.list\x90\xea0\x01\x82\xd3\xe4\x93\x02$\x12\"/v1/{parent=projects/*}/worksheets\x12\xa2\x01\n" +
+ "\x0eListWorksheets\x12\".bytebase.v1.ListWorksheetsRequest\x1a#.bytebase.v1.ListWorksheetsResponse\"M\xdaA\x06parent\x8a\xea0\x12bb.worksheets.list\x90\xea0\x01\x82\xd3\xe4\x93\x02$\x12\"/v1/{parent=projects/*}/worksheets\x12\xaa\x01\n" +
+ "\x14ListWorksheetFolders\x12(.bytebase.v1.ListWorksheetFoldersRequest\x1a).bytebase.v1.ListWorksheetFoldersResponse\"=\xdaA\x06parent\x90\xea0\x02\x82\xd3\xe4\x93\x02*\x12(/v1/{parent=projects/*}/worksheetFolders\x12\xa2\x01\n" +
"\x10SearchWorksheets\x12$.bytebase.v1.SearchWorksheetsRequest\x1a%.bytebase.v1.SearchWorksheetsResponse\"A\xdaA\x06parent\x90\xea0\x02\x82\xd3\xe4\x93\x02.:\x01*\")/v1/{parent=projects/*}/worksheets:search\x12\xab\x01\n" +
"\x0fUpdateWorksheet\x12#.bytebase.v1.UpdateWorksheetRequest\x1a\x16.bytebase.v1.Worksheet\"[\xdaA\x15worksheet,update_mask\x90\xea0\x02\x82\xd3\xe4\x93\x029:\tworksheet2,/v1/{worksheet.name=projects/*/worksheets/*}\x12\xd5\x01\n" +
- "\x18UpdateWorksheetOrganizer\x12,.bytebase.v1.UpdateWorksheetOrganizerRequest\x1a\x1f.bytebase.v1.WorksheetOrganizer\"j\xdaA\x15organizer,update_mask\x90\xea0\x02\x82\xd3\xe4\x93\x02H:\torganizer2;/v1/{organizer.worksheet=projects/*/worksheets/*}/organizer\x12\xbb\x01\n" +
- "\x1dBatchUpdateWorksheetOrganizer\x121.bytebase.v1.BatchUpdateWorksheetOrganizerRequest\x1a2.bytebase.v1.BatchUpdateWorksheetOrganizerResponse\"3\x90\xea0\x02\x82\xd3\xe4\x93\x02):\x01*2$/v1/worksheets/organizer:batchUpdate\x12\x85\x01\n" +
+ "\x18UpdateWorksheetOrganizer\x12,.bytebase.v1.UpdateWorksheetOrganizerRequest\x1a\x1f.bytebase.v1.WorksheetOrganizer\"j\xdaA\x15organizer,update_mask\x90\xea0\x02\x82\xd3\xe4\x93\x02H:\torganizer2;/v1/{organizer.worksheet=projects/*/worksheets/*}/organizer\x12\xef\x01\n" +
+ "\x1dBatchUpdateWorksheetOrganizer\x121.bytebase.v1.BatchUpdateWorksheetOrganizerRequest\x1a2.bytebase.v1.BatchUpdateWorksheetOrganizerResponse\"g\xdaA\x1cparent,organizer,update_mask\x90\xea0\x02\x82\xd3\xe4\x93\x02>:\x01*\"9/v1/{parent=projects/*}/worksheets/organizers:batchUpdate\x12\x85\x01\n" +
"\x0fDeleteWorksheet\x12#.bytebase.v1.DeleteWorksheetRequest\x1a\x16.google.protobuf.Empty\"5\xdaA\x04name\x90\xea0\x02\x82\xd3\xe4\x93\x02$*\"/v1/{name=projects/*/worksheets/*}B\xab\x01\n" +
"\x0fcom.bytebase.v1B\x15WorksheetServiceProtoP\x01Z4github.com/bytebase/bytebase/backend/generated-go/v1\xa2\x02\x03BXX\xaa\x02\vBytebase.V1\xca\x02\vBytebase\\V1\xe2\x02\x17Bytebase\\V1\\GPBMetadata\xea\x02\fBytebase::V1b\x06proto3"
@@ -1018,61 +1320,70 @@ func file_v1_worksheet_service_proto_rawDescGZIP() []byte {
return file_v1_worksheet_service_proto_rawDescData
}
-var file_v1_worksheet_service_proto_enumTypes = make([]protoimpl.EnumInfo, 1)
-var file_v1_worksheet_service_proto_msgTypes = make([]protoimpl.MessageInfo, 13)
+var file_v1_worksheet_service_proto_enumTypes = make([]protoimpl.EnumInfo, 2)
+var file_v1_worksheet_service_proto_msgTypes = make([]protoimpl.MessageInfo, 16)
var file_v1_worksheet_service_proto_goTypes = []any{
- (Worksheet_Visibility)(0), // 0: bytebase.v1.Worksheet.Visibility
- (*CreateWorksheetRequest)(nil), // 1: bytebase.v1.CreateWorksheetRequest
- (*GetWorksheetRequest)(nil), // 2: bytebase.v1.GetWorksheetRequest
- (*ListWorksheetsRequest)(nil), // 3: bytebase.v1.ListWorksheetsRequest
- (*ListWorksheetsResponse)(nil), // 4: bytebase.v1.ListWorksheetsResponse
- (*UpdateWorksheetRequest)(nil), // 5: bytebase.v1.UpdateWorksheetRequest
- (*BatchUpdateWorksheetOrganizerRequest)(nil), // 6: bytebase.v1.BatchUpdateWorksheetOrganizerRequest
- (*BatchUpdateWorksheetOrganizerResponse)(nil), // 7: bytebase.v1.BatchUpdateWorksheetOrganizerResponse
- (*UpdateWorksheetOrganizerRequest)(nil), // 8: bytebase.v1.UpdateWorksheetOrganizerRequest
- (*WorksheetOrganizer)(nil), // 9: bytebase.v1.WorksheetOrganizer
- (*DeleteWorksheetRequest)(nil), // 10: bytebase.v1.DeleteWorksheetRequest
- (*SearchWorksheetsRequest)(nil), // 11: bytebase.v1.SearchWorksheetsRequest
- (*SearchWorksheetsResponse)(nil), // 12: bytebase.v1.SearchWorksheetsResponse
- (*Worksheet)(nil), // 13: bytebase.v1.Worksheet
- (*fieldmaskpb.FieldMask)(nil), // 14: google.protobuf.FieldMask
- (*timestamppb.Timestamp)(nil), // 15: google.protobuf.Timestamp
- (*emptypb.Empty)(nil), // 16: google.protobuf.Empty
+ (WorksheetFolder_Category)(0), // 0: bytebase.v1.WorksheetFolder.Category
+ (Worksheet_Visibility)(0), // 1: bytebase.v1.Worksheet.Visibility
+ (*CreateWorksheetRequest)(nil), // 2: bytebase.v1.CreateWorksheetRequest
+ (*GetWorksheetRequest)(nil), // 3: bytebase.v1.GetWorksheetRequest
+ (*ListWorksheetsRequest)(nil), // 4: bytebase.v1.ListWorksheetsRequest
+ (*ListWorksheetsResponse)(nil), // 5: bytebase.v1.ListWorksheetsResponse
+ (*ListWorksheetFoldersRequest)(nil), // 6: bytebase.v1.ListWorksheetFoldersRequest
+ (*ListWorksheetFoldersResponse)(nil), // 7: bytebase.v1.ListWorksheetFoldersResponse
+ (*WorksheetFolder)(nil), // 8: bytebase.v1.WorksheetFolder
+ (*UpdateWorksheetRequest)(nil), // 9: bytebase.v1.UpdateWorksheetRequest
+ (*BatchUpdateWorksheetOrganizerRequest)(nil), // 10: bytebase.v1.BatchUpdateWorksheetOrganizerRequest
+ (*BatchUpdateWorksheetOrganizerResponse)(nil), // 11: bytebase.v1.BatchUpdateWorksheetOrganizerResponse
+ (*UpdateWorksheetOrganizerRequest)(nil), // 12: bytebase.v1.UpdateWorksheetOrganizerRequest
+ (*WorksheetOrganizer)(nil), // 13: bytebase.v1.WorksheetOrganizer
+ (*DeleteWorksheetRequest)(nil), // 14: bytebase.v1.DeleteWorksheetRequest
+ (*SearchWorksheetsRequest)(nil), // 15: bytebase.v1.SearchWorksheetsRequest
+ (*SearchWorksheetsResponse)(nil), // 16: bytebase.v1.SearchWorksheetsResponse
+ (*Worksheet)(nil), // 17: bytebase.v1.Worksheet
+ (*fieldmaskpb.FieldMask)(nil), // 18: google.protobuf.FieldMask
+ (*timestamppb.Timestamp)(nil), // 19: google.protobuf.Timestamp
+ (*emptypb.Empty)(nil), // 20: google.protobuf.Empty
}
var file_v1_worksheet_service_proto_depIdxs = []int32{
- 13, // 0: bytebase.v1.CreateWorksheetRequest.worksheet:type_name -> bytebase.v1.Worksheet
- 13, // 1: bytebase.v1.ListWorksheetsResponse.worksheets:type_name -> bytebase.v1.Worksheet
- 13, // 2: bytebase.v1.UpdateWorksheetRequest.worksheet:type_name -> bytebase.v1.Worksheet
- 14, // 3: bytebase.v1.UpdateWorksheetRequest.update_mask:type_name -> google.protobuf.FieldMask
- 8, // 4: bytebase.v1.BatchUpdateWorksheetOrganizerRequest.requests:type_name -> bytebase.v1.UpdateWorksheetOrganizerRequest
- 9, // 5: bytebase.v1.BatchUpdateWorksheetOrganizerResponse.worksheet_organizers:type_name -> bytebase.v1.WorksheetOrganizer
- 9, // 6: bytebase.v1.UpdateWorksheetOrganizerRequest.organizer:type_name -> bytebase.v1.WorksheetOrganizer
- 14, // 7: bytebase.v1.UpdateWorksheetOrganizerRequest.update_mask:type_name -> google.protobuf.FieldMask
- 13, // 8: bytebase.v1.SearchWorksheetsResponse.worksheets:type_name -> bytebase.v1.Worksheet
- 15, // 9: bytebase.v1.Worksheet.create_time:type_name -> google.protobuf.Timestamp
- 15, // 10: bytebase.v1.Worksheet.update_time:type_name -> google.protobuf.Timestamp
- 0, // 11: bytebase.v1.Worksheet.visibility:type_name -> bytebase.v1.Worksheet.Visibility
- 1, // 12: bytebase.v1.WorksheetService.CreateWorksheet:input_type -> bytebase.v1.CreateWorksheetRequest
- 2, // 13: bytebase.v1.WorksheetService.GetWorksheet:input_type -> bytebase.v1.GetWorksheetRequest
- 3, // 14: bytebase.v1.WorksheetService.ListWorksheets:input_type -> bytebase.v1.ListWorksheetsRequest
- 11, // 15: bytebase.v1.WorksheetService.SearchWorksheets:input_type -> bytebase.v1.SearchWorksheetsRequest
- 5, // 16: bytebase.v1.WorksheetService.UpdateWorksheet:input_type -> bytebase.v1.UpdateWorksheetRequest
- 8, // 17: bytebase.v1.WorksheetService.UpdateWorksheetOrganizer:input_type -> bytebase.v1.UpdateWorksheetOrganizerRequest
- 6, // 18: bytebase.v1.WorksheetService.BatchUpdateWorksheetOrganizer:input_type -> bytebase.v1.BatchUpdateWorksheetOrganizerRequest
- 10, // 19: bytebase.v1.WorksheetService.DeleteWorksheet:input_type -> bytebase.v1.DeleteWorksheetRequest
- 13, // 20: bytebase.v1.WorksheetService.CreateWorksheet:output_type -> bytebase.v1.Worksheet
- 13, // 21: bytebase.v1.WorksheetService.GetWorksheet:output_type -> bytebase.v1.Worksheet
- 4, // 22: bytebase.v1.WorksheetService.ListWorksheets:output_type -> bytebase.v1.ListWorksheetsResponse
- 12, // 23: bytebase.v1.WorksheetService.SearchWorksheets:output_type -> bytebase.v1.SearchWorksheetsResponse
- 13, // 24: bytebase.v1.WorksheetService.UpdateWorksheet:output_type -> bytebase.v1.Worksheet
- 9, // 25: bytebase.v1.WorksheetService.UpdateWorksheetOrganizer:output_type -> bytebase.v1.WorksheetOrganizer
- 7, // 26: bytebase.v1.WorksheetService.BatchUpdateWorksheetOrganizer:output_type -> bytebase.v1.BatchUpdateWorksheetOrganizerResponse
- 16, // 27: bytebase.v1.WorksheetService.DeleteWorksheet:output_type -> google.protobuf.Empty
- 20, // [20:28] is the sub-list for method output_type
- 12, // [12:20] is the sub-list for method input_type
- 12, // [12:12] is the sub-list for extension type_name
- 12, // [12:12] is the sub-list for extension extendee
- 0, // [0:12] is the sub-list for field type_name
+ 17, // 0: bytebase.v1.CreateWorksheetRequest.worksheet:type_name -> bytebase.v1.Worksheet
+ 17, // 1: bytebase.v1.ListWorksheetsResponse.worksheets:type_name -> bytebase.v1.Worksheet
+ 8, // 2: bytebase.v1.ListWorksheetFoldersResponse.folders:type_name -> bytebase.v1.WorksheetFolder
+ 0, // 3: bytebase.v1.WorksheetFolder.category:type_name -> bytebase.v1.WorksheetFolder.Category
+ 17, // 4: bytebase.v1.UpdateWorksheetRequest.worksheet:type_name -> bytebase.v1.Worksheet
+ 18, // 5: bytebase.v1.UpdateWorksheetRequest.update_mask:type_name -> google.protobuf.FieldMask
+ 13, // 6: bytebase.v1.BatchUpdateWorksheetOrganizerRequest.organizer:type_name -> bytebase.v1.WorksheetOrganizer
+ 18, // 7: bytebase.v1.BatchUpdateWorksheetOrganizerRequest.update_mask:type_name -> google.protobuf.FieldMask
+ 13, // 8: bytebase.v1.BatchUpdateWorksheetOrganizerResponse.worksheet_organizers:type_name -> bytebase.v1.WorksheetOrganizer
+ 13, // 9: bytebase.v1.UpdateWorksheetOrganizerRequest.organizer:type_name -> bytebase.v1.WorksheetOrganizer
+ 18, // 10: bytebase.v1.UpdateWorksheetOrganizerRequest.update_mask:type_name -> google.protobuf.FieldMask
+ 17, // 11: bytebase.v1.SearchWorksheetsResponse.worksheets:type_name -> bytebase.v1.Worksheet
+ 19, // 12: bytebase.v1.Worksheet.create_time:type_name -> google.protobuf.Timestamp
+ 19, // 13: bytebase.v1.Worksheet.update_time:type_name -> google.protobuf.Timestamp
+ 1, // 14: bytebase.v1.Worksheet.visibility:type_name -> bytebase.v1.Worksheet.Visibility
+ 2, // 15: bytebase.v1.WorksheetService.CreateWorksheet:input_type -> bytebase.v1.CreateWorksheetRequest
+ 3, // 16: bytebase.v1.WorksheetService.GetWorksheet:input_type -> bytebase.v1.GetWorksheetRequest
+ 4, // 17: bytebase.v1.WorksheetService.ListWorksheets:input_type -> bytebase.v1.ListWorksheetsRequest
+ 6, // 18: bytebase.v1.WorksheetService.ListWorksheetFolders:input_type -> bytebase.v1.ListWorksheetFoldersRequest
+ 15, // 19: bytebase.v1.WorksheetService.SearchWorksheets:input_type -> bytebase.v1.SearchWorksheetsRequest
+ 9, // 20: bytebase.v1.WorksheetService.UpdateWorksheet:input_type -> bytebase.v1.UpdateWorksheetRequest
+ 12, // 21: bytebase.v1.WorksheetService.UpdateWorksheetOrganizer:input_type -> bytebase.v1.UpdateWorksheetOrganizerRequest
+ 10, // 22: bytebase.v1.WorksheetService.BatchUpdateWorksheetOrganizer:input_type -> bytebase.v1.BatchUpdateWorksheetOrganizerRequest
+ 14, // 23: bytebase.v1.WorksheetService.DeleteWorksheet:input_type -> bytebase.v1.DeleteWorksheetRequest
+ 17, // 24: bytebase.v1.WorksheetService.CreateWorksheet:output_type -> bytebase.v1.Worksheet
+ 17, // 25: bytebase.v1.WorksheetService.GetWorksheet:output_type -> bytebase.v1.Worksheet
+ 5, // 26: bytebase.v1.WorksheetService.ListWorksheets:output_type -> bytebase.v1.ListWorksheetsResponse
+ 7, // 27: bytebase.v1.WorksheetService.ListWorksheetFolders:output_type -> bytebase.v1.ListWorksheetFoldersResponse
+ 16, // 28: bytebase.v1.WorksheetService.SearchWorksheets:output_type -> bytebase.v1.SearchWorksheetsResponse
+ 17, // 29: bytebase.v1.WorksheetService.UpdateWorksheet:output_type -> bytebase.v1.Worksheet
+ 13, // 30: bytebase.v1.WorksheetService.UpdateWorksheetOrganizer:output_type -> bytebase.v1.WorksheetOrganizer
+ 11, // 31: bytebase.v1.WorksheetService.BatchUpdateWorksheetOrganizer:output_type -> bytebase.v1.BatchUpdateWorksheetOrganizerResponse
+ 20, // 32: bytebase.v1.WorksheetService.DeleteWorksheet:output_type -> google.protobuf.Empty
+ 24, // [24:33] is the sub-list for method output_type
+ 15, // [15:24] is the sub-list for method input_type
+ 15, // [15:15] is the sub-list for extension type_name
+ 15, // [15:15] is the sub-list for extension extendee
+ 0, // [0:15] is the sub-list for field type_name
}
func init() { file_v1_worksheet_service_proto_init() }
@@ -1086,8 +1397,8 @@ func file_v1_worksheet_service_proto_init() {
File: protoimpl.DescBuilder{
GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
RawDescriptor: unsafe.Slice(unsafe.StringData(file_v1_worksheet_service_proto_rawDesc), len(file_v1_worksheet_service_proto_rawDesc)),
- NumEnums: 1,
- NumMessages: 13,
+ NumEnums: 2,
+ NumMessages: 16,
NumExtensions: 0,
NumServices: 1,
},
diff --git a/backend/generated-go/v1/worksheet_service.pb.gw.go b/backend/generated-go/v1/worksheet_service.pb.gw.go
index 1db5b0b32d..10392ce856 100644
--- a/backend/generated-go/v1/worksheet_service.pb.gw.go
+++ b/backend/generated-go/v1/worksheet_service.pb.gw.go
@@ -172,6 +172,45 @@ func local_request_WorksheetService_ListWorksheets_0(ctx context.Context, marsha
return msg, metadata, err
}
+func request_WorksheetService_ListWorksheetFolders_0(ctx context.Context, marshaler runtime.Marshaler, client WorksheetServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
+ var (
+ protoReq ListWorksheetFoldersRequest
+ metadata runtime.ServerMetadata
+ err error
+ )
+ if req.Body != nil {
+ _, _ = io.Copy(io.Discard, req.Body)
+ }
+ val, ok := pathParams["parent"]
+ if !ok {
+ return nil, metadata, status.Errorf(codes.InvalidArgument, "missing parameter %s", "parent")
+ }
+ protoReq.Parent, err = runtime.String(val)
+ if err != nil {
+ return nil, metadata, status.Errorf(codes.InvalidArgument, "type mismatch, parameter: %s, error: %v", "parent", err)
+ }
+ msg, err := client.ListWorksheetFolders(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
+ return msg, metadata, err
+}
+
+func local_request_WorksheetService_ListWorksheetFolders_0(ctx context.Context, marshaler runtime.Marshaler, server WorksheetServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
+ var (
+ protoReq ListWorksheetFoldersRequest
+ metadata runtime.ServerMetadata
+ err error
+ )
+ val, ok := pathParams["parent"]
+ if !ok {
+ return nil, metadata, status.Errorf(codes.InvalidArgument, "missing parameter %s", "parent")
+ }
+ protoReq.Parent, err = runtime.String(val)
+ if err != nil {
+ return nil, metadata, status.Errorf(codes.InvalidArgument, "type mismatch, parameter: %s, error: %v", "parent", err)
+ }
+ msg, err := server.ListWorksheetFolders(ctx, &protoReq)
+ return msg, metadata, err
+}
+
func request_WorksheetService_SearchWorksheets_0(ctx context.Context, marshaler runtime.Marshaler, client WorksheetServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var (
protoReq SearchWorksheetsRequest
@@ -383,6 +422,7 @@ func request_WorksheetService_BatchUpdateWorksheetOrganizer_0(ctx context.Contex
var (
protoReq BatchUpdateWorksheetOrganizerRequest
metadata runtime.ServerMetadata
+ err error
)
if err := marshaler.NewDecoder(req.Body).Decode(&protoReq); err != nil && !errors.Is(err, io.EOF) {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", err)
@@ -390,6 +430,14 @@ func request_WorksheetService_BatchUpdateWorksheetOrganizer_0(ctx context.Contex
if req.Body != nil {
_, _ = io.Copy(io.Discard, req.Body)
}
+ val, ok := pathParams["parent"]
+ if !ok {
+ return nil, metadata, status.Errorf(codes.InvalidArgument, "missing parameter %s", "parent")
+ }
+ protoReq.Parent, err = runtime.String(val)
+ if err != nil {
+ return nil, metadata, status.Errorf(codes.InvalidArgument, "type mismatch, parameter: %s, error: %v", "parent", err)
+ }
msg, err := client.BatchUpdateWorksheetOrganizer(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
return msg, metadata, err
}
@@ -398,10 +446,19 @@ func local_request_WorksheetService_BatchUpdateWorksheetOrganizer_0(ctx context.
var (
protoReq BatchUpdateWorksheetOrganizerRequest
metadata runtime.ServerMetadata
+ err error
)
if err := marshaler.NewDecoder(req.Body).Decode(&protoReq); err != nil && !errors.Is(err, io.EOF) {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", err)
}
+ val, ok := pathParams["parent"]
+ if !ok {
+ return nil, metadata, status.Errorf(codes.InvalidArgument, "missing parameter %s", "parent")
+ }
+ protoReq.Parent, err = runtime.String(val)
+ if err != nil {
+ return nil, metadata, status.Errorf(codes.InvalidArgument, "type mismatch, parameter: %s, error: %v", "parent", err)
+ }
msg, err := server.BatchUpdateWorksheetOrganizer(ctx, &protoReq)
return msg, metadata, err
}
@@ -511,6 +568,26 @@ func RegisterWorksheetServiceHandlerServer(ctx context.Context, mux *runtime.Ser
}
forward_WorksheetService_ListWorksheets_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
+ mux.Handle(http.MethodGet, pattern_WorksheetService_ListWorksheetFolders_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+ ctx, cancel := context.WithCancel(req.Context())
+ defer cancel()
+ var stream runtime.ServerTransportStream
+ ctx = grpc.NewContextWithServerTransportStream(ctx, &stream)
+ inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
+ annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.WorksheetService/ListWorksheetFolders", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/worksheetFolders"))
+ if err != nil {
+ runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
+ return
+ }
+ resp, md, err := local_request_WorksheetService_ListWorksheetFolders_0(annotatedContext, inboundMarshaler, server, req, pathParams)
+ md.HeaderMD, md.TrailerMD = metadata.Join(md.HeaderMD, stream.Header()), metadata.Join(md.TrailerMD, stream.Trailer())
+ annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md)
+ if err != nil {
+ runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err)
+ return
+ }
+ forward_WorksheetService_ListWorksheetFolders_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
+ })
mux.Handle(http.MethodPost, pattern_WorksheetService_SearchWorksheets_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
@@ -571,13 +648,13 @@ func RegisterWorksheetServiceHandlerServer(ctx context.Context, mux *runtime.Ser
}
forward_WorksheetService_UpdateWorksheetOrganizer_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
- mux.Handle(http.MethodPatch, pattern_WorksheetService_BatchUpdateWorksheetOrganizer_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+ mux.Handle(http.MethodPost, pattern_WorksheetService_BatchUpdateWorksheetOrganizer_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
var stream runtime.ServerTransportStream
ctx = grpc.NewContextWithServerTransportStream(ctx, &stream)
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
- annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.WorksheetService/BatchUpdateWorksheetOrganizer", runtime.WithHTTPPathPattern("/v1/worksheets/organizer:batchUpdate"))
+ annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.WorksheetService/BatchUpdateWorksheetOrganizer", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/worksheets/organizers:batchUpdate"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
@@ -702,6 +779,23 @@ func RegisterWorksheetServiceHandlerClient(ctx context.Context, mux *runtime.Ser
}
forward_WorksheetService_ListWorksheets_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
+ mux.Handle(http.MethodGet, pattern_WorksheetService_ListWorksheetFolders_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+ ctx, cancel := context.WithCancel(req.Context())
+ defer cancel()
+ inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
+ annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.WorksheetService/ListWorksheetFolders", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/worksheetFolders"))
+ if err != nil {
+ runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
+ return
+ }
+ resp, md, err := request_WorksheetService_ListWorksheetFolders_0(annotatedContext, inboundMarshaler, client, req, pathParams)
+ annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md)
+ if err != nil {
+ runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err)
+ return
+ }
+ forward_WorksheetService_ListWorksheetFolders_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
+ })
mux.Handle(http.MethodPost, pattern_WorksheetService_SearchWorksheets_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
@@ -753,11 +847,11 @@ func RegisterWorksheetServiceHandlerClient(ctx context.Context, mux *runtime.Ser
}
forward_WorksheetService_UpdateWorksheetOrganizer_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
- mux.Handle(http.MethodPatch, pattern_WorksheetService_BatchUpdateWorksheetOrganizer_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+ mux.Handle(http.MethodPost, pattern_WorksheetService_BatchUpdateWorksheetOrganizer_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
- annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.WorksheetService/BatchUpdateWorksheetOrganizer", runtime.WithHTTPPathPattern("/v1/worksheets/organizer:batchUpdate"))
+ annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.WorksheetService/BatchUpdateWorksheetOrganizer", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/worksheets/organizers:batchUpdate"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
@@ -794,10 +888,11 @@ var (
pattern_WorksheetService_CreateWorksheet_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 4, 2, 5, 2, 2, 3}, []string{"v1", "projects", "parent", "worksheets"}, ""))
pattern_WorksheetService_GetWorksheet_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 2, 2, 1, 0, 4, 4, 5, 3}, []string{"v1", "projects", "worksheets", "name"}, ""))
pattern_WorksheetService_ListWorksheets_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 4, 2, 5, 2, 2, 3}, []string{"v1", "projects", "parent", "worksheets"}, ""))
+ pattern_WorksheetService_ListWorksheetFolders_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 4, 2, 5, 2, 2, 3}, []string{"v1", "projects", "parent", "worksheetFolders"}, ""))
pattern_WorksheetService_SearchWorksheets_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 4, 2, 5, 2, 2, 3}, []string{"v1", "projects", "parent", "worksheets"}, "search"))
pattern_WorksheetService_UpdateWorksheet_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 2, 2, 1, 0, 4, 4, 5, 3}, []string{"v1", "projects", "worksheets", "worksheet.name"}, ""))
pattern_WorksheetService_UpdateWorksheetOrganizer_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 2, 2, 1, 0, 4, 4, 5, 3, 2, 4}, []string{"v1", "projects", "worksheets", "organizer.worksheet", "organizer"}, ""))
- pattern_WorksheetService_BatchUpdateWorksheetOrganizer_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 2, 2}, []string{"v1", "worksheets", "organizer"}, "batchUpdate"))
+ pattern_WorksheetService_BatchUpdateWorksheetOrganizer_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 4, 2, 5, 2, 2, 3, 2, 4}, []string{"v1", "projects", "parent", "worksheets", "organizers"}, "batchUpdate"))
pattern_WorksheetService_DeleteWorksheet_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 2, 2, 1, 0, 4, 4, 5, 3}, []string{"v1", "projects", "worksheets", "name"}, ""))
)
@@ -805,6 +900,7 @@ var (
forward_WorksheetService_CreateWorksheet_0 = runtime.ForwardResponseMessage
forward_WorksheetService_GetWorksheet_0 = runtime.ForwardResponseMessage
forward_WorksheetService_ListWorksheets_0 = runtime.ForwardResponseMessage
+ forward_WorksheetService_ListWorksheetFolders_0 = runtime.ForwardResponseMessage
forward_WorksheetService_SearchWorksheets_0 = runtime.ForwardResponseMessage
forward_WorksheetService_UpdateWorksheet_0 = runtime.ForwardResponseMessage
forward_WorksheetService_UpdateWorksheetOrganizer_0 = runtime.ForwardResponseMessage
diff --git a/backend/generated-go/v1/worksheet_service_equal.pb.go b/backend/generated-go/v1/worksheet_service_equal.pb.go
index 1c65391ded..ab65b5a1fc 100644
--- a/backend/generated-go/v1/worksheet_service_equal.pb.go
+++ b/backend/generated-go/v1/worksheet_service_equal.pb.go
@@ -80,6 +80,58 @@ func (x *ListWorksheetsResponse) Equal(y *ListWorksheetsResponse) bool {
return true
}
+func (x *ListWorksheetFoldersRequest) Equal(y *ListWorksheetFoldersRequest) bool {
+ if x == y {
+ return true
+ }
+ if x == nil || y == nil {
+ return x == nil && y == nil
+ }
+ if x.Parent != y.Parent {
+ return false
+ }
+ return true
+}
+
+func (x *ListWorksheetFoldersResponse) Equal(y *ListWorksheetFoldersResponse) bool {
+ if x == y {
+ return true
+ }
+ if x == nil || y == nil {
+ return x == nil && y == nil
+ }
+ if len(x.Folders) != len(y.Folders) {
+ return false
+ }
+ for i := 0; i < len(x.Folders); i++ {
+ if !x.Folders[i].Equal(y.Folders[i]) {
+ return false
+ }
+ }
+ return true
+}
+
+func (x *WorksheetFolder) Equal(y *WorksheetFolder) bool {
+ if x == y {
+ return true
+ }
+ if x == nil || y == nil {
+ return x == nil && y == nil
+ }
+ if len(x.Folders) != len(y.Folders) {
+ return false
+ }
+ for i := 0; i < len(x.Folders); i++ {
+ if x.Folders[i] != y.Folders[i] {
+ return false
+ }
+ }
+ if x.Category != y.Category {
+ return false
+ }
+ return true
+}
+
func (x *UpdateWorksheetRequest) Equal(y *UpdateWorksheetRequest) bool {
if x == y {
return true
@@ -107,13 +159,21 @@ func (x *BatchUpdateWorksheetOrganizerRequest) Equal(y *BatchUpdateWorksheetOrga
if x == nil || y == nil {
return x == nil && y == nil
}
- if len(x.Requests) != len(y.Requests) {
+ if x.Parent != y.Parent {
return false
}
- for i := 0; i < len(x.Requests); i++ {
- if !x.Requests[i].Equal(y.Requests[i]) {
- return false
- }
+ if x.Filter != y.Filter {
+ return false
+ }
+ if !x.Organizer.Equal(y.Organizer) {
+ return false
+ }
+ if equal, ok := interface{}(x.UpdateMask).(interface {
+ Equal(*fieldmaskpb.FieldMask) bool
+ }); !ok || !equal.Equal(y.UpdateMask) {
+ return false
+ } else if !proto.Equal(x.UpdateMask, y.UpdateMask) {
+ return false
}
return true
}
@@ -133,6 +193,9 @@ func (x *BatchUpdateWorksheetOrganizerResponse) Equal(y *BatchUpdateWorksheetOrg
return false
}
}
+ if x.UpdatedCount != y.UpdatedCount {
+ return false
+ }
return true
}
@@ -209,6 +272,12 @@ func (x *SearchWorksheetsRequest) Equal(y *SearchWorksheetsRequest) bool {
if x.Filter != y.Filter {
return false
}
+ if x.PageSize != y.PageSize {
+ return false
+ }
+ if x.PageToken != y.PageToken {
+ return false
+ }
return true
}
@@ -227,6 +296,9 @@ func (x *SearchWorksheetsResponse) Equal(y *SearchWorksheetsResponse) bool {
return false
}
}
+ if x.NextPageToken != y.NextPageToken {
+ return false
+ }
return true
}
diff --git a/backend/generated-go/v1/worksheet_service_grpc.pb.go b/backend/generated-go/v1/worksheet_service_grpc.pb.go
index d56b3e7dd2..45bf87ae3f 100644
--- a/backend/generated-go/v1/worksheet_service_grpc.pb.go
+++ b/backend/generated-go/v1/worksheet_service_grpc.pb.go
@@ -23,6 +23,7 @@ const (
WorksheetService_CreateWorksheet_FullMethodName = "/bytebase.v1.WorksheetService/CreateWorksheet"
WorksheetService_GetWorksheet_FullMethodName = "/bytebase.v1.WorksheetService/GetWorksheet"
WorksheetService_ListWorksheets_FullMethodName = "/bytebase.v1.WorksheetService/ListWorksheets"
+ WorksheetService_ListWorksheetFolders_FullMethodName = "/bytebase.v1.WorksheetService/ListWorksheetFolders"
WorksheetService_SearchWorksheets_FullMethodName = "/bytebase.v1.WorksheetService/SearchWorksheets"
WorksheetService_UpdateWorksheet_FullMethodName = "/bytebase.v1.WorksheetService/UpdateWorksheet"
WorksheetService_UpdateWorksheetOrganizer_FullMethodName = "/bytebase.v1.WorksheetService/UpdateWorksheetOrganizer"
@@ -50,6 +51,9 @@ type WorksheetServiceClient interface {
// This is used for listing worksheets in a project, or across all projects by using `projects/-`.
// Permissions required: bb.worksheets.list
ListWorksheets(ctx context.Context, in *ListWorksheetsRequest, opts ...grpc.CallOption) (*ListWorksheetsResponse, error)
+ // List the caller's worksheet folders.
+ // Only folders stored in the caller's worksheet organizer are returned.
+ ListWorksheetFolders(ctx context.Context, in *ListWorksheetFoldersRequest, opts ...grpc.CallOption) (*ListWorksheetFoldersResponse, error)
// Search for worksheets.
// This is used for finding my worksheets or worksheets shared by other people.
// The sheet accessibility is the same as GetWorksheet().
@@ -114,6 +118,16 @@ func (c *worksheetServiceClient) ListWorksheets(ctx context.Context, in *ListWor
return out, nil
}
+func (c *worksheetServiceClient) ListWorksheetFolders(ctx context.Context, in *ListWorksheetFoldersRequest, opts ...grpc.CallOption) (*ListWorksheetFoldersResponse, error) {
+ cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
+ out := new(ListWorksheetFoldersResponse)
+ err := c.cc.Invoke(ctx, WorksheetService_ListWorksheetFolders_FullMethodName, in, out, cOpts...)
+ if err != nil {
+ return nil, err
+ }
+ return out, nil
+}
+
func (c *worksheetServiceClient) SearchWorksheets(ctx context.Context, in *SearchWorksheetsRequest, opts ...grpc.CallOption) (*SearchWorksheetsResponse, error) {
cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
out := new(SearchWorksheetsResponse)
@@ -184,6 +198,9 @@ type WorksheetServiceServer interface {
// This is used for listing worksheets in a project, or across all projects by using `projects/-`.
// Permissions required: bb.worksheets.list
ListWorksheets(context.Context, *ListWorksheetsRequest) (*ListWorksheetsResponse, error)
+ // List the caller's worksheet folders.
+ // Only folders stored in the caller's worksheet organizer are returned.
+ ListWorksheetFolders(context.Context, *ListWorksheetFoldersRequest) (*ListWorksheetFoldersResponse, error)
// Search for worksheets.
// This is used for finding my worksheets or worksheets shared by other people.
// The sheet accessibility is the same as GetWorksheet().
@@ -227,6 +244,9 @@ func (UnimplementedWorksheetServiceServer) GetWorksheet(context.Context, *GetWor
func (UnimplementedWorksheetServiceServer) ListWorksheets(context.Context, *ListWorksheetsRequest) (*ListWorksheetsResponse, error) {
return nil, status.Error(codes.Unimplemented, "method ListWorksheets not implemented")
}
+func (UnimplementedWorksheetServiceServer) ListWorksheetFolders(context.Context, *ListWorksheetFoldersRequest) (*ListWorksheetFoldersResponse, error) {
+ return nil, status.Error(codes.Unimplemented, "method ListWorksheetFolders not implemented")
+}
func (UnimplementedWorksheetServiceServer) SearchWorksheets(context.Context, *SearchWorksheetsRequest) (*SearchWorksheetsResponse, error) {
return nil, status.Error(codes.Unimplemented, "method SearchWorksheets not implemented")
}
@@ -317,6 +337,24 @@ func _WorksheetService_ListWorksheets_Handler(srv interface{}, ctx context.Conte
return interceptor(ctx, in, info, handler)
}
+func _WorksheetService_ListWorksheetFolders_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
+ in := new(ListWorksheetFoldersRequest)
+ if err := dec(in); err != nil {
+ return nil, err
+ }
+ if interceptor == nil {
+ return srv.(WorksheetServiceServer).ListWorksheetFolders(ctx, in)
+ }
+ info := &grpc.UnaryServerInfo{
+ Server: srv,
+ FullMethod: WorksheetService_ListWorksheetFolders_FullMethodName,
+ }
+ handler := func(ctx context.Context, req interface{}) (interface{}, error) {
+ return srv.(WorksheetServiceServer).ListWorksheetFolders(ctx, req.(*ListWorksheetFoldersRequest))
+ }
+ return interceptor(ctx, in, info, handler)
+}
+
func _WorksheetService_SearchWorksheets_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
in := new(SearchWorksheetsRequest)
if err := dec(in); err != nil {
@@ -426,6 +464,10 @@ var WorksheetService_ServiceDesc = grpc.ServiceDesc{
MethodName: "ListWorksheets",
Handler: _WorksheetService_ListWorksheets_Handler,
},
+ {
+ MethodName: "ListWorksheetFolders",
+ Handler: _WorksheetService_ListWorksheetFolders_Handler,
+ },
{
MethodName: "SearchWorksheets",
Handler: _WorksheetService_SearchWorksheets_Handler,
diff --git a/backend/store/worksheet.go b/backend/store/worksheet.go
index f54d9ad203..39dce9a1d1 100644
--- a/backend/store/worksheet.go
+++ b/backend/store/worksheet.go
@@ -3,6 +3,7 @@ package store
import (
"context"
"database/sql"
+ "encoding/json"
"fmt"
"strings"
"time"
@@ -10,6 +11,7 @@ import (
"github.com/google/cel-go/cel"
celast "github.com/google/cel-go/common/ast"
celoperators "github.com/google/cel-go/common/operators"
+ celoverloads "github.com/google/cel-go/common/overloads"
"github.com/pkg/errors"
"google.golang.org/protobuf/encoding/protojson"
@@ -145,7 +147,7 @@ func (s *Store) ListWorkSheets(ctx context.Context, find *FindWorkSheetMessage)
q.And("worksheet.resource_id = ?", *v)
}
- q.Space("ORDER BY worksheet.updated_at DESC, worksheet.resource_id DESC")
+ q.Space("ORDER BY worksheet.name, worksheet.resource_id")
if v := find.Limit; v != nil {
q.Space("LIMIT ?", *v)
}
@@ -208,6 +210,82 @@ func (s *Store) ListWorkSheets(ctx context.Context, find *FindWorkSheetMessage)
return sheets, nil
}
+// ListWorksheetOrganizers returns the caller's worksheet organizers.
+func (s *Store) ListWorksheetOrganizers(ctx context.Context, find *FindWorkSheetMessage) ([]*WorksheetOrganizerMessage, error) {
+ if len(find.ProjectIDs) == 0 && find.Workspace == "" {
+ return nil, errors.Errorf("empty project filter")
+ }
+ if find.PrincipalEmail == "" {
+ return nil, errors.Errorf("empty principal")
+ }
+ q := qb.Q().Space(`
+ SELECT
+ worksheet.resource_id,
+ worksheet.creator,
+ worksheet.visibility,
+ worksheet_organizer.principal,
+ worksheet_organizer.payload
+ FROM worksheet_organizer
+ JOIN worksheet ON worksheet.resource_id = worksheet_organizer.worksheet
+ WHERE worksheet_organizer.principal = ?`, find.PrincipalEmail)
+
+ if find.Workspace != "" {
+ q.And("EXISTS (SELECT 1 FROM project WHERE project.resource_id = worksheet.project AND project.workspace = ? AND project.deleted = FALSE)", find.Workspace)
+ }
+ if len(find.ProjectIDs) == 1 {
+ q.And("worksheet.project = ?", find.ProjectIDs[0])
+ } else if len(find.ProjectIDs) > 1 {
+ q.And("worksheet.project = ANY(?)", find.ProjectIDs)
+ }
+
+ if filterQ := find.FilterQ; filterQ != nil {
+ q.And("?", filterQ)
+ }
+
+ q.Space("ORDER BY worksheet.project, worksheet.resource_id")
+
+ query, args, err := q.ToSQL()
+ if err != nil {
+ return nil, errors.Wrapf(err, "failed to build sql")
+ }
+
+ rows, err := s.GetDB().QueryContext(ctx, query, args...)
+ if err != nil {
+ return nil, err
+ }
+ defer rows.Close()
+
+ var worksheetOrganizers []*WorksheetOrganizerMessage
+ for rows.Next() {
+ var worksheetOrganizer WorksheetOrganizerMessage
+ var visibility string
+ var payloadBytes []byte
+ if err := rows.Scan(
+ &worksheetOrganizer.WorksheetResourceID,
+ &worksheetOrganizer.WorksheetCreator,
+ &visibility,
+ &worksheetOrganizer.Principal,
+ &payloadBytes,
+ ); err != nil {
+ return nil, err
+ }
+ worksheetOrganizer.WorksheetVisibility = WorkSheetVisibility(visibility)
+
+ var payload storepb.WorkSheetOrganizerPayload
+ if err := common.ProtojsonUnmarshaler.Unmarshal(payloadBytes, &payload); err != nil {
+ return nil, errors.Wrapf(err, "failed to unmarshal worksheet organizer payload")
+ }
+ worksheetOrganizer.Payload = &payload
+
+ worksheetOrganizers = append(worksheetOrganizers, &worksheetOrganizer)
+ }
+ if err := rows.Err(); err != nil {
+ return nil, err
+ }
+
+ return worksheetOrganizers, nil
+}
+
// CreateWorkSheet creates a new sheet.
func (s *Store) CreateWorkSheet(ctx context.Context, create *WorkSheetMessage) (*WorkSheetMessage, error) {
q := qb.Q().Space(`
@@ -300,10 +378,20 @@ func (s *Store) DeleteWorkSheet(ctx context.Context, resourceID string) error {
// WorksheetOrganizerMessage is the store message for worksheet organizer.
type WorksheetOrganizerMessage struct {
WorksheetResourceID string
+ WorksheetCreator string
+ WorksheetVisibility WorkSheetVisibility
Principal string
Payload *storepb.WorkSheetOrganizerPayload
}
+// BatchUpdateWorksheetOrganizerPatch is the patch for updating worksheet organizers in batch.
+type BatchUpdateWorksheetOrganizerPatch struct {
+ WorksheetResourceIDs []string
+ Principal string
+ Starred *bool
+ Folders *[]string
+}
+
func (s *Store) GetWorksheetOrganizer(ctx context.Context, worksheetResourceID string, principal string) (*WorksheetOrganizerMessage, error) {
q := qb.Q().Space(`
SELECT
@@ -387,7 +475,102 @@ func (s *Store) UpsertWorksheetOrganizer(ctx context.Context, patch *WorksheetOr
return &worksheetOrganizer, nil
}
-func GetListSheetFilter(ctx context.Context, s *Store, caller string, filter string) (*qb.Query, error) {
+// BatchUpdateWorksheetOrganizer updates worksheet organizer payload fields in batch.
+func (s *Store) BatchUpdateWorksheetOrganizer(ctx context.Context, patch *BatchUpdateWorksheetOrganizerPatch) ([]*WorksheetOrganizerMessage, error) {
+ if len(patch.WorksheetResourceIDs) == 0 {
+ return nil, nil
+ }
+ if patch.Principal == "" {
+ return nil, errors.New("principal is empty")
+ }
+ if patch.Starred == nil && patch.Folders == nil {
+ return nil, errors.New("empty worksheet organizer patch")
+ }
+
+ tx, err := s.GetDB().BeginTx(ctx, nil)
+ if err != nil {
+ return nil, errors.Wrap(err, "failed to begin transaction")
+ }
+ defer tx.Rollback()
+
+ insertQuery, insertArgs, err := qb.Q().Space(`
+ INSERT INTO worksheet_organizer (
+ worksheet,
+ principal,
+ payload
+ )
+ SELECT worksheet.resource_id, ?, '{}'::jsonb
+ FROM worksheet
+ WHERE worksheet.resource_id = ANY(?)
+ ON CONFLICT (worksheet, principal) DO NOTHING
+ `, patch.Principal, patch.WorksheetResourceIDs).ToSQL()
+ if err != nil {
+ return nil, errors.Wrap(err, "failed to build worksheet organizer insert query")
+ }
+ if _, err := tx.ExecContext(ctx, insertQuery, insertArgs...); err != nil {
+ return nil, errors.Wrap(err, "failed to insert missing worksheet organizers")
+ }
+
+ payloadExpr := "payload"
+ var updateArgs []any
+ if patch.Starred != nil {
+ payloadExpr = fmt.Sprintf("jsonb_set(%s, '{starred}', to_jsonb(?::boolean), true)", payloadExpr)
+ updateArgs = append(updateArgs, *patch.Starred)
+ }
+ if patch.Folders != nil {
+ folderBytes, err := json.Marshal(*patch.Folders)
+ if err != nil {
+ return nil, errors.Wrap(err, "failed to marshal folders")
+ }
+ payloadExpr = fmt.Sprintf("jsonb_set(%s, '{folders}', ?::jsonb, true)", payloadExpr)
+ updateArgs = append(updateArgs, string(folderBytes))
+ }
+ updateArgs = append(updateArgs, patch.Principal, patch.WorksheetResourceIDs)
+
+ updateQuery, args, err := qb.Q().Space(fmt.Sprintf(`
+ UPDATE worksheet_organizer
+ SET payload = %s
+ WHERE principal = ? AND worksheet = ANY(?)
+ RETURNING worksheet, principal, payload
+ `, payloadExpr), updateArgs...).ToSQL()
+ if err != nil {
+ return nil, errors.Wrap(err, "failed to build worksheet organizer update query")
+ }
+ rows, err := tx.QueryContext(ctx, updateQuery, args...)
+ if err != nil {
+ return nil, errors.Wrap(err, "failed to update worksheet organizers")
+ }
+ defer rows.Close()
+
+ var worksheetOrganizers []*WorksheetOrganizerMessage
+ for rows.Next() {
+ var worksheetOrganizer WorksheetOrganizerMessage
+ var payload []byte
+ if err := rows.Scan(
+ &worksheetOrganizer.WorksheetResourceID,
+ &worksheetOrganizer.Principal,
+ &payload,
+ ); err != nil {
+ return nil, err
+ }
+ workSheetPayload := &storepb.WorkSheetOrganizerPayload{}
+ if err := common.ProtojsonUnmarshaler.Unmarshal(payload, workSheetPayload); err != nil {
+ return nil, err
+ }
+ worksheetOrganizer.Payload = workSheetPayload
+ worksheetOrganizers = append(worksheetOrganizers, &worksheetOrganizer)
+ }
+ if err := rows.Err(); err != nil {
+ return nil, err
+ }
+
+ if err := tx.Commit(); err != nil {
+ return nil, errors.Wrap(err, "failed to commit transaction")
+ }
+ return worksheetOrganizers, nil
+}
+
+func GetListSheetFilter(ctx context.Context, s *Store, caller string, filter string, allowTitleContains bool) (*qb.Query, error) {
if filter == "" {
return nil, nil
}
@@ -417,9 +600,26 @@ func GetListSheetFilter(ctx context.Context, s *Store, caller string, filter str
}
return user.Email, nil
}
+ getWorksheetID := func(name string) (string, error) {
+ _, worksheetID, err := common.GetProjectIDWorksheetID(name)
+ if err != nil {
+ return "", errors.Errorf("invalid worksheet name %q", name)
+ }
+ return worksheetID, nil
+ }
parseToSQL := func(variable, value any) (*qb.Query, error) {
switch variable {
+ case "name":
+ name, ok := value.(string)
+ if !ok {
+ return nil, errors.Errorf("invalid name value %q", value)
+ }
+ worksheetID, err := getWorksheetID(name)
+ if err != nil {
+ return nil, err
+ }
+ return qb.Q().Space("worksheet.resource_id = ?", worksheetID), nil
case "creator":
userID, err := getUserID(value.(string))
if err != nil {
@@ -434,6 +634,25 @@ func GetListSheetFilter(ctx context.Context, s *Store, caller string, filter str
case "visibility":
visibility := WorkSheetVisibility(value.(string))
return qb.Q().Space("worksheet.visibility = ?", visibility), nil
+ case "folder":
+ folder, ok := value.(string)
+ if !ok {
+ return nil, errors.Errorf("invalid folder value %q", value)
+ }
+ folder = strings.Trim(folder, "/")
+ if folder == "" {
+ return qb.Q().Space("COALESCE(jsonb_array_length(worksheet_organizer.payload->'folders'), 0) = 0"), nil
+ }
+ q := qb.Q()
+ segments := strings.Split(folder, "/")
+ for i, segment := range segments {
+ if segment == "" {
+ return nil, errors.Errorf("invalid folder %q", value)
+ }
+ q.And(fmt.Sprintf("worksheet_organizer.payload->'folders'->>%d = ?", i), segment)
+ }
+ q.And("jsonb_array_length(worksheet_organizer.payload->'folders') = ?", len(segments))
+ return qb.Q().Space("(?)", q), nil
default:
return nil, errors.Errorf("unsupport variable %q", variable)
}
@@ -466,6 +685,30 @@ func GetListSheetFilter(ctx context.Context, s *Store, caller string, filter str
case celoperators.Equals:
variable, value := getVariableAndValueFromExpr(expr)
return parseToSQL(variable, value)
+ case celoverloads.Contains:
+ variable := expr.AsCall().Target().AsIdent()
+ args := expr.AsCall().Args()
+ if len(args) != 1 {
+ return nil, errors.Errorf(`invalid args for %q`, variable)
+ }
+ value := args[0].AsLiteral().Value()
+ strValue, ok := value.(string)
+ if !ok {
+ return nil, errors.Errorf("expect string, got %T, hint: filter literals should be string", value)
+ }
+ if strValue == "" {
+ return nil, errors.Errorf(`empty value for %q`, variable)
+ }
+
+ switch variable {
+ case "title":
+ if !allowTitleContains {
+ return nil, errors.Errorf("unsupport variable %q", variable)
+ }
+ return qb.Q().Space("LOWER(worksheet.name) LIKE ? ESCAPE '\\'", "%"+escapeLikePattern(strings.ToLower(strValue))+"%"), nil
+ default:
+ return nil, errors.Errorf("unsupport variable %q", variable)
+ }
case celoperators.NotEquals:
variable, value := getVariableAndValueFromExpr(expr)
if variable != "creator" {
@@ -478,21 +721,41 @@ func GetListSheetFilter(ctx context.Context, s *Store, caller string, filter str
return qb.Q().Space("worksheet.creator != ?", userID), nil
case celoperators.In:
variable, value := getVariableAndValueFromExpr(expr)
- if variable != "visibility" {
- return nil, errors.Errorf(`only "visibility" support "visibility in [xx]" filter`)
- }
rawList, ok := value.([]any)
if !ok {
- return nil, errors.Errorf("invalid visibility value %q", value)
+ return nil, errors.Errorf("invalid %s value %q", variable, value)
}
if len(rawList) == 0 {
- return nil, errors.New("empty visibility filter")
+ return nil, errors.Errorf("empty %s filter", variable)
}
- visibilityList := []string{}
- for _, raw := range rawList {
- visibilityList = append(visibilityList, raw.(string))
+ switch variable {
+ case "name":
+ worksheetIDs := []string{}
+ for _, raw := range rawList {
+ name, ok := raw.(string)
+ if !ok {
+ return nil, errors.Errorf("invalid name value %q", raw)
+ }
+ worksheetID, err := getWorksheetID(name)
+ if err != nil {
+ return nil, err
+ }
+ worksheetIDs = append(worksheetIDs, worksheetID)
+ }
+ return qb.Q().Space("worksheet.resource_id = ANY(?)", worksheetIDs), nil
+ case "visibility":
+ visibilityList := []string{}
+ for _, raw := range rawList {
+ visibility, ok := raw.(string)
+ if !ok {
+ return nil, errors.Errorf("invalid visibility value %q", raw)
+ }
+ visibilityList = append(visibilityList, visibility)
+ }
+ return qb.Q().Space("worksheet.visibility = ANY(?)", visibilityList), nil
+ default:
+ return nil, errors.Errorf(`only "name" and "visibility" support "in" filter`)
}
- return qb.Q().Space("worksheet.visibility = ANY(?)", visibilityList), nil
default:
return nil, errors.Errorf("unexpected function %v", functionName)
}
@@ -508,6 +771,14 @@ func GetListSheetFilter(ctx context.Context, s *Store, caller string, filter str
return qb.Q().Space("(?)", q), nil
}
+func escapeLikePattern(pattern string) string {
+ return strings.NewReplacer(
+ `\`, `\\`,
+ `%`, `\%`,
+ `_`, `\_`,
+ ).Replace(pattern)
+}
+
func GetListWorksheetFilter(filter string) (*qb.Query, error) {
if filter == "" {
return nil, nil
diff --git a/backend/tests/tests.go b/backend/tests/tests.go
index 594c159141..546edaee5d 100644
--- a/backend/tests/tests.go
+++ b/backend/tests/tests.go
@@ -102,6 +102,7 @@ type controller struct {
databaseServiceClient v1connect.DatabaseServiceClient
databaseCatalogServiceClient v1connect.DatabaseCatalogServiceClient
sheetServiceClient v1connect.SheetServiceClient
+ worksheetServiceClient v1connect.WorksheetServiceClient
sqlServiceClient v1connect.SQLServiceClient
queryHistoryServiceClient v1connect.QueryHistoryServiceClient
subscriptionServiceClient v1connect.SubscriptionServiceClient
@@ -114,7 +115,6 @@ type controller struct {
serviceAccountServiceClient v1connect.ServiceAccountServiceClient
workloadIdentityServiceClient v1connect.WorkloadIdentityServiceClient
accessGrantServiceClient v1connect.AccessGrantServiceClient
- worksheetServiceClient v1connect.WorksheetServiceClient
project *v1pb.Project
@@ -296,6 +296,7 @@ func (ctl *controller) start(ctx context.Context, port int) (context.Context, er
ctl.databaseServiceClient = v1connect.NewDatabaseServiceClient(ctl.client, baseURL, interceptors)
ctl.databaseCatalogServiceClient = v1connect.NewDatabaseCatalogServiceClient(ctl.client, baseURL, interceptors)
ctl.sheetServiceClient = v1connect.NewSheetServiceClient(ctl.client, baseURL, interceptors)
+ ctl.worksheetServiceClient = v1connect.NewWorksheetServiceClient(ctl.client, baseURL, interceptors)
ctl.sqlServiceClient = v1connect.NewSQLServiceClient(ctl.client, baseURL, interceptors)
ctl.queryHistoryServiceClient = v1connect.NewQueryHistoryServiceClient(ctl.client, baseURL, interceptors)
ctl.subscriptionServiceClient = v1connect.NewSubscriptionServiceClient(ctl.client, baseURL, interceptors)
@@ -308,7 +309,6 @@ func (ctl *controller) start(ctx context.Context, port int) (context.Context, er
ctl.serviceAccountServiceClient = v1connect.NewServiceAccountServiceClient(ctl.client, baseURL, interceptors)
ctl.workloadIdentityServiceClient = v1connect.NewWorkloadIdentityServiceClient(ctl.client, baseURL, interceptors)
ctl.accessGrantServiceClient = v1connect.NewAccessGrantServiceClient(ctl.client, baseURL, interceptors)
- ctl.worksheetServiceClient = v1connect.NewWorksheetServiceClient(ctl.client, baseURL, interceptors)
if err := ctl.waitForHealthz(ctx); err != nil {
return nil, errors.Wrap(err, "failed to wait for healthz")
diff --git a/backend/tests/worksheet_test.go b/backend/tests/worksheet_test.go
index 3c8e0f12f2..24921153e1 100644
--- a/backend/tests/worksheet_test.go
+++ b/backend/tests/worksheet_test.go
@@ -2,12 +2,15 @@ package tests
import (
"context"
+ "database/sql"
"fmt"
"testing"
"connectrpc.com/connect"
"github.com/stretchr/testify/require"
+ "google.golang.org/protobuf/types/known/fieldmaskpb"
+ "github.com/bytebase/bytebase/backend/common"
v1pb "github.com/bytebase/bytebase/backend/generated-go/v1"
)
@@ -141,6 +144,384 @@ func TestListWorksheets(t *testing.T) {
a.Equal(connect.CodeInvalidArgument, connect.CodeOf(err))
}
+func TestSearchWorksheetsFilterByFolder(t *testing.T) {
+ t.Parallel()
+ a := require.New(t)
+ ctx := context.Background()
+ ctl := &controller{}
+ ctx, err := ctl.StartServerWithExternalPg(ctx)
+ a.NoError(err)
+ defer ctl.Close(ctx)
+
+ createWorksheet := func(title string) *v1pb.Worksheet {
+ resp, err := ctl.worksheetServiceClient.CreateWorksheet(ctx, connect.NewRequest(&v1pb.CreateWorksheetRequest{
+ Parent: ctl.project.Name,
+ Worksheet: &v1pb.Worksheet{
+ Title: title,
+ Content: []byte("SELECT 1;"),
+ Visibility: v1pb.Worksheet_PRIVATE,
+ },
+ }))
+ a.NoError(err)
+ return resp.Msg
+ }
+ setFolders := func(worksheet *v1pb.Worksheet, folders []string) {
+ _, err := ctl.worksheetServiceClient.UpdateWorksheetOrganizer(ctx, connect.NewRequest(&v1pb.UpdateWorksheetOrganizerRequest{
+ Organizer: &v1pb.WorksheetOrganizer{
+ Worksheet: worksheet.Name,
+ Folders: folders,
+ },
+ UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"folders"}},
+ }))
+ a.NoError(err)
+ }
+
+ alphaWorksheet := createWorksheet("alpha")
+ setFolders(alphaWorksheet, []string{"alpha"})
+ alphaChildWorksheet := createWorksheet("alpha-child")
+ setFolders(alphaChildWorksheet, []string{"alpha", "beta"})
+ alphabetWorksheet := createWorksheet("alphabet")
+ setFolders(alphabetWorksheet, []string{"alphabet"})
+ nestedAlphaWorksheet := createWorksheet("nested-alpha")
+ setFolders(nestedAlphaWorksheet, []string{"gamma", "alpha"})
+ rootWorksheet := createWorksheet("root")
+
+ resp, err := ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
+ Parent: ctl.project.Name,
+ Filter: `folder == "alpha"`,
+ }))
+ a.NoError(err)
+ a.ElementsMatch(
+ []string{alphaWorksheet.Name},
+ worksheetNames(resp.Msg.Worksheets),
+ )
+ a.NotContains(worksheetNames(resp.Msg.Worksheets), alphaChildWorksheet.Name)
+ a.NotContains(worksheetNames(resp.Msg.Worksheets), alphabetWorksheet.Name)
+ a.NotContains(worksheetNames(resp.Msg.Worksheets), nestedAlphaWorksheet.Name)
+ a.NotContains(worksheetNames(resp.Msg.Worksheets), rootWorksheet.Name)
+
+ childResp, err := ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
+ Parent: ctl.project.Name,
+ Filter: `folder == "alpha/beta"`,
+ }))
+ a.NoError(err)
+ a.ElementsMatch([]string{alphaChildWorksheet.Name}, worksheetNames(childResp.Msg.Worksheets))
+
+ rootResp, err := ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
+ Parent: ctl.project.Name,
+ Filter: `folder == ""`,
+ }))
+ a.NoError(err)
+ a.ElementsMatch([]string{rootWorksheet.Name}, worksheetNames(rootResp.Msg.Worksheets))
+
+ pageFirstWorksheet := createWorksheet("aaa-page")
+ setFolders(pageFirstWorksheet, []string{"paging"})
+ pageSecondWorksheet := createWorksheet("zzz-page")
+ setFolders(pageSecondWorksheet, []string{"paging"})
+
+ firstPageResp, err := ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
+ Parent: ctl.project.Name,
+ Filter: `folder == "paging"`,
+ PageSize: 1,
+ }))
+ a.NoError(err)
+ a.Equal([]string{pageFirstWorksheet.Name}, worksheetNames(firstPageResp.Msg.Worksheets))
+ a.NotEmpty(firstPageResp.Msg.NextPageToken)
+
+ secondPageResp, err := ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
+ Parent: ctl.project.Name,
+ Filter: `folder == "paging"`,
+ PageSize: 1,
+ PageToken: firstPageResp.Msg.NextPageToken,
+ }))
+ a.NoError(err)
+ a.Equal([]string{pageSecondWorksheet.Name}, worksheetNames(secondPageResp.Msg.Worksheets))
+}
+
+func TestSearchWorksheetsFilterByTitle(t *testing.T) {
+ t.Parallel()
+ a := require.New(t)
+ ctx := context.Background()
+ ctl := &controller{}
+ ctx, err := ctl.StartServerWithExternalPg(ctx)
+ a.NoError(err)
+ defer ctl.Close(ctx)
+
+ createWorksheet := func(title string) *v1pb.Worksheet {
+ resp, err := ctl.worksheetServiceClient.CreateWorksheet(ctx, connect.NewRequest(&v1pb.CreateWorksheetRequest{
+ Parent: ctl.project.Name,
+ Worksheet: &v1pb.Worksheet{
+ Title: title,
+ Content: []byte("SELECT 1;"),
+ Visibility: v1pb.Worksheet_PRIVATE,
+ },
+ }))
+ a.NoError(err)
+ return resp.Msg
+ }
+
+ matchedWorksheet := createWorksheet("Production Payroll Report")
+ unmatchedWorksheet := createWorksheet("Development Scratchpad")
+ percentWorksheet := createWorksheet("Literal 100% match")
+ underscoreWorksheet := createWorksheet("Literal under_score match")
+
+ resp, err := ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
+ Parent: ctl.project.Name,
+ Filter: `title.contains("payroll")`,
+ }))
+ a.NoError(err)
+ a.Equal([]string{matchedWorksheet.Name}, worksheetNames(resp.Msg.Worksheets))
+ a.NotContains(worksheetNames(resp.Msg.Worksheets), unmatchedWorksheet.Name)
+
+ percentResp, err := ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
+ Parent: ctl.project.Name,
+ Filter: `title.contains("%")`,
+ }))
+ a.NoError(err)
+ a.Equal([]string{percentWorksheet.Name}, worksheetNames(percentResp.Msg.Worksheets))
+
+ underscoreResp, err := ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
+ Parent: ctl.project.Name,
+ Filter: `title.contains("_")`,
+ }))
+ a.NoError(err)
+ a.Equal([]string{underscoreWorksheet.Name}, worksheetNames(underscoreResp.Msg.Worksheets))
+
+ _, err = ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
+ Parent: ctl.project.Name,
+ Filter: `content.contains("SELECT")`,
+ }))
+ a.Error(err)
+}
+
+func TestBatchUpdateWorksheetOrganizerFilterByFolder(t *testing.T) {
+ t.Parallel()
+ a := require.New(t)
+ ctx := context.Background()
+ ctl := &controller{}
+ ctx, err := ctl.StartServerWithExternalPg(ctx)
+ a.NoError(err)
+ defer ctl.Close(ctx)
+
+ createWorksheet := func(title string) *v1pb.Worksheet {
+ resp, err := ctl.worksheetServiceClient.CreateWorksheet(ctx, connect.NewRequest(&v1pb.CreateWorksheetRequest{
+ Parent: ctl.project.Name,
+ Worksheet: &v1pb.Worksheet{
+ Title: title,
+ Content: []byte("SELECT 1;"),
+ Visibility: v1pb.Worksheet_PRIVATE,
+ },
+ }))
+ a.NoError(err)
+ return resp.Msg
+ }
+ setFolders := func(worksheet *v1pb.Worksheet, folders []string) {
+ _, err := ctl.worksheetServiceClient.UpdateWorksheetOrganizer(ctx, connect.NewRequest(&v1pb.UpdateWorksheetOrganizerRequest{
+ Organizer: &v1pb.WorksheetOrganizer{
+ Worksheet: worksheet.Name,
+ Folders: folders,
+ },
+ UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"folders"}},
+ }))
+ a.NoError(err)
+ }
+ searchByFolder := func(folder string) []string {
+ resp, err := ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
+ Parent: ctl.project.Name,
+ Filter: fmt.Sprintf("folder == %q", folder),
+ }))
+ a.NoError(err)
+ return worksheetNames(resp.Msg.Worksheets)
+ }
+
+ directWorksheet := createWorksheet("old-direct")
+ setFolders(directWorksheet, []string{"old"})
+ childWorksheet := createWorksheet("old-child")
+ setFolders(childWorksheet, []string{"old", "child"})
+ otherWorksheet := createWorksheet("other")
+ setFolders(otherWorksheet, []string{"other"})
+
+ directResp, err := ctl.worksheetServiceClient.BatchUpdateWorksheetOrganizer(ctx, connect.NewRequest(&v1pb.BatchUpdateWorksheetOrganizerRequest{
+ Parent: ctl.project.Name,
+ Filter: `folder == "old"`,
+ Organizer: &v1pb.WorksheetOrganizer{
+ Folders: []string{"new"},
+ },
+ UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"folders"}},
+ }))
+ a.NoError(err)
+ a.Equal(int32(1), directResp.Msg.UpdatedCount)
+
+ childResp, err := ctl.worksheetServiceClient.BatchUpdateWorksheetOrganizer(ctx, connect.NewRequest(&v1pb.BatchUpdateWorksheetOrganizerRequest{
+ Parent: ctl.project.Name,
+ Filter: `folder == "old/child"`,
+ Organizer: &v1pb.WorksheetOrganizer{
+ Folders: []string{"new", "child"},
+ },
+ UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"folders"}},
+ }))
+ a.NoError(err)
+ a.Equal(int32(1), childResp.Msg.UpdatedCount)
+
+ a.ElementsMatch([]string{directWorksheet.Name}, searchByFolder("new"))
+ a.ElementsMatch([]string{childWorksheet.Name}, searchByFolder("new/child"))
+ a.ElementsMatch([]string{otherWorksheet.Name}, searchByFolder("other"))
+ a.Empty(searchByFolder("old"))
+ a.Empty(searchByFolder("old/child"))
+
+ starResp, err := ctl.worksheetServiceClient.BatchUpdateWorksheetOrganizer(ctx, connect.NewRequest(&v1pb.BatchUpdateWorksheetOrganizerRequest{
+ Parent: ctl.project.Name,
+ Filter: `folder == "new"`,
+ Organizer: &v1pb.WorksheetOrganizer{
+ Starred: true,
+ },
+ UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"starred"}},
+ }))
+ a.NoError(err)
+ a.Equal(int32(1), starResp.Msg.UpdatedCount)
+ starredResp, err := ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
+ Parent: ctl.project.Name,
+ Filter: `folder == "new" && starred == true`,
+ }))
+ a.NoError(err)
+ a.ElementsMatch([]string{directWorksheet.Name}, worksheetNames(starredResp.Msg.Worksheets))
+
+ nameResp, err := ctl.worksheetServiceClient.BatchUpdateWorksheetOrganizer(ctx, connect.NewRequest(&v1pb.BatchUpdateWorksheetOrganizerRequest{
+ Parent: ctl.project.Name,
+ Filter: fmt.Sprintf(`name in [%q,%q]`, directWorksheet.Name, childWorksheet.Name),
+ Organizer: &v1pb.WorksheetOrganizer{
+ Folders: []string{"selected"},
+ },
+ UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"folders"}},
+ }))
+ a.NoError(err)
+ a.Equal(int32(2), nameResp.Msg.UpdatedCount)
+ a.ElementsMatch([]string{directWorksheet.Name, childWorksheet.Name}, searchByFolder("selected"))
+ a.ElementsMatch([]string{otherWorksheet.Name}, searchByFolder("other"))
+}
+
+func TestListWorksheetFoldersReturnsCallerFolders(t *testing.T) {
+ t.Parallel()
+ a := require.New(t)
+ ctx := context.Background()
+ ctl := &controller{}
+ ctx, err := ctl.StartServerWithExternalPg(ctx)
+ a.NoError(err)
+ defer ctl.Close(ctx)
+
+ ownerToken := ctl.authInterceptor.token
+
+ createWorksheet := func(title string, visibility v1pb.Worksheet_Visibility) *v1pb.Worksheet {
+ resp, err := ctl.worksheetServiceClient.CreateWorksheet(ctx, connect.NewRequest(&v1pb.CreateWorksheetRequest{
+ Parent: ctl.project.Name,
+ Worksheet: &v1pb.Worksheet{
+ Title: title,
+ Content: []byte("SELECT 1;"),
+ Visibility: visibility,
+ },
+ }))
+ a.NoError(err)
+ return resp.Msg
+ }
+ setFolders := func(worksheet *v1pb.Worksheet, folders []string) {
+ _, err := ctl.worksheetServiceClient.UpdateWorksheetOrganizer(ctx, connect.NewRequest(&v1pb.UpdateWorksheetOrganizerRequest{
+ Organizer: &v1pb.WorksheetOrganizer{
+ Worksheet: worksheet.Name,
+ Folders: folders,
+ },
+ UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"folders"}},
+ }))
+ a.NoError(err)
+ }
+
+ ownerWorksheet := createWorksheet("owner", v1pb.Worksheet_PRIVATE)
+ setFolders(ownerWorksheet, []string{"owner", "child"})
+ ownerSharedWorksheet := createWorksheet("owner-shared", v1pb.Worksheet_PROJECT_READ)
+ setFolders(ownerSharedWorksheet, []string{"owner-shared"})
+
+ otherEmail := fmt.Sprintf("worksheet-folder-%[email protected]", generateRandomString("user"))
+ otherPassword := "1024bytebase"
+ otherUser, err := ctl.userServiceClient.CreateUser(ctx, connect.NewRequest(&v1pb.CreateUserRequest{
+ User: &v1pb.User{
+ Email: otherEmail,
+ Password: otherPassword,
+ Title: "Worksheet Folder User",
+ },
+ }))
+ a.NoError(err)
+ _, err = ctl.addMemberToWorkspaceIAM(ctx, otherUser.Msg.Workspace, fmt.Sprintf("user:%s", otherEmail), "roles/workspaceMember")
+ a.NoError(err)
+ policyResp, err := ctl.projectServiceClient.GetIamPolicy(ctx, connect.NewRequest(&v1pb.GetIamPolicyRequest{
+ Resource: ctl.project.Name,
+ }))
+ a.NoError(err)
+ policy := policyResp.Msg
+ policy.Bindings = append(policy.Bindings, &v1pb.Binding{
+ Role: "roles/sqlEditorUser",
+ Members: []string{fmt.Sprintf("user:%s", otherEmail)},
+ })
+ _, err = ctl.projectServiceClient.SetIamPolicy(ctx, connect.NewRequest(&v1pb.SetIamPolicyRequest{
+ Resource: ctl.project.Name,
+ Policy: policy,
+ }))
+ a.NoError(err)
+
+ loginResp, err := ctl.authServiceClient.Login(ctx, connect.NewRequest(&v1pb.LoginRequest{
+ Email: otherEmail,
+ Password: otherPassword,
+ }))
+ a.NoError(err)
+ ctl.authInterceptor.token = loginResp.Msg.Token
+ sharedWorksheet := createWorksheet("shared", v1pb.Worksheet_PROJECT_READ)
+ setFolders(sharedWorksheet, []string{"other", "shared"})
+ privateWorksheet := createWorksheet("private", v1pb.Worksheet_PRIVATE)
+
+ ctl.authInterceptor.token = ownerToken
+ setFolders(sharedWorksheet, []string{"owner", "child"})
+
+ db, err := sql.Open("pgx", ctl.profile.PgURL)
+ a.NoError(err)
+ defer db.Close()
+ _, privateWorksheetID, err := common.GetProjectIDWorksheetID(privateWorksheet.Name)
+ a.NoError(err)
+ _, err = db.ExecContext(ctx, `
+ INSERT INTO worksheet_organizer (worksheet, principal, payload)
+ SELECT resource_id, $1, '{"folders":["private"]}'::jsonb
+ FROM worksheet
+ WHERE resource_id = $2
+ `, "[email protected]", privateWorksheetID)
+ a.NoError(err)
+
+ resp, err := ctl.worksheetServiceClient.ListWorksheetFolders(ctx, connect.NewRequest(&v1pb.ListWorksheetFoldersRequest{
+ Parent: ctl.project.Name,
+ }))
+ a.NoError(err)
+ a.ElementsMatch([]string{
+ "MINE:[owner]",
+ "MINE:[owner child]",
+ "MINE:[owner-shared]",
+ "SHARED:[owner]",
+ "SHARED:[owner child]",
+ "SHARED:[private]",
+ }, worksheetFolderEntries(resp.Msg.Folders))
+}
+
+func TestSearchWorksheetsRejectsWildcardProject(t *testing.T) {
+ t.Parallel()
+ a := require.New(t)
+ ctx := context.Background()
+ ctl := &controller{}
+ ctx, err := ctl.StartServerWithExternalPg(ctx)
+ a.NoError(err)
+ defer ctl.Close(ctx)
+
+ _, err = ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
+ Parent: "projects/-",
+ }))
+ a.Error(err)
+ a.Equal(connect.CodeInvalidArgument, connect.CodeOf(err))
+}
+
func worksheetNames(worksheets []*v1pb.Worksheet) []string {
names := make([]string, 0, len(worksheets))
for _, worksheet := range worksheets {
@@ -148,3 +529,11 @@ func worksheetNames(worksheets []*v1pb.Worksheet) []string {
}
return names
}
+
+func worksheetFolderEntries(folders []*v1pb.WorksheetFolder) []string {
+ entries := make([]string, 0, len(folders))
+ for _, folder := range folders {
+ entries = append(entries, fmt.Sprintf("%s:%v", folder.Category, folder.Folders))
+ }
+ return entries
+}
diff --git a/frontend/src/modules/sql-editor/components/FolderForm.test.tsx b/frontend/src/modules/sql-editor/components/FolderForm.test.tsx
index 6e2777b1de..4c13dd850e 100644
--- a/frontend/src/modules/sql-editor/components/FolderForm.test.tsx
+++ b/frontend/src/modules/sql-editor/components/FolderForm.test.tsx
@@ -158,6 +158,15 @@ const makeFolderNode = (
empty: children.length === 0,
});
+const makeLoadMoreNode = (key: string): WorksheetFolderNode => ({
+ key,
+ label: "Load more",
+ editable: false,
+ isLeaf: true,
+ loadMore: true,
+ children: [],
+});
+
const setupDefaultMocks = () => {
mocks.useTranslation.mockReturnValue({ t: (key: string) => key });
mocks.useClickOutside.mockImplementation(() => undefined);
@@ -274,6 +283,36 @@ describe("FolderForm", () => {
unmount();
});
+ test("does not show load-more nodes in the folder picker", () => {
+ const rootNode = makeFolderNode("/my", [
+ makeFolderNode("/my/foo"),
+ makeLoadMoreNode("/my/__load-more"),
+ ]);
+ mocks.useSheetContextByView.mockReturnValue({
+ folderTree: rootNode,
+ folderContext: {
+ rootPath: "/my",
+ },
+ });
+
+ const { container, render, unmount } = renderIntoContainer(
+ <FolderForm folder="/my" onFolderChange={vi.fn()} />
+ );
+ render();
+
+ const input = container.querySelector(
+ "[data-testid='folder-input']"
+ ) as HTMLInputElement;
+ act(() => {
+ input.dispatchEvent(new FocusEvent("focusin", { bubbles: true }));
+ });
+
+ expect(document.body.textContent).toContain("foo");
+ expect(document.body.textContent).not.toContain("Load more");
+
+ unmount();
+ });
+
test("typing in input normalizes path and calls onFolderChange", () => {
const onFolderChange = vi.fn();
const { container, render, unmount } = renderIntoContainer(
diff --git a/frontend/src/modules/sql-editor/components/FolderForm.tsx b/frontend/src/modules/sql-editor/components/FolderForm.tsx
index 9cf3af5357..863ebe0ec1 100644
--- a/frontend/src/modules/sql-editor/components/FolderForm.tsx
+++ b/frontend/src/modules/sql-editor/components/FolderForm.tsx
@@ -24,7 +24,7 @@ function toTreeData(
return {
id: node.key,
data: node,
- children: node.children.map(toTreeData),
+ children: node.children.filter((child) => !child.loadMore).map(toTreeData),
};
}
@@ -97,7 +97,9 @@ export function FolderForm({ folder, onFolderChange }: Props) {
queueMicrotask(() => setShowPopover(false));
};
- const treeData = folderTree.children.map(toTreeData);
+ const treeData = folderTree.children
+ .filter((child) => !child.loadMore)
+ .map(toTreeData);
const searchMatch = (node: TreeDataNode<WorksheetFolderNode>) => {
if (!folderPath) return true;
diff --git a/frontend/src/modules/sql-editor/components/SheetTree.test.tsx b/frontend/src/modules/sql-editor/components/SheetTree.test.tsx
index b5d833b0a1..603ca7bcea 100644
--- a/frontend/src/modules/sql-editor/components/SheetTree.test.tsx
+++ b/frontend/src/modules/sql-editor/components/SheetTree.test.tsx
@@ -1,5 +1,5 @@
import type { ReactElement } from "react";
-import { act } from "react";
+import { act, forwardRef } from "react";
import { createRoot } from "react-dom/client";
import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
import type { WorksheetFolderNode } from "@/modules/sql-editor/model/Sheet";
@@ -39,6 +39,11 @@ const mocks = vi.hoisted(() => ({
useDropdown: vi.fn(),
openWorksheetByName: vi.fn(),
pushNotification: vi.fn(),
+ treeProps: {} as {
+ disableDrag?: unknown;
+ disableDrop?: unknown;
+ onMove?: unknown;
+ },
}));
vi.mock("react-i18next", () => ({
@@ -130,10 +135,19 @@ vi.mock("@/components/ui/tree", () => ({
Tree: ({
data,
renderNode,
+ className,
+ disableDrag,
+ disableDrop,
+ onMove,
}: {
data: MockTreeItem[];
renderNode: (args: MockRenderArgs) => React.ReactNode;
+ className?: string;
+ disableDrag?: unknown;
+ disableDrop?: unknown;
+ onMove?: unknown;
}) => {
+ mocks.treeProps = { disableDrag, disableDrop, onMove };
const renderAll = (items: MockTreeItem[]): React.ReactNode[] =>
items.flatMap((item) => [
renderNode({
@@ -142,7 +156,11 @@ vi.mock("@/components/ui/tree", () => ({
}),
...(item.children ? renderAll(item.children) : []),
]);
- return <div data-testid="tree">{renderAll(data)}</div>;
+ return (
+ <div data-testid="tree" className={className}>
+ {renderAll(data)}
+ </div>
+ );
},
}));
@@ -211,11 +229,20 @@ vi.mock("@/components/ui/button", () => ({
Button: ({
children,
onClick,
+ disabled,
+ className,
}: {
children: React.ReactNode;
onClick?: () => void;
+ disabled?: boolean;
+ className?: string;
}) => (
- <button data-testid="button" onClick={onClick}>
+ <button
+ data-testid="button"
+ className={className}
+ disabled={disabled}
+ onClick={onClick}
+ >
{children}
</button>
),
@@ -223,29 +250,29 @@ vi.mock("@/components/ui/button", () => ({
// Mock Input
vi.mock("@/components/ui/input", () => ({
- Input: ({
- value,
- onChange,
- onBlur,
- onKeyDown,
- id,
- }: {
- value?: string;
- onChange?: (e: React.ChangeEvent<HTMLInputElement>) => void;
- onBlur?: () => void;
- onKeyDown?: (e: React.KeyboardEvent<HTMLInputElement>) => void;
- id?: string;
- }) => (
+ Input: forwardRef<
+ HTMLInputElement,
+ {
+ value?: string;
+ onChange?: (e: React.ChangeEvent<HTMLInputElement>) => void;
+ onBlur?: () => void;
+ onKeyDown?: (e: React.KeyboardEvent<HTMLInputElement>) => void;
+ id?: string;
+ className?: string;
+ }
+ >(({ value, onChange, onBlur, onKeyDown, id, className }, ref) => (
<input
+ ref={ref}
data-testid="rename-input"
id={id}
+ className={className}
value={value ?? ""}
onChange={onChange}
onBlur={onBlur}
onKeyDown={onKeyDown}
readOnly={!onChange}
/>
- ),
+ )),
}));
// Mock HighlightLabelText
@@ -351,6 +378,15 @@ const makeWorksheetNode = (
},
});
+const makeLoadMoreNode = (key: string): WorksheetFolderNode => ({
+ key,
+ label: "common.load-more",
+ editable: false,
+ isLeaf: true,
+ loadMore: true,
+ children: [],
+});
+
// The migrated `useSheetContext()` exposes `expandedKeys` / `selectedKeys`
// as plain values plus setters. We model the live state behind a `value`
// holder (so the existing per-test assertions like
@@ -378,6 +414,7 @@ const setupDefaultMocks = () => {
const folderContext = {
rootPath: "/my",
+ listSubFolders: vi.fn((_parent: string): string[] => []),
isSubFolder: vi.fn(() => false),
moveFolder: vi.fn(),
removeFolder: vi.fn(),
@@ -397,6 +434,7 @@ const setupDefaultMocks = () => {
return editingNode.value;
},
batchUpdateWorksheetFolders: vi.fn(),
+ batchUpdateWorksheetFolderPaths: vi.fn(),
setExpandedKeys: vi.fn(
(next: Set<string> | ((prev: Set<string>) => Set<string>)) => {
expandedKeys.value =
@@ -414,11 +452,17 @@ const setupDefaultMocks = () => {
const viewContext = {
isInitialized: true,
isLoading: false,
+ isFetchingNextPage: false,
+ hasMore: false,
+ hasMoreForFolder: vi.fn((_folderKey: string) => false),
get sheetTree() {
return viewContext._sheetTree.value;
},
_sheetTree: { value: rootNode } as { value: WorksheetFolderNode },
fetchSheetList: vi.fn(),
+ fetchNextPage: vi.fn(),
+ fetchWorksheetsByFolder: vi.fn(),
+ rebuildTree: vi.fn(),
folderContext,
getFoldersForWorksheet: vi.fn((path: string) => [path]),
events: {
@@ -469,6 +513,20 @@ const setupDefaultMocks = () => {
};
};
+test("keeps the initialized tree visible while refetching", () => {
+ const { viewContext } = setupDefaultMocks();
+ viewContext.isLoading = true;
+
+ const { container, render, unmount } = renderIntoContainer(
+ <SheetTree view="my" />
+ );
+ render();
+
+ expect(container.textContent).toContain("folder1");
+ expect(container.textContent).toContain("ws2");
+ unmount();
+});
+
const renderIntoContainer = (element: ReactElement) => {
const container = document.createElement("div");
const root = createRoot(container);
@@ -523,6 +581,7 @@ describe("SheetTree", () => {
// Tree primitive is rendered
const tree = document.body.querySelector("[data-testid='tree']");
expect(tree).not.toBeNull();
+ expect(tree?.className).toContain("[&_[role=treeitem]]:!min-w-0");
// HighlightLabelText nodes are rendered (root node + children)
const labels = container.querySelectorAll(
@@ -615,6 +674,64 @@ describe("SheetTree", () => {
unmount();
});
+ test("3b. Opening a locally nonempty folder still fetches its server members", () => {
+ const defaultMocks = setupDefaultMocks();
+ const folder = makeFolderNode("/my/folder1", [
+ makeWorksheetNode("/my/folder1/new-local-ws"),
+ ]);
+ const rootNode = makeFolderNode("/my", [folder]);
+ defaultMocks.viewContext._sheetTree.value = rootNode;
+ defaultMocks.expandedKeys.value = new Set(["/my"]);
+
+ const { container, render, unmount } = renderIntoContainer(
+ <SheetTree
+ view="my"
+ onMultiSelectModeChange={vi.fn()}
+ onCheckedNodesChange={vi.fn()}
+ />
+ );
+ render();
+
+ const row = container.querySelector(
+ `[data-item-key="/my/folder1"]`
+ ) as HTMLElement | null;
+ const prefix = row?.querySelector("[data-testid='tree-node-prefix']");
+ act(() => {
+ prefix?.dispatchEvent(new MouseEvent("click", { bubbles: true }));
+ });
+
+ expect(defaultMocks.viewContext.fetchWorksheetsByFolder).toHaveBeenCalledWith(
+ "/my/folder1"
+ );
+
+ unmount();
+ });
+
+ test("3c. Already expanded locally nonempty folders are fetched", () => {
+ const defaultMocks = setupDefaultMocks();
+ const folder = makeFolderNode("/my/folder1", [
+ makeWorksheetNode("/my/folder1/new-local-ws"),
+ ]);
+ const rootNode = makeFolderNode("/my", [folder]);
+ defaultMocks.viewContext._sheetTree.value = rootNode;
+ defaultMocks.expandedKeys.value = new Set(["/my", "/my/folder1"]);
+
+ const { render, unmount } = renderIntoContainer(
+ <SheetTree
+ view="my"
+ onMultiSelectModeChange={vi.fn()}
+ onCheckedNodesChange={vi.fn()}
+ />
+ );
+ render();
+
+ expect(defaultMocks.viewContext.fetchWorksheetsByFolder).toHaveBeenCalledWith(
+ "/my/folder1"
+ );
+
+ unmount();
+ });
+
test("4. Multi-select mode renders checkboxes; toggle fires onCheckedNodesChange", () => {
const defaultMocks = setupDefaultMocks();
const wsNode = makeWorksheetNode("/my/ws2");
@@ -657,6 +774,48 @@ describe("SheetTree", () => {
unmount();
});
+ test("4b. Multi-select folder selection skips load-more nodes", () => {
+ const defaultMocks = setupDefaultMocks();
+ const wsNode = makeWorksheetNode("/my/folder1/ws1");
+ const loadMoreNode = makeLoadMoreNode("/my/folder1/__load-more");
+ const folderNode = makeFolderNode(
+ "/my/folder1",
+ [wsNode, loadMoreNode],
+ true
+ );
+ defaultMocks.viewContext._sheetTree.value = makeFolderNode("/my", [
+ folderNode,
+ ]);
+
+ const onCheckedNodesChange = vi.fn();
+
+ const { container, render, unmount } = renderIntoContainer(
+ <SheetTree
+ view="my"
+ multiSelectMode={true}
+ checkedNodes={[]}
+ onMultiSelectModeChange={vi.fn()}
+ onCheckedNodesChange={onCheckedNodesChange}
+ />
+ );
+ render();
+
+ const row = container.querySelector(
+ `[data-item-key="/my/folder1"]`
+ ) as HTMLElement | null;
+ const checkbox = row?.querySelector("input[type='checkbox']");
+
+ act(() => {
+ checkbox?.dispatchEvent(new MouseEvent("click", { bubbles: true }));
+ });
+
+ expect(onCheckedNodesChange).toHaveBeenCalledWith(
+ expect.not.arrayContaining([loadMoreNode])
+ );
+
+ unmount();
+ });
+
test("5. Right-click → opens context menu with items", () => {
const defaultMocks = setupDefaultMocks();
const wsNode = makeWorksheetNode("/my/ws2");
@@ -771,4 +930,447 @@ describe("SheetTree", () => {
unmount();
});
+
+ test("7. Load more button fetches the next page", async () => {
+ const defaultMocks = setupDefaultMocks();
+ defaultMocks.viewContext._sheetTree.value = makeFolderNode("/my", [
+ {
+ key: "/my/__load-more",
+ label: "common.load-more",
+ editable: false,
+ isLeaf: true,
+ loadMore: true,
+ children: [],
+ },
+ ]);
+
+ const { container, render, unmount } = renderIntoContainer(
+ <SheetTree
+ view="my"
+ onMultiSelectModeChange={vi.fn()}
+ onCheckedNodesChange={vi.fn()}
+ />
+ );
+ render();
+
+ const loadMoreRow = container.querySelector(
+ `[data-item-key="/my/__load-more"]`
+ ) as HTMLElement | null;
+ expect(loadMoreRow).not.toBeNull();
+ const loadMoreWrapper = loadMoreRow?.querySelector(
+ "[data-testid='load-more-wrapper']"
+ );
+ const loadMoreButton = loadMoreRow?.querySelector("[data-testid='button']");
+ expect(loadMoreButton).not.toBeNull();
+ expect(loadMoreWrapper?.classList.contains("flex-1")).toBe(true);
+ expect(loadMoreWrapper?.classList.contains("text-left")).toBe(true);
+ expect(loadMoreButton?.classList.contains("tree-label")).toBe(true);
+ expect(loadMoreButton?.classList.contains("flex-1")).toBe(false);
+ expect(loadMoreButton?.classList.contains("text-accent")).toBe(true);
+ expect(loadMoreButton?.classList.contains("text-control")).toBe(false);
+ expect(loadMoreButton?.classList.contains("text-control-light")).toBe(false);
+ expect(loadMoreButton?.classList.contains("text-xs")).toBe(true);
+ expect(loadMoreButton?.classList.contains("cursor-pointer")).toBe(true);
+ expect(loadMoreButton?.textContent).toBe("···common.load-more");
+
+ await act(async () => {
+ loadMoreWrapper?.dispatchEvent(
+ new MouseEvent("click", { bubbles: true })
+ );
+ });
+ expect(defaultMocks.viewContext.fetchNextPage).not.toHaveBeenCalled();
+
+ await act(async () => {
+ loadMoreButton?.dispatchEvent(new MouseEvent("click", { bubbles: true }));
+ });
+
+ expect(defaultMocks.viewContext.fetchNextPage).toHaveBeenCalledWith(
+ undefined
+ );
+
+ unmount();
+ });
+
+ test("7b. Folder load more button fetches that folder's next page", async () => {
+ const defaultMocks = setupDefaultMocks();
+ const folder = makeFolderNode("/my/alpha", [
+ makeWorksheetNode("/my/alpha/ws1"),
+ {
+ key: "/my/alpha/__load-more",
+ label: "common.load-more",
+ editable: false,
+ isLeaf: true,
+ loadMore: true,
+ loadMoreFolderKey: "/my/alpha",
+ children: [],
+ },
+ ]);
+ defaultMocks.viewContext._sheetTree.value = makeFolderNode("/my", [folder]);
+ defaultMocks.expandedKeys.value = new Set(["/my", "/my/alpha"]);
+
+ const { container, render, unmount } = renderIntoContainer(
+ <SheetTree
+ view="my"
+ onMultiSelectModeChange={vi.fn()}
+ onCheckedNodesChange={vi.fn()}
+ />
+ );
+ render();
+
+ const loadMoreRow = container.querySelector(
+ `[data-item-key="/my/alpha/__load-more"]`
+ ) as HTMLElement | null;
+ expect(loadMoreRow).not.toBeNull();
+ const loadMoreWrapper = loadMoreRow?.querySelector(
+ "[data-testid='load-more-wrapper']"
+ );
+ const loadMoreButton = loadMoreRow?.querySelector("[data-testid='button']");
+ expect(loadMoreButton).not.toBeNull();
+ expect(loadMoreWrapper?.classList.contains("flex-1")).toBe(true);
+ expect(loadMoreWrapper?.classList.contains("text-left")).toBe(true);
+ expect(loadMoreButton?.classList.contains("tree-label")).toBe(true);
+ expect(loadMoreButton?.classList.contains("flex-1")).toBe(false);
+ expect(loadMoreButton?.classList.contains("text-accent")).toBe(true);
+ expect(loadMoreButton?.classList.contains("text-control")).toBe(false);
+ expect(loadMoreButton?.classList.contains("text-control-light")).toBe(false);
+ expect(loadMoreButton?.classList.contains("text-xs")).toBe(true);
+ expect(loadMoreButton?.classList.contains("cursor-pointer")).toBe(true);
+ expect(loadMoreButton?.textContent).toBe("···common.load-more");
+
+ await act(async () => {
+ loadMoreWrapper?.dispatchEvent(
+ new MouseEvent("click", { bubbles: true })
+ );
+ });
+ expect(defaultMocks.viewContext.fetchNextPage).not.toHaveBeenCalled();
+
+ await act(async () => {
+ loadMoreButton?.dispatchEvent(new MouseEvent("click", { bubbles: true }));
+ });
+
+ expect(defaultMocks.viewContext.fetchNextPage).toHaveBeenCalledWith(
+ "/my/alpha"
+ );
+
+ unmount();
+ });
+
+ test("7c. Load more rows are inert for tree actions", () => {
+ const defaultMocks = setupDefaultMocks();
+ const loadMoreNode = makeLoadMoreNode("/my/__load-more");
+ const folderNode = makeFolderNode("/my/folder", [], true);
+ defaultMocks.viewContext._sheetTree.value = makeFolderNode("/my", [
+ folderNode,
+ loadMoreNode,
+ ]);
+
+ const handleContextMenu = vi.fn();
+ mocks.useDropdown.mockReturnValue({
+ currentNode: undefined,
+ options: [],
+ worksheetEntity: undefined,
+ showSharePanel: false,
+ handleContextMenu,
+ handleSharePanelShow: vi.fn(),
+ handleClickOutside: vi.fn(),
+ });
+
+ const { container, render, unmount } = renderIntoContainer(
+ <SheetTree
+ view="my"
+ onMultiSelectModeChange={vi.fn()}
+ onCheckedNodesChange={vi.fn()}
+ />
+ );
+ render();
+
+ const loadMoreRow = container.querySelector(
+ `[data-item-key="/my/__load-more"]`
+ ) as HTMLElement | null;
+ expect(loadMoreRow).not.toBeNull();
+
+ act(() => {
+ loadMoreRow?.dispatchEvent(
+ new MouseEvent("contextmenu", { bubbles: true })
+ );
+ });
+ expect(handleContextMenu).not.toHaveBeenCalled();
+
+ const disableDrag = mocks.treeProps.disableDrag as
+ | ((data: { data: WorksheetFolderNode }) => boolean)
+ | undefined;
+ expect(disableDrag?.({ data: loadMoreNode })).toBe(true);
+ expect(disableDrag?.({ data: folderNode })).toBe(false);
+
+ const disableDrop = mocks.treeProps.disableDrop as
+ | ((args: {
+ parentNode?: { data: { data: WorksheetFolderNode } } | null;
+ dragNodes: { data: { data: WorksheetFolderNode } }[];
+ }) => boolean)
+ | undefined;
+ expect(
+ disableDrop?.({
+ parentNode: { data: { data: loadMoreNode } },
+ dragNodes: [{ data: { data: folderNode } }],
+ })
+ ).toBe(true);
+ expect(
+ disableDrop?.({
+ parentNode: { data: { data: folderNode } },
+ dragNodes: [{ data: { data: loadMoreNode } }],
+ })
+ ).toBe(true);
+
+ unmount();
+ });
+
+ test("7d. Add folder ignores load-more nodes when generating a name", async () => {
+ const defaultMocks = setupDefaultMocks();
+ const existingFolder = makeFolderNode("/my/new folder", [], true);
+ const loadMoreNode = makeLoadMoreNode("/my/__load-more");
+ const rootNode = makeFolderNode(
+ "/my",
+ [existingFolder, loadMoreNode],
+ true
+ );
+ defaultMocks.viewContext._sheetTree.value = rootNode;
+
+ mocks.useDropdown.mockReturnValue({
+ currentNode: rootNode,
+ options: [{ type: "item", key: "add-folder", label: "Add folder" }],
+ worksheetEntity: undefined,
+ showSharePanel: false,
+ handleContextMenu: vi.fn(),
+ handleSharePanelShow: vi.fn(),
+ handleClickOutside: vi.fn(),
+ });
+
+ const { container, render, unmount } = renderIntoContainer(
+ <SheetTree
+ view="my"
+ onMultiSelectModeChange={vi.fn()}
+ onCheckedNodesChange={vi.fn()}
+ />
+ );
+ render();
+
+ const addFolderItem = container.querySelector(
+ "[data-testid='dropdown-menu-item']"
+ ) as HTMLElement | null;
+
+ await act(async () => {
+ addFolderItem?.click();
+ });
+
+ expect(defaultMocks.viewContext.folderContext.addFolder).toHaveBeenCalledWith(
+ "/my/new folder2"
+ );
+ expect(defaultMocks.sheetContext.setEditingNode).toHaveBeenCalledWith(
+ expect.objectContaining({
+ rawLabel: "new folder2",
+ })
+ );
+
+ unmount();
+ });
+
+ test("8. Rename input is not clipped by display-mode row overflow", () => {
+ const defaultMocks = setupDefaultMocks();
+ const wsNode = makeWorksheetNode("/my/ws-with-long-title");
+ const rootNode = makeFolderNode("/my", [wsNode]);
+ defaultMocks.viewContext._sheetTree.value = rootNode;
+ defaultMocks.editingNode.value = {
+ node: wsNode,
+ rawLabel: "bytebase-3.12.2 May 9, 2026, 12:12:02 PM GMT+8",
+ };
+
+ const { container, render, unmount } = renderIntoContainer(
+ <SheetTree
+ view="my"
+ onMultiSelectModeChange={vi.fn()}
+ onCheckedNodesChange={vi.fn()}
+ />
+ );
+ render();
+
+ const input = container.querySelector(
+ "[data-testid='rename-input']"
+ ) as HTMLInputElement | null;
+ expect(input).not.toBeNull();
+ expect(input?.className).toContain("w-full");
+ expect(input?.className).toContain("h-6");
+
+ const label = input?.closest(".tree-label");
+ expect(label?.className).toContain("overflow-visible");
+
+ const row = input?.closest("[data-item-key='/my/ws-with-long-title']");
+ expect(row?.className).toContain("overflow-visible");
+ expect(row?.className).toContain("py-0");
+
+ const tree = container.querySelector("[data-testid='tree']");
+ expect(tree?.className).toContain(
+ "[&_[role=treeitem]]:overflow-visible"
+ );
+
+ unmount();
+ });
+
+ test("8b. Rename input preserves cursor position while typing", async () => {
+ const defaultMocks = setupDefaultMocks();
+ const folderNode = makeFolderNode("/my/folder1", [], true);
+ defaultMocks.viewContext._sheetTree.value = makeFolderNode("/my", [
+ folderNode,
+ ]);
+ defaultMocks.editingNode.value = {
+ node: folderNode,
+ rawLabel: "abcdef",
+ };
+
+ const { container, render, unmount } = renderIntoContainer(
+ <SheetTree
+ view="my"
+ onMultiSelectModeChange={vi.fn()}
+ onCheckedNodesChange={vi.fn()}
+ />
+ );
+ render();
+
+ const input = container.querySelector(
+ "[data-testid='rename-input']"
+ ) as HTMLInputElement | null;
+ expect(input).not.toBeNull();
+ input?.setSelectionRange(3, 3);
+
+ await act(async () => {
+ if (!input) return;
+ const valueSetter = Object.getOwnPropertyDescriptor(
+ HTMLInputElement.prototype,
+ "value"
+ )?.set;
+ valueSetter?.call(input, "abcXdef");
+ input.setSelectionRange(4, 4);
+ input.dispatchEvent(new Event("input", { bubbles: true }));
+ input.setSelectionRange(7, 7);
+ });
+ render();
+ await act(async () => {
+ await new Promise((resolve) => setTimeout(resolve, 0));
+ });
+
+ expect(input?.selectionStart).toBe(4);
+ expect(input?.selectionEnd).toBe(4);
+
+ unmount();
+ });
+
+ test("9. Folder rename updates known folder paths with exact batch filters", async () => {
+ const defaultMocks = setupDefaultMocks();
+ const childFolder = makeFolderNode("/my/old/child");
+ const oldFolder = makeFolderNode("/my/old", [childFolder]);
+ const rootNode = makeFolderNode("/my", [oldFolder]);
+ defaultMocks.viewContext._sheetTree.value = rootNode;
+ defaultMocks.editingNode.value = {
+ node: oldFolder,
+ rawLabel: "new",
+ };
+ defaultMocks.viewContext.getFoldersForWorksheet.mockImplementation(
+ (path: string) =>
+ path
+ .replace("/my", "")
+ .split("/")
+ .map((part) => part.trim())
+ .filter(Boolean)
+ );
+ defaultMocks.folderContext.listSubFolders.mockImplementation(
+ (parent: string) => (parent === "/my/old" ? ["/my/old/child"] : [])
+ );
+
+ const { container, render, unmount } = renderIntoContainer(
+ <SheetTree
+ view="my"
+ onMultiSelectModeChange={vi.fn()}
+ onCheckedNodesChange={vi.fn()}
+ />
+ );
+ render();
+
+ const input = container.querySelector(
+ "[data-testid='rename-input']"
+ ) as HTMLInputElement | null;
+ expect(input).not.toBeNull();
+
+ await act(async () => {
+ input?.dispatchEvent(new FocusEvent("focusout", { bubbles: true }));
+ await new Promise((resolve) => setTimeout(resolve, 10));
+ });
+
+ expect(
+ defaultMocks.sheetContext.batchUpdateWorksheetFolderPaths
+ ).toHaveBeenCalledWith("my", [
+ { sourceFolder: ["old"], targetFolder: ["new"] },
+ { sourceFolder: ["old", "child"], targetFolder: ["new", "child"] },
+ ]);
+ expect(defaultMocks.viewContext.rebuildTree).toHaveBeenCalled();
+
+ unmount();
+ });
+
+ test("10. Opening an empty folder fetches that folder's worksheets", async () => {
+ const defaultMocks = setupDefaultMocks();
+ const folder = makeFolderNode("/my/empty", []);
+ const rootNode = makeFolderNode("/my", [folder]);
+ defaultMocks.viewContext._sheetTree.value = rootNode;
+ defaultMocks.expandedKeys.value = new Set(["/my"]);
+
+ const { container, render, unmount } = renderIntoContainer(
+ <SheetTree
+ view="my"
+ onMultiSelectModeChange={vi.fn()}
+ onCheckedNodesChange={vi.fn()}
+ />
+ );
+ render();
+
+ const row = container.querySelector(
+ `[data-item-key="/my/empty"]`
+ ) as HTMLElement | null;
+ expect(row).not.toBeNull();
+ const prefix = row?.querySelector("[data-testid='tree-node-prefix']");
+
+ await act(async () => {
+ prefix?.dispatchEvent(new MouseEvent("click", { bubbles: true }));
+ });
+
+ expect(
+ defaultMocks.viewContext.fetchWorksheetsByFolder
+ ).toHaveBeenCalledWith("/my/empty");
+
+ unmount();
+ });
+
+ test("11. Already-expanded empty folder fetches after render", async () => {
+ const defaultMocks = setupDefaultMocks();
+ const folder = makeFolderNode("/my/empty", []);
+ const rootNode = makeFolderNode("/my", [folder]);
+ defaultMocks.viewContext._sheetTree.value = rootNode;
+ defaultMocks.expandedKeys.value = new Set(["/my", "/my/empty"]);
+
+ const { render, unmount } = renderIntoContainer(
+ <SheetTree
+ view="my"
+ onMultiSelectModeChange={vi.fn()}
+ onCheckedNodesChange={vi.fn()}
+ />
+ );
+
+ await act(async () => {
+ render();
+ });
+
+ expect(
+ defaultMocks.viewContext.fetchWorksheetsByFolder
+ ).toHaveBeenCalledWith("/my/empty");
+
+ unmount();
+ });
});
diff --git a/frontend/src/modules/sql-editor/components/SheetTree.tsx b/frontend/src/modules/sql-editor/components/SheetTree.tsx
index a51389a07f..d3731d746f 100644
--- a/frontend/src/modules/sql-editor/components/SheetTree.tsx
+++ b/frontend/src/modules/sql-editor/components/SheetTree.tsx
@@ -16,7 +16,7 @@
*/
import { Loader2 } from "lucide-react";
-import type { Ref } from "react";
+import type { CSSProperties, Ref } from "react";
import {
useCallback,
useEffect,
@@ -63,6 +63,7 @@ import {
useSheetContext,
useSheetContextByView,
type WorksheetFolderNode,
+ type WorksheetFolderPathUpdate,
} from "@/modules/sql-editor/model/Sheet";
import { useSQLEditorStore as useSQLEditorReactStore } from "@/modules/sql-editor/store";
import { useSQLEditorEditorState } from "@/modules/sql-editor/store/editor";
@@ -149,7 +150,7 @@ function generateNewFolderName(children: WorksheetFolderNode[]): string {
let maxNumber = 0;
for (let i = children.length - 1; i >= 0; i--) {
const child = children[i];
- if (child.worksheet) {
+ if (child.worksheet || child.loadMore) {
continue;
}
const match = child.label.match(regex);
@@ -166,6 +167,43 @@ function generateNewFolderName(children: WorksheetFolderNode[]): string {
return maxNumber === 0 ? baseName : `${baseName}${maxNumber + 1}`;
}
+function selectableNodes(node: WorksheetFolderNode[]): WorksheetFolderNode[];
+function selectableNodes(node: WorksheetFolderNode): WorksheetFolderNode[];
+function selectableNodes(
+ node: WorksheetFolderNode | WorksheetFolderNode[]
+): WorksheetFolderNode[] {
+ if (Array.isArray(node)) {
+ return node.filter((n) => !n.loadMore);
+ }
+ return revealNodes(node, (n) => (n.loadMore ? undefined : n));
+}
+
+function WorksheetTreeLoadMoreButton({
+ label,
+ onClick,
+}: Readonly<{
+ label: string;
+ onClick: (e: React.MouseEvent<HTMLButtonElement>) => void;
+}>) {
+ return (
+ <span
+ data-testid="load-more-wrapper"
+ className="min-w-0 flex-1 truncate text-left"
+ >
+ <Button
+ type="button"
+ appearance="secondary"
+ size="xs"
+ className="tree-label cursor-pointer text-xs font-medium text-accent hover:text-accent-hover"
+ onClick={onClick}
+ >
+ <span aria-hidden="true">···</span>
+ <span>{label}</span>
+ </Button>
+ </span>
+ );
+}
+
// ---------------------------------------------------------------------------
// Component
// ---------------------------------------------------------------------------
@@ -190,6 +228,7 @@ export function SheetTree({
expandedKeys,
editingNode,
batchUpdateWorksheetFolders,
+ batchUpdateWorksheetFolderPaths,
setExpandedKeys,
setEditingNode,
} = useSheetContext();
@@ -198,8 +237,11 @@ export function SheetTree({
isLoading,
sheetTree,
fetchSheetList,
+ fetchNextPage,
+ fetchWorksheetsByFolder,
folderContext,
getFoldersForWorksheet,
+ rebuildTree,
events,
} = useSheetContextByView(view);
@@ -356,9 +398,42 @@ export function SheetTree({
[sheetTree, expandedKeysArray, worksheetFilter.keyword, nodeMatches]
);
+ useEffect(() => {
+ if (view === "draft" || !isInitialized || isLoading) return;
+ const expandedKeySet = new Set(expandedKeysArray);
+ for (const node of revealNodes(sheetTree, (node) => node)) {
+ if (
+ node.worksheet ||
+ node.loadMore ||
+ node.key === folderContext.rootPath ||
+ !expandedKeySet.has(node.key)
+ ) {
+ continue;
+ }
+ void fetchWorksheetsByFolder(node.key);
+ }
+ }, [
+ expandedKeysArray,
+ fetchWorksheetsByFolder,
+ folderContext.rootPath,
+ isInitialized,
+ isLoading,
+ sheetTree,
+ view,
+ ]);
+
// ---- Expand/collapse toggle -----------------------------------------------
const handleToggleExpand = useCallback(
(node: WorksheetFolderNode) => {
+ const isOpening = !expandedKeysArray.includes(node.key);
+ if (
+ isOpening &&
+ !node.worksheet &&
+ !node.loadMore &&
+ node.key !== folderContext.rootPath
+ ) {
+ void fetchWorksheetsByFolder(node.key);
+ }
setExpandedKeys((prev) => {
const next = new Set(prev);
if (next.has(node.key)) {
@@ -369,7 +444,12 @@ export function SheetTree({
return next;
});
},
- [setExpandedKeys]
+ [
+ expandedKeysArray,
+ fetchWorksheetsByFolder,
+ folderContext.rootPath,
+ setExpandedKeys,
+ ]
);
// ---- Helpers: folder/tree operations ------------------------------------
@@ -433,6 +513,38 @@ export function SheetTree({
[batchUpdateWorksheetFolders, getFoldersForWorksheet]
);
+ const collectFolderKeys = useCallback(
+ (folderKey: string): string[] => [
+ folderKey,
+ ...folderContext
+ .listSubFolders(folderKey)
+ .flatMap((child) => collectFolderKeys(child)),
+ ],
+ [folderContext]
+ );
+
+ const updateFolderFolders = useCallback(
+ async (oldKey: string, newKey: string) => {
+ const updates = collectFolderKeys(oldKey).map<WorksheetFolderPathUpdate>(
+ (sourceKey) => ({
+ sourceFolder: getFoldersForWorksheet(sourceKey),
+ targetFolder: getFoldersForWorksheet(
+ sourceKey === oldKey
+ ? newKey
+ : sourceKey.replace(`${oldKey}/`, `${newKey}/`)
+ ),
+ })
+ );
+ await batchUpdateWorksheetFolderPaths(view, updates);
+ },
+ [
+ batchUpdateWorksheetFolderPaths,
+ collectFolderKeys,
+ getFoldersForWorksheet,
+ view,
+ ]
+ );
+
// ---- Delete helpers -------------------------------------------------------
const doDeleteWorksheets = useCallback(async (worksheets: string[]) => {
@@ -522,13 +634,10 @@ export function SheetTree({
resolve: (merge) => {
if (merge) {
void (async () => {
- await updateWorksheetFolders(
- editing.node,
- editing.node.key,
- newKey
- );
+ await updateFolderFolders(editing.node.key, newKey);
replaceExpandedKeys({ oldKey: editing.node.key, newKey });
folderContext.moveFolder(editing.node.key, newKey);
+ rebuildTree();
cleanup();
})();
} else {
@@ -541,9 +650,10 @@ export function SheetTree({
});
});
} else {
- await updateWorksheetFolders(editing.node, editing.node.key, newKey);
+ await updateFolderFolders(editing.node.key, newKey);
replaceExpandedKeys({ oldKey: editing.node.key, newKey });
folderContext.moveFolder(editing.node.key, newKey);
+ rebuildTree();
cleanup();
}
}
@@ -552,9 +662,10 @@ export function SheetTree({
setEditingNode,
findParentNode,
sheetTree,
- updateWorksheetFolders,
+ updateFolderFolders,
replaceExpandedKeys,
folderContext,
+ rebuildTree,
]);
const handleRenameNode = useCallback(() => {
@@ -566,10 +677,32 @@ export function SheetTree({
}, 0);
}, [execRenameNode]);
+ const restoreRenameInputSelection = useCallback(
+ (selectionStart: number | null, selectionEnd: number | null) => {
+ if (selectionStart === null || selectionEnd === null) {
+ return;
+ }
+ window.setTimeout(() => {
+ const input = inputRef.current;
+ if (!input || document.activeElement !== input) {
+ return;
+ }
+ const start = Math.min(selectionStart, input.value.length);
+ const end = Math.min(selectionEnd, input.value.length);
+ input.setSelectionRange(start, end);
+ }, 0);
+ },
+ []
+ );
+
// ---- Click handler -------------------------------------------------------
const handleNodeClick = useCallback(
(e: React.MouseEvent, node: WorksheetFolderNode) => {
if (editingNode) return;
+ if (node.loadMore) {
+ void fetchNextPage(node.loadMoreFolderKey);
+ return;
+ }
if (node.worksheet) {
if (node.worksheet.type === "worksheet") {
void openWorksheetByName({
@@ -584,7 +717,7 @@ export function SheetTree({
handleToggleExpand(node);
}
},
- [editingNode, handleToggleExpand]
+ [editingNode, fetchNextPage, handleToggleExpand]
);
// ---- Duplicate sheet -------------------------------------------------------
@@ -637,6 +770,9 @@ export function SheetTree({
const folders: string[] = [];
const worksheets: string[] = [];
for (const node of nodes) {
+ if (node.loadMore) {
+ continue;
+ }
if (node.worksheet) {
worksheets.push(node.worksheet.name);
continue;
@@ -750,7 +886,7 @@ export function SheetTree({
// Guarded — the menu item is only surfaced when the callbacks exist
// (the "my" tree); the optional-chaining is a belt-and-braces safety.
onMultiSelectModeChange?.(true);
- onCheckedNodesChange?.(revealNodes(contextMenuNode, (n) => n));
+ onCheckedNodesChange?.(selectableNodes(contextMenuNode));
break;
default:
break;
@@ -834,7 +970,7 @@ export function SheetTree({
parentFolderNode = candidate;
}
}
- if (!parentFolderNode) return;
+ if (!parentFolderNode || parentFolderNode.loadMore) return;
// Only handle single drag (matches Vue behaviour)
const draggedTreeNode = dragNodes[0] as
@@ -843,6 +979,7 @@ export function SheetTree({
if (!draggedTreeNode) return;
const draggedNode = draggedTreeNode.data.data;
+ if (draggedNode.loadMore) return;
const oldParentNode = findParentNode(sheetTree, draggedNode.key);
if (!oldParentNode) return;
@@ -864,14 +1001,17 @@ export function SheetTree({
const shouldCloseOldParent =
!draggedNode.worksheet && oldParentNode.children.length === 1;
- await updateWorksheetFolders(
- draggedNode,
- oldParentNode.key,
- parentFolderNode.key
- );
- if (!draggedNode.worksheet) {
+ if (draggedNode.worksheet) {
+ await updateWorksheetFolders(
+ draggedNode,
+ oldParentNode.key,
+ parentFolderNode.key
+ );
+ } else {
+ await updateFolderFolders(draggedNode.key, newKey);
// Folder move — update folderContext too
folderContext.moveFolder(draggedNode.key, newKey);
+ rebuildTree();
}
// Update expanded keys (nextTick equivalent: defer to next microtask)
@@ -893,6 +1033,8 @@ export function SheetTree({
folderContext,
handleDuplicateFolderNameDrop,
updateWorksheetFolders,
+ updateFolderFolders,
+ rebuildTree,
replaceExpandedKeys,
setExpandedKeys,
]
@@ -937,19 +1079,23 @@ export function SheetTree({
const ROW_GUTTER_X = 8;
const indentPadding =
typeof style.paddingLeft === "number" ? style.paddingLeft : 0;
- const rowStyle = {
+ const rowStyle: CSSProperties = {
...style,
paddingLeft: indentPadding + ROW_GUTTER_X,
paddingRight: ROW_GUTTER_X,
+ width: "100%",
+ maxWidth: "100%",
+ boxSizing: "border-box",
};
return (
<div
key={folderNode.key}
- ref={dragHandle}
+ ref={folderNode.loadMore ? undefined : dragHandle}
style={rowStyle}
data-item-key={folderNode.key}
className={cn(
- "flex items-center gap-x-1 w-full py-0.5 text-sm cursor-pointer select-none",
+ "flex min-w-0 max-w-full items-center gap-x-1 text-sm cursor-pointer select-none",
+ isEditing ? "overflow-visible py-0" : "overflow-hidden py-0.5",
// Align with the connection-panel database tree: subtle neutral
// hover, accent-tinted selection (was a too-light gray fill).
"hover:bg-control-bg/70 rounded-xs",
@@ -966,11 +1112,12 @@ export function SheetTree({
onContextMenu={(e) => {
e.preventDefault();
e.stopPropagation();
+ if (folderNode.loadMore) return;
openMenuAtPoint(e.clientX, e.clientY, folderNode);
}}
>
{/* Multi-select checkbox */}
- {multiSelectMode && (
+ {multiSelectMode && !folderNode.loadMore && (
<Checkbox
checked={isChecked}
className="shrink-0 cursor-pointer"
@@ -980,7 +1127,7 @@ export function SheetTree({
// users don't have to tick each child individually.
const affected = folderNode.worksheet
? [folderNode]
- : revealNodes(folderNode, (n) => n);
+ : selectableNodes(folderNode);
if (checked) {
const existing = new Set(checkedNodes.map((n) => n.key));
onCheckedNodesChange?.([
@@ -998,69 +1145,87 @@ export function SheetTree({
)}
{/* Prefix icon */}
- <span className="tree-prefix shrink-0">
- <TreeNodePrefix
- node={folderNode}
- isOpen={isOpen}
- rootPath={folderContext.rootPath}
- view={view}
- />
- </span>
-
- {/* Label / rename input */}
- <span className="tree-label flex-1 min-w-0">
- {isEditing ? (
- <Input
- ref={inputRef}
- id={`sheet-input-${folderNode.key}`}
- size="sm"
- // Bind to the editable `rawLabel`, NOT `node.label`. The
- // editingNode lives in the immer-backed sheet-context
- // store and is frozen — mutating `node.label` silently
- // no-ops, which froze the input (could not type).
- value={editingNode.rawLabel}
- className="h-5 py-0 text-xs px-1!"
- autoFocus
- onBlur={() => handleRenameNode()}
- onKeyDown={(e) => {
- // react-arborist's container intercepts Space (toggles node)
- // and other keys for tree navigation; stop propagation so
- // typing inside the rename input is unaffected.
- e.stopPropagation();
- if (e.key === "Enter") {
- e.preventDefault();
- handleRenameNode();
- }
- }}
- onChange={(e) => {
- const val = e.target.value;
- if (!editingNode) return;
- if (!editingNode.node.worksheet) {
- // folder names cannot contain "/" or "."
- if (val.includes("/") || val.includes(".")) return;
- }
- setEditingNode({ ...editingNode, rawLabel: val });
- }}
- onClick={(e) => e.stopPropagation()}
+ {!folderNode.loadMore && (
+ <span className="tree-prefix shrink-0">
+ <TreeNodePrefix
+ node={folderNode}
+ isOpen={isOpen}
+ rootPath={folderContext.rootPath}
+ view={view}
/>
- ) : folderNode.worksheet && !folderNode.label ? (
- // Untitled worksheet — render a placeholder. We don't pipe this
- // through HighlightLabelText since there's nothing to highlight
- // and the muted italic styling signals "empty title".
- <span className="truncate block text-control-placeholder italic">
- {t("common.untitled")}
- </span>
- ) : (
- <HighlightLabelText
- text={folderNode.label}
- keyword={worksheetFilter.keyword}
- className="truncate block"
- />
- )}
- </span>
+ </span>
+ )}
+
+ {folderNode.loadMore ? (
+ <WorksheetTreeLoadMoreButton
+ label={folderNode.label}
+ onClick={(e) => {
+ e.stopPropagation();
+ void fetchNextPage(folderNode.loadMoreFolderKey);
+ }}
+ />
+ ) : (
+ <span
+ className={cn(
+ "tree-label min-w-0 flex-1",
+ isEditing ? "overflow-visible" : "overflow-hidden"
+ )}
+ >
+ {isEditing ? (
+ <Input
+ ref={inputRef}
+ id={`sheet-input-${folderNode.key}`}
+ size="sm"
+ // Bind to the editable `rawLabel`, NOT `node.label`. The
+ // editingNode lives in the immer-backed sheet-context
+ // store and is frozen — mutating `node.label` silently
+ // no-ops, which froze the input (could not type).
+ value={editingNode.rawLabel}
+ className="h-6 w-full min-w-0 py-0 text-sm px-1!"
+ autoFocus
+ onBlur={() => handleRenameNode()}
+ onKeyDown={(e) => {
+ // react-arborist's container intercepts Space (toggles node)
+ // and other keys for tree navigation; stop propagation so
+ // typing inside the rename input is unaffected.
+ e.stopPropagation();
+ if (e.key === "Enter") {
+ e.preventDefault();
+ handleRenameNode();
+ }
+ }}
+ onChange={(e) => {
+ const val = e.target.value;
+ const { selectionStart, selectionEnd } = e.currentTarget;
+ if (!editingNode) return;
+ if (!editingNode.node.worksheet) {
+ // folder names cannot contain "/" or "."
+ if (val.includes("/") || val.includes(".")) return;
+ }
+ setEditingNode({ ...editingNode, rawLabel: val });
+ restoreRenameInputSelection(selectionStart, selectionEnd);
+ }}
+ onClick={(e) => e.stopPropagation()}
+ />
+ ) : folderNode.worksheet && !folderNode.label ? (
+ // Untitled worksheet — render a placeholder. We don't pipe this
+ // through HighlightLabelText since there's nothing to highlight
+ // and the muted italic styling signals "empty title".
+ <span className="truncate block text-control-placeholder italic">
+ {t("common.untitled")}
+ </span>
+ ) : (
+ <HighlightLabelText
+ text={folderNode.label}
+ keyword={worksheetFilter.keyword}
+ className="truncate block"
+ />
+ )}
+ </span>
+ )}
{/* Suffix (star, visibility badge, more) */}
- {!isEditing && (
+ {!isEditing && !folderNode.loadMore && (
<TreeNodeSuffix
node={folderNode}
view={view}
@@ -1086,6 +1251,7 @@ export function SheetTree({
folderContext,
handleNodeClick,
handleRenameNode,
+ restoreRenameInputSelection,
handleWorksheetToggleStar,
openMenuAtPoint,
openMenuAtElement,
@@ -1096,7 +1262,7 @@ export function SheetTree({
);
// ---- Loading spinner -----------------------------------------------------
- if (isLoading) {
+ if (isLoading && !isInitialized) {
return (
<div className="flex items-center justify-center p-4">
<Loader2 className="size-4 animate-spin text-control-light" />
@@ -1370,7 +1536,7 @@ export function SheetTree({
// ---- Main render ---------------------------------------------------------
return (
- <div className="flex flex-col items-stretch gap-y-1 relative worksheet-tree">
+ <div className="relative flex min-w-0 max-w-full flex-col items-stretch gap-y-1 overflow-x-hidden worksheet-tree">
<Tree<WorksheetFolderNode>
data={treeData}
renderNode={renderNode}
@@ -1381,13 +1547,25 @@ export function SheetTree({
height={treeHeight}
rowHeight={ROW_HEIGHT}
indent={12}
- className="text-sm"
+ className={cn(
+ "min-w-0 max-w-full overflow-x-hidden text-sm [&_[role=treeitem]]:!min-w-0 [&_[role=treeitem]]:!max-w-full",
+ editingNode
+ ? "[&_[role=treeitem]]:overflow-visible"
+ : "[&_[role=treeitem]]:overflow-hidden"
+ )}
onMove={handleMove}
- disableDrag={view === "draft" || !!editingNode || multiSelectMode}
+ disableDrag={
+ view === "draft" || !!editingNode || multiSelectMode
+ ? true
+ : ({ data }) => !!data.loadMore
+ }
disableDrop={
view === "draft" || !!editingNode || multiSelectMode
? true
- : ({ parentNode: p }) => !!p?.data.data.worksheet
+ : ({ parentNode: p, dragNodes }) =>
+ !!p?.data.data.worksheet ||
+ !!p?.data.data.loadMore ||
+ dragNodes.some((node) => !!node.data.data.loadMore)
}
/>
diff --git a/frontend/src/modules/sql-editor/components/TreeNodePrefix.test.tsx b/frontend/src/modules/sql-editor/components/TreeNodePrefix.test.tsx
index e3fb99f32d..5d6d9c57ac 100644
--- a/frontend/src/modules/sql-editor/components/TreeNodePrefix.test.tsx
+++ b/frontend/src/modules/sql-editor/components/TreeNodePrefix.test.tsx
@@ -94,6 +94,22 @@ describe("TreeNodePrefix", () => {
unmount();
});
+ test("renders the regular folder icon for empty folders", () => {
+ const node = makeNode({ empty: true });
+
+ const { container, render, unmount } = renderIntoContainer(
+ <TreeNodePrefix node={node} isOpen={false} rootPath="/my" view="my" />
+ );
+ render();
+
+ const svg = container.querySelector("svg");
+ expect(svg).not.toBeNull();
+ expect(svg?.classList.contains("lucide-folder-code")).toBe(true);
+ expect(svg?.classList.contains("lucide-folder-minus")).toBe(false);
+
+ unmount();
+ });
+
test("renders view-specific root icon when node.key === rootPath", () => {
const rootPath = "/my";
const node = makeNode({ key: rootPath });
diff --git a/frontend/src/modules/sql-editor/components/TreeNodePrefix.tsx b/frontend/src/modules/sql-editor/components/TreeNodePrefix.tsx
index 88ca4d91c8..c7cb09c61f 100644
--- a/frontend/src/modules/sql-editor/components/TreeNodePrefix.tsx
+++ b/frontend/src/modules/sql-editor/components/TreeNodePrefix.tsx
@@ -1,7 +1,6 @@
import {
FileCode,
FolderCode,
- FolderMinus,
FolderOpen,
FolderPen,
FolderSync,
@@ -34,8 +33,5 @@ export function TreeNodePrefix({ node, isOpen, rootPath, view }: Props) {
}
return <FolderCode className={cls} />;
}
- if (node.empty) {
- return <FolderMinus className={cls} />;
- }
return <FolderCode className={cls} />;
}
diff --git a/frontend/src/modules/sql-editor/components/TreeNodeSuffix.tsx b/frontend/src/modules/sql-editor/components/TreeNodeSuffix.tsx
index aa033b4327..a77b1be572 100644
--- a/frontend/src/modules/sql-editor/components/TreeNodeSuffix.tsx
+++ b/frontend/src/modules/sql-editor/components/TreeNodeSuffix.tsx
@@ -152,7 +152,7 @@ export function TreeNodeSuffix({
worksheetLite.visibility === Worksheet_Visibility.PROJECT_WRITE;
return (
- <div className="inline-flex gap-x-1 items-center">
+ <div className="inline-flex shrink-0 items-center gap-x-1">
{showVisibilityBadge && (
<Tooltip
content={
diff --git a/frontend/src/modules/sql-editor/components/WorksheetPane.tsx b/frontend/src/modules/sql-editor/components/WorksheetPane.tsx
index b8f8e0519e..538d485757 100644
--- a/frontend/src/modules/sql-editor/components/WorksheetPane.tsx
+++ b/frontend/src/modules/sql-editor/components/WorksheetPane.tsx
@@ -110,8 +110,8 @@ export function WorksheetPane() {
const hasAnyView = filter.showMine || views.length > 0;
return (
- <div className="h-full flex flex-col gap-1 overflow-hidden py-1 text-sm">
- <div className="flex items-center gap-x-1 px-1">
+ <div className="flex h-full min-w-0 max-w-full flex-col gap-1 overflow-hidden py-1 text-sm">
+ <div className="flex min-w-0 items-center gap-x-1 px-1">
<SearchInput
size="sm"
value={filter.keyword}
@@ -153,7 +153,7 @@ export function WorksheetPane() {
</DropdownMenu>
</div>
- <div className="relative flex-1 flex flex-col gap-y-2 overflow-y-auto worksheet-scroll">
+ <div className="relative flex min-w-0 max-w-full flex-1 flex-col gap-y-2 overflow-y-auto overflow-x-hidden worksheet-scroll">
{showMultiSelectToolbar && (
<div className="sticky top-0 z-10 flex flex-wrap items-center justify-start gap-y-1 gap-x-1 bg-control-bg py-2 px-1">
<Button
diff --git a/frontend/src/modules/sql-editor/model/Sheet/context.test.tsx b/frontend/src/modules/sql-editor/model/Sheet/context.test.tsx
new file mode 100644
index 0000000000..5827d3431d
--- /dev/null
+++ b/frontend/src/modules/sql-editor/model/Sheet/context.test.tsx
@@ -0,0 +1,787 @@
+import { create } from "@bufbuild/protobuf";
+import { act } from "react";
+import { createRoot, type Root } from "react-dom/client";
+import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
+import {
+ WorksheetSchema,
+ Worksheet_Visibility,
+ type Worksheet,
+} from "@/types/proto-es/v1/worksheet_service_pb";
+import { storageKeySqlEditorWorksheetFolder } from "@/utils";
+
+type AppState = {
+ currentUser: { email: string; workspace: string };
+ worksheetsByKey: Record<string, Worksheet>;
+ isSaaSMode: () => boolean;
+ getWorksheetByName: (name: string) => Worksheet | undefined;
+ listWorksheetFolders: ReturnType<typeof vi.fn>;
+ fetchWorksheetList: ReturnType<typeof vi.fn>;
+ upsertWorksheetOrganizer: ReturnType<typeof vi.fn>;
+ batchUpdateWorksheetOrganizers: ReturnType<typeof vi.fn>;
+};
+
+const mocks = vi.hoisted(() => {
+ let appState: AppState;
+ const appSubscribers = new Set<(state: AppState, prev: AppState) => void>();
+ const keyForWorksheet = (name: string) => `${name.split("/").pop()}:FULL`;
+
+ const setWorksheets = (worksheets: Worksheet[]) => {
+ const prev = {
+ ...appState,
+ worksheetsByKey: appState.worksheetsByKey,
+ };
+ appState = {
+ ...appState,
+ worksheetsByKey: {
+ ...appState.worksheetsByKey,
+ ...Object.fromEntries(
+ worksheets.map((worksheet) => [
+ keyForWorksheet(worksheet.name),
+ worksheet,
+ ])
+ ),
+ },
+ };
+ for (const subscriber of appSubscribers) {
+ subscriber(appState, prev);
+ }
+ };
+
+ return {
+ getAppState: () => appState,
+ resetAppState: () => {
+ appSubscribers.clear();
+ appState = {
+ currentUser: {
+ email: "[email protected]",
+ workspace: "workspaces/default",
+ },
+ worksheetsByKey: {},
+ isSaaSMode: () => false,
+ getWorksheetByName: (name: string) =>
+ appState.worksheetsByKey[keyForWorksheet(name)],
+ listWorksheetFolders: vi.fn(async () => []),
+ fetchWorksheetList: vi.fn(async (_project, _filter, _params) => {
+ const worksheet = create(WorksheetSchema, {
+ name: "projects/proj1/worksheets/1",
+ project: "projects/proj1",
+ creator: "users/[email protected]",
+ title: "Existing worksheet",
+ visibility: Worksheet_Visibility.PRIVATE,
+ });
+ setWorksheets([worksheet]);
+ return { worksheets: [worksheet], nextPageToken: "next-page" };
+ }),
+ upsertWorksheetOrganizer: vi.fn(),
+ batchUpdateWorksheetOrganizers: vi.fn(),
+ };
+ },
+ addWorksheets: setWorksheets,
+ useAppStore: {
+ getState: () => appState,
+ subscribe: (subscriber: (state: AppState, prev: AppState) => void) => {
+ appSubscribers.add(subscriber);
+ return () => appSubscribers.delete(subscriber);
+ },
+ },
+ getSQLEditorTabsState: vi.fn(() => ({
+ currentTabId: "",
+ openTmpTabList: [],
+ tabsById: new Map(),
+ })),
+ subscribeSQLEditorEditorState: vi.fn(),
+ subscribeSQLEditorTabsState: vi.fn(),
+ };
+});
+
+vi.mock("@/lib/i18n", () => ({
+ default: { t: (key: string) => key },
+}));
+
+vi.mock("@/stores/app", () => ({
+ useAppStore: mocks.useAppStore,
+}));
+
+vi.mock("@/modules/sql-editor/store/editor", () => ({
+ getSQLEditorEditorState: () => ({ project: "projects/proj1" }),
+ subscribeSQLEditorEditorState: mocks.subscribeSQLEditorEditorState,
+ useSQLEditorEditorStore: vi.fn(),
+}));
+
+vi.mock("@/modules/sql-editor/store/tab", () => ({
+ getSQLEditorTabsState: mocks.getSQLEditorTabsState,
+ subscribeSQLEditorTabsState: mocks.subscribeSQLEditorTabsState,
+ useSQLEditorTabsStore: vi.fn(),
+}));
+
+describe("sheet context", () => {
+ let root: Root;
+ let container: HTMLDivElement;
+
+ beforeEach(() => {
+ vi.useFakeTimers();
+ mocks.resetAppState();
+ window.localStorage.clear();
+ container = document.createElement("div");
+ document.body.appendChild(container);
+ });
+
+ afterEach(() => {
+ root?.unmount();
+ container.remove();
+ vi.useRealTimers();
+ vi.resetModules();
+ });
+
+ test("adds newly created worksheets to the initialized paged my view", async () => {
+ const { provideSheetContext, useSheetContextByView } = await import(
+ "./context"
+ );
+ let viewContext: ReturnType<typeof useSheetContextByView> | undefined;
+
+ const Probe = () => {
+ provideSheetContext();
+ viewContext = useSheetContextByView("my");
+ return (
+ <div>
+ {viewContext.sheetTree.children.map((child) => child.label).join(",")}
+ </div>
+ );
+ };
+
+ root = createRoot(container);
+ await act(async () => {
+ root.render(<Probe />);
+ });
+
+ await act(async () => {
+ await viewContext!.fetchSheetList();
+ });
+
+ expect(container.textContent).toContain("Existing worksheet");
+ expect(viewContext!.sheetTree.children.map((child) => child.label)).toContain(
+ "common.load-more"
+ );
+ expect(viewContext!.folderTree.children.map((child) => child.label)).not.toContain(
+ "common.load-more"
+ );
+
+ mocks.addWorksheets([
+ create(WorksheetSchema, {
+ name: "projects/proj1/worksheets/2",
+ project: "projects/proj1",
+ creator: "users/[email protected]",
+ title: "Created worksheet",
+ visibility: Worksheet_Visibility.PRIVATE,
+ }),
+ ]);
+ await act(async () => {
+ vi.runAllTimers();
+ });
+
+ expect(container.textContent).toContain("Created worksheet");
+ });
+
+ test("loads caller worksheet folders before the root worksheet page", async () => {
+ mocks
+ .getAppState()
+ .listWorksheetFolders.mockResolvedValueOnce([
+ { folders: ["alpha"], category: "my" },
+ { folders: ["alpha", "beta"], category: "my" },
+ { folders: ["shared"], category: "shared" },
+ ]);
+ mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => ({
+ worksheets: [],
+ nextPageToken: "",
+ }));
+
+ const { provideSheetContext, useSheetContextByView } = await import(
+ "./context"
+ );
+ let viewContext: ReturnType<typeof useSheetContextByView> | undefined;
+
+ const Probe = () => {
+ provideSheetContext();
+ viewContext = useSheetContextByView("my");
+ return (
+ <div>
+ {viewContext.sheetTree.children.map((child) => child.label).join(",")}
+ </div>
+ );
+ };
+
+ root = createRoot(container);
+ await act(async () => {
+ root.render(<Probe />);
+ });
+ await act(async () => {
+ await viewContext!.fetchSheetList();
+ });
+
+ expect(mocks.getAppState().listWorksheetFolders).toHaveBeenCalledWith(
+ "projects/proj1"
+ );
+ expect(mocks.getAppState().fetchWorksheetList).toHaveBeenCalledWith(
+ "projects/proj1",
+ 'creator == "users/[email protected]" && folder == ""',
+ expect.objectContaining({ pageToken: "" })
+ );
+ expect(container.textContent).toContain("alpha");
+ expect(container.textContent).not.toContain("shared");
+ });
+
+ test("merges persisted empty folders with backend folders", async () => {
+ window.localStorage.setItem(
+ storageKeySqlEditorWorksheetFolder(
+ "",
+ "projects/proj1",
+ "shared",
+ ),
+ JSON.stringify(["/shared/alpha", "/shared/local-empty"])
+ );
+ mocks.getAppState().listWorksheetFolders.mockResolvedValueOnce([
+ { folders: ["alpha"], category: "my" },
+ ]);
+ mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => ({
+ worksheets: [],
+ nextPageToken: "",
+ }));
+
+ const { provideSheetContext, useSheetContextByView } = await import(
+ "./context"
+ );
+ let viewContext: ReturnType<typeof useSheetContextByView> | undefined;
+
+ const Probe = () => {
+ provideSheetContext();
+ viewContext = useSheetContextByView("shared");
+ return (
+ <div>
+ {viewContext.sheetTree.children.map((child) => child.label).join(",")}
+ </div>
+ );
+ };
+
+ root = createRoot(container);
+ await act(async () => {
+ root.render(<Probe />);
+ });
+ await act(async () => {
+ await viewContext!.fetchSheetList();
+ });
+
+ expect(container.textContent).toContain("alpha");
+ expect(container.textContent).toContain("local-empty");
+ });
+
+ test("persists locally created empty folders", async () => {
+ const { provideSheetContext, useSheetContextByView } = await import(
+ "./context"
+ );
+ let viewContext: ReturnType<typeof useSheetContextByView> | undefined;
+
+ const Probe = () => {
+ provideSheetContext();
+ viewContext = useSheetContextByView("my");
+ return null;
+ };
+
+ root = createRoot(container);
+ await act(async () => {
+ root.render(<Probe />);
+ });
+
+ act(() => {
+ viewContext!.folderContext.addFolder("/my/local-empty");
+ });
+
+ expect(
+ JSON.parse(
+ window.localStorage.getItem(
+ storageKeySqlEditorWorksheetFolder(
+ "",
+ "projects/proj1",
+ "my",
+ )
+ ) ?? "[]"
+ )
+ ).toEqual(["/my/local-empty"]);
+ });
+
+ test("uses server-side keyword and starred filters when fetching worksheets", async () => {
+ const { provideSheetContext, useSheetContext, useSheetContextByView } =
+ await import("./context");
+ let sheetContext: ReturnType<typeof useSheetContext> | undefined;
+ let viewContext: ReturnType<typeof useSheetContextByView> | undefined;
+
+ const Probe = () => {
+ provideSheetContext();
+ sheetContext = useSheetContext();
+ viewContext = useSheetContextByView("my");
+ return null;
+ };
+
+ root = createRoot(container);
+ await act(async () => {
+ root.render(<Probe />);
+ });
+ await act(async () => {
+ await viewContext!.fetchSheetList();
+ });
+ mocks.getAppState().fetchWorksheetList.mockClear();
+
+ act(() => {
+ sheetContext!.setFilter({
+ ...sheetContext!.filter,
+ keyword: "Payroll",
+ onlyShowStarred: true,
+ });
+ });
+ await act(async () => {
+ await vi.runAllTimersAsync();
+ });
+
+ expect(mocks.getAppState().fetchWorksheetList).toHaveBeenLastCalledWith(
+ "projects/proj1",
+ 'creator == "users/[email protected]" && title.contains("payroll") && starred == true',
+ expect.objectContaining({ pageToken: "" })
+ );
+ });
+
+ test("fetches worksheet descendants for a folder without replacing the paged view", async () => {
+ const { provideSheetContext, useSheetContextByView } = await import(
+ "./context"
+ );
+ let viewContext: ReturnType<typeof useSheetContextByView> | undefined;
+
+ const Probe = () => {
+ provideSheetContext();
+ viewContext = useSheetContextByView("my");
+ return (
+ <div>
+ {viewContext.sheetTree.children.map((child) => child.label).join(",")}
+ </div>
+ );
+ };
+
+ root = createRoot(container);
+ await act(async () => {
+ root.render(<Probe />);
+ });
+ await act(async () => {
+ await viewContext!.fetchSheetList();
+ });
+
+ mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => {
+ const worksheet = create(WorksheetSchema, {
+ name: "projects/proj1/worksheets/3",
+ project: "projects/proj1",
+ creator: "users/[email protected]",
+ title: "Folder worksheet",
+ folders: ["alpha"],
+ visibility: Worksheet_Visibility.PRIVATE,
+ });
+ mocks.addWorksheets([worksheet]);
+ return {
+ worksheets: [worksheet],
+ nextPageToken: "",
+ };
+ });
+
+ await act(async () => {
+ await viewContext!.fetchWorksheetsByFolder("/my/alpha");
+ });
+
+ expect(mocks.getAppState().fetchWorksheetList).toHaveBeenLastCalledWith(
+ "projects/proj1",
+ 'creator == "users/[email protected]" && folder == "alpha"',
+ expect.objectContaining({ pageToken: "" })
+ );
+ expect(container.textContent).toContain("Existing worksheet");
+ expect(container.textContent).toContain("alpha");
+ });
+
+ test("fetches the next page for a folder without using the root page token", async () => {
+ const { provideSheetContext, useSheetContextByView } = await import(
+ "./context"
+ );
+ let viewContext: ReturnType<typeof useSheetContextByView> | undefined;
+
+ const Probe = () => {
+ provideSheetContext();
+ viewContext = useSheetContextByView("my");
+ return null;
+ };
+
+ root = createRoot(container);
+ await act(async () => {
+ root.render(<Probe />);
+ });
+ await act(async () => {
+ await viewContext!.fetchSheetList();
+ });
+
+ mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => {
+ const worksheet = create(WorksheetSchema, {
+ name: "projects/proj1/worksheets/3",
+ project: "projects/proj1",
+ creator: "users/[email protected]",
+ title: "Folder worksheet",
+ folders: ["alpha"],
+ visibility: Worksheet_Visibility.PRIVATE,
+ });
+ mocks.addWorksheets([worksheet]);
+ return {
+ worksheets: [worksheet],
+ nextPageToken: "folder-next",
+ };
+ });
+ await act(async () => {
+ await viewContext!.fetchWorksheetsByFolder("/my/alpha");
+ });
+
+ const alpha = viewContext!.sheetTree.children.find(
+ (child) => child.key === "/my/alpha"
+ );
+ expect(alpha?.children.map((child) => child.label)).toContain(
+ "common.load-more"
+ );
+
+ mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => ({
+ worksheets: [],
+ nextPageToken: "",
+ }));
+ await act(async () => {
+ await viewContext!.fetchNextPage("/my/alpha");
+ });
+
+ expect(mocks.getAppState().fetchWorksheetList).toHaveBeenLastCalledWith(
+ "projects/proj1",
+ 'creator == "users/[email protected]" && folder == "alpha"',
+ expect.objectContaining({ pageToken: "folder-next" })
+ );
+ });
+
+ test("appends newly fetched worksheet pages without frontend reordering", async () => {
+ const firstWorksheet = create(WorksheetSchema, {
+ name: "projects/proj1/worksheets/first",
+ project: "projects/proj1",
+ creator: "users/[email protected]",
+ title: "Zeta worksheet",
+ visibility: Worksheet_Visibility.PRIVATE,
+ });
+ mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => {
+ mocks.addWorksheets([firstWorksheet]);
+ return {
+ worksheets: [firstWorksheet],
+ nextPageToken: "next-page",
+ };
+ });
+
+ const { provideSheetContext, useSheetContextByView } = await import(
+ "./context"
+ );
+ let viewContext: ReturnType<typeof useSheetContextByView> | undefined;
+
+ const Probe = () => {
+ provideSheetContext();
+ viewContext = useSheetContextByView("my");
+ return null;
+ };
+
+ root = createRoot(container);
+ await act(async () => {
+ root.render(<Probe />);
+ });
+ await act(async () => {
+ await viewContext!.fetchSheetList();
+ });
+
+ const secondWorksheet = create(WorksheetSchema, {
+ name: "projects/proj1/worksheets/second",
+ project: "projects/proj1",
+ creator: "users/[email protected]",
+ title: "Alpha worksheet",
+ visibility: Worksheet_Visibility.PRIVATE,
+ });
+ mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => {
+ mocks.addWorksheets([secondWorksheet]);
+ return {
+ worksheets: [secondWorksheet],
+ nextPageToken: "",
+ };
+ });
+ await act(async () => {
+ await viewContext!.fetchNextPage();
+ });
+
+ expect(
+ viewContext!.sheetTree.children
+ .filter((child) => child.worksheet)
+ .map((child) => child.label)
+ ).toEqual(["Zeta worksheet", "Alpha worksheet"]);
+ });
+
+ test("keeps folder and descendant load-more state after renaming a folder", async () => {
+ const { provideSheetContext, useSheetContextByView } = await import(
+ "./context"
+ );
+ let viewContext: ReturnType<typeof useSheetContextByView> | undefined;
+
+ const Probe = () => {
+ provideSheetContext();
+ viewContext = useSheetContextByView("my");
+ return null;
+ };
+
+ root = createRoot(container);
+ await act(async () => {
+ root.render(<Probe />);
+ });
+ await act(async () => {
+ await viewContext!.fetchSheetList();
+ });
+
+ mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => {
+ const worksheet = create(WorksheetSchema, {
+ name: "projects/proj1/worksheets/3",
+ project: "projects/proj1",
+ creator: "users/[email protected]",
+ title: "Folder worksheet",
+ folders: ["alpha"],
+ visibility: Worksheet_Visibility.PRIVATE,
+ });
+ mocks.addWorksheets([worksheet]);
+ return {
+ worksheets: [worksheet],
+ nextPageToken: "folder-next",
+ };
+ });
+ await act(async () => {
+ await viewContext!.fetchWorksheetsByFolder("/my/alpha");
+ });
+
+ expect(viewContext!.hasMoreForFolder("/my/alpha")).toBe(true);
+
+ mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => {
+ const worksheet = create(WorksheetSchema, {
+ name: "projects/proj1/worksheets/4",
+ project: "projects/proj1",
+ creator: "users/[email protected]",
+ title: "Child folder worksheet",
+ folders: ["alpha", "child"],
+ visibility: Worksheet_Visibility.PRIVATE,
+ });
+ mocks.addWorksheets([worksheet]);
+ return {
+ worksheets: [worksheet],
+ nextPageToken: "child-folder-next",
+ };
+ });
+ await act(async () => {
+ await viewContext!.fetchWorksheetsByFolder("/my/alpha/child");
+ });
+
+ expect(viewContext!.hasMoreForFolder("/my/alpha/child")).toBe(true);
+
+ act(() => {
+ viewContext!.folderContext.moveFolder("/my/alpha", "/my/beta");
+ viewContext!.rebuildTree();
+ });
+
+ expect(viewContext!.hasMoreForFolder("/my/beta")).toBe(true);
+ expect(viewContext!.hasMoreForFolder("/my/beta/child")).toBe(true);
+ expect(viewContext!.hasMoreForFolder("/my/alpha/child")).toBe(false);
+ });
+
+ test("invalidates folder pagination state when merging folders", async () => {
+ const { provideSheetContext, useSheetContextByView } = await import(
+ "./context"
+ );
+ let viewContext: ReturnType<typeof useSheetContextByView> | undefined;
+
+ const Probe = () => {
+ provideSheetContext();
+ viewContext = useSheetContextByView("my");
+ return null;
+ };
+
+ root = createRoot(container);
+ await act(async () => {
+ root.render(<Probe />);
+ });
+ await act(async () => {
+ await viewContext!.fetchSheetList();
+ });
+
+ viewContext!.folderContext.addFolder("/my/beta");
+
+ mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => {
+ const worksheet = create(WorksheetSchema, {
+ name: "projects/proj1/worksheets/3",
+ project: "projects/proj1",
+ creator: "users/[email protected]",
+ title: "Alpha worksheet",
+ folders: ["alpha"],
+ visibility: Worksheet_Visibility.PRIVATE,
+ });
+ mocks.addWorksheets([worksheet]);
+ return {
+ worksheets: [worksheet],
+ nextPageToken: "alpha-next",
+ };
+ });
+ await act(async () => {
+ await viewContext!.fetchWorksheetsByFolder("/my/alpha");
+ });
+
+ expect(viewContext!.hasMoreForFolder("/my/alpha")).toBe(true);
+
+ act(() => {
+ viewContext!.folderContext.moveFolder("/my/alpha", "/my/beta");
+ viewContext!.rebuildTree();
+ });
+
+ expect(viewContext!.hasMoreForFolder("/my/beta")).toBe(false);
+ expect(viewContext!.hasMoreForFolder("/my/alpha")).toBe(false);
+ });
+
+ test("invalidates affected page tokens after moving worksheets", async () => {
+ const { provideSheetContext, useSheetContext, useSheetContextByView } =
+ await import("./context");
+ let sheetContext: ReturnType<typeof useSheetContext> | undefined;
+ let viewContext: ReturnType<typeof useSheetContextByView> | undefined;
+
+ const Probe = () => {
+ provideSheetContext();
+ sheetContext = useSheetContext();
+ viewContext = useSheetContextByView("my");
+ return null;
+ };
+
+ root = createRoot(container);
+ await act(async () => {
+ root.render(<Probe />);
+ });
+ await act(async () => {
+ await viewContext!.fetchSheetList();
+ });
+
+ mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => {
+ const worksheet = create(WorksheetSchema, {
+ name: "projects/proj1/worksheets/3",
+ project: "projects/proj1",
+ creator: "users/[email protected]",
+ title: "Folder worksheet",
+ folders: ["alpha"],
+ visibility: Worksheet_Visibility.PRIVATE,
+ });
+ mocks.addWorksheets([worksheet]);
+ return {
+ worksheets: [worksheet],
+ nextPageToken: "folder-next",
+ };
+ });
+ await act(async () => {
+ await viewContext!.fetchWorksheetsByFolder("/my/alpha");
+ });
+
+ expect(viewContext!.hasMore).toBe(true);
+ expect(viewContext!.hasMoreForFolder("/my/alpha")).toBe(true);
+
+ await act(async () => {
+ await sheetContext!.batchUpdateWorksheetFolders([
+ { name: "projects/proj1/worksheets/1", folders: ["alpha"] },
+ ]);
+ });
+
+ expect(viewContext!.hasMore).toBe(false);
+ expect(viewContext!.hasMoreForFolder("/my/alpha")).toBe(false);
+ });
+
+ test("batch updates worksheet folders with one name filter per target folder", async () => {
+ const { provideSheetContext, useSheetContext } = await import("./context");
+ let sheetContext: ReturnType<typeof useSheetContext> | undefined;
+
+ const Probe = () => {
+ provideSheetContext();
+ sheetContext = useSheetContext();
+ return null;
+ };
+
+ root = createRoot(container);
+ await act(async () => {
+ root.render(<Probe />);
+ });
+
+ await act(async () => {
+ await sheetContext!.batchUpdateWorksheetFolders([
+ { name: "projects/proj1/worksheets/1", folders: ["target"] },
+ { name: "projects/proj1/worksheets/2", folders: ["target"] },
+ ]);
+ });
+
+ expect(mocks.getAppState().upsertWorksheetOrganizer).not.toHaveBeenCalled();
+ expect(
+ mocks.getAppState().batchUpdateWorksheetOrganizers
+ ).toHaveBeenCalledWith([
+ {
+ parent: "projects/proj1",
+ filter:
+ 'name in ["projects/proj1/worksheets/1","projects/proj1/worksheets/2"]',
+ organizer: { folders: ["target"] },
+ updateMask: ["folders"],
+ },
+ ]);
+ });
+
+ test("batch updates worksheet folder paths without display filters", async () => {
+ const { provideSheetContext, useSheetContext } = await import("./context");
+ let sheetContext: ReturnType<typeof useSheetContext> | undefined;
+
+ const Probe = () => {
+ provideSheetContext();
+ sheetContext = useSheetContext();
+ return null;
+ };
+
+ root = createRoot(container);
+ await act(async () => {
+ root.render(<Probe />);
+ });
+ act(() => {
+ sheetContext!.setFilter({
+ ...sheetContext!.filter,
+ keyword: "Payroll",
+ onlyShowStarred: true,
+ });
+ });
+
+ await act(async () => {
+ await sheetContext!.batchUpdateWorksheetFolderPaths("my", [
+ { sourceFolder: ["old"], targetFolder: ["new"] },
+ { sourceFolder: ["old", "child"], targetFolder: ["new", "child"] },
+ ]);
+ });
+
+ expect(
+ mocks.getAppState().batchUpdateWorksheetOrganizers
+ ).toHaveBeenCalledWith([
+ {
+ parent: "projects/proj1",
+ filter:
+ 'creator == "users/[email protected]" && folder == "old/child"',
+ organizer: { folders: ["new", "child"] },
+ updateMask: ["folders"],
+ },
+ {
+ parent: "projects/proj1",
+ filter: 'creator == "users/[email protected]" && folder == "old"',
+ organizer: { folders: ["new"] },
+ updateMask: ["folders"],
+ },
+ ]);
+ });
+});
diff --git a/frontend/src/modules/sql-editor/model/Sheet/context.ts b/frontend/src/modules/sql-editor/model/Sheet/context.ts
index a60d3b6d55..99a1fe4d7d 100644
--- a/frontend/src/modules/sql-editor/model/Sheet/context.ts
+++ b/frontend/src/modules/sql-editor/model/Sheet/context.ts
@@ -1,6 +1,6 @@
import Emittery from "emittery";
import { enableMapSet } from "immer";
-import { debounce, isEqual, orderBy, sortBy } from "lodash-es";
+import { debounce, isEqual, sortBy } from "lodash-es";
import scrollIntoView from "scroll-into-view-if-needed";
import { create, type StoreApi, type UseBoundStore } from "zustand";
import { immer } from "zustand/middleware/immer";
@@ -25,6 +25,7 @@ import {
Worksheet_Visibility,
} from "@/types/proto-es/v1/worksheet_service_pb";
import {
+ getDefaultPagination,
getSheetStatement,
isWorksheetReadableV1,
storageKeySqlEditorWorksheetFilter,
@@ -32,6 +33,7 @@ import {
storageKeySqlEditorWorksheetTree,
workspaceCacheScope,
} from "@/utils";
+import { escapeCELStringLiteral } from "@/utils/v1/cel";
import { isSubFolder } from "./folder";
import { type SheetViewMode, SheetViewModeList } from "./types";
@@ -54,6 +56,8 @@ export interface WorksheetFolderNode {
editable: boolean;
isLeaf?: boolean;
empty?: boolean;
+ loadMore?: boolean;
+ loadMoreFolderKey?: string;
worksheet?: WorksheetLikeItem;
children: WorksheetFolderNode[];
[key: string]: unknown;
@@ -76,6 +80,7 @@ export interface FolderContext {
removeFolder: (path: string) => void;
moveFolder: (from: string, to: string) => void;
mergeFolders: (paths: Set<string>) => void;
+ replaceFolders: (paths: Set<string>) => void;
isSubFolder: (args: {
parent: string;
path: string;
@@ -95,6 +100,11 @@ export interface ViewContext {
folderContext: FolderContext;
events: SheetTreeEvents;
fetchSheetList: () => Promise<void>;
+ fetchNextPage: (folderKey?: string) => Promise<void>;
+ fetchWorksheetsByFolder: (folderKey: string) => Promise<void>;
+ hasMore: boolean;
+ hasMoreForFolder: (folderKey: string) => boolean;
+ isFetchingNextPage: boolean;
rebuildTree: () => void;
getKeyForWorksheet: (worksheet: WorksheetLikeItem) => string;
getFoldersForWorksheet: (path: string) => string[];
@@ -102,6 +112,11 @@ export interface ViewContext {
getPwdForWorksheet: (worksheet: { folders: string[] }) => string;
}
+export type WorksheetFolderPathUpdate = {
+ sourceFolder: string[];
+ targetFolder: string[];
+};
+
// ---- internal Zustand store ------------------------------------------------
const INITIAL_FILTER: WorksheetFilter = {
@@ -114,9 +129,15 @@ const INITIAL_FILTER: WorksheetFilter = {
interface ViewState {
isLoading: boolean;
+ isFetchingNextPage: boolean;
isInitialized: boolean;
sheetTree: WorksheetFolderNode;
folders: string[];
+ worksheetNames: string[];
+ nextPageToken: string;
+ folderNextPageTokens: Map<string, string>;
+ fetchingFolderKeys: Set<string>;
+ fetchedFolderKeys: Set<string>;
}
interface SheetContextState {
@@ -139,9 +160,34 @@ interface SheetContextState {
next: { node: WorksheetFolderNode; rawLabel: string } | undefined
) => void;
setViewIsLoading: (view: SheetViewMode, loading: boolean) => void;
+ setViewIsFetchingNextPage: (view: SheetViewMode, loading: boolean) => void;
setViewIsInitialized: (view: SheetViewMode, initialized: boolean) => void;
setViewSheetTree: (view: SheetViewMode, tree: WorksheetFolderNode) => void;
setViewFolders: (view: SheetViewMode, folders: string[]) => void;
+ setViewWorksheetNames: (view: SheetViewMode, names: string[]) => void;
+ setViewNextPageToken: (view: SheetViewMode, token: string) => void;
+ setViewFolderNextPageToken: (
+ view: SheetViewMode,
+ folderKey: string,
+ token: string
+ ) => void;
+ resetViewFolderPageState: (view: SheetViewMode) => void;
+ setViewFolderFetching: (
+ view: SheetViewMode,
+ folderKey: string,
+ fetching: boolean
+ ) => void;
+ setViewFolderFetched: (view: SheetViewMode, folderKey: string) => void;
+ invalidateViewPageState: (
+ view: SheetViewMode,
+ folderKeys: Iterable<string>
+ ) => void;
+ moveViewFolderPageState: (
+ view: SheetViewMode,
+ fromPath: string,
+ toPath: string,
+ merge: boolean
+ ) => void;
/** Replace the entire state (used by project / user-scope reload). */
hydrate: (next: Partial<SheetContextState>) => void;
}
@@ -158,9 +204,15 @@ const emptyRootNode = (view: SheetViewMode): WorksheetFolderNode => ({
const emptyViewState = (view: SheetViewMode): ViewState => ({
isLoading: false,
+ isFetchingNextPage: false,
isInitialized: false,
sheetTree: emptyRootNode(view),
folders: [rootPathFor(view)],
+ worksheetNames: [],
+ nextPageToken: "",
+ folderNextPageTokens: new Map<string, string>(),
+ fetchingFolderKeys: new Set<string>(),
+ fetchedFolderKeys: new Set<string>(),
});
const initialViewStates: Record<SheetViewMode, ViewState> = {
@@ -214,6 +266,11 @@ const useSheetContextStore: UseBoundStore<StoreApi<SheetContextState>> =
s.viewStates[view].isLoading = loading;
});
},
+ setViewIsFetchingNextPage(view, loading) {
+ set((s) => {
+ s.viewStates[view].isFetchingNextPage = loading;
+ });
+ },
setViewIsInitialized(view, initialized) {
set((s) => {
s.viewStates[view].isInitialized = initialized;
@@ -229,6 +286,109 @@ const useSheetContextStore: UseBoundStore<StoreApi<SheetContextState>> =
s.viewStates[view].folders = folders;
});
},
+ setViewWorksheetNames(view, names) {
+ set((s) => {
+ s.viewStates[view].worksheetNames = names;
+ });
+ },
+ setViewNextPageToken(view, token) {
+ set((s) => {
+ s.viewStates[view].nextPageToken = token;
+ });
+ },
+ setViewFolderNextPageToken(view, folderKey, token) {
+ set((s) => {
+ if (token) {
+ s.viewStates[view].folderNextPageTokens.set(folderKey, token);
+ } else {
+ s.viewStates[view].folderNextPageTokens.delete(folderKey);
+ }
+ });
+ },
+ resetViewFolderPageState(view) {
+ set((s) => {
+ s.viewStates[view].folderNextPageTokens.clear();
+ s.viewStates[view].fetchingFolderKeys.clear();
+ s.viewStates[view].fetchedFolderKeys.clear();
+ });
+ },
+ setViewFolderFetching(view, folderKey, fetching) {
+ set((s) => {
+ if (fetching) {
+ s.viewStates[view].fetchingFolderKeys.add(folderKey);
+ } else {
+ s.viewStates[view].fetchingFolderKeys.delete(folderKey);
+ }
+ });
+ },
+ setViewFolderFetched(view, folderKey) {
+ set((s) => {
+ s.viewStates[view].fetchedFolderKeys.add(folderKey);
+ });
+ },
+ invalidateViewPageState(view, folderKeys) {
+ set((s) => {
+ const viewState = s.viewStates[view];
+ const rootPath = rootPathFor(view);
+ const folderContext = getFolderContext(view);
+ for (const folderKey of folderKeys) {
+ const key = folderContext.ensureFolderPath(folderKey);
+ if (key === rootPath) {
+ viewState.nextPageToken = "";
+ continue;
+ }
+ viewState.folderNextPageTokens.delete(key);
+ viewState.fetchingFolderKeys.delete(key);
+ viewState.fetchedFolderKeys.delete(key);
+ }
+ });
+ },
+ moveViewFolderPageState(view, fromPath, toPath, merge) {
+ const moveKey = (key: string) => {
+ if (key === fromPath) return toPath;
+ if (isSubFolder({ parent: fromPath, path: key, dig: true })) {
+ return key.replace(fromPath, toPath);
+ }
+ return key;
+ };
+ set((s) => {
+ const viewState = s.viewStates[view];
+ if (merge) {
+ const shouldInvalidate = (key: string) =>
+ key === fromPath ||
+ key === toPath ||
+ isSubFolder({ parent: fromPath, path: key, dig: true }) ||
+ isSubFolder({ parent: toPath, path: key, dig: true });
+ viewState.folderNextPageTokens = new Map(
+ [...viewState.folderNextPageTokens.entries()].filter(
+ ([key]) => !shouldInvalidate(key)
+ )
+ );
+ viewState.fetchingFolderKeys = new Set(
+ [...viewState.fetchingFolderKeys].filter(
+ (key) => !shouldInvalidate(key)
+ )
+ );
+ viewState.fetchedFolderKeys = new Set(
+ [...viewState.fetchedFolderKeys].filter(
+ (key) => !shouldInvalidate(key)
+ )
+ );
+ return;
+ }
+ viewState.folderNextPageTokens = new Map(
+ [...viewState.folderNextPageTokens.entries()].map(
+ ([key, token]) => [moveKey(key), token]
+ )
+ );
+ viewState.fetchingFolderKeys = new Set(
+ [...viewState.fetchingFolderKeys].map(moveKey)
+ );
+ viewState.fetchedFolderKeys = new Set(
+ [...viewState.fetchedFolderKeys].map(moveKey)
+ );
+ });
+ },
hydrate(next) {
set((s) => {
Object.assign(s, next);
@@ -327,23 +487,11 @@ const reloadFromStorage = () => {
shared: emptyViewState("shared"),
draft: emptyViewState("draft"),
};
-
- for (const view of ["my", "shared", "draft"] as const) {
- const folders = safeReadJSON<string[]>(
- storageKeySqlEditorWorksheetFolder(
- scope.wsScope,
- scope.project,
- view,
- scope.email
- ),
- (v) =>
- Array.isArray(v) && v.every((entry) => typeof entry === "string")
- ? (v as string[])
- : undefined
- );
- const set = new Set(folders ?? []);
- set.add(rootPathFor(view));
- viewStates[view].folders = sortBy([...set]);
+ for (const view of SheetViewModeList) {
+ viewStates[view].folders = sortBy([
+ rootPathFor(view),
+ ...readPersistedFolders(view),
+ ]);
}
useSheetContextStore.getState().hydrate({
@@ -377,18 +525,74 @@ const persistExpandedKeys = (keys: Set<string>) => {
);
};
-const persistViewFolders = (view: SheetViewMode, folders: string[]) => {
+const persistedFolderStorageKey = (view: SheetViewMode): string | undefined => {
const scope = currentScope();
- if (!scope) return;
- safeWriteJSON(
- storageKeySqlEditorWorksheetFolder(
- scope.wsScope,
- scope.project,
- view,
- scope.email
- ),
- folders
+ if (!scope) return undefined;
+ return storageKeySqlEditorWorksheetFolder(
+ scope.wsScope,
+ scope.project,
+ view,
+ scope.email
+ );
+};
+
+const readPersistedFolders = (view: SheetViewMode): Set<string> => {
+ const key = persistedFolderStorageKey(view);
+ if (!key) return new Set();
+ const folders = safeReadJSON<string[]>(key, (v) =>
+ Array.isArray(v) && v.every((entry) => typeof entry === "string")
+ ? (v as string[])
+ : undefined
+ );
+ return new Set(
+ (folders ?? []).map((folder) => ensureFolderPath(view, folder))
+ );
+};
+
+const writePersistedFolders = (view: SheetViewMode, folders: Set<string>) => {
+ const key = persistedFolderStorageKey(view);
+ if (!key) return;
+ const root = rootPathFor(view);
+ safeWriteJSON(key, sortBy([...folders].filter((folder) => folder !== root)));
+};
+
+const addPersistedFolder = (view: SheetViewMode, path: string) => {
+ const folders = readPersistedFolders(view);
+ folders.add(ensureFolderPath(view, path));
+ writePersistedFolders(view, folders);
+};
+
+const removePersistedFolder = (view: SheetViewMode, path: string) => {
+ const folderContext = getFolderContext(view);
+ const target = folderContext.ensureFolderPath(path);
+ const folders = readPersistedFolders(view);
+ const next = new Set(
+ [...folders].filter(
+ (folder) =>
+ folder !== target &&
+ !folderContext.isSubFolder({ parent: target, path: folder, dig: true })
+ )
+ );
+ writePersistedFolders(view, next);
+};
+
+const movePersistedFolder = (view: SheetViewMode, from: string, to: string) => {
+ const folderContext = getFolderContext(view);
+ const fromPath = folderContext.ensureFolderPath(from);
+ const toPath = folderContext.ensureFolderPath(to);
+ const folders = readPersistedFolders(view);
+ const next = new Set(
+ [...folders].map((folder) => {
+ if (folder === fromPath) return toPath;
+ if (
+ folderContext.isSubFolder({ parent: fromPath, path: folder, dig: true })
+ ) {
+ return folder.replace(fromPath, toPath);
+ }
+ return folder;
+ })
);
+ writePersistedFolders(view, next);
};
// ---- per-view helpers + folder context -------------------------------------
@@ -463,7 +667,7 @@ const buildFolderContext = (view: SheetViewMode): FolderContext => {
set.add(newPath);
const next = sortBy([...set]);
useSheetContextStore.getState().setViewFolders(view, next);
- persistViewFolders(view, next);
+ addPersistedFolder(view, newPath);
return newPath;
},
removeFolder(path) {
@@ -476,12 +680,13 @@ const buildFolderContext = (view: SheetViewMode): FolderContext => {
)
);
useSheetContextStore.getState().setViewFolders(view, next);
- persistViewFolders(view, next);
+ removePersistedFolder(view, path);
},
moveFolder(from, to) {
const fromPath = ensureFolderPath(view, from);
const toPath = ensureFolderPath(view, to);
const current = useSheetContextStore.getState().viewStates[view].folders;
+ const merge = current.includes(toPath);
const next = current.map((path) => {
if (path === fromPath) return toPath;
if (isSubFolder({ parent: fromPath, path, dig: true })) {
@@ -491,7 +696,10 @@ const buildFolderContext = (view: SheetViewMode): FolderContext => {
});
const deduped = sortBy([...new Set(next)]);
useSheetContextStore.getState().setViewFolders(view, deduped);
- persistViewFolders(view, deduped);
+ useSheetContextStore
+ .getState()
+ .moveViewFolderPageState(view, fromPath, toPath, merge);
+ movePersistedFolder(view, fromPath, toPath);
},
mergeFolders(paths) {
const current = useSheetContextStore.getState().viewStates[view].folders;
@@ -505,7 +713,20 @@ const buildFolderContext = (view: SheetViewMode): FolderContext => {
!next.every((p, i) => current[i] === p)
) {
useSheetContextStore.getState().setViewFolders(view, next);
- persistViewFolders(view, next);
+ }
+ },
+ replaceFolders(paths) {
+ const current = useSheetContextStore.getState().viewStates[view].folders;
+ const set = new Set<string>([rootPath]);
+ for (const folder of paths.values()) {
+ set.add(ensureFolderPath(view, folder));
+ }
+ const next = sortBy([...set]);
+ if (
+ next.length !== current.length ||
+ !next.every((p, i) => current[i] === p)
+ ) {
+ useSheetContextStore.getState().setViewFolders(view, next);
}
},
isSubFolder,
@@ -573,7 +794,8 @@ const buildTree = (
view: SheetViewMode,
parent: WorksheetFolderNode,
worksheetsByFolder: Map<string, WorksheetLikeItem[]>,
- hideEmpty: boolean
+ hideEmpty: boolean,
+ includeLoadMore = true
): WorksheetFolderNode => {
const folderContext = getFolderContext(view);
const subfolders: WorksheetFolderNode[] = folderContext
@@ -588,7 +810,13 @@ const buildTree = (
let empty = true;
for (const childNode of subfolders) {
- const subtree = buildTree(view, childNode, worksheetsByFolder, hideEmpty);
+ const subtree = buildTree(
+ view,
+ childNode,
+ worksheetsByFolder,
+ hideEmpty,
+ includeLoadMore
+ );
if (!subtree.empty || !hideEmpty) {
parent.children.push(subtree);
}
@@ -597,9 +825,8 @@ const buildTree = (
}
}
- const sheets = orderBy(
- worksheetsByFolder.get(parent.key) ?? [],
- (item) => item.title
+ const sheets = (
+ worksheetsByFolder.get(parent.key) ?? []
).map<WorksheetFolderNode>((worksheet) => ({
isLeaf: true,
key: getKeyForWorksheet(view, worksheet),
@@ -610,6 +837,25 @@ const buildTree = (
}));
parent.children.push(...sheets);
+ const viewState = useSheetContextStore.getState().viewStates[view];
+ const isRoot = parent.key === folderContext.rootPath;
+ const hasMore = isRoot
+ ? !!viewState.nextPageToken
+ : viewState.folderNextPageTokens.has(parent.key);
+ if (includeLoadMore && hasMore) {
+ const loadMoreNode: WorksheetFolderNode = {
+ key: `${parent.key}/__load-more`,
+ label: i18n.t("common.load-more"),
+ editable: false,
+ isLeaf: true,
+ loadMore: true,
+ children: [],
+ };
+ if (!isRoot) {
+ loadMoreNode.loadMoreFolderKey = parent.key;
+ }
+ parent.children.push(loadMoreNode);
+ }
parent.empty = sheets.length === 0 && empty;
if (parent.key !== folderContext.rootPath) {
parent.isLeaf = parent.children.length === 0;
@@ -628,10 +874,14 @@ const worksheetsForView = (view: SheetViewMode): Worksheet[] => {
// the previous Pinia path had.
const email = useAppStore.getState().currentUser?.email ?? "";
const creator = `users/${email}`;
- let list = useAppStore
+ const appState = useAppStore.getState();
+ let list = useSheetContextStore
.getState()
- .worksheetList()
- .filter((sheet) => {
+ .viewStates[view].worksheetNames.map((name) =>
+ appState.getWorksheetByName(name)
+ )
+ .filter((sheet): sheet is Worksheet => {
+ if (!sheet) return false;
if (sheet.project !== project) return false;
const mine = sheet.creator === creator;
return view === "my" ? mine : !mine;
@@ -707,28 +957,19 @@ const fetchSheetListFor = async (view: SheetViewMode) => {
const state = useSheetContextStore.getState();
state.setViewIsLoading(view, true);
try {
- const sheetStore = useAppStore.getState();
- const email = sheetStore.currentUser?.email ?? "";
- const project = getSQLEditorEditorState().project;
- switch (view) {
- case "my":
- await sheetStore.fetchWorksheetList(
- project,
- `creator == "users/${email}"`
- );
- break;
- case "shared":
- await sheetStore.fetchWorksheetList(
- project,
- [
- `creator != "users/${email}"`,
- `visibility in ["${Worksheet_Visibility[Worksheet_Visibility.PROJECT_READ]}","${Worksheet_Visibility[Worksheet_Visibility.PROJECT_WRITE]}"]`,
- ].join(" && ")
- );
- break;
- default:
- break;
- }
+ state.resetViewFolderPageState(view);
+ await fetchWorksheetFoldersForView(view);
+ const rootFilters = hasWorksheetServerFilter() ? [] : [`folder == ""`];
+ const { worksheets, nextPageToken } = await fetchWorksheetsPage(
+ view,
+ "",
+ rootFilters
+ );
+ state.setViewWorksheetNames(
+ view,
+ worksheets.map((worksheet) => worksheet.name)
+ );
+ state.setViewNextPageToken(view, nextPageToken);
rebuildTreeImpl(view);
state.setViewIsInitialized(view, true);
} finally {
@@ -736,12 +977,219 @@ const fetchSheetListFor = async (view: SheetViewMode) => {
}
};
+const fetchSheetListDebounced: Partial<Record<SheetViewMode, () => void>> = {};
+const getFetchSheetListFn = (view: SheetViewMode): (() => void) => {
+ const existed = fetchSheetListDebounced[view];
+ if (existed) return existed;
+ const debounced = debounce(() => {
+ void fetchSheetListFor(view);
+ }, DEBOUNCE_SEARCH_DELAY);
+ fetchSheetListDebounced[view] = debounced;
+ return debounced;
+};
+
+const fetchNextSheetPageFor = async (
+ view: SheetViewMode,
+ folderKey?: string
+) => {
+ const state = useSheetContextStore.getState();
+ const viewState = state.viewStates[view];
+ const folderContext = getFolderContext(view);
+ const key = folderKey
+ ? folderContext.ensureFolderPath(folderKey)
+ : rootPathFor(view);
+ const pageToken =
+ key === folderContext.rootPath
+ ? viewState.nextPageToken
+ : viewState.folderNextPageTokens.get(key) || "";
+ if (
+ (view !== "my" && view !== "shared") ||
+ !pageToken ||
+ viewState.isFetchingNextPage ||
+ viewState.isLoading
+ ) {
+ return;
+ }
+
+ state.setViewIsFetchingNextPage(view, true);
+ try {
+ const { worksheets, nextPageToken } = await fetchWorksheetsPage(
+ view,
+ pageToken,
+ key === folderContext.rootPath && hasWorksheetServerFilter()
+ ? []
+ : [folderFilterForKey(view, key)]
+ );
+ const names = new Set(
+ useSheetContextStore.getState().viewStates[view].worksheetNames
+ );
+ for (const worksheet of worksheets) {
+ names.add(worksheet.name);
+ }
+ state.setViewWorksheetNames(view, [...names]);
+ if (key === folderContext.rootPath) {
+ state.setViewNextPageToken(view, nextPageToken);
+ } else {
+ state.setViewFolderNextPageToken(view, key, nextPageToken);
+ }
+ rebuildTreeImpl(view);
+ } finally {
+ state.setViewIsFetchingNextPage(view, false);
+ }
+};
+
+const folderFilterForKey = (view: SheetViewMode, folderKey: string): string => {
+ const folderContext = getFolderContext(view);
+ const key = folderContext.ensureFolderPath(folderKey);
+ if (key === folderContext.rootPath) {
+ return `folder == ""`;
+ }
+ const folder = getFoldersForWorksheet(view, key).join("/");
+ return `folder == "${escapeCELStringLiteral(folder)}"`;
+};
+
+const worksheetSearchFilters = (): string[] => {
+ const filter = useSheetContextStore.getState().filter;
+ const filters: string[] = [];
+ const keyword = filter.keyword.trim().toLowerCase();
+ if (keyword) {
+ filters.push(`title.contains("${escapeCELStringLiteral(keyword)}")`);
+ }
+ if (filter.onlyShowStarred) {
+ filters.push("starred == true");
+ }
+ return filters;
+};
+
+const hasWorksheetServerFilter = (): boolean =>
+ worksheetSearchFilters().length > 0;
+
+const sheetFilterForView = (
+ view: SheetViewMode,
+ extraFilters: string[] = [],
+ includeDisplayFilters = true
+): string => {
+ const email = useAppStore.getState().currentUser?.email ?? "";
+ const baseFilters =
+ view === "my"
+ ? [`creator == "users/${escapeCELStringLiteral(email)}"`]
+ : [
+ `creator != "users/${escapeCELStringLiteral(email)}"`,
+ `visibility in ["${Worksheet_Visibility[Worksheet_Visibility.PROJECT_READ]}","${Worksheet_Visibility[Worksheet_Visibility.PROJECT_WRITE]}"]`,
+ ];
+ return [
+ ...baseFilters,
+ ...extraFilters,
+ ...(includeDisplayFilters ? worksheetSearchFilters() : []),
+ ].join(" && ");
+};
+
+const fetchWorksheetsPage = async (
+ view: SheetViewMode,
+ pageToken: string,
+ extraFilters: string[] = []
+): Promise<{ worksheets: Worksheet[]; nextPageToken: string }> => {
+ if (view !== "my" && view !== "shared") {
+ return { worksheets: [], nextPageToken: "" };
+ }
+ const sheetStore = useAppStore.getState();
+ const project = getSQLEditorEditorState().project;
+ const filter = sheetFilterForView(view, extraFilters);
+ return sheetStore.fetchWorksheetList(project, filter, {
+ pageSize: getDefaultPagination(),
+ pageToken,
+ });
+};
+
+const fetchWorksheetFoldersForView = async (view: SheetViewMode) => {
+ if (view !== "my" && view !== "shared") {
+ return;
+ }
+ const project = getSQLEditorEditorState().project;
+ const paths = await useAppStore.getState().listWorksheetFolders(project);
+ const folderPaths = new Set<string>();
+ for (const { folders, category } of paths) {
+ if (category !== view) {
+ continue;
+ }
+ for (const path of getPathesForWorksheet(view, { folders })) {
+ folderPaths.add(path);
+ }
+ }
+ for (const path of readPersistedFolders(view)) {
+ folderPaths.add(path);
+ }
+ getFolderContext(view).replaceFolders(folderPaths);
+};
+
+const fetchWorksheetsByFolder = async (
+ view: SheetViewMode,
+ folderKey: string
+) => {
+ if (view !== "my" && view !== "shared") {
+ return;
+ }
+ const folderContext = getFolderContext(view);
+ const key = folderContext.ensureFolderPath(folderKey);
+ if (key === folderContext.rootPath) {
+ return;
+ }
+
+ const state = useSheetContextStore.getState();
+ const viewState = state.viewStates[view];
+ if (
+ viewState.fetchingFolderKeys.has(key) ||
+ viewState.fetchedFolderKeys.has(key)
+ ) {
+ return;
+ }
+
+ const folder = getFoldersForWorksheet(view, key).join("/");
+ if (!folder) {
+ return;
+ }
+
+ state.setViewFolderFetching(view, key, true);
+ try {
+ const { worksheets, nextPageToken } = await fetchWorksheetsPage(view, "", [
+ `folder == "${escapeCELStringLiteral(folder)}"`,
+ ]);
+ const names = new Set(
+ useSheetContextStore.getState().viewStates[view].worksheetNames
+ );
+ for (const worksheet of worksheets) {
+ names.add(worksheet.name);
+ }
+ useSheetContextStore.getState().setViewWorksheetNames(view, [...names]);
+ useSheetContextStore
+ .getState()
+ .setViewFolderNextPageToken(view, key, nextPageToken);
+ useSheetContextStore.getState().setViewFolderFetched(view, key);
+ rebuildTreeImpl(view);
+ } finally {
+ useSheetContextStore.getState().setViewFolderFetching(view, key, false);
+ }
+};
+
const buildViewContext = (view: SheetViewMode): ViewContext => {
const folderContext = getFolderContext(view);
return {
get isLoading() {
return useSheetContextStore.getState().viewStates[view].isLoading;
},
+ get isFetchingNextPage() {
+ return useSheetContextStore.getState().viewStates[view]
+ .isFetchingNextPage;
+ },
+ get hasMore() {
+ return !!useSheetContextStore.getState().viewStates[view].nextPageToken;
+ },
+ hasMoreForFolder(folderKey) {
+ const key = folderContext.ensureFolderPath(folderKey);
+ return !!useSheetContextStore
+ .getState()
+ .viewStates[view].folderNextPageTokens.get(key);
+ },
get isInitialized() {
return useSheetContextStore.getState().viewStates[view].isInitialized;
},
@@ -753,11 +1201,14 @@ const buildViewContext = (view: SheetViewMode): ViewContext => {
...rootTreeNodeFor(view),
key: folderContext.rootPath,
};
- return buildTree(view, root, new Map(), false);
+ return buildTree(view, root, new Map(), false, false);
},
folderContext,
events: getEvents(view),
fetchSheetList: () => fetchSheetListFor(view),
+ fetchNextPage: (folderKey) => fetchNextSheetPageFor(view, folderKey),
+ fetchWorksheetsByFolder: (folderKey) =>
+ fetchWorksheetsByFolder(view, folderKey),
rebuildTree: () => getRebuildTreeFn(view)(),
getKeyForWorksheet: (ws) => getKeyForWorksheet(view, ws),
getFoldersForWorksheet: (path) => getFoldersForWorksheet(view, path),
@@ -783,15 +1234,126 @@ const isWorksheetCreator = (worksheet: { creator: string }) => {
return worksheet.creator === `users/${email}`;
};
+const viewForWorksheet = (worksheet: Worksheet): SheetViewMode | undefined => {
+ const project = getSQLEditorEditorState().project;
+ if (worksheet.project !== project) return undefined;
+ if (isWorksheetCreator(worksheet)) return "my";
+ if (
+ worksheet.visibility === Worksheet_Visibility.PROJECT_READ ||
+ worksheet.visibility === Worksheet_Visibility.PROJECT_WRITE
+ ) {
+ return "shared";
+ }
+ return undefined;
+};
+
+const addNewWorksheetsToViewMembership = (
+ worksheetsByKey: Record<string, Worksheet>,
+ prevWorksheetsByKey: Record<string, Worksheet>
+) => {
+ const prevNames = new Set(
+ Object.values(prevWorksheetsByKey).map((worksheet) => worksheet.name)
+ );
+ for (const worksheet of Object.values(worksheetsByKey)) {
+ if (prevNames.has(worksheet.name)) continue;
+ const view = viewForWorksheet(worksheet);
+ if (!view) continue;
+ const state = useSheetContextStore.getState();
+ const viewState = state.viewStates[view];
+ if (
+ !viewState.isInitialized ||
+ viewState.worksheetNames.includes(worksheet.name)
+ ) {
+ continue;
+ }
+ state.setViewWorksheetNames(view, [
+ ...viewState.worksheetNames,
+ worksheet.name,
+ ]);
+ }
+};
+
const batchUpdateWorksheetFolders = async (
worksheets: { name: string; folders: string[] }[]
): Promise<void> => {
- if (worksheets.length === 0) return;
- await useAppStore.getState().batchUpsertWorksheetOrganizers(
- worksheets.map((worksheet) => ({
- organizer: {
- worksheet: worksheet.name,
+ const affectedFolderKeysByView = new Map<SheetViewMode, Set<string>>();
+ const addAffectedFolderKey = (view: SheetViewMode, folderKey: string) => {
+ const keys = affectedFolderKeysByView.get(view) ?? new Set<string>();
+ keys.add(folderKey);
+ affectedFolderKeysByView.set(view, keys);
+ };
+
+ const requestByKey = new Map<
+ string,
+ { parent: string; folders: string[]; names: string[] }
+ >();
+ for (const worksheet of worksheets) {
+ const current = useAppStore.getState().getWorksheetByName(worksheet.name);
+ const view = current ? viewForWorksheet(current) : undefined;
+ if (current && (view === "my" || view === "shared")) {
+ addAffectedFolderKey(view, getPwdForWorksheet(view, current));
+ addAffectedFolderKey(view, getPwdForWorksheet(view, worksheet));
+ }
+
+ const index = worksheet.name.lastIndexOf("/worksheets/");
+ if (index < 0) {
+ continue;
+ }
+ const parent = worksheet.name.slice(0, index);
+ const key = JSON.stringify([parent, worksheet.folders]);
+ const request = requestByKey.get(key);
+ if (request) {
+ request.names.push(worksheet.name);
+ } else {
+ requestByKey.set(key, {
+ parent,
folders: worksheet.folders,
+ names: [worksheet.name],
+ });
+ }
+ }
+ const requests = [...requestByKey.values()];
+ if (requests.length === 0) return;
+ await useAppStore.getState().batchUpdateWorksheetOrganizers(
+ requests.map((request) => ({
+ parent: request.parent,
+ filter: `name in [${request.names
+ .map((name) => '"' + escapeCELStringLiteral(name) + '"')
+ .join(",")}]`,
+ organizer: {
+ folders: request.folders,
+ },
+ updateMask: ["folders"],
+ }))
+ );
+ for (const [view, folderKeys] of affectedFolderKeysByView) {
+ useSheetContextStore.getState().invalidateViewPageState(view, folderKeys);
+ rebuildTreeImpl(view);
+ }
+};
+
+const batchUpdateWorksheetFolderPaths = async (
+ view: SheetViewMode,
+ updates: WorksheetFolderPathUpdate[]
+): Promise<void> => {
+ if (view !== "my" && view !== "shared") return;
+ if (updates.length === 0) return;
+ const project = getSQLEditorEditorState().project;
+ const sortedUpdates = [...updates].sort(
+ (a, b) => b.sourceFolder.length - a.sourceFolder.length
+ );
+ await useAppStore.getState().batchUpdateWorksheetOrganizers(
+ sortedUpdates.map((update) => ({
+ parent: project,
+ filter: sheetFilterForView(
+ view,
+ [
+ `folder == "${escapeCELStringLiteral(update.sourceFolder.join("/"))}"`,
+ ],
+ false
+ ),
+ organizer: {
+ folders: update.targetFolder,
},
updateMask: ["folders"],
}))
@@ -842,15 +1404,15 @@ const bindWatchers = () => {
if (state.expandedKeys !== prev.expandedKeys)
persistExpandedKeys(state.expandedKeys);
- // Rebuild the worksheet-backed trees when `onlyShowStarred` toggles
- // — it changes both the worksheet list (`worksheetsForView` filters
- // to starred) and the `hideEmpty` pass inside `buildTree`. Mirrors
- // the Vue `watch(filter, rebuildTree)`. Keyword filtering is applied
- // component-side (SheetTree's `nodeMatches`), so it doesn't need a
- // rebuild here.
- if (state.filter.onlyShowStarred !== prev.filter.onlyShowStarred) {
- getRebuildTreeFn("my")();
- getRebuildTreeFn("shared")();
+ if (
+ state.filter.keyword !== prev.filter.keyword ||
+ state.filter.onlyShowStarred !== prev.filter.onlyShowStarred
+ ) {
+ for (const view of ["my", "shared"] as const) {
+ if (state.viewStates[view].isInitialized) {
+ getFetchSheetListFn(view)();
+ }
+ }
}
// Rebuild a view's tree when its folder set changes (add / remove /
@@ -896,6 +1458,10 @@ const bindWatchers = () => {
// burst of cache writes a single fetch produces.
useAppStore.subscribe((state, prev) => {
if (state.worksheetsByKey === prev.worksheetsByKey) return;
+ addNewWorksheetsToViewMembership(
+ state.worksheetsByKey,
+ prev.worksheetsByKey
+ );
getRebuildTreeFn("my")();
getRebuildTreeFn("shared")();
});
@@ -978,6 +1544,10 @@ export interface SheetContext {
batchUpdateWorksheetFolders: (
worksheets: { name: string; folders: string[] }[]
) => Promise<void>;
+ batchUpdateWorksheetFolderPaths: (
+ view: SheetViewMode,
+ updates: WorksheetFolderPathUpdate[]
+ ) => Promise<void>;
getContextByView: (view: SheetViewMode) => ViewContext;
setFilter: SheetContextState["setFilter"];
setView: SheetContextState["setView"];
@@ -1040,6 +1610,7 @@ export function useSheetContext(): SheetContext {
viewContexts: VIEW_CONTEXTS_LAZY,
isWorksheetCreator,
batchUpdateWorksheetFolders,
+ batchUpdateWorksheetFolderPaths,
getContextByView: getViewContext,
setFilter: setFilterAction,
setView: setViewAction,
diff --git a/frontend/src/stores/app/types.ts b/frontend/src/stores/app/types.ts
index 3b08260937..a7aa808ed4 100644
--- a/frontend/src/stores/app/types.ts
+++ b/frontend/src/stores/app/types.ts
@@ -627,7 +627,17 @@ export type WorksheetSlice = {
name: string,
silent?: boolean
) => Promise<Worksheet | undefined>;
- fetchWorksheetList: (parent: string, filter: string) => Promise<Worksheet[]>;
+ fetchWorksheetList: (
+ parent: string,
+ filter: string,
+ params?: {
+ pageSize?: number;
+ pageToken?: string;
+ }
+ ) => Promise<{ worksheets: Worksheet[]; nextPageToken: string }>;
+ listWorksheetFolders: (
+ parent: string
+ ) => Promise<{ folders: string[]; category: "my" | "shared" }[]>;
createWorksheet: (worksheet: Worksheet) => Promise<Worksheet>;
patchWorksheet: (
worksheet: Worksheet,
@@ -639,8 +649,13 @@ export type WorksheetSlice = {
organizer: Partial<WorksheetOrganizer>,
updateMask: string[]
) => Promise<void>;
- batchUpsertWorksheetOrganizers: (
- requests: { organizer: Partial<WorksheetOrganizer>; updateMask: string[] }[]
+ batchUpdateWorksheetOrganizers: (
+ requests: {
+ parent: string;
+ filter: string;
+ organizer: Partial<WorksheetOrganizer>;
+ updateMask: string[];
+ }[]
) => Promise<void>;
worksheetList: () => Worksheet[];
};
diff --git a/frontend/src/stores/app/worksheet.ts b/frontend/src/stores/app/worksheet.ts
index e434a8afb5..c6b11166d5 100644
--- a/frontend/src/stores/app/worksheet.ts
+++ b/frontend/src/stores/app/worksheet.ts
@@ -13,9 +13,11 @@ import {
CreateWorksheetRequestSchema,
DeleteWorksheetRequestSchema,
GetWorksheetRequestSchema,
+ ListWorksheetFoldersRequestSchema,
SearchWorksheetsRequestSchema,
UpdateWorksheetOrganizerRequestSchema,
UpdateWorksheetRequestSchema,
+ WorksheetFolder_Category,
WorksheetOrganizerSchema,
WorksheetSchema,
} from "@/types/proto-es/v1/worksheet_service_pb";
@@ -135,15 +137,43 @@ export const createWorksheetSlice: AppSliceCreator<WorksheetSlice> = (
return promise;
},
- fetchWorksheetList: async (parent, filter) => {
+ fetchWorksheetList: async (parent, filter, params = {}) => {
const response = await worksheetServiceClientConnect.searchWorksheets(
- createProto(SearchWorksheetsRequestSchema, { parent, filter })
+ createProto(SearchWorksheetsRequestSchema, {
+ parent,
+ filter,
+ pageSize: params.pageSize,
+ pageToken: params.pageToken,
+ })
);
await hydrateRelatedResources(response.worksheets);
for (const worksheet of response.worksheets) {
setCacheEntry(worksheet, "BASIC");
}
- return response.worksheets;
+ return {
+ worksheets: response.worksheets,
+ nextPageToken: response.nextPageToken,
+ };
+ },
+
+ listWorksheetFolders: async (parent) => {
+ const response = await worksheetServiceClientConnect.listWorksheetFolders(
+ createProto(ListWorksheetFoldersRequestSchema, {
+ parent,
+ })
+ );
+ const folders: { folders: string[]; category: "my" | "shared" }[] = [];
+ for (const folder of response.folders) {
+ switch (folder.category) {
+ case WorksheetFolder_Category.MINE:
+ folders.push({ folders: folder.folders, category: "my" });
+ break;
+ case WorksheetFolder_Category.SHARED:
+ folders.push({ folders: folder.folders, category: "shared" });
+ break;
+ }
+ }
+ return folders;
},
createWorksheet: async (worksheet) => {
@@ -201,21 +231,24 @@ export const createWorksheetSlice: AppSliceCreator<WorksheetSlice> = (
updateCacheWithOrganizer(response);
},
- batchUpsertWorksheetOrganizers: async (requests) => {
- const response =
- await worksheetServiceClientConnect.batchUpdateWorksheetOrganizer(
- createProto(BatchUpdateWorksheetOrganizerRequestSchema, {
- requests: requests.map((request) =>
- createProto(UpdateWorksheetOrganizerRequestSchema, {
- organizer: createProto(WorksheetOrganizerSchema, {
- ...request.organizer,
- } as WorksheetOrganizer),
- updateMask: { paths: request.updateMask },
- })
- ),
- })
- );
- response.worksheetOrganizers.map(updateCacheWithOrganizer);
+ batchUpdateWorksheetOrganizers: async (requests) => {
+ const responses = await Promise.all(
+ requests.map((request) =>
+ worksheetServiceClientConnect.batchUpdateWorksheetOrganizer(
+ createProto(BatchUpdateWorksheetOrganizerRequestSchema, {
+ parent: request.parent,
+ filter: request.filter,
+ organizer: createProto(WorksheetOrganizerSchema, {
+ ...request.organizer,
+ } as WorksheetOrganizer),
+ updateMask: { paths: request.updateMask },
+ })
+ )
+ )
+ );
+ for (const response of responses) {
+ response.worksheetOrganizers.map(updateCacheWithOrganizer);
+ }
},
// The deduped full list. Callers split into "my" / "shared" using
diff --git a/frontend/src/types/proto-es/v1/worksheet_service_pb.d.ts b/frontend/src/types/proto-es/v1/worksheet_service_pb.d.ts
index e27cfb3829..7422ea7fe4 100644
--- a/frontend/src/types/proto-es/v1/worksheet_service_pb.d.ts
+++ b/frontend/src/types/proto-es/v1/worksheet_service_pb.d.ts
@@ -139,6 +139,93 @@ export declare type ListWorksheetsResponse = Message<"bytebase.v1.ListWorksheets
*/
export declare const ListWorksheetsResponseSchema: GenMessage<ListWorksheetsResponse>;
+/**
+ * @generated from message bytebase.v1.ListWorksheetFoldersRequest
+ */
+export declare type ListWorksheetFoldersRequest = Message<"bytebase.v1.ListWorksheetFoldersRequest"> & {
+ /**
+ * The parent resource of the worksheet folders.
+ * Format: projects/{project}
+ *
+ * @generated from field: string parent = 1;
+ */
+ parent: string;
+};
+
+/**
+ * Describes the message bytebase.v1.ListWorksheetFoldersRequest.
+ * Use `create(ListWorksheetFoldersRequestSchema)` to create a new message.
+ */
+export declare const ListWorksheetFoldersRequestSchema: GenMessage<ListWorksheetFoldersRequest>;
+
+/**
+ * @generated from message bytebase.v1.ListWorksheetFoldersResponse
+ */
+export declare type ListWorksheetFoldersResponse = Message<"bytebase.v1.ListWorksheetFoldersResponse"> & {
+ /**
+ * The caller's worksheet folders.
+ *
+ * @generated from field: repeated bytebase.v1.WorksheetFolder folders = 1;
+ */
+ folders: WorksheetFolder[];
+};
+
+/**
+ * Describes the message bytebase.v1.ListWorksheetFoldersResponse.
+ * Use `create(ListWorksheetFoldersResponseSchema)` to create a new message.
+ */
+export declare const ListWorksheetFoldersResponseSchema: GenMessage<ListWorksheetFoldersResponse>;
+
+/**
+ * @generated from message bytebase.v1.WorksheetFolder
+ */
+export declare type WorksheetFolder = Message<"bytebase.v1.WorksheetFolder"> & {
+ /**
+ * The folder path segments.
+ *
+ * @generated from field: repeated string folders = 1;
+ */
+ folders: string[];
+
+ /**
+ * The folder category.
+ *
+ * @generated from field: bytebase.v1.WorksheetFolder.Category category = 2;
+ */
+ category: WorksheetFolder_Category;
+};
+
+/**
+ * Describes the message bytebase.v1.WorksheetFolder.
+ * Use `create(WorksheetFolderSchema)` to create a new message.
+ */
+export declare const WorksheetFolderSchema: GenMessage<WorksheetFolder>;
+
+/**
+ * @generated from enum bytebase.v1.WorksheetFolder.Category
+ */
+export enum WorksheetFolder_Category {
+ /**
+ * @generated from enum value: CATEGORY_UNSPECIFIED = 0;
+ */
+ CATEGORY_UNSPECIFIED = 0,
+
+ /**
+ * @generated from enum value: MINE = 1;
+ */
+ MINE = 1,
+
+ /**
+ * @generated from enum value: SHARED = 2;
+ */
+ SHARED = 2,
+}
+
+/**
+ * Describes the enum bytebase.v1.WorksheetFolder.Category.
+ */
+export declare const WorksheetFolder_CategorySchema: GenEnum<WorksheetFolder_Category>;
+
/**
* @generated from message bytebase.v1.UpdateWorksheetRequest
*/
@@ -179,9 +266,45 @@ export declare const UpdateWorksheetRequestSchema: GenMessage<UpdateWorksheetReq
*/
export declare type BatchUpdateWorksheetOrganizerRequest = Message<"bytebase.v1.BatchUpdateWorksheetOrganizerRequest"> & {
/**
- * @generated from field: repeated bytebase.v1.UpdateWorksheetOrganizerRequest requests = 1;
+ * The parent resource whose worksheets' organizers are updated.
+ * Format: projects/{project}
+ *
+ * @generated from field: string parent = 1;
+ */
+ parent: string;
+
+ /**
+ * To filter the batch update target.
+ * The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+ *
+ * Supported filter:
+ * - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
+ * - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
+ * - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
+ * - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
+ * - folder: the worksheet organizer folder path, support exact "==" operator.
+ *
+ * @generated from field: string filter = 2;
+ */
+ filter: string;
+
+ /**
+ * The organizer fields to update.
+ *
+ * @generated from field: bytebase.v1.WorksheetOrganizer organizer = 3;
*/
- requests: UpdateWorksheetOrganizerRequest[];
+ organizer?: WorksheetOrganizer | undefined;
+
+ /**
+ * The list of fields to be updated.
+ * Fields are specified relative to the worksheet organizer.
+ * Only support update the following fields for now:
+ * - `starred`
+ * - `folders`
+ *
+ * @generated from field: google.protobuf.FieldMask update_mask = 4;
+ */
+ updateMask?: FieldMask | undefined;
};
/**
@@ -198,6 +321,11 @@ export declare type BatchUpdateWorksheetOrganizerResponse = Message<"bytebase.v1
* @generated from field: repeated bytebase.v1.WorksheetOrganizer worksheet_organizers = 1;
*/
worksheetOrganizers: WorksheetOrganizer[];
+
+ /**
+ * @generated from field: int32 updated_count = 2;
+ */
+ updatedCount: number;
};
/**
@@ -312,21 +440,44 @@ export declare type SearchWorksheetsRequest = Message<"bytebase.v1.SearchWorkshe
* The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
*
* Supported filter:
+ * - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
+ * - title: the worksheet title, support "contains" operator.
* - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
* - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
* - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
+ * - folder: the worksheet organizer folder path, support "==" operator.
*
* For example:
* creator == "users/{email}"
+ * title.contains("worksheet title")
* creator != "users/{email}"
* starred == true
* starred == false
* visibility in ["PRIVATE", "PROJECT_READ", "PROJECT_WRITE"]
* visibility == "PRIVATE"
+ * folder == "foo/bar"
*
* @generated from field: string filter = 2;
*/
filter: string;
+
+ /**
+ * The maximum number of worksheets to return. The service may return fewer than
+ * this value.
+ * If unspecified, at most 10 worksheets will be returned.
+ * The maximum value is 1000; values above 1000 will be coerced to 1000.
+ *
+ * @generated from field: int32 page_size = 3;
+ */
+ pageSize: number;
+
+ /**
+ * A page token, received from a previous `SearchWorksheets` call.
+ * Provide this to retrieve the subsequent page.
+ *
+ * @generated from field: string page_token = 4;
+ */
+ pageToken: string;
};
/**
@@ -345,6 +496,15 @@ export declare type SearchWorksheetsResponse = Message<"bytebase.v1.SearchWorksh
* @generated from field: repeated bytebase.v1.Worksheet worksheets = 1;
*/
worksheets: Worksheet[];
+
+ /**
+ * A token to retrieve next page of worksheets.
+ * Pass this value in the page_token field in the subsequent call to
+ * `SearchWorksheets` method to retrieve the next page of worksheets.
+ *
+ * @generated from field: string next_page_token = 2;
+ */
+ nextPageToken: string;
};
/**
@@ -532,6 +692,17 @@ export declare const WorksheetService: GenService<{
input: typeof ListWorksheetsRequestSchema;
output: typeof ListWorksheetsResponseSchema;
},
+ /**
+ * List the caller's worksheet folders.
+ * Only folders stored in the caller's worksheet organizer are returned.
+ *
+ * @generated from rpc bytebase.v1.WorksheetService.ListWorksheetFolders
+ */
+ listWorksheetFolders: {
+ methodKind: "unary";
+ input: typeof ListWorksheetFoldersRequestSchema;
+ output: typeof ListWorksheetFoldersResponseSchema;
+ },
/**
* Search for worksheets.
* This is used for finding my worksheets or worksheets shared by other people.
diff --git a/frontend/src/types/proto-es/v1/worksheet_service_pb.js b/frontend/src/types/proto-es/v1/worksheet_service_pb.js
index 4024db30fb..83acbb34d2 100644
--- a/frontend/src/types/proto-es/v1/worksheet_service_pb.js
+++ b/frontend/src/types/proto-es/v1/worksheet_service_pb.js
@@ -15,7 +15,7 @@ import { file_v1_annotation } from "./annotation_pb";
* Describes the file v1/worksheet_service.proto.
*/
export const file_v1_worksheet_service = /*@__PURE__*/
- fileDesc("Chp2MS93b3Jrc2hlZXRfc2VydmljZS5wcm90bxILYnl0ZWJhc2UudjEiXQoWQ3JlYXRlV29ya3NoZWV0UmVxdWVzdBITCgZwYXJlbnQYASABKAlCA+BBAhIuCgl3b3Jrc2hlZXQYAiABKAsyFi5ieXRlYmFzZS52MS5Xb3Jrc2hlZXRCA+BBAiIoChNHZXRXb3Jrc2hlZXRSZXF1ZXN0EhEKBG5hbWUYASABKAlCA+BBAiJ8ChVMaXN0V29ya3NoZWV0c1JlcXVlc3QSLAoGcGFyZW50GAEgASgJQhzgQQL6QRYKFGJ5dGViYXNlLmNvbS9Qcm9qZWN0Eg4KBmZpbHRlchgCIAEoCRIRCglwYWdlX3NpemUYAyABKAUSEgoKcGFnZV90b2tlbhgEIAEoCSJdChZMaXN0V29ya3NoZWV0c1Jlc3BvbnNlEioKCndvcmtzaGVldHMYASADKAsyFi5ieXRlYmFzZS52MS5Xb3Jrc2hlZXQSFwoPbmV4dF9wYWdlX3Rva2VuGAIgASgJInkKFlVwZGF0ZVdvcmtzaGVldFJlcXVlc3QSLgoJd29ya3NoZWV0GAEgASgLMhYuYnl0ZWJhc2UudjEuV29ya3NoZWV0QgPgQQISLwoLdXBkYXRlX21hc2sYAiABKAsyGi5nb29nbGUucHJvdG9idWYuRmllbGRNYXNrImsKJEJhdGNoVXBkYXRlV29ya3NoZWV0T3JnYW5pemVyUmVxdWVzdBJDCghyZXF1ZXN0cxgBIAMoCzIsLmJ5dGViYXNlLnYxLlVwZGF0ZVdvcmtzaGVldE9yZ2FuaXplclJlcXVlc3RCA+BBAiJmCiVCYXRjaFVwZGF0ZVdvcmtzaGVldE9yZ2FuaXplclJlc3BvbnNlEj0KFHdvcmtzaGVldF9vcmdhbml6ZXJzGAEgAygLMh8uYnl0ZWJhc2UudjEuV29ya3NoZWV0T3JnYW5pemVyIqIBCh9VcGRhdGVXb3Jrc2hlZXRPcmdhbml6ZXJSZXF1ZXN0EjcKCW9yZ2FuaXplchgBIAEoCzIfLmJ5dGViYXNlLnYxLldvcmtzaGVldE9yZ2FuaXplckID4EECEi8KC3VwZGF0ZV9tYXNrGAIgASgLMhouZ29vZ2xlLnByb3RvYnVmLkZpZWxkTWFzaxIVCg1hbGxvd19taXNzaW5nGAMgASgIIk4KEldvcmtzaGVldE9yZ2FuaXplchIWCgl3b3Jrc2hlZXQYASABKAlCA+BBAhIPCgdzdGFycmVkGAIgASgIEg8KB2ZvbGRlcnMYAyADKAkiKwoWRGVsZXRlV29ya3NoZWV0UmVxdWVzdBIRCgRuYW1lGAEgASgJQgPgQQIiPgoXU2VhcmNoV29ya3NoZWV0c1JlcXVlc3QSEwoGcGFyZW50GAEgASgJQgPgQQISDgoGZmlsdGVyGAIgASgJIkYKGFNlYXJjaFdvcmtzaGVldHNSZXNwb25zZRIqCgp3b3Jrc2hlZXRzGAEgAygLMhYuYnl0ZWJhc2UudjEuV29ya3NoZWV0ItwDCglXb3Jrc2hlZXQSFAoEbmFtZRgBIAEoCUIG4EEC4EEFEhQKB3Byb2plY3QYAiABKAlCA+BBAxIQCghkYXRhYmFzZRgDIAEoCRIaCgV0aXRsZRgEIAEoCUIL4EECukgFcgMYyAESFAoHY3JlYXRvchgFIAEoCUID4EEDEjQKC2NyZWF0ZV90aW1lGAYgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcEID4EEDEjQKC3VwZGF0ZV90aW1lGAcgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcEID4EEDEhQKB2NvbnRlbnQYCCABKAxCA+BBAhIZCgxjb250ZW50X3NpemUYCSABKANCA+BBAxI6Cgp2aXNpYmlsaXR5GAogASgOMiEuYnl0ZWJhc2UudjEuV29ya3NoZWV0LlZpc2liaWxpdHlCA+BBAhIUCgdzdGFycmVkGAsgASgIQgPgQQMSFAoHZm9sZGVycxgMIAMoCUID4EEDIloKClZpc2liaWxpdHkSGgoWVklTSUJJTElUWV9VTlNQRUNJRklFRBAAEhAKDFBST0pFQ1RfUkVBRBABEhEKDVBST0pFQ1RfV1JJVEUQAhILCgdQUklWQVRFEAMyzgoKEFdvcmtzaGVldFNlcnZpY2USnAEKD0NyZWF0ZVdvcmtzaGVldBIjLmJ5dGViYXNlLnYxLkNyZWF0ZVdvcmtzaGVldFJlcXVlc3QaFi5ieXRlYmFzZS52MS5Xb3Jrc2hlZXQiTNpBEHBhcmVudCx3b3Jrc2hlZXSQ6jACgtPkkwIvOgl3b3Jrc2hlZXQiIi92MS97cGFyZW50PXByb2plY3RzLyp9L3dvcmtzaGVldHMSfwoMR2V0V29ya3NoZWV0EiAuYnl0ZWJhc2UudjEuR2V0V29ya3NoZWV0UmVxdWVzdBoWLmJ5dGViYXNlLnYxLldvcmtzaGVldCI12kEEbmFtZZDqMAKC0+STAiQSIi92MS97bmFtZT1wcm9qZWN0cy8qL3dvcmtzaGVldHMvKn0SqAEKDkxpc3RXb3Jrc2hlZXRzEiIuYnl0ZWJhc2UudjEuTGlzdFdvcmtzaGVldHNSZXF1ZXN0GiMuYnl0ZWJhc2UudjEuTGlzdFdvcmtzaGVldHNSZXNwb25zZSJN2kEGcGFyZW50iuowEmJiLndvcmtzaGVldHMubGlzdJDqMAGC0+STAiQSIi92MS97cGFyZW50PXByb2plY3RzLyp9L3dvcmtzaGVldHMSogEKEFNlYXJjaFdvcmtzaGVldHMSJC5ieXRlYmFzZS52MS5TZWFyY2hXb3Jrc2hlZXRzUmVxdWVzdBolLmJ5dGViYXNlLnYxLlNlYXJjaFdvcmtzaGVldHNSZXNwb25zZSJB2kEGcGFyZW50kOowAoLT5JMCLjoBKiIpL3YxL3twYXJlbnQ9cHJvamVjdHMvKn0vd29ya3NoZWV0czpzZWFyY2gSqwEKD1VwZGF0ZVdvcmtzaGVldBIjLmJ5dGViYXNlLnYxLlVwZGF0ZVdvcmtzaGVldFJlcXVlc3QaFi5ieXRlYmFzZS52MS5Xb3Jrc2hlZXQiW9pBFXdvcmtzaGVldCx1cGRhdGVfbWFza5DqMAKC0+STAjk6CXdvcmtzaGVldDIsL3YxL3t3b3Jrc2hlZXQubmFtZT1wcm9qZWN0cy8qL3dvcmtzaGVldHMvKn0S1QEKGFVwZGF0ZVdvcmtzaGVldE9yZ2FuaXplchIsLmJ5dGViYXNlLnYxLlVwZGF0ZVdvcmtzaGVldE9yZ2FuaXplclJlcXVlc3QaHy5ieXRlYmFzZS52MS5Xb3Jrc2hlZXRPcmdhbml6ZXIiatpBFW9yZ2FuaXplcix1cGRhdGVfbWFza5DqMAKC0+STAkg6CW9yZ2FuaXplcjI7L3YxL3tvcmdhbml6ZXIud29ya3NoZWV0PXByb2plY3RzLyovd29ya3NoZWV0cy8qfS9vcmdhbml6ZXISuwEKHUJhdGNoVXBkYXRlV29ya3NoZWV0T3JnYW5pemVyEjEuYnl0ZWJhc2UudjEuQmF0Y2hVcGRhdGVXb3Jrc2hlZXRPcmdhbml6ZXJSZXF1ZXN0GjIuYnl0ZWJhc2UudjEuQmF0Y2hVcGRhdGVXb3Jrc2hlZXRPcmdhbml6ZXJSZXNwb25zZSIzkOowAoLT5JMCKToBKjIkL3YxL3dvcmtzaGVldHMvb3JnYW5pemVyOmJhdGNoVXBkYXRlEoUBCg9EZWxldGVXb3Jrc2hlZXQSIy5ieXRlYmFzZS52MS5EZWxldGVXb3Jrc2hlZXRSZXF1ZXN0GhYuZ29vZ2xlLnByb3RvYnVmLkVtcHR5IjXaQQRuYW1lkOowAoLT5JMCJCoiL3YxL3tuYW1lPXByb2plY3RzLyovd29ya3NoZWV0cy8qfUKrAQoPY29tLmJ5dGViYXNlLnYxQhVXb3Jrc2hlZXRTZXJ2aWNlUHJvdG9QAVo0Z2l0aHViLmNvbS9ieXRlYmFzZS9ieXRlYmFzZS9iYWNrZW5kL2dlbmVyYXRlZC1nby92MaICA0JYWKoCC0J5dGViYXNlLlYxygILQnl0ZWJhc2VcVjHiAhdCeXRlYmFzZVxWMVxHUEJNZXRhZGF0YeoCDEJ5dGViYXNlOjpWMWIGcHJvdG8z", [file_buf_validate_validate, file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_resource, file_google_protobuf_empty, file_google_protobuf_field_mask, file_google_protobuf_timestamp, file_v1_annotation]);
+ fileDesc("Chp2MS93b3Jrc2hlZXRfc2VydmljZS5wcm90bxILYnl0ZWJhc2UudjEiXQoWQ3JlYXRlV29ya3NoZWV0UmVxdWVzdBITCgZwYXJlbnQYASABKAlCA+BBAhIuCgl3b3Jrc2hlZXQYAiABKAsyFi5ieXRlYmFzZS52MS5Xb3Jrc2hlZXRCA+BBAiIoChNHZXRXb3Jrc2hlZXRSZXF1ZXN0EhEKBG5hbWUYASABKAlCA+BBAiJ8ChVMaXN0V29ya3NoZWV0c1JlcXVlc3QSLAoGcGFyZW50GAEgASgJQhzgQQL6QRYKFGJ5dGViYXNlLmNvbS9Qcm9qZWN0Eg4KBmZpbHRlchgCIAEoCRIRCglwYWdlX3NpemUYAyABKAUSEgoKcGFnZV90b2tlbhgEIAEoCSJdChZMaXN0V29ya3NoZWV0c1Jlc3BvbnNlEioKCndvcmtzaGVldHMYASADKAsyFi5ieXRlYmFzZS52MS5Xb3Jrc2hlZXQSFwoPbmV4dF9wYWdlX3Rva2VuGAIgASgJIjIKG0xpc3RXb3Jrc2hlZXRGb2xkZXJzUmVxdWVzdBITCgZwYXJlbnQYASABKAlCA+BBAiJNChxMaXN0V29ya3NoZWV0Rm9sZGVyc1Jlc3BvbnNlEi0KB2ZvbGRlcnMYASADKAsyHC5ieXRlYmFzZS52MS5Xb3Jrc2hlZXRGb2xkZXIilwEKD1dvcmtzaGVldEZvbGRlchIPCgdmb2xkZXJzGAEgAygJEjcKCGNhdGVnb3J5GAIgASgOMiUuYnl0ZWJhc2UudjEuV29ya3NoZWV0Rm9sZGVyLkNhdGVnb3J5IjoKCENhdGVnb3J5EhgKFENBVEVHT1JZX1VOU1BFQ0lGSUVEEAASCAoETUlORRABEgoKBlNIQVJFRBACInkKFlVwZGF0ZVdvcmtzaGVldFJlcXVlc3QSLgoJd29ya3NoZWV0GAEgASgLMhYuYnl0ZWJhc2UudjEuV29ya3NoZWV0QgPgQQISLwoLdXBkYXRlX21hc2sYAiABKAsyGi5nb29nbGUucHJvdG9idWYuRmllbGRNYXNrIroBCiRCYXRjaFVwZGF0ZVdvcmtzaGVldE9yZ2FuaXplclJlcXVlc3QSEwoGcGFyZW50GAEgASgJQgPgQQISDgoGZmlsdGVyGAIgASgJEjcKCW9yZ2FuaXplchgDIAEoCzIfLmJ5dGViYXNlLnYxLldvcmtzaGVldE9yZ2FuaXplckID4EECEjQKC3VwZGF0ZV9tYXNrGAQgASgLMhouZ29vZ2xlLnByb3RvYnVmLkZpZWxkTWFza0ID4EECIn0KJUJhdGNoVXBkYXRlV29ya3NoZWV0T3JnYW5pemVyUmVzcG9uc2USPQoUd29ya3NoZWV0X29yZ2FuaXplcnMYASADKAsyHy5ieXRlYmFzZS52MS5Xb3Jrc2hlZXRPcmdhbml6ZXISFQoNdXBkYXRlZF9jb3VudBgCIAEoBSKiAQofVXBkYXRlV29ya3NoZWV0T3JnYW5pemVyUmVxdWVzdBI3Cglvcmdhbml6ZXIYASABKAsyHy5ieXRlYmFzZS52MS5Xb3Jrc2hlZXRPcmdhbml6ZXJCA+BBAhIvCgt1cGRhdGVfbWFzaxgCIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE1hc2sSFQoNYWxsb3dfbWlzc2luZxgDIAEoCCJOChJXb3Jrc2hlZXRPcmdhbml6ZXISFgoJd29ya3NoZWV0GAEgASgJQgPgQQISDwoHc3RhcnJlZBgCIAEoCBIPCgdmb2xkZXJzGAMgAygJIisKFkRlbGV0ZVdvcmtzaGVldFJlcXVlc3QSEQoEbmFtZRgBIAEoCUID4EECImUKF1NlYXJjaFdvcmtzaGVldHNSZXF1ZXN0EhMKBnBhcmVudBgBIAEoCUID4EECEg4KBmZpbHRlchgCIAEoCRIRCglwYWdlX3NpemUYAyABKAUSEgoKcGFnZV90b2tlbhgEIAEoCSJfChhTZWFyY2hXb3Jrc2hlZXRzUmVzcG9uc2USKgoKd29ya3NoZWV0cxgBIAMoCzIWLmJ5dGViYXNlLnYxLldvcmtzaGVldBIXCg9uZXh0X3BhZ2VfdG9rZW4YAiABKAki3AMKCVdvcmtzaGVldBIUCgRuYW1lGAEgASgJQgbgQQLgQQUSFAoHcHJvamVjdBgCIAEoCUID4EEDEhAKCGRhdGFiYXNlGAMgASgJEhoKBXRpdGxlGAQgASgJQgvgQQK6SAVyAxjIARIUCgdjcmVhdG9yGAUgASgJQgPgQQMSNAoLY3JlYXRlX3RpbWUYBiABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wQgPgQQMSNAoLdXBkYXRlX3RpbWUYByABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wQgPgQQMSFAoHY29udGVudBgIIAEoDEID4EECEhkKDGNvbnRlbnRfc2l6ZRgJIAEoA0ID4EEDEjoKCnZpc2liaWxpdHkYCiABKA4yIS5ieXRlYmFzZS52MS5Xb3Jrc2hlZXQuVmlzaWJpbGl0eUID4EECEhQKB3N0YXJyZWQYCyABKAhCA+BBAxIUCgdmb2xkZXJzGAwgAygJQgPgQQMiWgoKVmlzaWJpbGl0eRIaChZWSVNJQklMSVRZX1VOU1BFQ0lGSUVEEAASEAoMUFJPSkVDVF9SRUFEEAESEQoNUFJPSkVDVF9XUklURRACEgsKB1BSSVZBVEUQAzKvDAoQV29ya3NoZWV0U2VydmljZRKcAQoPQ3JlYXRlV29ya3NoZWV0EiMuYnl0ZWJhc2UudjEuQ3JlYXRlV29ya3NoZWV0UmVxdWVzdBoWLmJ5dGViYXNlLnYxLldvcmtzaGVldCJM2kEQcGFyZW50LHdvcmtzaGVldJDqMAKC0+STAi86CXdvcmtzaGVldCIiL3YxL3twYXJlbnQ9cHJvamVjdHMvKn0vd29ya3NoZWV0cxJ/CgxHZXRXb3Jrc2hlZXQSIC5ieXRlYmFzZS52MS5HZXRXb3Jrc2hlZXRSZXF1ZXN0GhYuYnl0ZWJhc2UudjEuV29ya3NoZWV0IjXaQQRuYW1lkOowAoLT5JMCJBIiL3YxL3tuYW1lPXByb2plY3RzLyovd29ya3NoZWV0cy8qfRKoAQoOTGlzdFdvcmtzaGVldHMSIi5ieXRlYmFzZS52MS5MaXN0V29ya3NoZWV0c1JlcXVlc3QaIy5ieXRlYmFzZS52MS5MaXN0V29ya3NoZWV0c1Jlc3BvbnNlIk3aQQZwYXJlbnSK6jASYmIud29ya3NoZWV0cy5saXN0kOowAYLT5JMCJBIiL3YxL3twYXJlbnQ9cHJvamVjdHMvKn0vd29ya3NoZWV0cxKqAQoUTGlzdFdvcmtzaGVldEZvbGRlcnMSKC5ieXRlYmFzZS52MS5MaXN0V29ya3NoZWV0Rm9sZGVyc1JlcXVlc3QaKS5ieXRlYmFzZS52MS5MaXN0V29ya3NoZWV0Rm9sZGVyc1Jlc3BvbnNlIj3aQQZwYXJlbnSQ6jACgtPkkwIqEigvdjEve3BhcmVudD1wcm9qZWN0cy8qfS93b3Jrc2hlZXRGb2xkZXJzEqIBChBTZWFyY2hXb3Jrc2hlZXRzEiQuYnl0ZWJhc2UudjEuU2VhcmNoV29ya3NoZWV0c1JlcXVlc3QaJS5ieXRlYmFzZS52MS5TZWFyY2hXb3Jrc2hlZXRzUmVzcG9uc2UiQdpBBnBhcmVudJDqMAKC0+STAi46ASoiKS92MS97cGFyZW50PXByb2plY3RzLyp9L3dvcmtzaGVldHM6c2VhcmNoEqsBCg9VcGRhdGVXb3Jrc2hlZXQSIy5ieXRlYmFzZS52MS5VcGRhdGVXb3Jrc2hlZXRSZXF1ZXN0GhYuYnl0ZWJhc2UudjEuV29ya3NoZWV0IlvaQRV3b3Jrc2hlZXQsdXBkYXRlX21hc2uQ6jACgtPkkwI5Ogl3b3Jrc2hlZXQyLC92MS97d29ya3NoZWV0Lm5hbWU9cHJvamVjdHMvKi93b3Jrc2hlZXRzLyp9EtUBChhVcGRhdGVXb3Jrc2hlZXRPcmdhbml6ZXISLC5ieXRlYmFzZS52MS5VcGRhdGVXb3Jrc2hlZXRPcmdhbml6ZXJSZXF1ZXN0Gh8uYnl0ZWJhc2UudjEuV29ya3NoZWV0T3JnYW5pemVyImraQRVvcmdhbml6ZXIsdXBkYXRlX21hc2uQ6jACgtPkkwJIOglvcmdhbml6ZXIyOy92MS97b3JnYW5pemVyLndvcmtzaGVldD1wcm9qZWN0cy8qL3dvcmtzaGVldHMvKn0vb3JnYW5pemVyEu8BCh1CYXRjaFVwZGF0ZVdvcmtzaGVldE9yZ2FuaXplchIxLmJ5dGViYXNlLnYxLkJhdGNoVXBkYXRlV29ya3NoZWV0T3JnYW5pemVyUmVxdWVzdBoyLmJ5dGViYXNlLnYxLkJhdGNoVXBkYXRlV29ya3NoZWV0T3JnYW5pemVyUmVzcG9uc2UiZ9pBHHBhcmVudCxvcmdhbml6ZXIsdXBkYXRlX21hc2uQ6jACgtPkkwI+OgEqIjkvdjEve3BhcmVudD1wcm9qZWN0cy8qfS93b3Jrc2hlZXRzL29yZ2FuaXplcnM6YmF0Y2hVcGRhdGUShQEKD0RlbGV0ZVdvcmtzaGVldBIjLmJ5dGViYXNlLnYxLkRlbGV0ZVdvcmtzaGVldFJlcXVlc3QaFi5nb29nbGUucHJvdG9idWYuRW1wdHkiNdpBBG5hbWWQ6jACgtPkkwIkKiIvdjEve25hbWU9cHJvamVjdHMvKi93b3Jrc2hlZXRzLyp9QqsBCg9jb20uYnl0ZWJhc2UudjFCFVdvcmtzaGVldFNlcnZpY2VQcm90b1ABWjRnaXRodWIuY29tL2J5dGViYXNlL2J5dGViYXNlL2JhY2tlbmQvZ2VuZXJhdGVkLWdvL3YxogIDQlhYqgILQnl0ZWJhc2UuVjHKAgtCeXRlYmFzZVxWMeICF0J5dGViYXNlXFYxXEdQQk1ldGFkYXRh6gIMQnl0ZWJhc2U6OlYxYgZwcm90bzM", [file_buf_validate_validate, file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_resource, file_google_protobuf_empty, file_google_protobuf_field_mask, file_google_protobuf_timestamp, file_v1_annotation]);
/**
* Describes the message bytebase.v1.CreateWorksheetRequest.
@@ -45,74 +45,107 @@ export const ListWorksheetsRequestSchema = /*@__PURE__*/
export const ListWorksheetsResponseSchema = /*@__PURE__*/
messageDesc(file_v1_worksheet_service, 3);
+/**
+ * Describes the message bytebase.v1.ListWorksheetFoldersRequest.
+ * Use `create(ListWorksheetFoldersRequestSchema)` to create a new message.
+ */
+export const ListWorksheetFoldersRequestSchema = /*@__PURE__*/
+ messageDesc(file_v1_worksheet_service, 4);
+
+/**
+ * Describes the message bytebase.v1.ListWorksheetFoldersResponse.
+ * Use `create(ListWorksheetFoldersResponseSchema)` to create a new message.
+ */
+export const ListWorksheetFoldersResponseSchema = /*@__PURE__*/
+ messageDesc(file_v1_worksheet_service, 5);
+
+/**
+ * Describes the message bytebase.v1.WorksheetFolder.
+ * Use `create(WorksheetFolderSchema)` to create a new message.
+ */
+export const WorksheetFolderSchema = /*@__PURE__*/
+ messageDesc(file_v1_worksheet_service, 6);
+
+/**
+ * Describes the enum bytebase.v1.WorksheetFolder.Category.
+ */
+export const WorksheetFolder_CategorySchema = /*@__PURE__*/
+ enumDesc(file_v1_worksheet_service, 6, 0);
+
+/**
+ * @generated from enum bytebase.v1.WorksheetFolder.Category
+ */
+export const WorksheetFolder_Category = /*@__PURE__*/
+ tsEnum(WorksheetFolder_CategorySchema);
+
/**
* Describes the message bytebase.v1.UpdateWorksheetRequest.
* Use `create(UpdateWorksheetRequestSchema)` to create a new message.
*/
export const UpdateWorksheetRequestSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 4);
+ messageDesc(file_v1_worksheet_service, 7);
/**
* Describes the message bytebase.v1.BatchUpdateWorksheetOrganizerRequest.
* Use `create(BatchUpdateWorksheetOrganizerRequestSchema)` to create a new message.
*/
export const BatchUpdateWorksheetOrganizerRequestSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 5);
+ messageDesc(file_v1_worksheet_service, 8);
/**
* Describes the message bytebase.v1.BatchUpdateWorksheetOrganizerResponse.
* Use `create(BatchUpdateWorksheetOrganizerResponseSchema)` to create a new message.
*/
export const BatchUpdateWorksheetOrganizerResponseSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 6);
+ messageDesc(file_v1_worksheet_service, 9);
/**
* Describes the message bytebase.v1.UpdateWorksheetOrganizerRequest.
* Use `create(UpdateWorksheetOrganizerRequestSchema)` to create a new message.
*/
export const UpdateWorksheetOrganizerRequestSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 7);
+ messageDesc(file_v1_worksheet_service, 10);
/**
* Describes the message bytebase.v1.WorksheetOrganizer.
* Use `create(WorksheetOrganizerSchema)` to create a new message.
*/
export const WorksheetOrganizerSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 8);
+ messageDesc(file_v1_worksheet_service, 11);
/**
* Describes the message bytebase.v1.DeleteWorksheetRequest.
* Use `create(DeleteWorksheetRequestSchema)` to create a new message.
*/
export const DeleteWorksheetRequestSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 9);
+ messageDesc(file_v1_worksheet_service, 12);
/**
* Describes the message bytebase.v1.SearchWorksheetsRequest.
* Use `create(SearchWorksheetsRequestSchema)` to create a new message.
*/
export const SearchWorksheetsRequestSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 10);
+ messageDesc(file_v1_worksheet_service, 13);
/**
* Describes the message bytebase.v1.SearchWorksheetsResponse.
* Use `create(SearchWorksheetsResponseSchema)` to create a new message.
*/
export const SearchWorksheetsResponseSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 11);
+ messageDesc(file_v1_worksheet_service, 14);
/**
* Describes the message bytebase.v1.Worksheet.
* Use `create(WorksheetSchema)` to create a new message.
*/
export const WorksheetSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 12);
+ messageDesc(file_v1_worksheet_service, 15);
/**
* Describes the enum bytebase.v1.Worksheet.Visibility.
*/
export const Worksheet_VisibilitySchema = /*@__PURE__*/
- enumDesc(file_v1_worksheet_service, 12, 0);
+ enumDesc(file_v1_worksheet_service, 15, 0);
/**
* @generated from enum bytebase.v1.Worksheet.Visibility
diff --git a/proto/gen/grpc-doc/openapi.yaml b/proto/gen/grpc-doc/openapi.yaml
index c1c77e21be..528ae9b987 100644
--- a/proto/gen/grpc-doc/openapi.yaml
+++ b/proto/gen/grpc-doc/openapi.yaml
@@ -11475,6 +11475,29 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/bytebase.v1.WorkloadIdentity'
+ /v1/projects/{project}/worksheetFolders:
+ get:
+ tags:
+ - WorksheetService
+ summary: ListWorksheetFolders
+ description: |-
+ List the caller's worksheet folders.
+ Only folders stored in the caller's worksheet organizer are returned.
+ operationId: WorksheetService_ListWorksheetFolders
+ parameters:
+ - name: project
+ in: path
+ description: The project id.
+ required: true
+ schema:
+ type: string
+ responses:
+ "200":
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/bytebase.v1.ListWorksheetFoldersResponse'
/v1/projects/{project}/worksheets:
get:
tags:
@@ -11566,6 +11589,68 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/bytebase.v1.Worksheet'
+ /v1/projects/{project}/worksheets/organizers:batchUpdate:
+ post:
+ tags:
+ - WorksheetService
+ summary: BatchUpdateWorksheetOrganizer
+ description: |-
+ Batch update the organizers of worksheets.
+ The access is the same as UpdateWorksheet method.
+ Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
+ operationId: WorksheetService_BatchUpdateWorksheetOrganizer
+ parameters:
+ - name: project
+ in: path
+ description: The project id.
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ filter:
+ type: string
+ title: filter
+ description: |-
+ To filter the batch update target.
+ The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+ Supported filter:
+ - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
+ - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
+ - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
+ - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
+ - folder: the worksheet organizer folder path, support exact "==" operator.
+ organizer:
+ title: organizer
+ description: The organizer fields to update.
+ $ref: '#/components/schemas/bytebase.v1.WorksheetOrganizer'
+ updateMask:
+ title: update_mask
+ description: |-
+ The list of fields to be updated.
+ Fields are specified relative to the worksheet organizer.
+ Only support update the following fields for now:
+ - `starred`
+ - `folders`
+ $ref: '#/components/schemas/google.protobuf.FieldMask'
+ title: BatchUpdateWorksheetOrganizerRequest
+ required:
+ - organizer
+ - updateMask
+ additionalProperties: false
+ required: true
+ responses:
+ "200":
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/bytebase.v1.BatchUpdateWorksheetOrganizerResponse'
/v1/projects/{project}/worksheets/{worksheet}:
get:
tags:
@@ -12170,17 +12255,37 @@ paths:
The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
Supported filter:
+ - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
+ - title: the worksheet title, support "contains" operator.
- creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
- starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
- visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
+ - folder: the worksheet organizer folder path, support "==" operator.
For example:
creator == "users/{email}"
+ title.contains("worksheet title")
creator != "users/{email}"
starred == true
starred == false
visibility in ["PRIVATE", "PROJECT_READ", "PROJECT_WRITE"]
visibility == "PRIVATE"
+ folder == "foo/bar"
+ pageSize:
+ type: integer
+ title: page_size
+ format: int32
+ description: |-
+ The maximum number of worksheets to return. The service may return fewer than
+ this value.
+ If unspecified, at most 10 worksheets will be returned.
+ The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken:
+ type: string
+ title: page_token
+ description: |-
+ A page token, received from a previous `SearchWorksheets` call.
+ Provide this to retrieve the subsequent page.
title: SearchWorksheetsRequest
additionalProperties: false
required: true
@@ -14688,29 +14793,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/bytebase.v1.WorkloadIdentity'
- /v1/worksheets/organizer:batchUpdate:
- patch:
- tags:
- - WorksheetService
- summary: BatchUpdateWorksheetOrganizer
- description: |-
- Batch update the organizers of worksheets.
- The access is the same as UpdateWorksheet method.
- Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- operationId: WorksheetService_BatchUpdateWorksheetOrganizer
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/bytebase.v1.BatchUpdateWorksheetOrganizerRequest'
- required: true
- responses:
- "200":
- description: Success
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/bytebase.v1.BatchUpdateWorksheetOrganizerResponse'
/v1/workspaces:
get:
tags:
@@ -17273,14 +17355,43 @@ components:
bytebase.v1.BatchUpdateWorksheetOrganizerRequest:
type: object
properties:
- requests:
- type: array
- items:
- $ref: '#/components/schemas/bytebase.v1.UpdateWorksheetOrganizerRequest'
- title: requests
+ parent:
+ type: string
+ title: parent
+ description: |-
+ The parent resource whose worksheets' organizers are updated.
+ Format: projects/{project}
+ filter:
+ type: string
+ title: filter
+ description: |-
+ To filter the batch update target.
+ The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+ Supported filter:
+ - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
+ - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
+ - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
+ - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
+ - folder: the worksheet organizer folder path, support exact "==" operator.
+ organizer:
+ title: organizer
+ description: The organizer fields to update.
+ $ref: '#/components/schemas/bytebase.v1.WorksheetOrganizer'
+ updateMask:
+ title: update_mask
+ description: |-
+ The list of fields to be updated.
+ Fields are specified relative to the worksheet organizer.
+ Only support update the following fields for now:
+ - `starred`
+ - `folders`
+ $ref: '#/components/schemas/google.protobuf.FieldMask'
title: BatchUpdateWorksheetOrganizerRequest
required:
- - requests
+ - parent
+ - organizer
+ - updateMask
additionalProperties: false
bytebase.v1.BatchUpdateWorksheetOrganizerResponse:
type: object
@@ -17290,6 +17401,10 @@ components:
items:
$ref: '#/components/schemas/bytebase.v1.WorksheetOrganizer'
title: worksheet_organizers
+ updatedCount:
+ type: integer
+ title: updated_count
+ format: int32
title: BatchUpdateWorksheetOrganizerResponse
additionalProperties: false
bytebase.v1.BillingInterval:
@@ -22893,6 +23008,30 @@ components:
title: ListWorkloadIdentitiesResponse
additionalProperties: false
description: Response message for listing workload identities.
+ bytebase.v1.ListWorksheetFoldersRequest:
+ type: object
+ properties:
+ parent:
+ type: string
+ title: parent
+ description: |-
+ The parent resource of the worksheet folders.
+ Format: projects/{project}
+ title: ListWorksheetFoldersRequest
+ required:
+ - parent
+ additionalProperties: false
+ bytebase.v1.ListWorksheetFoldersResponse:
+ type: object
+ properties:
+ folders:
+ type: array
+ items:
+ $ref: '#/components/schemas/bytebase.v1.WorksheetFolder'
+ title: folders
+ description: The caller's worksheet folders.
+ title: ListWorksheetFoldersResponse
+ additionalProperties: false
bytebase.v1.ListWorksheetsRequest:
type: object
properties:
@@ -26368,17 +26507,37 @@ components:
The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
Supported filter:
+ - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
+ - title: the worksheet title, support "contains" operator.
- creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
- starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
- visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
+ - folder: the worksheet organizer folder path, support "==" operator.
For example:
creator == "users/{email}"
+ title.contains("worksheet title")
creator != "users/{email}"
starred == true
starred == false
visibility in ["PRIVATE", "PROJECT_READ", "PROJECT_WRITE"]
visibility == "PRIVATE"
+ folder == "foo/bar"
+ pageSize:
+ type: integer
+ title: page_size
+ format: int32
+ description: |-
+ The maximum number of worksheets to return. The service may return fewer than
+ this value.
+ If unspecified, at most 10 worksheets will be returned.
+ The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken:
+ type: string
+ title: page_token
+ description: |-
+ A page token, received from a previous `SearchWorksheets` call.
+ Provide this to retrieve the subsequent page.
title: SearchWorksheetsRequest
required:
- parent
@@ -26392,6 +26551,13 @@ components:
$ref: '#/components/schemas/bytebase.v1.Worksheet'
title: worksheets
description: The worksheets that matched the search criteria.
+ nextPageToken:
+ type: string
+ title: next_page_token
+ description: |-
+ A token to retrieve next page of worksheets.
+ Pass this value in the page_token field in the subsequent call to
+ `SearchWorksheets` method to retrieve the next page of worksheets.
title: SearchWorksheetsResponse
additionalProperties: false
bytebase.v1.SemanticTypeSetting:
@@ -29432,6 +29598,28 @@ components:
- PROJECT_READ
- PROJECT_WRITE
- PRIVATE
+ bytebase.v1.WorksheetFolder:
+ type: object
+ properties:
+ folders:
+ type: array
+ items:
+ type: string
+ title: folders
+ description: The folder path segments.
+ category:
+ title: category
+ description: The folder category.
+ $ref: '#/components/schemas/bytebase.v1.WorksheetFolder.Category'
+ title: WorksheetFolder
+ additionalProperties: false
+ bytebase.v1.WorksheetFolder.Category:
+ type: string
+ title: Category
+ enum:
+ - CATEGORY_UNSPECIFIED
+ - MINE
+ - SHARED
bytebase.v1.WorksheetOrganizer:
type: object
properties:
diff --git a/proto/gen/grpc-doc/v1/README.md b/proto/gen/grpc-doc/v1/README.md
index 37b35771fd..641e4d4bb1 100644
--- a/proto/gen/grpc-doc/v1/README.md
+++ b/proto/gen/grpc-doc/v1/README.md
@@ -748,6 +748,8 @@
- [CreateWorksheetRequest](#bytebase-v1-CreateWorksheetRequest)
- [DeleteWorksheetRequest](#bytebase-v1-DeleteWorksheetRequest)
- [GetWorksheetRequest](#bytebase-v1-GetWorksheetRequest)
+ - [ListWorksheetFoldersRequest](#bytebase-v1-ListWorksheetFoldersRequest)
+ - [ListWorksheetFoldersResponse](#bytebase-v1-ListWorksheetFoldersResponse)
- [ListWorksheetsRequest](#bytebase-v1-ListWorksheetsRequest)
- [ListWorksheetsResponse](#bytebase-v1-ListWorksheetsResponse)
- [SearchWorksheetsRequest](#bytebase-v1-SearchWorksheetsRequest)
@@ -755,9 +757,11 @@
- [UpdateWorksheetOrganizerRequest](#bytebase-v1-UpdateWorksheetOrganizerRequest)
- [UpdateWorksheetRequest](#bytebase-v1-UpdateWorksheetRequest)
- [Worksheet](#bytebase-v1-Worksheet)
+ - [WorksheetFolder](#bytebase-v1-WorksheetFolder)
- [WorksheetOrganizer](#bytebase-v1-WorksheetOrganizer)
- [Worksheet.Visibility](#bytebase-v1-Worksheet-Visibility)
+ - [WorksheetFolder.Category](#bytebase-v1-WorksheetFolder-Category)
- [WorksheetService](#bytebase-v1-WorksheetService)
@@ -11991,7 +11995,12 @@ WorkloadIdentityService manages workload identities for external CI/CD integrati
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| requests | [UpdateWorksheetOrganizerRequest](#bytebase-v1-UpdateWorksheetOrganizerRequest) | repeated | |
+| parent | [string](#string) | | The parent resource whose worksheets&#39; organizers are updated. Format: projects/{project} |
+| filter | [string](#string) | | To filter the batch update target. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter: - name: the worksheet name in &#34;projects/{project}/worksheets/{worksheet}&#34; format, support &#34;==&#34; and &#34;in [xx]&#34; operator. - creator: the worksheet creator in &#34;users/{email}&#34; format, support &#34;==&#34; and &#34;!=&#34; operator. - starred: should be &#34;true&#34; or &#34;false&#34;, filter starred/unstarred sheets, support &#34;==&#34; operator. - visibility: check Visibility enum in the Worksheet message for values, support &#34;==&#34; and &#34;in [xx]&#34; operator. - folder: the worksheet organizer folder path, support exact &#34;==&#34; operator. |
+| organizer | [WorksheetOrganizer](#bytebase-v1-WorksheetOrganizer) | | The organizer fields to update. |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to be updated. Fields are specified relative to the worksheet organizer. Only support update the following fields for now: - `starred` - `folders` |
@@ -12007,6 +12016,7 @@ WorkloadIdentityService manages workload identities for external CI/CD integrati
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| worksheet_organizers | [WorksheetOrganizer](#bytebase-v1-WorksheetOrganizer) | repeated | |
+| updated_count | [int32](#int32) | | |
@@ -12059,6 +12069,36 @@ WorkloadIdentityService manages workload identities for external CI/CD integrati
+<a name="bytebase-v1-ListWorksheetFoldersRequest"></a>
+
+### ListWorksheetFoldersRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | The parent resource of the worksheet folders. Format: projects/{project} |
+
+
+
+
+
+
+<a name="bytebase-v1-ListWorksheetFoldersResponse"></a>
+
+### ListWorksheetFoldersResponse
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| folders | [WorksheetFolder](#bytebase-v1-WorksheetFolder) | repeated | The caller&#39;s worksheet folders. |
+
+
+
+
+
+
<a name="bytebase-v1-ListWorksheetsRequest"></a>
### ListWorksheetsRequest
@@ -12110,9 +12150,11 @@ When paginating, all other parameters provided to `ListWorksheets` must match th
| parent | [string](#string) | | The parent resource of the worksheets. Format: projects/{project} |
| filter | [string](#string) | | To filter the search result. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-Supported filter: - creator: the worksheet creator in &#34;users/{email}&#34; format, support &#34;==&#34; and &#34;!=&#34; operator. - starred: should be &#34;true&#34; or &#34;false&#34;, filter starred/unstarred sheets, support &#34;==&#34; operator. - visibility: check Visibility enum in the Worksheet message for values, support &#34;==&#34; and &#34;in [xx]&#34; operator.
+Supported filter: - name: the worksheet name in &#34;projects/{project}/worksheets/{worksheet}&#34; format, support &#34;==&#34; and &#34;in [xx]&#34; operator. - title: the worksheet title, support &#34;contains&#34; operator. - creator: the worksheet creator in &#34;users/{email}&#34; format, support &#34;==&#34; and &#34;!=&#34; operator. - starred: should be &#34;true&#34; or &#34;false&#34;, filter starred/unstarred sheets, support &#34;==&#34; operator. - visibility: check Visibility enum in the Worksheet message for values, support &#34;==&#34; and &#34;in [xx]&#34; operator. - folder: the worksheet organizer folder path, support &#34;==&#34; operator.
-For example: creator == &#34;users/{email}&#34; creator != &#34;users/{email}&#34; starred == true starred == false visibility in [&#34;PRIVATE&#34;, &#34;PROJECT_READ&#34;, &#34;PROJECT_WRITE&#34;] visibility == &#34;PRIVATE&#34; |
+For example: creator == &#34;users/{email}&#34; title.contains(&#34;worksheet title&#34;) creator != &#34;users/{email}&#34; starred == true starred == false visibility in [&#34;PRIVATE&#34;, &#34;PROJECT_READ&#34;, &#34;PROJECT_WRITE&#34;] visibility == &#34;PRIVATE&#34; folder == &#34;foo/bar&#34; |
+| page_size | [int32](#int32) | | The maximum number of worksheets to return. The service may return fewer than this value. If unspecified, at most 10 worksheets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `SearchWorksheets` call. Provide this to retrieve the subsequent page. |
@@ -12128,6 +12170,7 @@ For example: creator == &#34;users/{email}&#34; creator != &#34;users/{email}&#3
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| worksheets | [Worksheet](#bytebase-v1-Worksheet) | repeated | The worksheets that matched the search criteria. |
+| next_page_token | [string](#string) | | A token to retrieve next page of worksheets. Pass this value in the page_token field in the subsequent call to `SearchWorksheets` method to retrieve the next page of worksheets. |
@@ -12197,6 +12240,22 @@ The worksheet&#39;s `name` field is used to identify the worksheet to update. Fo
+<a name="bytebase-v1-WorksheetFolder"></a>
+
+### WorksheetFolder
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| folders | [string](#string) | repeated | The folder path segments. |
+| category | [WorksheetFolder.Category](#bytebase-v1-WorksheetFolder-Category) | | The folder category. |
+
+
+
+
+
+
<a name="bytebase-v1-WorksheetOrganizer"></a>
### WorksheetOrganizer
@@ -12229,6 +12288,19 @@ The worksheet&#39;s `name` field is used to identify the worksheet to update. Fo
| PRIVATE | 3 | Private, only worksheet OWNER can read/write. |
+
+<a name="bytebase-v1-WorksheetFolder-Category"></a>
+
+### WorksheetFolder.Category
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| CATEGORY_UNSPECIFIED | 0 | |
+| MINE | 1 | |
+| SHARED | 2 | |
+
+
@@ -12244,6 +12316,7 @@ WorksheetService manages SQL worksheets for query development.
| CreateWorksheet | [CreateWorksheetRequest](#bytebase-v1-CreateWorksheetRequest) | [Worksheet](#bytebase-v1-Worksheet) | Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets. Permissions required: None (authenticated users only) |
| GetWorksheet | [GetWorksheetRequest](#bytebase-v1-GetWorksheetRequest) | [Worksheet](#bytebase-v1-Worksheet) | Get a worksheet by name. The users can access this method if, - they are the creator of the worksheet; - they have bb.worksheets.get permission on the workspace; - the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project. Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets) |
| ListWorksheets | [ListWorksheetsRequest](#bytebase-v1-ListWorksheetsRequest) | [ListWorksheetsResponse](#bytebase-v1-ListWorksheetsResponse) | List worksheets. This is used for listing worksheets in a project, or across all projects by using `projects/-`. Permissions required: bb.worksheets.list |
+| ListWorksheetFolders | [ListWorksheetFoldersRequest](#bytebase-v1-ListWorksheetFoldersRequest) | [ListWorksheetFoldersResponse](#bytebase-v1-ListWorksheetFoldersResponse) | List the caller&#39;s worksheet folders. Only folders stored in the caller&#39;s worksheet organizer are returned. |
| SearchWorksheets | [SearchWorksheetsRequest](#bytebase-v1-SearchWorksheetsRequest) | [SearchWorksheetsResponse](#bytebase-v1-SearchWorksheetsResponse) | Search for worksheets. This is used for finding my worksheets or worksheets shared by other people. The sheet accessibility is the same as GetWorksheet(). Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets) |
| UpdateWorksheet | [UpdateWorksheetRequest](#bytebase-v1-UpdateWorksheetRequest) | [Worksheet](#bytebase-v1-Worksheet) | Update a worksheet. The users can access this method if, - they are the creator of the worksheet; - they have bb.worksheets.manage permission on the workspace; - the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project. Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets) |
| UpdateWorksheetOrganizer | [UpdateWorksheetOrganizerRequest](#bytebase-v1-UpdateWorksheetOrganizerRequest) | [WorksheetOrganizer](#bytebase-v1-WorksheetOrganizer) | Update the organizer of a worksheet. The access is the same as UpdateWorksheet method. Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets) |
diff --git a/proto/gen/grpc-doc/v1/index.html b/proto/gen/grpc-doc/v1/index.html
index 684d1f5356..b402543812 100644
--- a/proto/gen/grpc-doc/v1/index.html
+++ b/proto/gen/grpc-doc/v1/index.html
@@ -3024,6 +3024,14 @@
<a href="#bytebase.v1.GetWorksheetRequest"><span class="badge">M</span>GetWorksheetRequest</a>
</li>
+ <li>
+ <a href="#bytebase.v1.ListWorksheetFoldersRequest"><span class="badge">M</span>ListWorksheetFoldersRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.ListWorksheetFoldersResponse"><span class="badge">M</span>ListWorksheetFoldersResponse</a>
+ </li>
+
<li>
<a href="#bytebase.v1.ListWorksheetsRequest"><span class="badge">M</span>ListWorksheetsRequest</a>
</li>
@@ -3052,6 +3060,10 @@
<a href="#bytebase.v1.Worksheet"><span class="badge">M</span>Worksheet</a>
</li>
+ <li>
+ <a href="#bytebase.v1.WorksheetFolder"><span class="badge">M</span>WorksheetFolder</a>
+ </li>
+
<li>
<a href="#bytebase.v1.WorksheetOrganizer"><span class="badge">M</span>WorksheetOrganizer</a>
</li>
@@ -3061,6 +3073,10 @@
<a href="#bytebase.v1.Worksheet.Visibility"><span class="badge">E</span>Worksheet.Visibility</a>
</li>
+ <li>
+ <a href="#bytebase.v1.WorksheetFolder.Category"><span class="badge">E</span>WorksheetFolder.Category</a>
+ </li>
+
<li>
@@ -34024,10 +34040,44 @@ Permissions required: bb.workloadIdentities.undelete</p></td>
<tbody>
<tr>
- <td>requests</td>
- <td><a href="#bytebase.v1.UpdateWorksheetOrganizerRequest">UpdateWorksheetOrganizerRequest</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The parent resource whose worksheets&#39; organizers are updated.
+Format: projects/{project} </p></td>
+ </tr>
+
+ <tr>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>To filter the batch update target.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter:
+- name: the worksheet name in &#34;projects/{project}/worksheets/{worksheet}&#34; format, support &#34;==&#34; and &#34;in [xx]&#34; operator.
+- creator: the worksheet creator in &#34;users/{email}&#34; format, support &#34;==&#34; and &#34;!=&#34; operator.
+- starred: should be &#34;true&#34; or &#34;false&#34;, filter starred/unstarred sheets, support &#34;==&#34; operator.
+- visibility: check Visibility enum in the Worksheet message for values, support &#34;==&#34; and &#34;in [xx]&#34; operator.
+- folder: the worksheet organizer folder path, support exact &#34;==&#34; operator. </p></td>
+ </tr>
+
+ <tr>
+ <td>organizer</td>
+ <td><a href="#bytebase.v1.WorksheetOrganizer">WorksheetOrganizer</a></td>
+ <td></td>
+ <td><p>The organizer fields to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td></td>
+ <td><p>The list of fields to be updated.
+Fields are specified relative to the worksheet organizer.
+Only support update the following fields for now:
+- `starred`
+- `folders` </p></td>
</tr>
</tbody>
@@ -34054,6 +34104,13 @@ Permissions required: bb.workloadIdentities.undelete</p></td>
<td><p> </p></td>
</tr>
+ <tr>
+ <td>updated_count</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
</tbody>
</table>
@@ -34143,6 +34200,55 @@ Format: projects/{project}/worksheets/{worksheet} </p></td>
+ <h3 id="bytebase.v1.ListWorksheetFoldersRequest">ListWorksheetFoldersRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The parent resource of the worksheet folders.
+Format: projects/{project} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListWorksheetFoldersResponse">ListWorksheetFoldersResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>folders</td>
+ <td><a href="#bytebase.v1.WorksheetFolder">WorksheetFolder</a></td>
+ <td>repeated</td>
+ <td><p>The caller&#39;s worksheet folders. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
<h3 id="bytebase.v1.ListWorksheetsRequest">ListWorksheetsRequest</h3>
<p></p>
@@ -34264,17 +34370,40 @@ Format: projects/{project} </p></td>
The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
Supported filter:
+- name: the worksheet name in &#34;projects/{project}/worksheets/{worksheet}&#34; format, support &#34;==&#34; and &#34;in [xx]&#34; operator.
+- title: the worksheet title, support &#34;contains&#34; operator.
- creator: the worksheet creator in &#34;users/{email}&#34; format, support &#34;==&#34; and &#34;!=&#34; operator.
- starred: should be &#34;true&#34; or &#34;false&#34;, filter starred/unstarred sheets, support &#34;==&#34; operator.
- visibility: check Visibility enum in the Worksheet message for values, support &#34;==&#34; and &#34;in [xx]&#34; operator.
+- folder: the worksheet organizer folder path, support &#34;==&#34; operator.
For example:
creator == &#34;users/{email}&#34;
+title.contains(&#34;worksheet title&#34;)
creator != &#34;users/{email}&#34;
starred == true
starred == false
visibility in [&#34;PRIVATE&#34;, &#34;PROJECT_READ&#34;, &#34;PROJECT_WRITE&#34;]
-visibility == &#34;PRIVATE&#34; </p></td>
+visibility == &#34;PRIVATE&#34;
+folder == &#34;foo/bar&#34; </p></td>
+ </tr>
+
+ <tr>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of worksheets to return. The service may return fewer than
+this value.
+If unspecified, at most 10 worksheets will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ </tr>
+
+ <tr>
+ <td>page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A page token, received from a previous `SearchWorksheets` call.
+Provide this to retrieve the subsequent page. </p></td>
</tr>
</tbody>
@@ -34301,6 +34430,15 @@ visibility == &#34;PRIVATE&#34; </p></td>
<td><p>The worksheets that matched the search criteria. </p></td>
</tr>
+ <tr>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A token to retrieve next page of worksheets.
+Pass this value in the page_token field in the subsequent call to
+`SearchWorksheets` method to retrieve the next page of worksheets. </p></td>
+ </tr>
+
</tbody>
</table>
@@ -34503,6 +34641,37 @@ use GetWorksheet() request to retrieve the full content. </p></td>
+ <h3 id="bytebase.v1.WorksheetFolder">WorksheetFolder</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>folders</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The folder path segments. </p></td>
+ </tr>
+
+ <tr>
+ <td>category</td>
+ <td><a href="#bytebase.v1.WorksheetFolder.Category">WorksheetFolder.Category</a></td>
+ <td></td>
+ <td><p>The folder category. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
<h3 id="bytebase.v1.WorksheetOrganizer">WorksheetOrganizer</h3>
<p></p>
@@ -34579,6 +34748,35 @@ Format: projects/{project}/worksheets/{worksheet} </p></td>
</tbody>
</table>
+ <h3 id="bytebase.v1.WorksheetFolder.Category">WorksheetFolder.Category</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>CATEGORY_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>MINE</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>SHARED</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
@@ -34620,6 +34818,14 @@ This is used for listing worksheets in a project, or across all projects by usin
Permissions required: bb.worksheets.list</p></td>
</tr>
+ <tr>
+ <td>ListWorksheetFolders</td>
+ <td><a href="#bytebase.v1.ListWorksheetFoldersRequest">ListWorksheetFoldersRequest</a></td>
+ <td><a href="#bytebase.v1.ListWorksheetFoldersResponse">ListWorksheetFoldersResponse</a></td>
+ <td><p>List the caller&#39;s worksheet folders.
+Only folders stored in the caller&#39;s worksheet organizer are returned.</p></td>
+ </tr>
+
<tr>
<td>SearchWorksheets</td>
<td><a href="#bytebase.v1.SearchWorksheetsRequest">SearchWorksheetsRequest</a></td>
@@ -34719,6 +34925,16 @@ Permissions required: bb.worksheets.manage (or creator, or project member for PR
+ <tr>
+ <td>ListWorksheetFolders</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/worksheetFolders</td>
+ <td></td>
+ </tr>
+
+
+
+
<tr>
<td>SearchWorksheets</td>
<td>POST</td>
@@ -34751,8 +34967,8 @@ Permissions required: bb.worksheets.manage (or creator, or project member for PR
<tr>
<td>BatchUpdateWorksheetOrganizer</td>
- <td>PATCH</td>
- <td>/v1/worksheets/organizer:batchUpdate</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/worksheets/organizers:batchUpdate</td>
<td>*</td>
</tr>
diff --git a/proto/v1/v1/worksheet_service.proto b/proto/v1/v1/worksheet_service.proto
index 8a768a23a8..42871cd169 100644
--- a/proto/v1/v1/worksheet_service.proto
+++ b/proto/v1/v1/worksheet_service.proto
@@ -49,6 +49,14 @@ service WorksheetService {
option (bytebase.v1.auth_method) = IAM;
}
+ // List the caller's worksheet folders.
+ // Only folders stored in the caller's worksheet organizer are returned.
+ rpc ListWorksheetFolders(ListWorksheetFoldersRequest) returns (ListWorksheetFoldersResponse) {
+ option (google.api.http) = {get: "/v1/{parent=projects/*}/worksheetFolders"};
+ option (google.api.method_signature) = "parent";
+ option (bytebase.v1.auth_method) = CUSTOM;
+ }
+
// Search for worksheets.
// This is used for finding my worksheets or worksheets shared by other people.
// The sheet accessibility is the same as GetWorksheet().
@@ -94,9 +102,10 @@ service WorksheetService {
// Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
rpc BatchUpdateWorksheetOrganizer(BatchUpdateWorksheetOrganizerRequest) returns (BatchUpdateWorksheetOrganizerResponse) {
option (google.api.http) = {
- patch: "/v1/worksheets/organizer:batchUpdate"
+ post: "/v1/{parent=projects/*}/worksheets/organizers:batchUpdate"
body: "*"
};
+ option (google.api.method_signature) = "parent,organizer,update_mask";
option (bytebase.v1.auth_method) = CUSTOM;
}
@@ -169,6 +178,31 @@ message ListWorksheetsResponse {
string next_page_token = 2;
}
+message ListWorksheetFoldersRequest {
+ // The parent resource of the worksheet folders.
+ // Format: projects/{project}
+ string parent = 1 [(google.api.field_behavior) = REQUIRED];
+}
+
+message ListWorksheetFoldersResponse {
+ // The caller's worksheet folders.
+ repeated WorksheetFolder folders = 1;
+}
+
+message WorksheetFolder {
+ enum Category {
+ CATEGORY_UNSPECIFIED = 0;
+ MINE = 1;
+ SHARED = 2;
+ }
+
+ // The folder path segments.
+ repeated string folders = 1;
+
+ // The folder category.
+ Category category = 2;
+}
+
message UpdateWorksheetRequest {
// The worksheet to update.
//
@@ -188,11 +222,36 @@ message UpdateWorksheetRequest {
}
message BatchUpdateWorksheetOrganizerRequest {
- repeated UpdateWorksheetOrganizerRequest requests = 1 [(google.api.field_behavior) = REQUIRED];
+ // The parent resource whose worksheets' organizers are updated.
+ // Format: projects/{project}
+ string parent = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // To filter the batch update target.
+ // The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+ //
+ // Supported filter:
+ // - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
+ // - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
+ // - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
+ // - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
+ // - folder: the worksheet organizer folder path, support exact "==" operator.
+ string filter = 2;
+
+ // The organizer fields to update.
+ WorksheetOrganizer organizer = 3 [(google.api.field_behavior) = REQUIRED];
+
+ // The list of fields to be updated.
+ // Fields are specified relative to the worksheet organizer.
+ // Only support update the following fields for now:
+ // - `starred`
+ // - `folders`
+ google.protobuf.FieldMask update_mask = 4 [(google.api.field_behavior) = REQUIRED];
}
message BatchUpdateWorksheetOrganizerResponse {
repeated WorksheetOrganizer worksheet_organizers = 1;
+
+ int32 updated_count = 2;
}
message UpdateWorksheetOrganizerRequest {
@@ -239,23 +298,43 @@ message SearchWorksheetsRequest {
// The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
//
// Supported filter:
+ // - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
+ // - title: the worksheet title, support "contains" operator.
// - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
// - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
// - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
+ // - folder: the worksheet organizer folder path, support "==" operator.
//
// For example:
// creator == "users/{email}"
+ // title.contains("worksheet title")
// creator != "users/{email}"
// starred == true
// starred == false
// visibility in ["PRIVATE", "PROJECT_READ", "PROJECT_WRITE"]
// visibility == "PRIVATE"
+ // folder == "foo/bar"
string filter = 2;
+
+ // The maximum number of worksheets to return. The service may return fewer than
+ // this value.
+ // If unspecified, at most 10 worksheets will be returned.
+ // The maximum value is 1000; values above 1000 will be coerced to 1000.
+ int32 page_size = 3;
+
+ // A page token, received from a previous `SearchWorksheets` call.
+ // Provide this to retrieve the subsequent page.
+ string page_token = 4;
}
message SearchWorksheetsResponse {
// The worksheets that matched the search criteria.
repeated Worksheet worksheets = 1;
+
+ // A token to retrieve next page of worksheets.
+ // Pass this value in the page_token field in the subsequent call to
+ // `SearchWorksheets` method to retrieve the next page of worksheets.
+ string next_page_token = 2;
}
message Worksheet {