instrument directory route

catalog/app/components/Assistant/Model/GlobalContext/__snapshots__/navigation.spec.ts.snap

@@ -630,20 +630,36 @@ exports[`components/Assistant/Model/GlobalTools/navigation NavigateSchema produc
         },
         {
           "additionalProperties": false,
-          "description": "Bucket overview page",
+          "description": "S3 Object (aka File) page",
           "properties": {
             "name": {
-              "const": "bucket.overview",
+              "const": "bucket.object",
             },
             "params": {
               "additionalProperties": false,
               "properties": {
                 "bucket": {
                   "type": "string",
                 },
+                "mode": {
+                  "description": "Contents preview mode",
+                  "title": "Viewing Mode",
+                  "type": "string",
+                },
+                "path": {
+                  "description": "S3 Object Key aka File Path",
+                  "title": "Path",
+                  "type": "string",
+                },
+                "version": {
+                  "description": "S3 Object Version ID (omit for latest version)",
+                  "title": "Version ID",
+                  "type": "string",
+                },
               },
               "required": [
                 "bucket",
+                "path",
               ],
               "type": "object",
             },
@@ -656,36 +672,52 @@ exports[`components/Assistant/Model/GlobalTools/navigation NavigateSchema produc
         },
         {
           "additionalProperties": false,
-          "description": "S3 Object (aka File) Detail page",
+          "description": "S3 Prefix (aka Directory) page",
           "properties": {
             "name": {
-              "const": "bucket.object",
+              "const": "bucket.prefix",
             },
             "params": {
               "additionalProperties": false,
               "properties": {
                 "bucket": {
                   "type": "string",
                 },
-                "mode": {
-                  "description": "Contents preview mode",
-                  "title": "Viewing Mode",
-                  "type": "string",
-                },
                 "path": {
-                  "description": "a string",
-                  "title": "string & Brand<"S3Path">",
+                  "description": "S3 Prefix aka Directory Path",
+                  "title": "Path",
                   "type": "string",
                 },
-                "version": {
-                  "description": "S3 Object Version ID (omit for latest version)",
-                  "title": "Version ID",
+              },
+              "required": [
+                "bucket",
+                "path",
+              ],
+              "type": "object",
+            },
+          },
+          "required": [
+            "name",
+            "params",
+          ],
+          "type": "object",
+        },
+        {
+          "additionalProperties": false,
+          "description": "Bucket overview page",
+          "properties": {
+            "name": {
+              "const": "bucket.overview",
+            },
+            "params": {
+              "additionalProperties": false,
+              "properties": {
+                "bucket": {
                   "type": "string",
                 },
               },
               "required": [
                 "bucket",
-                "path",
               ],
               "type": "object",
             },

catalog/app/components/Assistant/Model/GlobalContext/navigation.spec.ts

@@ -62,6 +62,20 @@ describe('components/Assistant/Model/GlobalTools/navigation', () => {
           hash: '',
         },
       },
+      {
+        route: {
+          name: 'bucket.prefix',
+          params: {
+            bucket: 'quilt-example',
+            path: 'data/random-data-benchmark/100kb/',
+          },
+        },
+        loc: {
+          pathname: '/b/quilt-example/tree/data/random-data-benchmark/100kb/',
+          search: '',
+          hash: '',
+        },
+      },
     ]
 
     const encode = Eff.flow(
@@ -70,14 +84,15 @@ describe('components/Assistant/Model/GlobalTools/navigation', () => {
       Eff.Effect.runPromise,
     )
 
-    for (let i in TEST_CASES) {
-      const tc = TEST_CASES[i]
+    TEST_CASES.forEach((tc, i) => {
       describe(`${i + 1}: ${tc.route.name}`, () => {
         it('should encode', async () => {
-          const loc = await encode(tc.route)
-          expect(loc).toEqual(tc.loc)
+          expect(await encode(tc.route)).toEqual(tc.loc)
+        })
+        it('should decode', async () => {
+          expect(nav.matchLocation(tc.loc)?.decoded).toEqual(tc.route)
         })
       })
-    }
+    })
   })
 })

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

@@ -159,12 +159,12 @@ const navigate = (
     ),
   )
 
-interface Match {
+export interface Match {
   descriptor: KnownRoute
   decoded: NavigableRoute | null
 }
 
-const matchLocation = (loc: typeof Nav.Location.Type): Match | null =>
+export const matchLocation = (loc: typeof Nav.Location.Type): Match | null =>
   Eff.pipe(
     Eff.Array.findFirst(routeList, (route) =>
       RR.matchPath(loc.pathname, {

catalog/app/containers/Bucket/Dir.tsx

@@ -20,6 +20,7 @@ import * as s3paths from 'utils/s3paths'
 import type * as workflows from 'utils/workflows'
 
 import DirCodeSamples from './CodeSamples/Dir'
+import * as AssistantContext from './DirAssistantContext'
 import * as FileView from './FileView'
 import * as Listing from './Listing'
 import Menu from './Menu'
@@ -268,6 +269,8 @@ export default function Dir() {
     prev,
   })
 
+  AssistantContext.useListingContext(data)
+
   const loadMore = React.useCallback(() => {
     AsyncResult.case(
       {

catalog/app/containers/Bucket/DirAssistantContext.ts

@@ -0,0 +1,51 @@
+import * as Eff from 'effect'
+import * as React from 'react'
+
+import * as Assistant from 'components/Assistant'
+import * as XML from 'utils/XML'
+
+import type { BucketListingResult } from './requests'
+
+export function useListingContext(data: $TSFixMe) {
+  const msg = React.useMemo(
+    () =>
+      Eff.pipe(
+        data.case({
+          Ok: (res: BucketListingResult) => Eff.Option.some(Eff.Either.right(res)),
+          Err: () => Eff.Option.some(Eff.Either.left('Error fetching listing data')),
+          _: () => Eff.Option.none(),
+        }) as Eff.Option.Option<Eff.Either.Either<BucketListingResult, string>>,
+        Eff.Option.map(
+          Eff.Either.match({
+            onLeft: (err) => [err],
+            onRight: (res) => [
+              res.truncated ? 'The listing is truncated' : null,
+              res.dirs.length ? XML.tag('prefixes', {}, ...res.dirs) : null,
+              res.files.length
+                ? XML.tag(
+                    'objects',
+                    {},
+                    ...res.files.map((o) =>
+                      JSON.stringify({
+                        key: o.key,
+                        size: o.size,
+                        modified: o.modified.toISOString(),
+                      }),
+                    ),
+                  )
+                : null,
+            ],
+          }),
+        ),
+        Eff.Option.map((children: XML.Children) =>
+          XML.tag('listing-data', {}, ...children).toString(),
+        ),
+      ),
+    [data],
+  )
+
+  Assistant.Context.usePushContext({
+    markers: { listingReady: Eff.Option.isSome(msg) },
+    messages: Eff.Option.toArray(msg),
+  })
+}

catalog/app/containers/Bucket/Routes.ts

@@ -24,26 +24,28 @@ const mapSegments = (separator: string, map: (s: string) => string) =>
 
 const S3Path = S.brand('S3Path')(S.String)
 
-const S3PathFromString = S.transform(S.String, S3Path, {
-  encode: mapSegments(PATH_SEP, encodeURIComponent),
-  decode: mapSegments(PATH_SEP, decodeURIComponent),
-})
+const S3PathFromString = (S3PathSchema: typeof S3Path) =>
+  S.transform(S.String, S3PathSchema, {
+    encode: mapSegments(PATH_SEP, encodeURIComponent),
+    strict: true,
+    decode: mapSegments(PATH_SEP, decodeURIComponent),
+  })
 
 export const s3Object = Nav.makeRoute({
   name: 'bucket.object',
   path: routes.bucketFile.path,
   exact: true,
   strict: true,
-  description: 'S3 Object (aka File) Detail page',
+  description: 'S3 Object (aka File) page',
   waitForMarkers: ['versionsReady', 'currentVersionReady'],
   pathParams: Nav.fromPathParams(
     S.extend(
       BucketPathParams,
       S.Struct({
-        path: S3PathFromString.annotations({
-          title: 'Object Key',
+        path: S3Path.annotations({
+          title: 'Path',
           description: 'S3 Object Key aka File Path',
-        }),
+        }).pipe(S3PathFromString),
       }),
     ),
   ),
@@ -63,13 +65,25 @@ export const s3Object = Nav.makeRoute({
   }),
 })
 
-// export const bucketDir = route(
-//   '/b/:bucket/tree/:path(.+/)?',
-//   (bucket: string, path: string = '', prefix?: string) =>
-//     `/b/${bucket}/tree/${encode(path)}${mkSearch({ prefix: prefix || undefined })}`,
-// )
-// export type BucketDirArgs = Parameters<typeof bucketDir.url>
-//
+export const s3Prefix = Nav.makeRoute({
+  name: 'bucket.prefix',
+  path: routes.bucketDir.path,
+  exact: true,
+  description: 'S3 Prefix (aka Directory) page',
+  waitForMarkers: ['listingReady'],
+  pathParams: Nav.fromPathParams(
+    S.extend(
+      BucketPathParams,
+      S.Struct({
+        path: S3Path.annotations({
+          title: 'Path',
+          description: 'S3 Prefix aka Directory Path',
+        }).pipe(S3PathFromString),
+      }),
+    ),
+  ),
+})
+
 // interface BucketPackageListOpts {
 //   filter?: string
 //   sort?: string
@@ -140,4 +154,4 @@ export const s3Object = Nav.makeRoute({
 //   (bucket: string, workgroup: string, queryExecutionId: string) =>
 //     `/b/${bucket}/queries/athena/${workgroup}/${queryExecutionId}`,
 
-export default [overview, s3Object]
+export default [s3Object, s3Prefix, overview]