Preserve property order in environment editor

[develohpanda]

Closes #1046.

Added an option to keep property order by consuming json-order. This is opt-in, thus disabled by default. This behavior is available to both the workspace environment editor, and the request group override environment editor.

Field names cannot begin by $ or contain a . (as part of the nedb documentation).

As a result, the map generation uses & as the prefix and ~| as the separator. These two options are parameters in the parse and stringify methods. An example map is shown below.

const map = {
  "&": ["a"],
  "&~|a": ["z", "y"],
  "&~|a~|z": ["b"],
  "&~|a~|y~|2": ["d", "c"]
}

[develohpanda]

I'm not sure I added the dependency correctly - should json-order be under packedDependencies or dependencies?

[gschier]

I'm not sure I added the dependency correctly - should json-order be under packedDependencies or dependencies?

It should be in both. packedDependencies is a special insomnia-specific property that the build script uses to figure out whether the dependency should be bundled in the Webpack output or left as an external node module. In general, most should be bundled, but some modules don't work like that so need to be left alone.

[develohpanda]

Hmmm - I'm not sure why the CI builds are failing. I added to the packed dep but it still failed. Surely I've missed a step somewhere while adding the package 🤔

Works locally:

[gschier]

Ah, @develohpanda it's because you need to add a Flow definition to the flow-typed folder. I wish there were a way to have a better error message when that happens.

Here's a good example of one to take a look at:

https://github.com/getinsomnia/insomnia/blob/639d0cc33b0d455f43f449da1cbbe42dffa443cc/packages/insomnia-app/flow-typed/mkdirp.js

[gschier]

PR looking great! Just a couple small comments and then one about whether or not we should have the checkbox to maintain order.

[gschier]

Curious why you included the try/catch when there wasn't one before. Did you find an error case that wasn't handled?

[gschier]

Oh I see. Same thing here. I just checked the getValue function and didn't realize it was doing JSON parsing. Makes sense now 👍

[develohpanda]

@gschier ready for review again :)

[gschier]

Awesome! Just gave it a spin locally and it works great 😄