feat(files): CAR Import by badgooooor · Pull Request #2323 · ipfs/ipfs-webui

badgooooor · 2025-02-03T14:52:53Z

Description

Close Import/export CAR DAG archives #1798
Add "Import CAR File", including
- Dropdown menu in import
- CAR File import modal with file input, optional name input and validation on file name by extension
- Add local definition of DAG from kubo to IPFSService

… file and validate file name

src/bundles/files/actions.js

lidel

Thank you @badgooooor!

I've pushed small cosmetic changes to follow similar visual language as in "Bulk import" feature added in #2307, added CLI tutor docs and unified CAR Import/Export language.

Looks good to merge on my end, but would appreciate second set of eyes on UI and language.

@SgtPooki / @2color mind taking a final look, and if looks ok, merge?

2color

I discovered a bug when you try to import and the name already exists. I've pushed a229aa9 to fix this, in lieu of a better way to show errors, I just throw a more helpful error.

Besides that, LGTM.

Thanks @badgooooor 🎉

SgtPooki · 2025-03-05T12:44:12Z

i'm getting an error when importing:

core.ts:90 Uncaught (in promise) HTTPError: file does not exist
    at Object.errorHandler [as handleError] (core.ts:90:22)
    at async Client.fetch (http.ts:165:11)
    at async Object.stat (stat.ts:9:17)
    at async actions.js:421:7
    at async task.js:100:12
    at async task.js:199:20
    at async utils.js:139:12

commenting out changes from a229aa9 resolves this. Will look into a more robust fix.

2color · 2025-03-05T13:14:01Z

@SgtPooki sorry that was oversight on my end. I used the then notation (avoiding try catch) because we swallow the error. I just pushed a small refactor to keep it leaner.

SgtPooki

a few small nits..

I think we should update the modal to provide a little more information.. here is a quick edit I made that I think improves clarity for users a bit (and centers the description):

SgtPooki · 2025-03-05T13:02:15Z

src/bundles/files/actions.js

+        // TODO: Not sure why we do this. Perhaps a generic error is used
+        // to avoid leaking private information via Countly?
+        throw Object.assign(new Error('ipfs.files.cp call failed'), {


FYI we no longer use countly.. we need to strip it from this repo

src/files/FilesPage.js

SgtPooki · 2025-03-05T13:37:00Z

@types/ipfs/index.d.ts

    name: NameService;
    object: ObjectService;
    config: ConfigService;
+    dag: KuboRPCClient['dag'];


note that I removed the custom defined types here so we don't have to manage them later. Ideally this whole IPFSService will be going away and we'll be using types from kubo-rpc-client going forward.

SgtPooki · 2025-03-05T13:37:14Z

public/locales/en/files.json

+    "description": "Choose a CAR file to import a DAG from and specify a name for it to be imported into the current directory.",
+    "selectCARButtonText": "Select CAR…",
+    "namePlaceholder": "Name",
+    "renameImportPath": "Rename import"


new label for rename input

SgtPooki · 2025-03-05T13:37:40Z

src/bundles/files/actions.js

+      // @ts-expect-error - https://github.com/ipfs/js-kubo-rpc-client/issues/278
+      const result = await all(ipfs.dag.import(stream, {


kubo-rpc-client types need updated.

src/bundles/files/actions.js

SgtPooki · 2025-03-05T13:39:28Z

src/files/modals/add-by-car-modal/AddByCarModal.js

+        {/* Gray text showing original car file name */}
+        { file != null
+          ? <div className='mt1 f7 center charcoal-muted tl w-90'>{file.path}</div>
+          : null
+        }


new display of original car file

SgtPooki · 2025-03-05T13:39:36Z

src/files/modals/add-by-car-modal/AddByCarModal.js

+          <p className='mt0 center charcoal tl w-90'>{t('addByCarModal.description')}</p>
+        </div>
+
+        <label htmlFor='import-car-file-name' className='mt0 f7 center charcoal-muted tl w-90'>{t('addByCarModal.renameImportPath')}</label>


new label for rename input

src/bundles/files/actions.js

## [4.6.0](v4.5.0...v4.6.0) (2025-03-14) CID `bafybeibpaa5kqrj4gkemiswbwndjqiryl65cks64ypwtyerxixu56gnvvm` --- ### Features * add dark mode ([#2322](#2322)) ([d751fc6](d751fc6)) * bulk CIDs import ([#2307](#2307)) ([830a30d](830a30d)), closes [#2305](#2305) [#2306](#2306) [#2293](#2293) [#2290](#2290) [#2306](#2306) [#2304](#2304) [#2302](#2302) [#2292](#2292) [#2291](#2291) [#2296](#2296) [#2303](#2303) [#2295](#2295) [#2308](#2308) * **files:** CAR Import ([#2323](#2323)) ([e66590f](e66590f)) ### Trivial Changes * Pull transifex translations ([#2340](#2340)) ([493223a](493223a)) * Pull transifex translations ([#2343](#2343)) ([007dbb1](007dbb1))

ipfs-gui-bot · 2025-03-14T16:39:06Z

🎉 This PR is included in version 4.6.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

badgooooor added 8 commits February 1, 2025 14:13

feat: add dropdown menu for import car

bc3c29d

feat: add modal for import car

d97c867

locale: add en locale

a3d7418

refactor,feat: change to functional component, add check file, rename…

9488c3d

… file and validate file name

feat: wiring handling uploading car dag file

f0b44df

locale: add placeholder

742de35

feat: add import car file

e381d4e

refactor: clear unused params

40f58d0

badgooooor temporarily deployed to Deploy February 3, 2025 14:55 — with GitHub Actions Inactive

lidel reviewed Feb 3, 2025

View reviewed changes

src/bundles/files/actions.js Outdated Show resolved Hide resolved

lidel changed the title ~~Import CAR File~~ feat(fileS): Import CAR File Feb 3, 2025

lidel changed the title ~~feat(fileS): Import CAR File~~ feat(files): CAR Import Feb 3, 2025

badgooooor added 4 commits February 4, 2025 19:23

update dependency

5e324f3

refactor: cleanup modal

ce09977

feat: update types

e7001ec

feat: wip on dag import

f1abecf

badgooooor temporarily deployed to Deploy February 4, 2025 17:16 — with GitHub Actions Inactive

SgtPooki reviewed Feb 5, 2025

View reviewed changes

src/bundles/files/actions.js Outdated Show resolved Hide resolved

badgooooor added 2 commits February 6, 2025 22:22

feat: add util

1eb486f

feat: fix parse file for dag import

0e6bdd4

badgooooor temporarily deployed to Deploy February 6, 2025 15:25 — with GitHub Actions Inactive

docs: Add AddByCarModal as storybook

f2271cc

badgooooor temporarily deployed to Deploy February 6, 2025 15:51 — with GitHub Actions Inactive

fix: fix typecheck error

d234a60

badgooooor temporarily deployed to Deploy February 6, 2025 16:17 — with GitHub Actions Inactive

lidel reviewed Feb 6, 2025

View reviewed changes

src/bundles/files/actions.js Show resolved Hide resolved

fix: revert back

ab8b11f

badgooooor temporarily deployed to Deploy February 7, 2025 01:34 — with GitHub Actions Inactive

badgooooor added 2 commits February 10, 2025 14:30

feat: update types of IPFSService

3820dad

feat: revert types to use modified type

e5b82d2

lidel approved these changes Mar 4, 2025

View reviewed changes

chore: throw helpful error if name exists

a229aa9

2color approved these changes Mar 5, 2025

View reviewed changes

2color temporarily deployed to Deploy March 5, 2025 11:34 — with GitHub Actions Inactive

fix: dont throw error when importing car if destination doesnt exist

5b35fec

SgtPooki temporarily deployed to Deploy March 5, 2025 12:52 — with GitHub Actions Inactive

SgtPooki mentioned this pull request Mar 5, 2025

fix: support readable streams as iterable in dag.import ipfs/js-kubo-rpc-client#278

Open

fix: swallow error when file doesn't exist

a3abcce

2color temporarily deployed to Deploy March 5, 2025 13:14 — with GitHub Actions Inactive

SgtPooki reviewed Mar 5, 2025

View reviewed changes

chore: remove unnecessary changes

bda1817

SgtPooki temporarily deployed to Deploy March 5, 2025 13:29 — with GitHub Actions Inactive

SgtPooki added 2 commits March 5, 2025 07:36

chore: use kubo-rpc-client types for IPFSService

838aae0

chore: minor ux fixes

d1ae76f

SgtPooki temporarily deployed to Deploy March 5, 2025 13:38 — with GitHub Actions Inactive

fix: dont error if path doesn't exist

2b929fc

SgtPooki approved these changes Mar 5, 2025

View reviewed changes

SgtPooki temporarily deployed to Deploy March 5, 2025 13:40 — with GitHub Actions Inactive

Merge branch 'main' into feat/import-dag-car-file

34f15dc

badgooooor temporarily deployed to Deploy March 5, 2025 14:04 — with GitHub Actions Inactive

2color reviewed Mar 5, 2025

View reviewed changes

src/bundles/files/actions.js Show resolved Hide resolved

fix: remove duplicate catch block

8c5ff77

SgtPooki temporarily deployed to Deploy March 5, 2025 14:33 — with GitHub Actions Inactive

SgtPooki merged commit e66590f into ipfs:main Mar 5, 2025
20 checks passed

lidel mentioned this pull request Mar 14, 2025

Release 0.34 ipfs/kubo#10685

Closed

56 tasks

ipfs-gui-bot added the released label Mar 14, 2025

		// @ts-expect-error - https://github.com/ipfs/js-kubo-rpc-client/issues/278
		const result = await all(ipfs.dag.import(stream, {

Conversation

badgooooor commented Feb 3, 2025 • edited by lidel Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lidel left a comment

Choose a reason for hiding this comment

Uh oh!

2color left a comment

Choose a reason for hiding this comment

Uh oh!

SgtPooki commented Mar 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

2color commented Mar 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SgtPooki left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SgtPooki Mar 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

SgtPooki Mar 5, 2025

Choose a reason for hiding this comment

Uh oh!

SgtPooki Mar 5, 2025

Choose a reason for hiding this comment

Uh oh!

SgtPooki Mar 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

SgtPooki Mar 5, 2025

Choose a reason for hiding this comment

Uh oh!

SgtPooki Mar 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ipfs-gui-bot commented Mar 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

badgooooor commented Feb 3, 2025 •

edited by lidel

Loading

SgtPooki commented Mar 5, 2025 •

edited

Loading

2color commented Mar 5, 2025 •

edited

Loading

SgtPooki left a comment •

edited

Loading