feat: support name in ls

[oed]

According to the Kubo docs (and practical experience) the pin label (name) is returned top level on the pin item (not in Metadata)

Also doesn't seem like Metadata is a thing anymore, but left it in case.

[oed]

Looks like there's just a timeout on the windows tests?

[achingbrain]

Thanks for submitting this - could you please add a test or some assertions to an existing test in https://github.com/ipfs/js-kubo-rpc-client/blob/main/test/interface-tests/src/pin/ls.ts to ensure this works as expected and there will be no regressions in future?

[oed]

Sure can, however I'm having some issues installing dependencies locally.

% npm i

npm WARN EBADENGINE Unsupported engine {
npm WARN EBADENGINE   package: 'undici@7.3.0',
npm WARN EBADENGINE   required: { node: '>=20.18.1' },
npm WARN EBADENGINE   current: { node: 'v20.10.0', npm: '10.2.3' }
npm WARN EBADENGINE }
npm WARN deprecated inflight@1.0.6: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
npm WARN deprecated lodash.get@4.4.2: This package is deprecated. Use the optional chaining (?.) operator instead.
npm WARN deprecated @babel/plugin-proposal-nullish-coalescing-operator@7.18.6: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-nullish-coalescing-operator instead.
npm WARN deprecated @babel/plugin-proposal-class-properties@7.18.6: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-class-properties instead.
npm WARN deprecated @babel/plugin-proposal-optional-catch-binding@7.18.6: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-optional-catch-binding instead.
npm WARN deprecated read-pkg-up@11.0.0: Renamed to read-package-up
npm WARN deprecated rimraf@2.7.1: Rimraf versions prior to v4 are no longer supported
npm WARN deprecated lodash.isequal@4.5.0: This package is deprecated. Use require('node:util').isDeepStrictEqual instead.
npm WARN deprecated har-validator@5.1.5: this library is no longer supported
npm WARN deprecated @humanwhocodes/config-array@0.13.0: Use @eslint/config-array instead
npm WARN deprecated @babel/plugin-proposal-optional-chaining@7.21.0: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-optional-chaining instead.
npm WARN deprecated @babel/plugin-proposal-async-generator-functions@7.20.7: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-async-generator-functions instead.
npm WARN deprecated rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
npm WARN deprecated rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
npm WARN deprecated rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
npm WARN deprecated rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
npm WARN deprecated rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
npm WARN deprecated @humanwhocodes/object-schema@2.0.3: Use @eslint/object-schema instead
npm WARN deprecated glob@7.2.3: Glob versions prior to v9 are no longer supported
npm WARN deprecated glob@7.2.3: Glob versions prior to v9 are no longer supported
npm WARN deprecated glob@7.2.3: Glob versions prior to v9 are no longer supported
npm WARN deprecated glob@7.2.3: Glob versions prior to v9 are no longer supported
npm WARN deprecated glob@7.2.3: Glob versions prior to v9 are no longer supported
npm WARN deprecated glob@7.2.3: Glob versions prior to v9 are no longer supported
npm WARN deprecated @babel/plugin-proposal-object-rest-spread@7.20.7: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-object-rest-spread instead.
npm WARN deprecated boolean@3.2.0: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.
npm WARN deprecated uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
npm WARN deprecated multibase@4.0.6: This module has been superseded by the multiformats module
npm WARN deprecated request@2.88.2: request has been deprecated, see https://github.com/request/request/issues/3142
npm WARN deprecated eslint@8.57.1: This version is no longer supported. Please see https://eslint.org/version-support for other options.
npm WARN deprecated oas-tools@2.2.2: This package will stop receiving updates in the near future. Please migrate to @oas-tools/core and refer to documentation at https://oas-tools.github.io/docs/migration
npm ERR! code 1
npm ERR! path /Users/joel/code/js-kubo-rpc-client/node_modules/kubo
npm ERR! command failed
npm ERR! command sh -c node src/post-install.js
npm ERR! https://dist.ipfs.tech/kubo/versions
npm ERR! HTTPError: Response code 504 (Gateway Timeout)
npm ERR!     at Request.<anonymous> (/Users/joel/code/js-kubo-rpc-client/node_modules/got/dist/source/as-promise/index.js:118:42)
npm ERR!     at process.processTicksAndRejections (node:internal/process/task_queues:95:5) {
npm ERR!   code: 'ERR_NON_2XX_3XX_RESPONSE',
npm ERR!   timings: {
npm ERR!     start: 1739540225453,
npm ERR!     socket: 1739540225453,
npm ERR!     lookup: 1739540225453,
npm ERR!     connect: 1739540225453,
npm ERR!     secureConnect: 1739540225453,
npm ERR!     upload: 1739540225453,
npm ERR!     response: 1739540285625,
npm ERR!     end: 1739540285626,
npm ERR!     error: undefined,
npm ERR!     abort: undefined,
npm ERR!     phases: {
npm ERR!       wait: 0,
npm ERR!       dns: 0,
npm ERR!       tcp: 0,
npm ERR!       tls: 0,
npm ERR!       request: 0,
npm ERR!       firstByte: 60172,
npm ERR!       download: 1,
npm ERR!       total: 60173
npm ERR!     }
npm ERR!   }
npm ERR! }

npm ERR! A complete log of this run can be found in: /Users/joel/.npm/_logs/2025-02-14T13_33_51_093Z-debug-0.log

[oed]

Actually that seems to be an issue with the IDE I was using. Got it working now.

[achingbrain]

No, I think the infrastructure is flaky 🙄. It was 504ing for me too when you posted that, someone's rebooted something and it works now.

[oed]

How do I test only a specific file with aegir btw?
I get this error when trying the obvious way:

% npm t -- -f test/interface-tests/src/pin/ls.ts   

> kubo-rpc-client@5.0.2 test
> aegir test -f test/interface-tests/src/pin/ls.ts

build

> kubo-rpc-client@5.0.2 build
> aegir build

[15:19:59] tsc [started]
[15:20:01] tsc [completed]
[15:20:01] esbuild [started]
[15:20:01] esbuild [completed]
test node.js

 Exception during run: TypeError: Unknown file extension ".ts" for /Users/joel/code/js-kubo-rpc-client/test/interface-tests/src/pin/ls.ts
    at Object.getFileProtocolModuleFormat [as file:] (node:internal/modules/esm/get_format:160:9)
    at defaultGetFormat (node:internal/modules/esm/get_format:203:36)
    at defaultLoad (node:internal/modules/esm/load:141:22)
    at ModuleLoader.load (node:internal/modules/esm/loader:409:7)
    at ModuleLoader.moduleProvider (node:internal/modules/esm/loader:291:45)
    at link (node:internal/modules/esm/module_job:76:21) {
  code: 'ERR_UNKNOWN_FILE_EXTENSION'
}
Command failed with exit code 1: mocha test/interface-tests/src/pin/ls.ts --ui bdd --require source-map-support/register --timeout=60000 --bail

[achingbrain]

You can use --grep to match strings from describe or it invocations:

npx aegir test -t node --grep 'a string to match'

You can also stick a .only on the test(s) you want to run:

describe.only('...

it.only('...

[achingbrain]

The tests look good - thanks for adding them.

I think it just needs an assertion that the .name property is included in objects yielded from ipfs.pin.ls as part of the PinLsResult interface then it's ready.

If I read it correctly you could just add it to the should list all recursive pins test:

expect(pinset).to.deep.include({
  type: 'recursive',
  cid: fixtures.files[0].cid,
  name: fixtures.files[0].pinName // <- add this line
})

[oed]

So interestingly Kubo doesn't return name if it's not something you queried for, but added a check for it in the tests I introduced.

[achingbrain]

If Kubo doesn’t return this field, does it need to be in the interface?

[oed]

Kubo does return it if you call pin.ls with the name param. Otherwise not. So yes it needs to be there as optional.

[oed]

I think the reason it's not returned by default is that one CID can have multiple names it's pinned under.

[achingbrain]

Aha, gotcha - so it just needs a test that shows this then all is good.

[oed]

Alright, so now we test for both cases:

• should list all types of pins tests that name isn't returned in the regular case
• should list multiple partially matched named pins and should list specific named pin tests that name is returned

[achingbrain]

That's perfect, thanks for making those changes.

[github-actions]

🎉 This PR is included in version 5.1.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[oed]

Thanks @achingbrain !