├── .editorconfig
├── .eslintrc.json
├── .github
    └── workflows
    │   ├── nlm.yml
    │   ├── node.js.yml
    │   └── npm-publish.yml
├── .gitignore
├── .nlmrc
├── .npmrc
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── example
    └── config.json
├── file-alternatives.js
├── file.js
├── http.js
├── lib
    ├── cache.js
    ├── crash-recovery.js
    ├── dir-content.js
    ├── file-alternatives.js
    ├── file.js
    ├── http.js
    ├── interval.js
    ├── latest-file.js
    ├── promise.js
    ├── safe-merge.js
    └── shared-store.js
├── package-lock.json
├── package.json
└── test
    ├── check-error.js
    ├── crash-recovery.test.js
    ├── crashing
    ├── file-alternatives.test.js
    ├── file.test.js
    ├── http.test.js
    ├── interval.test.js
    ├── latest-file.test.js
    ├── promise.test.js
    └── shared-store
        ├── error-handling.test.js
        ├── index.test.js
        ├── no-cache.test.js
        ├── retry.test.js
        └── with-cache.test.js


/.editorconfig:
--------------------------------------------------------------------------------
 1 | root = true
 2 | 
 3 | [*]
 4 | indent_style = space
 5 | indent_size = 2
 6 | charset = utf-8
 7 | trim_trailing_whitespace = true
 8 | insert_final_newline = true
 9 | 
10 | [*.md]
11 | trim_trailing_whitespace = false
12 | 


--------------------------------------------------------------------------------
/.eslintrc.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "extends": "groupon",
 3 |   "overrides": [
 4 |     {
 5 |       "files": "*.test.js",
 6 |       "env": {
 7 |         "mocha": true
 8 |       }
 9 |     }
10 |   ]
11 | }
12 | 


--------------------------------------------------------------------------------
/.github/workflows/nlm.yml:
--------------------------------------------------------------------------------
 1 | # This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
 3 | 
 4 | name: NLM
 5 | 
 6 | on:
 7 |   pull_request:
 8 | 
 9 | jobs:
10 |   tag:
11 |     runs-on: ubuntu-latest
12 | 
13 |     steps:
14 |     - uses: actions/checkout@v2
15 |       with:
16 |         fetch-depth: 0  # necessary to get full commit history
17 |     - name: Use Node.js
18 |       uses: actions/setup-node@v2
19 |       with:
20 |         node-version: 14
21 |     - run: npm ci
22 |     - run: npx nlm verify
23 |       env:
24 |         GH_TOKEN: ${{secrets.GITHUB_TOKEN}}
25 | 


--------------------------------------------------------------------------------
/.github/workflows/node.js.yml:
--------------------------------------------------------------------------------
 1 | # This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
 3 | 
 4 | name: Node.js CI
 5 | 
 6 | on:
 7 |   push:
 8 | 
 9 | jobs:
10 |   build:
11 |     runs-on: ubuntu-latest
12 | 
13 |     strategy:
14 |       matrix:
15 |         node-version: [12.x, 14.x] # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
16 | 
17 |     steps:
18 |     - uses: actions/checkout@v2
19 |     - name: Use Node.js ${{ matrix.node-version }}
20 |       uses: actions/setup-node@v2
21 |       with:
22 |         node-version: ${{ matrix.node-version }}
23 |     - run: npm ci
24 |     - run: npm run build --if-present
25 |     - run: npm test
26 | 


--------------------------------------------------------------------------------
/.github/workflows/npm-publish.yml:
--------------------------------------------------------------------------------
 1 | # This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
 3 | 
 4 | name: Publish to NPM
 5 | 
 6 | on:
 7 |   push:
 8 |     branches: [ main ]
 9 | 
10 | jobs:
11 |   build:
12 |     runs-on: ubuntu-latest
13 |     steps:
14 |       - uses: actions/checkout@v2
15 |       - uses: actions/setup-node@v2
16 |         with:
17 |           node-version: 14
18 |       - run: npm ci
19 |       - run: npm test
20 | 
21 |   publish-npm:
22 |     needs: build
23 |     runs-on: ubuntu-latest
24 |     steps:
25 |       - uses: actions/checkout@v2
26 |         with:
27 |           fetch-depth: 0
28 |       - uses: actions/setup-node@v2
29 |         with:
30 |           node-version: 14
31 |       - run: npm ci
32 |       - run: npx nlm release
33 |         env:
34 |           GH_TOKEN: ${{secrets.GITHUB_TOKEN}}
35 |           NPM_TOKEN: ${{secrets.NPM_TOKEN}}
36 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | /yarn.lock
 2 | node_modules/
 3 | /tmp
 4 | npm-debug.log
 5 | test/tmp
 6 | test/log
 7 | /.idea
 8 | /.nyc_output
 9 | /coverage
10 | 


--------------------------------------------------------------------------------
/.nlmrc:
--------------------------------------------------------------------------------
1 | [license]
2 | files[] = src
3 | 


--------------------------------------------------------------------------------
/.npmrc:
--------------------------------------------------------------------------------
1 | registry=https://registry.npmjs.org
2 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
  1 | ### v4.1.2 (2021-08-16)
  2 | <a id="v4.1.2"></a>
  3 | #### 🔼 Dependencies
  4 | 
  5 | * [#55](https://github.com/groupon/shared-store/pull/55) chore(deps): bump path-parse from 1.0.6 to 1.0.7 ([@dependabot[bot]](https://github.com/apps/dependabot))
  6 | 
  7 | 
  8 | ### v4.1.1 (2021-06-11)
  9 | <a id="v4.1.1"></a>
 10 | #### 🐛 Bug Fixes
 11 | 
 12 | * [#54](https://github.com/groupon/shared-store/pull/54) fix(yml): add .yaml extension ([@aaarichter](https://github.com/aaarichter))
 13 | 
 14 | #### 🏡 Internal
 15 | 
 16 | * [#53](https://github.com/groupon/shared-store/pull/53) ci(actions): add GitHub actions ([@aaarichter](https://github.com/aaarichter))
 17 | 
 18 | 
 19 | ### v4.1.0 (2021-04-20)
 20 | 
 21 | #### 🚀 New Features
 22 | 
 23 | * [#51](https://github.com/groupon/shared-store/pull/51) feat: support yaml ([@aaarichter](https://github.com/aaarichter)) 
 24 | 
 25 | 
 26 | ### v4.0.8 (2021-03-26)
 27 | 
 28 | #### 🏡 Internal
 29 | 
 30 | * [#50](https://github.com/groupon/shared-store/pull/50) chore: switch to main & update packages ([@aaarichter](https://github.com/aaarichter)) 
 31 | 
 32 | 
 33 | ### v4.0.7 (2021-03-15)
 34 | 
 35 | #### 🐛 Bug Fixes
 36 | 
 37 | * [#49](https://github.com/groupon/shared-store/pull/49) fix: avoid error on empty cson/json ([@aaarichter](https://github.com/aaarichter)) 
 38 | 
 39 | 
 40 | ### v4.0.6 (2021-02-17)
 41 | 
 42 | #### 🔼 Dependencies
 43 | 
 44 | * [#48](https://github.com/groupon/shared-store/pull/48) chore(deps): bump ini from 1.3.5 to 1.3.8 ([@dependabot[bot]](https://github.com/apps/dependabot)) 
 45 | 
 46 | 
 47 | ### 4.0.5 - 2020-09-03
 48 | 
 49 | * refactor: remove nodash functions & test refactor - **[@aaarichter](https://github.com/aaarichter)** [#47](https://github.com/groupon/shared-store/pull/47)
 50 |   - [`2ac79e2`](https://github.com/groupon/shared-store/commit/2ac79e2acb1c15617c1e6f09a08a8608cc4dd7d1) ♻️ **chore:** update dependencies
 51 |   - [`4ed2eb1`](https://github.com/groupon/shared-store/commit/4ed2eb14766c1d66fd3d1dc3c56a2416b7a512e4) ✅ **test:** use node assert instead of assertive
 52 |   - [`2e868e3`](https://github.com/groupon/shared-store/commit/2e868e3bfb239859d6bbcd866e0c155566f59f9e) 💚 **ci:** add node 14 to travis
 53 |   - [`d979d32`](https://github.com/groupon/shared-store/commit/d979d32198f93313d16475ad3317f424f656dcf8) ♻️ **chore:** update dependencies
 54 |   - [`9891749`](https://github.com/groupon/shared-store/commit/9891749bfbc9395b0c17db2bf002577b668f10b6) 📦️ **refactor:** remove nodash functions
 55 |   - [`779937e`](https://github.com/groupon/shared-store/commit/779937e8da8287bf9518db6c28aef322abf62687) ✅ **test:** fix test promise handling
 56 | 
 57 | 
 58 | ### 4.0.4 - 2020-07-20
 59 | 
 60 | * chore(deps): bump lodash from 4.17.15 to 4.17.19 - **[@dependabot[bot]](https://github.com/apps/dependabot)** [#45](https://github.com/groupon/shared-store/pull/45)
 61 |   - [`c468f10`](https://github.com/groupon/shared-store/commit/c468f100a06c19652df78a2179820d039ddbc1bf) **chore:** bump lodash from 4.17.15 to 4.17.19 - see: [4](- [Commits](https://github.com/lodash/lodash/compare/4)
 62 | 
 63 | 
 64 | ### 4.0.3 - 2020-05-10
 65 | 
 66 | * refactor: switch to rx-lite packages - **[@aaarichter](https://github.com/aaarichter)** [#44](https://github.com/groupon/shared-store/pull/44)
 67 |   - [`c8dc636`](https://github.com/groupon/shared-store/commit/c8dc63691e09cc02f8a421571459d907e5acb984) **refactor:** switch to rx-lite packages
 68 | 
 69 | 
 70 | ### 4.0.2 - 2020-05-06
 71 | 
 72 | * fix: set internal vars ahead of time - **[@aaarichter](https://github.com/aaarichter)** [#43](https://github.com/groupon/shared-store/pull/43)
 73 |   - [`5f7008d`](https://github.com/groupon/shared-store/commit/5f7008d214be98a2c64320973e7200beb74c863a) **fix:** set internal vars ahead of time
 74 | 
 75 | 
 76 | ### 4.0.1 - 2020-04-30
 77 | 
 78 | * chore: update package and remove unused bluebird pkg - **[@aaarichter](https://github.com/aaarichter)** [#42](https://github.com/groupon/shared-store/pull/42)
 79 |   - [`36a7c5a`](https://github.com/groupon/shared-store/commit/36a7c5a93705db5f89cd4f32d21452f47acd7d39) **chore:** update package and remove unused bluebird pkg
 80 | 
 81 | 
 82 | ### 4.0.0 - 2020-04-07
 83 | 
 84 | #### Breaking Changes
 85 | 
 86 | - drop node 8 support due to dependencies
 87 | 
 88 | *See: [`ad0263e`](https://github.com/groupon/shared-store/commit/ad0263e16033790f095d049c5699c5b728678218)*
 89 | 
 90 | #### Commits
 91 | 
 92 | * refactor: decaf, node 8 deprecation & package upgrades - **[@aaarichter](https://github.com/aaarichter)** [#41](https://github.com/groupon/shared-store/pull/41)
 93 |   - [`da08155`](https://github.com/groupon/shared-store/commit/da081559157016869b0c257ec5dad9f419536806) **refactor:** decaf /test
 94 |   - [`651472b`](https://github.com/groupon/shared-store/commit/651472b8a8e80cda33e0386f08e9a1f9ed5d273a) **refactor:** decaf /lib & improve tests
 95 |   - [`99a61da`](https://github.com/groupon/shared-store/commit/99a61dac1422f1be6ddae539ab9d3844b1d03654) **refactor:** safeMerge()
 96 |   - [`514a840`](https://github.com/groupon/shared-store/commit/514a840bb27cb30afb309a66eecec48a79e4147d) **chore:** upgrade cson-parser
 97 |   - [`ad0263e`](https://github.com/groupon/shared-store/commit/ad0263e16033790f095d049c5699c5b728678218) **chore:** drop node 8 support & upgrade mkdirp
 98 |   - [`84dcdd1`](https://github.com/groupon/shared-store/commit/84dcdd16e90829bf32c81fdd984e99487af92743) **refactor:** replace util.promisify with node promisify
 99 |   - [`15ab806`](https://github.com/groupon/shared-store/commit/15ab8061ee729d8790197408db0be37ed6b087c8) **chore:** ugprade debug
100 |   - [`9ad2792`](https://github.com/groupon/shared-store/commit/9ad27927c46be953da6b4f6fb86c4e4430326bfc) **chore:** upgrade dev dependencies
101 |   - [`dd4cdc8`](https://github.com/groupon/shared-store/commit/dd4cdc8d549b8a826a5b4f525086b226ccdcf22e) **chore:** add nyc
102 |   - [`d0971dd`](https://github.com/groupon/shared-store/commit/d0971ddaf95552eed56a1969fb93654304073df9) **refactor:** replace lodash functions
103 |   - [`a178aaf`](https://github.com/groupon/shared-store/commit/a178aaf2ec9db436e7d3e072a629e3b46a7a428b) **style:** clean code
104 |   - [`948dc19`](https://github.com/groupon/shared-store/commit/948dc1933b6c7719c2b414c1d0524e6b4fb0bc02) **chore:** upgrade to rx 4.x
105 |   - [`e168b42`](https://github.com/groupon/shared-store/commit/e168b42b3670422de90f545a62139b687ec684c3) **fix:** update travis.yml
106 |   - [`49e4f31`](https://github.com/groupon/shared-store/commit/49e4f3194ed324d1af6bb7b9bbdb0eb2e7a4555b) **docs:** update readme
107 | 
108 | 
109 | ### 3.1.1
110 | 
111 | * default `setActive()` to write cache files - **[@dbushong](https://github.com/dbushong)** [#40](https://github.com/groupon/shared-store/pull/40)
112 |   - [`70fb4ea`](https://github.com/groupon/shared-store/commit/70fb4eae8937521abe99cacde9da701dfc5bc9e9) **fix:** default `setActive()` to write cache files
113 | 
114 | 
115 | ### 3.1.0
116 | 
117 | * Allow skipping all tmp files - **[@jkrems](https://github.com/jkrems)** [#39](https://github.com/groupon/shared-store/pull/39)
118 |   - [`ebf18c1`](https://github.com/groupon/shared-store/commit/ebf18c1d39172d5710f8edc84d6e2f9cdd2841c2) **feat:** Allow skipping all tmp files
119 | 
120 | 
121 | ### 3.0.0
122 | 
123 | #### Breaking Changes
124 | 
125 | None of the methods return Bluebird promises anymore.
126 | If a consumer of this library depends on it, they need to refactor
127 | to use native promise-based solutions.
128 | 
129 | *See: [`5f22f8c`](https://github.com/groupon/shared-store/commit/5f22f8c80831e5531a4deb49d7835f7ca4f51500)*
130 | 
131 | #### Commits
132 | 
133 | * Remove bluebird dependency - **[@jkrems](https://github.com/jkrems)** [#38](https://github.com/groupon/shared-store/pull/38)
134 |   - [`5f22f8c`](https://github.com/groupon/shared-store/commit/5f22f8c80831e5531a4deb49d7835f7ca4f51500) **refactor:** Remove bluebird dependency
135 | 
136 | 
137 | ### 2.2.2
138 | 
139 | * Apply latest nlm generator - **[@markowsiak](https://github.com/markowsiak)** [#36](https://github.com/groupon/shared-store/pull/36)
140 |   - [`535aa21`](https://github.com/groupon/shared-store/commit/535aa21152e4b283d783daca04a860e8fd56feb3) **chore:** Apply latest nlm generator
141 |   - [`cf92a1e`](https://github.com/groupon/shared-store/commit/cf92a1e7b0ac80f409dc99aeb06e01a761e4e79a) **chore:** cleanup generator misses
142 | 
143 | 
144 | ### 2.2.1
145 | 
146 | * fix: properly bundle all top-level js endpoints - **[@dbushong](https://github.com/dbushong)** [#35](https://github.com/groupon/shared-store/pull/35)
147 |   - [`89ded1c`](https://github.com/groupon/shared-store/commit/89ded1c4b0344cd57cbc23091a301b407adb5cd4) **fix:** properly bundle all top-level js endpoints
148 | 
149 | 
150 | ### 2.2.0
151 | 
152 | * feat: add fileAlternativesContent() handler - **[@dbushong](https://github.com/dbushong)** [#34](https://github.com/groupon/shared-store/pull/34)
153 |   - [`0c8e56f`](https://github.com/groupon/shared-store/commit/0c8e56f16bcf30f908fe17ee9533564c8cbdbdd2) **feat:** add fileAlternativesContent() handler
154 | 
155 | 
156 | ### 2.1.4
157 | 
158 | * Gracefully handle missing dir - **[@jkrems](https://github.com/jkrems)** [#33](https://github.com/groupon/shared-store/pull/33)
159 |   - [`571d011`](https://github.com/groupon/shared-store/commit/571d011cbcd00d0065d4034ed023d7301cccc090) **fix:** Gracefully handle missing dir
160 | 
161 | 
162 | ### 2.1.3
163 | 
164 | * Consume body of 304 response - **[@jkrems](https://github.com/jkrems)** [#32](https://github.com/groupon/shared-store/pull/32)
165 |   - [`1453210`](https://github.com/groupon/shared-store/commit/145321022e7110d9509424d0b982fbb1d18c156e) **fix:** Consume body of 304 response
166 | 
167 | 
168 | ### 2.1.2
169 | 
170 | * Safer interval handling - **[@jkrems](https://github.com/jkrems)** [#31](https://github.com/groupon/shared-store/pull/31)
171 |   - [`bfb7276`](https://github.com/groupon/shared-store/commit/bfb72765ba460a2f1af73b93eb5715f222cdf0ba) **fix:** Safer interval handling
172 |   - [`4bd2ffa`](https://github.com/groupon/shared-store/commit/4bd2ffaafa666916e7e6384ab41d7479affe46cd) **test:** Pass on node 6
173 | 
174 | 
175 | ### 2.1.1
176 | 
177 | * stop emitting updates on HTTP 304s - **[@dbushong](https://github.com/dbushong)** [#30](https://github.com/groupon/shared-store/pull/30)
178 |   - [`b5ea890`](https://github.com/groupon/shared-store/commit/b5ea890801b616759577eada2257e97786a6fdf8) **perf:** stop emitting updates on HTTP 304s
179 |   - [`4d1a718`](https://github.com/groupon/shared-store/commit/4d1a7183d6fa96f1ff2c480cd37177a910e5d8b3) **chore:** update nlm & mocha; rebuild JS
180 |   - [`9a8f23b`](https://github.com/groupon/shared-store/commit/9a8f23be74eb479cb5ad7faa7fe7a24481b542e3) **chore:** update coffeelint & make code pass
181 | 
182 | 
183 | ### 2.1.0
184 | 
185 | * feat: allow switching active mode after instantiation - **[@dbushong](https://github.com/dbushong)** [#29](https://github.com/groupon/shared-store/pull/29)
186 |   - [`115352a`](https://github.com/groupon/shared-store/commit/115352aec3ec3037587fbda622f47efa6ec97581) **feat:** allow switching active mode after instantiation
187 | 
188 | 
189 | ### 2.0.3
190 | 
191 | * Apply latest nlm generator & upgrade to bluebird 3.x - **[@i-tier-bot](https://github.com/i-tier-bot)** [#28](https://github.com/groupon/shared-store/pull/28)
192 |   - [`55b3a28`](https://github.com/groupon/shared-store/commit/55b3a2878c6a6aacef08c8f94b23c5b7dc978e04) **chore:** Apply latest nlm generator
193 |   - [`cac9301`](https://github.com/groupon/shared-store/commit/cac9301c64169aefea505a957fba036f0dc54ce9) **fix:** Changes for bluebird 3
194 | 
195 | 
196 | ### 2.0.2
197 | 
198 | * Update to nlm v2 - **[@jkrems](https://github.com/jkrems)** [#27](https://github.com/groupon/shared-store/pull/27)
199 |   - [`9d61ca8`](https://github.com/groupon/shared-store/commit/9d61ca8a9720139bdfb8f8114f5ed597f5d3e05c) **chore:** Update to nlm v2
200 | 
201 | 
202 | ### 2.0.1
203 | 
204 | * fix: survive invalid json tmpfile on init() - **[@dbushong](https://github.com/dbushong)** [#26](https://github.com/groupon/shared-store/pull/26)
205 |   - [`7d5c9cc`](https://github.com/groupon/shared-store/commit/7d5c9ccae0b8f4d3ab3fed80ad29fdb90ff8c915) **fix:** survive invalid json tmpfile on init()
206 | 
207 | 
208 | ### 2.0.0
209 | 
210 | #### Breaking Changes
211 | 
212 | We are only testing against node v4 from now on.
213 | 
214 | *See: [`e782cba`](https://github.com/groupon/shared-store/commit/e782cba29798d6bd5b1913d15e4b2b6b58ee53c4)*
215 | 
216 | #### Commits
217 | 
218 | * Switch from npub to nlm - **[@jkrems](https://github.com/jkrems)** [#25](https://github.com/groupon/shared-store/pull/25)
219 |   - [`e782cba`](https://github.com/groupon/shared-store/commit/e782cba29798d6bd5b1913d15e4b2b6b58ee53c4) **chore:** Switch from npub to nlm
220 | 
221 | 
222 | 1.1.0
223 | -----
224 | * More useful parse errors for files - @jkrems
225 |   https://github.com/groupon/shared-store/pull/24
226 | 
227 | 1.0.12
228 | ------
229 | * fix to resolve store.init if cache = loaded data - @chkhoo #22
230 | 
231 | 1.0.11
232 | ------
233 | * emit correct @_options to meta - @chkhoo #20
234 | * fix when store.init errors, fetches from cache & getCurrent is null - @chkhoo #19
235 | 
236 | 1.0.10
237 | ------
238 | * fix ENOTFOUND error by intercepting init rejection - @chkhoo #18
239 | 
240 | 1.0.9
241 | -----
242 | * fix getaddrinfo ENOTFOUND by connecting only when subscribed - @chkhoo #17
243 | 
244 | 1.0.8
245 | -----
246 | * retry upon failure - @chkhoo #14
247 | 
248 | 1.0.7
249 | -----
250 | * fix fetching data from cache with init - @chkhoo #12
251 | 
252 | 1.0.6
253 | -----
254 | * fix multiple error events for single onError value - @chkhoo #11
255 | 
256 | 1.0.5
257 | -----
258 | * fix first error to store.init callback - @chkhoo #9
259 | * Put more focus on loader `options` in example - @jkrems #7
260 | * remove redundant npub tasks & Observable declarations - @chkhoo #6
261 | * fix err typo in README.md - @chkhoo #3
262 | 
263 | 1.0.4
264 | -----
265 | * Clean up license headers - @jkrems #2
266 | * Clear cache when app fails to start - @jkrems #1
267 | 


--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
  1 | <!-- Generated by generator-js -->
  2 | 
  3 | # Contributing
  4 | 
  5 | 🎉🏅 Thanks for helping us improve this project! 🙏
  6 | 
  7 | This document outlines some of the practices we care about.
  8 | If you have any questions or suggestions about the process,
  9 | feel free to [open an issue](#reporting-issues)
 10 | .
 11 | 
 12 | ## How Can I Contribute?
 13 | 
 14 | ### Reporting Issues
 15 | 
 16 | If you find any mistakes in the docs or a bug in the code,
 17 | please [open an issue in Github](https://github.com/groupon/shared-store/issues/new) so we can look into it.
 18 | You can also [create a PR](#contributing-code) fixing it yourself, or course.
 19 | 
 20 | If you report a bug, please follow these guidelines:
 21 | 
 22 | * Make sure the bug exists in the latest version.
 23 | * Include instructions on how to reproduce the issue.
 24 |   The instructions should be as minimal as possible
 25 |   and answer the three big questions:
 26 |   1. What are the exact steps you took? This includes the exact versions of node, npm, and any packages involved.
 27 |   1. What result are you expecting?
 28 |   1. What is the actual result?
 29 | 
 30 | ### Improving Documentation
 31 | 
 32 | For small documentation changes, you can use [Github's editing feature](https://help.github.com/articles/editing-files-in-another-user-s-repository/).
 33 | The only thing to keep in mind is to prefix the commit message with "docs: ".
 34 | The default commit message generated by Github will lead to a failing CI build.
 35 | 
 36 | For larger updates to the documentation
 37 | it might be better to follow the [instructions for contributing code below](#contributing-code).
 38 | 
 39 | ### Contributing Code
 40 | 
 41 | **Note:** If you're planning on making substantial changes,
 42 | please [open an issue first to discuss your idea](#reporting-issues).
 43 | Otherwise you might end up investing a lot of work
 44 | only to discover that it conflicts with plans the maintainers might have.
 45 | 
 46 | The general steps for creating a pull request are:
 47 | 
 48 | 1. Create a branch for your change.
 49 |    Always start your branch from the latest `main`.
 50 |    We often prefix the branch name with our initials, e.g. `jk-a-change`.
 51 | 1. Run `npm install` to install the dependencies.
 52 | 1. If you're fixing a bug, be sure to write a test *first*.
 53 |    That way you can validate that the test actually catches the bug and doesn't pass.
 54 | 1. Make your changes to the code.
 55 |    Remember to update the tests if you add new features or change behavior.
 56 | 1. Run the tests via `npm test`. This will also run style checks and other validations.
 57 |    You might see errors about uncommitted files.
 58 |    This is expected until you commit your changes.
 59 | 1. Once you're done, `git add .` and `git commit`.
 60 |    Please follow the [commit message conventions](#commits--commit-messages) described below.
 61 | 1. Push your branch to Github & create a PR.
 62 | 
 63 | #### Code Style
 64 | 
 65 | In addition to any linting rules the project might include,
 66 | a few general rules of thumb:
 67 | 
 68 | * Try to match the style of the rest of the code.
 69 | * We prefer simple code that is easy to understand over terse, expressive code.
 70 | * We try to structure projects by semantics instead of role.
 71 |   E.g. we'd rather have a `tree.js` module that contains tree traversal-related helpers
 72 |   than a `helpers.js` module.
 73 | * Actually, if you create helpers you might want to put those into a separate package.
 74 |   That way it's easier to reuse them.
 75 | 
 76 | #### Commits & Commit Messages
 77 | 
 78 | Please follow the [angular commit message conventions](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines).
 79 | We use an automated tool for generating releases
 80 | that depends on the conventions to determine the next version and the content of the changelog.
 81 | Commit messages that don't follow the conventions will cause `npm test` (and thus CI) to fail.
 82 | 
 83 | The short summary - a commit message should look like this:
 84 | 
 85 | ```
 86 | <type>: <subject>
 87 | 
 88 | <body>
 89 | 
 90 | <references>
 91 | 
 92 | <footer>
 93 | ```
 94 | 
 95 | Everything but the first line is optional.
 96 | The empty lines between the different parts are required.
 97 | 
 98 | * `<type>`: One of the following:
 99 |   - **feat:** Introduces a new feature. This will cause the minor version to go up.
100 |   - **fix:** A bug fix. Causes a patch version bump.
101 |   - **docs:** Changes to the documentation.
102 |     This will also cause an increase of the patch version so that the changes show up in the npm registry.
103 |   - **style:** Cleanup & lint rule fixes.
104 |     Note that often it's better to just amend the previous commit if it introduced lint errors.
105 |   - **refactor:** Changes to the code structure without fixing bugs or adding features.
106 |   - **perf:** Performance optimizations.
107 |   - **test:** Fixing existing tests or adding missing ones.
108 |     Just like with **style**, if you add tests to a feature you just introduced in the previous commit,
109 |     consider keeping the tests and the feature in the same commit instead.
110 |   - **chore:** Changes to the project setup and tools, dependency bumps, house-keeping.
111 | * `<subject>`: A [good git commit message subject](http://chris.beams.io/posts/git-commit/#limit-50).
112 |   - Keep it brief. If possible the whole first line should have at most 50 characters.
113 |   - Use imperative mood. "Create" instead of "creates" or "created".
114 |   - No period (".") at the end.
115 | * `<body>`: Motivation for the change and any context required for understanding the choices made.
116 |   Just like the subject, it should use imperative mood.
117 | * `<references>`: Any URLs relevant to the PR go here.
118 |   Use one line per URL and prefix it with the kind of relationship, e.g. "Closes: " or "See: ".
119 |   If you are referencing an issue in your commit body or PR description,
120 |   never use `#123` but the full URL to the issue or PR you are referencing.
121 |   That way the reference is easy to resolve from the git history without having to "guess" the correct link
122 |   even if the commit got cherry-picked or merged into a different project.
123 | * `<footer>`: This part only applies if your commit introduces a breaking change.
124 |   It's important this is present, otherwise the major version will not increase.
125 |   See below for an example.
126 | 
127 | ##### Examples
128 | 
129 | A feature that introduces a breaking change:
130 | 
131 | ```
132 | feat: Support --yes CLI option
133 | 
134 | For existing projects all prompts can be inferred automatically.
135 | Manual confirmation for each default provides no value in that case.
136 | 
137 | Closes https://github.com/my/project/issues/123
138 | 
139 | BREAKING CHANGE: This removes support for interactive password entry.
140 | Users will have to login beforehand.
141 | ```
142 | 
143 | A simple bug fix:
144 | 
145 | ```
146 | fix: Handle multi-byte characters in search logic
147 | ```
148 | 
149 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2015, Groupon, Inc.
 2 | All rights reserved.
 3 | 
 4 | Redistribution and use in source and binary forms, with or without
 5 | modification, are permitted provided that the following conditions
 6 | are met:
 7 | 
 8 | Redistributions of source code must retain the above copyright notice,
 9 | this list of conditions and the following disclaimer.
10 | 
11 | Redistributions in binary form must reproduce the above copyright
12 | notice, this list of conditions and the following disclaimer in the
13 | documentation and/or other materials provided with the distribution.
14 | 
15 | Neither the name of GROUPON nor the names of its contributors may be
16 | used to endorse or promote products derived from this software without
17 | specific prior written permission.
18 | 
19 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
20 | IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 | TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
22 | PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 | HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
25 | TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26 | PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | [![nlm-github](https://img.shields.io/badge/github-groupon%2Fshared--store%2Fissues-F4D03F?logo=github&logoColor=white)](https://github.com/groupon/shared-store/issues)
  2 | ![nlm-node](https://img.shields.io/badge/node-%3E%3D10.13-blue?logo=node.js&logoColor=white)
  3 | ![nlm-version](https://img.shields.io/badge/version-4.1.2-blue?logo=version&logoColor=white)
  4 | # shared-store
  5 | 
  6 | This module allows you load data from a `.json`, `.cson` or `.yml` file, URL or custom loader
  7 | function and share that data easily amongst multiple node.js worker processes.
  8 | When the data changes, the master process will load the latest changes, which
  9 | are immediately made available for all workers to consume.
 10 | 
 11 | At Groupon, this allows us to dynamically update app config in a central
 12 | system, and see those changes propagate automatically to our node.js processes
 13 | without having to restart our apps.
 14 | 
 15 | For development, engineers can change their local file-based config, and see
 16 | those changes reflected immediately.
 17 | 
 18 | Files are observed via `fs.watch` and URLs via a polling mechanism.  HTTP cache
 19 | headers are supported for optimal fetching behavior.
 20 | 
 21 | ## Install
 22 | 
 23 | ```bash
 24 | npm install --save shared-store
 25 | ```
 26 | 
 27 | ## Usage
 28 | 
 29 | The code below can be used in both master & child processes.  The master process
 30 | (i.e. `cluster.isMaster`) will run the loader; whereas the child processes will
 31 | fetch changes from the `temp` directory.
 32 | 
 33 | ```js
 34 | const SharedStore = require('shared-store');
 35 | const fileContent = require('shared-store/file');
 36 | 
 37 | const store = new SharedStore({
 38 |   temp: 'tmp/config',
 39 | 
 40 |   loader(options) {
 41 |     return fileContent(options.filename, {
 42 |       watch: true,
 43 |     });
 44 |   }
 45 | });
 46 | 
 47 | // Load the initial configuration
 48 | store.init({ filename: 'conf/application.json' })
 49 |   .then(config => {
 50 | 
 51 |     // The `config` variable was passed into the callback for convenience
 52 |     // purposes only.  If you want the latest data at any point, you can call:
 53 |     const latestConfig = store.getCurrent();
 54 | 
 55 |     const server = require('http').createServer((req, res) => {
 56 |       res.end('ok');
 57 |     }).listen(latestConfig.port);
 58 |   }).catch(err => { throw err });
 59 | ```
 60 | 
 61 | When loading fails, the store will fall back to the `temp` directory.
 62 | 
 63 | ## API
 64 | 
 65 | ### `new SharedStore({ temp, loader, active })`
 66 | 
 67 | Creates a new store, based on the given `loader`.
 68 | 
 69 | * `temp`:
 70 |   Directory to store cached versions of the data.
 71 |   This is used for handling load errors
 72 |   and for sharing data across processes.
 73 |   The directory should not contain any other files.
 74 | * `loader`:
 75 |   A function that takes `options` and returns
 76 |   an observable with the data.
 77 | * `active`:
 78 |   If this instance should actively load the data
 79 |   or just get the latest from the `temp` directory.
 80 |   Defaults to `cluster.isMaster`.
 81 | 
 82 | 
 83 | #### `store.init([ options, [ callback ] ])`
 84 | 
 85 | Sets the options that will be passed into the loader.
 86 | The promise will be resolved with the initial data.
 87 | 
 88 | Note that cached data could be returned in the callback/promise if it already
 89 | exists.
 90 | 
 91 | `SharedStore` does not interpret `options` in any way,
 92 | it is just forwarded to the loader.
 93 | 
 94 | 
 95 | #### `store.getCurrent()`
 96 | 
 97 | Get the last known version of the data.
 98 | This function is safe to call once `init` finished.
 99 | It will just return `undefined` otherwise.
100 | 
101 | #### `store.setActive(active=true)`
102 | 
103 | Enables/disables active mode (see constructor).
104 | 
105 | ### `SharedStore.safeMerge`
106 | 
107 | Random utility function to deep-merge multiple objects
108 | without mutating any of the input arguments.
109 | Very useful in loader implementations
110 | when combined with `Observable.combineLatest`.
111 | 
112 | 
113 | ### `fileContent(filename, options)`
114 | 
115 | ```js
116 | const fileContent = require('shared-store/file');
117 | ```
118 | 
119 | An observable representing the content of a file.
120 | By default, parses the content based on the extension.
121 | 
122 | Support for the following extensions is built in:
123 | 
124 | * `.json`:
125 |   Parsed using `JSON.parse`
126 | * `.cson`:
127 |   Parsed using [`CSON.parse`](https://github.com/groupon/cson-parser)
128 | * `.yml`/`.yaml`:
129 |   Parsed using [`yaml.load`](https://github.com/nodeca/js-yaml)
130 | 
131 | ##### Options
132 | 
133 | * `defaultValue`:
134 |   If the file is not found, return this value instead.
135 |   Parse errors will still cause failures.
136 | * `root`:
137 |   If provided, the filename will be resolved relative to it.
138 | * `parse`:
139 |   Function that takes a string and parses it into data.
140 |   Defaults to auto-detection from the file's extension.
141 | * `watch`: Watch file for changes, defaults to `false`.
142 | * `interval`:
143 |   Interval for checking for file changes in ms.
144 |   If provided, has to be at least 1000 (1 second).
145 |   Any value `<= 0` disables the behavior.
146 |   If `watch` is enabled, `interval` is automatically disabled.
147 |   Defaults to `0` (disabled).
148 | 
149 | ### `fileAlternativesContent([filename, ...], options)`
150 | 
151 | ```js
152 | const fileAlternativesContent = require('shared-store/file-alternatives');
153 | ```
154 | 
155 | An observable representing the content of a single file, chosen from among
156 | multiple alternatives.  All of the alternatives in the array argument are
157 | checked for existence.  Iff exactly one exists, it is passed along with
158 | `options` to `fileContent()`.  This is useful for multiple extensions:
159 | 
160 | ```js
161 | fileAlternativesContent(['some-file.cson', 'some-file.json'], options)
162 | ```
163 | 
164 | or for a legacy path location and a new path location:
165 | 
166 | ```js
167 | fileAlternativesContent([oldestPath, oldPath, currentPath], options)
168 | ```
169 | 
170 | If more than one or none of the paths exist, it is an error.
171 | 
172 | ### `httpResource({fetch, interval})`
173 | 
174 | ```js
175 | const httpResource = require('shared-store/http');
176 | ```
177 | 
178 | An observable representing a cacheable HTTP resource.
179 | Makes only minimal assumptions about how the data is fetched
180 | and focuses on handling caching.
181 | 
182 | For `interval`, see the `fileContent` options above.
183 | 
184 | ##### `fetch(headers) -> Promise({ body, response })`
185 | 
186 | The http resource will pass in cache headers
187 | that should be forwarded by the fetch implementation.
188 | `httpResource` will store `ETag` and `Last-Modified` headers
189 | in the response and pass them into subsequent requests.
190 | If `response.statusCode` is 304,
191 | the last known body will be returned.
192 | `httpResource` does not interpret the body in any way.
193 | 
194 | Example `fetch` implementation using `request`:
195 | 
196 | ```js
197 | function fetch(headers) {
198 |   return new Promise((resolve, reject) => {
199 |     request('http://my-service/config', {
200 |       headers, json: true
201 |     }, (error, response) => {
202 |       if (response && response.statusCode === 304) {
203 |         // Ignore parse errors etc. when a 304 is received
204 |         return resolve({ response });
205 |       } else if (error) {
206 |         // Forward errors
207 |         return reject(error);
208 |       }
209 |       // Default: resolve with response and body
210 |       resolve({ response, body: response.body });
211 |     });
212 |   });
213 | }
214 | ```
215 | 
216 | If you don't set an interval,
217 | handling the `headers` argument isn't necessary.
218 | 
219 | ## Events
220 | 
221 | Events are emitted on instances of the `SharedStore` class.  Most notably,
222 | error events are emitted as `'err'` and not `'error'`.  This is because
223 | unhandled `'error'` events throw, which isn't necessary when fetching fails
224 | due to HTTP connection timeouts, etc.
225 | 
226 | In this scenario, the cached copy will continue to be used until the data
227 | source is available again.
228 | 
229 | ## Tests
230 | Once you've cloned the repository, you can run:
231 | 
232 | ```bash
233 | npm run setup
234 | npm test
235 | ```
236 | 
237 | Note: `npm run setup` is the same as `npm install` except that it ensures the
238 | public npm registry is always used.
239 | 
240 | ## License
241 | ```
242 | Copyright (c) 2015, Groupon, Inc.
243 | All rights reserved.
244 | 
245 | Redistribution and use in source and binary forms, with or without
246 | modification, are permitted provided that the following conditions
247 | are met:
248 | 
249 | Redistributions of source code must retain the above copyright notice,
250 | this list of conditions and the following disclaimer.
251 | 
252 | Redistributions in binary form must reproduce the above copyright
253 | notice, this list of conditions and the following disclaimer in the
254 | documentation and/or other materials provided with the distribution.
255 | 
256 | Neither the name of GROUPON nor the names of its contributors may be
257 | used to endorse or promote products derived from this software without
258 | specific prior written permission.
259 | 
260 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
261 | IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
262 | TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
263 | PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
264 | HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
265 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
266 | TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
267 | PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
268 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
269 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
270 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
271 | ```
272 | 


--------------------------------------------------------------------------------
/example/config.json:
--------------------------------------------------------------------------------
1 | {
2 |   "fromFile": 42
3 | }
4 | 


--------------------------------------------------------------------------------
/file-alternatives.js:
--------------------------------------------------------------------------------
 1 | /*
 2 | Copyright (c) 2015, Groupon, Inc.
 3 | All rights reserved.
 4 | 
 5 | Redistribution and use in source and binary forms, with or without
 6 | modification, are permitted provided that the following conditions
 7 | are met:
 8 | 
 9 | Redistributions of source code must retain the above copyright notice,
10 | this list of conditions and the following disclaimer.
11 | 
12 | Redistributions in binary form must reproduce the above copyright
13 | notice, this list of conditions and the following disclaimer in the
14 | documentation and/or other materials provided with the distribution.
15 | 
16 | Neither the name of GROUPON nor the names of its contributors may be
17 | used to endorse or promote products derived from this software without
18 | specific prior written permission.
19 | 
20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21 | IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 | TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23 | PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 | HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
26 | TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 | PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 | */
32 | 
33 | 'use strict';
34 | 
35 | module.exports = require('./lib/file-alternatives');
36 | 


--------------------------------------------------------------------------------
/file.js:
--------------------------------------------------------------------------------
 1 | /*
 2 | Copyright (c) 2015, Groupon, Inc.
 3 | All rights reserved.
 4 | 
 5 | Redistribution and use in source and binary forms, with or without
 6 | modification, are permitted provided that the following conditions
 7 | are met:
 8 | 
 9 | Redistributions of source code must retain the above copyright notice,
10 | this list of conditions and the following disclaimer.
11 | 
12 | Redistributions in binary form must reproduce the above copyright
13 | notice, this list of conditions and the following disclaimer in the
14 | documentation and/or other materials provided with the distribution.
15 | 
16 | Neither the name of GROUPON nor the names of its contributors may be
17 | used to endorse or promote products derived from this software without
18 | specific prior written permission.
19 | 
20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21 | IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 | TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23 | PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 | HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
26 | TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 | PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 | */
32 | 
33 | 'use strict';
34 | 
35 | module.exports = require('./lib/file');
36 | 


--------------------------------------------------------------------------------
/http.js:
--------------------------------------------------------------------------------
 1 | /*
 2 | Copyright (c) 2015, Groupon, Inc.
 3 | All rights reserved.
 4 | 
 5 | Redistribution and use in source and binary forms, with or without
 6 | modification, are permitted provided that the following conditions
 7 | are met:
 8 | 
 9 | Redistributions of source code must retain the above copyright notice,
10 | this list of conditions and the following disclaimer.
11 | 
12 | Redistributions in binary form must reproduce the above copyright
13 | notice, this list of conditions and the following disclaimer in the
14 | documentation and/or other materials provided with the distribution.
15 | 
16 | Neither the name of GROUPON nor the names of its contributors may be
17 | used to endorse or promote products derived from this software without
18 | specific prior written permission.
19 | 
20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21 | IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 | TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23 | PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 | HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
26 | TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 | PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 | */
32 | 
33 | 'use strict';
34 | 
35 | module.exports = require('./lib/http');
36 | 


--------------------------------------------------------------------------------
/lib/cache.js:
--------------------------------------------------------------------------------
  1 | /*
  2 | Copyright (c) 2015, Groupon, Inc.
  3 | All rights reserved.
  4 | 
  5 | Redistribution and use in source and binary forms, with or without
  6 | modification, are permitted provided that the following conditions
  7 | are met:
  8 | 
  9 | Redistributions of source code must retain the above copyright notice,
 10 | this list of conditions and the following disclaimer.
 11 | 
 12 | Redistributions in binary form must reproduce the above copyright
 13 | notice, this list of conditions and the following disclaimer in the
 14 | documentation and/or other materials provided with the distribution.
 15 | 
 16 | Neither the name of GROUPON nor the names of its contributors may be
 17 | used to endorse or promote products derived from this software without
 18 | specific prior written permission.
 19 | 
 20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 21 | IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 22 | TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 23 | PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 24 | HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 25 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 26 | TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 27 | PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 28 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 29 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 30 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 31 | */
 32 | 
 33 | 'use strict';
 34 | 
 35 | const fs = require('fs');
 36 | 
 37 | const path = require('path');
 38 | 
 39 | const debug = require('debug')('shared-store:cache');
 40 | 
 41 | const isEqual = require('lodash.isequal');
 42 | 
 43 | const mkdirp = require('mkdirp');
 44 | 
 45 | const { Observable } = require('rx-lite-aggregates');
 46 | 
 47 | const { promisify } = require('util');
 48 | 
 49 | const crashRecovery = require('./crash-recovery');
 50 | 
 51 | const { dirContent } = require('./dir-content');
 52 | 
 53 | const latestFile = require('./latest-file');
 54 | 
 55 | const { fromPromiseFunction } = require('./promise');
 56 | 
 57 | const writeFile = promisify(fs.writeFile);
 58 | const readFile = promisify(fs.readFile);
 59 | const unlink = promisify(fs.unlink);
 60 | 
 61 | function isCacheFile({ filename }) {
 62 |   return /[\d-]+T[\d]+Z\.json/.test(filename);
 63 | }
 64 | 
 65 | function timestampName() {
 66 |   const date = new Date().toISOString().replace(/[:.]/g, '');
 67 |   return `${date}.json`;
 68 | }
 69 | 
 70 | function sortByMostRecent(files) {
 71 |   return files.sort((a, b) => b.mtime.getTime() - a.mtime.getTime());
 72 | }
 73 | 
 74 | function cleanup(tmpDir) {
 75 |   return (
 76 |     // enforce side effects
 77 |     dirContent(tmpDir, {
 78 |       watch: false,
 79 |       statFiles: true,
 80 |     })
 81 |       .filter(isCacheFile)
 82 |       .toArray()
 83 |       .flatMap(sortByMostRecent)
 84 |       .skip(5)
 85 |       .map(x => x.absolute)
 86 |       .subscribe(unlink)
 87 |   );
 88 | }
 89 | 
 90 | function readCacheFile({ absolute }) {
 91 |   return readFile(absolute)
 92 |     .then(JSON.parse)
 93 |     .then(({ data, time }) => ({
 94 |       data,
 95 |       time,
 96 |       source: absolute,
 97 |       usingCache: true,
 98 |     }));
 99 | }
100 | 
101 | function latestCacheFile(tmpDir, watch = false) {
102 |   const options = {
103 |     watch,
104 |     filter: isCacheFile,
105 |   };
106 |   return latestFile(tmpDir, options).flatMap(readCacheFile);
107 | }
108 | 
109 | function writeCache(tmpDir, changed) {
110 |   function writeIfChanged(latest) {
111 |     if (latest != null && isEqual(changed.data, latest.data)) {
112 |       debug('Latest cache file matches');
113 |       return Observable.just(latest);
114 |     } else {
115 |       const filename = path.join(tmpDir, timestampName());
116 |       debug('Writing new cache file', filename);
117 |       const serialized = JSON.stringify(changed, null, 2);
118 |       return fromPromiseFunction(() => writeFile(filename, serialized)).map(
119 |         () => changed
120 |       ); // return the data
121 |     }
122 |   }
123 | 
124 |   return Observable.fromPromise(mkdirp(tmpDir))
125 |     .flatMap(() => tryCache(tmpDir))
126 |     .defaultIfEmpty()
127 |     .flatMap(writeIfChanged)
128 |     .finally(() => cleanup(tmpDir));
129 | }
130 | 
131 | function tryCache(tmpDir) {
132 |   return latestCacheFile(tmpDir, false).catch(error => {
133 |     if (error.code === 'ENOENT') {
134 |       debug('No cache file found');
135 |       return Observable.empty();
136 |     } else if (error instanceof SyntaxError) {
137 |       debug(`Invalid cache file found: ${error.message}`);
138 |       return Observable.empty();
139 |     } else {
140 |       return Observable.throw(error);
141 |     }
142 |   });
143 | }
144 | 
145 | function activeLoader(meta, loader, tmpDir, writeCacheFiles) {
146 |   const rawData = meta.flatMapLatest(loader).map(otherData => {
147 |     otherData.usingCache = false;
148 |     return otherData;
149 |   });
150 | 
151 |   if (!writeCacheFiles) {
152 |     debug('skip writing a cache, returning raw data stream');
153 |     return rawData.distinctUntilChanged(x => x.data, isEqual).publish();
154 |   }
155 | 
156 |   debug('wrapping data stream in cache', {
157 |     tmpDir,
158 |   });
159 |   const { onDataLoaded, tearDownCrashHandler } = crashRecovery(tmpDir);
160 |   const data = rawData.tap(
161 |     onDataLoaded,
162 |     tearDownCrashHandler,
163 |     tearDownCrashHandler
164 |   );
165 |   const fromCache = tryCache(tmpDir);
166 |   return fromCache
167 |     .takeUntil(data)
168 |     .merge(data)
169 |     .distinctUntilChanged(x => x.data, isEqual)
170 |     .flatMapLatest(writeCache.bind(null, tmpDir))
171 |     .publish();
172 | }
173 | 
174 | function passiveLoader(tmpDir) {
175 |   return latestCacheFile(tmpDir, true).publish();
176 | }
177 | 
178 | function cachedLoader(meta, loader, tmpDir, active, writeCacheFiles = true) {
179 |   debug('cachedLoader(%j)', active);
180 |   loader = active
181 |     ? activeLoader(meta, loader, tmpDir, writeCacheFiles)
182 |     : passiveLoader(tmpDir);
183 |   return Observable.create(observer => {
184 |     loader.subscribe(observer);
185 |     loader.connect();
186 |   });
187 | }
188 | 
189 | module.exports = {
190 |   cachedLoader,
191 |   timestampName,
192 |   latestCacheFile,
193 | };
194 | 


--------------------------------------------------------------------------------
/lib/crash-recovery.js:
--------------------------------------------------------------------------------
 1 | /*
 2 | Copyright (c) 2015, Groupon, Inc.
 3 | All rights reserved.
 4 | 
 5 | Redistribution and use in source and binary forms, with or without
 6 | modification, are permitted provided that the following conditions
 7 | are met:
 8 | 
 9 | Redistributions of source code must retain the above copyright notice,
10 | this list of conditions and the following disclaimer.
11 | 
12 | Redistributions in binary form must reproduce the above copyright
13 | notice, this list of conditions and the following disclaimer in the
14 | documentation and/or other materials provided with the distribution.
15 | 
16 | Neither the name of GROUPON nor the names of its contributors may be
17 | used to endorse or promote products derived from this software without
18 | specific prior written permission.
19 | 
20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21 | IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 | TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23 | PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 | HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
26 | TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 | PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 | */
32 | 
33 | 'use strict';
34 | 
35 | const fs = require('fs');
36 | 
37 | const console = require('console');
38 | 
39 | const path = require('path');
40 | 
41 | function crashRecovery(tmpDir) {
42 |   function onApplicationCrashed(exitCode) {
43 |     if (exitCode === 0) {
44 |       return;
45 |     }
46 | 
47 |     console.error(`\
48 | Application crashed with current config. Resetting cache.\
49 | `);
50 | 
51 |     let files;
52 |     try {
53 |       files = fs.readdirSync(tmpDir);
54 |     } catch (error) {
55 |       console.error('Failed to read config cache directory', error.message);
56 |     }
57 | 
58 |     console.error('Trying to remove cache files', files);
59 | 
60 |     if (files == null) {
61 |       return;
62 |     }
63 | 
64 |     files.forEach(filename => {
65 |       const absolute = path.join(tmpDir, filename);
66 | 
67 |       try {
68 |         fs.unlinkSync(absolute);
69 |       } catch (error) {
70 |         console.error('Failed to reset %j', absolute, error.message);
71 |       }
72 |     });
73 |     console.error('Cache reset successful.');
74 |   }
75 | 
76 |   process.on('exit', onApplicationCrashed);
77 | 
78 |   const tearDownCrashHandler = () =>
79 |     process.removeListener('exit', onApplicationCrashed);
80 | 
81 |   const onDataLoaded = () =>
82 |     // if the app survives 5s after initial load, we believe it's fine
83 |     setTimeout(tearDownCrashHandler, 5000);
84 | 
85 |   return {
86 |     onDataLoaded,
87 |     tearDownCrashHandler,
88 |   };
89 | }
90 | 
91 | module.exports = crashRecovery;
92 | 


--------------------------------------------------------------------------------
/lib/dir-content.js:
--------------------------------------------------------------------------------
  1 | /*
  2 | Copyright (c) 2015, Groupon, Inc.
  3 | All rights reserved.
  4 | 
  5 | Redistribution and use in source and binary forms, with or without
  6 | modification, are permitted provided that the following conditions
  7 | are met:
  8 | 
  9 | Redistributions of source code must retain the above copyright notice,
 10 | this list of conditions and the following disclaimer.
 11 | 
 12 | Redistributions in binary form must reproduce the above copyright
 13 | notice, this list of conditions and the following disclaimer in the
 14 | documentation and/or other materials provided with the distribution.
 15 | 
 16 | Neither the name of GROUPON nor the names of its contributors may be
 17 | used to endorse or promote products derived from this software without
 18 | specific prior written permission.
 19 | 
 20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 21 | IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 22 | TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 23 | PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 24 | HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 25 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 26 | TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 27 | PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 28 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 29 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 30 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 31 | */
 32 | 
 33 | 'use strict';
 34 | 
 35 | const fs = require('fs');
 36 | 
 37 | const path = require('path');
 38 | 
 39 | const debug = require('debug')('shared-store:dir-content');
 40 | 
 41 | const { Observable } = require('rx-lite');
 42 | 
 43 | const { promisify } = require('util');
 44 | 
 45 | const { fromPromiseFunction } = require('./promise');
 46 | 
 47 | const stat = promisify(fs.stat);
 48 | const readdir = promisify(fs.readdir);
 49 | 
 50 | function niceStat(props, absolute) {
 51 |   return stat(absolute).then(info => ({ ...info, ...props }));
 52 | }
 53 | 
 54 | function unexpectedError(err) {
 55 |   return process.nextTick(() => {
 56 |     throw err;
 57 |   });
 58 | }
 59 | 
 60 | function dirChanges(dir, { statFiles } = {}) {
 61 |   if (statFiles == null) {
 62 |     statFiles = false;
 63 |   }
 64 | 
 65 |   return Observable.create(observer => {
 66 |     debug('Create watcher: %s', dir);
 67 |     const watcher = fs.watch(dir, {
 68 |       persistent: false,
 69 |     });
 70 |     const onNext = observer.onNext.bind(observer);
 71 |     const onError = observer.onError.bind(observer);
 72 |     watcher.on('error', onError);
 73 |     watcher.on('change', (event, filename) => {
 74 |       if (!filename) {
 75 |         return null;
 76 |       }
 77 | 
 78 |       debug('File changed (%s)', event, filename);
 79 |       const absolute = path.join(dir, filename);
 80 |       const props = {
 81 |         event,
 82 |         filename,
 83 |         absolute,
 84 |       };
 85 | 
 86 |       if (statFiles) {
 87 |         return niceStat(props, absolute)
 88 |           .then(onNext, error => {
 89 |             // This happens on file deletions and is fine.
 90 |             const { code } = error;
 91 |             debug('stat failed: %s', code, filename);
 92 | 
 93 |             if (code === 'ENOENT') {
 94 |               return;
 95 |             }
 96 | 
 97 |             onError(error);
 98 |           })
 99 |           .catch(unexpectedError);
100 |       }
101 | 
102 |       return onNext(props);
103 |     });
104 | 
105 |     function dispose() {
106 |       debug('Closing watcher: %s', dir);
107 |       return watcher.close();
108 |     }
109 | 
110 |     return dispose;
111 |   });
112 | }
113 | 
114 | function promiseMap(handler) {
115 |   return arr => Promise.all(arr.map(handler));
116 | }
117 | 
118 | function dirContent(dir, { watch, statFiles } = {}) {
119 |   if (statFiles == null) {
120 |     statFiles = false;
121 |   }
122 | 
123 |   if (watch == null) {
124 |     watch = false;
125 |   }
126 | 
127 |   const statDir = () =>
128 |     readdir(dir).then(
129 |       promiseMap(filename => {
130 |         const absolute = path.join(dir, filename);
131 |         const props = {
132 |           filename,
133 |           absolute,
134 |         };
135 | 
136 |         if (statFiles) {
137 |           return niceStat(props, absolute);
138 |         } else {
139 |           return props;
140 |         }
141 |       })
142 |     );
143 | 
144 |   const initial = fromPromiseFunction(statDir).flatMap(Observable.from);
145 | 
146 |   if (watch) {
147 |     return initial.concat(
148 |       dirChanges(dir, {
149 |         statFiles,
150 |       })
151 |     );
152 |   } else {
153 |     return initial;
154 |   }
155 | }
156 | 
157 | module.exports = { dirContent, niceStat, dirChanges };
158 | 


--------------------------------------------------------------------------------
/lib/file-alternatives.js:
--------------------------------------------------------------------------------
 1 | /*
 2 | Copyright (c) 2015, Groupon, Inc.
 3 | All rights reserved.
 4 | 
 5 | Redistribution and use in source and binary forms, with or without
 6 | modification, are permitted provided that the following conditions
 7 | are met:
 8 | 
 9 | Redistributions of source code must retain the above copyright notice,
10 | this list of conditions and the following disclaimer.
11 | 
12 | Redistributions in binary form must reproduce the above copyright
13 | notice, this list of conditions and the following disclaimer in the
14 | documentation and/or other materials provided with the distribution.
15 | 
16 | Neither the name of GROUPON nor the names of its contributors may be
17 | used to endorse or promote products derived from this software without
18 | specific prior written permission.
19 | 
20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21 | IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 | TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23 | PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 | HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
26 | TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 | PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 | */
32 | 
33 | 'use strict';
34 | 
35 | const fs = require('fs');
36 | 
37 | const path = require('path');
38 | 
39 | const debug = require('debug')('shared-store:file-alternatives');
40 | 
41 | const { Observable } = require('rx-lite');
42 | 
43 | const fileContent = require('./file');
44 | 
45 | function filterExisting(filenames, rootDir) {
46 |   return filenames.filter(filename => {
47 |     if (rootDir != null) {
48 |       filename = path.resolve(rootDir, filename);
49 |     }
50 | 
51 |     return fs.existsSync(filename);
52 |   });
53 | }
54 | 
55 | function fileAlternativesContent(filenames, options = {}) {
56 |   const { defaultValue, root: rootDir } = options;
57 | 
58 |   if (!Array.isArray(filenames)) {
59 |     filenames = [filenames];
60 |   }
61 | 
62 |   debug('checking file alternatives', filenames);
63 |   const hasDefault = defaultValue !== undefined;
64 |   const hits = filterExisting(filenames, rootDir);
65 | 
66 |   switch (hits.length) {
67 |     case 0:
68 |       debug('none found');
69 | 
70 |       if (hasDefault) {
71 |         debug('using defaultValue');
72 |         return Observable.just(defaultValue);
73 |       } else {
74 |         return Observable.throw(
75 |           new Error(`none of ${filenames.join(', ')} exist`)
76 |         );
77 |       }
78 | 
79 |     case 1:
80 |       const filename = hits[0];
81 |       debug('using %s', filename);
82 |       return fileContent(filename, options);
83 | 
84 |     default:
85 |       return Observable.throw(
86 |         new Error(`multiple file alternatives present: ${hits.join(', ')}`)
87 |       );
88 |   }
89 | }
90 | 
91 | module.exports = fileAlternativesContent;
92 | 


--------------------------------------------------------------------------------
/lib/file.js:
--------------------------------------------------------------------------------
  1 | /*
  2 | Copyright (c) 2015, Groupon, Inc.
  3 | All rights reserved.
  4 | 
  5 | Redistribution and use in source and binary forms, with or without
  6 | modification, are permitted provided that the following conditions
  7 | are met:
  8 | 
  9 | Redistributions of source code must retain the above copyright notice,
 10 | this list of conditions and the following disclaimer.
 11 | 
 12 | Redistributions in binary form must reproduce the above copyright
 13 | notice, this list of conditions and the following disclaimer in the
 14 | documentation and/or other materials provided with the distribution.
 15 | 
 16 | Neither the name of GROUPON nor the names of its contributors may be
 17 | used to endorse or promote products derived from this software without
 18 | specific prior written permission.
 19 | 
 20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 21 | IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 22 | TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 23 | PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 24 | HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 25 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 26 | TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 27 | PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 28 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 29 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 30 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 31 | */
 32 | 
 33 | 'use strict';
 34 | 
 35 | const fs = require('fs');
 36 | 
 37 | const path = require('path');
 38 | 
 39 | const CSON = require('cson-parser');
 40 | 
 41 | const yaml = require('js-yaml');
 42 | 
 43 | const debug = require('debug')('shared-store:file');
 44 | 
 45 | const { promisify } = require('util');
 46 | 
 47 | const { dirChanges } = require('./dir-content');
 48 | 
 49 | const onInterval = require('./interval');
 50 | 
 51 | const { fromPromiseFunction } = require('./promise');
 52 | 
 53 | const readFile = promisify(fs.readFile);
 54 | 
 55 | function fileChanges(filename, options) {
 56 |   return dirChanges(path.dirname(filename), options).filter(
 57 |     ({ absolute }) => absolute === filename
 58 |   );
 59 | }
 60 | 
 61 | function isMissingError(error) {
 62 |   return error.code === 'ENOENT';
 63 | }
 64 | 
 65 | function parseYML(filename, content = '') {
 66 |   if (content.trim().length === 0) return {};
 67 | 
 68 |   try {
 69 |     return yaml.load(content);
 70 |   } catch (err) {
 71 |     err.message += ` in ${filename}`;
 72 |     throw err;
 73 |   }
 74 | }
 75 | 
 76 | /**
 77 |  * @param {string} filename
 78 |  * @param {string} content
 79 |  * @returns {{}}
 80 |  */
 81 | function parseCSON(filename, content = '') {
 82 |   if (content.trim().length === 0) return {};
 83 | 
 84 |   try {
 85 |     return CSON.parse(content);
 86 |   } catch (err) {
 87 |     err.message += ` in ${filename}:${err.location.first_line + 1}`;
 88 |     throw err;
 89 |   }
 90 | }
 91 | 
 92 | /**
 93 |  * @param {string} filename
 94 |  * @param {string} content
 95 |  * @returns {{}}
 96 |  */
 97 | function parseJSON(filename, content = '') {
 98 |   if (content.trim().length === 0) return {};
 99 | 
100 |   try {
101 |     return JSON.parse(content);
102 |   } catch (err) {
103 |     err.message += ` in ${filename}`;
104 |     throw err;
105 |   }
106 | }
107 | 
108 | function parserFromExtension(filename) {
109 |   switch (path.extname(filename)) {
110 |     case '.json':
111 |       return parseJSON.bind(null, filename);
112 | 
113 |     case '.cson':
114 |       return parseCSON.bind(null, filename);
115 | 
116 |     case '.yml':
117 |     case '.yaml':
118 |       return parseYML.bind(null, filename);
119 | 
120 |     default:
121 |       return value => value;
122 |   }
123 | }
124 | 
125 | function surroundingDirExists(filename) {
126 |   try {
127 |     const dirStat = fs.statSync(path.dirname(filename));
128 |     return dirStat.isDirectory();
129 |   } catch (err) {
130 |     if (err.code !== 'ENOENT') {
131 |       throw err;
132 |     }
133 | 
134 |     return false;
135 |   }
136 | }
137 | 
138 | function tap(fn) {
139 |   return function (value) {
140 |     fn(value);
141 |     return value;
142 |   };
143 | }
144 | 
145 | function fileContent(filename, options = {}) {
146 |   const { defaultValue, watch, interval, root: rootDir } = options;
147 | 
148 |   if (rootDir != null) {
149 |     filename = path.resolve(rootDir, filename);
150 |   }
151 | 
152 |   const parse =
153 |     options.parse == null ? parserFromExtension(filename) : options.parse;
154 | 
155 |   const hasDefault = defaultValue !== undefined;
156 |   debug('fileContent, watch: %j', !!watch, filename);
157 | 
158 |   function returnDefault(error) {
159 |     if (isMissingError(error) && hasDefault) {
160 |       return defaultValue;
161 |     } else {
162 |       return Promise.reject(error);
163 |     }
164 |   }
165 | 
166 |   const loaded = content => debug('Parsing %j', content);
167 | 
168 |   const wrap = data => ({
169 |     data,
170 |     time: Date.now(),
171 |     source: filename,
172 |   });
173 | 
174 |   const load = fromPromiseFunction.bind(null, () => {
175 |     debug('readFile %s', filename);
176 |     return readFile(filename, 'utf8')
177 |       .then(tap(loaded))
178 |       .then(parse)
179 |       .then(wrap)
180 |       .catch(returnDefault);
181 |   });
182 | 
183 |   if (watch && surroundingDirExists(filename)) {
184 |     return load().concat(fileChanges(filename).flatMap(load));
185 |   } else {
186 |     return onInterval(interval, load);
187 |   }
188 | }
189 | 
190 | module.exports = fileContent;
191 | 


--------------------------------------------------------------------------------
/lib/http.js:
--------------------------------------------------------------------------------
 1 | /*
 2 | Copyright (c) 2015, Groupon, Inc.
 3 | All rights reserved.
 4 | 
 5 | Redistribution and use in source and binary forms, with or without
 6 | modification, are permitted provided that the following conditions
 7 | are met:
 8 | 
 9 | Redistributions of source code must retain the above copyright notice,
10 | this list of conditions and the following disclaimer.
11 | 
12 | Redistributions in binary form must reproduce the above copyright
13 | notice, this list of conditions and the following disclaimer in the
14 | documentation and/or other materials provided with the distribution.
15 | 
16 | Neither the name of GROUPON nor the names of its contributors may be
17 | used to endorse or promote products derived from this software without
18 | specific prior written permission.
19 | 
20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21 | IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 | TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23 | PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 | HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
26 | TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 | PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 | */
32 | 
33 | 'use strict';
34 | 
35 | const debug = require('debug')('shared-store:http');
36 | 
37 | const onInterval = require('./interval');
38 | 
39 | const { fromPromiseFunction } = require('./promise');
40 | 
41 | function httpResource({ fetch, interval }) {
42 |   let lastETag;
43 |   let lastModified;
44 |   let lastBody;
45 | 
46 |   function wrap(data, source) {
47 |     if (source == null) {
48 |       source = 'http';
49 |     }
50 | 
51 |     return {
52 |       data,
53 |       time: Date.now(),
54 |       source,
55 |     };
56 |   }
57 | 
58 |   function checkModified({ response, body, url }) {
59 |     const { headers, statusCode } = response;
60 | 
61 |     if (statusCode === 304) {
62 |       debug('cache headers match');
63 |       response.resume(); // consume the (empty) body
64 |     } else {
65 |       debug('cache header mismatch');
66 |       lastBody = wrap(body, url);
67 |       lastETag = headers.etag;
68 |       lastModified = headers['last-modified'];
69 |     }
70 | 
71 |     return lastBody;
72 |   }
73 | 
74 |   function returnLastKnown(error) {
75 |     if (lastBody != null) {
76 |       debug('Failed, return last known', error);
77 |       return lastBody;
78 |     } else {
79 |       return Promise.reject(error);
80 |     }
81 |   }
82 | 
83 |   const load = fromPromiseFunction.bind(null, () =>
84 |     fetch({
85 |       'If-None-Match': lastETag,
86 |       'If-Modified-Since': lastModified,
87 |     }).then(checkModified, returnLastKnown)
88 |   );
89 | 
90 |   return onInterval(interval, load).distinctUntilChanged(
91 |     null,
92 |     (a, b) => a === b
93 |   );
94 | }
95 | 
96 | module.exports = httpResource;
97 | 


--------------------------------------------------------------------------------
/lib/interval.js:
--------------------------------------------------------------------------------
 1 | /*
 2 | Copyright (c) 2015, Groupon, Inc.
 3 | All rights reserved.
 4 | 
 5 | Redistribution and use in source and binary forms, with or without
 6 | modification, are permitted provided that the following conditions
 7 | are met:
 8 | 
 9 | Redistributions of source code must retain the above copyright notice,
10 | this list of conditions and the following disclaimer.
11 | 
12 | Redistributions in binary form must reproduce the above copyright
13 | notice, this list of conditions and the following disclaimer in the
14 | documentation and/or other materials provided with the distribution.
15 | 
16 | Neither the name of GROUPON nor the names of its contributors may be
17 | used to endorse or promote products derived from this software without
18 | specific prior written permission.
19 | 
20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21 | IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 | TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23 | PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 | HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
26 | TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 | PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 | */
32 | 
33 | 'use strict';
34 | 
35 | const { Observable } = require('rx-lite');
36 | 
37 | function onInterval(interval, load) {
38 |   if (interval > 0) {
39 |     if (interval < 1000) {
40 |       return Observable.throw(
41 |         new Error(`Interval has to be at least 1s: ${interval}ms`)
42 |       );
43 |     } else {
44 |       return Observable.create(observer => {
45 |         let timeoutHandle;
46 |         let loadSubscription;
47 | 
48 |         function dispose() {
49 |           if (timeoutHandle) {
50 |             clearTimeout(timeoutHandle);
51 |           }
52 | 
53 |           if (loadSubscription) {
54 |             loadSubscription.dispose();
55 |           }
56 | 
57 |           loadSubscription = null;
58 |           timeoutHandle = null;
59 |         }
60 | 
61 |         function prepareNext() {
62 |           dispose();
63 |           timeoutHandle = setTimeout(runLoad, interval);
64 |         }
65 | 
66 |         function runLoad() {
67 |           dispose();
68 |           loadSubscription = load().subscribe(
69 |             observer.onNext.bind(observer),
70 |             observer.onError.bind(observer),
71 |             prepareNext
72 |           );
73 |         }
74 | 
75 |         runLoad();
76 |         return dispose;
77 |       });
78 |     }
79 |   } else {
80 |     return load();
81 |   }
82 | }
83 | 
84 | module.exports = onInterval;
85 | 


--------------------------------------------------------------------------------
/lib/latest-file.js:
--------------------------------------------------------------------------------
  1 | /*
  2 | Copyright (c) 2015, Groupon, Inc.
  3 | All rights reserved.
  4 | 
  5 | Redistribution and use in source and binary forms, with or without
  6 | modification, are permitted provided that the following conditions
  7 | are met:
  8 | 
  9 | Redistributions of source code must retain the above copyright notice,
 10 | this list of conditions and the following disclaimer.
 11 | 
 12 | Redistributions in binary form must reproduce the above copyright
 13 | notice, this list of conditions and the following disclaimer in the
 14 | documentation and/or other materials provided with the distribution.
 15 | 
 16 | Neither the name of GROUPON nor the names of its contributors may be
 17 | used to endorse or promote products derived from this software without
 18 | specific prior written permission.
 19 | 
 20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 21 | IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 22 | TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 23 | PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 24 | HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 25 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 26 | TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 27 | PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 28 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 29 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 30 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 31 | */
 32 | 
 33 | 'use strict';
 34 | 
 35 | const { Observable } = require('rx-lite-extras');
 36 | 
 37 | const { dirChanges, dirContent } = require('./dir-content');
 38 | 
 39 | const onInterval = require('./interval');
 40 | 
 41 | function mostRecent(previous, current) {
 42 |   if (current.mtime.getTime() > previous.mtime.getTime()) {
 43 |     return current;
 44 |   }
 45 | 
 46 |   return previous;
 47 | }
 48 | 
 49 | function getLatestFileInfo(dir, filter) {
 50 |   return dirContent(dir, {
 51 |     statFiles: true,
 52 |     watch: false,
 53 |   })
 54 |     .filter(filter)
 55 |     .defaultIfEmpty()
 56 |     .reduce(mostRecent)
 57 |     .flatMap(info => {
 58 |       if (info != null) {
 59 |         return Observable.just(info);
 60 |       } else {
 61 |         const err = new Error(`No file found in ${dir}`);
 62 |         err.code = 'ENOENT';
 63 |         return Observable.throw(err);
 64 |       }
 65 |     });
 66 | }
 67 | 
 68 | function getMTime({ mtime }) {
 69 |   return mtime.getTime();
 70 | }
 71 | 
 72 | function latestFile(dir, options = {}) {
 73 |   let { watch, interval, filter } = options;
 74 | 
 75 |   if (filter == null) {
 76 |     filter = () => true;
 77 |   }
 78 | 
 79 |   if (watch == null) {
 80 |     watch = false;
 81 |   }
 82 | 
 83 |   if (interval == null) {
 84 |     interval = 0;
 85 |   }
 86 | 
 87 |   const load = () => getLatestFileInfo(dir, filter);
 88 | 
 89 |   if (watch) {
 90 |     const changes = dirChanges(dir, {
 91 |       statFiles: true,
 92 |     }).filter(filter);
 93 |     return load()
 94 |       .concat(changes)
 95 |       .scan(mostRecent)
 96 |       .distinctUntilChanged(getMTime);
 97 |   } else {
 98 |     return onInterval(interval, load);
 99 |   }
100 | }
101 | 
102 | module.exports = latestFile;
103 | 


--------------------------------------------------------------------------------
/lib/promise.js:
--------------------------------------------------------------------------------
 1 | /*
 2 | Copyright (c) 2015, Groupon, Inc.
 3 | All rights reserved.
 4 | 
 5 | Redistribution and use in source and binary forms, with or without
 6 | modification, are permitted provided that the following conditions
 7 | are met:
 8 | 
 9 | Redistributions of source code must retain the above copyright notice,
10 | this list of conditions and the following disclaimer.
11 | 
12 | Redistributions in binary form must reproduce the above copyright
13 | notice, this list of conditions and the following disclaimer in the
14 | documentation and/or other materials provided with the distribution.
15 | 
16 | Neither the name of GROUPON nor the names of its contributors may be
17 | used to endorse or promote products derived from this software without
18 | specific prior written permission.
19 | 
20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21 | IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 | TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23 | PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 | HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
26 | TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 | PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 | */
32 | 
33 | 'use strict';
34 | 
35 | const { Observable } = require('rx-lite');
36 | 
37 | function unexpectedError(err) {
38 |   return process.nextTick(() => {
39 |     throw err;
40 |   });
41 | }
42 | 
43 | function fromPromiseFunction(fn) {
44 |   return Observable.create(observer => {
45 |     const p = new Promise(resolve => resolve(fn()));
46 | 
47 |     function onResolved(value) {
48 |       observer.onNext(value);
49 |       return observer.onCompleted();
50 |     }
51 | 
52 |     const onRejected = error => observer.onError(error);
53 | 
54 |     return p.then(onResolved, onRejected).catch(unexpectedError);
55 |   });
56 | }
57 | 
58 | module.exports = {
59 |   fromPromiseFunction,
60 | };
61 | 


--------------------------------------------------------------------------------
/lib/safe-merge.js:
--------------------------------------------------------------------------------
 1 | /*
 2 | Copyright (c) 2015, Groupon, Inc.
 3 | All rights reserved.
 4 | 
 5 | Redistribution and use in source and binary forms, with or without
 6 | modification, are permitted provided that the following conditions
 7 | are met:
 8 | 
 9 | Redistributions of source code must retain the above copyright notice,
10 | this list of conditions and the following disclaimer.
11 | 
12 | Redistributions in binary form must reproduce the above copyright
13 | notice, this list of conditions and the following disclaimer in the
14 | documentation and/or other materials provided with the distribution.
15 | 
16 | Neither the name of GROUPON nor the names of its contributors may be
17 | used to endorse or promote products derived from this software without
18 | specific prior written permission.
19 | 
20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21 | IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 | TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23 | PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 | HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
26 | TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 | PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 | */
32 | 
33 | 'use strict';
34 | 
35 | const merge = require('lodash.merge');
36 | 
37 | function safeMerge() {
38 |   const args = Array.from(arguments);
39 |   const data = merge({}, ...args.map(arg => arg.data));
40 |   const time = args.reduce(
41 |     (maxTime, arg) => ((arg.time || 0) > maxTime ? arg.time : maxTime),
42 |     0
43 |   );
44 |   const source = args.reduce((acc, arg) => {
45 |     if (arg.source) {
46 |       // NOTE: multiple source might not even exists. Tests contain only one source in each argument
47 |       Array.isArray(arg.source)
48 |         ? (acc = [...acc, ...arg.source])
49 |         : acc.push(arg.source);
50 |     }
51 |     return acc;
52 |   }, []);
53 | 
54 |   return {
55 |     data,
56 |     time,
57 |     source,
58 |   };
59 | }
60 | 
61 | module.exports = safeMerge;
62 | 


--------------------------------------------------------------------------------
/lib/shared-store.js:
--------------------------------------------------------------------------------
  1 | /*
  2 | Copyright (c) 2015, Groupon, Inc.
  3 | All rights reserved.
  4 | 
  5 | Redistribution and use in source and binary forms, with or without
  6 | modification, are permitted provided that the following conditions
  7 | are met:
  8 | 
  9 | Redistributions of source code must retain the above copyright notice,
 10 | this list of conditions and the following disclaimer.
 11 | 
 12 | Redistributions in binary form must reproduce the above copyright
 13 | notice, this list of conditions and the following disclaimer in the
 14 | documentation and/or other materials provided with the distribution.
 15 | 
 16 | Neither the name of GROUPON nor the names of its contributors may be
 17 | used to endorse or promote products derived from this software without
 18 | specific prior written permission.
 19 | 
 20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 21 | IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 22 | TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 23 | PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 24 | HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 25 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 26 | TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 27 | PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 28 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 29 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 30 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 31 | */
 32 | 
 33 | 'use strict';
 34 | 
 35 | const cluster = require('cluster');
 36 | 
 37 | const { EventEmitter } = require('events');
 38 | 
 39 | const path = require('path');
 40 | 
 41 | const freeze = require('deep-freeze-es6');
 42 | 
 43 | const { Observable } = require('rx-lite');
 44 | 
 45 | const { cachedLoader, latestCacheFile } = require('./cache');
 46 | 
 47 | const safeMerge = require('./safe-merge');
 48 | 
 49 | const RETRY_MULTIPLIER = 2;
 50 | const TEN_SECONDS = 1000 * 10;
 51 | const TEN_MINUTES = 1000 * 60 * 10;
 52 | 
 53 | function unexpectedError(err) {
 54 |   return process.nextTick(() => {
 55 |     throw err;
 56 |   });
 57 | }
 58 | 
 59 | function callbackify(p, callback) {
 60 |   if ('function' !== typeof callback) {
 61 |     return p;
 62 |   }
 63 | 
 64 |   return p.then(callback.bind(null, null), callback).catch(unexpectedError);
 65 | }
 66 | 
 67 | class SharedStore extends EventEmitter {
 68 |   constructor({ loader, temp, active }) {
 69 |     super();
 70 |     this._handleError = this._handleError.bind(this);
 71 |     this._handleUpdate = this._handleUpdate.bind(this);
 72 |     this._handleMetaUpdate = this._handleMetaUpdate.bind(this);
 73 |     this._retry = this._retry.bind(this);
 74 |     this._active = active != null ? active : cluster.isMaster;
 75 |     this._cache = null;
 76 |     this._writeCacheFiles = !!this._active;
 77 |     this._retryTimeout = TEN_SECONDS;
 78 |     this._temp = path.resolve(temp);
 79 | 
 80 |     if (this._temp === '/') {
 81 |       throw new Error('Refusing to use / as a tmp directory');
 82 |     }
 83 | 
 84 |     this.loader = loader;
 85 |     this._createStream();
 86 | 
 87 |     this.on('meta', this._handleMetaUpdate);
 88 |   }
 89 | 
 90 |   setActive(
 91 |     isActive = {
 92 |       writeCacheFiles: true,
 93 |     }
 94 |   ) {
 95 |     this._active = !!isActive;
 96 | 
 97 |     if (isActive && typeof isActive.writeCacheFiles === 'boolean') {
 98 |       this._writeCacheFiles = isActive.writeCacheFiles;
 99 |     }
100 | 
101 |     return this._createStream();
102 |   }
103 | 
104 |   getCurrent() {
105 |     return this._cache != null ? this._cache.data : undefined;
106 |   }
107 | 
108 |   getCurrentWithMetaData() {
109 |     return this._cache;
110 |   }
111 | 
112 |   init(options, callback) {
113 |     if (typeof options === 'function') {
114 |       callback = options;
115 |       options = {};
116 |     }
117 | 
118 |     const result = new Promise((resolve, reject) => {
119 |       if (this._cache != null) {
120 |         return resolve(this._cache.data);
121 |       }
122 | 
123 |       let handleData;
124 | 
125 |       const handleErr = err => {
126 |         this.removeListener('data', handleData);
127 |         return latestCacheFile(this._temp).subscribe(
128 |           cache => {
129 |             this._handleUpdate(cache);
130 | 
131 |             return resolve(cache.data);
132 |           },
133 |           () => reject(err)
134 |         );
135 |       };
136 | 
137 |       handleData = data => {
138 |         this.removeListener('err', handleErr);
139 |         return resolve(data);
140 |       };
141 | 
142 |       this.once('data', handleData);
143 |       return this.once('err', handleErr);
144 |     });
145 |     this.emit('meta', options);
146 |     return callbackify(result, callback);
147 |   }
148 | 
149 |   _createStream() {
150 |     if (this.subscription != null) {
151 |       this.subscription.dispose();
152 |     }
153 | 
154 |     const meta = this._createMeta();
155 | 
156 |     this.stream = cachedLoader(
157 |       meta,
158 |       this.loader,
159 |       this._temp,
160 |       this._active,
161 |       this._writeCacheFiles
162 |     );
163 |     this.subscription = this.stream.subscribe(
164 |       this._handleUpdate,
165 |       this._handleError
166 |     );
167 |     return this.subscription;
168 |   }
169 |   _createMeta() {
170 |     this._metaObserver = null;
171 |     return Observable.create(observer => {
172 |       if (this._options != null) {
173 |         observer.onNext(this._options);
174 |       }
175 | 
176 |       this._metaObserver = observer;
177 |     });
178 |   }
179 | 
180 |   _handleError(err) {
181 |     this.emit('err', err);
182 |     setTimeout(this._retry, this._retryTimeout);
183 |   }
184 | 
185 |   _handleUpdate({ data, time, source, usingCache }) {
186 |     if (usingCache === false) {
187 |       this._retryTimeout = TEN_SECONDS;
188 |     }
189 | 
190 |     this._cache = freeze({
191 |       data,
192 |       time,
193 |       source,
194 |     });
195 | 
196 |     this.emit('changed', {
197 |       isWorker: cluster.isWorker,
198 |       id: cluster.worker != null ? cluster.worker.id : undefined,
199 |     });
200 | 
201 |     this.emit('data', this._cache.data);
202 |   }
203 | 
204 |   _handleMetaUpdate(_options) {
205 |     this._options = _options;
206 |     return this._metaObserver != null
207 |       ? this._metaObserver.onNext(this._options)
208 |       : undefined;
209 |   }
210 | 
211 |   _retry() {
212 |     this._createStream();
213 | 
214 |     this.emit('meta', this._options);
215 |     this._retryTimeout *= RETRY_MULTIPLIER;
216 | 
217 |     if (this._retryTimeout > TEN_MINUTES) {
218 |       this._retryTimeout = TEN_MINUTES;
219 |     }
220 |   }
221 | }
222 | 
223 | SharedStore.safeMerge = safeMerge;
224 | module.exports = SharedStore;
225 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "shared-store",
 3 |   "version": "4.1.2",
 4 |   "description": "Keeping config data in sync",
 5 |   "license": "BSD-3-Clause",
 6 |   "main": "lib/shared-store.js",
 7 |   "homepage": "https://github.com/groupon/shared-store",
 8 |   "repository": {
 9 |     "type": "git",
10 |     "url": "https://github.com/groupon/shared-store"
11 |   },
12 |   "bugs": {
13 |     "url": "https://github.com/groupon/shared-store/issues"
14 |   },
15 |   "scripts": {
16 |     "lint": "eslint .",
17 |     "pretest": "npm run lint",
18 |     "test": "c8 mocha",
19 |     "posttest": "nlm verify"
20 |   },
21 |   "c8": {
22 |     "reporter": [
23 |       "text",
24 |       "json-summary"
25 |     ]
26 |   },
27 |   "engines": {
28 |     "node": ">=10.13"
29 |   },
30 |   "mocha": {
31 |     "recursive": true,
32 |     "exit": true
33 |   },
34 |   "nlm": {
35 |     "license": {
36 |       "files": [
37 |         "src"
38 |       ]
39 |     }
40 |   },
41 |   "dependencies": {
42 |     "cson-parser": "^4.0.9",
43 |     "debug": "^4.3.1",
44 |     "deep-freeze-es6": "^1.4.1",
45 |     "js-yaml": "^4.1.0",
46 |     "lodash.isequal": "^4.5.0",
47 |     "lodash.merge": "^4.6.2",
48 |     "mkdirp": "^1.0.4",
49 |     "rx-lite": "^4.0.8",
50 |     "rx-lite-aggregates": "^4.0.8",
51 |     "rx-lite-extras": "^4.0.8"
52 |   },
53 |   "devDependencies": {
54 |     "@types/rx-lite": "^4.0.6",
55 |     "@types/rx-lite-aggregates": "^4.0.3",
56 |     "c8": "^7.7.2",
57 |     "eslint": "^7.28.0",
58 |     "eslint-config-groupon": "^10.0.4",
59 |     "eslint-plugin-import": "^2.23.4",
60 |     "eslint-plugin-mocha": "^9.0.0",
61 |     "eslint-plugin-node": "^11.1.0",
62 |     "eslint-plugin-prettier": "^3.4.0",
63 |     "mocha": "^9.0.0",
64 |     "nlm": "^5.5.1",
65 |     "prettier": "^2.3.1",
66 |     "rimraf": "^3.0.2",
67 |     "tmp": "^0.2.1"
68 |   },
69 |   "author": {
70 |     "name": "Groupon",
71 |     "email": "opensource@groupon.com"
72 |   },
73 |   "keywords": [
74 |     "observable",
75 |     "reactive"
76 |   ],
77 |   "files": [
78 |     "lib",
79 |     "*.js"
80 |   ],
81 |   "publishConfig": {
82 |     "registry": "https://registry.npmjs.org"
83 |   }
84 | }
85 | 


--------------------------------------------------------------------------------
/test/check-error.js:
--------------------------------------------------------------------------------
 1 | 'use strict';
 2 | 
 3 | const assert = require('assert');
 4 | 
 5 | const { Observable } = require('rx-lite');
 6 | 
 7 | /**
 8 |  *
 9 |  * @param {Rx.Observable} observable
10 |  * @param {function} fn
11 |  * @returns {Rx.IPromise<void>}
12 |  */
13 | function checkError(observable, fn) {
14 |   const OK = {};
15 |   return observable
16 |     .catch(err => {
17 |       fn(err);
18 |       return Observable.just(OK);
19 |     })
20 |     .toPromise()
21 |     .then(value => {
22 |       assert.deepStrictEqual(value, OK);
23 |     });
24 | }
25 | 
26 | module.exports = checkError;
27 | 


--------------------------------------------------------------------------------
/test/crash-recovery.test.js:
--------------------------------------------------------------------------------
  1 | 'use strict';
  2 | 
  3 | const childProcess = require('child_process');
  4 | 
  5 | const fs = require('fs');
  6 | 
  7 | const assert = require('assert');
  8 | 
  9 | const tmp = require('tmp');
 10 | 
 11 | const { promisify } = require('util');
 12 | 
 13 | const { timestampName } = require('../lib/cache');
 14 | 
 15 | const writeFile = promisify(fs.writeFile);
 16 | 
 17 | function execFile(...args) {
 18 |   return new Promise((resolve, reject) => {
 19 |     childProcess.execFile(...Array.from(args), (err, stdout, stderr) => {
 20 |       if (err) {
 21 |         return reject(err);
 22 |       }
 23 | 
 24 |       return resolve({
 25 |         stdout,
 26 |         stderr,
 27 |       });
 28 |     });
 29 |   });
 30 | }
 31 | 
 32 | const childPath = `${__dirname}/crashing`;
 33 | 
 34 | function unexpected() {
 35 |   throw new Error('Unexpected success');
 36 | }
 37 | 
 38 | describe('Crash recovery', () => {
 39 |   before(function (done) {
 40 |     process.setMaxListeners(99); // repeated process.on('exit') blab warnings
 41 | 
 42 |     tmp.dir(
 43 |       {
 44 |         unsafeCleanup: true,
 45 |       },
 46 |       (err, tmpDir) => {
 47 |         this.tmpDir = tmpDir;
 48 |         done(err);
 49 |       }
 50 |     );
 51 |   });
 52 |   before(function () {
 53 |     // Write known broken config
 54 |     const brokenCache = JSON.stringify(
 55 |       {
 56 |         data: {
 57 |           crashing: true,
 58 |         },
 59 |       },
 60 |       null,
 61 |       2
 62 |     );
 63 |     return writeFile(`${this.tmpDir}/${timestampName()}`, brokenCache);
 64 |   });
 65 | 
 66 |   it('crashes initially', function () {
 67 |     return execFile(childPath, [this.tmpDir]).then(unexpected, error => {
 68 |       assert.ok(error.message.includes('Error: Expected crash'));
 69 |       assert.ok(error.message.includes('Cache reset successful'));
 70 |     });
 71 |   });
 72 | 
 73 |   it('succeeds on retry', function () {
 74 |     return execFile(childPath, [this.tmpDir]).then(({ stdout, stderr }) => {
 75 |       assert.strictEqual(stderr, '');
 76 |       assert.strictEqual(stdout, 'ok\n');
 77 |     });
 78 |   });
 79 | });
 80 | describe('Crash avoidance', () => {
 81 |   before(function (done) {
 82 |     process.setMaxListeners(99); // repeated process.on('exit') blab warnings
 83 | 
 84 |     tmp.dir(
 85 |       {
 86 |         unsafeCleanup: true,
 87 |       },
 88 |       (err, tmpDir) => {
 89 |         this.tmpDir = tmpDir;
 90 |         done(err);
 91 |       }
 92 |     );
 93 |   });
 94 |   before(function () {
 95 |     // Write invalid JSON config
 96 |     const badJSON = '{';
 97 |     return writeFile(`${this.tmpDir}/${timestampName()}`, badJSON);
 98 |   });
 99 | 
100 |   it('starts up anyway', function () {
101 |     const env = {
102 |       DEBUG: 'shared-store:cache',
103 | 
104 |       ...process.env,
105 |     };
106 |     return execFile(childPath, [this.tmpDir], {
107 |       env,
108 |     }).then(({ stdout }) => {
109 |       assert.strictEqual(stdout, 'ok\n');
110 |     });
111 |   });
112 | });
113 | 


--------------------------------------------------------------------------------
/test/crashing:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env node
 2 | 
 3 | 'use strict';
 4 | 
 5 | const SharedStore = require('../');
 6 | const httpResource = require('../lib/http');
 7 | 
 8 | function fetchData(headers) {
 9 |   return Promise.resolve({
10 |     url: 'http://my-url',
11 |     response: {
12 |       headers: {
13 |         'last-modified': new Date().toString(),
14 |         etag: 'some-etag',
15 |       },
16 |     },
17 |     body: { incoming: headers, crashing: false },
18 |   }).then(value => {
19 |     return new Promise(resolve => {
20 |       // delay to ensure temp reads are faster
21 |       setTimeout(resolve, 1000, value);
22 |     });
23 |   });
24 | }
25 | 
26 | const options = {
27 |   temp: process.argv[2],
28 |   active: true,
29 |   loader() {
30 |     return httpResource({ fetch: fetchData });
31 |   },
32 | };
33 | 
34 | function unexpectedError(err) {
35 |   process.nextTick(() => {
36 |     throw err;
37 |   });
38 | }
39 | 
40 | new SharedStore(options)
41 |   .init({})
42 |   .then(config => {
43 |     if (config.crashing) {
44 |       throw new Error('Expected crash');
45 |     } else {
46 |       // eslint-disable-next-line no-console
47 |       console.log('ok');
48 |       // eslint-disable-next-line no-process-exit
49 |       process.exit(0);
50 |     }
51 |   })
52 |   .catch(unexpectedError);
53 | 


--------------------------------------------------------------------------------
/test/file-alternatives.test.js:
--------------------------------------------------------------------------------
  1 | 'use strict';
  2 | 
  3 | const fs = require('fs');
  4 | 
  5 | const os = require('os');
  6 | 
  7 | const path = require('path');
  8 | 
  9 | const assert = require('assert');
 10 | 
 11 | const { promisify } = require('util');
 12 | 
 13 | const fileAlternativesContent = require('../lib/file-alternatives');
 14 | 
 15 | const checkError = require('./check-error');
 16 | 
 17 | const writeFile = promisify(fs.writeFile);
 18 | 
 19 | describe('fileAlternativesContent', () => {
 20 |   it('is a function', () => {
 21 |     assert.strictEqual(typeof fileAlternativesContent, 'function');
 22 |   });
 23 | 
 24 |   describe('for no existing files', () => {
 25 |     it('fails with no defaultValue', async () => {
 26 |       const filename = path.join(os.tmpdir(), 'missing.json');
 27 |       await checkError(
 28 |         fileAlternativesContent([filename], {
 29 |           watch: false,
 30 |         }),
 31 |         error => {
 32 |           assert.ok(error.message.includes('none of'));
 33 |         }
 34 |       );
 35 |     });
 36 | 
 37 |     it('returns a defaultValue', () => {
 38 |       const defaultValue = {};
 39 |       return fileAlternativesContent([], {
 40 |         watch: false,
 41 |         defaultValue,
 42 |       })
 43 |         .take(1)
 44 |         .toPromise()
 45 |         .then(data => {
 46 |           assert.strictEqual(data, defaultValue);
 47 |         });
 48 |     });
 49 |   });
 50 | 
 51 |   describe('for a single existing file', () => {
 52 |     before(function () {
 53 |       this.filename = path.join(os.tmpdir(), 'some-file.json');
 54 |       this.initialContent = {
 55 |         initial: 'state',
 56 |       };
 57 |       return writeFile(this.filename, JSON.stringify(this.initialContent));
 58 |     });
 59 | 
 60 |     it('accepts a string', function () {
 61 |       return fileAlternativesContent(this.filename, {
 62 |         watch: false,
 63 |       })
 64 |         .take(1)
 65 |         .toPromise()
 66 |         .then(({ data }) => {
 67 |           assert.deepStrictEqual(data, this.initialContent);
 68 |         });
 69 |     });
 70 | 
 71 |     it('accepts an array with only one existing file', function () {
 72 |       const bogus = path.join(os.tmpdir(), 'missing.json');
 73 |       return fileAlternativesContent([bogus, this.filename], {
 74 |         watch: false,
 75 |       })
 76 |         .take(1)
 77 |         .toPromise()
 78 |         .then(({ data }) => {
 79 |           assert.deepStrictEqual(data, this.initialContent);
 80 |         });
 81 |     });
 82 |   });
 83 | 
 84 |   describe('for multiple existing files', () => {
 85 |     before(function () {
 86 |       this.filename1 = path.join(os.tmpdir(), 'some-file.json');
 87 |       this.filename2 = path.join(os.tmpdir(), 'other-file.json');
 88 |       this.initialContent = {
 89 |         initial: 'state',
 90 |       };
 91 |       return Promise.all(
 92 |         [this.filename1, this.filename2].map(filename => {
 93 |           return writeFile(filename, JSON.stringify(this.initialContent));
 94 |         })
 95 |       );
 96 |     });
 97 | 
 98 |     it('dies horribly', async function () {
 99 |       await checkError(
100 |         fileAlternativesContent([this.filename1, this.filename2], {
101 |           watch: false,
102 |         }),
103 |         error => {
104 |           assert.ok(error.message.includes('multiple'));
105 |         }
106 |       );
107 |     });
108 |   });
109 | });
110 | 


--------------------------------------------------------------------------------
/test/file.test.js:
--------------------------------------------------------------------------------
  1 | 'use strict';
  2 | 
  3 | const fs = require('fs');
  4 | 
  5 | const os = require('os');
  6 | 
  7 | const path = require('path');
  8 | 
  9 | const assert = require('assert');
 10 | 
 11 | const CSON = require('cson-parser');
 12 | 
 13 | const yaml = require('js-yaml');
 14 | 
 15 | const { promisify } = require('util');
 16 | 
 17 | const fileContent = require('../lib/file');
 18 | 
 19 | const checkError = require('./check-error');
 20 | 
 21 | const writeFile = promisify(fs.writeFile);
 22 | 
 23 | describe('fileContent', () => {
 24 |   it('is a function', () => {
 25 |     assert.strictEqual(typeof fileContent, 'function');
 26 |   });
 27 | 
 28 |   it('fails when the file does not exist', async () => {
 29 |     const filename = path.join(os.tmpdir(), 'missing.json');
 30 |     await checkError(
 31 |       fileContent(filename, {
 32 |         watch: false,
 33 |       }),
 34 |       error => {
 35 |         assert.strictEqual(error.code, 'ENOENT');
 36 |       }
 37 |     );
 38 |   });
 39 | 
 40 |   describe('supported file types', () => {
 41 |     const testCases = [
 42 |       ['.cson', CSON.stringify, [null, 2]],
 43 |       ['.json', JSON.stringify, [null, 2]],
 44 |       ['.yml', yaml.dump],
 45 |       ['.yaml', yaml.dump],
 46 |     ];
 47 | 
 48 |     for (const testCase of testCases) {
 49 |       const [fileType, writer, writerArgs = []] = testCase;
 50 | 
 51 |       describe(fileType, () => {
 52 |         let filename;
 53 |         let initialContent;
 54 |         beforeEach(() => {
 55 |           filename = path.join(os.tmpdir(), `some-file${fileType}`);
 56 |           initialContent = {
 57 |             initial: 'state',
 58 |           };
 59 |           return writeFile(filename, writer(initialContent, ...writerArgs));
 60 |         });
 61 | 
 62 |         it('returns the parsed content', async () => {
 63 |           const { data } = await fileContent(filename, {
 64 |             watch: false,
 65 |           }).toPromise();
 66 | 
 67 |           assert.deepStrictEqual(data, initialContent);
 68 |         });
 69 | 
 70 |         it("doesn't throw on an empty file", async () => {
 71 |           filename = path.join(os.tmpdir(), `some-file${fileType}`);
 72 |           await writeFile(filename, '');
 73 | 
 74 |           const { data } = await fileContent(filename, {
 75 |             watch: false,
 76 |           }).toPromise();
 77 | 
 78 |           assert.deepStrictEqual(data, {});
 79 |         });
 80 | 
 81 |         it("doesn't throw on a file with newline chars", async () => {
 82 |           filename = path.join(os.tmpdir(), `some-file${fileType}`);
 83 |           await writeFile(filename, '\n\n'); // when folks delete newline chars might remain
 84 | 
 85 |           const { data } = await fileContent(filename, {
 86 |             watch: false,
 87 |           }).toPromise();
 88 | 
 89 |           assert.deepStrictEqual(data, {});
 90 |         });
 91 | 
 92 |         describe('after changing the file', () => {
 93 |           let content;
 94 |           let connection;
 95 |           let changed;
 96 |           let updated;
 97 | 
 98 |           beforeEach(() => {
 99 |             content = fileContent(filename, {
100 |               watch: true,
101 |             }).publish();
102 |             connection = content.connect();
103 |             return content.take(1).toPromise();
104 |           }); // Skip initial
105 | 
106 |           beforeEach(() => {
107 |             changed = content.take(1).toPromise();
108 |             updated = {
109 |               updated: 'content',
110 |             };
111 |             return writeFile(filename, writer(updated, ...writerArgs));
112 |           });
113 | 
114 |           afterEach(() => {
115 |             if (connection) {
116 |               connection.dispose();
117 |             }
118 |           });
119 | 
120 |           it('returns the updated content', async () => {
121 |             const { data } = await changed;
122 | 
123 |             assert.deepStrictEqual(data, updated);
124 |           });
125 |         });
126 |       });
127 |     }
128 |   });
129 | 
130 |   describe('when the surrounding dir does not exist', () => {
131 |     before(function () {
132 |       this.filename = path.join(os.tmpdir(), 'not-a-dir', 'some-file.cson');
133 |     });
134 | 
135 |     it('does not fail, just ignores the watch', function () {
136 |       return fileContent(this.filename, {
137 |         watch: true,
138 |         defaultValue: 42,
139 |       })
140 |         .take(2)
141 |         .toPromise()
142 |         .then(result => {
143 |           assert.strictEqual(result, 42);
144 |         });
145 |     });
146 |   });
147 | 
148 |   describe('a CSON file with syntax errors', () => {
149 |     before(function () {
150 |       this.filename = path.join(os.tmpdir(), 'some-file.cson'); // The content is missing a closing quote after Hello
151 | 
152 |       return writeFile(
153 |         this.filename,
154 |         'x: 10\nfoo: 13\nbar: "Hello\nzapp: 42\n'
155 |       );
156 |     });
157 | 
158 |     it('fails with a helpful error message', async function () {
159 |       await checkError(
160 |         fileContent(this.filename, {
161 |           watch: false,
162 |         }),
163 |         error => {
164 |           assert.strictEqual(error.name, 'SyntaxError');
165 |           assert.ok(error.message.includes('missing "'));
166 |           assert.ok(error.message.includes(`in ${this.filename}:3`));
167 |         }
168 |       );
169 |     });
170 |   });
171 | 
172 |   describe('a JSON file with syntax errors', () => {
173 |     before(function () {
174 |       this.filename = path.join(os.tmpdir(), 'some-file.json'); // The content is missing a comma after 42
175 | 
176 |       return writeFile(this.filename, '{\n  "foo": 42\n  "bar": 13\n}\n');
177 |     });
178 | 
179 |     it('fails with a helpful error message', async function () {
180 |       await checkError(
181 |         fileContent(this.filename, {
182 |           watch: false,
183 |         }),
184 |         error => {
185 |           assert.strictEqual(error.name, 'SyntaxError');
186 |           assert.ok(error.message.includes('Unexpected string'));
187 |           assert.ok(error.message.includes(`in ${this.filename}`));
188 |         }
189 |       );
190 |     });
191 |   });
192 | });
193 | 


--------------------------------------------------------------------------------
/test/http.test.js:
--------------------------------------------------------------------------------
 1 | 'use strict';
 2 | 
 3 | const assert = require('assert');
 4 | 
 5 | const httpResource = require('../lib/http');
 6 | 
 7 | const checkError = require('./check-error');
 8 | 
 9 | const MODIFIED_SINCE = 'If-Modified-Since';
10 | const NONE_MATCH = 'If-None-Match';
11 | 
12 | describe('httpResource', () => {
13 |   it('is a function', () => {
14 |     assert.strictEqual(typeof httpResource, 'function');
15 |   });
16 | 
17 |   describe('unavailable resource', () => {
18 |     beforeEach(function () {
19 |       this.resource = httpResource({
20 |         fetch() {
21 |           return Promise.reject(new Error('Fetch failed'));
22 |         },
23 |       });
24 |     });
25 | 
26 |     it('forwards the error', async function () {
27 |       await checkError(this.resource, error => {
28 |         assert.strictEqual(error.message, 'Fetch failed');
29 |       });
30 |     });
31 |   });
32 | 
33 |   describe('successful fetch', () => {
34 |     const LAST_MODIFIED = new Date().toString();
35 |     const ETAG = 'some-etag';
36 | 
37 |     beforeEach(function () {
38 |       this.fetchCount = 0;
39 |       this.resource = httpResource({
40 |         fetch: headers => {
41 |           ++this.fetchCount;
42 |           return Promise.resolve({
43 |             url: 'http://my-url',
44 |             response: {
45 |               headers: {
46 |                 'last-modified': LAST_MODIFIED,
47 |                 etag: 'some-etag',
48 |               },
49 |             },
50 |             body: {
51 |               incoming: headers,
52 |             },
53 |           });
54 |         },
55 |         interval: 1000,
56 |       });
57 |     });
58 | 
59 |     it('succeeds and fetched once', function () {
60 |       return this.resource
61 |         .take(1)
62 |         .toPromise()
63 |         .then(({ data }) => {
64 |           assert.strictEqual(data.incoming[NONE_MATCH], undefined);
65 |           assert.strictEqual(data.incoming[MODIFIED_SINCE], undefined);
66 |           assert.strictEqual(this.fetchCount, 1);
67 |         });
68 |     });
69 | 
70 |     it('includes the url as the source', function () {
71 |       return this.resource
72 |         .take(1)
73 |         .toPromise()
74 |         .then(({ source }) => {
75 |           assert.strictEqual(source, 'http://my-url');
76 |         });
77 |     });
78 | 
79 |     it('sends ETag and modified the second time around', function () {
80 |       this.slow(1500);
81 |       return this.resource
82 |         .take(2)
83 |         .toPromise()
84 |         .then(({ data }) => {
85 |           assert.strictEqual(data.incoming[NONE_MATCH], ETAG);
86 |           assert.strictEqual(data.incoming[MODIFIED_SINCE], LAST_MODIFIED);
87 |           assert.strictEqual(this.fetchCount, 2);
88 |         });
89 |     });
90 |   });
91 | });
92 | 


--------------------------------------------------------------------------------
/test/interval.test.js:
--------------------------------------------------------------------------------
 1 | 'use strict';
 2 | 
 3 | const assert = require('assert');
 4 | 
 5 | const { Observable } = require('rx-lite');
 6 | 
 7 | const onInterval = require('../lib/interval');
 8 | 
 9 | const checkError = require('./check-error');
10 | 
11 | const LOAD_SUCCESS = {};
12 | 
13 | function loadSuccess() {
14 |   return Observable.just(LOAD_SUCCESS);
15 | }
16 | 
17 | describe('onInterval', () => {
18 |   it('is a function', () => {
19 |     assert.strictEqual(typeof onInterval, 'function');
20 |   });
21 | 
22 |   describe('interval < 1s', () => {
23 |     it('fails', async () => {
24 |       const observable = onInterval(999, loadSuccess);
25 |       await checkError(observable, err => {
26 |         assert.strictEqual(
27 |           err.message,
28 |           `\
29 | Interval has to be at least 1s: 999ms\
30 | `
31 |         );
32 |       });
33 |     });
34 |   });
35 | 
36 |   describe('interval is falsey', () => {
37 |     const verifyOne = observable =>
38 |       observable
39 |         .toArray()
40 |         .toPromise()
41 |         .then(values => {
42 |           assert.strictEqual(values.length, 1);
43 |           assert.strictEqual(values[0], LOAD_SUCCESS);
44 |         });
45 | 
46 |     it('returns one value only for interval = 0', () =>
47 |       verifyOne(onInterval(0, loadSuccess)));
48 | 
49 |     it('returns one value for negative interval', () =>
50 |       verifyOne(onInterval(-1, loadSuccess)));
51 | 
52 |     it('returns one value for interval = false', () =>
53 |       verifyOne(onInterval(false, loadSuccess)));
54 | 
55 |     it('returns one value for interval = undefined', () =>
56 |       verifyOne(onInterval(undefined, loadSuccess)));
57 |   });
58 | 
59 |   describe('interval >= 1s', () => {
60 |     function loadIncremental() {
61 |       let current = 0;
62 |       return () => Observable.just(current++);
63 |     }
64 | 
65 |     it('loads the first value immediately', async () => {
66 |       const start = Date.now();
67 |       const value = await onInterval(1000, loadIncremental())
68 |         .take(1)
69 |         .toPromise();
70 | 
71 |       assert.strictEqual(value, 0);
72 |       assert.ok(Date.now() - start < 50, `took <<< 1s`);
73 |     });
74 | 
75 |     it('loads one value per second', async function () {
76 |       this.timeout(2100);
77 |       this.slow(2050);
78 |       const start = Date.now();
79 |       const values = await onInterval(1000, loadIncremental())
80 |         .take(3)
81 |         .toArray()
82 |         .toPromise();
83 | 
84 |       assert.deepStrictEqual(values, [0, 1, 2]); // 1st: immediate, 2nd: 1s, 3rd: 2s
85 |       assert.ok(Date.now() - start >= 2000, `took >= 2s`);
86 |     });
87 |   });
88 | });
89 | 


--------------------------------------------------------------------------------
/test/latest-file.test.js:
--------------------------------------------------------------------------------
  1 | 'use strict';
  2 | 
  3 | const fs = require('fs');
  4 | 
  5 | const os = require('os');
  6 | 
  7 | const path = require('path');
  8 | 
  9 | const assert = require('assert');
 10 | 
 11 | const mkdirp = require('mkdirp');
 12 | 
 13 | const rimraf = require('rimraf');
 14 | 
 15 | const { promisify } = require('util');
 16 | 
 17 | const latestFile = require('../lib/latest-file');
 18 | 
 19 | const checkError = require('./check-error');
 20 | 
 21 | const writeFile = promisify(fs.writeFile);
 22 | const DIR_NAME = 'shared-store-latest-file-test';
 23 | 
 24 | function delay(ms) {
 25 |   return new Promise(resolve => setTimeout(resolve, ms));
 26 | }
 27 | 
 28 | function dotJSON({ filename }) {
 29 |   return /\.json$/.test(filename);
 30 | }
 31 | 
 32 | describe('latestFile', () => {
 33 |   it('is a function', () => {
 34 |     assert.strictEqual(typeof latestFile, 'function');
 35 |   });
 36 | 
 37 |   before(function (done) {
 38 |     this.dir = path.join(os.tmpdir(), DIR_NAME);
 39 |     rimraf(this.dir, () => {
 40 |       done();
 41 |     });
 42 |   });
 43 | 
 44 |   describe('with non-existant directory', () => {
 45 |     before(function () {
 46 |       this.resource = latestFile(this.dir, {
 47 |         watch: false,
 48 |         filter: dotJSON,
 49 |       });
 50 |     });
 51 | 
 52 |     it('fails', async function () {
 53 |       await checkError(this.resource, error => {
 54 |         assert.strictEqual(error.code, 'ENOENT');
 55 |       });
 56 |     });
 57 |   });
 58 | 
 59 |   describe('an existing directory', () => {
 60 |     before(function () {
 61 |       return mkdirp(this.dir);
 62 |     });
 63 | 
 64 |     describe('without any files', () => {
 65 |       before(function () {
 66 |         this.resource = latestFile(this.dir, {
 67 |           watch: false,
 68 |           filter: dotJSON,
 69 |         });
 70 |       });
 71 | 
 72 |       it('fails', async function () {
 73 |         await checkError(this.resource, error => {
 74 |           assert.strictEqual(error.code, 'ENOENT');
 75 |         });
 76 |       });
 77 |     });
 78 | 
 79 |     describe('with two files', () => {
 80 |       before(function () {
 81 |         this.timeout(3000);
 82 | 
 83 |         const writeTestFile = filename => {
 84 |           const absolute = path.join(this.dir, filename);
 85 |           const content = JSON.stringify({
 86 |             filename,
 87 |           }); // delay to ensure different mtime
 88 | 
 89 |           return writeFile(absolute, content).then(() => delay(1050));
 90 |         };
 91 | 
 92 |         return writeTestFile('first.json').then(
 93 |           writeTestFile.bind(null, 'second.json')
 94 |         );
 95 |       });
 96 | 
 97 |       before(function () {
 98 |         this.resource = latestFile(this.dir, {
 99 |           watch: true,
100 |           filter: dotJSON,
101 |         }).publish();
102 |         this._connection = this.resource.connect();
103 |       });
104 | 
105 |       after(function () {
106 |         if (this._connection != null) {
107 |           this._connection.dispose();
108 |         }
109 |       });
110 | 
111 |       before(function () {
112 |         return this.resource
113 |           .take(1)
114 |           .toPromise()
115 |           .then(firstFile => {
116 |             this.firstFile = firstFile;
117 |           });
118 |       });
119 | 
120 |       it('emits the second (latest) file only', function () {
121 |         assert.strictEqual(this.firstFile.filename, 'second.json');
122 |       });
123 | 
124 |       describe('with an additional file', () => {
125 |         before(function () {
126 |           this.additional = this.resource.take(1).toArray().toPromise();
127 |         }); // don't block
128 | 
129 |         before(function () {
130 |           const filename = 'third.json';
131 |           const absolute = path.join(this.dir, filename);
132 |           return writeFile(
133 |             absolute,
134 |             JSON.stringify({
135 |               filename,
136 |             })
137 |           ).then(() => delay(100));
138 |         }); // race condition protection
139 | 
140 |         it('emits the third file', function () {
141 |           return this.additional.then(results => {
142 |             assert.strictEqual(results.length, 1);
143 |             assert.strictEqual(results[0].filename, 'third.json');
144 |           });
145 |         });
146 |       });
147 |     });
148 |   });
149 | });
150 | 


--------------------------------------------------------------------------------
/test/promise.test.js:
--------------------------------------------------------------------------------
 1 | 'use strict';
 2 | 
 3 | const assert = require('assert');
 4 | 
 5 | const { Observable } = require('rx-lite');
 6 | 
 7 | const { fromPromiseFunction } = require('../lib/promise');
 8 | 
 9 | describe('fromPromiseFunction', () => {
10 |   it('is a function', () => {
11 |     assert.strictEqual(typeof fromPromiseFunction, 'function');
12 |   });
13 | 
14 |   it('can convert back and forth', () => {
15 |     const expected = {
16 |       a: 'value',
17 |     };
18 |     return fromPromiseFunction(() => expected)
19 |       .toPromise()
20 |       .then(value => {
21 |         assert.deepStrictEqual(value, expected);
22 |       });
23 |   });
24 | 
25 |   it('handles rejections', () =>
26 |     fromPromiseFunction(() => Promise.reject(new Error('Bad')))
27 |       .catch(err => {
28 |         assert.strictEqual(err.message, 'Bad');
29 |         return Observable.just('ok');
30 |       })
31 |       .toPromise()
32 |       .then(ok => {
33 |         assert.strictEqual(ok, 'ok');
34 |       }));
35 | });
36 | 


--------------------------------------------------------------------------------
/test/shared-store/error-handling.test.js:
--------------------------------------------------------------------------------
  1 | 'use strict';
  2 | 
  3 | const assert = require('assert');
  4 | 
  5 | const { Observable } = require('rx-lite');
  6 | 
  7 | const tmp = require('tmp');
  8 | 
  9 | const SharedStore = require('../../');
 10 | 
 11 | describe('SharedStore (error handling)', () => {
 12 |   describe('reading from a loader that throws an error immediately', () => {
 13 |     describe('with no cache', () => {
 14 |       let tmpDir = null;
 15 | 
 16 |       before(done => {
 17 |         tmp.dir(
 18 |           {
 19 |             unsafeCleanup: true,
 20 |           },
 21 |           (err, tmpDirParam) => {
 22 |             tmpDir = tmpDirParam;
 23 |             done(err);
 24 |           }
 25 |         );
 26 |       });
 27 | 
 28 |       it('will return the error through callback', done => {
 29 |         let thrownError = false;
 30 |         const store = new SharedStore({
 31 |           temp: tmpDir,
 32 |           loader: Observable.create(observer => {
 33 |             if (thrownError) {
 34 |               return;
 35 |             }
 36 | 
 37 |             observer.onError(new Error('This throws!'));
 38 |             thrownError = true;
 39 |           }),
 40 |         });
 41 | 
 42 |         store.init((err, data) => {
 43 |           assert.strictEqual(data, undefined);
 44 |           assert.strictEqual(store.getCurrent(), undefined);
 45 |           assert.strictEqual(err.message, 'This throws!');
 46 |           done();
 47 |         });
 48 |       });
 49 |     });
 50 | 
 51 |     describe('with a cache', () => {
 52 |       let tmpDir = null;
 53 | 
 54 |       before(done => {
 55 |         tmp.dir(
 56 |           {
 57 |             unsafeCleanup: true,
 58 |           },
 59 |           (err, tmpDirParam) => {
 60 |             tmpDir = tmpDirParam;
 61 |             const store = new SharedStore({
 62 |               temp: tmpDir,
 63 | 
 64 |               loader() {
 65 |                 return Observable.just({
 66 |                   data: 'tastic',
 67 |                 });
 68 |               },
 69 |             });
 70 | 
 71 |             store.init(storeErr => {
 72 |               done(storeErr);
 73 |             });
 74 |           }
 75 |         );
 76 |       });
 77 | 
 78 |       it('will return the cache through callback & getCurrent', done => {
 79 |         let thrownError = false;
 80 |         const store = new SharedStore({
 81 |           temp: tmpDir,
 82 |           loader: Observable.create(observer => {
 83 |             if (thrownError) {
 84 |               return;
 85 |             }
 86 | 
 87 |             observer.onError(new Error('This throws!'));
 88 |             thrownError = true;
 89 |           }),
 90 |         });
 91 | 
 92 |         store.init((err, data) => {
 93 |           assert.strictEqual(data, 'tastic');
 94 |           assert.strictEqual(store.getCurrent(), 'tastic');
 95 |           assert.strictEqual(err, null);
 96 |           done();
 97 |         });
 98 |       });
 99 |     });
100 |   });
101 | 
102 |   describe('reading from a loader that throws an error after a successful read', () => {
103 |     let tmpDir = null;
104 | 
105 |     before(done => {
106 |       tmp.dir(
107 |         {
108 |           unsafeCleanup: true,
109 |         },
110 |         (err, tmpDirParam) => {
111 |           tmpDir = tmpDirParam;
112 |           done(err);
113 |         }
114 |       );
115 |     });
116 | 
117 |     it('will return the error through event handler', done => {
118 |       let thrownError = false;
119 |       const store = new SharedStore({
120 |         temp: tmpDir,
121 |         loader: Observable.create(observer => {
122 |           observer.onNext({
123 |             data: {},
124 |           });
125 |           return setTimeout(() => {
126 |             if (thrownError) {
127 |               return;
128 |             }
129 | 
130 |             observer.onError(new Error('¡Ay, caramba!'));
131 |             thrownError = true;
132 |           }, 500);
133 |         }),
134 |       });
135 | 
136 |       store.init((err, data) => {
137 |         assert.strictEqual(err, null);
138 |         assert.deepStrictEqual(data, {});
139 |       });
140 |       store.on('err', err => {
141 |         assert.strictEqual(err.message, '¡Ay, caramba!');
142 |         done();
143 |       });
144 |     });
145 |   });
146 | });
147 | 


--------------------------------------------------------------------------------
/test/shared-store/index.test.js:
--------------------------------------------------------------------------------
  1 | 'use strict';
  2 | 
  3 | const fs = require('fs');
  4 | 
  5 | const os = require('os');
  6 | 
  7 | const path = require('path');
  8 | 
  9 | const assert = require('assert');
 10 | 
 11 | const { Observable } = require('rx-lite');
 12 | 
 13 | const tmp = require('tmp');
 14 | 
 15 | const SharedStore = require('../../');
 16 | 
 17 | const fileContent = require('../../file');
 18 | 
 19 | const BASE_CONFIG = {
 20 |   opt: 'value',
 21 | };
 22 | const INITIAL_DATA = {
 23 |   override: 'loaded',
 24 |   fromFile: 42,
 25 |   static: 'data',
 26 | };
 27 | const CHANGED_DATA = {
 28 |   static: 'data',
 29 |   fromFile: 13,
 30 | };
 31 | 
 32 | function delay(ms) {
 33 |   return new Promise(resolve => setTimeout(resolve, ms));
 34 | }
 35 | 
 36 | describe('SharedStore', () => {
 37 |   let tmpDir;
 38 | 
 39 |   before(done => {
 40 |     tmp.dir(
 41 |       {
 42 |         unsafeCleanup: true,
 43 |       },
 44 |       (err, dir) => {
 45 |         tmpDir = dir;
 46 |         done(err);
 47 |       }
 48 |     );
 49 |   });
 50 | 
 51 |   describe('reading from multiple loaders', () => {
 52 |     let store;
 53 |     let overrideFile;
 54 |     let initCallbackData;
 55 | 
 56 |     before(done => {
 57 |       overrideFile = path.join(os.tmpdir(), 'shared-store.test.json');
 58 |       const initialOverrides = {
 59 |         override: 'loaded',
 60 |       };
 61 |       fs.writeFile(overrideFile, JSON.stringify(initialOverrides), done);
 62 |     });
 63 | 
 64 |     before(async () => {
 65 |       store = new SharedStore({
 66 |         temp: tmpDir,
 67 |         active: true,
 68 |         loader: baseConfig => {
 69 |           assert.deepStrictEqual(baseConfig, BASE_CONFIG);
 70 | 
 71 |           return Observable.combineLatest(
 72 |             Observable.just({
 73 |               data: {
 74 |                 static: 'data',
 75 |               },
 76 |               source: 'static',
 77 |             }),
 78 |             fileContent('example/config.json'),
 79 |             fileContent(overrideFile, {
 80 |               watch: true,
 81 |             }),
 82 |             SharedStore.safeMerge
 83 |           );
 84 |         },
 85 |       });
 86 | 
 87 |       initCallbackData = await store.init({
 88 |         opt: 'value',
 89 |       });
 90 |     });
 91 | 
 92 |     it('returns the initial data', () => {
 93 |       assert.deepStrictEqual(store.getCurrent(), INITIAL_DATA);
 94 |     });
 95 | 
 96 |     it('passes the initial data into the callback', () => {
 97 |       assert.deepStrictEqual(initCallbackData, INITIAL_DATA);
 98 |     });
 99 | 
100 |     it('writes a cache file', () => {
101 |       const cacheFiles = fs.readdirSync(tmpDir);
102 | 
103 |       assert.strictEqual(cacheFiles.length, 1);
104 |     });
105 | 
106 |     describe('a passive store', () => {
107 |       let passiveStore;
108 | 
109 |       before(async () => {
110 |         passiveStore = new SharedStore({
111 |           temp: tmpDir,
112 |           active: false,
113 |           loader: Observable.just({
114 |             data: {
115 |               static: 'data',
116 |             },
117 |             source: 'static',
118 |           }),
119 |         });
120 | 
121 |         await passiveStore.init({
122 |           opt: '-- ignored --',
123 |         });
124 |       });
125 | 
126 |       it('gets the same data', () => {
127 |         assert.deepStrictEqual(passiveStore.getCurrent(), INITIAL_DATA);
128 |       });
129 | 
130 |       it('can switch to active', async () => {
131 |         passiveStore.setActive();
132 |         await delay(300);
133 | 
134 |         assert.deepStrictEqual(passiveStore.getCurrent(), { static: 'data' });
135 |       });
136 |     });
137 | 
138 |     describe('after changing a file', () => {
139 |       before(done => {
140 |         const newOverrides = {
141 |           fromFile: CHANGED_DATA.fromFile,
142 |         };
143 |         fs.writeFile(overrideFile, JSON.stringify(newOverrides), done);
144 |       });
145 |       before(() => delay(300));
146 | 
147 |       it('has the updated data', () => {
148 |         assert.deepStrictEqual(store.getCurrent(), CHANGED_DATA);
149 |       });
150 |     });
151 |   });
152 | });
153 | 


--------------------------------------------------------------------------------
/test/shared-store/no-cache.test.js:
--------------------------------------------------------------------------------
 1 | 'use strict';
 2 | 
 3 | const fs = require('fs');
 4 | 
 5 | const os = require('os');
 6 | 
 7 | const path = require('path');
 8 | 
 9 | const assert = require('assert');
10 | 
11 | const { Observable } = require('rx-lite');
12 | 
13 | const tmp = require('tmp');
14 | 
15 | const SharedStore = require('../../');
16 | 
17 | const BASE_CONFIG = {
18 |   opt: 'value',
19 | };
20 | 
21 | describe('With cache disabled', () => {
22 |   before(function (done) {
23 |     tmp.dir(
24 |       {
25 |         unsafeCleanup: true,
26 |       },
27 |       (err, tmpDir) => {
28 |         this.tmpDir = tmpDir;
29 |         done(err);
30 |       }
31 |     );
32 |   });
33 |   describe('with cache disabled', () => {
34 |     before(function (done) {
35 |       this.overrideFile = path.join(os.tmpdir(), 'shared-store.test.json');
36 |       this.initialOverrides = {
37 |         override: 'loaded',
38 |       };
39 |       fs.writeFile(
40 |         this.overrideFile,
41 |         JSON.stringify(this.initialOverrides),
42 |         done
43 |       );
44 |     });
45 | 
46 |     before(function (done) {
47 |       this.store = new SharedStore({
48 |         temp: this.tmpDir,
49 |         active: true,
50 |         loader: baseConfig => {
51 |           assert.deepStrictEqual(baseConfig, BASE_CONFIG);
52 | 
53 |           return Observable.just({
54 |             data: {
55 |               static: 'data',
56 |             },
57 |             source: 'static',
58 |           });
59 |         },
60 |       });
61 |       this.store.setActive({
62 |         writeCacheFiles: false,
63 |       });
64 |       this.store.init(
65 |         {
66 |           opt: 'value',
67 |         },
68 |         (err, initCallbackData) => {
69 |           this.initCallbackData = initCallbackData;
70 |           done(err);
71 |         }
72 |       );
73 |     });
74 | 
75 |     it('returns the initial data', function () {
76 |       assert.deepStrictEqual(this.store.getCurrent(), {
77 |         static: 'data',
78 |       });
79 |     });
80 | 
81 |     it('writes no cache file', function () {
82 |       const cacheFiles = fs.readdirSync(this.tmpDir);
83 | 
84 |       assert.strictEqual(cacheFiles.length, 0);
85 |     });
86 |   });
87 | });
88 | 


--------------------------------------------------------------------------------
/test/shared-store/retry.test.js:
--------------------------------------------------------------------------------
 1 | 'use strict';
 2 | 
 3 | const assert = require('assert');
 4 | 
 5 | const { Observable } = require('rx-lite');
 6 | 
 7 | const tmp = require('tmp');
 8 | 
 9 | const SharedStore = require('../../');
10 | 
11 | describe('SharedStore (retry functionality)', () => {
12 |   let tmpDir;
13 | 
14 |   before(done => {
15 |     tmp.dir(
16 |       {
17 |         unsafeCleanup: true,
18 |       },
19 |       (err, dir) => {
20 |         tmpDir = dir;
21 |         done(err);
22 |       }
23 |     );
24 |   });
25 | 
26 |   describe('reading from a loader with a single value', () => {
27 |     let store = null;
28 | 
29 |     before(() => {
30 |       store = new SharedStore({
31 |         temp: tmpDir,
32 |         loader: Observable.just({
33 |           data: 'test',
34 |         }),
35 |       });
36 |     });
37 | 
38 |     it('init and retry will emit the same meta ', async () => {
39 |       let metaCount = 0;
40 |       store.on('meta', options => {
41 |         assert.strictEqual(options, 'some-options');
42 |         metaCount++;
43 |       });
44 | 
45 |       await store.init('some-options');
46 | 
47 |       // eslint-disable-next-line no-underscore-dangle
48 |       store._retry();
49 | 
50 |       assert.strictEqual(metaCount, 2);
51 |     });
52 |   });
53 | });
54 | 


--------------------------------------------------------------------------------
/test/shared-store/with-cache.test.js:
--------------------------------------------------------------------------------
  1 | 'use strict';
  2 | 
  3 | const assert = require('assert');
  4 | 
  5 | const { Observable } = require('rx-lite');
  6 | 
  7 | const tmp = require('tmp');
  8 | 
  9 | const { promisify } = require('util');
 10 | 
 11 | const SharedStore = require('../../');
 12 | 
 13 | const tmpDir = promisify(tmp.dir);
 14 | 
 15 | function delay(ms) {
 16 |   return new Promise(resolve => setTimeout(resolve, ms));
 17 | }
 18 | 
 19 | describe('SharedStore (with data already in cache)', () => {
 20 |   let cacheTmpDir = null;
 21 | 
 22 |   beforeEach(() =>
 23 |     tmpDir({ unsafeCleanup: true })
 24 |       .then(createdDir => {
 25 |         cacheTmpDir = createdDir;
 26 |         return new SharedStore({
 27 |           temp: cacheTmpDir,
 28 |           loader: Observable.just({
 29 |             data: 'some data',
 30 |           }),
 31 |         });
 32 |       })
 33 |       .then(store => store.init())
 34 |   );
 35 | 
 36 |   describe('taking a long time to load data', () => {
 37 |     let store;
 38 |     let notSoCurrent;
 39 | 
 40 |     beforeEach(async () => {
 41 |       store = new SharedStore({
 42 |         temp: cacheTmpDir,
 43 |         loader: Observable.just({
 44 |           data: 'other data',
 45 |         }).delay(500),
 46 |       });
 47 | 
 48 |       notSoCurrent = await store.init();
 49 |     });
 50 | 
 51 |     beforeEach(() => delay(1000));
 52 | 
 53 |     it('should return cached data immediately in callback', () => {
 54 |       assert.strictEqual(notSoCurrent, 'some data');
 55 |     });
 56 | 
 57 |     it('should return latest data in getCurrent', () => {
 58 |       assert.strictEqual(store.getCurrent(), 'other data');
 59 |     });
 60 |   });
 61 | 
 62 |   describe('having cache data = loaded data', () => {
 63 |     let store = null;
 64 |     beforeEach(() => {
 65 |       store = new SharedStore({
 66 |         temp: cacheTmpDir,
 67 |         loader: Observable.just({
 68 |           data: 'some data',
 69 |         }),
 70 |       });
 71 |     });
 72 | 
 73 |     it("should resolve the promise even if there's a long period between construction & initialization", () =>
 74 |       delay(1000)
 75 |         .then(() => store.init())
 76 |         .then(data => {
 77 |           assert.strictEqual(data, 'some data');
 78 |         }));
 79 |   });
 80 | 
 81 |   describe('throwing a load error & then producing a value', () => {
 82 |     let thrownError = false;
 83 |     let store;
 84 | 
 85 |     const loader = () =>
 86 |       Observable.create(observer =>
 87 |         delay(250).then(() => {
 88 |           if (!thrownError) {
 89 |             observer.onError(new Error('kaboom!'));
 90 |             thrownError = true;
 91 |             return;
 92 |           }
 93 | 
 94 |           observer.onNext({
 95 |             data: '2nd value',
 96 |           });
 97 |         })
 98 |       );
 99 | 
100 |     beforeEach(async () => {
101 |       store = new SharedStore({
102 |         temp: cacheTmpDir,
103 |         loader,
104 |       });
105 | 
106 |       await store.init();
107 |     });
108 | 
109 |     it('will throw an error first', done => {
110 |       store.on('err', err => {
111 |         assert.strictEqual(err.message, 'kaboom!');
112 |         done();
113 |       });
114 |     });
115 | 
116 |     it('will keep on streaming after an error is thrown', () =>
117 |       delay(1500).then(() => {
118 |         assert.strictEqual(store.getCurrent(), '2nd value');
119 |       }));
120 |   });
121 | });
122 | 


--------------------------------------------------------------------------------