fix(client): update invalid stored code #44437

ojeytonwilliams · 2021-12-09T12:36:56Z

If loadCodeEpic encounters stored code it cannot parse, it would silently throw an error. This fixes old stored code and then clears out anything it doesn't understand.

The text was updated successfully, but these errors were encountered:

gitpod-io · 2021-12-09T12:37:00Z

codesee-architecture-diagrams · 2021-12-09T12:39:00Z

👀 Review this PR in a CodeSee Review Map

Preview the Review Map

Legend

ShaunSHamilton

Nit-picky, because the fewer types the more betterer.

client/src/templates/Challenges/redux/code-storage-epic.js

ojeytonwilliams · 2021-12-09T13:52:03Z

@raisedadead what do you think about purging the saved javascript challenge code? Just the challenge code, mind, nothing else.

raisedadead · 2021-12-09T14:08:19Z

what do you think about purging the saved javascript challenge code?

Does this include user code too?

ShaunSHamilton · 2021-12-09T14:12:04Z

what do you think about purging the saved javascript challenge code?

Does this include user code too?

Yes. This is the localStorage for non-certification projects. So, only user code. Only client-side. (the code saved with Ctrl + S in the editor)

ShaunSHamilton · 2021-12-09T14:20:55Z

@raisedadead We discussed and have decided to go with the "hacky" approach which allows all currently saved code.

This is mostly because there are probably a few Campers relying on localStorage for the JS certification projects (before they submit)

ojeytonwilliams · 2021-12-09T14:37:24Z

Blocked while we discuss what we want to implement

)" This reverts commit fca626f.

ojeytonwilliams · 2021-12-20T12:21:11Z

This now restores the old behaviour, but should gracefully handle old saved code and only discard stored code if it isn't valid.

@Sembauke this should help a little with the mobile app.

Sembauke · 2021-12-20T12:31:08Z

Thanks @ojeytonwilliams ,

I tried to use the editor on mobile but came across some issues when switching panes and trying to run tests.
(Most of the time the code would just not save)

Also some users report unable to remove text or type at all.
It is hard to know if these issue's are from the mobile app or from the Monaco Editor itself.

Hope this fixes the storing issues.

ojeytonwilliams · 2021-12-20T12:41:56Z

@Sembauke Monaco really isn't great for mobile. If you're interested, you can try https://microsoft.github.io/monaco-editor/playground.html on mobile, to see what's a Monaco specific issue rather than something we have done.

This PR is a relatively minor improvement - I just remembered that inability to save was a source of frustration for some mobile users.

ShaunSHamilton · 2021-12-20T13:16:27Z

@Sembauke For reference, we have always pointed mobile users to: https://www.freecodecamp.org/news/freecodecamp-mobile/

ShaunSHamilton

This LGTM 👍

One thing I noticed, even when updating the old code format, the old fields remain behind:
Is there any reason this would be a problem?

{
    "fileKey": "scriptjs",
    "head": "",
    "tail": "",
    "editableRegionBoundaries": null,
    "history": [
        "script.js"
    ],
    "name": "script",
    "ext": "js",
    "path": "script.js",
    "contents": "// The global variable\nvar watchList = [\n  {\n    \"Title\": \"Inception\",\n    \"Year\": \"2010\",\n    \"Rated\": \"PG-13\",\n    \"Released\": \"16 Jul 2010\",\n    \"Runtime\": \"148 min\",\n    \"Genre\": \"Action, Adventure, Crime\",\n    \"Director\": \"Christopher Nolan\",\n    \"Writer\": \"Christopher Nolan\",\n    \"Actors\": \"Leonardo DiCaprio, Joseph Gordon-Levitt, Elliot Page, Tom Hardy\",\n    \"Plot\": \"A thief, who steals corporate secrets through use of dream-sharing technology, is given the inverse task of planting an idea into the mind of a CEO.\",\n    \"Language\": \"English, Japanese, French\",\n    \"Country\": \"USA, UK\",\n    \"Awards\": \"Won 4 Oscars. Another 143 wins & 198 nominations.\",\n    \"Poster\": \"http://ia.media-imdb.com/images/M/MV5BMjAxMzY3NjcxNF5BMl5BanBnXkFtZTcwNTI5OTM0Mw@@._V1_SX300.jpg\",\n    \"Metascore\": \"74\",\n    \"imdbRating\": \"8.8\",\n    \"imdbVotes\": \"1,446,708\",\n    \"imdbID\": \"tt1375666\",\n    \"Type\": \"movie\",\n    \"Response\": \"True\"\n  },\n  {\n    \"Title\": \"Interstellar\",\n    \"Year\": \"2014\",\n    \"Rated\": \"PG-13\",\n    \"Released\": \"07 Nov 2014\",\n    \"Runtime\": \"169 min\",\n    \"Genre\": \"Adventure, Drama, Sci-Fi\",\n    \"Director\": \"Christopher Nolan\",\n    \"Writer\": \"Jonathan Nolan, Christopher Nolan\",\n    \"Actors\": \"Ellen Burstyn, Matthew McConaughey, Mackenzie Foy, John Lithgow\",\n    \"Plot\": \"A team of explorers travel through a wormhole in space in an attempt to ensure humanity's survival.\",\n    \"Language\": \"English\",\n    \"Country\": \"USA, UK\",\n    \"Awards\": \"Won 1 Oscar. Another 39 wins & 132 nominations.\",\n    \"Poster\": \"http://ia.media-imdb.com/images/M/MV5BMjIxNTU4MzY4MF5BMl5BanBnXkFtZTgwMzM4ODI3MjE@._V1_SX300.jpg\",\n    \"Metascore\": \"74\",\n    \"imdbRating\": \"8.6\",\n    \"imdbVotes\": \"910,366\",\n    \"imdbID\": \"tt0816692\",\n    \"Type\": \"movie\",\n    \"Response\": \"True\"\n  },\n  {\n    \"Title\": \"The Dark Knight\",\n    \"Year\": \"2008\",\n    \"Rated\": \"PG-13\",\n    \"Released\": \"18 Jul 2008\",\n    \"Runtime\": \"152 min\",\n    \"Genre\": \"Action, Adventure, Crime\",\n    \"Director\": \"Christopher Nolan\",\n    \"Writer\": \"Jonathan Nolan (screenplay), Christopher Nolan (screenplay), Christopher Nolan (story), David S. Goyer (story), Bob Kane (characters)\",\n    \"Actors\": \"Christian Bale, Heath Ledger, Aaron Eckhart, Michael Caine\",\n    \"Plot\": \"When the menace known as the Joker wreaks havoc and chaos on the people of Gotham, the caped crusader must come to terms with one of the greatest psychological tests of his ability to fight injustice.\",\n    \"Language\": \"English, Mandarin\",\n    \"Country\": \"USA, UK\",\n    \"Awards\": \"Won 2 Oscars. Another 146 wins & 142 nominations.\",\n    \"Poster\": \"http://ia.media-imdb.com/images/M/MV5BMTMxNTMwODM0NF5BMl5BanBnXkFtZTcwODAyMTk2Mw@@._V1_SX300.jpg\",\n    \"Metascore\": \"82\",\n    \"imdbRating\": \"9.0\",\n    \"imdbVotes\": \"1,652,832\",\n    \"imdbID\": \"tt0468569\",\n    \"Type\": \"movie\",\n    \"Response\": \"True\"\n  },\n  {\n    \"Title\": \"Batman Begins\",\n    \"Year\": \"2005\",\n    \"Rated\": \"PG-13\",\n    \"Released\": \"15 Jun 2005\",\n    \"Runtime\": \"140 min\",\n    \"Genre\": \"Action, Adventure\",\n    \"Director\": \"Christopher Nolan\",\n    \"Writer\": \"Bob Kane (characters), David S. Goyer (story), Christopher Nolan (screenplay), David S. Goyer (screenplay)\",\n    \"Actors\": \"Christian Bale, Michael Caine, Liam Neeson, Katie Holmes\",\n    \"Plot\": \"After training with his mentor, Batman begins his fight to free crime-ridden Gotham City from the corruption that Scarecrow and the League of Shadows have cast upon it.\",\n    \"Language\": \"English, Urdu, Mandarin\",\n    \"Country\": \"USA, UK\",\n    \"Awards\": \"Nominated for 1 Oscar. Another 15 wins & 66 nominations.\",\n    \"Poster\": \"http://ia.media-imdb.com/images/M/MV5BNTM3OTc0MzM2OV5BMl5BanBnXkFtZTYwNzUwMTI3._V1_SX300.jpg\",\n    \"Metascore\": \"70\",\n    \"imdbRating\": \"8.3\",\n    \"imdbVotes\": \"972,584\",\n    \"imdbID\": \"tt0372784\",\n    \"Type\": \"movie\",\n    \"Response\": \"True\"\n  },\n  {\n    \"Title\": \"Avatar\",\n    \"Year\": \"2009\",\n    \"Rated\": \"PG-13\",\n    \"Released\": \"18 Dec 2009\",\n    \"Runtime\": \"162 min\",\n    \"Genre\": \"Action, Adventure, Fantasy\",\n    \"Director\": \"James Cameron\",\n    \"Writer\": \"James Cameron\",\n    \"Actors\": \"Sam Worthington, Zoe Saldana, Sigourney Weaver, Stephen Lang\",\n    \"Plot\": \"A paraplegic marine dispatched to the moon Pandora on a unique mission becomes torn between following his orders and protecting the world he feels is his home.\",\n    \"Language\": \"English, Spanish\",\n    \"Country\": \"USA, UK\",\n    \"Awards\": \"Won 3 Oscars. Another 80 wins & 121 nominations.\",\n    \"Poster\": \"http://ia.media-imdb.com/images/M/MV5BMTYwOTEwNjAzMl5BMl5BanBnXkFtZTcwODc5MTUwMw@@._V1_SX300.jpg\",\n    \"Metascore\": \"83\",\n    \"imdbRating\": \"7.9\",\n    \"imdbVotes\": \"876,575\",\n    \"imdbID\": \"tt0499549\",\n    \"Type\": \"movie\",\n    \"Response\": \"True\"\n  }\n];\n\nfunction getRating(watchList) {\n  // Only change code below this line\n  \n  var averageRating = watchList\n  .filter(e => e.Director === \"Christopher Nolan\")\n  .map(e => Number(e.imdbRating))\n  .reduce((sum, e) => sum + e, 0) / watchList.filter(e => e.Director === \"Christopher Nolan\").length;\n\n  // Only change code above this line\n  return averageRating;\n}\n\nconsole.log(getRating(watchList));",
    "error": null,
    "seed": "// The global variable\nvar watchList = [\n  {\n    \"Title\": \"Inception\",\n    \"Year\": \"2010\",\n    \"Rated\": \"PG-13\",\n    \"Released\": \"16 Jul 2010\",\n    \"Runtime\": \"148 min\",\n    \"Genre\": \"Action, Adventure, Crime\",\n    \"Director\": \"Christopher Nolan\",\n    \"Writer\": \"Christopher Nolan\",\n    \"Actors\": \"Leonardo DiCaprio, Joseph Gordon-Levitt, Elliot Page, Tom Hardy\",\n    \"Plot\": \"A thief, who steals corporate secrets through use of dream-sharing technology, is given the inverse task of planting an idea into the mind of a CEO.\",\n    \"Language\": \"English, Japanese, French\",\n    \"Country\": \"USA, UK\",\n    \"Awards\": \"Won 4 Oscars. Another 143 wins & 198 nominations.\",\n    \"Poster\": \"http://ia.media-imdb.com/images/M/MV5BMjAxMzY3NjcxNF5BMl5BanBnXkFtZTcwNTI5OTM0Mw@@._V1_SX300.jpg\",\n    \"Metascore\": \"74\",\n    \"imdbRating\": \"8.8\",\n    \"imdbVotes\": \"1,446,708\",\n    \"imdbID\": \"tt1375666\",\n    \"Type\": \"movie\",\n    \"Response\": \"True\"\n  },\n  {\n    \"Title\": \"Interstellar\",\n    \"Year\": \"2014\",\n    \"Rated\": \"PG-13\",\n    \"Released\": \"07 Nov 2014\",\n    \"Runtime\": \"169 min\",\n    \"Genre\": \"Adventure, Drama, Sci-Fi\",\n    \"Director\": \"Christopher Nolan\",\n    \"Writer\": \"Jonathan Nolan, Christopher Nolan\",\n    \"Actors\": \"Ellen Burstyn, Matthew McConaughey, Mackenzie Foy, John Lithgow\",\n    \"Plot\": \"A team of explorers travel through a wormhole in space in an attempt to ensure humanity's survival.\",\n    \"Language\": \"English\",\n    \"Country\": \"USA, UK\",\n    \"Awards\": \"Won 1 Oscar. Another 39 wins & 132 nominations.\",\n    \"Poster\": \"http://ia.media-imdb.com/images/M/MV5BMjIxNTU4MzY4MF5BMl5BanBnXkFtZTgwMzM4ODI3MjE@._V1_SX300.jpg\",\n    \"Metascore\": \"74\",\n    \"imdbRating\": \"8.6\",\n    \"imdbVotes\": \"910,366\",\n    \"imdbID\": \"tt0816692\",\n    \"Type\": \"movie\",\n    \"Response\": \"True\"\n  },\n  {\n    \"Title\": \"The Dark Knight\",\n    \"Year\": \"2008\",\n    \"Rated\": \"PG-13\",\n    \"Released\": \"18 Jul 2008\",\n    \"Runtime\": \"152 min\",\n    \"Genre\": \"Action, Adventure, Crime\",\n    \"Director\": \"Christopher Nolan\",\n    \"Writer\": \"Jonathan Nolan (screenplay), Christopher Nolan (screenplay), Christopher Nolan (story), David S. Goyer (story), Bob Kane (characters)\",\n    \"Actors\": \"Christian Bale, Heath Ledger, Aaron Eckhart, Michael Caine\",\n    \"Plot\": \"When the menace known as the Joker wreaks havoc and chaos on the people of Gotham, the caped crusader must come to terms with one of the greatest psychological tests of his ability to fight injustice.\",\n    \"Language\": \"English, Mandarin\",\n    \"Country\": \"USA, UK\",\n    \"Awards\": \"Won 2 Oscars. Another 146 wins & 142 nominations.\",\n    \"Poster\": \"http://ia.media-imdb.com/images/M/MV5BMTMxNTMwODM0NF5BMl5BanBnXkFtZTcwODAyMTk2Mw@@._V1_SX300.jpg\",\n    \"Metascore\": \"82\",\n    \"imdbRating\": \"9.0\",\n    \"imdbVotes\": \"1,652,832\",\n    \"imdbID\": \"tt0468569\",\n    \"Type\": \"movie\",\n    \"Response\": \"True\"\n  },\n  {\n    \"Title\": \"Batman Begins\",\n    \"Year\": \"2005\",\n    \"Rated\": \"PG-13\",\n    \"Released\": \"15 Jun 2005\",\n    \"Runtime\": \"140 min\",\n    \"Genre\": \"Action, Adventure\",\n    \"Director\": \"Christopher Nolan\",\n    \"Writer\": \"Bob Kane (characters), David S. Goyer (story), Christopher Nolan (screenplay), David S. Goyer (screenplay)\",\n    \"Actors\": \"Christian Bale, Michael Caine, Liam Neeson, Katie Holmes\",\n    \"Plot\": \"After training with his mentor, Batman begins his fight to free crime-ridden Gotham City from the corruption that Scarecrow and the League of Shadows have cast upon it.\",\n    \"Language\": \"English, Urdu, Mandarin\",\n    \"Country\": \"USA, UK\",\n    \"Awards\": \"Nominated for 1 Oscar. Another 15 wins & 66 nominations.\",\n    \"Poster\": \"http://ia.media-imdb.com/images/M/MV5BNTM3OTc0MzM2OV5BMl5BanBnXkFtZTYwNzUwMTI3._V1_SX300.jpg\",\n    \"Metascore\": \"70\",\n    \"imdbRating\": \"8.3\",\n    \"imdbVotes\": \"972,584\",\n    \"imdbID\": \"tt0372784\",\n    \"Type\": \"movie\",\n    \"Response\": \"True\"\n  },\n  {\n    \"Title\": \"Avatar\",\n    \"Year\": \"2009\",\n    \"Rated\": \"PG-13\",\n    \"Released\": \"18 Dec 2009\",\n    \"Runtime\": \"162 min\",\n    \"Genre\": \"Action, Adventure, Fantasy\",\n    \"Director\": \"James Cameron\",\n    \"Writer\": \"James Cameron\",\n    \"Actors\": \"Sam Worthington, Zoe Saldana, Sigourney Weaver, Stephen Lang\",\n    \"Plot\": \"A paraplegic marine dispatched to the moon Pandora on a unique mission becomes torn between following his orders and protecting the world he feels is his home.\",\n    \"Language\": \"English, Spanish\",\n    \"Country\": \"USA, UK\",\n    \"Awards\": \"Won 3 Oscars. Another 80 wins & 121 nominations.\",\n    \"Poster\": \"http://ia.media-imdb.com/images/M/MV5BMTYwOTEwNjAzMl5BMl5BanBnXkFtZTcwODc5MTUwMw@@._V1_SX300.jpg\",\n    \"Metascore\": \"83\",\n    \"imdbRating\": \"7.9\",\n    \"imdbVotes\": \"876,575\",\n    \"imdbID\": \"tt0499549\",\n    \"Type\": \"movie\",\n    \"Response\": \"True\"\n  }\n];\n\nfunction getRating(watchList){\n  // Only change code below this line\n  var averageRating;\n\n\n  // Only change code above this line\n  return averageRating;\n}\nconsole.log(getRating(watchList));",
    "editableContents": "",
    "seedEditableRegionBoundaries": [],
    "key": "indexjs"
}

ojeytonwilliams · 2022-01-07T16:57:16Z

Do you mean "key"? We can delete that, I think.

moT01

This LGTM 🎉

The only thing I found was that loading code on the beta projects doesn't update the preview. I may have solved this on the PR where I load users code. I would be fine merging with this problem.

Do we still want to drop the key?

ShaunSHamilton · 2022-01-31T12:51:11Z

I think we are fine moving forward with this, but one final check, @ojeytonwilliams ?

client/src/templates/Challenges/redux/code-storage-epic.js

ojeytonwilliams · 2022-01-31T17:37:46Z

Probably best to get rid of the key, rather than leaving it around when we know it's not necessary. I've updated the PR.

ShaunSHamilton

Thank you, Dr. Oliver!

LGTM 👍

ojeytonwilliams requested a review from as a code owner Dec 9, 2021

github-actions bot added the platform: client label Dec 9, 2021

ShaunSHamilton requested changes Dec 9, 2021

View changes

client/src/templates/Challenges/redux/code-storage-epic.js Show resolved Hide resolved

ShaunSHamilton reviewed Dec 9, 2021

View changes

client/src/templates/Challenges/redux/code-storage-epic.js Show resolved Hide resolved

ojeytonwilliams added the status: blocked label Dec 9, 2021

ojeytonwilliams changed the title ~~fix: purge invalid stored code~~ fix: update invalid stored code Dec 20, 2021

ojeytonwilliams added status: waiting review and removed status: blocked labels Dec 20, 2021

ojeytonwilliams added 6 commits Dec 20, 2021

fix: purge invalid stored code

40cffb1

fix: ugly hack to keep old stored code

03f7099

fix: hack the hack

1c1271a

fix: repair old code instead

3e043e4

Revert "fix(client): prevent load from local storage (freeCodeCamp#44440

8125acd

)" This reverts commit fca626f.

refactor: delete log

aa59fbd

ojeytonwilliams force-pushed the fix/purge-invalid-stored-code branch from 9f003ff to aa59fbd Dec 20, 2021

github-actions bot added the scope: tools/scripts label Dec 20, 2021

raisedadead requested review from ShaunSHamilton, moT01 and nhcarrigan Jan 7, 2022

raisedadead changed the title ~~fix: update invalid stored code~~ fix(client): update invalid stored code Jan 7, 2022

ShaunSHamilton previously approved these changes Jan 7, 2022

View changes

moT01 previously approved these changes Jan 25, 2022

View changes

ojeytonwilliams reviewed Jan 31, 2022

View changes

client/src/templates/Challenges/redux/code-storage-epic.js Show resolved Hide resolved

ojeytonwilliams dismissed stale reviews from moT01 and ShaunSHamilton via 1251bdf Jan 31, 2022

fix: delete old key.

1251bdf

ojeytonwilliams enabled auto-merge (squash) Jan 31, 2022

ShaunSHamilton approved these changes Jan 31, 2022

View changes

moT01 approved these changes Feb 1, 2022

View changes

ojeytonwilliams merged commit c541baf into freeCodeCamp:main Feb 1, 2022
13 checks passed

ojeytonwilliams deleted the fix/purge-invalid-stored-code branch Feb 1, 2022

freeCodeCamp / freeCodeCamp Public

fix(client): update invalid stored code #44437

fix(client): update invalid stored code #44437

ojeytonwilliams commented Dec 9, 2021 •

edited

gitpod-io bot commented Dec 9, 2021

codesee-architecture-diagrams bot commented Dec 9, 2021 •

edited

Legend

ShaunSHamilton left a comment

ojeytonwilliams commented Dec 9, 2021

raisedadead commented Dec 9, 2021

ShaunSHamilton commented Dec 9, 2021

ShaunSHamilton commented Dec 9, 2021

ojeytonwilliams commented Dec 9, 2021

ojeytonwilliams commented Dec 20, 2021

Sembauke commented Dec 20, 2021 •

edited

ojeytonwilliams commented Dec 20, 2021

ShaunSHamilton commented Dec 20, 2021

ShaunSHamilton left a comment

ojeytonwilliams commented Jan 7, 2022

moT01 left a comment

ShaunSHamilton commented Jan 31, 2022

ojeytonwilliams commented Jan 31, 2022

ShaunSHamilton left a comment

freeCodeCamp / freeCodeCamp Public

fix(client): update invalid stored code #44437

fix(client): update invalid stored code #44437

Conversation

ojeytonwilliams commented Dec 9, 2021 • edited

gitpod-io bot commented Dec 9, 2021

codesee-architecture-diagrams bot commented Dec 9, 2021 • edited

Legend

ShaunSHamilton left a comment

ojeytonwilliams commented Dec 9, 2021

raisedadead commented Dec 9, 2021

ShaunSHamilton commented Dec 9, 2021

ShaunSHamilton commented Dec 9, 2021

ojeytonwilliams commented Dec 9, 2021

ojeytonwilliams commented Dec 20, 2021

Sembauke commented Dec 20, 2021 • edited

ojeytonwilliams commented Dec 20, 2021

ShaunSHamilton commented Dec 20, 2021

ShaunSHamilton left a comment

ojeytonwilliams commented Jan 7, 2022

moT01 left a comment

ShaunSHamilton commented Jan 31, 2022

ojeytonwilliams commented Jan 31, 2022

ShaunSHamilton left a comment

ojeytonwilliams commented Dec 9, 2021 •

edited

codesee-architecture-diagrams bot commented Dec 9, 2021 •

edited

Sembauke commented Dec 20, 2021 •

edited