Catalog: migrate bucket queries to role-scoped Bucket type (#4839)

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Author: nl0

catalog/CHANGELOG.md

@@ -18,6 +18,8 @@ where verb is one of
 
 ## Changes
 
+- [Changed] Migrate user-facing bucket queries to the new role-scoped `buckets` / `bucket` GraphQL type; admins in a scoped managed role now see only role-permitted buckets in navbar / listings / deep-links (admin panel unchanged) ([#4839](https://github.com/quiltdata/quilt/pull/4839))
+- [Fixed] Refresh navbar bucket selector after bucket removal and after policy / role / user-role edits that change the caller's managed-role bucket set ([#4839](https://github.com/quiltdata/quilt/pull/4839))
 - [Added] HubSpot tracking ([#4807](https://github.com/quiltdata/quilt/pull/4807))
 - [Changed] Migrate `package-lock.json` from lockfileVersion 2 to 3 ([#4812](https://github.com/quiltdata/quilt/pull/4812))
 - [Changed] Replace `jsonpath` with `jsonpath-plus` for JSONPath evaluation ([#4811](https://github.com/quiltdata/quilt/pull/4811))

catalog/app/components/Assistant/Model/GlobalContext/stack.ts

@@ -1,17 +1,17 @@
 import * as React from 'react'
 
-import * as BucketConfig from 'utils/BucketConfig'
+import * as Buckets from 'utils/Buckets'
 import * as XML from 'utils/XML'
 
 export function useStackInfo() {
-  const bucketConfigs = BucketConfig.useRelevantBucketConfigs()
+  const buckets = Buckets.useRelevantBuckets()
 
   return React.useMemo(() => {
-    const buckets = XML.tag(
+    const bucketsXml = XML.tag(
       'buckets',
       {},
       'Buckets attached to this stack:',
-      ...bucketConfigs.map((b) =>
+      ...buckets.map((b) =>
         XML.tag(
           'bucket',
           {},
@@ -28,6 +28,6 @@ export function useStackInfo() {
         ),
       ),
     )
-    return XML.tag('quilt-stack-info', {}, buckets).toString()
-  }, [bucketConfigs])
+    return XML.tag('quilt-stack-info', {}, bucketsXml).toString()
+  }, [buckets])
 }

catalog/app/components/FileEditor/QuiltConfigEditor/BucketPreferences/BucketPreferences.spec.tsx

@@ -11,8 +11,8 @@ const theme = createMuiTheme()
 
 vi.mock('constants/config', () => ({ default: {} }))
 
-vi.mock('utils/BucketConfig', () => ({
-  useRelevantBucketConfigs: () => [],
+vi.mock('utils/Buckets', () => ({
+  useRelevantBuckets: () => [],
 }))
 
 vi.mock('@material-ui/core', async () => ({

catalog/app/components/FileEditor/QuiltConfigEditor/BucketPreferences/BucketPreferences.tsx

@@ -6,7 +6,7 @@ import * as Lab from '@material-ui/lab'
 import JsonValidationErrors from 'components/JsonValidationErrors'
 import { docs } from 'constants/urls'
 import type * as Model from 'model'
-import * as BucketConfig from 'utils/BucketConfig'
+import * as Buckets from 'utils/Buckets'
 import StyledLink from 'utils/StyledLink'
 import { JsonInvalidAgainstSchema } from 'utils/error'
 
@@ -121,13 +121,10 @@ function InputSourceBuckets({
   onChange,
   ...props
 }: FieldProps<TypedValue<string[]>>) {
-  const bucketConfigs = BucketConfig.useRelevantBucketConfigs()
-  const options = React.useMemo(
-    () => bucketConfigs.map((b) => `s3://${b.name}`),
-    [bucketConfigs],
-  )
+  const buckets = Buckets.useRelevantBuckets()
+  const options = React.useMemo(() => buckets.map((b) => `s3://${b.name}`), [buckets])
   const handleChange = React.useCallback(
-    (_e, buckets: string[]) => onChange({ isDefault: false, key, value: buckets }),
+    (_e, selected: string[]) => onChange({ isDefault: false, key, value: selected }),
     [key, onChange],
   )
   return (

catalog/app/components/Preview/loaders/Html/Html.tsx

@@ -6,7 +6,7 @@ import cfg from 'constants/config'
 import type * as Model from 'model'
 import * as AWS from 'utils/AWS'
 import AsyncResult from 'utils/AsyncResult'
-import { useIsInStack } from 'utils/BucketConfig'
+import { useIsInStack } from 'utils/Buckets'
 import * as GQL from 'utils/GraphQL'
 import log from 'utils/Logging'
 import type * as LogicalKeyResolver from 'utils/LogicalKeyResolver'
@@ -22,7 +22,7 @@ import * as Text from '../Text'
 import FileType from '../fileType'
 import * as utils from '../utils'
 
-import BUCKET_CONFIG_QUERY from './gql/BrowsableBucketConfig.generated'
+import BROWSABLE_BUCKET_QUERY from './gql/BrowsableBucket.generated'
 import CREATE_BROWSING_SESSION from './gql/CreateBrowsingSession.generated'
 import DISPOSE_BROWSING_SESSION from './gql/DisposeBrowsingSession.generated'
 import REFRESH_BROWSING_SESSION from './gql/RefreshBrowsingSession.generated'
@@ -257,19 +257,16 @@ interface IFrameLoaderProps {
 }
 
 function IFrameLoader({ handle, children }: IFrameLoaderProps) {
-  const bucketData = GQL.useQuery(BUCKET_CONFIG_QUERY, { bucket: handle.bucket })
+  const bucketData = GQL.useQuery(BROWSABLE_BUCKET_QUERY, { bucket: handle.bucket })
   const inPackage = !!handle.packageHandle
   return GQL.fold(bucketData, {
     fetching: () => children(AsyncResult.Pending()),
     error: (e) => children(AsyncResult.Err(e)),
-    data: ({ bucketConfig }) =>
-      bucketConfig?.browsable && inPackage ? (
+    data: ({ bucket }) =>
+      bucket?.browsable && inPackage ? (
         <IFrameLoaderBrowsable {...{ handle, children }} />
       ) : (
-        <IFrameLoaderSigned
-          {...{ handle, children }}
-          browsable={!!bucketConfig?.browsable}
-        />
+        <IFrameLoaderSigned {...{ handle, children }} browsable={!!bucket?.browsable} />
       ),
   })
 }

…l/gql/BrowsableBucketConfig.generated.ts …rs/Html/gql/BrowsableBucket.generated.tscatalog/app/components/Preview/loaders/Html/gql/BrowsableBucketConfig.generated.ts renamed to catalog/app/components/Preview/loaders/Html/gql/BrowsableBucket.generated.ts catalog/app/components/Preview/loaders/Html/gql/BrowsableBucketConfig.generated.ts renamed to catalog/app/components/Preview/loaders/Html/gql/BrowsableBucket.generated.ts

@@ -2,31 +2,28 @@
 import type { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core'
 import * as Types from '../../../../../model/graphql/types.generated'
 
-export type components_Preview_loaders_Html_gql_BrowsableBucketConfigQueryVariables =
+export type components_Preview_loaders_Html_gql_BrowsableBucketQueryVariables =
   Types.Exact<{
     bucket: Types.Scalars['String']
   }>
 
-export type components_Preview_loaders_Html_gql_BrowsableBucketConfigQuery = {
+export type components_Preview_loaders_Html_gql_BrowsableBucketQuery = {
   readonly __typename: 'Query'
 } & {
-  readonly bucketConfig: Types.Maybe<
-    { readonly __typename: 'BucketConfig' } & Pick<
-      Types.BucketConfig,
-      'name' | 'browsable'
-    >
+  readonly bucket: Types.Maybe<
+    { readonly __typename: 'Bucket' } & Pick<Types.Bucket, 'name' | 'browsable'>
   >
 }
 
-export const components_Preview_loaders_Html_gql_BrowsableBucketConfigDocument = {
+export const components_Preview_loaders_Html_gql_BrowsableBucketDocument = {
   kind: 'Document',
   definitions: [
     {
       kind: 'OperationDefinition',
       operation: 'query',
       name: {
         kind: 'Name',
-        value: 'components_Preview_loaders_Html_gql_BrowsableBucketConfig',
+        value: 'components_Preview_loaders_Html_gql_BrowsableBucket',
       },
       variableDefinitions: [
         {
@@ -43,7 +40,7 @@ export const components_Preview_loaders_Html_gql_BrowsableBucketConfigDocument =
         selections: [
           {
             kind: 'Field',
-            name: { kind: 'Name', value: 'bucketConfig' },
+            name: { kind: 'Name', value: 'bucket' },
             arguments: [
               {
                 kind: 'Argument',
@@ -64,8 +61,8 @@ export const components_Preview_loaders_Html_gql_BrowsableBucketConfigDocument =
     },
   ],
 } as unknown as DocumentNode<
-  components_Preview_loaders_Html_gql_BrowsableBucketConfigQuery,
-  components_Preview_loaders_Html_gql_BrowsableBucketConfigQueryVariables
+  components_Preview_loaders_Html_gql_BrowsableBucketQuery,
+  components_Preview_loaders_Html_gql_BrowsableBucketQueryVariables
 >
 
-export { components_Preview_loaders_Html_gql_BrowsableBucketConfigDocument as default }
+export { components_Preview_loaders_Html_gql_BrowsableBucketDocument as default }

…s/Html/gql/BrowsableBucketConfig.graphql …loaders/Html/gql/BrowsableBucket.graphqlcatalog/app/components/Preview/loaders/Html/gql/BrowsableBucketConfig.graphql renamed to catalog/app/components/Preview/loaders/Html/gql/BrowsableBucket.graphql catalog/app/components/Preview/loaders/Html/gql/BrowsableBucketConfig.graphql renamed to catalog/app/components/Preview/loaders/Html/gql/BrowsableBucket.graphql

@@ -1,5 +1,5 @@
 query ($bucket: String!) {
-  bucketConfig(name: $bucket) {
+  bucket(name: $bucket) {
     name
     browsable
   }

catalog/app/containers/Bucket/Overview/Overview.tsx

@@ -18,7 +18,7 @@ import * as Summarize from '../Summarize'
 import * as requests from '../requests'
 
 import Header from './Header'
-import BUCKET_CONFIG_QUERY from './gql/BucketConfig.generated'
+import BUCKET_QUERY from './gql/Bucket.generated'
 
 interface BucketReadmes {
   forced?: Model.S3.S3ObjectLocation
@@ -116,10 +116,12 @@ export default function Overview() {
   const { bucket } = useParams<{ bucket: string }>()
 
   const s3 = AWS.S3.use()
-  const { bucketConfig } = GQL.useQueryS(BUCKET_CONFIG_QUERY, { bucket })
-  const inStack = !!bucketConfig
-  const overviewUrl = bucketConfig?.overviewUrl
-  const description = bucketConfig?.description
+  const { bucket: bucketData } = GQL.useQueryS(BUCKET_QUERY, { bucket })
+  const inStack = !!bucketData
+  // overviewUrl is dead; stubbed until the field + its Readmes/Imgs/
+  // Summarize code paths are removed.
+  const overviewUrl = undefined
+  const description = bucketData?.description
   const { prefs } = BucketPreferences.use()
   return (
     <M.Box pb={{ xs: 0, sm: 4 }} mx={{ xs: -2, sm: 0 }} position="relative" zIndex={1}>
@@ -128,7 +130,7 @@ export default function Overview() {
           <LinkedData.BucketData bucket={bucket} />
         </React.Suspense>
       )}
-      {bucketConfig ? (
+      {bucketData ? (
         <Header {...{ s3, bucket, overviewUrl, description }} />
       ) : (
         <M.Box

…t/Overview/gql/BucketConfig.generated.ts …/Bucket/Overview/gql/Bucket.generated.tscatalog/app/containers/Bucket/Overview/gql/BucketConfig.generated.ts renamed to catalog/app/containers/Bucket/Overview/gql/Bucket.generated.ts catalog/app/containers/Bucket/Overview/gql/BucketConfig.generated.ts renamed to catalog/app/containers/Bucket/Overview/gql/Bucket.generated.ts

@@ -2,28 +2,25 @@
 import type { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core'
 import * as Types from '../../../../model/graphql/types.generated'
 
-export type containers_Bucket_Overview_gql_BucketConfigQueryVariables = Types.Exact<{
+export type containers_Bucket_Overview_gql_BucketQueryVariables = Types.Exact<{
   bucket: Types.Scalars['String']
 }>
 
-export type containers_Bucket_Overview_gql_BucketConfigQuery = {
+export type containers_Bucket_Overview_gql_BucketQuery = {
   readonly __typename: 'Query'
 } & {
-  readonly bucketConfig: Types.Maybe<
-    { readonly __typename: 'BucketConfig' } & Pick<
-      Types.BucketConfig,
-      'name' | 'description' | 'overviewUrl'
-    >
+  readonly bucket: Types.Maybe<
+    { readonly __typename: 'Bucket' } & Pick<Types.Bucket, 'name' | 'description'>
   >
 }
 
-export const containers_Bucket_Overview_gql_BucketConfigDocument = {
+export const containers_Bucket_Overview_gql_BucketDocument = {
   kind: 'Document',
   definitions: [
     {
       kind: 'OperationDefinition',
       operation: 'query',
-      name: { kind: 'Name', value: 'containers_Bucket_Overview_gql_BucketConfig' },
+      name: { kind: 'Name', value: 'containers_Bucket_Overview_gql_Bucket' },
       variableDefinitions: [
         {
           kind: 'VariableDefinition',
@@ -39,7 +36,7 @@ export const containers_Bucket_Overview_gql_BucketConfigDocument = {
         selections: [
           {
             kind: 'Field',
-            name: { kind: 'Name', value: 'bucketConfig' },
+            name: { kind: 'Name', value: 'bucket' },
             arguments: [
               {
                 kind: 'Argument',
@@ -52,7 +49,6 @@ export const containers_Bucket_Overview_gql_BucketConfigDocument = {
               selections: [
                 { kind: 'Field', name: { kind: 'Name', value: 'name' } },
                 { kind: 'Field', name: { kind: 'Name', value: 'description' } },
-                { kind: 'Field', name: { kind: 'Name', value: 'overviewUrl' } },
               ],
             },
           },
@@ -61,8 +57,8 @@ export const containers_Bucket_Overview_gql_BucketConfigDocument = {
     },
   ],
 } as unknown as DocumentNode<
-  containers_Bucket_Overview_gql_BucketConfigQuery,
-  containers_Bucket_Overview_gql_BucketConfigQueryVariables
+  containers_Bucket_Overview_gql_BucketQuery,
+  containers_Bucket_Overview_gql_BucketQueryVariables
 >
 
-export { containers_Bucket_Overview_gql_BucketConfigDocument as default }
+export { containers_Bucket_Overview_gql_BucketDocument as default }

…Bucket/Overview/gql/BucketConfig.graphql …iners/Bucket/Overview/gql/Bucket.graphqlcatalog/app/containers/Bucket/Overview/gql/BucketConfig.graphql renamed to catalog/app/containers/Bucket/Overview/gql/Bucket.graphql catalog/app/containers/Bucket/Overview/gql/BucketConfig.graphql renamed to catalog/app/containers/Bucket/Overview/gql/Bucket.graphql

@@ -1,7 +1,6 @@
 query ($bucket: String!) {
-  bucketConfig(name: $bucket) {
+  bucket(name: $bucket) {
     name
     description
-    overviewUrl
   }
 }