Merge pull request #265 from bitfinexcom/beta

Release version to master

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bfx-reports-framework",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "description": "Bitfinex reports framework",
   "main": "worker.js",
   "license": "Apache-2.0",

test/helpers/helpers.mock-rest-v2.js

@@ -47,17 +47,27 @@ const getMockDataOpts = () => ({
   ...getBaseMockDataOpts(),
   candles: { limit: 500 },
   generate_token: null,
-  delete_token: null
+  delete_token: null,
+  login: null,
+  login_verify: null
 })
 
+const getExtraMockMethods = () => (new Map([
+  ['post', {
+    '/v2/login': 'login',
+    '/v2/login/verify': 'login_verify'
+  }]
+]))
+
 const createMockRESTv2SrvWithDate = (
   start = Date.now(),
   end = start,
   limit = null,
   opts = getMockDataOpts(),
   {
     _getMockData = getMockData,
-    _setDataTo = setDataTo
+    _setDataTo = setDataTo,
+    extraMockMethods = getExtraMockMethods()
   } = {}
 ) => {
   return _createMockRESTv2SrvWithDate(
@@ -67,7 +77,8 @@ const createMockRESTv2SrvWithDate = (
     opts,
     {
       _getMockData,
-      _setDataTo
+      _setDataTo,
+      extraMockMethods
     }
   )
 }

test/helpers/mock-data.js

@@ -6,6 +6,25 @@ const _ms = Date.now()
 
 module.exports = new Map([
   ...mockData,
+  [
+    'login',
+    [
+      '12345678-8888-4321-1234-8cb090a01360',
+      [
+        [
+          'otp',
+          true
+        ]
+      ]
+    ]
+  ],
+  [
+    'login_verify',
+    [
+      'pub:api:88888888-4444-4444-4444-121212121212-caps:s:o:f:w:wd:a-write',
+      '2023-03-21T12:00:00.000Z'
+    ]
+  ],
   [
     'generate_token',
     ['pub:api:88888888-4444-4444-4444-121212121212-caps:s:o:f:w:wd:a-write']

test/test-cases/api-sync-mode-sqlite-test-cases.js

@@ -83,6 +83,58 @@ module.exports = (
     assert.isOk(res.body.result)
   })
 
+  it('it should be successfully performed by the loginToBFX method', async function () {
+    this.timeout(5000)
+
+    const res = await agent
+      .post(`${basePath}/json-rpc`)
+      .type('json')
+      .send({
+        auth: {
+          login: 'user-name',
+          password: 'user-pwd'
+        },
+        method: 'loginToBFX',
+        id: 5
+      })
+      .expect('Content-Type', /json/)
+      .expect(200)
+
+    assert.isObject(res.body)
+    assert.propertyVal(res.body, 'id', 5)
+    assert.isArray(res.body.result)
+    assert.isString(res.body.result[0])
+    assert.isArray(res.body.result[1])
+    assert.isArray(res.body.result[1][0])
+    assert.isString(res.body.result[1][0][0])
+    assert.isBoolean(res.body.result[1][0][1])
+  })
+
+  it('it should be successfully performed by the verifyOnBFX method', async function () {
+    this.timeout(5000)
+
+    const res = await agent
+      .post(`${basePath}/json-rpc`)
+      .type('json')
+      .send({
+        auth: {
+          loginToken: '12345678-8888-4321-1234-8cb090a01360',
+          token: '123456',
+          verifyMethod: 'otp'
+        },
+        method: 'verifyOnBFX',
+        id: 5
+      })
+      .expect('Content-Type', /json/)
+      .expect(200)
+
+    assert.isObject(res.body)
+    assert.propertyVal(res.body, 'id', 5)
+    assert.isArray(res.body.result)
+    assert.isString(res.body.result[0])
+    assert.isString(res.body.result[1])
+  })
+
   it('it should be successfully performed by the signIn method', async function () {
     this.timeout(5000)
 
@@ -107,10 +159,35 @@ module.exports = (
     assert.strictEqual(res.body.result.email, email)
     assert.strictEqual(res.body.result.isSubAccount, isSubAccount)
     assert.isString(res.body.result.token)
+    assert.isBoolean(res.body.result.shouldNotSyncOnStartupAfterUpdate)
+    assert.isNotOk(res.body.result.shouldNotSyncOnStartupAfterUpdate)
 
     auth.token = res.body.result.token
   })
 
+  it('it should be successfully performed by the updateUser method', async function () {
+    this.timeout(5000)
+
+    const res = await agent
+      .post(`${basePath}/json-rpc`)
+      .type('json')
+      .send({
+        auth,
+        method: 'updateUser',
+        params: {
+          shouldNotSyncOnStartupAfterUpdate: true
+        },
+        id: 5
+      })
+      .expect('Content-Type', /json/)
+      .expect(200)
+
+    assert.isObject(res.body)
+    assert.propertyVal(res.body, 'id', 5)
+    assert.isBoolean(res.body.result)
+    assert.isOk(res.body.result)
+  })
+
   it('it should be successfully performed by the signIn method by token', async function () {
     this.timeout(5000)
 
@@ -131,6 +208,8 @@ module.exports = (
     assert.strictEqual(res.body.result.email, email)
     assert.strictEqual(res.body.result.isSubAccount, isSubAccount)
     assert.strictEqual(res.body.result.token, auth.token)
+    assert.isBoolean(res.body.result.shouldNotSyncOnStartupAfterUpdate)
+    assert.isOk(res.body.result.shouldNotSyncOnStartupAfterUpdate)
   })
 
   it('it should not be successfully performed by the signIn method', async function () {
@@ -328,6 +407,7 @@ module.exports = (
       assert.isString(user.email)
       assert.isBoolean(user.isSubAccount)
       assert.isBoolean(user.isNotProtected)
+      assert.isBoolean(user.isRestrictedToBeAddedToSubAccount)
       assert.isArray(user.subUsers)
 
       user.subUsers.forEach((subUser) => {

workers/loc.api/di/app.deps.js

@@ -115,6 +115,7 @@ const Crypto = require('../sync/crypto')
 const Authenticator = require('../sync/authenticator')
 const privResponder = require('../responder')
 const ProcessMessageManager = require('../process.message.manager')
+const HTTPRequest = require('../http.request')
 
 decorate(injectable(), EventEmitter)
 
@@ -157,7 +158,8 @@ module.exports = ({
           ['_dataConsistencyChecker', TYPES.DataConsistencyChecker],
           ['_winLossVSAccountBalance', TYPES.WinLossVSAccountBalance],
           ['_weightedAveragesReport', TYPES.WeightedAveragesReport],
-          ['_getDataFromApi', TYPES.GetDataFromApi]
+          ['_getDataFromApi', TYPES.GetDataFromApi],
+          ['_httpRequest', TYPES.HTTPRequest]
         ]
       })
     rebind(TYPES.RServiceDepsSchemaAliase)
@@ -197,6 +199,9 @@ module.exports = ({
     bind(TYPES.ProcessMessageManager)
       .to(ProcessMessageManager)
       .inSingletonScope()
+    bind(TYPES.HTTPRequest)
+      .to(HTTPRequest)
+      .inSingletonScope()
     bind(TYPES.WSTransport)
       .to(WSTransport)
       .inSingletonScope()

workers/loc.api/di/types.js

@@ -69,5 +69,6 @@ module.exports = {
   SyncUserStepData: Symbol.for('SyncUserStepData'),
   SyncUserStepDataFactory: Symbol.for('SyncUserStepDataFactory'),
   WeightedAveragesReport: Symbol.for('WeightedAveragesReport'),
-  WeightedAveragesReportCsvWriter: Symbol.for('WeightedAveragesReportCsvWriter')
+  WeightedAveragesReportCsvWriter: Symbol.for('WeightedAveragesReportCsvWriter'),
+  HTTPRequest: Symbol.for('HTTPRequest')
 }

workers/loc.api/errors/index.js

@@ -6,6 +6,9 @@ const {
   ConflictError,
   ArgsParamsError
 } = require('bfx-report/workers/loc.api/errors')
+const {
+  getErrorArgs
+} = require('bfx-report/workers/loc.api/errors/helpers')
 
 class CollSyncPermissionError extends BaseError {
   constructor (message = 'ERR_PERMISSION_DENIED_TO_SYNC_SELECTED_COLL') {
@@ -113,6 +116,14 @@ class SubAccountUpdatingError extends AuthError {
   }
 }
 
+class UserUpdatingError extends AuthError {
+  constructor (message = 'ERR_USER_UPDATE_HAS_BEEN_FAILED') {
+    super(message)
+
+    this.statusMessage = 'User update has been failed'
+  }
+}
+
 class UserRemovingError extends AuthError {
   constructor (message = 'ERR_USER_REMOVE_HAS_BEEN_FAILED') {
     super(message)
@@ -212,8 +223,10 @@ class SyncInfoUpdatingError extends BaseError {
 }
 
 class AuthTokenGenerationError extends AuthError {
-  constructor (message = 'ERR_AUTH_TOKEN_HAS_NOT_BEEN_GENERATED') {
-    super(message)
+  constructor (args) {
+    const _args = getErrorArgs(args, 'ERR_AUTH_TOKEN_HAS_NOT_BEEN_GENERATED')
+
+    super(_args)
   }
 }
 
@@ -235,6 +248,7 @@ module.exports = {
   MigrationLaunchingError,
   SubAccountCreatingError,
   SubAccountUpdatingError,
+  UserUpdatingError,
   UserRemovingError,
   UserWasPreviouslyStoredInDbError,
   SubAccountLedgersBalancesRecalcError,

workers/loc.api/http.request/helpers.js

@@ -0,0 +1,26 @@
+'use strict'
+
+const {
+  AuthError
+} = require('bfx-report/workers/loc.api/errors')
+
+const isAuthApiError = (err) => {
+  return /ERR_AUTH_API/.test(err.toString())
+}
+
+const makeRequestToBFX = async (requestFn) => {
+  try {
+    return await requestFn()
+  } catch (err) {
+    if (isAuthApiError(err)) {
+      throw new AuthError()
+    }
+
+    throw err
+  }
+}
+
+module.exports = {
+  isAuthApiError,
+  makeRequestToBFX
+}

workers/loc.api/http.request/index.js

@@ -0,0 +1,63 @@
+'use strict'
+
+const { RESTv2 } = require('bfx-api-node-rest')
+
+const {
+  makeRequestToBFX
+} = require('./helpers')
+
+const { decorateInjectable } = require('../di/utils')
+
+const depsTypes = (TYPES) => [
+  TYPES.CONF
+]
+class HTTPRequest {
+  constructor (
+    conf
+  ) {
+    this.conf = conf
+
+    this._TEST_REST_URL = 'http://localhost:9999'
+    this._isTestEnv = process.env.NODE_ENV === 'test'
+
+    this._transportCache = new Map()
+    this.getRequest() // Init default cache
+  }
+
+  getRequest (opts = {}) {
+    const key = JSON.stringify(opts)
+
+    const _opts = {
+      transform: true,
+      url: this._isTestEnv
+        ? this._TEST_REST_URL
+        : this.conf?.restUrl,
+      ...opts
+    }
+
+    if (this._transportCache.has(key)) {
+      return this._transportCache.get(key)
+    }
+
+    const rest = new ExpandedRESTv2(_opts)
+    this._transportCache.set(key, rest)
+
+    return rest
+  }
+}
+
+class ExpandedRESTv2 extends RESTv2 {
+  async login (body) {
+    return makeRequestToBFX(() => this
+      ._makePublicPostRequest('/login', body))
+  }
+
+  async verify (body) {
+    return makeRequestToBFX(() => this
+      ._makePublicPostRequest('/login/verify', body))
+  }
+}
+
+decorateInjectable(HTTPRequest, depsTypes)
+
+module.exports = HTTPRequest

workers/loc.api/process.message.manager/index.js

@@ -278,6 +278,28 @@ class ProcessMessageManager {
       { backupFilesMetadata }
     )
   }
+
+  async [PROCESS_STATES.REQUEST_UPDATE_USERS_SYNC_ON_STARTUP_REQUIRED_STATE] (err, state, data) {
+    if (err) {
+      this.logger.debug('[Users sync on startup required state has not been updated]')
+      this.logger.error(err)
+
+      this.sendState(
+        PROCESS_MESSAGES.RESPONSE_UPDATE_USERS_SYNC_ON_STARTUP_REQUIRED_STATE,
+        { err }
+      )
+
+      return
+    }
+
+    const isDone = await this.dao
+      .updateUsersSyncOnStartupRequiredState()
+
+    this.sendState(
+      PROCESS_MESSAGES.RESPONSE_UPDATE_USERS_SYNC_ON_STARTUP_REQUIRED_STATE,
+      { isDone }
+    )
+  }
 }
 
 decorateInjectable(ProcessMessageManager, depsTypes)

workers/loc.api/process.message.manager/process.messages.js

@@ -26,5 +26,7 @@ module.exports = {
   REQUEST_MIGRATION_HAS_FAILED_WHAT_SHOULD_BE_DONE: 'request:migration-has-failed:what-should-be-done',
   REQUEST_SHOULD_ALL_TABLES_BE_REMOVED: 'request:should-all-tables-be-removed',
 
-  RESPONSE_GET_BACKUP_FILES_METADATA: 'response:get-backup-files-metadata'
+  RESPONSE_GET_BACKUP_FILES_METADATA: 'response:get-backup-files-metadata',
+
+  RESPONSE_UPDATE_USERS_SYNC_ON_STARTUP_REQUIRED_STATE: 'response:update-users-sync-on-startup-required-state'
 }