Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: migrate ipfs-api to ipfs-http-client #1647

Closed
wants to merge 1 commit into from

Conversation

andremedeiros
Copy link
Collaborator

Deprecates #1535

@ghost
Copy link

ghost commented May 30, 2019

DeepCode analyzed this pull request.
There is 1 new info report.

Click to see more details.

@andremedeiros andremedeiros requested a review from a team May 30, 2019 20:34
@@ -2,10 +2,15 @@ import { __ } from 'embark-i18n';
import { dappPath, embarkPath } from 'embark-utils';
var Npm = require('./npm.js');

const DEPRECATIONS = {
'ipfs-api': 'ipfs-http-client'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work! As part of the deprecation logic do we need to pair this with a default version of ipfs-http-client to use in case ipfs-api is found in embark.json?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great question!

This will use the default version for the replacement, so it'll forward the call to version:get:ipfs-http-client. That version comes from this.versions:

https://github.com/embark-framework/embark/pull/1647/files#diff-354526adef3a786756303636f591fd48R36

This would then be registered and used here:

https://github.com/embark-framework/embark/pull/1647/files#diff-354526adef3a786756303636f591fd48R80

Copy link
Collaborator

@emizzle emizzle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for thinking about the upgrade path. Should we maybe add a link in the deprecation warning to a blog post or some documentation or maybe even just inline instructions on further action for the user? For example, "Please update embark.json versions to use ipfs-http-client instead of ipfs-api".

Copy link
Collaborator

@jrainville jrainville left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM too. I like @emizzle 's suggestion though

@michaelsbradleyjr
Copy link
Contributor

@andremedeiros since we need to hold off on this package upgrade until embark 5.0.0[-alpha.0] (when we can change the min supported NodeJS version) maybe we should close this PR and reset the task state in Pivotal.

@michaelsbradleyjr michaelsbradleyjr added the v5 involves breaking change/s that will be introduced in v5.0.0 label Jun 5, 2019
@iurimatias iurimatias closed this Aug 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
v5 involves breaking change/s that will be introduced in v5.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants