fix: resolve lint rule violations and unit test errors

Author: CKodidela

src/controllers/invoices/get-invoice-controller.ts

@@ -1,9 +1,12 @@
+import { escapeHtml, safeJsonForScript } from '../../utils/html'
 import { path, pathEq } from 'ramda'
 import { Request, Response } from 'express'
+
 import { createSettings } from '../../factories/settings-factory'
+
 import { FeeSchedule } from '../../@types/settings'
 import { IController } from '../../@types/controllers'
-import { escapeHtml, safeJsonForScript } from '../../utils/html'
+
 import { getTemplate } from '../../utils/template-cache'
 
 

src/controllers/invoices/post-invoice-controller.ts

@@ -1,17 +1,20 @@
-import { FeeSchedule, Settings } from '../../@types/settings'
-import { fromBech32, toBech32 } from '../../utils/transform'
-import { getPublicKey, getRelayPrivateKey } from '../../utils/event'
+import { path } from 'ramda'
+
 import { Request, Response } from 'express'
 
-import { escapeHtml, safeJsonForScript } from '../../utils/html'
-import { createLogger } from '../../factories/logger-factory'
-import { getRemoteAddress } from '../../utils/http'
+import { FeeSchedule, Settings } from '../../@types/settings'
 import { IController } from '../../@types/controllers'
 import { Invoice } from '../../@types/invoice'
 import { IPaymentsService } from '../../@types/services'
 import { IRateLimiter } from '../../@types/utils'
 import { IUserRepository } from '../../@types/repositories'
-import { path } from 'ramda'
+
+import { createLogger } from '../../factories/logger-factory'
+
+import { escapeHtml, safeJsonForScript } from '../../utils/html'
+import { fromBech32, toBech32 } from '../../utils/transform'
+import { getPublicKey, getRelayPrivateKey } from '../../utils/event'
+import { getRemoteAddress } from '../../utils/http'
 import { getTemplate } from '../../utils/template-cache'
 
 

src/handlers/request-handlers/get-privacy-request-handler.ts

@@ -1,6 +1,9 @@
 import { NextFunction, Request, Response } from 'express'
+
 import { createSettings as settings } from '../../factories/settings-factory'
+
 import { escapeHtml } from '../../utils/html'
+
 import { getTemplate } from '../../utils/template-cache'
 
 export const getPrivacyRequestHandler = (_req: Request, res: Response, next: NextFunction) => {

src/handlers/request-handlers/get-terms-request-handler.ts

@@ -1,7 +1,7 @@
 import { NextFunction, Request, Response } from 'express'
-import { createSettings as settings } from '../../factories/settings-factory'
 import { escapeHtml } from '../../utils/html'
 import { getTemplate } from '../../utils/template-cache'
+import { createSettings as settings } from '../../factories/settings-factory'
 
 
 

src/handlers/request-handlers/root-request-handler.ts

@@ -1,9 +1,9 @@
 import { NextFunction, Request, Response } from 'express'
 import { path, pathEq } from 'ramda'
 import { createSettings } from '../../factories/settings-factory'
+import { escapeHtml } from '../../utils/html'
 import { FeeSchedule } from '../../@types/settings'
 import { fromBech32 } from '../../utils/transform'
-import { escapeHtml } from '../../utils/html'
 import { getTemplate } from '../../utils/template-cache'
 import packageJson from '../../../package.json'
 

test/unit/controllers/invoices/post-invoice-controller.spec.ts

@@ -7,8 +7,8 @@ chai.use(sinonChai)
 chai.use(chaiAsPromised)
 const { expect } = chai
 
-import * as templateCache from '../../../../src/utils/template-cache'
 import * as eventUtils from '../../../../src/utils/event'
+import * as templateCache from '../../../../src/utils/template-cache'
 import { PostInvoiceController } from '../../../../src/controllers/invoices/post-invoice-controller'
 
 const VALID_PUBKEY = 'a'.repeat(64)
@@ -26,6 +26,9 @@ const baseSettings = {
     },
   },
   limits: {},
+  network: {
+    remoteIpHeader: 'x-forwarded-for',
+  },
 }
 
 const makeController = (overrides: {
@@ -48,7 +51,7 @@ const makeController = (overrides: {
   )
 }
 
-const makeRes = () => ({
+const makeRes = (): any => ({
   status: sinon.stub().returnsThis(),
   setHeader: sinon.stub().returnsThis(),
   send: sinon.stub().returnsThis(),
@@ -148,6 +151,7 @@ describe('PostInvoiceController', () => {
     it('returns 400 when pubkey is missing', async () => {
       const controller = makeController()
       const res = makeRes()
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
       const { pubkey: _, ...bodyWithoutPubkey } = validBody
 
       await controller.handleRequest({ body: bodyWithoutPubkey } as any, res)

test/unit/utils/html.spec.ts

@@ -26,7 +26,7 @@ describe('escapeHtml', () => {
   })
 
   it('escapes all special characters together', () => {
-    expect(escapeHtml(`<script>alert("it's a & test")</script>`)).to.equal(
+    expect(escapeHtml('<script>alert("it\'s a & test")</script>')).to.equal(
       '&lt;script&gt;alert(&quot;it&#39;s a &amp; test&quot;)&lt;/script&gt;'
     )
   })

test/unit/utils/template-cache.spec.ts

@@ -1,47 +1,38 @@
 import chai from 'chai'
-import sinon from 'sinon'
-import sinonChai from 'sinon-chai'
 
-chai.use(sinonChai)
 const { expect } = chai
 
 import * as fs from 'fs'
 import { getTemplate } from '../../../src/utils/template-cache'
+import { join } from 'path'
+import { tmpdir } from 'os'
 
 describe('getTemplate', () => {
-  let readFileSyncStub: sinon.SinonStub
+  const tmpFile = join(tmpdir(), 'test-template.html')
 
   beforeEach(() => {
-    readFileSyncStub = sinon.stub(fs, 'readFileSync').returns('template content' as any)
+    fs.writeFileSync(tmpFile, 'template content')
   })
 
   afterEach(() => {
-    readFileSyncStub.restore()
+    try { fs.unlinkSync(tmpFile) } catch (e) { /* ignore */ }
   })
 
   it('returns the file content', () => {
-    const result = getTemplate('./resources/index.html')
-
+    const result = getTemplate(tmpFile)
     expect(result).to.equal('template content')
   })
 
-  it('reads the file with utf8 encoding', () => {
-    getTemplate('./resources/index.html')
-
-    expect(readFileSyncStub).to.have.been.calledWith('./resources/index.html', 'utf8')
-  })
-
   it('reads the file on every call in non-production mode', () => {
     // NODE_ENV is not 'production' in tests — cache is bypassed
-    getTemplate('./resources/index.html')
-    getTemplate('./resources/index.html')
+    getTemplate(tmpFile)
+    fs.writeFileSync(tmpFile, 'updated content')
+    const result2 = getTemplate(tmpFile)
 
-    expect(readFileSyncStub).to.have.been.calledTwice
+    expect(result2).to.equal('updated content')
   })
 
   it('propagates errors thrown by readFileSync', () => {
-    readFileSyncStub.throws(new Error('file not found'))
-
-    expect(() => getTemplate('./resources/missing.html')).to.throw('file not found')
+    expect(() => getTemplate('./does-not-exist.html')).to.throw(/ENOENT/)
   })
 })