WIP use module alias everywhere

app/controllers/agreements/agreements.controller.js

@@ -1,13 +1,13 @@
 const url = require('url')
 
 const agreementsService = require('./agreements.service')
-const transactionService = require('../../services/transaction.service')
-const { buildPaymentList } = require('../../utils/transaction-view')
-const formatFutureStrategyAccountPathsFor = require('../../utils/format-future-strategy-account-paths-for')
-const paths = require('../../paths')
+const transactionService = require('@services/transaction.service')
+const { buildPaymentList } = require('@utils/transaction-view')
+const formatFutureStrategyAccountPathsFor = require('@utils/format-future-strategy-account-paths-for')
+const paths = require('@root/paths')
 
-const { response } = require('../../utils/response')
-const { NotFoundError } = require('../../errors')
+const { response } = require('@utils/response')
+const { NotFoundError } = require('@root/errors')
 const { RESTClientError } = require('@govuk-pay/pay-js-commons/lib/utils/axios-base-client/errors')
 
 const LIMIT_NUMBER_OF_TRANSACTIONS_TO_SHOW = 5

app/controllers/agreements/agreements.controller.test.js

@@ -4,16 +4,16 @@ const sinon = require('sinon')
 const proxyquire = require('proxyquire')
 const { expect } = require('chai')
 
-const serviceFixtures = require('../../../test/fixtures/service.fixtures')
-const gatewayAccountFixtures = require('../../../test/fixtures/gateway-account.fixtures')
-const agreementFixtures = require('../../../test/fixtures/agreement.fixtures')
-const transactionFixtures = require('../../../test/fixtures/ledger-transaction.fixtures')
-const Service = require('../../models/Service.class')
-const { NotFoundError } = require('../../errors')
+const serviceFixtures = require('@test/fixtures/service.fixtures')
+const gatewayAccountFixtures = require('@test/fixtures/gateway-account.fixtures')
+const agreementFixtures = require('@test/fixtures/agreement.fixtures')
+const transactionFixtures = require('@test/fixtures/ledger-transaction.fixtures')
+const Service = require('@models/Service.class')
+const { NotFoundError } = require('@root/errors')
 const { RESTClientError } = require('@govuk-pay/pay-js-commons/lib/utils/axios-base-client/errors')
-const { buildPaymentList } = require('../../utils/transaction-view')
-const User = require('../../models/User.class')
-const userFixtures = require('../../../test/fixtures/user.fixtures')
+const { buildPaymentList } = require('@utils/transaction-view')
+const User = require('@models/User.class')
+const userFixtures = require('@test/fixtures/user.fixtures')
 
 const agreementsServiceSpy = {
   agreements: sinon.spy(() => Promise.resolve(agreements)),
@@ -259,7 +259,7 @@ function getControllerWithMocks (
   transactionsServiceSpy) {
   return proxyquire('./agreements.controller', {
     './agreements.service': agreementsServiceSpy,
-    '../../utils/response': responseSpy,
-    '../../services/transaction.service': transactionsServiceSpy
+    '@utils/response': responseSpy,
+    '@services/transaction.service': transactionsServiceSpy
   })
 }

app/controllers/agreements/agreements.service.js

@@ -1,6 +1,6 @@
-const Ledger = require('../../services/clients/ledger.client')
-const { ConnectorClient } = require('../../services/clients/connector.client')
-const Paginator = require('../../utils/paginator')
+const Ledger = require('@services/clients/ledger.client')
+const { ConnectorClient } = require('@services/clients/connector.client')
+const Paginator = require('@utils/paginator')
 const { CONNECTOR_URL } = process.env
 
 const connectorClient = new ConnectorClient(CONNECTOR_URL)

app/controllers/agreements/agreements.service.test.js

@@ -3,7 +3,7 @@ const sinon = require('sinon')
 
 const proxyquire = require('proxyquire')
 
-const agreementsFixture = require('../../../test/fixtures/agreement.fixtures')
+const agreementsFixture = require('@test/fixtures/agreement.fixtures')
 
 describe('agreements service', () => {
   describe('list agreements', () => {
@@ -90,7 +90,7 @@ describe('agreements service', () => {
 
 function getAgreementsService (ledgerClientStub = {}, connectorClientStub = {}) {
   return proxyquire('./agreements.service.js', {
-    './../../services/clients/ledger.client': ledgerClientStub,
-    './../../services/clients/connector.client': connectorClientStub
+    '@services/clients/ledger.client': ledgerClientStub,
+    '@services/clients/connector.client': connectorClientStub
   })
 }

app/controllers/all-service-transactions/all-service-transactions-no-autosearch.controller.js

@@ -1,9 +1,9 @@
 'use strict'
 
-const { response } = require('../../utils/response')
+const { response } = require('@utils/response')
 const { populateModel } = require('./populateModel')
-const { getFilters } = require('../../utils/filters')
-const permissions = require('../../utils/permissions')
+const { getFilters } = require('@utils/filters')
+const permissions = require('@utils/permissions')
 
 module.exports = async function getTransactionsForAllServicesNoSearch (req, res, next) {
   const filters = getFilters(req)

app/controllers/all-service-transactions/all-service-transactions-no-autosearch.controller.test.js

@@ -1,10 +1,10 @@
 const sinon = require('sinon')
 const proxyquire = require('proxyquire')
-const User = require('../../models/User.class')
-const userFixtures = require('../../../test/fixtures/user.fixtures')
-const gatewayAccountFixture = require('../../../test/fixtures/gateway-account.fixtures')
-const Service = require('../../models/Service.class')
-const serviceFixtures = require('../../../test/fixtures/service.fixtures')
+const User = require('@models/User.class')
+const userFixtures = require('@test/fixtures/user.fixtures')
+const gatewayAccountFixture = require('@test/fixtures/gateway-account.fixtures')
+const Service = require('@models/Service.class')
+const serviceFixtures = require('@test/fixtures/service.fixtures')
 
 describe('All service transactions no autosearch - GET', () => {
   let req, res, next
@@ -60,16 +60,16 @@ describe('All service transactions no autosearch - GET', () => {
 
   function getController () {
     return proxyquire('./all-service-transactions-no-autosearch.controller', {
-      '../../utils/permissions': {
+      '@utils/permissions': {
         getGatewayAccountsFor: sinon.spy(() => Promise.resolve(userPermittedAccountsSummary))
       },
       './populateModel': {
         populateModel: modelMock
       },
-      '../../utils/response': {
+      '@utils/response': {
         response: responseMock
       },
-      '../../utils/filters.js': {
+      '@utils/filters': {
         getFilters: filterMock
       }
     })

app/controllers/all-service-transactions/download-transactions.controller.js

@@ -1,10 +1,10 @@
 'use strict'
 
-const date = require('../../utils/dates')
-const transactionService = require('../../services/transaction.service')
-const Stream = require('../../services/clients/stream.client')
-const permissions = require('../../utils/permissions')
-const { NoServicesWithPermissionError } = require('../../errors')
+const date = require('@utils/dates')
+const transactionService = require('@services/transaction.service')
+const Stream = require('@services/clients/stream.client')
+const permissions = require('@utils/permissions')
+const { NoServicesWithPermissionError } = require('@root/errors')
 
 module.exports = async function dowmloadTransactions (req, res, next) {
   const filters = req.query

app/controllers/all-service-transactions/get.controller.js

@@ -2,14 +2,14 @@
 
 const url = require('url')
 
-const { response } = require('../../utils/response')
-const transactionService = require('../../services/transaction.service')
-const permissions = require('../../utils/permissions')
-const { getFilters } = require('../../utils/filters.js')
-const paths = require('../../paths')
-
-const logger = require('../../utils/logger')(__filename)
-const { NoServicesWithPermissionError } = require('../../errors')
+const { response } = require('@utils/response')
+const transactionService = require('@services/transaction.service')
+const permissions = require('@utils/permissions')
+const { getFilters } = require('@utils/filters.js')
+const paths = require('@root/paths')
+
+const logger = require('@utils/logger')(__filename)
+const { NoServicesWithPermissionError } = require('@root/errors')
 const { populateModel } = require('./populateModel.js')
 
 module.exports = async function getTransactionsForAllServices (req, res, next) {

app/controllers/all-service-transactions/get.controller.test.js

@@ -1,11 +1,11 @@
 const sinon = require('sinon')
 const proxyquire = require('proxyquire')
-const User = require('../../models/User.class')
-const userFixtures = require('../../../test/fixtures/user.fixtures')
-const gatewayAccountFixture = require('../../../test/fixtures/gateway-account.fixtures')
-const Service = require('../../models/Service.class')
-const serviceFixtures = require('../../../test/fixtures/service.fixtures')
-const ledgerTransactionFixture = require('../../../test/fixtures/ledger-transaction.fixtures')
+const User = require('@models/User.class')
+const userFixtures = require('@test/fixtures/user.fixtures')
+const gatewayAccountFixture = require('@test/fixtures/gateway-account.fixtures')
+const Service = require('@models/Service.class')
+const serviceFixtures = require('@test/fixtures/service.fixtures')
+const ledgerTransactionFixture = require('@test/fixtures/ledger-transaction.fixtures')
 
 describe('All service transactions - GET', () => {
   let req, res, next
@@ -62,23 +62,23 @@ describe('All service transactions - GET', () => {
 
   function getController () {
     return proxyquire('./get.controller', {
-      '../../utils/permissions': {
+      '@utils/permissions': {
         getGatewayAccountsFor: sinon.spy(() => Promise.resolve(userPermittedAccountsSummary))
       },
-      '../../services/transaction.service': {
+      '@services/transaction.service': {
         search: sinon.spy(() => Promise.resolve(transactionSearchResponse))
       },
       './populateModel': {
         populateModel: modelMock
       },
-      '../../utils/response': {
+      '@utils/response': {
         response: responseMock
       },
-      '../../paths': {
+      '@root/paths': {
         allServiceTransactions: { download: 'download-path' },
         formattedPathFor: () => 'formatted-path'
       },
-      '../../utils/filters.js': {
+      '@utils/filters.js': {
         getFilters: filterMock
       }
     })

app/controllers/all-service-transactions/populateModel.js

@@ -1,9 +1,9 @@
-const { buildPaymentList } = require('../../utils/transaction-view')
-const paths = require('../../paths')
-const { describeFilters } = require('../../utils/filters')
-const states = require('../../utils/states')
+const { buildPaymentList } = require('@utils/transaction-view')
+const paths = require('@root/paths')
+const { describeFilters } = require('@utils/filters')
+const states = require('@utils/states')
 const _ = require('lodash')
-const { ConnectorClient } = require('../../services/clients/connector.client')
+const { ConnectorClient } = require('@services/clients/connector.client')
 const client = new ConnectorClient(process.env.CONNECTOR_URL)
 
 async function populateModel (req, searchResultOutput, filters, downloadRoute, filterLiveAccounts, userPermittedAccountsSummary) {

app/controllers/all-service-transactions/populateModel.test.js

@@ -1,11 +1,11 @@
 const sinon = require('sinon')
 const proxyquire = require('proxyquire')
-const User = require('../../models/User.class')
-const userFixtures = require('../../../test/fixtures/user.fixtures')
-const gatewayAccountFixture = require('../../../test/fixtures/gateway-account.fixtures')
-const Service = require('../../models/Service.class')
-const serviceFixtures = require('../../../test/fixtures/service.fixtures')
-const { getFilters } = require('../../utils/filters.js')
+const User = require('@models/User.class')
+const userFixtures = require('@test/fixtures/user.fixtures')
+const gatewayAccountFixture = require('@test/fixtures/gateway-account.fixtures')
+const Service = require('@models/Service.class')
+const serviceFixtures = require('@test/fixtures/service.fixtures')
+const { getFilters } = require('@utils/filters.js')
 const { expect } = require('chai')
 
 describe('Populate Model', () => {
@@ -98,10 +98,10 @@ describe('Populate Model', () => {
 
   function populateModel () {
     return proxyquire('./populateModel', {
-      '../../services/clients/connector.client.js': {
+      '@services/clients/connector.client': {
         ConnectorClient: class {async getAllCardTypes () { return {} }}
       },
-      '../../utils/states': {
+      '@utils/states': {
         allDisplayStateSelectorObjects: allDisplayStateSelectorObjectsMock
       }
     }).populateModel

app/controllers/api-keys/get-create.controller.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { response } = require('../../utils/response.js')
+const { response } = require('@utils/response.js')
 
 module.exports = function showCreateApiKey (req, res) {
   const accountId = req.account.gateway_account_id

app/controllers/api-keys/get-index.controller.it.test.js

@@ -3,7 +3,7 @@
 const nock = require('nock')
 const sinon = require('sinon')
 
-const gatewayAccountFixtures = require('../../../test/fixtures/gateway-account.fixtures')
+const gatewayAccountFixtures = require('@test/fixtures/gateway-account.fixtures')
 const controller = require('./get-index.controller')
 
 const { PUBLIC_AUTH_URL } = process.env

app/controllers/api-keys/get-index.controller.js

@@ -1,7 +1,7 @@
 'use strict'
 
-const { response } = require('../../utils/response.js')
-const publicAuthClient = require('../../services/clients/public-auth.client')
+const { response } = require('@utils/response.js')
+const publicAuthClient = require('@services/clients/public-auth.client')
 
 module.exports = async function listActiveApiKeys (req, res, next) {
   const accountId = req.account.gateway_account_id

app/controllers/api-keys/get-revoked.controller.it.test.js

@@ -3,7 +3,7 @@
 const nock = require('nock')
 const sinon = require('sinon')
 
-const gatewayAccountFixtures = require('../../../test/fixtures/gateway-account.fixtures')
+const gatewayAccountFixtures = require('@test/fixtures/gateway-account.fixtures')
 const controller = require('./get-revoked.controller')
 
 const { PUBLIC_AUTH_URL } = process.env

app/controllers/api-keys/get-revoked.controller.js

@@ -1,7 +1,7 @@
 'use strict'
 
-const { response } = require('../../utils/response.js')
-const publicAuthClient = require('../../services/clients/public-auth.client')
+const { response } = require('@utils/response.js')
+const publicAuthClient = require('@services/clients/public-auth.client')
 
 module.exports = async function listRevokedApiKeys (req, res, next) {
   const accountId = req.account.gateway_account_id

app/controllers/api-keys/post-create.controller.js

@@ -1,7 +1,7 @@
 'use strict'
 
-const { response } = require('../../utils/response.js')
-const publicAuthClient = require('../../services/clients/public-auth.client')
+const { response } = require('@utils/response.js')
+const publicAuthClient = require('@services/clients/public-auth.client')
 
 module.exports = async function createApiKey (req, res, next) {
   const accountId = req.account.gateway_account_id

app/controllers/api-keys/post-revoke.controller.js

@@ -1,9 +1,9 @@
 'use strict'
 
-const paths = require('../../paths')
-const publicAuthClient = require('../../services/clients/public-auth.client')
-const logger = require('../../utils/logger')(__filename)
-const formatAccountPathsFor = require('../../utils/format-account-paths-for')
+const paths = require('@root/paths')
+const publicAuthClient = require('@services/clients/public-auth.client')
+const logger = require('@utils/logger')(__filename)
+const formatAccountPathsFor = require('@utils/format-account-paths-for')
 
 module.exports = async function revokeApiKey (req, res) {
   const apiKeysPath = formatAccountPathsFor(paths.account.apiKeys.index, req.account.external_id)

app/controllers/api-keys/post-update.controller.js

@@ -1,9 +1,9 @@
 'use strict'
 
-const paths = require('../../paths')
-const publicAuthClient = require('../../services/clients/public-auth.client')
-const logger = require('../../utils/logger')(__filename)
-const formatAccountPathsFor = require('../../utils/format-account-paths-for')
+const paths = require('@root/paths')
+const publicAuthClient = require('@services/clients/public-auth.client')
+const logger = require('@utils/logger')(__filename)
+const formatAccountPathsFor = require('@utils/format-account-paths-for')
 
 module.exports = async function updateApiKey (req, res) {
   const apiKeysPath = formatAccountPathsFor(paths.account.apiKeys.index, req.account.external_id)

app/controllers/billing-address/toggle-billing-address.controller.js

@@ -2,11 +2,11 @@
 
 const lodash = require('lodash')
 
-const logger = require('../../utils/logger')(__filename)
-const { response } = require('../../utils/response')
-const paths = require('../../paths')
-const formatAccountPathsFor = require('../../utils/format-account-paths-for')
-const serviceService = require('../../services/service.service')
+const logger = require('@utils/logger')(__filename)
+const { response } = require('@utils/response')
+const paths = require('@root/paths')
+const formatAccountPathsFor = require('@utils/format-account-paths-for')
+const serviceService = require('@services/service.service')
 
 function getIndex (req, res) {
   const model = {

app/controllers/create-service/create-service.controller.js

@@ -2,11 +2,11 @@
 
 const _ = require('lodash')
 
-const { response } = require('../../utils/response')
-const paths = require('../../paths')
-const serviceService = require('../../services/service.service')
-const userService = require('../../services/user.service')
-const formatAccountPathsFor = require('../../utils/format-account-paths-for')
+const { response } = require('@utils/response')
+const paths = require('@root/paths')
+const serviceService = require('@services/service.service')
+const userService = require('@services/user.service')
+const formatAccountPathsFor = require('@utils/format-account-paths-for')
 
 function get (req, res) {
   const createServiceState = _.get(req, 'session.pageData.createService', {})

app/controllers/create-service/get.controller.test.js

@@ -8,7 +8,7 @@ let req, res
 
 const getController = function (mockResponses) {
   return proxyquire('./create-service.controller', {
-    '../../utils/response': mockResponses
+    '@utils/response': mockResponses
   })
 }