Merge pull request #219 from beakerandjake/feature/218-input-string-provided-to-puzzles-is-not-raw-it-is-trimmed-at-the-end

Feature/218 input string provided to puzzles is not raw it is trimmed at the end

Author: beakerandjake

CHANGELOG.md

@@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Fixed
+- `downloadInput()` no longer trims the end of the text ([#218](https://github.com/beakerandjake/advent-of-code-runner/issues/218))
 
 ## [1.3.4] - 2023-02-14
 ### Fixed

src/api/api.js

@@ -53,13 +53,14 @@ export const downloadInput = async (year, day, authenticationToken) => {
   }
 
   // expect text of response is the input.
-  const text = (await response.text())?.trimEnd() || '';
-  logger.debug('downloaded: %s', sizeOfStringInKb(text));
+  const text = await response.text();
 
   if (!text) {
     throw new Error('Advent of code returned empty input');
   }
 
+  logger.debug('downloaded: %s', sizeOfStringInKb(text));
+
   return text;
 };
 

src/api/mockApi.js

@@ -11,7 +11,7 @@ import { logger } from '../logger.js';
  */
 export const downloadInput = async (year, day, authenticationToken) => {
   logger.debug('downloading mock input file for year: %s, day: %s', year, day);
-  return [...Array(100).keys()].map((x) => x + 1).join('\n');
+  return `${[...Array(100).keys()].map((x) => x + 1).join('\n')}\n`;
 };
 
 /**

src/inputs/parseInput.js

@@ -11,5 +11,5 @@ export const splitLines = (input) => {
     throw new TypeError('Expected argument of type String');
   }
 
-  return input.split('\n');
+  return input.trimEnd().split('\n');
 };

tests/api/api.test.js

@@ -70,21 +70,16 @@ describe('api', () => {
       );
     });
 
-    test.each([undefined, null, '', '\t'])(
-      'throws on empty input: "%s"',
-      async (value) => {
-        mockFetch.mockImplementation(() =>
-          Promise.resolve({
-            ok: true,
-            status: 200,
-            text: () => Promise.resolve(value),
-          })
-        );
-        await expect(async () => downloadInput(2022, 1, 'ASDF')).rejects.toThrow(
-          /empty/i
-        );
-      }
-    );
+    test.each([undefined, null, ''])('throws on empty input: "%s"', async (value) => {
+      mockFetch.mockImplementation(() =>
+        Promise.resolve({
+          ok: true,
+          status: 200,
+          text: () => Promise.resolve(value),
+        })
+      );
+      await expect(async () => downloadInput(2022, 1, 'ASDF')).rejects.toThrow(/empty/i);
+    });
 
     test('returns input on success', async () => {
       const expected = '1234\n5678\n9101112';
@@ -112,13 +107,13 @@ describe('api', () => {
       expect(result).toBe(expected);
     });
 
-    test('trims end of input', async () => {
-      const expected = '1234\n5678\n9101112';
+    test('does not trim end of input', async () => {
+      const expected = '1234\n5678\n9101112\n';
       mockFetch.mockImplementation(() =>
         Promise.resolve({
           ok: true,
           status: 200,
-          text: () => Promise.resolve(`${expected}\t\n`),
+          text: () => Promise.resolve(expected),
         })
       );
       const result = await downloadInput(2022, 1, 'ASDF');

tests/inputs/parseInput.test.js

@@ -1,6 +1,9 @@
 import { describe, test } from '@jest/globals';
 import { splitLines } from '../../src/inputs/parseInput.js';
 
+const addEndingLineBreak = (input) => `${input}\n`;
+const inputStringFromArray = (lines) => addEndingLineBreak(lines.join('\n'));
+
 describe('parseInput', () => {
   describe('splitLines()', () => {
     test.each([null, undefined])('returns [] if input is "%s"', (input) => {
@@ -16,16 +19,17 @@ describe('parseInput', () => {
     );
 
     test('returns array with one element if no line breaks', async () => {
-      const input = 'ASDFQWERRTY';
-      const result = splitLines(input);
-      expect(result).toEqual([input]);
+      const expected = ['ASDFQWERRTY'];
+      const result = splitLines(inputStringFromArray(expected));
+      expect(result).toEqual(expected);
     });
 
     test('returns each line as array element', async () => {
-      const lines = ['1234', 'ASDF', 'QWER', '@#$', 'asdf', '', 'zxcgv'];
-      const input = lines.join('\n');
-      const result = splitLines(input);
-      expect(result).toEqual(lines);
+      const expected = ['1234', 'ASDF', 'QWER', '@#$', 'asdf', '', 'zxcgv'];
+      const result = splitLines(inputStringFromArray(expected));
+      expect(result).toEqual(expected);
     });
+
+    // test('does not include empty ');
   });
 });