Bug/issue 271 determinism

[thescientist13]

Related Issue

resolves #271

Summary of Changes

1. Pages are tracked as read from the filesystem, and inserted into pages Array to that index, instead of asynchronously being pushed . Was trying to do something fancy like this but couldn't get it to work.
2. Documented graph return order
3. Added unit testing for data/graph.js and updated test cases to expect a specific order each time

Notes

1. had to extend Mocha glob configuration, which is making the test and test:tdd tasks a little cumbersome to maintain now. Will create a new issue for refactoring this configuration to use a mocharc.js file - see Technical/issue 293 mocha refactor #294
2. Could probably use some additional unit testing around other data files. Should probably make a new issue for that. Could also some up with a better way to capture MOCK_GRAPH

[thescientist13]

Hmm.. test is failing on CI because second-post.md is still returned before first-post.md 😞 😠

       {
      -  "Page:6d2fe63686567be": {
      +  "Page:9a4ce9aeeb41a94": {
           "__typename": "Page"
           "fileName": "second-post"
           "filePath": "./blog/second-post.md"
      -    "id": "6d2fe63686567be"
      +    "id": "9a4ce9aeeb41a94"
           "link": "/blog/second-post"
           "template": "blog"
           "title": "Blog"
         }
      -  "Page:cc38e1248273d99": {
      +  "Page:f3f1bb94286324a": {
           "__typename": "Page"
           "fileName": "first-post"
           "filePath": "./blog/first-post.md"
      -    "id": "cc38e1248273d99"
      +    "id": "f3f1bb94286324a"
           "link": "/blog/first-post"
           "template": "blog"
           "title": "Blog"
         }

[thescientist13]

So against my prior comment, the order is actually correct I think. Looking at the build The expected and actual both have second post after first post. ex.

AssertionError: expected '\n                window.__APOLLO_STATE__={"Page:cc38e1248273d99":{"id":"cc38e1248273d99","title":"Blog","link":"/blog/first-post","filePath":"./blog/first-post.md","fileName":"first-post","template":"blog","__typename":"Page"},"Page:6d2fe63686567be":{"id":"6d2fe63686567be","title":"Blog","link":"/blog/second-post","filePath":"./blog/second-post.md","fileName":"second-post","template":"blog","__typename":"Page"},"ROOT_QUERY":{"children({\\"parent\\":\\"blog\\"})":[{"type":"id","generated":false,"id":"Page:cc38e1248273d99","typename":"Page"},{"type":"id","generated":false,"id":"Page:6d2fe63686567be","typename":"Page"}],"navigation":[{"type":"id","generated":true,"id":"ROOT_QUERY.navigation.0","typename":"Navigation"}]},"ROOT_QUERY.navigation.0":{"label":"Blog","link":"/blog/","__typename":"Navigation"}};\n              ' to include 'window.__APOLLO_STATE__={"ROOT_QUERY.navigation.0":{"label":"Blog","link":"/blog/","__typename":"Navigation"},"ROOT_QUERY":{"navigation":[{"type":"id","generated":true,"id":"ROOT_QUERY.navigation.0","typename":"Navigation"}],"children({\\"parent\\":\\"blog\\"})":[{"type":"id","generated":false,"id":"Page:f3f1bb94286324a","typename":"Page"},{"type":"id","generated":false,"id":"Page:9a4ce9aeeb41a94","typename":"Page"}]},"Page:f3f1bb94286324a":{"id":"f3f1bb94286324a","title":"Blog","link":"/blog/first-post","filePath":"./blog/first-post.md","fileName":"first-post","template":"blog","__typename":"Page"},"Page:9a4ce9aeeb41a94":{"id":"9a4ce9aeeb41a94","title":"Blog","link":"/blog/second-post","filePath":"./blog/second-post.md","fileName":"second-post","template":"blog","__typename":"Page"}}'

So looking at them more closely, the issue isn't the the order, but rather the overall shape of the objects, which is something specific to GraphQL / Apollo.

---

I think I just need to relax my expectations of what is coming out of GraphQL and just leverage our unit tests more, which is the better place to capture specific APIs that our users will actually be using and not focus so much on things like Page id and hash values, as well as all the unique keys that GraphQL creates. How data comes in / out of GraphQL is more of an implementation details of our libraries.

So we should do as good as we can to validate the output in index.html, but if we go to granular, it will always just be a game of whack-a-mole. Will test for pages order, which is what we care about the most from this output.

[thescientist13]

Merging per consensus reached during the last project meeting and no standing objections / comments on this PR.