@milaboratories/pl-drivers 1.9.0 → 1.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/clients/constructors.cjs +45 -0
- package/dist/clients/constructors.cjs.map +1 -0
- package/dist/clients/constructors.d.ts +0 -1
- package/dist/clients/constructors.js +39 -0
- package/dist/clients/constructors.js.map +1 -0
- package/dist/clients/download.cjs +149 -0
- package/dist/clients/download.cjs.map +1 -0
- package/dist/clients/download.d.ts +0 -1
- package/dist/clients/download.js +121 -0
- package/dist/clients/download.js.map +1 -0
- package/dist/clients/logs.cjs +44 -0
- package/dist/clients/logs.cjs.map +1 -0
- package/dist/clients/logs.d.ts +0 -1
- package/dist/clients/logs.js +42 -0
- package/dist/clients/logs.js.map +1 -0
- package/dist/clients/ls_api.cjs +23 -0
- package/dist/clients/ls_api.cjs.map +1 -0
- package/dist/clients/ls_api.d.ts +0 -1
- package/dist/clients/ls_api.js +21 -0
- package/dist/clients/ls_api.js.map +1 -0
- package/dist/clients/progress.cjs +58 -0
- package/dist/clients/progress.cjs.map +1 -0
- package/dist/clients/progress.d.ts +1 -3
- package/dist/clients/progress.js +56 -0
- package/dist/clients/progress.js.map +1 -0
- package/dist/clients/upload.cjs +209 -0
- package/dist/clients/upload.cjs.map +1 -0
- package/dist/clients/upload.d.ts +8 -4
- package/dist/clients/upload.js +183 -0
- package/dist/clients/upload.js.map +1 -0
- package/dist/drivers/download_blob/blob_key.cjs +34 -0
- package/dist/drivers/download_blob/blob_key.cjs.map +1 -0
- package/dist/drivers/download_blob/blob_key.d.ts +0 -1
- package/dist/drivers/download_blob/blob_key.js +12 -0
- package/dist/drivers/download_blob/blob_key.js.map +1 -0
- package/dist/drivers/download_blob/download_blob.cjs +442 -0
- package/dist/drivers/download_blob/download_blob.cjs.map +1 -0
- package/dist/drivers/download_blob/download_blob.d.ts +0 -1
- package/dist/drivers/download_blob/download_blob.js +417 -0
- package/dist/drivers/download_blob/download_blob.js.map +1 -0
- package/dist/drivers/download_blob/download_blob_task.cjs +170 -0
- package/dist/drivers/download_blob/download_blob_task.cjs.map +1 -0
- package/dist/drivers/download_blob/download_blob_task.d.ts +0 -1
- package/dist/drivers/download_blob/download_blob_task.js +146 -0
- package/dist/drivers/download_blob/download_blob_task.js.map +1 -0
- package/dist/drivers/download_blob/sparse_cache/cache.cjs +202 -0
- package/dist/drivers/download_blob/sparse_cache/cache.cjs.map +1 -0
- package/dist/drivers/download_blob/sparse_cache/cache.d.ts +0 -1
- package/dist/drivers/download_blob/sparse_cache/cache.js +197 -0
- package/dist/drivers/download_blob/sparse_cache/cache.js.map +1 -0
- package/dist/drivers/download_blob/sparse_cache/file.cjs +61 -0
- package/dist/drivers/download_blob/sparse_cache/file.cjs.map +1 -0
- package/dist/drivers/download_blob/sparse_cache/file.d.ts +0 -1
- package/dist/drivers/download_blob/sparse_cache/file.js +39 -0
- package/dist/drivers/download_blob/sparse_cache/file.js.map +1 -0
- package/dist/drivers/download_blob/sparse_cache/ranges.cjs +104 -0
- package/dist/drivers/download_blob/sparse_cache/ranges.cjs.map +1 -0
- package/dist/drivers/download_blob/sparse_cache/ranges.d.ts +0 -1
- package/dist/drivers/download_blob/sparse_cache/ranges.js +76 -0
- package/dist/drivers/download_blob/sparse_cache/ranges.js.map +1 -0
- package/dist/drivers/download_blob_url/driver.cjs +169 -0
- package/dist/drivers/download_blob_url/driver.cjs.map +1 -0
- package/dist/drivers/download_blob_url/driver.d.ts +0 -1
- package/dist/drivers/download_blob_url/driver.js +148 -0
- package/dist/drivers/download_blob_url/driver.js.map +1 -0
- package/dist/drivers/download_blob_url/driver_id.cjs +9 -0
- package/dist/drivers/download_blob_url/driver_id.cjs.map +1 -0
- package/dist/drivers/download_blob_url/driver_id.d.ts +0 -1
- package/dist/drivers/download_blob_url/driver_id.js +7 -0
- package/dist/drivers/download_blob_url/driver_id.js.map +1 -0
- package/dist/drivers/download_blob_url/snapshot.cjs +18 -0
- package/dist/drivers/download_blob_url/snapshot.cjs.map +1 -0
- package/dist/drivers/download_blob_url/snapshot.d.ts +2 -3
- package/dist/drivers/download_blob_url/snapshot.js +15 -0
- package/dist/drivers/download_blob_url/snapshot.js.map +1 -0
- package/dist/drivers/download_blob_url/task.cjs +209 -0
- package/dist/drivers/download_blob_url/task.cjs.map +1 -0
- package/dist/drivers/download_blob_url/task.d.ts +0 -1
- package/dist/drivers/download_blob_url/task.js +184 -0
- package/dist/drivers/download_blob_url/task.js.map +1 -0
- package/dist/drivers/download_blob_url/url.d.ts +1 -1
- package/dist/drivers/download_url/driver.cjs +149 -0
- package/dist/drivers/download_url/driver.cjs.map +1 -0
- package/dist/drivers/download_url/driver.d.ts +0 -1
- package/dist/drivers/download_url/driver.js +128 -0
- package/dist/drivers/download_url/driver.js.map +1 -0
- package/dist/drivers/download_url/task.cjs +150 -0
- package/dist/drivers/download_url/task.cjs.map +1 -0
- package/dist/drivers/download_url/task.d.ts +0 -1
- package/dist/drivers/download_url/task.js +124 -0
- package/dist/drivers/download_url/task.js.map +1 -0
- package/dist/drivers/helpers/download_local_handle.cjs +26 -0
- package/dist/drivers/helpers/download_local_handle.cjs.map +1 -0
- package/dist/drivers/helpers/download_local_handle.d.ts +0 -1
- package/dist/drivers/helpers/download_local_handle.js +22 -0
- package/dist/drivers/helpers/download_local_handle.js.map +1 -0
- package/dist/drivers/helpers/download_remote_handle.cjs +36 -0
- package/dist/drivers/helpers/download_remote_handle.cjs.map +1 -0
- package/dist/drivers/helpers/download_remote_handle.d.ts +0 -1
- package/dist/drivers/helpers/download_remote_handle.js +32 -0
- package/dist/drivers/helpers/download_remote_handle.js.map +1 -0
- package/dist/drivers/helpers/files_cache.cjs +68 -0
- package/dist/drivers/helpers/files_cache.cjs.map +1 -0
- package/dist/drivers/helpers/files_cache.d.ts +0 -1
- package/dist/drivers/helpers/files_cache.js +66 -0
- package/dist/drivers/helpers/files_cache.js.map +1 -0
- package/dist/drivers/helpers/helpers.cjs +34 -0
- package/dist/drivers/helpers/helpers.cjs.map +1 -0
- package/dist/drivers/helpers/helpers.d.ts +0 -1
- package/dist/drivers/helpers/helpers.js +31 -0
- package/dist/drivers/helpers/helpers.js.map +1 -0
- package/dist/drivers/helpers/logs_handle.cjs +50 -0
- package/dist/drivers/helpers/logs_handle.cjs.map +1 -0
- package/dist/drivers/helpers/logs_handle.d.ts +0 -1
- package/dist/drivers/helpers/logs_handle.js +43 -0
- package/dist/drivers/helpers/logs_handle.js.map +1 -0
- package/dist/drivers/helpers/ls_remote_import_handle.cjs +34 -0
- package/dist/drivers/helpers/ls_remote_import_handle.cjs.map +1 -0
- package/dist/drivers/helpers/ls_remote_import_handle.d.ts +0 -1
- package/dist/drivers/helpers/ls_remote_import_handle.js +29 -0
- package/dist/drivers/helpers/ls_remote_import_handle.js.map +1 -0
- package/dist/drivers/helpers/ls_storage_entry.cjs +64 -0
- package/dist/drivers/helpers/ls_storage_entry.cjs.map +1 -0
- package/dist/drivers/helpers/ls_storage_entry.d.ts +0 -1
- package/dist/drivers/helpers/ls_storage_entry.js +58 -0
- package/dist/drivers/helpers/ls_storage_entry.js.map +1 -0
- package/dist/drivers/helpers/polling_ops.d.ts +0 -1
- package/dist/drivers/helpers/read_file.cjs +54 -0
- package/dist/drivers/helpers/read_file.cjs.map +1 -0
- package/dist/drivers/helpers/read_file.d.ts +0 -1
- package/dist/drivers/helpers/read_file.js +33 -0
- package/dist/drivers/helpers/read_file.js.map +1 -0
- package/dist/drivers/helpers/test_helpers.d.ts +0 -1
- package/dist/drivers/logs.cjs +118 -0
- package/dist/drivers/logs.cjs.map +1 -0
- package/dist/drivers/logs.d.ts +0 -1
- package/dist/drivers/logs.js +116 -0
- package/dist/drivers/logs.js.map +1 -0
- package/dist/drivers/logs_stream.cjs +238 -0
- package/dist/drivers/logs_stream.cjs.map +1 -0
- package/dist/drivers/logs_stream.d.ts +0 -1
- package/dist/drivers/logs_stream.js +236 -0
- package/dist/drivers/logs_stream.js.map +1 -0
- package/dist/drivers/ls.cjs +236 -0
- package/dist/drivers/ls.cjs.map +1 -0
- package/dist/drivers/ls.d.ts +0 -1
- package/dist/drivers/ls.js +214 -0
- package/dist/drivers/ls.js.map +1 -0
- package/dist/drivers/types.cjs +72 -0
- package/dist/drivers/types.cjs.map +1 -0
- package/dist/drivers/types.d.ts +4 -5
- package/dist/drivers/types.js +64 -0
- package/dist/drivers/types.js.map +1 -0
- package/dist/drivers/upload.cjs +154 -0
- package/dist/drivers/upload.cjs.map +1 -0
- package/dist/drivers/upload.d.ts +0 -1
- package/dist/drivers/upload.js +151 -0
- package/dist/drivers/upload.js.map +1 -0
- package/dist/drivers/upload_task.cjs +297 -0
- package/dist/drivers/upload_task.cjs.map +1 -0
- package/dist/drivers/upload_task.d.ts +2 -3
- package/dist/drivers/upload_task.js +289 -0
- package/dist/drivers/upload_task.js.map +1 -0
- package/dist/drivers/urls/url.cjs +59 -0
- package/dist/drivers/urls/url.cjs.map +1 -0
- package/dist/drivers/urls/url.d.ts +0 -1
- package/dist/drivers/urls/url.js +54 -0
- package/dist/drivers/urls/url.js.map +1 -0
- package/dist/drivers/virtual_storages.cjs +53 -0
- package/dist/drivers/virtual_storages.cjs.map +1 -0
- package/dist/drivers/virtual_storages.d.ts +0 -1
- package/dist/drivers/virtual_storages.js +51 -0
- package/dist/drivers/virtual_storages.js.map +1 -0
- package/dist/helpers/download.cjs +63 -0
- package/dist/helpers/download.cjs.map +1 -0
- package/dist/helpers/download.d.ts +0 -1
- package/dist/helpers/download.js +60 -0
- package/dist/helpers/download.js.map +1 -0
- package/dist/helpers/validate.cjs +12 -0
- package/dist/helpers/validate.cjs.map +1 -0
- package/dist/helpers/validate.d.ts +0 -1
- package/dist/helpers/validate.js +10 -0
- package/dist/helpers/validate.js.map +1 -0
- package/dist/index.cjs +73 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.ts +0 -1
- package/dist/index.js +19 -2
- package/dist/index.js.map +1 -1
- package/dist/proto/github.com/googleapis/googleapis/google/rpc/status.d.ts +0 -1
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/downloadapi/protocol.cjs +261 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/downloadapi/protocol.cjs.map +1 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/downloadapi/protocol.client.cjs +31 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/downloadapi/protocol.client.cjs.map +1 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/downloadapi/protocol.client.d.ts +3 -5
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/downloadapi/protocol.client.js +29 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/downloadapi/protocol.client.js.map +1 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/downloadapi/protocol.d.ts +0 -1
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/downloadapi/protocol.js +256 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/downloadapi/protocol.js.map +1 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/lsapi/protocol.cjs +301 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/lsapi/protocol.cjs.map +1 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/lsapi/protocol.client.cjs +34 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/lsapi/protocol.client.cjs.map +1 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/lsapi/protocol.client.d.ts +3 -5
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/lsapi/protocol.client.js +32 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/lsapi/protocol.client.js.map +1 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/lsapi/protocol.d.ts +0 -1
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/lsapi/protocol.js +296 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/lsapi/protocol.js.map +1 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/progressapi/protocol.cjs +410 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/progressapi/protocol.cjs.map +1 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/progressapi/protocol.client.cjs +38 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/progressapi/protocol.client.cjs.map +1 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/progressapi/protocol.client.d.ts +3 -5
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/progressapi/protocol.client.js +36 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/progressapi/protocol.client.js.map +1 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/progressapi/protocol.d.ts +0 -1
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/progressapi/protocol.js +403 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/progressapi/protocol.js.map +1 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/streamingapi/protocol.cjs +486 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/streamingapi/protocol.cjs.map +1 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/streamingapi/protocol.client.cjs +86 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/streamingapi/protocol.client.cjs.map +1 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/streamingapi/protocol.client.d.ts +3 -5
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/streamingapi/protocol.client.js +84 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/streamingapi/protocol.client.js.map +1 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/streamingapi/protocol.d.ts +0 -1
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/streamingapi/protocol.js +478 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/streamingapi/protocol.js.map +1 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol.cjs +758 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol.cjs.map +1 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol.client.cjs +71 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol.client.cjs.map +1 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol.client.d.ts +3 -5
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol.client.js +69 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol.client.js.map +1 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol.d.ts +36 -1
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol.js +747 -0
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol.js.map +1 -0
- package/dist/proto/github.com/milaboratory/pl/plapi/plapiproto/api.client.d.ts +3 -5
- package/dist/proto/github.com/milaboratory/pl/plapi/plapiproto/api.d.ts +0 -1
- package/dist/proto/github.com/milaboratory/pl/plapi/plapiproto/api_types.d.ts +0 -1
- package/dist/proto/github.com/milaboratory/pl/plapi/plapiproto/base_types.d.ts +0 -1
- package/dist/proto/github.com/milaboratory/pl/plapi/plapiproto/import.d.ts +0 -1
- package/dist/proto/github.com/milaboratory/pl/plapi/plapiproto/resource_types.d.ts +0 -1
- package/dist/proto/google/api/http.d.ts +0 -1
- package/dist/proto/google/protobuf/any.d.ts +0 -1
- package/dist/proto/google/protobuf/descriptor.d.ts +0 -1
- package/dist/proto/google/protobuf/duration.cjs +105 -0
- package/dist/proto/google/protobuf/duration.cjs.map +1 -0
- package/dist/proto/google/protobuf/duration.d.ts +0 -1
- package/dist/proto/google/protobuf/duration.js +103 -0
- package/dist/proto/google/protobuf/duration.js.map +1 -0
- package/dist/proto/google/protobuf/empty.d.ts +0 -1
- package/dist/proto/google/protobuf/struct.d.ts +0 -1
- package/dist/proto/google/protobuf/timestamp.cjs +133 -0
- package/dist/proto/google/protobuf/timestamp.cjs.map +1 -0
- package/dist/proto/google/protobuf/timestamp.d.ts +0 -1
- package/dist/proto/google/protobuf/timestamp.js +131 -0
- package/dist/proto/google/protobuf/timestamp.js.map +1 -0
- package/dist/proto/google/protobuf/wrappers.d.ts +0 -1
- package/dist/test_env.d.ts +0 -1
- package/package.json +17 -15
- package/src/clients/upload.ts +38 -14
- package/src/drivers/upload_task.ts +10 -3
- package/src/proto/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol.ts +69 -1
- package/dist/clients/constructors.d.ts.map +0 -1
- package/dist/clients/download.d.ts.map +0 -1
- package/dist/clients/logs.d.ts.map +0 -1
- package/dist/clients/ls_api.d.ts.map +0 -1
- package/dist/clients/progress.d.ts.map +0 -1
- package/dist/clients/upload.d.ts.map +0 -1
- package/dist/drivers/download_blob/blob_key.d.ts.map +0 -1
- package/dist/drivers/download_blob/download_blob.d.ts.map +0 -1
- package/dist/drivers/download_blob/download_blob_task.d.ts.map +0 -1
- package/dist/drivers/download_blob/sparse_cache/cache.d.ts.map +0 -1
- package/dist/drivers/download_blob/sparse_cache/file.d.ts.map +0 -1
- package/dist/drivers/download_blob/sparse_cache/ranges.d.ts.map +0 -1
- package/dist/drivers/download_blob_url/driver.d.ts.map +0 -1
- package/dist/drivers/download_blob_url/driver_id.d.ts.map +0 -1
- package/dist/drivers/download_blob_url/snapshot.d.ts.map +0 -1
- package/dist/drivers/download_blob_url/task.d.ts.map +0 -1
- package/dist/drivers/download_blob_url/url.d.ts.map +0 -1
- package/dist/drivers/download_url/driver.d.ts.map +0 -1
- package/dist/drivers/download_url/task.d.ts.map +0 -1
- package/dist/drivers/helpers/download_local_handle.d.ts.map +0 -1
- package/dist/drivers/helpers/download_remote_handle.d.ts.map +0 -1
- package/dist/drivers/helpers/files_cache.d.ts.map +0 -1
- package/dist/drivers/helpers/helpers.d.ts.map +0 -1
- package/dist/drivers/helpers/logs_handle.d.ts.map +0 -1
- package/dist/drivers/helpers/ls_remote_import_handle.d.ts.map +0 -1
- package/dist/drivers/helpers/ls_storage_entry.d.ts.map +0 -1
- package/dist/drivers/helpers/polling_ops.d.ts.map +0 -1
- package/dist/drivers/helpers/read_file.d.ts.map +0 -1
- package/dist/drivers/helpers/test_helpers.d.ts.map +0 -1
- package/dist/drivers/logs.d.ts.map +0 -1
- package/dist/drivers/logs_stream.d.ts.map +0 -1
- package/dist/drivers/ls.d.ts.map +0 -1
- package/dist/drivers/types.d.ts.map +0 -1
- package/dist/drivers/upload.d.ts.map +0 -1
- package/dist/drivers/upload_task.d.ts.map +0 -1
- package/dist/drivers/urls/url.d.ts.map +0 -1
- package/dist/drivers/virtual_storages.d.ts.map +0 -1
- package/dist/helpers/download.d.ts.map +0 -1
- package/dist/helpers/validate.d.ts.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/index.mjs +0 -4892
- package/dist/index.mjs.map +0 -1
- package/dist/proto/github.com/googleapis/googleapis/google/rpc/status.d.ts.map +0 -1
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/downloadapi/protocol.client.d.ts.map +0 -1
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/downloadapi/protocol.d.ts.map +0 -1
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/lsapi/protocol.client.d.ts.map +0 -1
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/lsapi/protocol.d.ts.map +0 -1
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/progressapi/protocol.client.d.ts.map +0 -1
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/progressapi/protocol.d.ts.map +0 -1
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/streamingapi/protocol.client.d.ts.map +0 -1
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/streamingapi/protocol.d.ts.map +0 -1
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol.client.d.ts.map +0 -1
- package/dist/proto/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol.d.ts.map +0 -1
- package/dist/proto/github.com/milaboratory/pl/plapi/plapiproto/api.client.d.ts.map +0 -1
- package/dist/proto/github.com/milaboratory/pl/plapi/plapiproto/api.d.ts.map +0 -1
- package/dist/proto/github.com/milaboratory/pl/plapi/plapiproto/api_types.d.ts.map +0 -1
- package/dist/proto/github.com/milaboratory/pl/plapi/plapiproto/base_types.d.ts.map +0 -1
- package/dist/proto/github.com/milaboratory/pl/plapi/plapiproto/import.d.ts.map +0 -1
- package/dist/proto/github.com/milaboratory/pl/plapi/plapiproto/resource_types.d.ts.map +0 -1
- package/dist/proto/google/api/http.d.ts.map +0 -1
- package/dist/proto/google/protobuf/any.d.ts.map +0 -1
- package/dist/proto/google/protobuf/descriptor.d.ts.map +0 -1
- package/dist/proto/google/protobuf/duration.d.ts.map +0 -1
- package/dist/proto/google/protobuf/empty.d.ts.map +0 -1
- package/dist/proto/google/protobuf/struct.d.ts.map +0 -1
- package/dist/proto/google/protobuf/timestamp.d.ts.map +0 -1
- package/dist/proto/google/protobuf/wrappers.d.ts.map +0 -1
- package/dist/test_env.d.ts.map +0 -1
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
import { isNotNullResourceId } from '@milaboratories/pl-client';
|
|
2
|
+
import { isImportFileHandleIndex } from '@milaboratories/pl-model-common';
|
|
3
|
+
import * as path from 'node:path';
|
|
4
|
+
import * as fsp from 'node:fs/promises';
|
|
5
|
+
import { parseIndexHandle, parseUploadHandle, createIndexImportHandle, createUploadImportHandle } from './helpers/ls_remote_import_handle.js';
|
|
6
|
+
import { createLocalStorageHandle, createRemoteStorageHandle, parseStorageHandle } from './helpers/ls_storage_entry.js';
|
|
7
|
+
import { validateAbsolute } from '../helpers/validate.js';
|
|
8
|
+
import { DefaultVirtualLocalStorages } from './virtual_storages.js';
|
|
9
|
+
import { createLsFilesClient } from '../clients/constructors.js';
|
|
10
|
+
|
|
11
|
+
class LsDriver {
|
|
12
|
+
logger;
|
|
13
|
+
lsClient;
|
|
14
|
+
storageIdToResourceId;
|
|
15
|
+
signer;
|
|
16
|
+
virtualStoragesMap;
|
|
17
|
+
localProjectionsMap;
|
|
18
|
+
openFileDialogCallback;
|
|
19
|
+
constructor(logger, lsClient,
|
|
20
|
+
/** Pl storage id, to resource id. The resource id can be used to make LS GRPC calls to. */
|
|
21
|
+
storageIdToResourceId, signer,
|
|
22
|
+
/** Virtual storages by name */
|
|
23
|
+
virtualStoragesMap,
|
|
24
|
+
/** Local projections by storageId */
|
|
25
|
+
localProjectionsMap, openFileDialogCallback) {
|
|
26
|
+
this.logger = logger;
|
|
27
|
+
this.lsClient = lsClient;
|
|
28
|
+
this.storageIdToResourceId = storageIdToResourceId;
|
|
29
|
+
this.signer = signer;
|
|
30
|
+
this.virtualStoragesMap = virtualStoragesMap;
|
|
31
|
+
this.localProjectionsMap = localProjectionsMap;
|
|
32
|
+
this.openFileDialogCallback = openFileDialogCallback;
|
|
33
|
+
}
|
|
34
|
+
async getLocalFileContent(file, range) {
|
|
35
|
+
const localPath = await this.tryResolveLocalFileHandle(file);
|
|
36
|
+
if (range)
|
|
37
|
+
throw new Error('Range request not yet supported.');
|
|
38
|
+
return await fsp.readFile(localPath);
|
|
39
|
+
}
|
|
40
|
+
async getLocalFileSize(file) {
|
|
41
|
+
const localPath = await this.tryResolveLocalFileHandle(file);
|
|
42
|
+
const stat = await fsp.stat(localPath);
|
|
43
|
+
return stat.size;
|
|
44
|
+
}
|
|
45
|
+
async showOpenMultipleFilesDialog(ops) {
|
|
46
|
+
const result = await this.openFileDialogCallback(true, ops);
|
|
47
|
+
if (result === undefined)
|
|
48
|
+
return {};
|
|
49
|
+
return {
|
|
50
|
+
files: await Promise.all(result.map((localPath) => this.getLocalFileHandle(localPath))),
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
async showOpenSingleFileDialog(ops) {
|
|
54
|
+
const result = await this.openFileDialogCallback(false, ops);
|
|
55
|
+
if (result === undefined)
|
|
56
|
+
return {};
|
|
57
|
+
return {
|
|
58
|
+
file: await this.getLocalFileHandle(result[0]),
|
|
59
|
+
};
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Resolves local handle to local file path.
|
|
63
|
+
*
|
|
64
|
+
* @param handle handle to be resolved
|
|
65
|
+
* @private
|
|
66
|
+
*/
|
|
67
|
+
async tryResolveLocalFileHandle(handle) {
|
|
68
|
+
if (isImportFileHandleIndex(handle)) {
|
|
69
|
+
const handleData = parseIndexHandle(handle);
|
|
70
|
+
const localProjection = this.localProjectionsMap.get(handleData.storageId);
|
|
71
|
+
if (!localProjection)
|
|
72
|
+
throw new Error(`Storage ${handleData.storageId} is not mounted locally.`);
|
|
73
|
+
return path.join(localProjection.localPath, handleData.path);
|
|
74
|
+
}
|
|
75
|
+
else {
|
|
76
|
+
const handleData = parseUploadHandle(handle);
|
|
77
|
+
// checking it is a valid local handle from out machine
|
|
78
|
+
this.signer.verify(handleData.localPath, handleData.pathSignature, 'Failed to validate local file handle signature.');
|
|
79
|
+
const localPath = handleData.localPath;
|
|
80
|
+
const stat = await fsp.stat(localPath, { bigint: true });
|
|
81
|
+
if (String(stat.mtimeMs / 1000n) !== handleData.modificationTime)
|
|
82
|
+
throw new Error('File has changed since the handle was created.');
|
|
83
|
+
return localPath;
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
async getLocalFileHandle(localPath) {
|
|
87
|
+
validateAbsolute(localPath);
|
|
88
|
+
// Checking if local path is directly reachable by pl, because it is in one of the
|
|
89
|
+
// locally mounted storages
|
|
90
|
+
for (const lp of this.localProjectionsMap.values()) {
|
|
91
|
+
// note: empty lp.localPath will match any address
|
|
92
|
+
if (localPath.startsWith(lp.localPath)) {
|
|
93
|
+
// Just in case:
|
|
94
|
+
// > path.relative("/a/b", "/a/b/c");
|
|
95
|
+
// 'c'
|
|
96
|
+
const pathWithinStorage = lp.localPath === '' ? localPath : path.relative(lp.localPath, localPath);
|
|
97
|
+
return createIndexImportHandle(lp.storageId, pathWithinStorage);
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
// we get here if none of the local projections matched the path
|
|
101
|
+
const stat = await fsp.stat(localPath, { bigint: true });
|
|
102
|
+
return createUploadImportHandle(localPath, this.signer, stat.size, stat.mtimeMs / 1000n);
|
|
103
|
+
}
|
|
104
|
+
async getStorageList() {
|
|
105
|
+
const virtualStorages = [...this.virtualStoragesMap.values()].map((s) => ({
|
|
106
|
+
name: s.name,
|
|
107
|
+
handle: createLocalStorageHandle(s.name, s.root),
|
|
108
|
+
initialFullPath: s.initialPath,
|
|
109
|
+
}));
|
|
110
|
+
const otherStorages = Object.entries(this.storageIdToResourceId).map(([storageId, resourceId]) => ({
|
|
111
|
+
name: storageId,
|
|
112
|
+
handle: createRemoteStorageHandle(storageId, resourceId),
|
|
113
|
+
initialFullPath: '', // we don't have any additional information from where to start browsing remote storages
|
|
114
|
+
isInitialPathHome: false,
|
|
115
|
+
}));
|
|
116
|
+
// root must be a storage so we can index any file,
|
|
117
|
+
// but for UI it's enough
|
|
118
|
+
// to have local virtual storage on *nix,
|
|
119
|
+
// and local_disk_${drive} on Windows.
|
|
120
|
+
const noRoot = otherStorages.filter((it) => it.name !== 'root');
|
|
121
|
+
return [...virtualStorages, ...noRoot];
|
|
122
|
+
}
|
|
123
|
+
async listFiles(storageHandle, fullPath) {
|
|
124
|
+
const storageData = parseStorageHandle(storageHandle);
|
|
125
|
+
if (storageData.isRemote) {
|
|
126
|
+
const response = await this.lsClient.list(storageData, fullPath);
|
|
127
|
+
return {
|
|
128
|
+
entries: response.items.map((e) => ({
|
|
129
|
+
type: e.isDir ? 'dir' : 'file',
|
|
130
|
+
name: e.name,
|
|
131
|
+
fullPath: e.fullName,
|
|
132
|
+
handle: createIndexImportHandle(storageData.name, e.fullName),
|
|
133
|
+
})),
|
|
134
|
+
};
|
|
135
|
+
}
|
|
136
|
+
if (path.sep === '/' && fullPath === '')
|
|
137
|
+
fullPath = '/';
|
|
138
|
+
if (storageData.rootPath === '') {
|
|
139
|
+
validateAbsolute(fullPath);
|
|
140
|
+
}
|
|
141
|
+
const lsRoot = path.isAbsolute(fullPath) ? fullPath : path.join(storageData.rootPath, fullPath);
|
|
142
|
+
const entries = [];
|
|
143
|
+
for await (const dirent of await fsp.opendir(lsRoot)) {
|
|
144
|
+
if (!dirent.isFile() && !dirent.isDirectory())
|
|
145
|
+
continue;
|
|
146
|
+
// We cannot use no dirent.fullPath no dirent.parentPath,
|
|
147
|
+
// since the former is deprecated
|
|
148
|
+
// and the later works differently on different versions.
|
|
149
|
+
const absolutePath = path.join(lsRoot, dirent.name);
|
|
150
|
+
entries.push({
|
|
151
|
+
type: dirent.isFile() ? 'file' : 'dir',
|
|
152
|
+
name: dirent.name,
|
|
153
|
+
fullPath: absolutePath,
|
|
154
|
+
handle: await this.getLocalFileHandle(absolutePath),
|
|
155
|
+
});
|
|
156
|
+
}
|
|
157
|
+
return { entries };
|
|
158
|
+
}
|
|
159
|
+
async listRemoteFilesWithAdditionalInfo(storageHandle, fullPath) {
|
|
160
|
+
const storageData = parseStorageHandle(storageHandle);
|
|
161
|
+
if (!storageData.isRemote) {
|
|
162
|
+
throw new Error(`Storage ${storageData.name} is not remote`);
|
|
163
|
+
}
|
|
164
|
+
const response = await this.lsClient.list(storageData, fullPath);
|
|
165
|
+
return {
|
|
166
|
+
entries: response.items.map((e) => ({
|
|
167
|
+
type: e.isDir ? 'dir' : 'file',
|
|
168
|
+
name: e.name,
|
|
169
|
+
fullPath: e.fullName,
|
|
170
|
+
handle: createIndexImportHandle(storageData.name, e.fullName),
|
|
171
|
+
size: Number(e.size),
|
|
172
|
+
})),
|
|
173
|
+
};
|
|
174
|
+
}
|
|
175
|
+
async fileToImportHandle(file) {
|
|
176
|
+
throw new Error('Not implemented. This method must be implemented and intercepted in desktop preload script.');
|
|
177
|
+
}
|
|
178
|
+
static async init(logger, client, signer,
|
|
179
|
+
/** Pl storages available locally */
|
|
180
|
+
localProjections, openFileDialogCallback, virtualStorages) {
|
|
181
|
+
const lsClient = createLsFilesClient(client, logger);
|
|
182
|
+
if (!virtualStorages)
|
|
183
|
+
virtualStorages = await DefaultVirtualLocalStorages();
|
|
184
|
+
// validating inputs
|
|
185
|
+
for (const vp of virtualStorages)
|
|
186
|
+
validateAbsolute(vp.root);
|
|
187
|
+
for (const lp of localProjections)
|
|
188
|
+
if (lp.localPath !== '')
|
|
189
|
+
validateAbsolute(lp.localPath);
|
|
190
|
+
// creating indexed maps for quick access
|
|
191
|
+
const virtualStoragesMap = new Map(virtualStorages.map((s) => [s.name, s]));
|
|
192
|
+
const localProjectionsMap = new Map(localProjections.map((s) => [s.storageId, s]));
|
|
193
|
+
// validating there is no intersection
|
|
194
|
+
if (new Set([...virtualStoragesMap.keys(), ...localProjectionsMap.keys()]).size
|
|
195
|
+
!== virtualStoragesMap.size + localProjectionsMap.size)
|
|
196
|
+
throw new Error('Intersection between local projection storage ids and virtual storages names detected.');
|
|
197
|
+
return new LsDriver(logger, lsClient, await doGetAvailableStorageIds(client), signer, virtualStoragesMap, localProjectionsMap, openFileDialogCallback);
|
|
198
|
+
}
|
|
199
|
+
}
|
|
200
|
+
async function doGetAvailableStorageIds(client) {
|
|
201
|
+
return client.withReadTx('GetAvailableStorageIds', async (tx) => {
|
|
202
|
+
const lsProviderId = await tx.getResourceByName('LSProvider');
|
|
203
|
+
const provider = await tx.getResourceData(lsProviderId, true);
|
|
204
|
+
return providerToStorageIds(provider);
|
|
205
|
+
});
|
|
206
|
+
}
|
|
207
|
+
function providerToStorageIds(provider) {
|
|
208
|
+
return Object.fromEntries(provider.fields
|
|
209
|
+
.filter((f) => f.type == 'Dynamic' && isNotNullResourceId(f.value))
|
|
210
|
+
.map((f) => [f.name.substring('storage/'.length), f.value]));
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
export { LsDriver };
|
|
214
|
+
//# sourceMappingURL=ls.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ls.js","sources":["../../src/drivers/ls.ts"],"sourcesContent":["import type { PlClient, ResourceData, ResourceId } from '@milaboratories/pl-client';\nimport { isNotNullResourceId } from '@milaboratories/pl-client';\nimport type { MiLogger, Signer } from '@milaboratories/ts-helpers';\nimport type * as sdk from '@milaboratories/pl-model-common';\nimport type {\n LocalImportFileHandle,\n LsEntry,\n OpenDialogOps,\n OpenMultipleFilesResponse,\n OpenSingleFileResponse,\n TableRange,\n} from '@milaboratories/pl-model-common';\nimport {\n isImportFileHandleIndex,\n} from '@milaboratories/pl-model-common';\nimport type { ClientLs } from '../clients/ls_api';\nimport * as path from 'node:path';\nimport * as fsp from 'node:fs/promises';\nimport {\n createIndexImportHandle,\n createUploadImportHandle,\n parseIndexHandle,\n parseUploadHandle,\n} from './helpers/ls_remote_import_handle';\nimport {\n createLocalStorageHandle,\n createRemoteStorageHandle,\n parseStorageHandle,\n} from './helpers/ls_storage_entry';\nimport type { LocalStorageProjection, VirtualLocalStorageSpec } from './types';\nimport { validateAbsolute } from '../helpers/validate';\nimport { DefaultVirtualLocalStorages } from './virtual_storages';\nimport { createLsFilesClient } from '../clients/constructors';\n\n/**\n * Extends public and safe SDK's driver API with methods used internally in the middle\n * layer and in tests.\n */\nexport interface InternalLsDriver extends sdk.LsDriver {\n /**\n * Given local path, generates well-structured and signed upload handle.\n * To be used in tests and in implementation of the native file selection UI API.\n * */\n getLocalFileHandle(localPath: string): Promise<sdk.LocalImportFileHandle>;\n\n listRemoteFilesWithAdditionalInfo(storage: sdk.StorageHandle, fullPath: string): Promise<ListRemoteFilesResultWithAdditionalInfo>;\n}\n\nexport type ListRemoteFilesResultWithAdditionalInfo = {\n parent?: string;\n entries: LsEntryWithAdditionalInfo[];\n};\n\nexport type LsEntryWithAdditionalInfo = LsEntry & {\n size: number;\n};\n\nexport type OpenFileDialogCallback = (\n multipleFiles: boolean,\n ops?: OpenDialogOps\n) => Promise<undefined | string[]>;\n\nexport class LsDriver implements InternalLsDriver {\n private constructor(\n private readonly logger: MiLogger,\n private readonly lsClient: ClientLs,\n /** Pl storage id, to resource id. The resource id can be used to make LS GRPC calls to. */\n private readonly storageIdToResourceId: Record<string, ResourceId>,\n private readonly signer: Signer,\n /** Virtual storages by name */\n private readonly virtualStoragesMap: Map<string, VirtualLocalStorageSpec>,\n /** Local projections by storageId */\n private readonly localProjectionsMap: Map<string, LocalStorageProjection>,\n private readonly openFileDialogCallback: OpenFileDialogCallback,\n ) {}\n\n public async getLocalFileContent(\n file: LocalImportFileHandle,\n range?: TableRange,\n ): Promise<Uint8Array> {\n const localPath = await this.tryResolveLocalFileHandle(file);\n if (range) throw new Error('Range request not yet supported.');\n return await fsp.readFile(localPath);\n }\n\n public async getLocalFileSize(file: LocalImportFileHandle): Promise<number> {\n const localPath = await this.tryResolveLocalFileHandle(file);\n const stat = await fsp.stat(localPath);\n return stat.size;\n }\n\n public async showOpenMultipleFilesDialog(\n ops?: OpenDialogOps,\n ): Promise<OpenMultipleFilesResponse> {\n const result = await this.openFileDialogCallback(true, ops);\n if (result === undefined) return {};\n return {\n files: await Promise.all(result.map((localPath) => this.getLocalFileHandle(localPath))),\n };\n }\n\n public async showOpenSingleFileDialog(ops?: OpenDialogOps): Promise<OpenSingleFileResponse> {\n const result = await this.openFileDialogCallback(false, ops);\n if (result === undefined) return {};\n return {\n file: await this.getLocalFileHandle(result[0]),\n };\n }\n\n /**\n * Resolves local handle to local file path.\n *\n * @param handle handle to be resolved\n * @private\n */\n private async tryResolveLocalFileHandle(handle: LocalImportFileHandle): Promise<string> {\n if (isImportFileHandleIndex(handle)) {\n const handleData = parseIndexHandle(handle);\n const localProjection = this.localProjectionsMap.get(handleData.storageId);\n if (!localProjection)\n throw new Error(`Storage ${handleData.storageId} is not mounted locally.`);\n return path.join(localProjection.localPath, handleData.path);\n } else {\n const handleData = parseUploadHandle(handle);\n // checking it is a valid local handle from out machine\n this.signer.verify(\n handleData.localPath,\n handleData.pathSignature,\n 'Failed to validate local file handle signature.',\n );\n\n const localPath = handleData.localPath;\n\n const stat = await fsp.stat(localPath, { bigint: true });\n if (String(stat.mtimeMs / 1000n) !== handleData.modificationTime)\n throw new Error('File has changed since the handle was created.');\n\n return localPath;\n }\n }\n\n public async getLocalFileHandle(\n localPath: string,\n ): Promise<sdk.ImportFileHandle & LocalImportFileHandle> {\n validateAbsolute(localPath);\n\n // Checking if local path is directly reachable by pl, because it is in one of the\n // locally mounted storages\n for (const lp of this.localProjectionsMap.values()) {\n // note: empty lp.localPath will match any address\n if (localPath.startsWith(lp.localPath)) {\n // Just in case:\n // > path.relative(\"/a/b\", \"/a/b/c\");\n // 'c'\n const pathWithinStorage\n = lp.localPath === '' ? localPath : path.relative(lp.localPath, localPath);\n return createIndexImportHandle(\n lp.storageId,\n pathWithinStorage,\n ) as sdk.ImportFileHandleIndex & LocalImportFileHandle;\n }\n }\n\n // we get here if none of the local projections matched the path\n\n const stat = await fsp.stat(localPath, { bigint: true });\n return createUploadImportHandle(\n localPath,\n this.signer,\n stat.size,\n stat.mtimeMs / 1000n, // integer division\n ) as sdk.ImportFileHandleUpload & LocalImportFileHandle;\n }\n\n public async getStorageList(): Promise<sdk.StorageEntry[]> {\n const virtualStorages = [...this.virtualStoragesMap.values()].map((s) => ({\n name: s.name,\n handle: createLocalStorageHandle(s.name, s.root),\n initialFullPath: s.initialPath,\n }));\n\n const otherStorages = Object.entries(this.storageIdToResourceId!).map(\n ([storageId, resourceId]) => ({\n name: storageId,\n handle: createRemoteStorageHandle(storageId, resourceId),\n initialFullPath: '', // we don't have any additional information from where to start browsing remote storages\n isInitialPathHome: false,\n }),\n );\n\n // root must be a storage so we can index any file,\n // but for UI it's enough\n // to have local virtual storage on *nix,\n // and local_disk_${drive} on Windows.\n const noRoot = otherStorages.filter((it) => it.name !== 'root');\n\n return [...virtualStorages, ...noRoot];\n }\n\n public async listFiles(\n storageHandle: sdk.StorageHandle,\n fullPath: string,\n ): Promise<sdk.ListFilesResult> {\n const storageData = parseStorageHandle(storageHandle);\n\n if (storageData.isRemote) {\n const response = await this.lsClient.list(storageData, fullPath);\n return {\n entries: response.items.map((e) => ({\n type: e.isDir ? 'dir' : 'file',\n name: e.name,\n fullPath: e.fullName,\n handle: createIndexImportHandle(storageData.name, e.fullName),\n })),\n };\n }\n\n if (path.sep === '/' && fullPath === '') fullPath = '/';\n\n if (storageData.rootPath === '') {\n validateAbsolute(fullPath);\n }\n const lsRoot = path.isAbsolute(fullPath) ? fullPath : path.join(storageData.rootPath, fullPath);\n\n const entries: LsEntry[] = [];\n for await (const dirent of await fsp.opendir(lsRoot)) {\n if (!dirent.isFile() && !dirent.isDirectory()) continue;\n\n // We cannot use no dirent.fullPath no dirent.parentPath,\n // since the former is deprecated\n // and the later works differently on different versions.\n const absolutePath = path.join(lsRoot, dirent.name);\n\n entries.push({\n type: dirent.isFile() ? 'file' : 'dir',\n name: dirent.name,\n fullPath: absolutePath,\n handle: await this.getLocalFileHandle(absolutePath),\n });\n }\n\n return { entries };\n }\n\n public async listRemoteFilesWithAdditionalInfo(\n storageHandle: sdk.StorageHandle,\n fullPath: string,\n ): Promise<ListRemoteFilesResultWithAdditionalInfo> {\n const storageData = parseStorageHandle(storageHandle);\n if (!storageData.isRemote) {\n throw new Error(`Storage ${storageData.name} is not remote`);\n }\n\n const response = await this.lsClient.list(storageData, fullPath);\n\n return {\n entries: response.items.map((e) => ({\n type: e.isDir ? 'dir' : 'file',\n name: e.name,\n fullPath: e.fullName,\n handle: createIndexImportHandle(storageData.name, e.fullName),\n size: Number(e.size),\n })),\n };\n }\n\n public async fileToImportHandle(file: sdk.FileLike): Promise<sdk.ImportFileHandle> {\n throw new Error(\n 'Not implemented. This method must be implemented and intercepted in desktop preload script.',\n );\n }\n\n public static async init(\n logger: MiLogger,\n client: PlClient,\n signer: Signer,\n /** Pl storages available locally */\n localProjections: LocalStorageProjection[],\n openFileDialogCallback: OpenFileDialogCallback,\n virtualStorages?: VirtualLocalStorageSpec[],\n ): Promise<LsDriver> {\n const lsClient = createLsFilesClient(client, logger);\n\n if (!virtualStorages) virtualStorages = await DefaultVirtualLocalStorages();\n\n // validating inputs\n for (const vp of virtualStorages) validateAbsolute(vp.root);\n for (const lp of localProjections) if (lp.localPath !== '') validateAbsolute(lp.localPath);\n\n // creating indexed maps for quick access\n const virtualStoragesMap = new Map(virtualStorages.map((s) => [s.name, s]));\n const localProjectionsMap = new Map(localProjections.map((s) => [s.storageId, s]));\n\n // validating there is no intersection\n if (\n new Set([...virtualStoragesMap.keys(), ...localProjectionsMap.keys()]).size\n !== virtualStoragesMap.size + localProjectionsMap.size\n )\n throw new Error(\n 'Intersection between local projection storage ids and virtual storages names detected.',\n );\n\n return new LsDriver(\n logger,\n lsClient,\n await doGetAvailableStorageIds(client),\n signer,\n virtualStoragesMap,\n localProjectionsMap,\n openFileDialogCallback,\n );\n }\n}\n\nasync function doGetAvailableStorageIds(client: PlClient): Promise<Record<string, ResourceId>> {\n return client.withReadTx('GetAvailableStorageIds', async (tx) => {\n const lsProviderId = await tx.getResourceByName('LSProvider');\n const provider = await tx.getResourceData(lsProviderId, true);\n\n return providerToStorageIds(provider);\n });\n}\n\nfunction providerToStorageIds(provider: ResourceData) {\n return Object.fromEntries(\n provider.fields\n .filter((f) => f.type == 'Dynamic' && isNotNullResourceId(f.value))\n .map((f) => [f.name.substring('storage/'.length), f.value as ResourceId]),\n );\n}\n"],"names":[],"mappings":";;;;;;;;;;MA8Da,QAAQ,CAAA;AAEA,IAAA,MAAA;AACA,IAAA,QAAA;AAEA,IAAA,qBAAA;AACA,IAAA,MAAA;AAEA,IAAA,kBAAA;AAEA,IAAA,mBAAA;AACA,IAAA,sBAAA;IAVnB,WAAA,CACmB,MAAgB,EAChB,QAAkB;;AAElB,IAAA,qBAAiD,EACjD,MAAc;;IAEd,kBAAwD;;AAExD,IAAA,mBAAwD,EACxD,sBAA8C,EAAA;QAT9C,IAAA,CAAA,MAAM,GAAN,MAAM;QACN,IAAA,CAAA,QAAQ,GAAR,QAAQ;QAER,IAAA,CAAA,qBAAqB,GAArB,qBAAqB;QACrB,IAAA,CAAA,MAAM,GAAN,MAAM;QAEN,IAAA,CAAA,kBAAkB,GAAlB,kBAAkB;QAElB,IAAA,CAAA,mBAAmB,GAAnB,mBAAmB;QACnB,IAAA,CAAA,sBAAsB,GAAtB,sBAAsB;IACtC;AAEI,IAAA,MAAM,mBAAmB,CAC9B,IAA2B,EAC3B,KAAkB,EAAA;QAElB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC;AAC5D,QAAA,IAAI,KAAK;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC;AAC9D,QAAA,OAAO,MAAM,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC;IACtC;IAEO,MAAM,gBAAgB,CAAC,IAA2B,EAAA;QACvD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC;QAC5D,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC;QACtC,OAAO,IAAI,CAAC,IAAI;IAClB;IAEO,MAAM,2BAA2B,CACtC,GAAmB,EAAA;QAEnB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,IAAI,EAAE,GAAG,CAAC;QAC3D,IAAI,MAAM,KAAK,SAAS;AAAE,YAAA,OAAO,EAAE;QACnC,OAAO;YACL,KAAK,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,SAAS,KAAK,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC;SACxF;IACH;IAEO,MAAM,wBAAwB,CAAC,GAAmB,EAAA;QACvD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,GAAG,CAAC;QAC5D,IAAI,MAAM,KAAK,SAAS;AAAE,YAAA,OAAO,EAAE;QACnC,OAAO;YACL,IAAI,EAAE,MAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;SAC/C;IACH;AAEA;;;;;AAKG;IACK,MAAM,yBAAyB,CAAC,MAA6B,EAAA;AACnE,QAAA,IAAI,uBAAuB,CAAC,MAAM,CAAC,EAAE;AACnC,YAAA,MAAM,UAAU,GAAG,gBAAgB,CAAC,MAAM,CAAC;AAC3C,YAAA,MAAM,eAAe,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC;AAC1E,YAAA,IAAI,CAAC,eAAe;gBAClB,MAAM,IAAI,KAAK,CAAC,CAAA,QAAA,EAAW,UAAU,CAAC,SAAS,CAAA,wBAAA,CAA0B,CAAC;AAC5E,YAAA,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,UAAU,CAAC,IAAI,CAAC;QAC9D;aAAO;AACL,YAAA,MAAM,UAAU,GAAG,iBAAiB,CAAC,MAAM,CAAC;;AAE5C,YAAA,IAAI,CAAC,MAAM,CAAC,MAAM,CAChB,UAAU,CAAC,SAAS,EACpB,UAAU,CAAC,aAAa,EACxB,iDAAiD,CAClD;AAED,YAAA,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS;AAEtC,YAAA,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;YACxD,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,KAAK,UAAU,CAAC,gBAAgB;AAC9D,gBAAA,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC;AAEnE,YAAA,OAAO,SAAS;QAClB;IACF;IAEO,MAAM,kBAAkB,CAC7B,SAAiB,EAAA;QAEjB,gBAAgB,CAAC,SAAS,CAAC;;;QAI3B,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,EAAE;;YAElD,IAAI,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE;;;;gBAItC,MAAM,iBAAiB,GACnB,EAAE,CAAC,SAAS,KAAK,EAAE,GAAG,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;gBAC5E,OAAO,uBAAuB,CAC5B,EAAE,CAAC,SAAS,EACZ,iBAAiB,CACmC;YACxD;QACF;;AAIA,QAAA,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;AACxD,QAAA,OAAO,wBAAwB,CAC7B,SAAS,EACT,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,OAAO,GAAG,KAAK,CACiC;IACzD;AAEO,IAAA,MAAM,cAAc,GAAA;AACzB,QAAA,MAAM,eAAe,GAAG,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM;YACxE,IAAI,EAAE,CAAC,CAAC,IAAI;YACZ,MAAM,EAAE,wBAAwB,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC;YAChD,eAAe,EAAE,CAAC,CAAC,WAAW;AAC/B,SAAA,CAAC,CAAC;QAEH,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAsB,CAAC,CAAC,GAAG,CACnE,CAAC,CAAC,SAAS,EAAE,UAAU,CAAC,MAAM;AAC5B,YAAA,IAAI,EAAE,SAAS;AACf,YAAA,MAAM,EAAE,yBAAyB,CAAC,SAAS,EAAE,UAAU,CAAC;YACxD,eAAe,EAAE,EAAE;AACnB,YAAA,iBAAiB,EAAE,KAAK;AACzB,SAAA,CAAC,CACH;;;;;AAMD,QAAA,MAAM,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,IAAI,KAAK,MAAM,CAAC;AAE/D,QAAA,OAAO,CAAC,GAAG,eAAe,EAAE,GAAG,MAAM,CAAC;IACxC;AAEO,IAAA,MAAM,SAAS,CACpB,aAAgC,EAChC,QAAgB,EAAA;AAEhB,QAAA,MAAM,WAAW,GAAG,kBAAkB,CAAC,aAAa,CAAC;AAErD,QAAA,IAAI,WAAW,CAAC,QAAQ,EAAE;AACxB,YAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;YAChE,OAAO;AACL,gBAAA,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM;oBAClC,IAAI,EAAE,CAAC,CAAC,KAAK,GAAG,KAAK,GAAG,MAAM;oBAC9B,IAAI,EAAE,CAAC,CAAC,IAAI;oBACZ,QAAQ,EAAE,CAAC,CAAC,QAAQ;oBACpB,MAAM,EAAE,uBAAuB,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC;AAC9D,iBAAA,CAAC,CAAC;aACJ;QACH;QAEA,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,IAAI,QAAQ,KAAK,EAAE;YAAE,QAAQ,GAAG,GAAG;AAEvD,QAAA,IAAI,WAAW,CAAC,QAAQ,KAAK,EAAE,EAAE;YAC/B,gBAAgB,CAAC,QAAQ,CAAC;QAC5B;QACA,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAE/F,MAAM,OAAO,GAAc,EAAE;AAC7B,QAAA,WAAW,MAAM,MAAM,IAAI,MAAM,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YACpD,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;gBAAE;;;;AAK/C,YAAA,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC;YAEnD,OAAO,CAAC,IAAI,CAAC;AACX,gBAAA,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,MAAM,GAAG,KAAK;gBACtC,IAAI,EAAE,MAAM,CAAC,IAAI;AACjB,gBAAA,QAAQ,EAAE,YAAY;AACtB,gBAAA,MAAM,EAAE,MAAM,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC;AACpD,aAAA,CAAC;QACJ;QAEA,OAAO,EAAE,OAAO,EAAE;IACpB;AAEO,IAAA,MAAM,iCAAiC,CAC5C,aAAgC,EAChC,QAAgB,EAAA;AAEhB,QAAA,MAAM,WAAW,GAAG,kBAAkB,CAAC,aAAa,CAAC;AACrD,QAAA,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE;YACzB,MAAM,IAAI,KAAK,CAAC,CAAA,QAAA,EAAW,WAAW,CAAC,IAAI,CAAA,cAAA,CAAgB,CAAC;QAC9D;AAEA,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;QAEhE,OAAO;AACL,YAAA,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM;gBAClC,IAAI,EAAE,CAAC,CAAC,KAAK,GAAG,KAAK,GAAG,MAAM;gBAC9B,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,QAAQ,EAAE,CAAC,CAAC,QAAQ;gBACpB,MAAM,EAAE,uBAAuB,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC;AAC7D,gBAAA,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AACrB,aAAA,CAAC,CAAC;SACJ;IACH;IAEO,MAAM,kBAAkB,CAAC,IAAkB,EAAA;AAChD,QAAA,MAAM,IAAI,KAAK,CACb,6FAA6F,CAC9F;IACH;IAEO,aAAa,IAAI,CACtB,MAAgB,EAChB,MAAgB,EAChB,MAAc;;IAEd,gBAA0C,EAC1C,sBAA8C,EAC9C,eAA2C,EAAA;QAE3C,MAAM,QAAQ,GAAG,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC;AAEpD,QAAA,IAAI,CAAC,eAAe;AAAE,YAAA,eAAe,GAAG,MAAM,2BAA2B,EAAE;;QAG3E,KAAK,MAAM,EAAE,IAAI,eAAe;AAAE,YAAA,gBAAgB,CAAC,EAAE,CAAC,IAAI,CAAC;QAC3D,KAAK,MAAM,EAAE,IAAI,gBAAgB;AAAE,YAAA,IAAI,EAAE,CAAC,SAAS,KAAK,EAAE;AAAE,gBAAA,gBAAgB,CAAC,EAAE,CAAC,SAAS,CAAC;;QAG1F,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAC3E,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;;AAGlF,QAAA,IACE,IAAI,GAAG,CAAC,CAAC,GAAG,kBAAkB,CAAC,IAAI,EAAE,EAAE,GAAG,mBAAmB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AACjE,gBAAA,kBAAkB,CAAC,IAAI,GAAG,mBAAmB,CAAC,IAAI;AAExD,YAAA,MAAM,IAAI,KAAK,CACb,wFAAwF,CACzF;QAEH,OAAO,IAAI,QAAQ,CACjB,MAAM,EACN,QAAQ,EACR,MAAM,wBAAwB,CAAC,MAAM,CAAC,EACtC,MAAM,EACN,kBAAkB,EAClB,mBAAmB,EACnB,sBAAsB,CACvB;IACH;AACD;AAED,eAAe,wBAAwB,CAAC,MAAgB,EAAA;IACtD,OAAO,MAAM,CAAC,UAAU,CAAC,wBAAwB,EAAE,OAAO,EAAE,KAAI;QAC9D,MAAM,YAAY,GAAG,MAAM,EAAE,CAAC,iBAAiB,CAAC,YAAY,CAAC;QAC7D,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,eAAe,CAAC,YAAY,EAAE,IAAI,CAAC;AAE7D,QAAA,OAAO,oBAAoB,CAAC,QAAQ,CAAC;AACvC,IAAA,CAAC,CAAC;AACJ;AAEA,SAAS,oBAAoB,CAAC,QAAsB,EAAA;AAClD,IAAA,OAAO,MAAM,CAAC,WAAW,CACvB,QAAQ,CAAC;AACN,SAAA,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,IAAI,SAAS,IAAI,mBAAmB,CAAC,CAAC,CAAC,KAAK,CAAC;SACjE,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,KAAmB,CAAC,CAAC,CAC5E;AACH;;;;"}
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var zod = require('zod');
|
|
4
|
+
var plTree = require('@milaboratories/pl-tree');
|
|
5
|
+
|
|
6
|
+
//
|
|
7
|
+
// download
|
|
8
|
+
//
|
|
9
|
+
/** ResourceSnapshot that can be passed to OnDemandBlob */
|
|
10
|
+
const OnDemandBlobResourceSnapshot = plTree.rsSchema({
|
|
11
|
+
kv: {
|
|
12
|
+
'ctl/file/blobInfo': zod.z.object({
|
|
13
|
+
sizeBytes: zod.z.coerce.number(),
|
|
14
|
+
}),
|
|
15
|
+
},
|
|
16
|
+
});
|
|
17
|
+
function getSize(bs, range) {
|
|
18
|
+
const size = bs.kv['ctl/file/blobInfo'].sizeBytes;
|
|
19
|
+
if (range) {
|
|
20
|
+
const newSize = range.to - range.from;
|
|
21
|
+
if (newSize > size) {
|
|
22
|
+
throw new Error(`getSize: range (${JSON.stringify(range)}, newSize: ${newSize}) is greater than size (${size})`);
|
|
23
|
+
}
|
|
24
|
+
return newSize;
|
|
25
|
+
}
|
|
26
|
+
return size;
|
|
27
|
+
}
|
|
28
|
+
//
|
|
29
|
+
// upload
|
|
30
|
+
//
|
|
31
|
+
const ImportFileHandleUploadData = zod.z.object({
|
|
32
|
+
/** Local file path, to take data for upload */
|
|
33
|
+
localPath: zod.z.string(),
|
|
34
|
+
/** Path signature, to check this data was generated by us */
|
|
35
|
+
pathSignature: zod.z.string(),
|
|
36
|
+
/** File size in bytes */
|
|
37
|
+
sizeBytes: zod.z.string(),
|
|
38
|
+
/** Modification time unix timestamp in seconds */
|
|
39
|
+
modificationTime: zod.z.string(),
|
|
40
|
+
});
|
|
41
|
+
const ImportFileHandleIndexData = zod.z.object({
|
|
42
|
+
/** Pl storage id */
|
|
43
|
+
storageId: zod.z.string(),
|
|
44
|
+
/** Path inside storage */
|
|
45
|
+
path: zod.z.string(),
|
|
46
|
+
});
|
|
47
|
+
const ImportFileHandleData = zod.z.union([
|
|
48
|
+
ImportFileHandleUploadData,
|
|
49
|
+
ImportFileHandleIndexData,
|
|
50
|
+
]);
|
|
51
|
+
/** Options from BlobUpload resource that have to be passed to getProgress. */
|
|
52
|
+
/** ResourceSnapshot that can be passed to GetProgressID */
|
|
53
|
+
const UploadResourceSnapshot = plTree.rsSchema({
|
|
54
|
+
data: ImportFileHandleUploadData,
|
|
55
|
+
fields: {
|
|
56
|
+
blob: false,
|
|
57
|
+
},
|
|
58
|
+
});
|
|
59
|
+
const IndexResourceSnapshot = plTree.rsSchema({
|
|
60
|
+
fields: {
|
|
61
|
+
incarnation: false,
|
|
62
|
+
},
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
exports.ImportFileHandleData = ImportFileHandleData;
|
|
66
|
+
exports.ImportFileHandleIndexData = ImportFileHandleIndexData;
|
|
67
|
+
exports.ImportFileHandleUploadData = ImportFileHandleUploadData;
|
|
68
|
+
exports.IndexResourceSnapshot = IndexResourceSnapshot;
|
|
69
|
+
exports.OnDemandBlobResourceSnapshot = OnDemandBlobResourceSnapshot;
|
|
70
|
+
exports.UploadResourceSnapshot = UploadResourceSnapshot;
|
|
71
|
+
exports.getSize = getSize;
|
|
72
|
+
//# sourceMappingURL=types.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.cjs","sources":["../../src/drivers/types.ts"],"sourcesContent":["import { z } from 'zod';\nimport type { InferSnapshot } from '@milaboratories/pl-tree';\nimport { rsSchema } from '@milaboratories/pl-tree';\nimport { RangeBytes } from '@milaboratories/pl-model-common';\n\n//\n// download\n//\n/** ResourceSnapshot that can be passed to OnDemandBlob */\nexport const OnDemandBlobResourceSnapshot = rsSchema({\n kv: {\n 'ctl/file/blobInfo': z.object({\n sizeBytes: z.coerce.number(),\n }),\n },\n});\n\nexport type OnDemandBlobResourceSnapshot = InferSnapshot<typeof OnDemandBlobResourceSnapshot>;\n\nexport function getSize(bs: OnDemandBlobResourceSnapshot, range?: RangeBytes): number {\n const size = bs.kv['ctl/file/blobInfo'].sizeBytes;\n if (range) {\n const newSize = range.to - range.from;\n if (newSize > size) {\n throw new Error(`getSize: range (${JSON.stringify(range)}, newSize: ${newSize}) is greater than size (${size})`);\n }\n\n return newSize;\n }\n\n return size;\n}\n\n//\n// upload\n//\n\nexport const ImportFileHandleUploadData = z.object({\n /** Local file path, to take data for upload */\n localPath: z.string(),\n /** Path signature, to check this data was generated by us */\n pathSignature: z.string(),\n /** File size in bytes */\n sizeBytes: z.string(),\n /** Modification time unix timestamp in seconds */\n modificationTime: z.string(),\n});\nexport type ImportFileHandleUploadData = z.infer<typeof ImportFileHandleUploadData>;\n\nexport const ImportFileHandleIndexData = z.object({\n /** Pl storage id */\n storageId: z.string(),\n /** Path inside storage */\n path: z.string(),\n});\nexport type ImportFileHandleIndexData = z.infer<typeof ImportFileHandleIndexData>;\n\nexport const ImportFileHandleData = z.union([\n ImportFileHandleUploadData,\n ImportFileHandleIndexData,\n]);\nexport type ImportFileHandleData = z.infer<typeof ImportFileHandleData>;\n\n/** Options from BlobUpload resource that have to be passed to getProgress. */\n\n/** ResourceSnapshot that can be passed to GetProgressID */\nexport const UploadResourceSnapshot = rsSchema({\n data: ImportFileHandleUploadData,\n fields: {\n blob: false,\n },\n});\n\nexport const IndexResourceSnapshot = rsSchema({\n fields: {\n incarnation: false,\n },\n});\n\nexport type UploadResourceSnapshot = InferSnapshot<typeof UploadResourceSnapshot>;\nexport type IndexResourceSnapshot = InferSnapshot<typeof IndexResourceSnapshot>;\n\nexport type ImportResourceSnapshot = UploadResourceSnapshot | IndexResourceSnapshot;\n\n//\n// ls\n//\n\n/** Defines which storages from pl are available via local paths */\nexport type LocalStorageProjection = {\n /** Pl storage id */\n readonly storageId: string;\n\n /**\n * Local path, the storage is mounted at.\n *\n * Empty string means that this storage accepts absolute paths, and operates inside the same OS.\n * This matches the behaviour how pl interprets FS storage config.\n * */\n readonly localPath: string;\n};\n\n/** Allows to add parts of local FS as virtual storages, presenting homogeneous API to UI */\nexport type VirtualLocalStorageSpec = {\n /** Virtual storage ID, must not intersect with other storage ids */\n readonly name: string;\n\n /** Local path to \"chroot\" the API in */\n readonly root: string;\n\n /** Used as hint to UI controls to, set as initial path during browsing */\n readonly initialPath: string;\n};\n"],"names":["rsSchema","z"],"mappings":";;;;;AAKA;AACA;AACA;AACA;AACO,MAAM,4BAA4B,GAAGA,eAAQ,CAAC;AACnD,IAAA,EAAE,EAAE;AACF,QAAA,mBAAmB,EAAEC,KAAC,CAAC,MAAM,CAAC;AAC5B,YAAA,SAAS,EAAEA,KAAC,CAAC,MAAM,CAAC,MAAM,EAAE;SAC7B,CAAC;AACH,KAAA;AACF,CAAA;AAIK,SAAU,OAAO,CAAC,EAAgC,EAAE,KAAkB,EAAA;IAC1E,MAAM,IAAI,GAAG,EAAE,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC,SAAS;IACjD,IAAI,KAAK,EAAE;QACT,MAAM,OAAO,GAAG,KAAK,CAAC,EAAE,GAAG,KAAK,CAAC,IAAI;AACrC,QAAA,IAAI,OAAO,GAAG,IAAI,EAAE;AAClB,YAAA,MAAM,IAAI,KAAK,CAAC,CAAA,gBAAA,EAAmB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,cAAc,OAAO,CAAA,wBAAA,EAA2B,IAAI,CAAA,CAAA,CAAG,CAAC;QAClH;AAEA,QAAA,OAAO,OAAO;IAChB;AAEA,IAAA,OAAO,IAAI;AACb;AAEA;AACA;AACA;AAEO,MAAM,0BAA0B,GAAGA,KAAC,CAAC,MAAM,CAAC;;AAEjD,IAAA,SAAS,EAAEA,KAAC,CAAC,MAAM,EAAE;;AAErB,IAAA,aAAa,EAAEA,KAAC,CAAC,MAAM,EAAE;;AAEzB,IAAA,SAAS,EAAEA,KAAC,CAAC,MAAM,EAAE;;AAErB,IAAA,gBAAgB,EAAEA,KAAC,CAAC,MAAM,EAAE;AAC7B,CAAA;AAGM,MAAM,yBAAyB,GAAGA,KAAC,CAAC,MAAM,CAAC;;AAEhD,IAAA,SAAS,EAAEA,KAAC,CAAC,MAAM,EAAE;;AAErB,IAAA,IAAI,EAAEA,KAAC,CAAC,MAAM,EAAE;AACjB,CAAA;AAGM,MAAM,oBAAoB,GAAGA,KAAC,CAAC,KAAK,CAAC;IAC1C,0BAA0B;IAC1B,yBAAyB;AAC1B,CAAA;AAGD;AAEA;AACO,MAAM,sBAAsB,GAAGD,eAAQ,CAAC;AAC7C,IAAA,IAAI,EAAE,0BAA0B;AAChC,IAAA,MAAM,EAAE;AACN,QAAA,IAAI,EAAE,KAAK;AACZ,KAAA;AACF,CAAA;AAEM,MAAM,qBAAqB,GAAGA,eAAQ,CAAC;AAC5C,IAAA,MAAM,EAAE;AACN,QAAA,WAAW,EAAE,KAAK;AACnB,KAAA;AACF,CAAA;;;;;;;;;;"}
|
package/dist/drivers/types.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
-
import { InferSnapshot
|
|
2
|
+
import { InferSnapshot } from '@milaboratories/pl-tree';
|
|
3
3
|
import { RangeBytes } from '@milaboratories/pl-model-common';
|
|
4
4
|
/** ResourceSnapshot that can be passed to OnDemandBlob */
|
|
5
|
-
export declare const OnDemandBlobResourceSnapshot: ResourceSnapshotSchema<undefined, undefined, {
|
|
5
|
+
export declare const OnDemandBlobResourceSnapshot: import('@milaboratories/pl-tree').ResourceSnapshotSchema<undefined, undefined, {
|
|
6
6
|
readonly 'ctl/file/blobInfo': z.ZodObject<{
|
|
7
7
|
sizeBytes: z.ZodNumber;
|
|
8
8
|
}, "strip", z.ZodTypeAny, {
|
|
@@ -81,7 +81,7 @@ export declare const ImportFileHandleData: z.ZodUnion<[z.ZodObject<{
|
|
|
81
81
|
export type ImportFileHandleData = z.infer<typeof ImportFileHandleData>;
|
|
82
82
|
/** Options from BlobUpload resource that have to be passed to getProgress. */
|
|
83
83
|
/** ResourceSnapshot that can be passed to GetProgressID */
|
|
84
|
-
export declare const UploadResourceSnapshot: ResourceSnapshotSchema<z.ZodObject<{
|
|
84
|
+
export declare const UploadResourceSnapshot: import('@milaboratories/pl-tree').ResourceSnapshotSchema<z.ZodObject<{
|
|
85
85
|
/** Local file path, to take data for upload */
|
|
86
86
|
localPath: z.ZodString;
|
|
87
87
|
/** Path signature, to check this data was generated by us */
|
|
@@ -103,7 +103,7 @@ export declare const UploadResourceSnapshot: ResourceSnapshotSchema<z.ZodObject<
|
|
|
103
103
|
}>, {
|
|
104
104
|
readonly blob: false;
|
|
105
105
|
}, undefined>;
|
|
106
|
-
export declare const IndexResourceSnapshot: ResourceSnapshotSchema<undefined, {
|
|
106
|
+
export declare const IndexResourceSnapshot: import('@milaboratories/pl-tree').ResourceSnapshotSchema<undefined, {
|
|
107
107
|
readonly incarnation: false;
|
|
108
108
|
}, undefined>;
|
|
109
109
|
export type UploadResourceSnapshot = InferSnapshot<typeof UploadResourceSnapshot>;
|
|
@@ -130,4 +130,3 @@ export type VirtualLocalStorageSpec = {
|
|
|
130
130
|
/** Used as hint to UI controls to, set as initial path during browsing */
|
|
131
131
|
readonly initialPath: string;
|
|
132
132
|
};
|
|
133
|
-
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { rsSchema } from '@milaboratories/pl-tree';
|
|
3
|
+
|
|
4
|
+
//
|
|
5
|
+
// download
|
|
6
|
+
//
|
|
7
|
+
/** ResourceSnapshot that can be passed to OnDemandBlob */
|
|
8
|
+
const OnDemandBlobResourceSnapshot = rsSchema({
|
|
9
|
+
kv: {
|
|
10
|
+
'ctl/file/blobInfo': z.object({
|
|
11
|
+
sizeBytes: z.coerce.number(),
|
|
12
|
+
}),
|
|
13
|
+
},
|
|
14
|
+
});
|
|
15
|
+
function getSize(bs, range) {
|
|
16
|
+
const size = bs.kv['ctl/file/blobInfo'].sizeBytes;
|
|
17
|
+
if (range) {
|
|
18
|
+
const newSize = range.to - range.from;
|
|
19
|
+
if (newSize > size) {
|
|
20
|
+
throw new Error(`getSize: range (${JSON.stringify(range)}, newSize: ${newSize}) is greater than size (${size})`);
|
|
21
|
+
}
|
|
22
|
+
return newSize;
|
|
23
|
+
}
|
|
24
|
+
return size;
|
|
25
|
+
}
|
|
26
|
+
//
|
|
27
|
+
// upload
|
|
28
|
+
//
|
|
29
|
+
const ImportFileHandleUploadData = z.object({
|
|
30
|
+
/** Local file path, to take data for upload */
|
|
31
|
+
localPath: z.string(),
|
|
32
|
+
/** Path signature, to check this data was generated by us */
|
|
33
|
+
pathSignature: z.string(),
|
|
34
|
+
/** File size in bytes */
|
|
35
|
+
sizeBytes: z.string(),
|
|
36
|
+
/** Modification time unix timestamp in seconds */
|
|
37
|
+
modificationTime: z.string(),
|
|
38
|
+
});
|
|
39
|
+
const ImportFileHandleIndexData = z.object({
|
|
40
|
+
/** Pl storage id */
|
|
41
|
+
storageId: z.string(),
|
|
42
|
+
/** Path inside storage */
|
|
43
|
+
path: z.string(),
|
|
44
|
+
});
|
|
45
|
+
const ImportFileHandleData = z.union([
|
|
46
|
+
ImportFileHandleUploadData,
|
|
47
|
+
ImportFileHandleIndexData,
|
|
48
|
+
]);
|
|
49
|
+
/** Options from BlobUpload resource that have to be passed to getProgress. */
|
|
50
|
+
/** ResourceSnapshot that can be passed to GetProgressID */
|
|
51
|
+
const UploadResourceSnapshot = rsSchema({
|
|
52
|
+
data: ImportFileHandleUploadData,
|
|
53
|
+
fields: {
|
|
54
|
+
blob: false,
|
|
55
|
+
},
|
|
56
|
+
});
|
|
57
|
+
const IndexResourceSnapshot = rsSchema({
|
|
58
|
+
fields: {
|
|
59
|
+
incarnation: false,
|
|
60
|
+
},
|
|
61
|
+
});
|
|
62
|
+
|
|
63
|
+
export { ImportFileHandleData, ImportFileHandleIndexData, ImportFileHandleUploadData, IndexResourceSnapshot, OnDemandBlobResourceSnapshot, UploadResourceSnapshot, getSize };
|
|
64
|
+
//# sourceMappingURL=types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sources":["../../src/drivers/types.ts"],"sourcesContent":["import { z } from 'zod';\nimport type { InferSnapshot } from '@milaboratories/pl-tree';\nimport { rsSchema } from '@milaboratories/pl-tree';\nimport { RangeBytes } from '@milaboratories/pl-model-common';\n\n//\n// download\n//\n/** ResourceSnapshot that can be passed to OnDemandBlob */\nexport const OnDemandBlobResourceSnapshot = rsSchema({\n kv: {\n 'ctl/file/blobInfo': z.object({\n sizeBytes: z.coerce.number(),\n }),\n },\n});\n\nexport type OnDemandBlobResourceSnapshot = InferSnapshot<typeof OnDemandBlobResourceSnapshot>;\n\nexport function getSize(bs: OnDemandBlobResourceSnapshot, range?: RangeBytes): number {\n const size = bs.kv['ctl/file/blobInfo'].sizeBytes;\n if (range) {\n const newSize = range.to - range.from;\n if (newSize > size) {\n throw new Error(`getSize: range (${JSON.stringify(range)}, newSize: ${newSize}) is greater than size (${size})`);\n }\n\n return newSize;\n }\n\n return size;\n}\n\n//\n// upload\n//\n\nexport const ImportFileHandleUploadData = z.object({\n /** Local file path, to take data for upload */\n localPath: z.string(),\n /** Path signature, to check this data was generated by us */\n pathSignature: z.string(),\n /** File size in bytes */\n sizeBytes: z.string(),\n /** Modification time unix timestamp in seconds */\n modificationTime: z.string(),\n});\nexport type ImportFileHandleUploadData = z.infer<typeof ImportFileHandleUploadData>;\n\nexport const ImportFileHandleIndexData = z.object({\n /** Pl storage id */\n storageId: z.string(),\n /** Path inside storage */\n path: z.string(),\n});\nexport type ImportFileHandleIndexData = z.infer<typeof ImportFileHandleIndexData>;\n\nexport const ImportFileHandleData = z.union([\n ImportFileHandleUploadData,\n ImportFileHandleIndexData,\n]);\nexport type ImportFileHandleData = z.infer<typeof ImportFileHandleData>;\n\n/** Options from BlobUpload resource that have to be passed to getProgress. */\n\n/** ResourceSnapshot that can be passed to GetProgressID */\nexport const UploadResourceSnapshot = rsSchema({\n data: ImportFileHandleUploadData,\n fields: {\n blob: false,\n },\n});\n\nexport const IndexResourceSnapshot = rsSchema({\n fields: {\n incarnation: false,\n },\n});\n\nexport type UploadResourceSnapshot = InferSnapshot<typeof UploadResourceSnapshot>;\nexport type IndexResourceSnapshot = InferSnapshot<typeof IndexResourceSnapshot>;\n\nexport type ImportResourceSnapshot = UploadResourceSnapshot | IndexResourceSnapshot;\n\n//\n// ls\n//\n\n/** Defines which storages from pl are available via local paths */\nexport type LocalStorageProjection = {\n /** Pl storage id */\n readonly storageId: string;\n\n /**\n * Local path, the storage is mounted at.\n *\n * Empty string means that this storage accepts absolute paths, and operates inside the same OS.\n * This matches the behaviour how pl interprets FS storage config.\n * */\n readonly localPath: string;\n};\n\n/** Allows to add parts of local FS as virtual storages, presenting homogeneous API to UI */\nexport type VirtualLocalStorageSpec = {\n /** Virtual storage ID, must not intersect with other storage ids */\n readonly name: string;\n\n /** Local path to \"chroot\" the API in */\n readonly root: string;\n\n /** Used as hint to UI controls to, set as initial path during browsing */\n readonly initialPath: string;\n};\n"],"names":[],"mappings":";;;AAKA;AACA;AACA;AACA;AACO,MAAM,4BAA4B,GAAG,QAAQ,CAAC;AACnD,IAAA,EAAE,EAAE;AACF,QAAA,mBAAmB,EAAE,CAAC,CAAC,MAAM,CAAC;AAC5B,YAAA,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE;SAC7B,CAAC;AACH,KAAA;AACF,CAAA;AAIK,SAAU,OAAO,CAAC,EAAgC,EAAE,KAAkB,EAAA;IAC1E,MAAM,IAAI,GAAG,EAAE,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC,SAAS;IACjD,IAAI,KAAK,EAAE;QACT,MAAM,OAAO,GAAG,KAAK,CAAC,EAAE,GAAG,KAAK,CAAC,IAAI;AACrC,QAAA,IAAI,OAAO,GAAG,IAAI,EAAE;AAClB,YAAA,MAAM,IAAI,KAAK,CAAC,CAAA,gBAAA,EAAmB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,cAAc,OAAO,CAAA,wBAAA,EAA2B,IAAI,CAAA,CAAA,CAAG,CAAC;QAClH;AAEA,QAAA,OAAO,OAAO;IAChB;AAEA,IAAA,OAAO,IAAI;AACb;AAEA;AACA;AACA;AAEO,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;;AAEjD,IAAA,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;;AAErB,IAAA,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;;AAEzB,IAAA,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;;AAErB,IAAA,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE;AAC7B,CAAA;AAGM,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;;AAEhD,IAAA,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;;AAErB,IAAA,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;AACjB,CAAA;AAGM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC;IAC1C,0BAA0B;IAC1B,yBAAyB;AAC1B,CAAA;AAGD;AAEA;AACO,MAAM,sBAAsB,GAAG,QAAQ,CAAC;AAC7C,IAAA,IAAI,EAAE,0BAA0B;AAChC,IAAA,MAAM,EAAE;AACN,QAAA,IAAI,EAAE,KAAK;AACZ,KAAA;AACF,CAAA;AAEM,MAAM,qBAAqB,GAAG,QAAQ,CAAC;AAC5C,IAAA,MAAM,EAAE;AACN,QAAA,WAAW,EAAE,KAAK;AACnB,KAAA;AACF,CAAA;;;;"}
|
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var node_crypto = require('node:crypto');
|
|
4
|
+
var computable = require('@milaboratories/computable');
|
|
5
|
+
var tsHelpers = require('@milaboratories/ts-helpers');
|
|
6
|
+
var plTree = require('@milaboratories/pl-tree');
|
|
7
|
+
var promises = require('node:timers/promises');
|
|
8
|
+
var types = require('./types.cjs');
|
|
9
|
+
var upload_task = require('./upload_task.cjs');
|
|
10
|
+
var helpers = require('./helpers/helpers.cjs');
|
|
11
|
+
|
|
12
|
+
function makeBlobImportSnapshot(entryOrAccessor, ctx) {
|
|
13
|
+
const node = plTree.isPlTreeEntry(entryOrAccessor)
|
|
14
|
+
? ctx.accessor(entryOrAccessor).node()
|
|
15
|
+
: plTree.isPlTreeEntryAccessor(entryOrAccessor)
|
|
16
|
+
? entryOrAccessor.node()
|
|
17
|
+
: entryOrAccessor;
|
|
18
|
+
if (node.resourceType.name.startsWith('BlobUpload'))
|
|
19
|
+
return plTree.makeResourceSnapshot(node, types.UploadResourceSnapshot);
|
|
20
|
+
return plTree.makeResourceSnapshot(node, types.IndexResourceSnapshot);
|
|
21
|
+
}
|
|
22
|
+
// TODO: add abort signal to Upload Tasks.
|
|
23
|
+
/** Uploads blobs in a queue and holds counters, so it can stop not-needed
|
|
24
|
+
* uploads.
|
|
25
|
+
* Handles both Index and Upload blobs,
|
|
26
|
+
* the client needs to pass concrete blobs from `handle` field. */
|
|
27
|
+
class UploadDriver {
|
|
28
|
+
logger;
|
|
29
|
+
signer;
|
|
30
|
+
clientBlob;
|
|
31
|
+
clientProgress;
|
|
32
|
+
opts;
|
|
33
|
+
idToProgress = new Map();
|
|
34
|
+
/** Holds a queue that upload blobs. */
|
|
35
|
+
uploadQueue;
|
|
36
|
+
hooks;
|
|
37
|
+
constructor(logger, signer, clientBlob, clientProgress, opts = {
|
|
38
|
+
nConcurrentPartUploads: 10,
|
|
39
|
+
nConcurrentGetProgresses: 10,
|
|
40
|
+
pollingInterval: 1000,
|
|
41
|
+
stopPollingDelay: 1000,
|
|
42
|
+
}) {
|
|
43
|
+
this.logger = logger;
|
|
44
|
+
this.signer = signer;
|
|
45
|
+
this.clientBlob = clientBlob;
|
|
46
|
+
this.clientProgress = clientProgress;
|
|
47
|
+
this.opts = opts;
|
|
48
|
+
this.uploadQueue = new tsHelpers.TaskProcessor(this.logger, 1, {
|
|
49
|
+
type: 'exponentialWithMaxDelayBackoff',
|
|
50
|
+
initialDelay: 20,
|
|
51
|
+
maxDelay: 15000, // 15 seconds
|
|
52
|
+
backoffMultiplier: 1.5,
|
|
53
|
+
jitter: 0.5,
|
|
54
|
+
});
|
|
55
|
+
this.hooks = new computable.PollingComputableHooks(() => this.startUpdating(), () => this.stopUpdating(), { stopDebounce: opts.stopPollingDelay }, (resolve, reject) => this.scheduleOnNextState(resolve, reject));
|
|
56
|
+
}
|
|
57
|
+
getProgressId(handleResource, ctx) {
|
|
58
|
+
if (ctx == undefined)
|
|
59
|
+
return computable.Computable.make((ctx) => this.getProgressId(handleResource, ctx));
|
|
60
|
+
const rInfo = plTree.isPlTreeEntry(handleResource)
|
|
61
|
+
? makeBlobImportSnapshot(handleResource, ctx)
|
|
62
|
+
: handleResource;
|
|
63
|
+
const callerId = node_crypto.randomUUID();
|
|
64
|
+
ctx.attacheHooks(this.hooks);
|
|
65
|
+
ctx.addOnDestroy(() => this.release(rInfo.id, callerId));
|
|
66
|
+
const result = this.getProgressIdNoCtx(ctx.watcher, rInfo, callerId);
|
|
67
|
+
return result;
|
|
68
|
+
}
|
|
69
|
+
getProgressIdNoCtx(w, res, callerId) {
|
|
70
|
+
validateResourceType('getProgressId', res.type);
|
|
71
|
+
const task = this.idToProgress.get(res.id);
|
|
72
|
+
if (task != undefined) {
|
|
73
|
+
task.setDoneIfOutputSet(res);
|
|
74
|
+
return task.getProgress(w, callerId);
|
|
75
|
+
}
|
|
76
|
+
const newTask = new upload_task.UploadTask(this.logger, this.clientBlob, this.clientProgress, this.opts.nConcurrentPartUploads, this.signer, res);
|
|
77
|
+
this.idToProgress.set(res.id, newTask);
|
|
78
|
+
if (newTask.shouldScheduleUpload()) {
|
|
79
|
+
this.uploadQueue.push({
|
|
80
|
+
fn: () => newTask.uploadBlobTask(),
|
|
81
|
+
recoverableErrorPredicate: (e) => !upload_task.nonRecoverableError(e),
|
|
82
|
+
});
|
|
83
|
+
}
|
|
84
|
+
newTask.setDoneIfOutputSet(res);
|
|
85
|
+
return newTask.getProgress(w, callerId);
|
|
86
|
+
}
|
|
87
|
+
/** Decrement counters for the file and remove an uploading if counter == 0. */
|
|
88
|
+
async release(id, callerId) {
|
|
89
|
+
const task = this.idToProgress.get(id);
|
|
90
|
+
if (task === undefined)
|
|
91
|
+
return;
|
|
92
|
+
const deleted = task.decCounter(callerId);
|
|
93
|
+
if (deleted)
|
|
94
|
+
this.idToProgress.delete(id);
|
|
95
|
+
}
|
|
96
|
+
/** Must be called when the driver is closing. */
|
|
97
|
+
async releaseAll() {
|
|
98
|
+
this.uploadQueue.stop();
|
|
99
|
+
}
|
|
100
|
+
scheduledOnNextState = [];
|
|
101
|
+
scheduleOnNextState(resolve, reject) {
|
|
102
|
+
this.scheduledOnNextState.push({ resolve, reject });
|
|
103
|
+
}
|
|
104
|
+
/** Called from observer */
|
|
105
|
+
startUpdating() {
|
|
106
|
+
this.keepRunning = true;
|
|
107
|
+
if (this.currentLoop === undefined)
|
|
108
|
+
this.currentLoop = this.mainLoop();
|
|
109
|
+
}
|
|
110
|
+
/** Called from observer */
|
|
111
|
+
stopUpdating() {
|
|
112
|
+
this.keepRunning = false;
|
|
113
|
+
}
|
|
114
|
+
/** If true, main loop will continue polling pl state. */
|
|
115
|
+
keepRunning = false;
|
|
116
|
+
/** Actual state of main loop. */
|
|
117
|
+
currentLoop = undefined;
|
|
118
|
+
async mainLoop() {
|
|
119
|
+
while (this.keepRunning) {
|
|
120
|
+
const toNotify = this.scheduledOnNextState;
|
|
121
|
+
this.scheduledOnNextState = [];
|
|
122
|
+
try {
|
|
123
|
+
await tsHelpers.asyncPool(this.opts.nConcurrentGetProgresses, this.getAllNotDoneProgresses().map((p) => async () => await p.updateStatus()));
|
|
124
|
+
toNotify.forEach((n) => n.resolve());
|
|
125
|
+
}
|
|
126
|
+
catch (e) {
|
|
127
|
+
console.error(e);
|
|
128
|
+
toNotify.forEach((n) => n.reject(e));
|
|
129
|
+
}
|
|
130
|
+
if (!this.keepRunning)
|
|
131
|
+
break;
|
|
132
|
+
await promises.scheduler.wait(this.opts.pollingInterval);
|
|
133
|
+
}
|
|
134
|
+
this.currentLoop = undefined;
|
|
135
|
+
}
|
|
136
|
+
getAllNotDoneProgresses() {
|
|
137
|
+
return Array.from(this.idToProgress.entries())
|
|
138
|
+
.filter(([_, p]) => !isProgressDone(p.progress))
|
|
139
|
+
.map(([_, p]) => p);
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
function isProgressDone(p) {
|
|
143
|
+
return p.done && (p.status?.progress ?? 0.0) >= 1.0;
|
|
144
|
+
}
|
|
145
|
+
function validateResourceType(methodName, rType) {
|
|
146
|
+
if (!rType.name.startsWith('BlobUpload') && !rType.name.startsWith('BlobIndex')) {
|
|
147
|
+
throw new helpers.WrongResourceTypeError(`${methodName}: wrong resource type: ${rType.name}, `
|
|
148
|
+
+ `expected: a resource of either type 'BlobUpload' or 'BlobIndex'.`);
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
exports.UploadDriver = UploadDriver;
|
|
153
|
+
exports.makeBlobImportSnapshot = makeBlobImportSnapshot;
|
|
154
|
+
//# sourceMappingURL=upload.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"upload.cjs","sources":["../../src/drivers/upload.ts"],"sourcesContent":["import { randomUUID } from 'node:crypto';\nimport type { ResourceId, ResourceType } from '@milaboratories/pl-client';\nimport type {\n Watcher,\n ComputableCtx } from '@milaboratories/computable';\nimport {\n Computable,\n PollingComputableHooks,\n} from '@milaboratories/computable';\nimport type { MiLogger, Signer } from '@milaboratories/ts-helpers';\nimport { asyncPool, TaskProcessor } from '@milaboratories/ts-helpers';\nimport type * as sdk from '@milaboratories/pl-model-common';\nimport type { ClientProgress } from '../clients/progress';\nimport type { ClientUpload } from '../clients/upload';\nimport type {\n PlTreeEntry,\n PlTreeEntryAccessor,\n PlTreeNodeAccessor,\n} from '@milaboratories/pl-tree';\nimport {\n isPlTreeEntry,\n isPlTreeEntryAccessor,\n makeResourceSnapshot,\n} from '@milaboratories/pl-tree';\nimport { scheduler } from 'node:timers/promises';\nimport type { PollingOps } from './helpers/polling_ops';\nimport type { ImportResourceSnapshot } from './types';\nimport { IndexResourceSnapshot, UploadResourceSnapshot } from './types';\nimport { isMyUpload, nonRecoverableError, UploadTask } from './upload_task';\nimport { WrongResourceTypeError } from './helpers/helpers';\n\nexport function makeBlobImportSnapshot(\n entryOrAccessor: PlTreeEntry | PlTreeNodeAccessor | PlTreeEntryAccessor,\n ctx: ComputableCtx,\n): ImportResourceSnapshot {\n const node = isPlTreeEntry(entryOrAccessor)\n ? ctx.accessor(entryOrAccessor).node()\n : isPlTreeEntryAccessor(entryOrAccessor)\n ? entryOrAccessor.node()\n : entryOrAccessor;\n\n if (node.resourceType.name.startsWith('BlobUpload'))\n return makeResourceSnapshot(node, UploadResourceSnapshot);\n return makeResourceSnapshot(node, IndexResourceSnapshot);\n}\n\nexport type UploadDriverOps = PollingOps & {\n /** How much parts of a file can be multipart-uploaded to S3 at once. */\n nConcurrentPartUploads: number;\n /** How much upload/indexing statuses of blobs can the driver ask\n * from the platform gRPC at once. */\n nConcurrentGetProgresses: number;\n};\n\n// TODO: add abort signal to Upload Tasks.\n\n/** Uploads blobs in a queue and holds counters, so it can stop not-needed\n * uploads.\n * Handles both Index and Upload blobs,\n * the client needs to pass concrete blobs from `handle` field. */\nexport class UploadDriver {\n private readonly idToProgress: Map<ResourceId, UploadTask> = new Map();\n\n /** Holds a queue that upload blobs. */\n private readonly uploadQueue: TaskProcessor;\n private readonly hooks: PollingComputableHooks;\n\n constructor(\n private readonly logger: MiLogger,\n private readonly signer: Signer,\n private readonly clientBlob: ClientUpload,\n private readonly clientProgress: ClientProgress,\n private readonly opts: UploadDriverOps = {\n nConcurrentPartUploads: 10,\n nConcurrentGetProgresses: 10,\n pollingInterval: 1000,\n stopPollingDelay: 1000,\n },\n ) {\n this.uploadQueue = new TaskProcessor(this.logger, 1, {\n type: 'exponentialWithMaxDelayBackoff',\n initialDelay: 20,\n maxDelay: 15000, // 15 seconds\n backoffMultiplier: 1.5,\n jitter: 0.5,\n });\n\n this.hooks = new PollingComputableHooks(\n () => this.startUpdating(),\n () => this.stopUpdating(),\n { stopDebounce: opts.stopPollingDelay },\n (resolve, reject) => this.scheduleOnNextState(resolve, reject),\n );\n }\n\n /** Returns a progress id and schedules an upload task if it's necessary. */\n getProgressId(\n handleResource: ImportResourceSnapshot | PlTreeEntry\n ): Computable<sdk.ImportProgress>;\n getProgressId(\n handleResource: ImportResourceSnapshot | PlTreeEntry,\n ctx: ComputableCtx\n ): sdk.ImportProgress;\n getProgressId(\n handleResource: ImportResourceSnapshot | PlTreeEntry,\n ctx?: ComputableCtx,\n ): Computable<sdk.ImportProgress> | sdk.ImportProgress {\n if (ctx == undefined) return Computable.make((ctx) => this.getProgressId(handleResource, ctx));\n\n const rInfo: ImportResourceSnapshot = isPlTreeEntry(handleResource)\n ? makeBlobImportSnapshot(handleResource, ctx)\n : handleResource;\n\n const callerId = randomUUID();\n ctx.attacheHooks(this.hooks);\n ctx.addOnDestroy(() => this.release(rInfo.id, callerId));\n\n const result = this.getProgressIdNoCtx(ctx.watcher, rInfo, callerId);\n\n return result;\n }\n\n private getProgressIdNoCtx(\n w: Watcher,\n res: ImportResourceSnapshot,\n callerId: string,\n ): sdk.ImportProgress {\n validateResourceType('getProgressId', res.type);\n\n const task = this.idToProgress.get(res.id);\n\n if (task != undefined) {\n task.setDoneIfOutputSet(res);\n return task.getProgress(w, callerId);\n }\n\n const newTask = new UploadTask(\n this.logger,\n this.clientBlob,\n this.clientProgress,\n this.opts.nConcurrentPartUploads,\n this.signer,\n res,\n );\n\n this.idToProgress.set(res.id, newTask);\n\n if (newTask.shouldScheduleUpload()) {\n this.uploadQueue.push({\n fn: () => newTask.uploadBlobTask(),\n recoverableErrorPredicate: (e) => !nonRecoverableError(e),\n });\n }\n\n newTask.setDoneIfOutputSet(res);\n return newTask.getProgress(w, callerId);\n }\n\n /** Decrement counters for the file and remove an uploading if counter == 0. */\n private async release(id: ResourceId, callerId: string) {\n const task = this.idToProgress.get(id);\n if (task === undefined) return;\n\n const deleted = task.decCounter(callerId);\n if (deleted) this.idToProgress.delete(id);\n }\n\n /** Must be called when the driver is closing. */\n public async releaseAll() {\n this.uploadQueue.stop();\n }\n\n private scheduledOnNextState: ScheduledRefresh[] = [];\n\n private scheduleOnNextState(resolve: () => void, reject: (err: any) => void): void {\n this.scheduledOnNextState.push({ resolve, reject });\n }\n\n /** Called from observer */\n private startUpdating(): void {\n this.keepRunning = true;\n if (this.currentLoop === undefined) this.currentLoop = this.mainLoop();\n }\n\n /** Called from observer */\n private stopUpdating(): void {\n this.keepRunning = false;\n }\n\n /** If true, main loop will continue polling pl state. */\n private keepRunning = false;\n /** Actual state of main loop. */\n private currentLoop: Promise<void> | undefined = undefined;\n\n private async mainLoop() {\n while (this.keepRunning) {\n const toNotify = this.scheduledOnNextState;\n this.scheduledOnNextState = [];\n\n try {\n await asyncPool(\n this.opts.nConcurrentGetProgresses,\n this.getAllNotDoneProgresses().map((p) => async () => await p.updateStatus()),\n );\n\n toNotify.forEach((n) => n.resolve());\n } catch (e: any) {\n console.error(e);\n toNotify.forEach((n) => n.reject(e));\n }\n\n if (!this.keepRunning) break;\n await scheduler.wait(this.opts.pollingInterval);\n }\n\n this.currentLoop = undefined;\n }\n\n private getAllNotDoneProgresses(): Array<UploadTask> {\n return Array.from(this.idToProgress.entries())\n .filter(([_, p]) => !isProgressDone(p.progress))\n .map(([_, p]) => p);\n }\n}\n\nfunction isProgressDone(p: sdk.ImportProgress) {\n return p.done && (p.status?.progress ?? 0.0) >= 1.0;\n}\n\ntype ScheduledRefresh = {\n resolve: () => void;\n reject: (err: any) => void;\n};\n\nfunction validateResourceType(methodName: string, rType: ResourceType) {\n if (!rType.name.startsWith('BlobUpload') && !rType.name.startsWith('BlobIndex')) {\n throw new WrongResourceTypeError(\n `${methodName}: wrong resource type: ${rType.name}, `\n + `expected: a resource of either type 'BlobUpload' or 'BlobIndex'.`,\n );\n }\n}\n"],"names":["isPlTreeEntry","isPlTreeEntryAccessor","makeResourceSnapshot","UploadResourceSnapshot","IndexResourceSnapshot","TaskProcessor","PollingComputableHooks","Computable","randomUUID","UploadTask","nonRecoverableError","asyncPool","scheduler","WrongResourceTypeError"],"mappings":";;;;;;;;;;;AA+BM,SAAU,sBAAsB,CACpC,eAAuE,EACvE,GAAkB,EAAA;AAElB,IAAA,MAAM,IAAI,GAAGA,oBAAa,CAAC,eAAe;UACtC,GAAG,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,IAAI;AACpC,UAAEC,4BAAqB,CAAC,eAAe;AACrC,cAAE,eAAe,CAAC,IAAI;cACpB,eAAe;IAErB,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;AACjD,QAAA,OAAOC,2BAAoB,CAAC,IAAI,EAAEC,4BAAsB,CAAC;AAC3D,IAAA,OAAOD,2BAAoB,CAAC,IAAI,EAAEE,2BAAqB,CAAC;AAC1D;AAUA;AAEA;;;AAGkE;MACrD,YAAY,CAAA;AAQJ,IAAA,MAAA;AACA,IAAA,MAAA;AACA,IAAA,UAAA;AACA,IAAA,cAAA;AACA,IAAA,IAAA;AAXF,IAAA,YAAY,GAAgC,IAAI,GAAG,EAAE;;AAGrD,IAAA,WAAW;AACX,IAAA,KAAK;IAEtB,WAAA,CACmB,MAAgB,EAChB,MAAc,EACd,UAAwB,EACxB,cAA8B,EAC9B,IAAA,GAAwB;AACvC,QAAA,sBAAsB,EAAE,EAAE;AAC1B,QAAA,wBAAwB,EAAE,EAAE;AAC5B,QAAA,eAAe,EAAE,IAAI;AACrB,QAAA,gBAAgB,EAAE,IAAI;AACvB,KAAA,EAAA;QATgB,IAAA,CAAA,MAAM,GAAN,MAAM;QACN,IAAA,CAAA,MAAM,GAAN,MAAM;QACN,IAAA,CAAA,UAAU,GAAV,UAAU;QACV,IAAA,CAAA,cAAc,GAAd,cAAc;QACd,IAAA,CAAA,IAAI,GAAJ,IAAI;QAOrB,IAAI,CAAC,WAAW,GAAG,IAAIC,uBAAa,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE;AACnD,YAAA,IAAI,EAAE,gCAAgC;AACtC,YAAA,YAAY,EAAE,EAAE;YAChB,QAAQ,EAAE,KAAK;AACf,YAAA,iBAAiB,EAAE,GAAG;AACtB,YAAA,MAAM,EAAE,GAAG;AACZ,SAAA,CAAC;QAEF,IAAI,CAAC,KAAK,GAAG,IAAIC,iCAAsB,CACrC,MAAM,IAAI,CAAC,aAAa,EAAE,EAC1B,MAAM,IAAI,CAAC,YAAY,EAAE,EACzB,EAAE,YAAY,EAAE,IAAI,CAAC,gBAAgB,EAAE,EACvC,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,CAC/D;IACH;IAUA,aAAa,CACX,cAAoD,EACpD,GAAmB,EAAA;QAEnB,IAAI,GAAG,IAAI,SAAS;AAAE,YAAA,OAAOC,qBAAU,CAAC,IAAI,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;AAE9F,QAAA,MAAM,KAAK,GAA2BP,oBAAa,CAAC,cAAc;AAChE,cAAE,sBAAsB,CAAC,cAAc,EAAE,GAAG;cAC1C,cAAc;AAElB,QAAA,MAAM,QAAQ,GAAGQ,sBAAU,EAAE;AAC7B,QAAA,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;AAC5B,QAAA,GAAG,CAAC,YAAY,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;AAExD,QAAA,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC;AAEpE,QAAA,OAAO,MAAM;IACf;AAEQ,IAAA,kBAAkB,CACxB,CAAU,EACV,GAA2B,EAC3B,QAAgB,EAAA;AAEhB,QAAA,oBAAoB,CAAC,eAAe,EAAE,GAAG,CAAC,IAAI,CAAC;AAE/C,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;AAE1C,QAAA,IAAI,IAAI,IAAI,SAAS,EAAE;AACrB,YAAA,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC;YAC5B,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,QAAQ,CAAC;QACtC;AAEA,QAAA,MAAM,OAAO,GAAG,IAAIC,sBAAU,CAC5B,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,IAAI,CAAC,sBAAsB,EAChC,IAAI,CAAC,MAAM,EACX,GAAG,CACJ;QAED,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,CAAC;AAEtC,QAAA,IAAI,OAAO,CAAC,oBAAoB,EAAE,EAAE;AAClC,YAAA,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;AACpB,gBAAA,EAAE,EAAE,MAAM,OAAO,CAAC,cAAc,EAAE;gBAClC,yBAAyB,EAAE,CAAC,CAAC,KAAK,CAACC,+BAAmB,CAAC,CAAC,CAAC;AAC1D,aAAA,CAAC;QACJ;AAEA,QAAA,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAC;QAC/B,OAAO,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,QAAQ,CAAC;IACzC;;AAGQ,IAAA,MAAM,OAAO,CAAC,EAAc,EAAE,QAAgB,EAAA;QACpD,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;QACtC,IAAI,IAAI,KAAK,SAAS;YAAE;QAExB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;AACzC,QAAA,IAAI,OAAO;AAAE,YAAA,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;IAC3C;;AAGO,IAAA,MAAM,UAAU,GAAA;AACrB,QAAA,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE;IACzB;IAEQ,oBAAoB,GAAuB,EAAE;IAE7C,mBAAmB,CAAC,OAAmB,EAAE,MAA0B,EAAA;QACzE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IACrD;;IAGQ,aAAa,GAAA;AACnB,QAAA,IAAI,CAAC,WAAW,GAAG,IAAI;AACvB,QAAA,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS;AAAE,YAAA,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,QAAQ,EAAE;IACxE;;IAGQ,YAAY,GAAA;AAClB,QAAA,IAAI,CAAC,WAAW,GAAG,KAAK;IAC1B;;IAGQ,WAAW,GAAG,KAAK;;IAEnB,WAAW,GAA8B,SAAS;AAElD,IAAA,MAAM,QAAQ,GAAA;AACpB,QAAA,OAAO,IAAI,CAAC,WAAW,EAAE;AACvB,YAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,oBAAoB;AAC1C,YAAA,IAAI,CAAC,oBAAoB,GAAG,EAAE;AAE9B,YAAA,IAAI;AACF,gBAAA,MAAMC,mBAAS,CACb,IAAI,CAAC,IAAI,CAAC,wBAAwB,EAClC,IAAI,CAAC,uBAAuB,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,YAAY,MAAM,CAAC,CAAC,YAAY,EAAE,CAAC,CAC9E;AAED,gBAAA,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC;YACtC;YAAE,OAAO,CAAM,EAAE;AACf,gBAAA,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;AAChB,gBAAA,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACtC;YAEA,IAAI,CAAC,IAAI,CAAC,WAAW;gBAAE;YACvB,MAAMC,kBAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC;QACjD;AAEA,QAAA,IAAI,CAAC,WAAW,GAAG,SAAS;IAC9B;IAEQ,uBAAuB,GAAA;QAC7B,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE;AAC1C,aAAA,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC;AAC9C,aAAA,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;IACvB;AACD;AAED,SAAS,cAAc,CAAC,CAAqB,EAAA;AAC3C,IAAA,OAAO,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,IAAI,GAAG,KAAK,GAAG;AACrD;AAOA,SAAS,oBAAoB,CAAC,UAAkB,EAAE,KAAmB,EAAA;IACnE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE;QAC/E,MAAM,IAAIC,8BAAsB,CAC9B,CAAA,EAAG,UAAU,CAAA,uBAAA,EAA0B,KAAK,CAAC,IAAI,CAAA,EAAA;AAC/C,cAAA,CAAA,gEAAA,CAAkE,CACrE;IACH;AACF;;;;;"}
|
package/dist/drivers/upload.d.ts
CHANGED