-
Notifications
You must be signed in to change notification settings - Fork 37
chore(node-client): harden existing platform implementation #1403
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
joker23
wants to merge
7
commits into
main
Choose a base branch
from
skz/sdk-2195/node-client-sdk-next-port-client-harden-platform-io
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
922614d
fix: Harden Node platform I/O durability and resource limits
joker23 8203c63
test: Add coverage for Node platform hardening
joker23 60da3e6
chore: bot comments
joker23 f87b76d
chore: bot comment
joker23 696e085
chore: remove timeout from NodeRequests
joker23 2e0e11a
chore: reverting response body limit
joker23 a00473e
Update packages/sdk/node-client/src/platform/NodeStorage.ts
joker23 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -46,11 +46,19 @@ export default class NodeStorage implements Storage { | |
| try { | ||
| const data = await fs.readFile(this._storageFile, 'utf8'); | ||
| const parsed = JSON.parse(data); | ||
| if (parsed && typeof parsed === 'object') { | ||
| this._cache = new Map(Object.entries(parsed as Record<string, string>)); | ||
| if (parsed && typeof parsed === 'object' && !Array.isArray(parsed)) { | ||
| const entries = Object.entries(parsed).filter( | ||
| ([, value]) => typeof value === 'string', | ||
| ) as [string, string][]; | ||
| this._cache = new Map(entries); | ||
| } | ||
| } catch (error) { | ||
| if ((error as NodeJS.ErrnoException)?.code !== 'ENOENT') { | ||
| this._logger?.warn( | ||
| `Discarding malformed flag cache at ${this._storageFile}: ${error instanceof Error ? error.message : error}`, | ||
| ); | ||
| await this._atomicWriteToFile(this._cache); | ||
| } | ||
| } catch { | ||
| await this._atomicWriteToFile(this._cache); | ||
| } | ||
|
|
||
| return true; | ||
|
|
@@ -62,10 +70,29 @@ export default class NodeStorage implements Storage { | |
|
|
||
| private async _atomicWriteToFile(data: Map<string, string>): Promise<void> { | ||
| const content = JSON.stringify(Object.fromEntries(data)); | ||
| let handle: fs.FileHandle | undefined; | ||
| try { | ||
| await fs.writeFile(this._tempFile, content, { encoding: 'utf8', mode: 0o600 }); | ||
| try { | ||
| await fs.unlink(this._tempFile); | ||
| } catch { | ||
| // Either the temp file didn't exist, which we don't care about or there was | ||
| // a problem deleting the file, for example a problem with permissions, in | ||
| // which case the subsequent write will likely also fail and be handled by its | ||
| // exception handler. | ||
| } | ||
| handle = await fs.open(this._tempFile, 'wx', 0o600); | ||
| await handle.writeFile(content, 'utf8'); | ||
| await handle.close(); | ||
| handle = undefined; | ||
| await fs.rename(this._tempFile, this._storageFile); | ||
| } catch (error) { | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It does feel like we probably should log something in this error handler. |
||
| if (handle) { | ||
| try { | ||
| await handle.close(); | ||
| } catch { | ||
| // Ignore close errors during cleanup. | ||
| } | ||
| } | ||
| try { | ||
| await fs.unlink(this._tempFile); | ||
| } catch { | ||
|
|
@@ -142,15 +169,22 @@ export default class NodeStorage implements Storage { | |
| // process share the same cache file. The first call's storagePath / logger wins; | ||
| // later calls ignore the arguments. | ||
| let instance: NodeStorage | undefined; | ||
| let instancePath: string | undefined; | ||
|
|
||
| export function getNodeStorage(storagePath?: string, logger?: LDLogger): NodeStorage { | ||
| if (!instance) { | ||
| instance = new NodeStorage(storagePath, logger); | ||
| instancePath = storagePath; | ||
| } else if (storagePath !== undefined && storagePath !== instancePath) { | ||
| logger?.warn( | ||
| `NodeStorage was already initialized with a different localStoragePath; ignoring '${storagePath}'.`, | ||
| ); | ||
| } | ||
| return instance; | ||
| } | ||
|
|
||
| /** @internal Visible for testing only. */ | ||
| export function resetNodeStorage(): void { | ||
| instance = undefined; | ||
| instancePath = undefined; | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I assume the file being missing isn't the only reason it cannot be deleted. For example if it was created by a different user or with different permissions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yea that would also cause issues, but the exception will be caught further down.