fix: require passing repo options to migrator (#30)

In order to successfully open a datastore we should accept config that tells us how to open the datastore.

Refs: ipld/explore.ipld.io#65

Author: achingbrain

.travis.yml

@@ -37,13 +37,6 @@ jobs:
         firefox: latest
       script: npx aegir test -t browser -- --browsers FirefoxHeadless
 
-    - stage: test
-      name: sharness
-      os:
-        - linux
-        - osx
-      script: cd ./test/sharness && make
-
     - stage: test
       name: electron-main
       os: osx

README.md

@@ -1,4 +1,4 @@
-# Migration tool for JS IPFS Repo
+# Migration tool for JS IPFS Repo <!-- omit in toc -->
 
 [![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfs-repo-migrations)](https://travis-ci.com/ipfs/js-ipfs-repo-migrations)
 [![codecov](https://codecov.io/gh/ipfs/js-ipfs-repo-migrations/branch/master/graph/badge.svg)](https://codecov.io/gh/ipfs/js-ipfs-repo-migrations)
@@ -15,36 +15,41 @@
 
 This package is inspired by the [go-ipfs repo migration tool](https://github.com/ipfs/fs-repo-migrations/)
 
-## Lead Maintainer
+## Lead Maintainer <!-- omit in toc -->
 
 [Adam Uhlíř](https://github.com/auhau/)
 
-## Table of Contents
+## Table of Contents <!-- omit in toc -->
 
 - [Background](#background)
 - [Install](#install)
   - [npm](#npm)
   - [Use in Node.js](#use-in-nodejs)
   - [Use in a browser with browserify, webpack or any other bundler](#use-in-a-browser-with-browserify-webpack-or-any-other-bundler)
-  - [Use in a browser Using a script tag](#use-in-a-browser-using-a-script-tag)
 - [Usage](#usage)
 - [API](#api)
+  - [`.migrate(path, toVersion, {ignoreLock, repoOptions, onProgress, isDryRun}) -> Promise<void>`](#migratepath-toversion-ignorelock-repooptions-onprogress-isdryrun---promisevoid)
+    - [`onProgress(migration, counter, totalMigrations)`](#onprogressmigration-counter-totalmigrations)
+  - [`.revert(path, toVersion, {ignoreLock, repoOptions, onProgress, isDryRun}) -> Promise<void>`](#revertpath-toversion-ignorelock-repooptions-onprogress-isdryrun---promisevoid)
+  - [`getLatestMigrationVersion() -> int`](#getlatestmigrationversion---int)
 - [CLI](#cli)
 - [Creating a new migration](#creating-a-new-migration)
   - [Architecture of a migration](#architecture-of-a-migration)
+    - [`.migrate(repoPath, repoOptions)`](#migraterepopath-repooptions)
+    - [`.revert(repoPath, repoOptions)`](#revertrepopath-repooptions)
   - [Browser vs. NodeJS environments](#browser-vs-nodejs-environments)
   - [Guidelines](#guidelines)
   - [Integration with js-ipfs](#integration-with-js-ipfs)
+  - [Tests](#tests)
   - [Empty migrations](#empty-migrations)
   - [Migrations matrix](#migrations-matrix)
 - [Developer](#developer)
-    - [Module versioning notes](#module-versioning-notes)
+  - [Module versioning notes](#module-versioning-notes)
 - [Contribute](#contribute)
 - [License](#license)
 
 ## Background
 
-
 As js-ipfs evolves and new technologies, algorithms and data structures are incorporated it is necessary to
 enable users to transition between versions. Different versions of js-ipfs may expect a different IPFS repo structure or content (see: [IPFS repo spec](https://github.com/ipfs/specs/tree/master/repo), [JS implementation](https://github.com/ipfs/js-ipfs-repo) ).
 So the IPFS repo is versioned, and this package provides a framework to create migrations to transition
@@ -87,10 +92,15 @@ const migrations = require('ipfs-repo-migrations')
 const repoPath = 'some/repo/path'
 const currentRepoVersion = 7
 const latestVersion = migrations.getLatestMigrationVersion()
+const repoOptions = {
+  ... // the same storage backend/storage options passed to `ipfs-repo`
+}
 
 if(currentRepoVersion < latestVersion){
   // Old repo! Lets migrate to latest version!
-  await migrations.migrate(repoPath, latestVersion)
+  await migrations.migrate(repoPath, latestVersion, {
+    repoOptions
+  })
 }
 ```
 
@@ -106,9 +116,9 @@ Executes a forward migration to a specific version, or to the latest version if
 
  * `path` (string, mandatory) - path to the repo to be migrated
  * `toVersion` (int, mandatory) - version to which the repo should be migrated.
- * `options` (object, optional) - options for the migration
+ * `options` (object, mandatory) - options for the migration
  * `options.ignoreLock` (bool, optional) - if true will not lock the repo when applying migrations. Use with caution.
- * `options.repoOptions` (object, optional) - options that are passed to migrations, that use them to construct the datastore. (options are the same as for IPFSRepo).
+ * `options.repoOptions` (object, mandatory) - options that are passed to migrations, that use them to construct the datastore. (options are the same as for IPFSRepo).
  * `options.onProgress` (function, optional) - callback that is called after finishing execution of each migration to report progress.
  * `options.isDryRun` (bool, optional) - flag that indicates if it is a dry run that should give the same output as running a migration but without making any actual changes.
 
@@ -129,9 +139,9 @@ Executes backward migration to a specific version.
 
  * `path` (string, mandatory) - path to the repo to be reverted
  * `toVersion` (int, mandatory) - version to which the repo should be reverted to.
- * `options` (object, optional) - options for the reversion
+ * `options` (object, mandatory) - options for the reversion
  * `options.ignoreLock` (bool, optional) - if true will not lock the repo when applying migrations. Use with caution.
- * `options.repoOptions` (object, optional) - options that are passed to migrations, that use them to construct the datastore. (options are the same as for IPFSRepo).
+ * `options.repoOptions` (object, mandatory) - options that are passed to migrations, that use them to construct the datastore. (options are the same as for IPFSRepo).
  * `options.onProgress` (function, optional) - callback that is called after finishing execution of each migration to report progress.
  * `options.isDryRun` (bool, optional) - flag that indicates if it is a dry run that should give the same output as running a migration but without making any actual changes.
 

package.json

@@ -20,11 +20,9 @@
   "main": "src/index.js",
   "browser": {
     "./src/repo/lock.js": "./src/repo/lock-memory.js",
+    "./src/repo/default-root-options.js": "./src/repo/ldefault-root-options.browser.js",
     "datastore-fs": "datastore-level"
   },
-  "bin": {
-    "jsipfs-migrations": "./src/cli.js"
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/ipfs/js-ipfs-repo-migrations.git"
@@ -45,17 +43,14 @@
   },
   "dependencies": {
     "buffer": "^5.6.0",
-    "chalk": "^4.0.0",
     "cids": "^0.8.3",
     "datastore-core": "^1.1.0",
     "datastore-fs": "^1.0.0",
     "datastore-level": "^1.1.0",
     "debug": "^4.1.0",
     "interface-datastore": "^1.0.2",
     "multibase": "^1.0.1",
-    "proper-lockfile": "^4.1.1",
-    "yargs": "^15.3.1",
-    "yargs-promise": "^1.1.0"
+    "proper-lockfile": "^4.1.1"
   },
   "devDependencies": {
     "aegir": "^23.0.0",

src/cli.js

@@ -60,3 +60,18 @@ class InvalidValueError extends Error {
 
 InvalidValueError.code = 'ERR_INVALID_VALUE'
 exports.InvalidValueError = InvalidValueError
+
+/**
+ * Exception raised when config is not passed.
+ */
+class MissingRepoOptionsError extends Error {
+  constructor (message) {
+    super(message)
+    this.name = 'MissingRepoOptionsError'
+    this.code = 'ERR_MISSING_REPO_OPTIONS'
+    this.message = message
+  }
+}
+
+MissingRepoOptionsError.code = 'ERR_MISSING_REPO_OPTIONS'
+exports.MissingRepoOptionsError = MissingRepoOptionsError