/
config.js.html
1471 lines (1307 loc) · 145 KB
/
config.js.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>config config.js </title>
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1382629024.25" />
<link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1382629024.25" />
<script type="text/javascript" src="assets/api-js?stamp=1382629024.25"></script>
<script type="text/javascript" src="assets/ac-js?stamp=1382629024.25"></script>
</head>
<body id="node-monitor">
<div id="doc3" class="yui-t2">
<div id="hd">
<h1><a href="https://github.com/lorenwest/node-config" title="Node.js Configuration">Node.js Configuration</a></h1>
<a href="./index.html" title="Node.js Configuration">Node.js Configuration</a>
> <a href="./module_config.html" title="config">config</a>
> config.js (source view)
<form onsubmit="return false">
<div id="propertysearch">
Search: <input autocomplete="off" id="searchinput" />
<div id="searchresults">
</div>
</div>
</form>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
<fieldset>
<legend>Filters</legend>
<span class="classopts" style="display:none;"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
<span id="showProtected" class="classopts" style="display:none'"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
<span class="classopts" style="display:none;"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
</fieldset>
</form>
<div id="srcout">
<style>
#doc3 .classopts { display:none; }
</style>
<div class="highlight"><pre><span class="cm">/*jsl:declare global */</span>
<span class="c1">// config.js (c) 2010-2013 Loren West and other contributors</span>
<span class="c1">// May be freely distributed under the MIT license.</span>
<span class="c1">// For further details and documentation:</span>
<span class="c1">// http://lorenwest.github.com/node-config</span>
<span class="c1">// Dependencies</span>
<span class="kd">var</span> <span class="nx">Yaml</span> <span class="o">=</span> <span class="kc">null</span><span class="p">,</span> <span class="c1">// External libraries are lazy-loaded</span>
<span class="nx">VisionmediaYaml</span> <span class="o">=</span> <span class="kc">null</span><span class="p">,</span> <span class="c1">// only if these file types exist.</span>
<span class="nx">Coffee</span> <span class="o">=</span> <span class="kc">null</span><span class="p">,</span>
<span class="nx">FileSystem</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'fs'</span><span class="p">);</span>
<span class="c1">// Static members</span>
<span class="kd">var</span> <span class="nx">DEFAULT_CLONE_DEPTH</span> <span class="o">=</span> <span class="mi">20</span><span class="p">,</span>
<span class="nx">FILE_WATCHER_INTERVAL</span> <span class="o">=</span> <span class="mi">2500</span><span class="p">,</span> <span class="c1">// For old style (pre-6.0) file watching</span>
<span class="nx">CONFIG_DIR</span><span class="p">,</span> <span class="nx">RUNTIME_JSON_FILENAME</span><span class="p">,</span> <span class="nx">NODE_ENV</span><span class="p">,</span> <span class="nx">APP_INSTANCE</span><span class="p">,</span>
<span class="nx">DISABLE_FILE_WATCH</span><span class="p">,</span> <span class="nx">PERSIST_ON_CHANGE</span><span class="p">,</span> <span class="nx">HOST</span><span class="p">,</span> <span class="nx">HOSTNAME</span><span class="p">,</span>
<span class="nx">originalConfig</span> <span class="o">=</span> <span class="kc">null</span><span class="p">,</span> <span class="c1">// Not including the runtime.json values</span>
<span class="nx">runtimeJson</span> <span class="o">=</span> <span class="p">{},</span> <span class="c1">// Current runtimeJson extensions</span>
<span class="nx">runtimeJsonWatcher</span> <span class="o">=</span> <span class="kc">null</span><span class="p">,</span> <span class="c1">// Filesystem watcher for runtime.json</span>
<span class="nx">configSources</span> <span class="o">=</span> <span class="p">[],</span> <span class="c1">// Configuration sources - array of {name, original, parsed}</span>
<span class="nx">isQueuedForPersistence</span> <span class="o">=</span> <span class="kc">false</span><span class="p">;</span>
<span class="cm">/**</span>
<span class="cm"> * <p>Runtime Application Configurations</p></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * The config module exports a singleton object representing all runtime</span>
<span class="cm"> * configurations for this application deployment.</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * Application configurations are stored in files within the config directory</span>
<span class="cm"> * of your application. The default configuration file is loaded, followed</span>
<span class="cm"> * by files specific to the deployment type (development, testing, staging,</span>
<span class="cm"> * production, etc.).</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * For example, with the following config/default.yaml file:</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <pre></span>
<span class="cm"> * ...</span>
<span class="cm"> * customer:</span>
<span class="cm"> * &nbsp;&nbsp;initialCredit: 500</span>
<span class="cm"> * &nbsp;&nbsp;db:</span>
<span class="cm"> * &nbsp;&nbsp;&nbsp;&nbsp;name: customer</span>
<span class="cm"> * &nbsp;&nbsp;&nbsp;&nbsp;port: 5984</span>
<span class="cm"> * ...</span>
<span class="cm"> * </pre></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * The following code loads the customer section into the CONFIG variable:</span>
<span class="cm"> * <p></span>
<span class="cm"> *</span>
<span class="cm"> * <pre></span>
<span class="cm"> * var CONFIG = require('config').customer;</span>
<span class="cm"> * ...</span>
<span class="cm"> * newCustomer.creditLimit = CONFIG.initialCredit;</span>
<span class="cm"> * database.open(CONFIG.db.name, CONFIG.db.port);</span>
<span class="cm"> * ...</span>
<span class="cm"> * </pre></span>
<span class="cm"> *</span>
<span class="cm"> * @module config</span>
<span class="cm"> * @class Config</span>
<span class="cm"> */</span>
<span class="cm">/**</span>
<span class="cm"> * <p>Get the configuration object.</p></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * The configuration object is a shared singleton object within the applicaiton,</span>
<span class="cm"> * attained by calling require('config').</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * Usually you'll specify a CONFIG variable at the top of your .js file</span>
<span class="cm"> * for file/module scope. If you want the root of the object, you can do this:</span>
<span class="cm"> * </p></span>
<span class="cm"> * <pre></span>
<span class="cm"> * var CONFIG = require('config');</span>
<span class="cm"> * </pre></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * Sometimes you only care about a specific sub-object within the CONFIG</span>
<span class="cm"> * object. In that case you could do this at the top of your file:</span>
<span class="cm"> * </p></span>
<span class="cm"> * <pre></span>
<span class="cm"> * var CONFIG = require('config').customer;</span>
<span class="cm"> * or</span>
<span class="cm"> * var CUSTOMER_CONFIG = require('config').customer;</span>
<span class="cm"> * </pre></span>
<span class="cm"> *</span>
<span class="cm"> * <script type="text/javascript"></span>
<span class="cm"> * document.getElementById("showProtected").style.display = "block";</span>
<span class="cm"> * </script></span>
<span class="cm"> *</span>
<span class="cm"> * @method constructor</span>
<span class="cm"> * @return CONFIG {object} - The top level configuration object</span>
<span class="cm"> */</span>
<span class="kd">var</span> <span class="nx">Config</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">t</span> <span class="o">=</span> <span class="k">this</span><span class="p">;</span>
<span class="c1">// Initialize parameters from command line, environment, or default</span>
<span class="nx">NODE_ENV</span> <span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">_initParam</span><span class="p">(</span><span class="s1">'NODE_ENV'</span><span class="p">,</span> <span class="s1">'development'</span><span class="p">);</span>
<span class="nx">CONFIG_DIR</span> <span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">_initParam</span><span class="p">(</span><span class="s1">'NODE_CONFIG_DIR'</span><span class="p">,</span> <span class="nx">process</span><span class="p">.</span><span class="nx">cwd</span><span class="p">()</span> <span class="o">+</span> <span class="s1">'/config'</span><span class="p">);</span>
<span class="nx">RUNTIME_JSON_FILENAME</span> <span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">_initParam</span><span class="p">(</span><span class="s1">'NODE_CONFIG_RUNTIME_JSON'</span><span class="p">,</span> <span class="nx">CONFIG_DIR</span> <span class="o">+</span> <span class="s1">'/runtime.json'</span><span class="p">);</span>
<span class="nx">DISABLE_FILE_WATCH</span> <span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">_initParam</span><span class="p">(</span><span class="s1">'NODE_CONFIG_DISABLE_FILE_WATCH'</span><span class="p">);</span>
<span class="nx">PERSIST_ON_CHANGE</span> <span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">_initParam</span><span class="p">(</span><span class="s1">'NODE_CONFIG_PERSIST_ON_CHANGE'</span><span class="p">);</span>
<span class="nx">APP_INSTANCE</span> <span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">_initParam</span><span class="p">(</span><span class="s1">'NODE_APP_INSTANCE'</span><span class="p">);</span>
<span class="nx">HOST</span> <span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">_initParam</span><span class="p">(</span><span class="s1">'HOST'</span><span class="p">);</span>
<span class="nx">HOSTNAME</span> <span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">_initParam</span><span class="p">(</span><span class="s1">'HOSTNAME'</span><span class="p">);</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">_loadFileConfigs</span><span class="p">();</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">_persistConfigsOnChange</span><span class="p">();</span>
<span class="p">};</span>
<span class="cm">/**</span>
<span class="cm"> * <p>Monitor a configuration value for runtime changes.</p></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * Configuration values can be changed at runtime by the application or by a</span>
<span class="cm"> * manual change to the config/runtime.json file.</span>
<span class="cm"> * This method lets you specify a function to run when a configuration</span>
<span class="cm"> * value changes.</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <p><i></span>
<span class="cm"> * This was built for monitoring changes to configuration values,</span>
<span class="cm"> * but it can be used for watching changes to <u>any</u> javascript object.</span>
<span class="cm"> * </i></p></span>
<span class="cm"> *</span>
<span class="cm"> * <p>Example:</p></span>
<span class="cm"> * <pre></span>
<span class="cm"> * var CONFIG = require('config').customer;</span>
<span class="cm"> * ...</span>
<span class="cm"> *</span>
<span class="cm"> * // Watch for any changes to the customer configuration</span>
<span class="cm"> * CONFIG.watch(CONFIG, null, function(object, propertyName, priorValue, newValue) {</span>
<span class="cm"> * &nbsp;console.log("Customer configuration " + propertyName + " changed from " + priorValue + " to " + newValue);</span>
<span class="cm"> * });</span>
<span class="cm"> * </pre></span>
<span class="cm"> *</span>
<span class="cm"> * @method watch</span>
<span class="cm"> * @param object {object} - The object to watch.</span>
<span class="cm"> * @param property {string} - The property name to watch. Watch all object properties if null.</span>
<span class="cm"> * @param handler {function(object, propertyName, priorValue, newValue)} - Handler called when a property change is detected.</span>
<span class="cm"> * The handler is run along with other handlers registered for notification.</span>
<span class="cm"> * If your handler changes the value of the property, that change is applied after all handlers have finished processing the current change.</span>
<span class="cm"> * Then all handlers (including this one) will be called again with the newly changed value.</span>
<span class="cm"> * @param depth {integer} (optional) - If watching all object properties or if the specified property is an object, this specifies the depth of the object graph to watch for changes. Default 6.</span>
<span class="cm"> * @return object {object} - The original object is returned - for chaining.</span>
<span class="cm"> */</span>
<span class="nx">Config</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">watch</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">object</span><span class="p">,</span> <span class="nx">property</span><span class="p">,</span> <span class="nx">handler</span><span class="p">,</span> <span class="nx">depth</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Initialize</span>
<span class="kd">var</span> <span class="nx">t</span> <span class="o">=</span> <span class="k">this</span><span class="p">,</span> <span class="nx">o</span> <span class="o">=</span> <span class="nx">object</span><span class="p">;</span>
<span class="kd">var</span> <span class="nx">allProperties</span> <span class="o">=</span> <span class="nx">property</span> <span class="o">?</span> <span class="p">[</span><span class="nx">property</span><span class="p">]</span> <span class="o">:</span> <span class="nb">Object</span><span class="p">.</span><span class="nx">keys</span><span class="p">(</span><span class="nx">o</span><span class="p">);</span>
<span class="c1">// Depth detection</span>
<span class="nx">depth</span> <span class="o">=</span> <span class="p">(</span><span class="nx">depth</span> <span class="o">===</span> <span class="kc">null</span> <span class="o">?</span> <span class="nx">DEFAULT_CLONE_DEPTH</span> <span class="o">:</span> <span class="nx">depth</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">depth</span> <span class="o"><</span> <span class="mi">0</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span><span class="p">;</span>
<span class="p">}</span>
<span class="c1">// Create hidden properties on the object</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">o</span><span class="p">.</span><span class="nx">__watchers</span><span class="p">)</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">makeHidden</span><span class="p">(</span><span class="nx">o</span><span class="p">,</span> <span class="s1">'__watchers'</span><span class="p">,</span> <span class="p">{});</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">o</span><span class="p">.</span><span class="nx">__propertyValues</span><span class="p">)</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">makeHidden</span><span class="p">(</span><span class="nx">o</span><span class="p">,</span> <span class="s1">'__propertyValues'</span><span class="p">,</span> <span class="p">{});</span>
<span class="c1">// Attach watchers to all requested properties</span>
<span class="nx">allProperties</span><span class="p">.</span><span class="nx">forEach</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">prop</span><span class="p">){</span>
<span class="c1">// Setup the property for watching (first time only)</span>
<span class="k">if</span> <span class="p">(</span><span class="k">typeof</span><span class="p">(</span><span class="nx">o</span><span class="p">.</span><span class="nx">__propertyValues</span><span class="p">[</span><span class="nx">prop</span><span class="p">])</span> <span class="o">==</span> <span class="s1">'undefined'</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Don't error re-defining the property if immutable</span>
<span class="kd">var</span> <span class="nx">descriptor</span> <span class="o">=</span> <span class="nb">Object</span><span class="p">.</span><span class="nx">getOwnPropertyDescriptor</span><span class="p">(</span><span class="nx">o</span><span class="p">,</span> <span class="nx">prop</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">descriptor</span> <span class="o">&&</span> <span class="nx">descriptor</span><span class="p">.</span><span class="nx">writable</span> <span class="o">===</span> <span class="kc">false</span><span class="p">)</span>
<span class="k">return</span><span class="p">;</span>
<span class="c1">// Copy the value to the hidden field, and add the property to watchers</span>
<span class="nx">o</span><span class="p">.</span><span class="nx">__propertyValues</span><span class="p">[</span><span class="nx">prop</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="nx">o</span><span class="p">[</span><span class="nx">prop</span><span class="p">]];</span>
<span class="nx">o</span><span class="p">.</span><span class="nx">__watchers</span><span class="p">[</span><span class="nx">prop</span><span class="p">]</span> <span class="o">=</span> <span class="p">[];</span>
<span class="c1">// Attach the property watcher</span>
<span class="nb">Object</span><span class="p">.</span><span class="nx">defineProperty</span><span class="p">(</span><span class="nx">o</span><span class="p">,</span> <span class="nx">prop</span><span class="p">,</span> <span class="p">{</span>
<span class="nx">enumerable</span> <span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
<span class="nx">get</span> <span class="o">:</span> <span class="kd">function</span><span class="p">(){</span>
<span class="c1">// If more than 1 item is in the values array,</span>
<span class="c1">// then we're currently processing watchers.</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">o</span><span class="p">.</span><span class="nx">__propertyValues</span><span class="p">[</span><span class="nx">prop</span><span class="p">].</span><span class="nx">length</span> <span class="o">==</span> <span class="mi">1</span><span class="p">)</span>
<span class="c1">// Current value</span>
<span class="k">return</span> <span class="nx">o</span><span class="p">.</span><span class="nx">__propertyValues</span><span class="p">[</span><span class="nx">prop</span><span class="p">][</span><span class="mi">0</span><span class="p">];</span>
<span class="k">else</span>
<span class="c1">// [0] is prior value, [1] is new value being processed</span>
<span class="k">return</span> <span class="nx">o</span><span class="p">.</span><span class="nx">__propertyValues</span><span class="p">[</span><span class="nx">prop</span><span class="p">][</span><span class="mi">1</span><span class="p">];</span>
<span class="p">},</span>
<span class="nx">set</span> <span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">newValue</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Return early if no change</span>
<span class="kd">var</span> <span class="nx">origValue</span> <span class="o">=</span> <span class="nx">o</span><span class="p">[</span><span class="nx">prop</span><span class="p">];</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">t</span><span class="p">.</span><span class="nx">_equalsDeep</span><span class="p">(</span><span class="nx">origValue</span><span class="p">,</span> <span class="nx">newValue</span><span class="p">))</span>
<span class="k">return</span><span class="p">;</span>
<span class="c1">// Remember the new value, and return if we're in another setter</span>
<span class="nx">o</span><span class="p">.</span><span class="nx">__propertyValues</span><span class="p">[</span><span class="nx">prop</span><span class="p">].</span><span class="nx">push</span><span class="p">(</span><span class="nx">newValue</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">o</span><span class="p">.</span><span class="nx">__propertyValues</span><span class="p">[</span><span class="nx">prop</span><span class="p">].</span><span class="nx">length</span> <span class="o">></span> <span class="mi">2</span><span class="p">)</span>
<span class="k">return</span><span class="p">;</span>
<span class="c1">// Call all watchers for each change requested</span>
<span class="kd">var</span> <span class="nx">numIterations</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
<span class="k">while</span> <span class="p">(</span><span class="nx">o</span><span class="p">.</span><span class="nx">__propertyValues</span><span class="p">[</span><span class="nx">prop</span><span class="p">].</span><span class="nx">length</span> <span class="o">></span> <span class="mi">1</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Detect recursion</span>
<span class="k">if</span> <span class="p">(</span><span class="o">++</span><span class="nx">numIterations</span> <span class="o">></span> <span class="mi">20</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">o</span><span class="p">.</span><span class="nx">__propertyValues</span><span class="p">[</span><span class="nx">prop</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="nx">origValue</span><span class="p">];</span>
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s1">'Recursion detected while setting ['</span> <span class="o">+</span> <span class="nx">prop</span> <span class="o">+</span> <span class="s1">']'</span><span class="p">);</span>
<span class="p">}</span>
<span class="c1">// Call each watcher for the current values</span>
<span class="kd">var</span> <span class="nx">oldValue</span> <span class="o">=</span> <span class="nx">o</span><span class="p">.</span><span class="nx">__propertyValues</span><span class="p">[</span><span class="nx">prop</span><span class="p">][</span><span class="mi">0</span><span class="p">];</span>
<span class="nx">newValue</span> <span class="o">=</span> <span class="nx">o</span><span class="p">.</span><span class="nx">__propertyValues</span><span class="p">[</span><span class="nx">prop</span><span class="p">][</span><span class="mi">1</span><span class="p">];</span>
<span class="nx">o</span><span class="p">.</span><span class="nx">__watchers</span><span class="p">[</span><span class="nx">prop</span><span class="p">].</span><span class="nx">forEach</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">watcher</span><span class="p">)</span> <span class="p">{</span>
<span class="k">try</span> <span class="p">{</span>
<span class="nx">watcher</span><span class="p">(</span><span class="nx">o</span><span class="p">,</span> <span class="nx">prop</span><span class="p">,</span> <span class="nx">oldValue</span><span class="p">,</span> <span class="nx">newValue</span><span class="p">);</span>
<span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Log an error and continue with subsequent watchers</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s2">"Exception in object watcher for "</span> <span class="o">+</span> <span class="nx">prop</span><span class="p">,</span> <span class="nx">e</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">});</span>
<span class="c1">// Done processing this value</span>
<span class="nx">o</span><span class="p">.</span><span class="nx">__propertyValues</span><span class="p">[</span><span class="nx">prop</span><span class="p">].</span><span class="nx">splice</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="mi">1</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">});</span>
<span class="p">}</span> <span class="c1">// Done setting up the property for watching (first time)</span>
<span class="c1">// Add the watcher to the property</span>
<span class="nx">o</span><span class="p">.</span><span class="nx">__watchers</span><span class="p">[</span><span class="nx">prop</span><span class="p">].</span><span class="nx">push</span><span class="p">(</span><span class="nx">handler</span><span class="p">);</span>
<span class="c1">// Recurs if this is an object...</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">o</span><span class="p">[</span><span class="nx">prop</span><span class="p">]</span> <span class="o">&&</span> <span class="k">typeof</span><span class="p">(</span><span class="nx">o</span><span class="p">[</span><span class="nx">prop</span><span class="p">])</span> <span class="o">==</span> <span class="s1">'object'</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">Config</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">watch</span><span class="p">(</span><span class="nx">o</span><span class="p">[</span><span class="nx">prop</span><span class="p">],</span> <span class="kc">null</span><span class="p">,</span> <span class="nx">handler</span><span class="p">,</span> <span class="nx">depth</span> <span class="o">-</span> <span class="mi">1</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">});</span> <span class="c1">// Done processing each property</span>
<span class="c1">// Return the original object - for chaining</span>
<span class="k">return</span> <span class="nx">o</span><span class="p">;</span>
<span class="p">};</span>
<span class="cm">/**</span>
<span class="cm"> * <p></span>
<span class="cm"> * Set default configurations for a node.js module.</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * This allows module developers to attach their configurations onto the</span>
<span class="cm"> * default configuration object so they can be configured by the consumers</span>
<span class="cm"> * of the module.</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <p>Using the function within your module:</p></span>
<span class="cm"> * <pre></span>
<span class="cm"> * var CONFIG = require("config");</span>
<span class="cm"> * CONFIG.setModuleDefaults("MyModule", {</span>
<span class="cm"> * &nbsp;&nbsp;templateName: "t-50",</span>
<span class="cm"> * &nbsp;&nbsp;colorScheme: "green"</span>
<span class="cm"> * });</span>
<span class="cm"> * <br></span>
<span class="cm"> * // Template name may be overridden by application config files</span>
<span class="cm"> * console.log("Template: " + CONFIG.MyModule.templateName);</span>
<span class="cm"> * </pre></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * The above example results in a "MyModule" element of the configuration</span>
<span class="cm"> * object, containing an object with the specified default values.</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * @method setModuleDefaults</span>
<span class="cm"> * @param moduleName {string} - Name of your module.</span>
<span class="cm"> * @param defaultProperties {object} - The default module configuration.</span>
<span class="cm"> * @return moduleConfig {object} - The module level configuration object.</span>
<span class="cm"> */</span>
<span class="nx">Config</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">setModuleDefaults</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">moduleName</span><span class="p">,</span> <span class="nx">defaultProperties</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Copy the properties into a new object</span>
<span class="kd">var</span> <span class="nx">t</span> <span class="o">=</span> <span class="k">this</span><span class="p">,</span>
<span class="nx">moduleConfig</span> <span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">_extendDeep</span><span class="p">({},</span> <span class="nx">defaultProperties</span><span class="p">);</span>
<span class="c1">// Set module defaults into the first sources element</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">configSources</span><span class="p">.</span><span class="nx">length</span> <span class="o">===</span> <span class="mi">0</span> <span class="o">||</span> <span class="nx">configSources</span><span class="p">[</span><span class="mi">0</span><span class="p">].</span><span class="nx">name</span> <span class="o">!==</span> <span class="s1">'Module Defaults'</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">configSources</span><span class="p">.</span><span class="nx">splice</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="p">{</span>
<span class="nx">name</span><span class="o">:</span> <span class="s1">'Module Defaults'</span><span class="p">,</span>
<span class="nx">parsed</span><span class="o">:</span> <span class="p">{}</span>
<span class="p">});</span>
<span class="p">}</span>
<span class="nx">configSources</span><span class="p">[</span><span class="mi">0</span><span class="p">].</span><span class="nx">parsed</span><span class="p">[</span><span class="nx">moduleName</span><span class="p">]</span> <span class="o">=</span> <span class="p">{};</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">_extendDeep</span><span class="p">(</span><span class="nx">configSources</span><span class="p">[</span><span class="mi">0</span><span class="p">].</span><span class="nx">parsed</span><span class="p">[</span><span class="nx">moduleName</span><span class="p">],</span> <span class="nx">defaultProperties</span><span class="p">);</span>
<span class="c1">// Attach handlers & watchers onto the module config object</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">_attachProtoDeep</span><span class="p">(</span><span class="nx">moduleConfig</span><span class="p">);</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">_persistConfigsOnChange</span><span class="p">(</span><span class="nx">moduleConfig</span><span class="p">);</span>
<span class="c1">// Extend the module config object with values from originalConfig</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">originalConfig</span><span class="p">[</span><span class="nx">moduleName</span><span class="p">])</span> <span class="p">{</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">_extendDeep</span><span class="p">(</span><span class="nx">moduleConfig</span><span class="p">,</span> <span class="nx">originalConfig</span><span class="p">[</span><span class="nx">moduleName</span><span class="p">]);</span>
<span class="p">}</span>
<span class="c1">// Save the mixed module config as the original</span>
<span class="nx">originalConfig</span><span class="p">[</span><span class="nx">moduleName</span><span class="p">]</span> <span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">_cloneDeep</span><span class="p">(</span><span class="nx">moduleConfig</span><span class="p">);</span>
<span class="c1">// Extend the module config object with values from runtimeJson</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">runtimeJson</span><span class="p">[</span><span class="nx">moduleName</span><span class="p">])</span> <span class="p">{</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">_extendDeep</span><span class="p">(</span><span class="nx">moduleConfig</span><span class="p">,</span> <span class="nx">runtimeJson</span><span class="p">[</span><span class="nx">moduleName</span><span class="p">]);</span>
<span class="p">}</span>
<span class="c1">// Attach the object onto the CONFIG object</span>
<span class="nx">t</span><span class="p">[</span><span class="nx">moduleName</span><span class="p">]</span> <span class="o">=</span> <span class="nx">moduleConfig</span><span class="p">;</span>
<span class="c1">// Return the module config</span>
<span class="k">return</span> <span class="nx">moduleConfig</span><span class="p">;</span>
<span class="p">};</span>
<span class="cm">/**</span>
<span class="cm"> * <p>Make a configuration property hidden so it doesn't appear when enumerating</span>
<span class="cm"> * elements of the object.</p></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * The property still exists and can be read from and written to, but it won't</span>
<span class="cm"> * show up in for ... in loops, Object.keys(), or JSON.stringify() type methods.</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * If the property already exists, it will be made hidden. Otherwise it will</span>
<span class="cm"> * be created as a hidden property with the specified value.</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <p><i></span>
<span class="cm"> * This method was built for hiding configuration values, but it can be applied</span>
<span class="cm"> * to <u>any</u> javascript object.</span>
<span class="cm"> * </i></p></span>
<span class="cm"> *</span>
<span class="cm"> * <p>Example:</p></span>
<span class="cm"> * <pre></span>
<span class="cm"> * var CONFIG = require('config');</span>
<span class="cm"> * ...</span>
<span class="cm"> *</span>
<span class="cm"> * // Hide the Amazon S3 credentials</span>
<span class="cm"> * CONFIG.makeHidden(CONFIG.amazonS3, 'access_id');</span>
<span class="cm"> * CONFIG.makeHidden(CONFIG.amazonS3, 'secret_key');</span>
<span class="cm"> * </pre></span>
<span class="cm"> *</span>
<span class="cm"> * @method makeHidden</span>
<span class="cm"> * @param object {object} - The object to make a hidden property into.</span>
<span class="cm"> * @param property {string} - The name of the property to make hidden.</span>
<span class="cm"> * @param value {mixed} - (optional) Set the property value to this (otherwise leave alone)</span>
<span class="cm"> * @return object {object} - The original object is returned - for chaining.</span>
<span class="cm"> */</span>
<span class="nx">Config</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">makeHidden</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">object</span><span class="p">,</span> <span class="nx">property</span><span class="p">,</span> <span class="nx">value</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Use the existing value if the new value isn't specified</span>
<span class="nx">value</span> <span class="o">=</span> <span class="p">(</span><span class="k">typeof</span> <span class="nx">value</span> <span class="o">==</span> <span class="s1">'undefined'</span><span class="p">)</span> <span class="o">?</span> <span class="nx">object</span><span class="p">[</span><span class="nx">property</span><span class="p">]</span> <span class="o">:</span> <span class="nx">value</span><span class="p">;</span>
<span class="c1">// Create the hidden property</span>
<span class="nb">Object</span><span class="p">.</span><span class="nx">defineProperty</span><span class="p">(</span><span class="nx">object</span><span class="p">,</span> <span class="nx">property</span><span class="p">,</span> <span class="p">{</span>
<span class="nx">value</span><span class="o">:</span> <span class="nx">value</span><span class="p">,</span>
<span class="nx">enumerable</span> <span class="o">:</span> <span class="kc">false</span>
<span class="p">});</span>
<span class="k">return</span> <span class="nx">object</span><span class="p">;</span>
<span class="p">}</span>
<span class="cm">/**</span>
<span class="cm"> * <p>Make a configuration property immutable (assuring it cannot be changed</span>
<span class="cm"> * from the current value).</p></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * This operation cannot be un-done.</span>
<span class="cm"> * </p></span>
<span class="cm"> * <p><i></span>
<span class="cm"> *</span>
<span class="cm"> * This method was built for disabling runtime changes to configuration values,</span>
<span class="cm"> * but it can be applied to <u>any</u> javascript object.</span>
<span class="cm"> * </i></p></span>
<span class="cm"> *</span>
<span class="cm"> * <p>Example:</p></span>
<span class="cm"> * <pre></span>
<span class="cm"> * var CONFIG = require('config').customer;</span>
<span class="cm"> * ...</span>
<span class="cm"> *</span>
<span class="cm"> * // Obtain a DB connection using CONFIG parameters</span>
<span class="cm"> * database.open(CONFIG.db.name, CONFIG.db.port);</span>
<span class="cm"> * ...</span>
<span class="cm"> *</span>
<span class="cm"> * // Don't allow database changes after connect</span>
<span class="cm"> * CONFIG.makeImmutable(CONFIG.db, 'name');</span>
<span class="cm"> * CONFIG.makeImmutable(CONFIG.db, 'port');</span>
<span class="cm"> * </pre></span>
<span class="cm"> *</span>
<span class="cm"> * @method makeImmutable</span>
<span class="cm"> * @param object {object} - The object to attach an immutable property into.</span>
<span class="cm"> * @param property {string} - The name of the property to make immutable.</span>
<span class="cm"> * @param value {mixed} - (optional) Set the property value to this (otherwise leave alone)</span>
<span class="cm"> * @return object {object} - The original object is returned - for chaining.</span>
<span class="cm"> */</span>
<span class="nx">Config</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">makeImmutable</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">object</span><span class="p">,</span> <span class="nx">property</span><span class="p">,</span> <span class="nx">value</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Use the existing value if a new value isn't specified</span>
<span class="nx">value</span> <span class="o">=</span> <span class="p">(</span><span class="k">typeof</span> <span class="nx">value</span> <span class="o">==</span> <span class="s1">'undefined'</span><span class="p">)</span> <span class="o">?</span> <span class="nx">object</span><span class="p">[</span><span class="nx">property</span><span class="p">]</span> <span class="o">:</span> <span class="nx">value</span><span class="p">;</span>
<span class="c1">// Disable writing, and make sure the property cannot be re-configured.</span>
<span class="nb">Object</span><span class="p">.</span><span class="nx">defineProperty</span><span class="p">(</span><span class="nx">object</span><span class="p">,</span> <span class="nx">property</span><span class="p">,</span> <span class="p">{</span>
<span class="nx">value</span> <span class="o">:</span> <span class="nx">value</span><span class="p">,</span>
<span class="nx">writable</span> <span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
<span class="nx">configurable</span><span class="o">:</span> <span class="kc">false</span>
<span class="p">});</span>
<span class="k">return</span> <span class="nx">object</span><span class="p">;</span>
<span class="p">};</span>
<span class="cm">/**</span>
<span class="cm"> * Start or stop runtime.json configuration file watching</span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * Node-config automatically monitors and apply changes made to the</span>
<span class="cm"> * config/runtime.json file. This paradigm allows for manual changes to running</span>
<span class="cm"> * application servers, and for multi-node application servers to keep in sync.</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * This method allows you to change the polling interval from the default</span>
<span class="cm"> * interval (2.5 seconds), or to turn file watching off. On Linux systems with</span>
<span class="cm"> * inotify, and in node.js versions 0.6 and above, this interval is ignored.</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * runtime.json file watching can be disabled by setting the NODE_CONFIG_DISABLE_FILE_WATCH</span>
<span class="cm"> * environment variable or --NODE_CONFIG_DISABLE_FILE_WATCH command line parameter</span>
<span class="cm"> * to "Y" prior to running your application.</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * @method watchForConfigFileChanges</span>
<span class="cm"> * @param interval {Integer} - Polling interval in milliseconds. Defaults to 2500.</span>
<span class="cm"> */</span>
<span class="nx">Config</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">watchForConfigFileChanges</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">interval</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Turn off any prior watching</span>
<span class="kd">var</span> <span class="nx">t</span> <span class="o">=</span> <span class="k">this</span><span class="p">,</span> <span class="nx">watchInterval</span> <span class="o">=</span> <span class="p">(</span><span class="k">typeof</span> <span class="nx">interval</span> <span class="o">===</span> <span class="s1">'undefined'</span> <span class="o">?</span> <span class="nx">FILE_WATCHER_INTERVAL</span> <span class="o">:</span> <span class="nx">interval</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">FileSystem</span><span class="p">.</span><span class="nx">watch</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">runtimeJsonWatcher</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">runtimeJsonWatcher</span><span class="p">.</span><span class="nx">close</span><span class="p">();</span>
<span class="nx">runtimeJsonWatcher</span> <span class="o">=</span> <span class="kc">null</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
<span class="nx">FileSystem</span><span class="p">.</span><span class="nx">unwatchFile</span><span class="p">(</span><span class="nx">RUNTIME_JSON_FILENAME</span><span class="p">);</span>
<span class="p">}</span>
<span class="c1">// If interval is zero or file watching is disabled, don't attach a new watcher</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">interval</span> <span class="o">===</span> <span class="mi">0</span> <span class="o">||</span> <span class="nx">DISABLE_FILE_WATCH</span> <span class="o">===</span> <span class="s2">"Y"</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span><span class="p">;</span>
<span class="p">}</span>
<span class="c1">// Re-merge the runtime JSON file if we notice a change</span>
<span class="kd">var</span> <span class="nx">onFileChange</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">retry</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">FileSystem</span><span class="p">.</span><span class="nx">readFile</span><span class="p">(</span><span class="nx">RUNTIME_JSON_FILENAME</span><span class="p">,</span> <span class="s1">'UTF-8'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">fileContent</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Not much to do on error</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s2">"Error loading "</span> <span class="o">+</span> <span class="nx">RUNTIME_JSON_FILENAME</span><span class="p">,</span> <span class="nx">err</span><span class="p">);</span>
<span class="k">return</span><span class="p">;</span>
<span class="p">}</span>
<span class="c1">// Parse the file and mix it in to this config object.</span>
<span class="c1">// This notifies listeners</span>
<span class="k">try</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">configObject</span> <span class="o">=</span> <span class="nx">JSON</span><span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">t</span><span class="p">.</span><span class="nx">_stripComments</span><span class="p">(</span><span class="nx">fileContent</span><span class="p">));</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">_extendDeep</span><span class="p">(</span><span class="nx">t</span><span class="p">,</span> <span class="nx">configObject</span><span class="p">);</span>
<span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s2">"Error parsing "</span> <span class="o">+</span> <span class="nx">RUNTIME_JSON_FILENAME</span><span class="p">,</span> <span class="nx">e</span><span class="p">);</span>
<span class="c1">// Retry once - could be someone else writing</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">retry</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">setTimeout</span><span class="p">(</span><span class="kd">function</span><span class="p">(){</span>
<span class="nx">onFileChange</span><span class="p">(</span><span class="kc">true</span><span class="p">);</span>
<span class="p">},</span> <span class="mi">1000</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">return</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">});</span>
<span class="p">};</span>
<span class="c1">// Use the latest version of file watching</span>
<span class="k">try</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">FileSystem</span><span class="p">.</span><span class="nx">watch</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// This is the latest</span>
<span class="nx">runtimeJsonWatcher</span> <span class="o">=</span> <span class="nx">FileSystem</span><span class="p">.</span><span class="nx">watch</span><span class="p">(</span><span class="nx">RUNTIME_JSON_FILENAME</span><span class="p">,</span> <span class="p">{</span><span class="nx">persistent</span><span class="o">:</span><span class="kc">false</span><span class="p">},</span> <span class="kd">function</span><span class="p">(</span><span class="nx">event</span><span class="p">,</span> <span class="nx">filename</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Re-attach watcher on inode change (happens when some editors save a file)</span>
<span class="c1">// Wait for the O/S rename to complete, then re-watch the file</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">event</span> <span class="o">==</span> <span class="s1">'rename'</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">setTimeout</span><span class="p">(</span><span class="kd">function</span><span class="p">(){</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">watchForConfigFileChanges</span><span class="p">();</span>
<span class="nx">onFileChange</span><span class="p">();</span>
<span class="p">},</span> <span class="mi">10</span><span class="p">);</span>
<span class="k">return</span><span class="p">;</span>
<span class="p">}</span>
<span class="nx">onFileChange</span><span class="p">();</span>
<span class="p">});</span>
<span class="p">}</span>
<span class="k">else</span> <span class="p">{</span>
<span class="c1">// Old style polling - only choice if running pre-6.0</span>
<span class="nx">FileSystem</span><span class="p">.</span><span class="nx">watchFile</span><span class="p">(</span><span class="nx">RUNTIME_JSON_FILENAME</span><span class="p">,</span> <span class="p">{</span><span class="nx">persistent</span><span class="o">:</span><span class="kc">false</span><span class="p">,</span> <span class="nx">interval</span><span class="o">:</span><span class="nx">watchInterval</span><span class="p">},</span> <span class="kd">function</span><span class="p">(</span><span class="nx">curr</span><span class="p">,</span> <span class="nx">prev</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">curr</span><span class="p">.</span><span class="nx">mtime</span><span class="p">.</span><span class="nx">getTime</span><span class="p">()</span> <span class="o">===</span> <span class="nx">prev</span><span class="p">.</span><span class="nx">mtime</span><span class="p">.</span><span class="nx">getTime</span><span class="p">())</span> <span class="p">{</span><span class="k">return</span><span class="p">;}</span>
<span class="nx">onFileChange</span><span class="p">();</span>
<span class="p">});</span>
<span class="p">}</span>
<span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Complain if it exists and we can't watch it</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">e</span><span class="p">.</span><span class="nx">code</span> <span class="o">!==</span> <span class="s1">'ENOENT'</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s2">"Error watching for file: "</span> <span class="o">+</span> <span class="nx">RUNTIME_JSON_FILENAME</span><span class="p">,</span> <span class="nx">e</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">};</span>
<span class="cm">/**</span>
<span class="cm"> * Return the sources for the configurations</span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * All sources for configurations are stored in an array of objects containing</span>
<span class="cm"> * the source name (usually the filaname), the original source (as a string),</span>
<span class="cm"> * and the parsed source as an object.</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * @method getConfigSources</span>
<span class="cm"> * @return configSources {Array[Object]} - An array of objects containing</span>
<span class="cm"> * name, original, and parsed elements</span>
<span class="cm"> */</span>
<span class="nx">Config</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">getConfigSources</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">t</span> <span class="o">=</span> <span class="k">this</span><span class="p">;</span>
<span class="k">return</span> <span class="nx">configSources</span><span class="p">.</span><span class="nx">slice</span><span class="p">(</span><span class="mi">0</span><span class="p">);</span>
<span class="p">};</span>
<span class="cm">/**</span>
<span class="cm"> * <p></span>
<span class="cm"> * Watch the specified object for a change in properties, and persist changes</span>
<span class="cm"> * to runtime.json when a change is detected.</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * @protected</span>
<span class="cm"> * @param object {object} - The config object to watch</span>
<span class="cm"> * @method _persistConfigsOnChange</span>
<span class="cm"> */</span>
<span class="nx">Config</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">_persistConfigsOnChange</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">objectToWatch</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">PERSIST_ON_CHANGE</span> <span class="o">===</span> <span class="s1">'N'</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span><span class="p">;</span>
<span class="p">}</span>
<span class="c1">// Watch for configuration value changes</span>
<span class="kd">var</span> <span class="nx">t</span> <span class="o">=</span> <span class="k">this</span><span class="p">;</span>
<span class="nx">objectToWatch</span> <span class="o">=</span> <span class="nx">objectToWatch</span> <span class="o">||</span> <span class="nx">t</span><span class="p">;</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">watch</span><span class="p">(</span><span class="nx">objectToWatch</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="kd">function</span><span class="p">(){</span>
<span class="c1">// Return early if we're already queued up for persisting</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">isQueuedForPersistence</span><span class="p">)</span>
<span class="k">return</span><span class="p">;</span>
<span class="c1">// Defer persisting until the next tick. This results in a single</span>
<span class="c1">// persist across any number of config changes in a single event cycle.</span>
<span class="nx">isQueuedForPersistence</span> <span class="o">=</span> <span class="kc">true</span><span class="p">;</span>
<span class="nx">process</span><span class="p">.</span><span class="nx">nextTick</span><span class="p">(</span><span class="kd">function</span><span class="p">(){</span>
<span class="c1">// Persist if necessary</span>
<span class="kd">var</span> <span class="nx">newDiffs</span> <span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">_diffDeep</span><span class="p">(</span><span class="nx">originalConfig</span><span class="p">,</span> <span class="nx">t</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">t</span><span class="p">.</span><span class="nx">_equalsDeep</span><span class="p">(</span><span class="nx">newDiffs</span><span class="p">,</span> <span class="nx">runtimeJson</span><span class="p">))</span> <span class="p">{</span>
<span class="nx">FileSystem</span><span class="p">.</span><span class="nx">writeFile</span><span class="p">(</span><span class="nx">RUNTIME_JSON_FILENAME</span><span class="p">,</span> <span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">newDiffs</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">2</span><span class="p">),</span> <span class="s1">'utf-8'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">error</span><span class="p">){</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">error</span><span class="p">)</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s2">"Error writing "</span> <span class="o">+</span> <span class="nx">RUNTIME_JSON_FILENAME</span><span class="p">,</span> <span class="nx">error</span><span class="p">);</span>
<span class="p">});</span>
<span class="p">}</span>
<span class="c1">// Set up for next time</span>
<span class="nx">isQueuedForPersistence</span> <span class="o">=</span> <span class="kc">false</span><span class="p">;</span>
<span class="p">});</span>
<span class="p">});</span>
<span class="p">};</span>
<span class="cm">/**</span>
<span class="cm"> * Load the individual file configurations.</span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * This method builds a map of filename to the configuration object defined</span>
<span class="cm"> * by the file. The search order is:</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <pre></span>
<span class="cm"> * default.EXT</span>
<span class="cm"> * (hostname).EXT</span>
<span class="cm"> * (deployment).EXT</span>
<span class="cm"> * (hostname)-(deployment).EXT</span>
<span class="cm"> * local.EXT</span>
<span class="cm"> * local-(deployment).EXT</span>
<span class="cm"> * runtime.json</span>
<span class="cm"> * </pre></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * EXT can be yml, yaml, coffee, json, or js signifying the file type.</span>
<span class="cm"> * yaml (and yml) is in YAML format, coffee is a coffee-script,</span>
<span class="cm"> * json is in JSON format, and js is a javascript executable file that is</span>
<span class="cm"> * require()'d with module.exports being the config object.</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * hostname is the $HOST environment variable (or --HOST command line parameter)</span>
<span class="cm"> * if set, otherwise the $HOSTNAME environment variable (or --HOSTNAME command</span>
<span class="cm"> * line parameter) if set, otherwise the hostname found from</span>
<span class="cm"> * require('os').hostname().</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * Once a hostname is found, everything from the first period ('.') onwards</span>
<span class="cm"> * is removed. For example, abc.example.com becomes abc</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * (deployment) is the deployment type, found in the $NODE_ENV environment</span>
<span class="cm"> * variable or --NODE_ENV command line parameter. Defaults to 'development'.</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * The runtime.json file contains configuration changes made at runtime either</span>
<span class="cm"> * manually, or by the application setting a configuration value.</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * If the $NODE_APP_INSTANCE environment variable (or --NODE_APP_INSTANCE</span>
<span class="cm"> * command line parameter) is set, then files with this appendage will be loaded.</span>
<span class="cm"> * See the Multiple Applicstion Instances section of the main documentaion page</span>
<span class="cm"> * for more information.</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * @protected</span>
<span class="cm"> * @method _loadFileConfigs</span>
<span class="cm"> * @return {this} The configuration object</span>
<span class="cm"> */</span>
<span class="nx">Config</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">_loadFileConfigs</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
<span class="c1">// Initialize</span>
<span class="kd">var</span> <span class="nx">t</span> <span class="o">=</span> <span class="k">this</span><span class="p">;</span>
<span class="c1">// Run only once</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">originalConfig</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">t</span><span class="p">;</span>
<span class="p">}</span>
<span class="c1">// Determine the host name from the OS module, $HOST, or $HOSTNAME</span>
<span class="c1">// Remove any . appendages, and default to null if not set</span>
<span class="k">try</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">hostName</span> <span class="o">=</span> <span class="nx">HOST</span> <span class="o">||</span> <span class="nx">HOSTNAME</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">hostName</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">OS</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'os'</span><span class="p">);</span>
<span class="nx">hostName</span> <span class="o">=</span> <span class="nx">OS</span><span class="p">.</span><span class="nx">hostname</span><span class="p">();</span>
<span class="p">}</span>
<span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">hostName</span> <span class="o">=</span> <span class="s1">''</span><span class="p">;</span>
<span class="p">}</span>
<span class="nx">hostName</span> <span class="o">=</span> <span class="nx">hostName</span> <span class="o">?</span> <span class="nx">hostName</span><span class="p">.</span><span class="nx">split</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> <span class="o">:</span> <span class="kc">null</span><span class="p">;</span>
<span class="c1">// Read each file in turn</span>
<span class="kd">var</span> <span class="nx">baseNames</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'default'</span><span class="p">,</span> <span class="nx">hostName</span><span class="p">,</span> <span class="nx">NODE_ENV</span><span class="p">,</span> <span class="nx">hostName</span> <span class="o">+</span> <span class="s1">'-'</span> <span class="o">+</span> <span class="nx">NODE_ENV</span><span class="p">,</span> <span class="s1">'local'</span><span class="p">,</span> <span class="s1">'local-'</span> <span class="o">+</span> <span class="nx">NODE_ENV</span><span class="p">];</span>
<span class="kd">var</span> <span class="nx">extNames</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'js'</span><span class="p">,</span> <span class="s1">'json'</span><span class="p">,</span> <span class="s1">'coffee'</span><span class="p">,</span> <span class="s1">'yaml'</span><span class="p">,</span> <span class="s1">'yml'</span><span class="p">];</span>
<span class="nx">baseNames</span><span class="p">.</span><span class="nx">forEach</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">baseName</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">extNames</span><span class="p">.</span><span class="nx">forEach</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">extName</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Try merging the config object into this object</span>
<span class="kd">var</span> <span class="nx">fullFilename</span> <span class="o">=</span> <span class="nx">CONFIG_DIR</span> <span class="o">+</span> <span class="s1">'/'</span> <span class="o">+</span> <span class="nx">baseName</span> <span class="o">+</span> <span class="s1">'.'</span> <span class="o">+</span> <span class="nx">extName</span><span class="p">;</span>
<span class="kd">var</span> <span class="nx">configObj</span> <span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">_parseFile</span><span class="p">(</span><span class="nx">fullFilename</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">configObj</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">_extendDeep</span><span class="p">(</span><span class="nx">t</span><span class="p">,</span> <span class="nx">configObj</span><span class="p">);</span>
<span class="p">}</span>
<span class="c1">// See if the application instance file is available</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">APP_INSTANCE</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">fullFilename</span> <span class="o">=</span> <span class="nx">CONFIG_DIR</span> <span class="o">+</span> <span class="s1">'/'</span> <span class="o">+</span> <span class="nx">baseName</span> <span class="o">+</span> <span class="s1">'-'</span> <span class="o">+</span> <span class="nx">APP_INSTANCE</span> <span class="o">+</span> <span class="s1">'.'</span> <span class="o">+</span> <span class="nx">extName</span><span class="p">;</span>
<span class="nx">configObj</span> <span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">_parseFile</span><span class="p">(</span><span class="nx">fullFilename</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">configObj</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">_extendDeep</span><span class="p">(</span><span class="nx">t</span><span class="p">,</span> <span class="nx">configObj</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">});</span>
<span class="p">});</span>
<span class="c1">// Override configurations with the old-style environment variables</span>
<span class="c1">// Warning: This will be deprecated in a future major revision release</span>
<span class="kd">var</span> <span class="nx">oldStyleEnv</span> <span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">_loadOldStyleEnv</span><span class="p">();</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">oldStyleEnv</span><span class="p">).</span><span class="nx">length</span> <span class="o">></span> <span class="mi">2</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">_extendDeep</span><span class="p">(</span><span class="nx">t</span><span class="p">,</span> <span class="nx">oldStyleEnv</span><span class="p">);</span>
<span class="nx">configSources</span><span class="p">.</span><span class="nx">push</span><span class="p">({</span>
<span class="nx">name</span><span class="o">:</span> <span class="s2">"Old-Style Environment Variables"</span><span class="p">,</span>
<span class="nx">parsed</span><span class="o">:</span> <span class="nx">oldStyleEnv</span><span class="p">,</span>
<span class="p">});</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'\nWarning - old style $CONFIG_* environment configurations found. Convert to $NODE_CONFIG={JSON}'</span><span class="p">)</span>
<span class="p">}</span>
<span class="c1">// Override configurations from the $NODE_CONFIG environment variable</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">NODE_CONFIG</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">newStyleEnv</span> <span class="o">=</span> <span class="p">{};</span>
<span class="k">try</span> <span class="p">{</span>
<span class="nx">newStyleEnv</span> <span class="o">=</span> <span class="nx">JSON</span><span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">NODE_CONFIG</span><span class="p">);</span>
<span class="p">}</span> <span class="k">catch</span><span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s1">'The $NODE_CONFIG environment variable is malformed JSON'</span><span class="p">);</span>
<span class="p">}</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">_extendDeep</span><span class="p">(</span><span class="nx">t</span><span class="p">,</span> <span class="nx">newStyleEnv</span><span class="p">);</span>
<span class="nx">configSources</span><span class="p">.</span><span class="nx">push</span><span class="p">({</span>
<span class="nx">name</span><span class="o">:</span> <span class="s2">"$NODE_CONFIG"</span><span class="p">,</span>
<span class="nx">parsed</span><span class="o">:</span> <span class="nx">newStyleEnv</span><span class="p">,</span>
<span class="p">});</span>
<span class="p">}</span>
<span class="c1">// Override configurations from the --NODE_CONFIG command line</span>
<span class="kd">var</span> <span class="nx">cmdLineConfig</span> <span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">_getCmdLineArg</span><span class="p">(</span><span class="s1">'NODE_CONFIG'</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">cmdLineConfig</span><span class="p">)</span> <span class="p">{</span>
<span class="k">try</span> <span class="p">{</span>
<span class="nx">cmdLineConfig</span> <span class="o">=</span> <span class="nx">JSON</span><span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">cmdLineConfig</span><span class="p">);</span>
<span class="p">}</span> <span class="k">catch</span><span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s1">'The --NODE_CONFIG={json} command line argument is malformed JSON'</span><span class="p">);</span>
<span class="p">}</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">_extendDeep</span><span class="p">(</span><span class="nx">t</span><span class="p">,</span> <span class="nx">cmdLineConfig</span><span class="p">);</span>
<span class="nx">configSources</span><span class="p">.</span><span class="nx">push</span><span class="p">({</span>
<span class="nx">name</span><span class="o">:</span> <span class="s2">"--NODE_CONFIG argument"</span><span class="p">,</span>
<span class="nx">parsed</span><span class="o">:</span> <span class="nx">cmdLineConfig</span><span class="p">,</span>
<span class="p">});</span>
<span class="p">}</span>
<span class="c1">// Remember the original configuration (before adding runtimeJson)</span>
<span class="nx">originalConfig</span> <span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">_cloneDeep</span><span class="p">(</span><span class="nx">t</span><span class="p">);</span>
<span class="c1">// Extend the original config with any prior runtime.json diffs</span>
<span class="nx">runtimeJson</span> <span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">_parseFile</span><span class="p">(</span><span class="nx">RUNTIME_JSON_FILENAME</span><span class="p">)</span> <span class="o">||</span> <span class="p">{};</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">_extendDeep</span><span class="p">(</span><span class="nx">t</span><span class="p">,</span> <span class="nx">runtimeJson</span><span class="p">);</span>
<span class="c1">// Attach the config.prototype to all sub-objects.</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">_attachProtoDeep</span><span class="p">(</span><span class="nx">t</span><span class="p">);</span>
<span class="c1">// Return the configuration object</span>
<span class="k">return</span> <span class="nx">t</span><span class="p">;</span>
<span class="p">};</span>
<span class="cm">/**</span>
<span class="cm"> * Check for the old-style environment variable configurations</span>
<span class="cm"> *</span>
<span class="cm"> * @protected</span>
<span class="cm"> * @deprecated</span>
<span class="cm"> * @method _loadOldStyleEnv</span>
<span class="cm"> * @return {Object} old-style configurations from process.env</span>
<span class="cm"> */</span>
<span class="nx">Config</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">_loadOldStyleEnv</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">t</span> <span class="o">=</span> <span class="k">this</span><span class="p">,</span>
<span class="nx">envOverride</span> <span class="o">=</span> <span class="p">{};</span>
<span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">varName</span> <span class="k">in</span> <span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">varName</span><span class="p">.</span><span class="nx">indexOf</span><span class="p">(</span><span class="s1">'CONFIG_'</span><span class="p">)</span> <span class="o">===</span> <span class="mi">0</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Get the string or numeric value</span>
<span class="kd">var</span> <span class="nx">value</span> <span class="o">=</span> <span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">[</span><span class="nx">varName</span><span class="p">],</span>
<span class="nx">floatVal</span> <span class="o">=</span> <span class="nb">parseFloat</span><span class="p">(</span><span class="nx">value</span><span class="p">),</span>
<span class="nx">value</span> <span class="o">=</span> <span class="nx">floatVal</span><span class="p">.</span><span class="nx">toString</span><span class="p">()</span> <span class="o">===</span> <span class="nx">value</span> <span class="o">?</span> <span class="nx">floatVal</span> <span class="o">:</span> <span class="nx">value</span><span class="p">;</span>
<span class="c1">// Convert __ to ` (which you can't have in environment variables)</span>
<span class="c1">// After splitting, ` are converted to single underscores</span>
<span class="nx">varName</span> <span class="o">=</span> <span class="nx">varName</span><span class="p">.</span><span class="nx">replace</span><span class="p">(</span><span class="sr">/__/g</span><span class="p">,</span><span class="s1">'`'</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">parts</span> <span class="o">=</span> <span class="nx">varName</span><span class="p">.</span><span class="nx">split</span><span class="p">(</span><span class="s1">'_'</span><span class="p">);</span>
<span class="nx">parts</span><span class="p">.</span><span class="nx">splice</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="mi">1</span><span class="p">);</span> <span class="c1">// remove CONFIG</span>
<span class="kd">var</span> <span class="nx">curCtxt</span> <span class="o">=</span> <span class="nx">envOverride</span><span class="p">;</span>
<span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="nx">l</span> <span class="o">=</span> <span class="nx">parts</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span> <span class="nx">i</span> <span class="o"><</span> <span class="nx">l</span><span class="p">;</span> <span class="nx">i</span><span class="o">++</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">partName</span> <span class="o">=</span> <span class="nx">parts</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">replace</span><span class="p">(</span><span class="sr">/`/g</span><span class="p">,</span><span class="s1">'_'</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">i</span> <span class="o">==</span> <span class="nx">l</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Final (element) part</span>
<span class="nx">curCtxt</span><span class="p">[</span><span class="nx">partName</span><span class="p">]</span> <span class="o">=</span> <span class="nx">value</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">else</span> <span class="p">{</span>
<span class="c1">// Mid (object) part</span>
<span class="nx">curCtxt</span><span class="p">[</span><span class="nx">partName</span><span class="p">]</span> <span class="o">=</span> <span class="nx">curCtxt</span><span class="p">[</span><span class="nx">partName</span><span class="p">]</span> <span class="o">||</span> <span class="p">{};</span>
<span class="nx">curCtxt</span> <span class="o">=</span> <span class="nx">curCtxt</span><span class="p">[</span><span class="nx">partName</span><span class="p">];</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="k">return</span> <span class="nx">envOverride</span><span class="p">;</span>
<span class="p">}</span>
<span class="cm">/**</span>
<span class="cm"> * Parse and return the specified configuration file.</span>
<span class="cm"> *</span>
<span class="cm"> * If the file exists in the application config directory, it will</span>
<span class="cm"> * parse and return it as a JavaScript object.</span>
<span class="cm"> *</span>
<span class="cm"> * The file extension determines the parser to use.</span>
<span class="cm"> *</span>
<span class="cm"> * .js = File to run that has a module.exports containing the config object</span>
<span class="cm"> * .json = File is parsed using JSON.parse()</span>
<span class="cm"> * .coffee = File to run that has a module.exports with coffee-script containing the config object</span>
<span class="cm"> * .yaml (or .yml) = Parsed with a YAML parser</span>
<span class="cm"> *</span>
<span class="cm"> * If the file doesn't exist, a null will be returned. If the file can't be</span>
<span class="cm"> * parsed, an exception will be thrown.</span>
<span class="cm"> *</span>
<span class="cm"> * This method performs synchronous file operations, and should not be called</span>
<span class="cm"> * after synchronous module loading.</span>
<span class="cm"> *</span>
<span class="cm"> * @protected</span>
<span class="cm"> * @method _parseFile</span>
<span class="cm"> * @param fullFilename {string} The full file path and name</span>
<span class="cm"> * @return {configObject} The configuration object parsed from the file</span>
<span class="cm"> */</span>
<span class="nx">Config</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">_parseFile</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">fullFilename</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Initialize</span>
<span class="kd">var</span> <span class="nx">t</span> <span class="o">=</span> <span class="k">this</span><span class="p">,</span>
<span class="nx">extension</span> <span class="o">=</span> <span class="nx">fullFilename</span><span class="p">.</span><span class="nx">substr</span><span class="p">(</span><span class="nx">fullFilename</span><span class="p">.</span><span class="nx">lastIndexOf</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span><span class="p">),</span>
<span class="nx">configObject</span> <span class="o">=</span> <span class="kc">null</span><span class="p">,</span>
<span class="nx">fileContent</span> <span class="o">=</span> <span class="kc">null</span><span class="p">;</span>
<span class="c1">// Make sure the runtime.json file exists. This is required for fs.watch().</span>
<span class="kd">var</span> <span class="nx">checkRuntimeJson</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">fullFilename</span> <span class="o">==</span> <span class="nx">RUNTIME_JSON_FILENAME</span><span class="p">)</span> <span class="p">{</span>
<span class="k">try</span> <span class="p">{</span>
<span class="nx">FileSystem</span><span class="p">.</span><span class="nx">writeFileSync</span><span class="p">(</span><span class="nx">RUNTIME_JSON_FILENAME</span><span class="p">,</span> <span class="s1">'{}'</span><span class="p">);</span>
<span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// If we cannot write file, clear watch function.</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">watchForConfigFileChanges</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
<span class="k">return</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
<span class="k">return</span> <span class="p">{};</span>
<span class="p">}</span>
<span class="k">return</span> <span class="kc">null</span><span class="p">;</span>
<span class="p">};</span>
<span class="c1">// Return null if the file doesn't exist.</span>
<span class="c1">// Note that all methods here are the Sync versions. This is appropriate during</span>
<span class="c1">// module loading (which is a synchronous operation), but not thereafter.</span>
<span class="k">try</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">stat</span> <span class="o">=</span> <span class="nx">FileSystem</span><span class="p">.</span><span class="nx">statSync</span><span class="p">(</span><span class="nx">fullFilename</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">stat</span> <span class="o">||</span> <span class="nx">stat</span><span class="p">.</span><span class="nx">size</span> <span class="o"><</span> <span class="mi">1</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">checkRuntimeJson</span><span class="p">();</span>
<span class="p">}</span>
<span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="nx">e1</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">checkRuntimeJson</span><span class="p">();</span>
<span class="p">}</span>
<span class="c1">// Try loading the file.</span>
<span class="k">try</span> <span class="p">{</span>
<span class="nx">fileContent</span> <span class="o">=</span> <span class="nx">FileSystem</span><span class="p">.</span><span class="nx">readFileSync</span><span class="p">(</span><span class="nx">fullFilename</span><span class="p">,</span> <span class="s1">'UTF-8'</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">catch</span> <span class="p">(</span><span class="nx">e2</span><span class="p">)</span> <span class="p">{</span>
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s1">'Config file '</span> <span class="o">+</span> <span class="nx">fullFilename</span> <span class="o">+</span> <span class="s1">' cannot be read'</span><span class="p">);</span>
<span class="p">}</span>
<span class="c1">// Parse the file based on extension</span>
<span class="k">try</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">extension</span> <span class="o">===</span> <span class="s1">'yaml'</span> <span class="o">||</span> <span class="nx">extension</span> <span class="o">===</span> <span class="s1">'yml'</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">Yaml</span> <span class="o">&&</span> <span class="o">!</span><span class="nx">VisionmediaYaml</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Lazy loading</span>
<span class="k">try</span> <span class="p">{</span>
<span class="c1">// Try to load the better js-yaml module</span>
<span class="nx">Yaml</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'js-yaml'</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">catch</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// If it doesn't exist, load the fallback visionmedia yaml module.</span>
<span class="nx">VisionmediaYaml</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'yaml'</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">Yaml</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">configObject</span> <span class="o">=</span> <span class="nx">Yaml</span><span class="p">.</span><span class="nx">load</span><span class="p">(</span><span class="nx">t</span><span class="p">.</span><span class="nx">_stripYamlComments</span><span class="p">(</span><span class="nx">fileContent</span><span class="p">));</span>
<span class="p">}</span>
<span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="nx">VisionmediaYaml</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// The yaml library doesn't like strings that have newlines but don't</span>
<span class="c1">// end in a newline: https://github.com/visionmedia/js-yaml/issues/issue/13</span>
<span class="nx">fileContent</span> <span class="o">+=</span> <span class="s1">'\n'</span><span class="p">;</span>
<span class="nx">configObject</span> <span class="o">=</span> <span class="nx">VisionmediaYaml</span><span class="p">.</span><span class="nb">eval</span><span class="p">(</span><span class="nx">t</span><span class="p">.</span><span class="nx">_stripYamlComments</span><span class="p">(</span><span class="nx">fileContent</span><span class="p">));</span>
<span class="p">}</span>
<span class="k">else</span> <span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s2">"No YAML parser loaded. Suggest adding js-yaml dependency to your package.json file."</span><span class="p">)</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="nx">extension</span> <span class="o">==</span> <span class="s1">'json'</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Allow comments in JSON files</span>
<span class="nx">configObject</span> <span class="o">=</span> <span class="nx">JSON</span><span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">t</span><span class="p">.</span><span class="nx">_stripComments</span><span class="p">(</span><span class="nx">fileContent</span><span class="p">));</span>
<span class="p">}</span>
<span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="nx">extension</span> <span class="o">==</span> <span class="s1">'js'</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Use the built-in parser for .js files</span>
<span class="nx">configObject</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="nx">fullFilename</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="nx">extension</span> <span class="o">==</span> <span class="s1">'coffee'</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Lazy load the coffee-script extension</span>
<span class="nx">Coffee</span> <span class="o">=</span> <span class="nx">Coffee</span> <span class="o">||</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'coffee-script'</span><span class="p">);</span>
<span class="c1">// Use the built-in parser for .coffee files with coffee-script</span>
<span class="nx">configObject</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="nx">fullFilename</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="k">catch</span> <span class="p">(</span><span class="nx">e3</span><span class="p">)</span> <span class="p">{</span>
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s2">"Cannot parse config file: '"</span> <span class="o">+</span> <span class="nx">fullFilename</span> <span class="o">+</span> <span class="s2">"': "</span> <span class="o">+</span> <span class="nx">e3</span><span class="p">);</span>
<span class="p">}</span>
<span class="c1">// Keep track of this configuration source if it has anything in it</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">configObject</span><span class="p">).</span><span class="nx">length</span> <span class="o">></span> <span class="mi">2</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">configSources</span><span class="p">.</span><span class="nx">push</span><span class="p">({</span>
<span class="nx">name</span><span class="o">:</span> <span class="nx">fullFilename</span><span class="p">,</span>
<span class="nx">original</span><span class="o">:</span> <span class="nx">fileContent</span><span class="p">,</span>
<span class="nx">parsed</span><span class="o">:</span> <span class="nx">configObject</span><span class="p">,</span>
<span class="p">});</span>
<span class="p">}</span>
<span class="k">return</span> <span class="nx">configObject</span><span class="p">;</span>
<span class="p">};</span>
<span class="cm">/**</span>
<span class="cm"> * Attach the Config class prototype to all config objects recursively.</span>
<span class="cm"> *</span>
<span class="cm"> * <p></span>
<span class="cm"> * This allows you to do anything with CONFIG sub-objects as you can do with</span>
<span class="cm"> * the top-level CONFIG object. It's so you can do this:</span>
<span class="cm"> * </p></span>
<span class="cm"> *</span>
<span class="cm"> * <pre></span>
<span class="cm"> * var CUST_CONFIG = require('config').Customer;</span>
<span class="cm"> * CUST_CONFIG.watch(...)</span>
<span class="cm"> * </pre></span>
<span class="cm"> *</span>
<span class="cm"> * @protected</span>
<span class="cm"> * @method _attachProtoDeep</span>
<span class="cm"> * @param toObject</span>
<span class="cm"> * @param depth</span>
<span class="cm"> * @return toObject</span>
<span class="cm"> */</span>
<span class="nx">Config</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">_attachProtoDeep</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">toObject</span><span class="p">,</span> <span class="nx">depth</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Recursion detection</span>
<span class="kd">var</span> <span class="nx">t</span> <span class="o">=</span> <span class="k">this</span><span class="p">;</span>