|
@@ -1,276 +0,0 @@
|
|
-const axios = require('axios')
|
|
|
|
-const debug = require('debug')('joystream:discovery:discover')
|
|
|
|
-const stripEndingSlash = require('@joystream/storage-utils/stripEndingSlash')
|
|
|
|
-
|
|
|
|
-const BN = require('bn.js')
|
|
|
|
-const { newExternallyControlledPromise } = require('@joystream/storage-utils/externalPromise')
|
|
|
|
-
|
|
|
|
-/**
|
|
|
|
- * Determines if code is running in a browser by testing for the global window object.
|
|
|
|
- * @return {boolean} returns result check.
|
|
|
|
- */
|
|
|
|
-function inBrowser() {
|
|
|
|
- return typeof window !== 'undefined'
|
|
|
|
-}
|
|
|
|
-
|
|
|
|
-/**
|
|
|
|
- * After what period of time a cached record is considered stale, and would
|
|
|
|
- * trigger a re-discovery, but only if a query is made for the same provider.
|
|
|
|
- */
|
|
|
|
-const CACHE_TTL = 60 * 60 * 1000
|
|
|
|
-
|
|
|
|
-class DiscoveryClient {
|
|
|
|
- /**
|
|
|
|
- * Map storage-provider id to a Promise of a discovery result. The purpose
|
|
|
|
- * is to avoid concurrent active discoveries for the same provider.
|
|
|
|
- */
|
|
|
|
- activeDiscoveries = {}
|
|
|
|
-
|
|
|
|
- /**
|
|
|
|
- * Map of storage provider id to string
|
|
|
|
- * Cache of past discovery lookup results
|
|
|
|
- */
|
|
|
|
- accountInfoCache = {}
|
|
|
|
-
|
|
|
|
- /*
|
|
|
|
- * @param {RuntimeApi} api - api instance to query the chain
|
|
|
|
- * @param {string} ipfsHttpGatewayUrl - optional ipfs http gateway
|
|
|
|
- * @param {IpfsClient} ipfs - optinoal instance of an ipfs-http-client
|
|
|
|
- */
|
|
|
|
- constructor({ api, ipfs, ipfsHttpGatewayUrl }) {
|
|
|
|
- this.runtimeApi = api
|
|
|
|
- this.ipfs = ipfs
|
|
|
|
- this.ipfsHttpGatewayUrl = ipfsHttpGatewayUrl
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
- /**
|
|
|
|
- * Queries the ipns id (service key) of the storage provider from the blockchain.
|
|
|
|
- * If the storage provider is not registered it will return null.
|
|
|
|
- * @param {number | BN | u64} storageProviderId - the provider id to lookup
|
|
|
|
- * @returns { Promise<string | null> } - ipns multiformat address
|
|
|
|
- */
|
|
|
|
- async getIpnsIdentity(storageProviderId) {
|
|
|
|
- storageProviderId = new BN(storageProviderId)
|
|
|
|
- // lookup ipns identity from chain corresponding to storageProviderId
|
|
|
|
- const info = await this.runtimeApi.discovery.getAccountInfo(storageProviderId)
|
|
|
|
-
|
|
|
|
- if (info === null) {
|
|
|
|
- // no identity found on chain for account
|
|
|
|
- return null
|
|
|
|
- }
|
|
|
|
- return info.identity.toString()
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
- /**
|
|
|
|
- * Resolves provider id to its service information.
|
|
|
|
- * Will use an IPFS HTTP gateway. If caller doesn't provide a url the default gateway on
|
|
|
|
- * the local ipfs node will be used.
|
|
|
|
- * If the storage provider is not registered it will throw an error
|
|
|
|
- * @param {number | BN | u64} storageProviderId - the provider id to lookup
|
|
|
|
- * @param {string} ipfsHttpGatewayUrl - optional ipfs http gateway url to perform ipfs queries
|
|
|
|
- * @returns { Promise<object> } - the published service information
|
|
|
|
- */
|
|
|
|
- async discoverOverIpfsHttpGateway(storageProviderId, ipfsHttpGatewayUrl) {
|
|
|
|
- let gateway = ipfsHttpGatewayUrl || this.ipfsHttpGatewayUrl || 'http://localhost:8080'
|
|
|
|
- storageProviderId = new BN(storageProviderId)
|
|
|
|
- const isProvider = await this.runtimeApi.workers.isStorageProvider(storageProviderId)
|
|
|
|
-
|
|
|
|
- if (!isProvider) {
|
|
|
|
- throw new Error('Cannot discover non storage providers')
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
- const identity = await this.getIpnsIdentity(storageProviderId)
|
|
|
|
-
|
|
|
|
- if (identity === null) {
|
|
|
|
- // dont waste time trying to resolve if no identity was found
|
|
|
|
- throw new Error('no identity to resolve')
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
- gateway = stripEndingSlash(gateway)
|
|
|
|
-
|
|
|
|
- const url = `${gateway}/ipns/${identity}`
|
|
|
|
-
|
|
|
|
- const response = await axios.get(url)
|
|
|
|
-
|
|
|
|
- return response.data
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
- /**
|
|
|
|
- * Resolves id of provider to its service information.
|
|
|
|
- * Will use the provided colossus discovery api endpoint. If no api endpoint
|
|
|
|
- * is provided it attempts to use the configured endpoints from the chain.
|
|
|
|
- * If the storage provider is not registered it will throw an error
|
|
|
|
- * @param {number | BN | u64 } storageProviderId - provider id to lookup
|
|
|
|
- * @param {string} discoverApiEndpoint - url for a colossus discovery api endpoint
|
|
|
|
- * @returns { Promise<object> } - the published service information
|
|
|
|
- */
|
|
|
|
- async discoverOverJoystreamDiscoveryService(storageProviderId, discoverApiEndpoint) {
|
|
|
|
- storageProviderId = new BN(storageProviderId)
|
|
|
|
- const isProvider = await this.runtimeApi.workers.isStorageProvider(storageProviderId)
|
|
|
|
-
|
|
|
|
- if (!isProvider) {
|
|
|
|
- throw new Error('Cannot discover non storage providers')
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
- const identity = await this.getIpnsIdentity(storageProviderId)
|
|
|
|
-
|
|
|
|
- // dont waste time trying to resolve if no identity was found
|
|
|
|
- if (identity === null) {
|
|
|
|
- throw new Error('no identity to resolve')
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
- if (!discoverApiEndpoint) {
|
|
|
|
- // Use bootstrap nodes
|
|
|
|
- const discoveryBootstrapNodes = await this.runtimeApi.discovery.getBootstrapEndpoints()
|
|
|
|
-
|
|
|
|
- if (discoveryBootstrapNodes.length) {
|
|
|
|
- discoverApiEndpoint = stripEndingSlash(discoveryBootstrapNodes[0].toString())
|
|
|
|
- } else {
|
|
|
|
- throw new Error('No known discovery bootstrap nodes found on network')
|
|
|
|
- }
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
- const url = `${discoverApiEndpoint}/discover/v0/${storageProviderId.toNumber()}`
|
|
|
|
-
|
|
|
|
- // should have parsed if data was json?
|
|
|
|
- const response = await axios.get(url)
|
|
|
|
-
|
|
|
|
- return response.data
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
- /**
|
|
|
|
- * Resolves id of provider to its service information.
|
|
|
|
- * Will use the local IPFS node over RPC interface.
|
|
|
|
- * If the storage provider is not registered it will throw an error.
|
|
|
|
- * @param {number | BN | u64 } storageProviderId - provider id to lookup
|
|
|
|
- * @returns { Promise<object> } - the published service information
|
|
|
|
- */
|
|
|
|
- async discoverOverLocalIpfsNode(storageProviderId) {
|
|
|
|
- storageProviderId = new BN(storageProviderId)
|
|
|
|
- const isProvider = await this.runtimeApi.workers.isStorageProvider(storageProviderId)
|
|
|
|
-
|
|
|
|
- if (!isProvider) {
|
|
|
|
- throw new Error('Cannot discover non storage providers')
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
- const identity = await this.getIpnsIdentity(storageProviderId)
|
|
|
|
-
|
|
|
|
- if (identity === null) {
|
|
|
|
- // dont waste time trying to resolve if no identity was found
|
|
|
|
- throw new Error('no identity to resolve')
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
- const ipnsAddress = `/ipns/${identity}/`
|
|
|
|
-
|
|
|
|
- debug('resolved ipns to ipfs object')
|
|
|
|
- // Can this call hang forever!? can/should we set a timeout?
|
|
|
|
- const ipfsName = await this.ipfs.name.resolve(ipnsAddress, {
|
|
|
|
- // don't recurse, there should only be one indirection to the service info file
|
|
|
|
- recursive: false,
|
|
|
|
- nocache: false,
|
|
|
|
- })
|
|
|
|
-
|
|
|
|
- debug('getting ipfs object', ipfsName)
|
|
|
|
- const data = await this.ipfs.get(ipfsName) // this can sometimes hang forever!?! can we set a timeout?
|
|
|
|
-
|
|
|
|
- // there should only be one file published under the resolved path
|
|
|
|
- const content = data[0].content
|
|
|
|
-
|
|
|
|
- return JSON.parse(content)
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
- /**
|
|
|
|
- * Internal method that handles concurrent discoveries and caching of results. Will
|
|
|
|
- * select the appropriate discovery protocol based on browser environment or not,
|
|
|
|
- * and if an ipfs client was passed in the constructor.
|
|
|
|
- * @param {number | BN | u64} storageProviderId - ID of the storage provider
|
|
|
|
- * @returns { Promise<object | null> } - the published service information
|
|
|
|
- */
|
|
|
|
- async _discover(storageProviderId) {
|
|
|
|
- storageProviderId = new BN(storageProviderId)
|
|
|
|
- const id = storageProviderId.toNumber()
|
|
|
|
-
|
|
|
|
- const discoveryResult = this.activeDiscoveries[id]
|
|
|
|
- if (discoveryResult) {
|
|
|
|
- debug('discovery in progress waiting for result for', id)
|
|
|
|
- return discoveryResult
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
- debug('starting new discovery for', id)
|
|
|
|
- const deferredDiscovery = newExternallyControlledPromise()
|
|
|
|
- this.activeDiscoveries[id] = deferredDiscovery.promise
|
|
|
|
-
|
|
|
|
- let result
|
|
|
|
- try {
|
|
|
|
- if (inBrowser() || !this.ipfs) {
|
|
|
|
- result = await this.discoverOverJoystreamDiscoveryService(storageProviderId)
|
|
|
|
- } else {
|
|
|
|
- result = await this.discoverOverLocalIpfsNode(storageProviderId)
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
- debug(result)
|
|
|
|
- result = JSON.stringify(result)
|
|
|
|
- this.accountInfoCache[id] = {
|
|
|
|
- value: result,
|
|
|
|
- updated: Date.now(),
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
- deferredDiscovery.resolve(result)
|
|
|
|
- delete this.activeDiscoveries[id]
|
|
|
|
- return result
|
|
|
|
- } catch (err) {
|
|
|
|
- // we catch the error so we can update all callers
|
|
|
|
- // and throw again to inform the first caller.
|
|
|
|
- debug(err.message)
|
|
|
|
- delete this.activeDiscoveries[id]
|
|
|
|
- // deferredDiscovery.reject(err)
|
|
|
|
- deferredDiscovery.resolve(null) // resolve to null until we figure out the issue below
|
|
|
|
- // throw err // <-- throwing but this isn't being
|
|
|
|
- // caught correctly in express server! Is it because there is an uncaught promise somewhere
|
|
|
|
- // in the prior .reject() call ?
|
|
|
|
- // I've only seen this behaviour when error is from ipfs-client
|
|
|
|
- // ... is this unique to errors thrown from ipfs-client?
|
|
|
|
- // Problem is its crashing the node so just return null for now
|
|
|
|
- return null
|
|
|
|
- }
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
- /**
|
|
|
|
- * Cached discovery of storage provider service information. If useCachedValue is
|
|
|
|
- * set to true, will always return the cached result if found. New discovery will be triggered
|
|
|
|
- * if record is found to be stale. If a stale record is not desired (CACHE_TTL old) pass a non zero
|
|
|
|
- * value for maxCacheAge, which will force a new discovery and return the new resolved value.
|
|
|
|
- * This method in turn calls _discovery which handles concurrent discoveries and selects the appropriate
|
|
|
|
- * protocol to perform the query.
|
|
|
|
- * If the storage provider is not registered it will resolve to null
|
|
|
|
- * @param {number | BN | u64} storageProviderId - provider to discover
|
|
|
|
- * @param {bool} useCachedValue - optionaly use chached queries
|
|
|
|
- * @param {number} maxCacheAge - maximum age of a cached query that triggers automatic re-discovery
|
|
|
|
- * @returns { Promise<object | null> } - the published service information
|
|
|
|
- */
|
|
|
|
- async discover(storageProviderId, useCachedValue = false, maxCacheAge = 0) {
|
|
|
|
- storageProviderId = new BN(storageProviderId)
|
|
|
|
- const id = storageProviderId.toNumber()
|
|
|
|
- const cached = this.accountInfoCache[id]
|
|
|
|
-
|
|
|
|
- if (cached && useCachedValue) {
|
|
|
|
- if (maxCacheAge > 0) {
|
|
|
|
- // get latest value
|
|
|
|
- if (Date.now() > cached.updated + maxCacheAge) {
|
|
|
|
- return this._discover(storageProviderId)
|
|
|
|
- }
|
|
|
|
- }
|
|
|
|
- // refresh if cache if stale, new value returned on next cached query
|
|
|
|
- if (Date.now() > cached.updated + CACHE_TTL) {
|
|
|
|
- this._discover(storageProviderId)
|
|
|
|
- }
|
|
|
|
- // return best known value
|
|
|
|
- return cached.value
|
|
|
|
- }
|
|
|
|
- return this._discover(storageProviderId)
|
|
|
|
- }
|
|
|
|
-}
|
|
|
|
-
|
|
|
|
-module.exports = {
|
|
|
|
- DiscoveryClient,
|
|
|
|
-}
|
|
|