refactor: migrate objects apis

.changeset/cyan-jokes-prove.md

@@ -0,0 +1,5 @@
+---
+'renterd': minor
+---
+
+The files directory and global mode explorers now use the new list objects API.

.changeset/dry-elephants-try.md

@@ -0,0 +1,7 @@
+---
+'@siafoundation/renterd-js': minor
+'@siafoundation/renterd-react': minor
+'@siafoundation/renterd-types': minor
+---
+
+Updated the multipart upload APIs with the new payloads.

apps/renterd/contexts/filesDirectory/dataset.tsx

@@ -1,5 +1,4 @@
-import { ObjectDirectoryParams } from '@siafoundation/renterd-types'
-import { useObjectDirectory } from '@siafoundation/renterd-react'
+import { useObjectList } from '@siafoundation/renterd-react'
 import { useDataset as useDatasetGeneric } from '../filesManager/dataset'
 import { bucketAndKeyParamsFromPath } from '../../lib/paths'
 import { useRouter } from 'next/router'
@@ -19,32 +18,36 @@ export function useDataset() {
   } = useFilesManager()
   const router = useRouter()
   const limit = Number(router.query.limit || defaultLimit)
-  const offset = Number(router.query.offset || 0)
+  const marker = String(router.query.marker)
+
+  const pathParams = bucketAndKeyParamsFromPath(activeDirectoryPath)
 
   const params = useMemo(() => {
-    const p: ObjectDirectoryParams = {
-      ...bucketAndKeyParamsFromPath(activeDirectoryPath),
-      sortBy: sortField,
-      sortDir: sortDirection,
-      offset,
-      limit,
-    }
+    let prefix = pathParams.key
     if (fileNamePrefixFilter) {
-      p.prefix = fileNamePrefixFilter.startsWith('/')
+      prefix += fileNamePrefixFilter.startsWith('/')
         ? fileNamePrefixFilter.slice(1)
         : fileNamePrefixFilter
     }
-    return p
+    return {
+      prefix,
+      bucket: pathParams.bucket,
+      sortBy: sortField,
+      sortDir: sortDirection,
+      marker,
+      limit,
+      delimiter: '/',
+    }
   }, [
-    activeDirectoryPath,
     fileNamePrefixFilter,
+    pathParams,
     sortField,
     sortDirection,
-    offset,
+    marker,
     limit,
   ])
 
-  const response = useObjectDirectory({
+  const response = useObjectList({
     disabled: !activeBucketName,
     params,
     config: {
@@ -57,9 +60,9 @@ export function useDataset() {
   const objects = useMemo(
     () => ({
       isValidating: response.isValidating,
-      data: response.data?.entries,
+      data: response.data?.objects,
     }),
-    [response.isValidating, response.data?.entries]
+    [response.isValidating, response.data?.objects]
   )
 
   const d = useDatasetGeneric({
@@ -69,7 +72,7 @@ export function useDataset() {
 
   return {
     limit,
-    offset,
+    marker,
     response,
     dataset: d.data,
     refresh: response.mutate,

apps/renterd/contexts/filesFlat/dataset.tsx

@@ -1,4 +1,3 @@
-import { ObjectListPayload } from '@siafoundation/renterd-types'
 import { useObjectList } from '@siafoundation/renterd-react'
 import { SortField } from '../filesManager/types'
 import { useDataset as useDatasetGeneric } from '../filesManager/dataset'
@@ -21,22 +20,24 @@ export function useDataset({ sortDirection, sortField }: Props) {
   const marker = router.query.marker as string
 
   const params = useMemo(() => {
-    const p: ObjectListPayload = {
+    let prefix = ''
+    if (fileNamePrefixFilter) {
+      prefix += fileNamePrefixFilter.startsWith('/')
+        ? fileNamePrefixFilter
+        : '/' + fileNamePrefixFilter
+    }
+    return {
+      prefix,
       bucket: activeBucketName,
       sortBy: sortField,
       sortDir: sortDirection,
       marker,
       limit,
+      delimiter: '',
     }
-    if (fileNamePrefixFilter) {
-      p.prefix = fileNamePrefixFilter.startsWith('/')
-        ? fileNamePrefixFilter
-        : '/' + fileNamePrefixFilter
-    }
-    return p
   }, [
-    activeBucketName,
     fileNamePrefixFilter,
+    activeBucketName,
     sortField,
     sortDirection,
     marker,
@@ -45,7 +46,7 @@ export function useDataset({ sortDirection, sortField }: Props) {
 
   const response = useObjectList({
     disabled: !activeBucketName,
-    payload: params,
+    params,
     config: {
       swr: {
         refreshInterval: defaultDatasetRefreshInterval,

apps/renterd/contexts/filesManager/dataset.tsx

@@ -1,4 +1,4 @@
-import { ObjEntry } from '@siafoundation/renterd-types'
+import { ObjectMetadata } from '@siafoundation/renterd-types'
 import { sortBy, toPairs } from '@technically/lodash'
 import useSWR from 'swr'
 import { useContracts } from '../contracts'
@@ -16,7 +16,7 @@ type Props = {
   id: string
   objects: {
     isValidating: boolean
-    data?: ObjEntry[]
+    data?: ObjectMetadata[]
   }
 }
 
@@ -57,7 +57,7 @@ export function useDataset({ id, objects }: Props) {
           }
         })
       } else if (objects.data || uploadsList.length) {
-        objects.data?.forEach(({ name: key, size, health }) => {
+        objects.data?.forEach(({ key, size, health }) => {
           const path = join(activeBucketName, key)
           const name = getFilename(key)
           dataMap[path] = {

apps/renterd/contexts/filesManager/uploads.tsx

@@ -1,5 +1,9 @@
 import { triggerErrorToast } from '@siafoundation/design-system'
-import { Bucket } from '@siafoundation/renterd-types'
+import {
+  Bucket,
+  busListObjectsPrefixRoute,
+  busListObjectsRoute,
+} from '@siafoundation/renterd-types'
 import {
   useBuckets,
   useMultipartUploadAbort,
@@ -106,7 +110,7 @@ export function useUploads({ activeDirectoryPath }: Props) {
       const key = getKeyFromPath(path)
       const multipartUpload = new MultipartUpload({
         file: uploadFile,
-        path: key,
+        key,
         bucket: bucket.name,
         api: ref.current,
         partSize: getMultipartUploadPartSize(
@@ -133,7 +137,7 @@ export function useUploads({ activeDirectoryPath }: Props) {
         }, 1000)
       )
       multipartUpload.setOnComplete(async () => {
-        await ref.current.mutate((key) => key.startsWith('/bus/objects'))
+        await ref.current.mutate((key) => key.startsWith(busListObjectsRoute))
         ref.current.removeUpload(uploadId)
         setTimeout(() => {
           ref.current.checkAndStartUploads()

apps/renterd/contexts/uploads/index.tsx

@@ -46,7 +46,7 @@ function useUploadsMain() {
           await apiBusUploadAbort.post({
             payload: {
               bucket: activeBucket?.name,
-              path: upload.path,
+              key: upload.key,
               uploadID: upload.uploadID,
             },
           })
@@ -59,8 +59,8 @@ function useUploadsMain() {
     return (
       response.data?.uploads?.map((upload) => {
         const id = upload.uploadID
-        const name = getFilename(upload.path)
-        const fullPath = join(activeBucket?.name, upload.path)
+        const name = getFilename(upload.key)
+        const fullPath = join(activeBucket?.name, upload.key)
         const localUpload = uploadsMap[id]
         if (localUpload) {
           {
@@ -83,7 +83,7 @@ function useUploadsMain() {
             await apiBusUploadAbort.post({
               payload: {
                 bucket: activeBucket?.name,
-                path: upload.path,
+                key: upload.key,
                 uploadID: upload.uploadID,
               },
             })

apps/renterd/lib/multipartUpload.ts

@@ -14,7 +14,7 @@ type ApiBusUploadAbort = ReturnType<typeof useMultipartUploadAbort>
 
 export type MultipartParams = {
   bucket: string
-  path: string
+  key: string
   file: File
   api: {
     workerUploadPart: ApiWorkerUploadPart
@@ -41,7 +41,7 @@ type UploadedPart = {
 export class MultipartUpload {
   // params
   #bucket: string
-  #path: string
+  #key: string
   #file: File
   #partSize: number
   #maxConcurrentParts: number
@@ -75,7 +75,7 @@ export class MultipartUpload {
   constructor(options: MultipartParams) {
     // params
     this.#bucket = options.bucket
-    this.#path = options.path
+    this.#key = options.key
     this.#partSize = options.partSize || 1024 * 1024 * 5
     this.#maxConcurrentParts = Math.min(options.maxConcurrentParts || 5, 15)
     this.#file = options.file
@@ -96,8 +96,7 @@ export class MultipartUpload {
   public async create() {
     const createPayload = {
       bucket: this.#bucket,
-      generateKey: true,
-      path: this.#path,
+      key: this.#key,
     }
     const response = await this.#api.busUploadCreate.post({
       payload: createPayload,
@@ -133,7 +132,7 @@ export class MultipartUpload {
       await this.#api.busUploadAbort.post({
         payload: {
           bucket: this.#bucket,
-          path: this.#path,
+          key: this.#key,
           uploadID: this.#uploadId,
         },
       })
@@ -235,7 +234,7 @@ export class MultipartUpload {
     try {
       const payload = {
         bucket: this.#bucket,
-        path: this.#path,
+        key: this.#key,
         uploadID: this.#uploadId,
         parts: this.#uploadedParts.sort((a, b) => a.partNumber - b.partNumber),
       }
@@ -280,7 +279,7 @@ export class MultipartUpload {
     try {
       const response = await this.#api.workerUploadPart.put({
         params: {
-          key: this.#path.slice(1),
+          key: this.#key.slice(1),
           bucket: this.#bucket,
           uploadid: this.#uploadId,
           offset: partOffset,

libs/renterd-js/src/bus.ts

@@ -121,9 +121,6 @@ import {
   ObjectDeleteParams,
   ObjectDeletePayload,
   ObjectDeleteResponse,
-  ObjectDirectoryParams,
-  ObjectDirectoryPayload,
-  ObjectDirectoryResponse,
   ObjectListParams,
   ObjectListPayload,
   ObjectListResponse,
@@ -133,9 +130,6 @@ import {
   ObjectRenamePayload,
   ObjectRenameResponse,
   ObjectResponse,
-  ObjectSearchParams,
-  ObjectSearchPayload,
-  ObjectSearchResponse,
   ObjectsStatsParams,
   ObjectsStatsPayload,
   ObjectsStatsResponse,
@@ -230,10 +224,8 @@ import {
   busMultipartListuploadsRoute,
   busMultipartPartRoute,
   busObjectsKeyRoute,
-  busObjectsListRoute,
   busObjectsRenameRoute,
   busHostsRoute,
-  busSearchObjectsRoute,
   busSettingKeyRoute,
   busSettingsRoute,
   busSlabKeyObjectsRoute,
@@ -255,6 +247,7 @@ import {
   AutopilotsPayload,
   AutopilotsResponse,
   busWalletEventsRoute,
+  busListObjectsPrefixRoute,
 } from '@siafoundation/renterd-types'
 import { buildRequestHandler, initAxios } from '@siafoundation/request'
 import { AxiosRequestConfig } from 'axios'
@@ -468,26 +461,16 @@ export function Bus({ api, password }: { api: string; password?: string }) {
       BucketDeletePayload,
       BucketDeleteResponse
     >(axios, 'delete', busBucketNameRoute),
-    objectDirectory: buildRequestHandler<
-      ObjectDirectoryParams,
-      ObjectDirectoryPayload,
-      ObjectDirectoryResponse
-    >(axios, 'get', busObjectsKeyRoute),
     objectList: buildRequestHandler<
       ObjectListParams,
       ObjectListPayload,
       ObjectListResponse
-    >(axios, 'post', busObjectsListRoute),
+    >(axios, 'get', busListObjectsPrefixRoute),
     object: buildRequestHandler<ObjectParams, ObjectPayload, ObjectResponse>(
       axios,
       'get',
       busObjectsKeyRoute
     ),
-    objectSearch: buildRequestHandler<
-      ObjectSearchParams,
-      ObjectSearchPayload,
-      ObjectSearchResponse
-    >(axios, 'get', busSearchObjectsRoute),
     objectAdd: buildRequestHandler<
       ObjectAddParams,
       ObjectAddPayload,