Session replay options inconsistency across docs and exported types for JS Web SDK
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 58/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- typescript
- 領域
- documentation, web-dev
調査の方向性
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.
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- TypeScript
- スター
- 7.1k
- フォーク
- 516
- 平均マージ
- 1日 2時間
- マージ済み PR（30日）
- 18
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
Openpanel-dev/openpanel のほかの issue
-
ClickHouse retry logs print CLICKHOUSE_URL with its password対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 1/5 1〜3時間 初心者へのやさしさ 92/100
Openpanel-dev/openpanel#551 ·
メンテナーはふだん 1 日以内に返信
-
Self-hosted missing op1-replay.js再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
Openpanel-dev/openpanel#512 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
login page needs refinement再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
Openpanel-dev/openpanel#495 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 36/100
Openpanel-dev/openpanel#564 ·
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
Openpanel-dev/openpanel#563 ·
メンテナーはふだん 1 日以内に返信
Openpanel-dev/openpanel の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
logancyang/obsidian-copilot#3753 ·
メンテナーはふだん 1 日以内に返信
-
area: presentation severity: important
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
voithos-labs/aragonite#763 ·
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
diegosouzapw/OmniRoute#17386 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 半日 初心者へのやさしさ 72/100
super-productivity/super-productivity#10982 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信