feat(node): Add fsInstrumentation
#13291
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Comment on lines
35
to
44
| app.get('/readFile', async (_, res) => { | ||
| await new Promise<void>(resolve => { | ||
| fs.readFile(path.join(__dirname, 'some-file.txt'), 'utf-8', () => { | ||
| resolve(); | ||
| }); | ||
| }); | ||
| await fs.promises.readFile(path.join(__dirname, 'some-file-promises.txt'), 'utf-8'); | ||
| await util.promisify(fs.readFile)(path.join(__dirname, 'some-file-promisify.txt'), 'utf-8'); | ||
| res.send('done'); | ||
| }); |
Check failure
Code scanning / CodeQL
Missing rate limiting
Comment on lines
+87
to
+97
| app.get('/mkdtemp', async (_, res) => { | ||
| await new Promise<void>(resolve => { | ||
| fs.mkdtemp(path.join(os.tmpdir(), 'foo-'), () => { | ||
| resolve(); | ||
| }); | ||
| }); | ||
| await fs.promises.mkdtemp(path.join(os.tmpdir(), 'foo-')); | ||
| await util.promisify(fs.mkdtemp)(path.join(os.tmpdir(), 'foo-')); | ||
|
|
||
| res.send('done'); | ||
| }); |
Check failure
Code scanning / CodeQL
Missing rate limiting
mydea
reviewed
Aug 9, 2024
| @@ -0,0 +1,11 @@ | |||
| some-file.txt.copy | |||
There was a problem hiding this comment.
Can we just make this: some-file.txt.* ?
There was a problem hiding this comment.
and maybe move them out of the root of the package, into e.g. fixtures/ or something like this?
Comment on lines
+26
to
+33
| app.get('/readFile-error', async (_, res) => { | ||
| try { | ||
| await fs.promises.readFile(path.join(__dirname, 'fixtures', 'some-file-that-doesnt-exist.txt'), 'utf-8'); | ||
| } catch { | ||
| // noop | ||
| } | ||
| res.send('done'); | ||
| }); |
Check failure
Code scanning / CodeQL
Missing rate limiting
Comment on lines
+46
to
+65
| app.get('/copyFile', async (_, res) => { | ||
| await new Promise<void>(resolve => { | ||
| fs.copyFile( | ||
| path.join(__dirname, 'fixtures', 'some-file.txt'), | ||
| path.join(__dirname, 'fixtures', 'some-file.txt.copy'), | ||
| () => { | ||
| resolve(); | ||
| }, | ||
| ); | ||
| }); | ||
| await fs.promises.copyFile( | ||
| path.join(__dirname, 'fixtures', 'some-file-promises.txt'), | ||
| path.join(__dirname, 'fixtures', 'some-file-promises.txt.copy'), | ||
| ); | ||
| await util.promisify(fs.copyFile)( | ||
| path.join(__dirname, 'fixtures', 'some-file-promisify.txt'), | ||
| path.join(__dirname, 'fixtures', 'some-file-promisify.txt.copy'), | ||
| ); | ||
| res.send('done'); | ||
| }); |
Check failure
Code scanning / CodeQL
Missing rate limiting
Comment on lines
+67
to
+93
| app.get('/link', async (_, res) => { | ||
| await new Promise<void>(resolve => { | ||
| fs.link( | ||
| path.join(__dirname, 'fixtures', 'some-file.txt'), | ||
| path.join(__dirname, 'fixtures', 'some-file.txt.link'), | ||
| () => { | ||
| resolve(); | ||
| }, | ||
| ); | ||
| }); | ||
| await fs.promises.link( | ||
| path.join(__dirname, 'fixtures', 'some-file-promises.txt'), | ||
| path.join(__dirname, 'fixtures', 'some-file-promises.txt.link'), | ||
| ); | ||
| await util.promisify(fs.link)( | ||
| path.join(__dirname, 'fixtures', 'some-file-promisify.txt'), | ||
| path.join(__dirname, 'fixtures', 'some-file-promisify.txt.link'), | ||
| ); | ||
|
|
||
| await Promise.all([ | ||
| fs.promises.unlink(path.join(__dirname, 'fixtures', 'some-file.txt.link')), | ||
| fs.promises.unlink(path.join(__dirname, 'fixtures', 'some-file-promises.txt.link')), | ||
| fs.promises.unlink(path.join(__dirname, 'fixtures', 'some-file-promisify.txt.link')), | ||
| ]); | ||
|
|
||
| res.send('done'); | ||
| }); |
Check failure
Code scanning / CodeQL
Missing rate limiting
Comment on lines
+107
to
+133
| app.get('/symlink', async (_, res) => { | ||
| await new Promise<void>(resolve => { | ||
| fs.symlink( | ||
| path.join(__dirname, 'fixtures', 'some-file.txt'), | ||
| path.join(__dirname, 'fixtures', 'some-file.txt.symlink'), | ||
| () => { | ||
| resolve(); | ||
| }, | ||
| ); | ||
| }); | ||
| await fs.promises.symlink( | ||
| path.join(__dirname, 'fixtures', 'some-file-promises.txt'), | ||
| path.join(__dirname, 'fixtures', 'some-file-promises.txt.symlink'), | ||
| ); | ||
| await util.promisify(fs.symlink)( | ||
| path.join(__dirname, 'fixtures', 'some-file-promisify.txt'), | ||
| path.join(__dirname, 'fixtures', 'some-file-promisify.txt.symlink'), | ||
| ); | ||
|
|
||
| await Promise.all([ | ||
| fs.promises.unlink(path.join(__dirname, 'fixtures', 'some-file.txt.symlink')), | ||
| fs.promises.unlink(path.join(__dirname, 'fixtures', 'some-file-promises.txt.symlink')), | ||
| fs.promises.unlink(path.join(__dirname, 'fixtures', 'some-file-promisify.txt.symlink')), | ||
| ]); | ||
|
|
||
| res.send('done'); | ||
| }); |
Check failure
Code scanning / CodeQL
Missing rate limiting
This was referenced Sep 4, 2024
This was referenced Sep 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #13057
This PR adds an integration to instrument
fsAPI. We are using OTEL's@opentelemetry/instrumentation-fsinstrumentation under the hood.The integration creates spans with naming patterns of
fs.readFile,fs.unlink, and so on.Users can configure via option whether they want to include path arguments as attributes, and whether to include error messages as an attribute when an fs call fails.
I have found that the integration can slow down applications massively when there are a lot of fs calls, for example when running a dev server - so I put a disclaimer in the JS doc, and we should also put a similar disclaimer in the docs when we write them.