test: add test case for custom options

Author: daniel-jones-dev

tests/core.ts

@@ -201,7 +201,7 @@ export const testTimeout = 60000;
 
 // Base URL for mocking out HTTP client
 export const urlToMockRegexp =
-  /(https?:\/\/api.*\.deepl\.com)|(deepl-mock:\d+)|(https?:\/\/localhost:\d+)/;
+    /(https?:\/\/api.*\.deepl\.com)|(deepl-mock:\d+)|(https?:\/\/localhost:\d+)/;
 
 module.exports = {
     exampleText,

tests/translateDocument.test.ts

@@ -4,6 +4,8 @@
 
 import * as deepl from 'deepl-node';
 
+import nock from 'nock';
+
 import fs from 'fs';
 import path from 'path';
 import util from 'util';
@@ -17,9 +19,11 @@ import {
     tempFiles,
     testTimeout,
     timeout,
+    urlToMockRegexp,
     withMockServer,
     withRealServer,
 } from './core';
+import { DocumentTranslateOptions, QuotaExceededError } from 'deepl-node';
 
 describe('translate document', () => {
     it(
@@ -261,4 +265,33 @@ describe('translate document', () => {
         const translator = makeTranslator();
         await expect(translator.getDocumentStatus(handle)).rejects.toThrow('Not found');
     });
+
+    describe('request parameter tests', () => {
+        beforeAll(() => {
+            nock.disableNetConnect();
+        });
+
+        it('sends extra request parameters', async () => {
+            nock(urlToMockRegexp)
+                .post('/v2/document', function (body) {
+                    // Nock unfortunately does not support proper form data matching
+                    // See https://github.com/nock/nock/issues/887
+                    // And https://github.com/nock/nock/issues/191
+                    expect(body).toContain('form-data');
+                    expect(body).toContain('my-extra-parameter');
+                    expect(body).toContain('my-extra-value');
+                    return true;
+                })
+                .reply(456);
+            const translator = makeTranslator();
+            const dataBuf = Buffer.from('Example file contents', 'utf8');
+            const options: DocumentTranslateOptions = {
+                filename: 'example.txt',
+                extraRequestParameters: { 'my-extra-parameter': 'my-extra-value' },
+            };
+            await expect(translator.uploadDocument(dataBuf, null, 'de', options)).rejects.toThrow(
+                QuotaExceededError,
+            );
+        });
+    });
 });

tests/translateText.test.ts

@@ -4,7 +4,17 @@
 
 import * as deepl from 'deepl-node';
 
-import { exampleText, makeTranslator, testTimeout, withMockServer, withRealServer } from './core';
+import nock from 'nock';
+
+import {
+    exampleText,
+    makeTranslator,
+    testTimeout,
+    urlToMockRegexp,
+    withMockServer,
+    withRealServer,
+} from './core';
+import { QuotaExceededError, TranslateTextOptions } from 'deepl-node';
 
 describe('translate text', () => {
     it('should translate a single text', async () => {
@@ -235,4 +245,26 @@ describe('translate text', () => {
         expect(result.text).toContain('<h1>Meine erste Überschrift</h1>');
         expect(result.text).toContain('<p translate="no">My first paragraph.</p>');
     });
+
+    describe('request parameter tests', () => {
+        beforeAll(() => {
+            nock.disableNetConnect();
+        });
+
+        it('sends extra request parameters', async () => {
+            nock(urlToMockRegexp)
+                .post('/v2/translate', function (body) {
+                    expect(body['my-extra-parameter']).toBe('my-extra-value');
+                    return true;
+                })
+                .reply(456);
+            const translator = makeTranslator();
+            const options: TranslateTextOptions = {
+                extraRequestParameters: { 'my-extra-parameter': 'my-extra-value' },
+            };
+            await expect(translator.translateText('test', null, 'de', options)).rejects.toThrow(
+                QuotaExceededError,
+            );
+        });
+    });
 });