Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Replace unsupported fstream in filesystem LOB examples

Đã đóng
  • Có gì không ổn?
#320 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
42/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Sôi nổi
Công nghệ
javascript, node.js
Lĩnh vực
backend, databases

Hướng nghiên cứu

Chờ các maintainer chọn giữa alias, các API filesystem tích hợp sẵn hoặc việc loại bỏ các example. Sau đó kiểm tra package.json, package-lock.json, examples/app5.js, examples/app6.js và phần Running examples trong README; chạy npm test và xác thực mọi phạm vi kiểm thử tập trung nào được yêu cầu cho example. Được xem là hoàn tất khi hướng đã chọn được ghi lại, dependency và các example nhất quán, và unit suite hiện có vẫn ở trạng thái xanh.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

The documented filesystem LOB examples still use the unsupported [email protected] package as a direct development dependency. Would the maintainers prefer to replace that implementation through a compatibility alias, rewrite the examples with Node's built-in filesystem/stream APIs, or remove the dependency/examples if they are no longer supported?

The current uses are limited but real:

  • examples/app5.js imports fstream and calls fstream.Reader({ path: dirname, filter: isChildFile }), then pipes filesystem entries into the HANA statement adapter.
  • examples/app6.js imports fstream and creates new fstream.Writer({ path: dirname, type: 'Directory' }), then pipes HANA LOB rows into the destination directory.
  • Both examples are listed in the README's “Running examples” section.
  • package.json declares the exact direct dev dependency "fstream": "1.0.12".

One low-diff option would be an npm alias:

"fstream": "npm:@stackline/[email protected]"

That would preserve both existing require('fstream') calls and the Reader/Writer API. The expected repository changes would be limited to package.json, package-lock.json, and any focused example coverage the maintainers request. @stackline/fstream declares Node.js >=14.15.1; node-hdb declares Node.js >=18, and its workflow matrix lists Node.js 20, 22, 24, and 26.

The alternative is to replace the examples' fstream-specific entry handling with built-in fs and stream primitives, or remove these examples and the dependency if they are no longer maintained. That avoids adopting another package but is a larger behavioral rewrite. I do not have a preference over the project's desired maintenance direction.

Clean baseline recorded on 2026-08-28 at f26df559cdc9b01e7c5055f3b8571537cac4a4bf, using Node.js v20.20.2 and npm 10.8.2:

  • npm ci: exit 0; 138 packages added, 139 audited; npm emitted the existing fstream deprecation warning.
  • npm test: exit 0; 586 tests passed.

The unit suite does not exercise examples/app5.js or examples/app6.js, and both examples require a configured HANA connection. If the alias option is welcome, I can prepare the package.json/package-lock.json change and include any focused example coverage the maintainers request. It should preserve the clean unit baseline and add or document an isolated Reader/Writer smoke check where practical; end-to-end example validation would still require HANA.

Disclosure: I maintain @stackline/fstream, an independent compatibility-focused package. I am not affiliated with SAP or the node-hdb maintainers. This proposal is about dependency maintenance only. It is not a vulnerability report, makes no security claim about fstream or node-hdb, and does not ask the project to treat it as a security fix.

References:

Ngôn ngữ chính
JavaScript
Star
323
Fork
99
Merge trung bình
24 phút
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của SAP/node-hdb

Tất cả issue của SAP/node-hdb

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.