This repository has been archived by the owner on Feb 12, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
⚡️ v0.41.0 RELEASE 🚀 #2656
Labels
Comments
What steps are required to define the issue and include a resolution for #2161 in this release? Transmitting large files between browsers seems like a primary use case. |
With any luck this will be magically be fixed in this version with the new libp2p release which includes libp2p/js-libp2p-mplex#100 I agree this is an important bug to get squashed. If you’re willing it would be good to get your testing when the prerelease comes out. |
This was referenced Jan 30, 2020
Closed
🥚 |
This was referenced Feb 10, 2020
🐣 |
🐥 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
🗺 What's left for release
repo stat --human
bitswap stat --human
libp2pOptions
passed to libp2p bundle functionwebui@2.7.2
ipfs add --hidden
flag🚢 Estimated shipping date
Feb 14
🔦 Highlights
🦁 Async Await and Async Iterables
🎶 In the jungle, the mighty jungle the lion sleeps tonight!
🎶 async await, async await, async await, async await...
We've completed a HUGE refactor to js-ipfs internals 🥳, switching to using Promises and
async
/await
over Callbacks and using async iterables instead of Node.js and Pull Streams. Ok, tell a lie, it's actually not just js-ipfs internals, it's the whole stack, including libp2p, IPLD and multiformats, you might call it a ground up re-write, but, you know, we don't like to brag.🚨 Oh, wait, serious note - this release brings big breaking changes to the core API so please consult the "API Changes" section below for all the information.
It's been a long and emotional voyage but this refactor brings a plethora of incredible immediate and future benefits to consumers, contributors and core developers that make all the work and effort worthwhile. To summarise, we've:
async
/await
so we’ll get better error stack traces and improved readability and maintainabilityUsing
async
/await
in JavaScript is gaining a lot of traction in the ecosystem and is rapidly becoming the de facto way of writing idiomatic JS. We want js-ipfs to move with the times and continue to be attractive to contributors by using modern JS features, techniques and practices. The big idea with these changes is for the code to be easier to contribute to, easier to understand, easier to maintain, and be faster and smaller than ever.This change is so big, and so significant, we wrote a whole blog post about it to explain the motivations behind the changes...in
excruciatingdelightful depth 🤣!We've also compiled some stats on this refactor for your viewing pleasure:
package.json
ipfs-http-client
browser bundle (unpkg.com/ipfs-http-client@41.0.1 vs unpkg.com/ipfs-http-client@42.0.0) - that's 60% smaller!ipfs-http-client
(net)...and a lot of those stats are just for js-ipfs and js-ipfs-http-client - the tip of the iceberg! We saw changes similar to this for between 60-70 dependencies across IPFS, libp2p, IPLD and multiformats.
🌗 UnixFS v1.5
Turns out, it's really important for package managers to retain file metadata, particularly last modified time (
mtime
). Filemtime
allows them to selectively sync only data that has changed. Up until now if you wanted to host a large data set on IPFS, like a package manager's repository, it would be difficult to update."What about the permenant web?" I hear you cry. Well, this absolutely doesn't prevent a particular snapshot of a package manager's repository from being permenantly available. Metadata just enables diffs to be imported, instead of the whole thing. So, when I say "difficult to update", like I did up there, I mean slow and/or impossible. When you have Terabytes (or more) of package data and someone publishes a new package, it's kinda inconvenient to import everything again, when only a little part changed. File
mtime
is a really good indicator of which things have changed, so you can use it in IPFS now! 🥳For example, there's two new options to
jsipfs add
that allowmode
andmtime
to be preserved as the file is added to IPFS:Ok, no big changes there aside from the new options, buuut, now when you list directory contents you get
Mode
andMtime
info:The coolest thing is that it's completely backwards compatible. The CID for a given file/directory only changes if you opt in to metadata, otherwise the CIDs remain the same. Hooray!
There's a bunch of changes that add metadata capability to the CLI, HTTP and core API both for inputs and outputs. There's also a couple of new MFS commands
touch
andchmod
which allow you to change the metadata whenever you like! Magic 🧙♂️.See the API Changes sections below for details of all the new UnixFS v1.5 stuffs.
🏗 API Changes
Core API
There are significant and breaking core API changes in this release. Please see the migration guide.
IPFS is not a class that can be instantiated - use
IPFS.create
. An IPFS node instance is not an event emitter.The
init
option passed toIPFS.create
will now not take any initialization steps if it is set tofalse
. Previously, the repo would be initialized if it already existed. This is no longer the case. If you wish to initialize a node but only if the repo exists, passinit: { allowNew: false }
to the constructor.Instance
.ready
property has been removed. Please useIPFS.create
instead.IPFS.createNode
has been removed, please useIPFS.create
instead.Callbacks are no longer supported on any API methods. Please use a utility such as
callbackify
on API methods that return Promises to emulate previous behaviour. See the migration guide for more info.Delegated peer and content routing modules are no longer included as part of core (but are still available if starting a js-ipfs daemon from the command line). If you wish to use delegated routing and are creating your node programmatically in Node.js or the browser you must
npm install libp2p-delegated-content-routing
and/ornpm install libp2p-delegated-peer-routing
and provide configured instances of them inoptions.libp2p
. See the module repos for further instructions:add
now returns an async iterable.add
now acceptsmode
andmtime
options on inputs to allow setting mode and mtime metadata for added files. See the core interface docs for more info.add
results now contain acid
property (a CID instance) instead of a stringhash
property.🆕
add
results now includemode
andmtime
properties if they were set.addReadableStream
,addPullStream
have been removed. Please see the migration guide for more info.addFromStream
has been removed. Useadd
instead.addFromFs
has been removed. Please use the exportedglobSource
utility and pass the result toadd
. See the glob source documentation for more details and an example.addFromURL
has been removed. Please use the exportedurlSource
utility and pass the result toadd
. See the URL source documentation for more details and an example.bitswap.stat
result has changed -wantlist
and values are now an array of CID instances andpeers
is now astring[]
of peer IDs.bitswap.wantlist
now returns an array of CID instances.block.rm
now returns an async iterable.block.rm
now yields objects of{ cid: CID, error: Error }
.block.stat
result now contains acid
property (whose value is a CID instance) instead of akey
property.dht.findProvs
,dht.provide
,dht.put
anddht.query
now all return an async iterable.dht.findPeer
,dht.findProvs
,dht.provide
,dht.put
anddht.query
now yield/return an object{ id: string, addrs: Multiaddr[] }
instead of aPeerInfo
instance(s).🆕
files.chmod
has been added. See the core interface docs for info.🆕
files.flush
now returns the root CID for the path that was flushed (/
by default)files.lsPullStream
andfiles.lsReadableStream
have been removed. Please see the migration guide for more info.files.ls
now returns an async iterable.files.ls
results now contain acid
property (whose value is a CID instance) instead of ahash
property.🆕
files.ls
results now includemode
andmtime
properties if they were set. See the core interface docs for more info.files.ls
no longer takes along
option (in core) - you will receive all data by default.🆕
files.mkdir
now acceptsmode
andmtime
options to allow setting mode and mtime metadata. See the core interface docs for more info.files.readPullStream
andfiles.readReadableStream
have been removed. Please see the migration guide for more info.files.read
now returns an async iterable.files.stat
result now contains acid
property (whose value is a CID instance) instead of ahash
property.🆕
files.stat
result now includesmode
andmtime
properties if they were set. See the core interface docs for more info.🆕
files.touch
has been added. See the core interface docs for info.🆕
files.write
now acceptsmode
andmtime
options to allow setting mode and mtime metadata. See the core interface docs for more info.get
now returns an async iterable. Thecontent
property value for objects yielded from the iterator is now an async iterable that yieldsBufferList
objects.id
result has changed, theaddresses
property is now aMultiaddr[]
name.resolve
now returns an async iterable. It yields increasingly more accurate resolved values as they are discovered until the best value is selected from the quorum of 16. The "best" resolved value is the last item yielded from the iterator. If you are interested only in this best value you could useit-last
to extract it like so:🆕
object.get
now accepts atimeout
option. It will cause the method to throw with aTimeoutError
if no data is received within the timeout window. It can be passed as anumber
or astring
. If anumber
is passed it is interpreted as milliseconds, if a string is passed it is interpreted as a human readable duration.ls
now returns an async iterable.ls
results now contain acid
property (whose value is a CID instance) instead of ahash
property.🆕
ls
results now includemode
andmtime
properties if they were set. See the core interface docs for more info.pin.add
results now contain acid
property (a CID instance) instead of a stringhash
property.🆕
pin.add
now accepts atimeout
option. It will cause the method to throw with aTimeoutError
if no data is received within the timeout window. It can be passed as anumber
or astring
. If anumber
is passed it is interpreted as milliseconds, if a string is passed it is interpreted as a human readable duration.pin.ls
now returns an async iterable.pin.ls
results now contain acid
property (a CID instance) instead of a stringhash
property.pin.rm
results now contain acid
property (a CID instance) instead of a stringhash
property.ping
now returns an async iterable.refs
andrefs.local
now return an async iterable.🆕
refs
now accepts atimeout
option. It will cause the method to throw with aTimeoutError
if no data is received within the timeout window. It can be passed as anumber
or astring
. If anumber
is passed it is interpreted as milliseconds, if a string is passed it is interpreted as a human readable duration.repo.gc
now returns an async iterable.stats.bw
now returns an async iterable.swarm.peers
now returns an array of objects with apeer
property that is astring
, instead of aPeerId
instance.swarm.addrs
now returns an array of objects{ id: string, addrs: Multiaddr[] }
instead ofPeerInfo
instances.HTTP API
/api/v0/add
now supports the following additional multipart headers to allowmode
andmtime
metadata to be set on individual files:mode
file mode to apply to created UnixFS entries[string]
mtime
modification time in seconds before or since the Unix Epoch to apply to created UnixFS entries[number]
mtime-nsecs
modification time fraction in nanoseconds[number]
/api/v0/add
now returns fileMode
,Mtime
andMtimeNsecs
if set./api/v0/file/ls
has been removed, please use/api/v0/ls
instead./api/v0/files/chmod
has been added and supports the following query string args:arg
path of file to apply mode to[string]
mode
file mode to apply[string]
/api/v0/files/ls
now returns fileMode
,Mtime
andMtimeNsecs
if set./api/v0/files/mkdir
now supports supports the following additional query string args:mode
file mode to apply[string]
mtime
modification time in seconds before or since the Unix Epoch to apply[number]
/api/v0/files/stat
now returns fileMode
,Mtime
andMtimeNsecs
if set./api/v0/files/touch
has been added and supports the following query string args:arg
path of file to apply mode to[string]
mtime
modification time in seconds before or since the Unix Epoch to apply[number]
/api/v0/files/write
now supports the following additional multipart headers:mode
file mode to apply to created UnixFS entries[string]
mtime
modification time in seconds before or since the Unix Epoch to apply to created UnixFS entries[number]
/api/v0/ls
now returns fileMode
,Mtime
andMtimeNsecs
if set.CLI
jsipfs add [file...]
now supports the following flags to respect and applymode
andmtime
metadata of files added from the file system or explicitly set them:--preserve-mode
automatically apply permissions to created UnixFS entries from the file system[boolean] [default: false]
--preserve-mtime
automatically apply modification time to created UnixFS entries from the file system[boolean] [default: false]
--mode
file mode to apply to created UnixFS entries[string]
--mtime
modification time in seconds before or since the Unix Epoch to apply to created UnixFS entries[number]
--mtime-nsecs
modification time fraction in nanoseconds[number]
jsipfs file ls
has been removed, please usejsipfs ls
instead.jsipfs files chmod [mode] [path]
has been added.jsipfs files ls
now prints filemode
andmtime
.jsipfs files mkdir
now supports the following flags:--mode
file mode to apply to created UnixFS entries[string]
--mtime
modification time in seconds before or since the Unix Epoch to apply to created UnixFS entries[number]
jsipfs files stat
now prints filemode
andmtime
.jsipfs files touch [path]
has been added and supports the following flags:--mtime
modification time in seconds before or since the Unix Epoch to apply to created UnixFS entries[number]
jsipfs files write
now supports the following flags:--mode
file mode to apply to created UnixFS entries[string]
--mtime
modification time in seconds before or since the Unix Epoch to apply to created UnixFS entries[number]
jsipfs ls
now prints filemode
andmtime
.Other changes
✅ Release Checklist
sharness(Does not runjs-ipfs
)webui(Does not depend onjs-ipfs
orjs-ipfs-http-client
)ipfs-desktop(Does not depend onjs-ipfs
orjs-ipfs-http-client
)ipfs-pubsub-roomdoes not depend on IPFS anymore chore: remove ipfs-pubsub-room from CI #2765❤️ Huge thank you to everyone that made this release possible
🙌🏽 Want to contribute?
Would you like to contribute to the IPFS project and don't know how? Well, there are a few places you can get started:
help wanted
label in the js-ipfs repoThe best place to ask your questions about IPFS, how it works and what you can do with it is at discuss.ipfs.io. We are also available at the
#ipfs
channel on Freenode.The text was updated successfully, but these errors were encountered: