Merge pull request #170 from fluree/task/remove-deprecations

Remove deprecations & replace db with ledger everywhere appropriate

Author: cap10morgan

docs/fluree.db.api.html

@@ -157,7 +157,7 @@
 - :doc         - Optional doc string about this db.
 - :fork        - If forking an existing db, ref to db (actual identity, not db-ident). Must exist in network db.
 - :forkBlock   - If fork is provided, optionally provide the block to fork at. Defaults to latest known.
-- :persistResp - Respond immediately once persisted with the dbid, don't wait for transaction to be finished
+- :persistResp - Respond immediately once persisted with the ledger-id, don't wait for transaction to be finished
 </pre></div></div><div class="public anchor" id="var-new-ledger-async"><h3>new-ledger-async</h3><div class="usage"><code>(new-ledger-async conn ledger)</code><code>(new-ledger-async conn ledger opts)</code></div><div class="doc"><pre class="plaintext">Attempts to create new ledger with the given ledger name (ex. `fluree/example` or `:fluree/example`).
 
 A successful result will kick off a process on the ledger server(s) to bootstrap.
@@ -172,7 +172,7 @@
 - :doc         - Optional doc string about this db.
 - :fork        - If forking an existing db, ref to db (actual identity, not db-ident). Must exist in network db.
 - :forkBlock   - If fork is provided, optionally provide the block to fork at. Defaults to latest known.
-- :persistResp - Respond immediately once persisted with the dbid, don't wait for transaction to be finished
+- :persistResp - Respond immediately once persisted with the ledger-id, don't wait for transaction to be finished
 </pre></div></div><div class="public anchor" id="var-new-private-key"><h3>new-private-key</h3><h4 class="deprecated">deprecated</h4><div class="usage"><code>(new-private-key)</code></div><div class="doc"><pre class="plaintext">DEPRECATED: use fluree.db.api.auth/new-private-key instead.
 </pre></div></div><div class="public anchor" id="var-predicate-id"><h3>predicate-id</h3><div class="usage"><code>(predicate-id db predicate)</code></div><div class="doc"><pre class="plaintext">Returns promise containing predicate id given a predicate name, or predicate id.
 If predicate doesn't exist, returns nil.</pre></div></div><div class="public anchor" id="var-predicate-name"><h3>predicate-name</h3><div class="usage"><code>(predicate-name db predicate-name)</code></div><div class="doc"><pre class="plaintext">Returns promise containing predicate name given predicate id.
@@ -219,8 +219,8 @@
 - testnet/$testledger - look for a ledger with id testledger on network testnet (skip alias lookup).</pre></div></div><div class="public anchor" id="var-search"><h3>search</h3><div class="usage"><code>(search db flake-parts)</code></div><div class="doc"><pre class="plaintext">Returns a promise containing search results of flake parts (fparts).
 </pre></div></div><div class="public anchor" id="var-search-async"><h3>search-async</h3><div class="usage"><code>(search-async db flake-parts)</code></div><div class="doc"><pre class="plaintext">Performs a search for matching flakes, returns a core async promise channel.
 </pre></div></div><div class="public anchor" id="var-session"><h3>session</h3><div class="usage"><code>(session conn ledger)</code></div><div class="doc"><pre class="plaintext">Returns actual session object for a given ledger.
-</pre></div></div><div class="public anchor" id="var-set-default-key"><h3>set-default-key</h3><h4 class="deprecated">deprecated</h4><div class="usage"><code>(set-default-key conn private-key)</code><code>(set-default-key conn network private-key)</code><code>(set-default-key conn network dbid private-key)</code><code>(set-default-key conn network dbid private-key opts)</code></div><div class="doc"><pre class="plaintext">DEPRECATED: use fluree.db.api.auth/set-default-key instead.
-</pre></div></div><div class="public anchor" id="var-set-default-key-async"><h3>set-default-key-async</h3><h4 class="deprecated">deprecated</h4><div class="usage"><code>(set-default-key-async conn private-key)</code><code>(set-default-key-async conn network private-key)</code><code>(set-default-key-async conn network dbid private-key)</code><code>(set-default-key-async conn network dbid private-key opts)</code></div><div class="doc"><pre class="plaintext">DEPRECATED: use fluree.db.api.auth/set-default-key-async instead.
+</pre></div></div><div class="public anchor" id="var-set-default-key"><h3>set-default-key</h3><h4 class="deprecated">deprecated</h4><div class="usage"><code>(set-default-key conn private-key)</code><code>(set-default-key conn network private-key)</code><code>(set-default-key conn network ledger-id private-key)</code><code>(set-default-key conn network ledger-id private-key opts)</code></div><div class="doc"><pre class="plaintext">DEPRECATED: use fluree.db.api.auth/set-default-key instead.
+</pre></div></div><div class="public anchor" id="var-set-default-key-async"><h3>set-default-key-async</h3><h4 class="deprecated">deprecated</h4><div class="usage"><code>(set-default-key-async conn private-key)</code><code>(set-default-key-async conn network private-key)</code><code>(set-default-key-async conn network ledger-id private-key)</code><code>(set-default-key-async conn network ledger-id private-key opts)</code></div><div class="doc"><pre class="plaintext">DEPRECATED: use fluree.db.api.auth/set-default-key-async instead.
 </pre></div></div><div class="public anchor" id="var-sign"><h3>sign</h3><h4 class="deprecated">deprecated</h4><div class="usage"><code>(sign message private-key)</code></div><div class="doc"><pre class="plaintext">DEPRECATED: use fluree.db.api.auth/sign instead.
 </pre></div></div><div class="public anchor" id="var-sparql"><h3>sparql</h3><div class="usage"><code>(sparql db sparql-str)</code><code>(sparql db sparql-str opts)</code></div><div class="doc"><pre class="plaintext">Execute an sparql query against a specified database. Returns a promise of the query results.
 </pre></div></div><div class="public anchor" id="var-sparql-async"><h3>sparql-async</h3><div class="usage"><code>(sparql-async db sparql-str)</code><code>(sparql-async db sparql-str opts)</code></div><div class="doc"><pre class="plaintext">Exceute a sparql query against a specified database. Returns a core async channel,
@@ -261,7 +261,7 @@
 Note new ledgers are issued as a command, and auth/signature should have proper authority on ledger servers.
 {:type      new-ledger       - command type is required on all commands
  :ledger    testnet/myledger - ledger name - as network/ledger
- :fork      testnet/forkdb   - optional name of db to fork, if forking. Use testnet/$forkdb to peg to a dbid
+ :fork      testnet/forkdb   - optional name of db to fork, if forking. Use testnet/$forkdb to peg to a ledger-id
  :forkBlock 42               - if forking a db, optionally provides a block to fork at, else will default to current block
  :auth      ABC12345676      - only required if using an authority's signature
  :fuel      10000            - max fuel to spend, only required if enforcing fuel limits. tx will fail if auth doesn't have this much fuel avail. Will fail if all fuel is consumed. Unused fuel will not be debited.

js-packages/nodejs/package.json

@@ -5,7 +5,6 @@
   "name" : "@fluree/flureenjs",
   "preferGlobal" : false,
   "keywords" : [ "fluree", "nodejs" ],
-  "types" : "flureenjs.d.ts",
   "author" : "Fluree PBC (https://flur.ee)",
   "requires" : true,
   "version" : "2.0.0-alpha1",
@@ -21,4 +20,4 @@
     "utf-8-validate" : "^5.0.9",
     "@cljs-oss/module-deps" : "^1.1.1"
   }
-}
+}

src-cljs/flureedb.cljs

@@ -248,7 +248,7 @@
        - :doc         - Optional doc string about this db.
        - :fork        - If forking an existing db, ref to db (actual identity, not db-ident). Must exist in network db.
        - :forkBlock   - If fork is provided, optionally provide the block to fork at. Defaults to latest known.
-       - :persistResp - Respond immediately once persisted with the dbid, don't wait for transaction to be finished
+       - :persistResp - Respond immediately once persisted with the ledger-id, don't wait for transaction to be finished
        - :jwt         - token for Fluree On-Demand access
        "
       ([conn ledger] (new-ledger conn ledger nil))

src-nodejs/flureenjs.cljs

@@ -377,7 +377,7 @@
                                        ["_auth/id" (-> (conn-handler/validate-token conn jwt)
                                                        :sub)]))
                       perm-db (-> (<? (ledger/db conn ledger (assoc opts :auth auth')))
-                                  (assoc :conn conn :network network :dbid ledger-id))]
+                                  (assoc :conn conn :network network :ledger-id ledger-id))]
                      (async/put! pc perm-db))
                 (catch :default e
                   (log/error e)
@@ -566,7 +566,7 @@
        - :doc         - Optional doc string about this db.
        - :fork        - If forking an existing db, ref to db (actual identity, not db-ident). Must exist in network db.
        - :forkBlock   - If fork is provided, optionally provide the block to fork at. Defaults to latest known.
-       - :persistResp - Respond immediately once persisted with the dbid, don't wait for transaction to be finished
+       - :persistResp - Respond immediately once persisted with the ledger-id, don't wait for transaction to be finished
        "
       ([conn ledger] (newLedger conn ledger nil))
       ([conn ledger opts]

src/fluree/db/api.clj

@@ -72,19 +72,19 @@
   "DEPRECATED: use fluree.db.api.auth/set-default-key-async instead."
   ([conn private-key] (set-default-key-async conn nil nil private-key nil))
   ([conn network private-key] (set-default-key-async conn network nil private-key nil))
-  ([conn network dbid private-key] (set-default-key-async conn network dbid private-key nil))
-  ([conn network dbid private-key opts]
+  ([conn network ledger-id private-key] (set-default-key-async conn network ledger-id private-key nil))
+  ([conn network ledger-id private-key opts]
    (log/warn "set-default-key-async DEPRECATED - use fluree.db.api.auth/set-default-key-async instead")
-   (auth-api/set-default-key-async conn network dbid private-key opts)))
+   (auth-api/set-default-key-async conn network ledger-id private-key opts)))
 
 (defn ^:deprecated set-default-key
   "DEPRECATED: use fluree.db.api.auth/set-default-key instead."
   ([conn private-key] (set-default-key-async conn nil nil private-key nil))
   ([conn network private-key] (set-default-key-async conn network nil private-key nil))
-  ([conn network dbid private-key] (set-default-key-async conn network dbid private-key nil))
-  ([conn network dbid private-key opts]
+  ([conn network ledger-id private-key] (set-default-key-async conn network ledger-id private-key nil))
+  ([conn network ledger-id private-key opts]
    (log/warn "set-default-key DEPRECATED - use fluree.db.api.auth/set-default-key instead")
-   (auth-api/set-default-key conn network dbid private-key opts)))
+   (auth-api/set-default-key conn network ledger-id private-key opts)))
 
 (defn account-id
   "INTERNAL USE ONLY
@@ -226,7 +226,7 @@
   Note new ledgers are issued as a command, and auth/signature should have proper authority on ledger servers.
   {:type      new-ledger       - command type is required on all commands
    :ledger    testnet/myledger - ledger name - as network/ledger
-   :fork      testnet/forkdb   - optional name of db to fork, if forking. Use testnet/$forkdb to peg to a dbid
+   :fork      testnet/forkdb   - optional name of db to fork, if forking. Use testnet/$forkdb to peg to a ledger-id
    :forkBlock 42               - if forking a db, optionally provides a block to fork at, else will default to current block
    :auth      ABC12345676      - only required if using an authority's signature
    :fuel      10000            - max fuel to spend, only required if enforcing fuel limits. tx will fail if auth doesn't have this much fuel avail. Will fail if all fuel is consumed. Unused fuel will not be debited.
@@ -256,7 +256,7 @@
   - :doc         - Optional doc string about this db.
   - :fork        - If forking an existing db, ref to db (actual identity, not db-ident). Must exist in network db.
   - :forkBlock   - If fork is provided, optionally provide the block to fork at. Defaults to latest known.
-  - :persistResp - Respond immediately once persisted with the dbid, don't wait for transaction to be finished
+  - :persistResp - Respond immediately once persisted with the ledger-id, don't wait for transaction to be finished
   "
   ([conn ledger] (new-ledger-async conn ledger nil))
   ([conn ledger opts]
@@ -316,7 +316,7 @@
   - :doc         - Optional doc string about this db.
   - :fork        - If forking an existing db, ref to db (actual identity, not db-ident). Must exist in network db.
   - :forkBlock   - If fork is provided, optionally provide the block to fork at. Defaults to latest known.
-  - :persistResp - Respond immediately once persisted with the dbid, don't wait for transaction to be finished
+  - :persistResp - Respond immediately once persisted with the ledger-id, don't wait for transaction to be finished
   "
   ([conn ledger] (new-ledger conn ledger nil))
   ([conn ledger opts]
@@ -634,7 +634,7 @@
           auth-id   (:auth opts)
           db-chan   (->
                       (<? (db conn ledger {:auth (when auth-id ["_auth/id" auth-id])}))
-                      (assoc :conn conn :network network :dbid ledger-id))
+                      (assoc :conn conn :network network :ledger-id ledger-id))
           db-blocks (<? (query-block/block-range db-chan start end opts))
           result    (query-range/block-with-tx-data db-blocks)]
       result)))

src/fluree/db/api/ledger.cljc

@@ -100,19 +100,19 @@
 
   resp-port is the async port on which any successful response will be placed."
   [db syncTo listen-id resp-port]
-  (let [{:keys [conn network dbid]} db
+  (let [{:keys [conn network ledger-id]} db
         newer-block? (fn [block] (>= block syncTo))
         event-fn     (fn [evt data]
                        (when (and (= :local-ledger-update evt) (newer-block? (:block data)))
-                         (conn/remove-listener conn network dbid listen-id)
+                         (conn/remove-listener conn network ledger-id listen-id)
                          (async/go                          ;; note: avoided async/pipe as I don't believe promise-chan from session/db technically 'closes'
-                           (async/put! resp-port (async/<! (session/db conn (str network "/" dbid) nil))))))]
+                           (async/put! resp-port (async/<! (session/db conn (str network "/" ledger-id) nil))))))]
 
     ;; listener will monitor all blocks, add updated db to resp-port once > syncTo, and close listener
-    (conn/add-listener conn network dbid listen-id event-fn)
+    (conn/add-listener conn network ledger-id listen-id event-fn)
     ;; a preemptive check if newer version of db already exists (db passed in could be old)
     (async/go
-      (let [latest-db (async/<! (session/db conn (str network "/" dbid) nil))] ;; possible while setting up listener the block has come through, check again
+      (let [latest-db (async/<! (session/db conn (str network "/" ledger-id) nil))] ;; possible while setting up listener the block has come through, check again
         (when (newer-block? (:block latest-db))
           (async/put! resp-port latest-db))))))
 
@@ -121,7 +121,7 @@
   [db syncTo syncTimeout]
   (assert (pos-int? syncTo) (str "syncTo must be a block number (positive integer), provided: " syncTo))
   (let [pc        (async/promise-chan)                      ;; final response channel - has db or timeout error
-        {:keys [conn network dbid]} db
+        {:keys [conn network ledger-id]} db
         listen-id (random-uuid)
         timeout   (if (pos-int? syncTimeout)
                     (min syncTimeout 120000)                ;; max 2 minutes
@@ -139,7 +139,7 @@
           (let [timeout-ch (async/timeout timeout)
                 updated-db (async/alt! timeout-ch :timeout
                                        res-port ([db] db))]
-            (conn/remove-listener conn network dbid listen-id) ;; close listener to clean up
+            (conn/remove-listener conn network ledger-id listen-id) ;; close listener to clean up
             (if (= :timeout updated-db)
               (async/put! pc (ex-info (str "Timeout waiting for block: " syncTo)
                                       {:status 400 :error :db/timeout}))

src/fluree/db/api/query.cljc

@@ -66,8 +66,8 @@
 
 
 (defn- isolate-ledger-id
-  [dbid]
-  (re-find #"[a-z0-9]+/[a-z0-9]+" dbid))
+  [ledger-id]
+  (re-find #"[a-z0-9]+/[a-z0-9]+" ledger-id))
 
 
 (defn db
@@ -494,6 +494,6 @@
       :standard (query-async source flureeQL)
       :history (history-query-async source flureeQL)
       :block (let [conn   (:conn source)
-                   ledger (keyword (:network source) (:dbid source))]
+                   ledger (keyword (:network source) (:ledger-id source))]
                (block-query-async conn ledger flureeQL))
       :multi (multi-query-async source flureeQL))))

src/fluree/db/api_js.cljs

@@ -37,7 +37,7 @@
               _       (conn-handler/check-connection conn opts)
               [network ledger-id] (session/resolve-ledger conn ledger)
               root-db (-> (<? (session/db conn ledger opts))
-                          (assoc :conn conn :network network :dbid ledger-id))
+                          (assoc :conn conn :network network :ledger-id ledger-id))
               dbt     (if block
                         (<? (time-travel/as-of-block root-db block))
                         root-db)]
@@ -54,8 +54,8 @@
   (= (-> source (str/split #"/") count) 2))
 
 (defn- isolate-ledger-id
-  [dbid]
-  (re-find #"[a-z0-9]+/[a-z0-9]+" dbid))
+  [ledger-id]
+  (re-find #"[a-z0-9]+/[a-z0-9]+" ledger-id))
 
 (defn- get-sources
   "Validates & returns the query sources.