@photostructure/fs-metadata 0.5.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (116) hide show
  1. package/C++_REVIEW_TODO.md +1 -1
  2. package/CHANGELOG.md +11 -1
  3. package/CLAUDE.md +30 -23
  4. package/CONTRIBUTING.md +41 -0
  5. package/binding.gyp +2 -1
  6. package/dist/index.cjs +1439 -0
  7. package/dist/index.cjs.map +1 -0
  8. package/dist/index.d.cts +360 -0
  9. package/dist/index.d.mts +360 -0
  10. package/dist/index.d.ts +360 -0
  11. package/dist/index.mjs +1397 -0
  12. package/dist/index.mjs.map +1 -0
  13. package/package.json +19 -22
  14. package/prebuilds/darwin-arm64/@photostructure+fs-metadata.glibc.node +0 -0
  15. package/prebuilds/linux-arm64/@photostructure+fs-metadata.musl.node +0 -0
  16. package/prebuilds/linux-x64/@photostructure+fs-metadata.glibc.node +0 -0
  17. package/prebuilds/linux-x64/@photostructure+fs-metadata.musl.node +0 -0
  18. package/prebuilds/win32-x64/@photostructure+fs-metadata.glibc.node +0 -0
  19. package/scripts/check-memory.mjs +53 -173
  20. package/scripts/clang-tidy.mjs +1 -1
  21. package/scripts/sanitizers-test.sh +151 -0
  22. package/scripts/valgrind-test.mjs +1 -1
  23. package/scripts/{valgrind.sh → valgrind-test.sh} +15 -0
  24. package/src/common/error_utils.h +23 -0
  25. package/src/common/metadata_worker.h +4 -1
  26. package/src/darwin/hidden.cpp +13 -6
  27. package/src/darwin/volume_metadata.cpp +2 -2
  28. package/src/darwin/volume_mount_points.cpp +8 -1
  29. package/src/linux/blkid_cache.cpp +8 -2
  30. package/src/linux/volume_metadata.cpp +1 -1
  31. package/src/test-utils/worker-thread-helper.cjs +88 -0
  32. package/src/windows/hidden.cpp +20 -11
  33. package/coverage/base.css +0 -224
  34. package/coverage/block-navigation.js +0 -87
  35. package/coverage/favicon.png +0 -0
  36. package/coverage/index.html +0 -131
  37. package/coverage/lcov-report/base.css +0 -224
  38. package/coverage/lcov-report/block-navigation.js +0 -87
  39. package/coverage/lcov-report/favicon.png +0 -0
  40. package/coverage/lcov-report/index.html +0 -131
  41. package/coverage/lcov-report/prettify.css +0 -1
  42. package/coverage/lcov-report/prettify.js +0 -2
  43. package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  44. package/coverage/lcov-report/sorter.js +0 -196
  45. package/coverage/lcov-report/src/array.ts.html +0 -217
  46. package/coverage/lcov-report/src/async.ts.html +0 -547
  47. package/coverage/lcov-report/src/debuglog.ts.html +0 -187
  48. package/coverage/lcov-report/src/defer.ts.html +0 -175
  49. package/coverage/lcov-report/src/dirname.ts.html +0 -124
  50. package/coverage/lcov-report/src/error.ts.html +0 -322
  51. package/coverage/lcov-report/src/fs.ts.html +0 -316
  52. package/coverage/lcov-report/src/glob.ts.html +0 -472
  53. package/coverage/lcov-report/src/hidden.ts.html +0 -724
  54. package/coverage/lcov-report/src/index.html +0 -521
  55. package/coverage/lcov-report/src/index.ts.html +0 -676
  56. package/coverage/lcov-report/src/linux/dev_disk.ts.html +0 -316
  57. package/coverage/lcov-report/src/linux/index.html +0 -146
  58. package/coverage/lcov-report/src/linux/mount_points.ts.html +0 -364
  59. package/coverage/lcov-report/src/linux/mtab.ts.html +0 -493
  60. package/coverage/lcov-report/src/mount_point.ts.html +0 -106
  61. package/coverage/lcov-report/src/number.ts.html +0 -148
  62. package/coverage/lcov-report/src/object.ts.html +0 -265
  63. package/coverage/lcov-report/src/options.ts.html +0 -475
  64. package/coverage/lcov-report/src/path.ts.html +0 -268
  65. package/coverage/lcov-report/src/platform.ts.html +0 -112
  66. package/coverage/lcov-report/src/random.ts.html +0 -205
  67. package/coverage/lcov-report/src/remote_info.ts.html +0 -553
  68. package/coverage/lcov-report/src/stack_path.ts.html +0 -298
  69. package/coverage/lcov-report/src/string.ts.html +0 -382
  70. package/coverage/lcov-report/src/string_enum.ts.html +0 -208
  71. package/coverage/lcov-report/src/system_volume.ts.html +0 -301
  72. package/coverage/lcov-report/src/unc.ts.html +0 -274
  73. package/coverage/lcov-report/src/units.ts.html +0 -274
  74. package/coverage/lcov-report/src/uuid.ts.html +0 -157
  75. package/coverage/lcov-report/src/volume_health_status.ts.html +0 -259
  76. package/coverage/lcov-report/src/volume_metadata.ts.html +0 -787
  77. package/coverage/lcov-report/src/volume_mount_points.ts.html +0 -388
  78. package/coverage/lcov.info +0 -3581
  79. package/coverage/prettify.css +0 -1
  80. package/coverage/prettify.js +0 -2
  81. package/coverage/sort-arrow-sprite.png +0 -0
  82. package/coverage/sorter.js +0 -196
  83. package/coverage/src/array.ts.html +0 -217
  84. package/coverage/src/async.ts.html +0 -547
  85. package/coverage/src/debuglog.ts.html +0 -187
  86. package/coverage/src/defer.ts.html +0 -175
  87. package/coverage/src/dirname.ts.html +0 -124
  88. package/coverage/src/error.ts.html +0 -322
  89. package/coverage/src/fs.ts.html +0 -316
  90. package/coverage/src/glob.ts.html +0 -472
  91. package/coverage/src/hidden.ts.html +0 -724
  92. package/coverage/src/index.html +0 -521
  93. package/coverage/src/index.ts.html +0 -676
  94. package/coverage/src/linux/dev_disk.ts.html +0 -316
  95. package/coverage/src/linux/index.html +0 -146
  96. package/coverage/src/linux/mount_points.ts.html +0 -364
  97. package/coverage/src/linux/mtab.ts.html +0 -493
  98. package/coverage/src/mount_point.ts.html +0 -106
  99. package/coverage/src/number.ts.html +0 -148
  100. package/coverage/src/object.ts.html +0 -265
  101. package/coverage/src/options.ts.html +0 -475
  102. package/coverage/src/path.ts.html +0 -268
  103. package/coverage/src/platform.ts.html +0 -112
  104. package/coverage/src/random.ts.html +0 -205
  105. package/coverage/src/remote_info.ts.html +0 -553
  106. package/coverage/src/stack_path.ts.html +0 -298
  107. package/coverage/src/string.ts.html +0 -382
  108. package/coverage/src/string_enum.ts.html +0 -208
  109. package/coverage/src/system_volume.ts.html +0 -301
  110. package/coverage/src/unc.ts.html +0 -274
  111. package/coverage/src/units.ts.html +0 -274
  112. package/coverage/src/uuid.ts.html +0 -157
  113. package/coverage/src/volume_health_status.ts.html +0 -259
  114. package/coverage/src/volume_metadata.ts.html +0 -787
  115. package/coverage/src/volume_mount_points.ts.html +0 -388
  116. package/scripts/run-asan.sh +0 -92
package/coverage/src/volume_health_status.ts.html DELETED
@@ -1,259 +0,0 @@
1
-
2
- <!doctype html>
3
- <html lang="en">
4
-
5
- <head>
6
- <title>Code coverage report for src/volume_health_status.ts</title>
7
- <meta charset="utf-8" />
8
- <link rel="stylesheet" href="../prettify.css" />
9
- <link rel="stylesheet" href="../base.css" />
10
- <link rel="shortcut icon" type="image/x-icon" href="../favicon.png" />
11
- <meta name="viewport" content="width=device-width, initial-scale=1" />
12
- <style type='text/css'>
13
- .coverage-summary .sorter {
14
- background-image: url(../sort-arrow-sprite.png);
15
- }
16
- </style>
17
- </head>
18
-
19
- <body>
20
- <div class='wrapper'>
21
- <div class='pad1'>
22
- <h1><a href="../index.html">All files</a> / <a href="index.html">src</a> volume_health_status.ts</h1>
23
- <div class='clearfix'>
24
-
25
- <div class='fl pad1y space-right2'>
26
- <span class="strong">96.55% </span>
27
- <span class="quiet">Statements</span>
28
- <span class='fraction'>56/58</span>
29
- </div>
30
-
31
-
32
- <div class='fl pad1y space-right2'>
33
- <span class="strong">90.9% </span>
34
- <span class="quiet">Branches</span>
35
- <span class='fraction'>10/11</span>
36
- </div>
37
-
38
-
39
- <div class='fl pad1y space-right2'>
40
- <span class="strong">100% </span>
41
- <span class="quiet">Functions</span>
42
- <span class='fraction'>1/1</span>
43
- </div>
44
-
45
-
46
- <div class='fl pad1y space-right2'>
47
- <span class="strong">96.55% </span>
48
- <span class="quiet">Lines</span>
49
- <span class='fraction'>56/58</span>
50
- </div>
51
-
52
-
53
- </div>
54
- <p class="quiet">
55
- Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
56
- </p>
57
- <template id="filterTemplate">
58
- <div class="quiet">
59
- Filter:
60
- <input type="search" id="fileSearch">
61
- </div>
62
- </template>
63
- </div>
64
- <div class='status-line high'></div>
65
- <pre><table class="coverage">
66
- <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
67
- <a name='L2'></a><a href='#L2'>2</a>
68
- <a name='L3'></a><a href='#L3'>3</a>
69
- <a name='L4'></a><a href='#L4'>4</a>
70
- <a name='L5'></a><a href='#L5'>5</a>
71
- <a name='L6'></a><a href='#L6'>6</a>
72
- <a name='L7'></a><a href='#L7'>7</a>
73
- <a name='L8'></a><a href='#L8'>8</a>
74
- <a name='L9'></a><a href='#L9'>9</a>
75
- <a name='L10'></a><a href='#L10'>10</a>
76
- <a name='L11'></a><a href='#L11'>11</a>
77
- <a name='L12'></a><a href='#L12'>12</a>
78
- <a name='L13'></a><a href='#L13'>13</a>
79
- <a name='L14'></a><a href='#L14'>14</a>
80
- <a name='L15'></a><a href='#L15'>15</a>
81
- <a name='L16'></a><a href='#L16'>16</a>
82
- <a name='L17'></a><a href='#L17'>17</a>
83
- <a name='L18'></a><a href='#L18'>18</a>
84
- <a name='L19'></a><a href='#L19'>19</a>
85
- <a name='L20'></a><a href='#L20'>20</a>
86
- <a name='L21'></a><a href='#L21'>21</a>
87
- <a name='L22'></a><a href='#L22'>22</a>
88
- <a name='L23'></a><a href='#L23'>23</a>
89
- <a name='L24'></a><a href='#L24'>24</a>
90
- <a name='L25'></a><a href='#L25'>25</a>
91
- <a name='L26'></a><a href='#L26'>26</a>
92
- <a name='L27'></a><a href='#L27'>27</a>
93
- <a name='L28'></a><a href='#L28'>28</a>
94
- <a name='L29'></a><a href='#L29'>29</a>
95
- <a name='L30'></a><a href='#L30'>30</a>
96
- <a name='L31'></a><a href='#L31'>31</a>
97
- <a name='L32'></a><a href='#L32'>32</a>
98
- <a name='L33'></a><a href='#L33'>33</a>
99
- <a name='L34'></a><a href='#L34'>34</a>
100
- <a name='L35'></a><a href='#L35'>35</a>
101
- <a name='L36'></a><a href='#L36'>36</a>
102
- <a name='L37'></a><a href='#L37'>37</a>
103
- <a name='L38'></a><a href='#L38'>38</a>
104
- <a name='L39'></a><a href='#L39'>39</a>
105
- <a name='L40'></a><a href='#L40'>40</a>
106
- <a name='L41'></a><a href='#L41'>41</a>
107
- <a name='L42'></a><a href='#L42'>42</a>
108
- <a name='L43'></a><a href='#L43'>43</a>
109
- <a name='L44'></a><a href='#L44'>44</a>
110
- <a name='L45'></a><a href='#L45'>45</a>
111
- <a name='L46'></a><a href='#L46'>46</a>
112
- <a name='L47'></a><a href='#L47'>47</a>
113
- <a name='L48'></a><a href='#L48'>48</a>
114
- <a name='L49'></a><a href='#L49'>49</a>
115
- <a name='L50'></a><a href='#L50'>50</a>
116
- <a name='L51'></a><a href='#L51'>51</a>
117
- <a name='L52'></a><a href='#L52'>52</a>
118
- <a name='L53'></a><a href='#L53'>53</a>
119
- <a name='L54'></a><a href='#L54'>54</a>
120
- <a name='L55'></a><a href='#L55'>55</a>
121
- <a name='L56'></a><a href='#L56'>56</a>
122
- <a name='L57'></a><a href='#L57'>57</a>
123
- <a name='L58'></a><a href='#L58'>58</a>
124
- <a name='L59'></a><a href='#L59'>59</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
125
- <span class="cline-any cline-yes">1x</span>
126
- <span class="cline-any cline-yes">1x</span>
127
- <span class="cline-any cline-yes">1x</span>
128
- <span class="cline-any cline-yes">1x</span>
129
- <span class="cline-any cline-yes">1x</span>
130
- <span class="cline-any cline-yes">1x</span>
131
- <span class="cline-any cline-yes">1x</span>
132
- <span class="cline-any cline-yes">1x</span>
133
- <span class="cline-any cline-yes">1x</span>
134
- <span class="cline-any cline-yes">1x</span>
135
- <span class="cline-any cline-yes">1x</span>
136
- <span class="cline-any cline-yes">1x</span>
137
- <span class="cline-any cline-yes">1x</span>
138
- <span class="cline-any cline-yes">1x</span>
139
- <span class="cline-any cline-yes">1x</span>
140
- <span class="cline-any cline-yes">1x</span>
141
- <span class="cline-any cline-yes">1x</span>
142
- <span class="cline-any cline-yes">1x</span>
143
- <span class="cline-any cline-yes">1x</span>
144
- <span class="cline-any cline-yes">1x</span>
145
- <span class="cline-any cline-yes">1x</span>
146
- <span class="cline-any cline-yes">1x</span>
147
- <span class="cline-any cline-yes">1x</span>
148
- <span class="cline-any cline-yes">1x</span>
149
- <span class="cline-any cline-yes">1x</span>
150
- <span class="cline-any cline-yes">1x</span>
151
- <span class="cline-any cline-yes">1x</span>
152
- <span class="cline-any cline-yes">1x</span>
153
- <span class="cline-any cline-yes">1x</span>
154
- <span class="cline-any cline-yes">1x</span>
155
- <span class="cline-any cline-yes">1x</span>
156
- <span class="cline-any cline-yes">1x</span>
157
- <span class="cline-any cline-yes">1x</span>
158
- <span class="cline-any cline-yes">1x</span>
159
- <span class="cline-any cline-yes">1x</span>
160
- <span class="cline-any cline-yes">209x</span>
161
- <span class="cline-any cline-yes">209x</span>
162
- <span class="cline-any cline-yes">209x</span>
163
- <span class="cline-any cline-yes">209x</span>
164
- <span class="cline-any cline-yes">209x</span>
165
- <span class="cline-any cline-yes">209x</span>
166
- <span class="cline-any cline-yes">121x</span>
167
- <span class="cline-any cline-yes">121x</span>
168
- <span class="cline-any cline-yes">209x</span>
169
- <span class="cline-any cline-yes">88x</span>
170
- <span class="cline-any cline-yes">88x</span>
171
- <span class="cline-any cline-yes">88x</span>
172
- <span class="cline-any cline-yes">20x</span>
173
- <span class="cline-any cline-yes">88x</span>
174
- <span class="cline-any cline-yes">4x</span>
175
- <span class="cline-any cline-yes">2x</span>
176
- <span class="cline-any cline-yes">2x</span>
177
- <span class="cline-any cline-yes">4x</span>
178
- <span class="cline-any cline-yes">88x</span>
179
- <span class="cline-any cline-yes">88x</span>
180
- <span class="cline-any cline-no">&nbsp;</span>
181
- <span class="cline-any cline-no">&nbsp;</span>
182
- <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">// src/volume_health_status.ts
183
- &nbsp;
184
- import { TimeoutError } from "./async";
185
- import { debug } from "./debuglog";
186
- import { toError } from "./error";
187
- import { canReaddir } from "./fs";
188
- import { isObject } from "./object";
189
- import { stringEnum, StringEnumKeys } from "./string_enum";
190
- &nbsp;
191
- /**
192
- * Health statuses for volumes (mostly applicable to Windows).
193
- *
194
- * - `healthy`: Volume is "OK": accessible and functioning normally
195
- * - `timeout`: Volume could not be accessed before the specified timeout. It
196
- * may be inaccessible or disconnected.
197
- * - `inaccessible`: Volume exists but can't be accessed (permissions/locks)
198
- * - `disconnected`: Network volume that's offline
199
- * - `unknown`: Status can't be determined
200
- */
201
- export const VolumeHealthStatuses = stringEnum(
202
- "healthy",
203
- "timeout",
204
- "inaccessible",
205
- "disconnected",
206
- "unknown",
207
- );
208
- &nbsp;
209
- export type VolumeHealthStatus = StringEnumKeys&lt;typeof VolumeHealthStatuses&gt;;
210
- &nbsp;
211
- /**
212
- * Attempt to read a directory to determine if it's accessible, and if an error
213
- * is thrown, convert to a health status.
214
- * @returns the "health status" of the directory, based on the success of `readdir(dir)`.
215
- * @throws never
216
- */
217
- export async function directoryStatus(
218
- dir: string,
219
- timeoutMs: number,
220
- canReaddirImpl: typeof canReaddir = canReaddir,
221
- ): Promise&lt;{ status: VolumeHealthStatus; error?: Error }&gt; {
222
- try {
223
- if (await canReaddirImpl(dir, timeoutMs)) {
224
- return { status: VolumeHealthStatuses.healthy };
225
- }
226
- } catch (error) {
227
- debug("[directoryStatus] %s: %s", dir, error);
228
- let status: VolumeHealthStatus = VolumeHealthStatuses.unknown;
229
- if (error instanceof TimeoutError) {
230
- status = VolumeHealthStatuses.timeout;
231
- } else if (isObject(error) &amp;&amp; error instanceof Error &amp;&amp; "code" in error) {
232
- if (error.code === "EPERM" || error.code === "EACCES") {
233
- status = VolumeHealthStatuses.inaccessible;
234
- }
235
- }
236
- return { status, error: toError(error) };
237
- }
238
- <span class="cstat-no" title="statement not covered" ><span class="branch-0 cbranch-no" title="branch not covered" > return { status: VolumeHealthStatuses.unknown };</span></span>
239
- <span class="cstat-no" title="statement not covered" >}</span>
240
- &nbsp;</pre></td></tr></table></pre>
241
-
242
- <div class='push'></div><!-- for sticky footer -->
243
- </div><!-- /wrapper -->
244
- <div class='footer quiet pad2 space-top1 center small'>
245
- Code coverage generated by
246
- <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
247
- at 2025-06-01T20:18:02.872Z
248
- </div>
249
- <script src="../prettify.js"></script>
250
- <script>
251
- window.onload = function () {
252
- prettyPrint();
253
- };
254
- </script>
255
- <script src="../sorter.js"></script>
256
- <script src="../block-navigation.js"></script>
257
- </body>
258
- </html>
259
-