Session replay options inconsistency across docs and exported types for JS Web SDK
Maintainer thường phản hồi trong vòng 1 ngày
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 58/100
- Loại issue
- Lỗi
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- typescript
- Lĩnh vực
- documentation, web-dev
Hướng nghiên cứu
Compare the session replay documentation at /docs/sdks/web and /docs/session-replay with packages/sdks/web/src/index.ts and packages/sdks/web/src/replay/recorder.ts. First determine whether maskTextSelector is intended to be supported; done means the chosen behavior, exported type, recorder handling, and documentation consistently agree.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
In https://openpanel.dev/docs/sdks/web, a maskTextSelector option is mentioned. This option is neither present in https://openpanel.dev/docs/session-replay or in the declared SessionReplayOptions type.
A value which seems it could come from this configuration is hard-coded in https://github.com/Openpanel-dev/openpanel/blob/6ae4a60d9035acc70923d70c34fdc6358d70cea7/packages/sdks/web/src/replay/recorder.ts#L113. The hard-coded [data-openpanel-replay-mask] matches the default described in https://openpanel.dev/docs/sdks/web.
This creates a documentation inconsistency, and I'm unsure whether I should rely on the documented default as a workaround, or if this is not intended to be a feature at all.
Given a direction, I'm happy to open a PR to either remove the mention from the docs or to fix the config and wire it to the point where it should be consumed.
- Ngôn ngữ chính
- TypeScript
- Star
- 7.1k
- Fork
- 510
- Merge trung bình
- 7 ngày 2 giờ
- Pull request đã merge (30 ngày)
- 7
Chuẩn bị môi trường
- Có Dockerfile hoặc tệp Docker Compose
- Không có mẫu pull request
- Không có hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của Openpanel-dev/openpanel
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
Openpanel-dev/openpanel#532 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Period comparison badge shows wrong percentage for decreases (100 → 50 shows ↓100%)Có thể đã có người làm @sarmah-rup đã nhận 9 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 85/100
Openpanel-dev/openpanel#526 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Self-hosted missing op1-replay.jsCó thể đã có người làm @houstona đã nhận 9 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
Openpanel-dev/openpanel#512 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
login page needs refinementCó thể đã có người làm @anandghegde đã nhận 24 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
Openpanel-dev/openpanel#495 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 68/100
Openpanel-dev/openpanel#528 ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của Openpanel-dev/openpanel
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 85/100
farbenmeer/tapi#531 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
naver/egjs-flicking#971 ·
-
Renderer treats a sub-pixel width difference as a resize, which cancels the `motion()` entranceĐang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 85/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Tenant
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 66/100
MTES-MCT/Dossier-Facile-Frontend#2061 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 85/100
backnotprop/plannotator#1784 ·
Maintainer thường phản hồi trong vòng 1 ngày