fix: handle the sorting of transformed files (#44724)

* fix: handle the sorting of transformed files

We can't use the ext property, since that is transformed, but the
history is maintained.

* test: make solutions polyVinyls for sorting

* refactor: inline prepareChallenge

* refactor: make solutions polys in getChallenges

* fix: convert each solution to a poly

* fix: skip empty solutions

* fix: get challenge file history in client

* refactor: stop calling isPoly from the client

* fix: remove debug console.log

* refactor: remove unnecessary sorting step

client/gatsby-node.js

@@ -95,10 +95,12 @@ exports.createPages = function createPages({ graphql, actions, reporter }) {
                     contents
                     head
                     tail
+                    history
                   }
                   solutions {
                     contents
                     ext
+                    history
                   }
                   superBlock
                   superOrder

client/src/templates/Challenges/classic/show.tsx

@@ -547,6 +547,7 @@ export const query = graphql`
           head
           tail
           editableRegionBoundaries
+          history
         }
       }
     }

client/src/templates/Challenges/redux/index.js

@@ -2,7 +2,6 @@ import { isEmpty } from 'lodash-es';
 import { createAction, handleActions } from 'redux-actions';
 
 import { getLines } from '../../../../../utils/get-lines';
-import { createPoly } from '../../../../../utils/polyvinyl';
 import { challengeTypes } from '../../../../utils/challenge-types';
 import { completedChallengesSelector } from '../../../redux';
 import { getTargetEditor } from '../utils/getTargetEditor';
@@ -58,12 +57,11 @@ export const sagas = [
   ...createCurrentChallengeSaga(actionTypes)
 ];
 
-// TODO: can createPoly handle editable region, rather than separating it?
 export const createFiles = createAction(
   actionTypes.createFiles,
   challengeFiles =>
     challengeFiles.map(challengeFile => ({
-      ...createPoly(challengeFile),
+      ...challengeFile,
       seed: challengeFile.contents.slice(),
       editableContents: getLines(
         challengeFile.contents,

client/utils/gatsby/challenge-page-creator.js

@@ -1,5 +1,4 @@
 const path = require('path');
-const { createPoly } = require('../../../utils/polyvinyl');
 const { dasherize } = require('../../../utils/slugs');
 const { sortChallengeFiles } = require('../../../utils/sort-challengefiles');
 const { challengeTypes, viewTypes } = require('../challenge-types');
@@ -115,12 +114,10 @@ function getProjectPreviewConfig(challenge, allChallengeEdges) {
   const lastChallengeFiles = sortChallengeFiles(
     lastChallenge.challengeFiles ?? []
   );
-  const projectPreviewChallengeFiles = lastChallengeFiles.map((file, id) =>
-    createPoly({
+  const projectPreviewChallengeFiles = lastChallengeFiles.map((file, id) => ({
     ...file,
     contents: solutionToLastChallenge[id]?.contents ?? file.contents
-    })
-  );
+  }));
 
   return {
     showProjectPreview:

curriculum/getChallenges.js

@@ -337,15 +337,21 @@ ${getFullPath('english')}
   challenge.translationPending =
     lang !== 'english' && !isAuditedCert(lang, superBlock);
   challenge.usesMultifileEditor = !!usesMultifileEditor;
-
-  return prepareChallenge(challenge);
+  if (challenge.challengeFiles) {
+    // The client expects the challengeFiles to be an array of polyvinyls
+    challenge.challengeFiles = challengeFilesToPolys(challenge.challengeFiles);
+  }
+  if (challenge.solutions?.length) {
+    // The test runner needs the solutions to be arrays of polyvinyls so it
+    // can sort them correctly.
+    challenge.solutions = challenge.solutions.map(challengeFilesToPolys);
   }
 
-// gets the challenge ready for sourcing into Gatsby
-function prepareChallenge(challenge) {
-  if (challenge.challengeFiles) {
-    challenge.challengeFiles = challenge.challengeFiles.reduce(
-      (challengeFiles, challengeFile) => {
+  return challenge;
+}
+
+function challengeFilesToPolys(files) {
+  return files.reduce((challengeFiles, challengeFile) => {
     return [
       ...challengeFiles,
       {
@@ -353,11 +359,7 @@ function prepareChallenge(challenge) {
         seed: challengeFile.contents.slice(0)
       }
     ];
-      },
-      []
-    );
-  }
-  return challenge;
+  }, []);
 }
 
 async function hasEnglishSource(basePath, translationPath) {

curriculum/test/test-challenges.js

@@ -43,7 +43,6 @@ const testEvaluator =
 const { getLines } = require('../../utils/get-lines');
 const { isAuditedCert } = require('../../utils/is-audited');
 
-const { sortChallengeFiles } = require('../../utils/sort-challengefiles');
 const {
   getChallengesForLang,
   getMetaForBlock,
@@ -533,9 +532,7 @@ ${inspect(commentMap)}
           // TODO: the no-solution filtering is a little convoluted:
           const noSolution = new RegExp('// solution required');
 
-          const solutionsAsArrays = solutions.map(sortChallengeFiles);
-
-          const filteredSolutions = solutionsAsArrays.filter(solution => {
+          const filteredSolutions = solutions.filter(solution => {
             return !isEmpty(
               solution.filter(
                 challengeFile => !noSolution.test(challengeFile.contents)

utils/sort-challengefiles.js

@@ -1,16 +1,14 @@
 exports.sortChallengeFiles = function sortChallengeFiles(challengeFiles) {
   const xs = challengeFiles.slice();
-  // TODO: refactor this to use an ext array ['html', 'js', 'css'] and loop over
-  // that.
   xs.sort((a, b) => {
-    if (a.ext === 'html') return -1;
-    if (b.ext === 'html') return 1;
-    if (a.ext === 'css') return -1;
-    if (b.ext === 'css') return 1;
-    if (a.ext === 'jsx') return -1;
-    if (b.ext === 'jsx') return 1;
-    if (a.ext === 'js') return -1;
-    if (b.ext === 'js') return 1;
+    if (a.history[0] === 'index.html') return -1;
+    if (b.history[0] === 'index.html') return 1;
+    if (a.history[0] === 'styles.css') return -1;
+    if (b.history[0] === 'styles.css') return 1;
+    if (a.history[0] === 'index.jsx') return -1;
+    if (b.history[0] === 'index.jsx') return 1;
+    if (a.history[0] === 'script.js') return -1;
+    if (b.history[0] === 'script.js') return 1;
     return 0;
   });
   return xs;