Merge pull request #236 from beakerandjake/feature/223-submit-command-update-output-text-from-parsing-adventofcodecom-responses

Feature/223 submit command update output text from parsing adventofcodecom responses

Author: beakerandjake

CHANGELOG.md

@@ -6,6 +6,10 @@ 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
+- Fix submission response parsing. Now handles more server responses with better output to the user. ([#223](https://github.com/beakerandjake/advent-of-code-runner/issues/223))
+### Changed
+- Remove dependencies:  dom-serializer, domutils, htmlparser2
 
 ## [1.5.0] - 2023-11-16
 ### Added

package-lock.json

@@ -37,11 +37,8 @@
     "chalk": "^5.2.0",
     "commander": "^11.1.0",
     "date-fns": "^2.29.3",
-    "dom-serializer": "^2.0.0",
-    "domutils": "^3.0.1",
     "dotenv": "^16.0.3",
     "fs-extra": "^11.1.0",
-    "htmlparser2": "^8.0.1",
     "ora": "^6.1.2",
     "table": "^6.8.1",
     "terminal-link": "^3.0.0",

package.json

@@ -1,11 +1,12 @@
 import { getConfigValue } from '../config.js';
+import {
+  EmptyResponseError,
+  InternalServerError,
+  NotAuthorizedError,
+  PuzzleNotFoundError,
+} from '../errors/apiErrors.js';
 import { sizeOfStringInKb } from '../formatting.js';
 import { logger } from '../logger.js';
-import {
-  extractTextContentOfMain,
-  parseResponseMessage,
-  sanitizeMessage,
-} from './parseSubmissionResponse.js';
 import { puzzleAnswerUrl, puzzleInputUrl } from './urls.js';
 /**
  * Creates a headers object which can be passed to fetch.
@@ -23,46 +24,33 @@ const getHeaders = (authenticationToken) => ({
  * @param {Number} day - The day of the puzzle.
  * @param {Promise<String>} authenticationToken - Token to authenticate with aoc.
  */
-export const downloadInput = async (year, day, authenticationToken) => {
+export const getInput = async (year, day, authenticationToken) => {
   logger.debug('downloading input file for year: %s, day: %s', year, day);
-
   if (!authenticationToken) {
-    throw new Error(
-      'Authentication Token is required to query advent of code.'
-    );
+    throw new NotAuthorizedError();
   }
 
-  // query api
   const url = puzzleInputUrl(year, day);
   logger.debug('querying url for input: %s', url);
   const response = await fetch(url, {
     headers: getHeaders(authenticationToken),
   });
 
-  // bad request, authentication failed.
   if (response.status === 400) {
-    throw new Error('Authentication failed, double check authentication token');
+    throw new NotAuthorizedError();
   }
-  // not found, invalid day or year.
   if (response.status === 404) {
-    throw new Error('That year/day combination could not be found');
+    throw new PuzzleNotFoundError(year, day);
   }
-  // handle all other error status codes
   if (!response.ok) {
-    throw new Error(
-      `Unexpected server error while downloading input file, error: ${response.status} - ${response.statusText}`
-    );
+    throw new InternalServerError(response.status, response.statusText);
   }
 
-  // expect text of response is the input.
   const text = await response.text();
-
+  logger.debug('downloaded: %s', sizeOfStringInKb(text));
   if (!text) {
-    throw new Error('Advent of code returned empty input');
+    throw new EmptyResponseError();
   }
-
-  logger.debug('downloaded: %s', sizeOfStringInKb(text));
-
   return text;
 };
 
@@ -74,22 +62,19 @@ export const downloadInput = async (year, day, authenticationToken) => {
  * @param {String|Number} solution - The solution to test.
  * @param {String} authenticationToken - Token to authenticate with aoc.
  */
-export const submitSolution = async (
+export const postAnswer = async (
   year,
   day,
   level,
   solution,
   authenticationToken
 ) => {
-  logger.debug('submitting solution to advent of code', { year, day, level });
+  logger.debug('posting answer to advent of code', { year, day, level });
 
   if (!authenticationToken) {
-    throw new Error(
-      'Authentication Token is required to query advent of code.'
-    );
+    throw new NotAuthorizedError();
   }
 
-  // post to api
   const url = puzzleAnswerUrl(year, day);
   logger.debug('posting to url: %s', url);
   const response = await fetch(url, {
@@ -101,34 +86,20 @@ export const submitSolution = async (
     body: `level=${level}&answer=${solution}`,
   });
 
-  // bad request, authentication failed.
-  // as of writing advent returns a 302 to redirect the user to the puzzle page on fail
-  // but check 400 too just incase.
+  // server can sometimes redirect (302) back to puzzle page if auth fails.
   if (response.status === 400 || response.status === 302) {
-    throw new Error('Authentication failed, double check authentication token');
+    throw new NotAuthorizedError();
   }
-  // not found, invalid day or year.
   if (response.status === 404) {
-    throw new Error('That year/day combination could not be found');
+    throw new PuzzleNotFoundError(year, day);
   }
-  // bail on any other type of http error
   if (!response.ok) {
-    throw new Error(
-      `Unexpected server error while posting solution, error: ${response.status} - ${response.statusText}`
-    );
+    throw new InternalServerError(response.status, response.statusText);
   }
 
-  // advent of code doesn't return status codes, we have to parse the html.
-  // grab the text content of the <main> element which contains the message we need.
-  const responseMessage = sanitizeMessage(
-    extractTextContentOfMain(await response.text())
-  );
-
-  if (!responseMessage) {
-    throw new Error('Unable get message from advent of code response.');
+  const text = await response.text();
+  if (!text) {
+    throw new EmptyResponseError();
   }
-
-  // the content of the message tells us what happened
-  // parse this message to determine the submission result.
-  return parseResponseMessage(responseMessage);
+  return text;
 };

src/api/api.js

@@ -8,26 +8,26 @@ import { logger } from '../logger.js';
  * Decorates the api methods with rate limiting.
  * @param {Object} module - The imported api to decorate.
  */
-const decorateApiWithRateLimiting = ({ downloadInput, submitSolution }) => {
+const decorateApiWithRateLimiting = ({ getInput, postAnswer }) => {
   logger.debug('decorating api with rate limiting');
   return {
-    downloadInput: rateLimitDecorator(
-      downloadInput,
-      rateLimitedActions.downloadInput,
+    getInput: rateLimitDecorator(
+      getInput,
+      rateLimitedActions.getInput,
       'Timeout period for downloading an input file has not expired.'
     ),
-    submitSolution: rateLimitDecorator(
-      submitSolution,
-      rateLimitedActions.submitAnswer,
+    postAnswer: rateLimitDecorator(
+      postAnswer,
+      rateLimitedActions.postAnswer,
       'Timeout period for submitting an answer has not expired.'
     ),
   };
 };
 
 const useMockApi = getConfigValue('aoc.mockApi.enabled');
 
-const { downloadInput, submitSolution } = useMockApi
+const { getInput, postAnswer } = useMockApi
   ? await import('./mockApi.js')
   : decorateApiWithRateLimiting(await import('./api.js'));
 
-export { downloadInput, submitSolution };
+export { getInput, postAnswer };