order of json dicts not preserved in jupyter notebooks save files

[JoranDox]

Environment data

• VS Code version: Version: 1.58.2
  Commit: c3f1263
  Date: 2021-07-14T22:30:16.440Z
  Electron: 12.0.13
  Chrome: 89.0.4389.128
  Node.js: 14.16.0
  V8: 8.9.255.25-electron.0
  OS: Linux x64 5.4.0-80-generic snap
• Jupyter Extension version (available under the Extensions sidebar): v2021.8.1054968649
• Type of virtual environment used N/A
• Jupyter server running: Local

Expected behaviour

Make a small change, see only the change in git

Actual behaviour

Make a small change, the whole file is changed according to git (order of json dict entries is suddenly changed)

Steps to reproduce:

1. change something to a notebook in git
2. see this for every cell in the notebook:
3. 

Logs

Output for Jupyter in the Output panel (View→Output, change the drop-down the upper-right of the Output panel to Jupyter)

XXX

[JoranDox]

note: if anyone else has this issue, these lines give a workaround:

import sys
import json

fname = sys.argv[1]
with open(fname) as f:
    s = f.read()
    j = json.loads(s)


with open(fname, "w") as f:
    f.write(json.dumps(j, sort_keys=True, indent=1))

use it like this (maybe make a backup first to be sure):
python sortnotebook.py notebookthatsruined.ipynb

[joyceerhl]

@DonJayamanne IIRC we used to sort the keys in the notebook JSON to avoid creating noise like this (at least for the webview implementation). We should probably continue to do that moving forward

[vscodebot]

(Experimental duplicate detection)
Thanks for submitting this issue. Please also check if it is already covered by an existing one, like:

• Notebook suggest icons are no longer colored (#128798)

[DonJayamanne]

Oh yes, looks like we aren't doing that.

[roblourens]

Is there code for this that got lost in moving to builtin? I thought I remembered that but didn't see code for it, if you point me to it I can port it over

[DonJayamanne]

Sure here you go https://github.com/microsoft/vscode-jupyter/blob/main/src/client/datascience/notebookStorage/vscNotebookModel.ts

[roblourens]

It looks like that function isn't called anywhere from vscode-jupyter though

[DonJayamanne]

sn't called anywhere from vscode-jupyter though

Yes, as Joyce mentioned we're not using it. This was used in the old custom editor.

[roblourens]

@DonJayamanne already implemented this, thanks