Skip to content

feat: telemetry [WIP]#1932

Open
andrii-harbour wants to merge 10 commits intomainfrom
andrii/sd-1638-telemetry-create-telemetry-set-up-in-superdoc-core-lib
Open

feat: telemetry [WIP]#1932
andrii-harbour wants to merge 10 commits intomainfrom
andrii/sd-1638-telemetry-create-telemetry-set-up-in-superdoc-core-lib

Conversation

@andrii-harbour
Copy link
Contributor

  • Added telemetry support to track document opens for usage-based billing.
  • Introduced initTelemetry method in the Editor class to initialize telemetry based on configuration.
  • Created tests for telemetry functionality, ensuring correct behavior when enabled/disabled and with various configurations.
  • Updated Editor and SuperDoc configurations to include telemetry options and license key handling.
  • Enhanced SuperConverter to manage document creation timestamps for unique identification.

- Added telemetry support to track document opens for usage-based billing.
- Introduced `initTelemetry` method in the Editor class to initialize telemetry based on configuration.
- Created tests for telemetry functionality, ensuring correct behavior when enabled/disabled and with various configurations.
- Updated Editor and SuperDoc configurations to include telemetry options and license key handling.
- Enhanced SuperConverter to manage document creation timestamps for unique identification.
@andrii-harbour andrii-harbour self-assigned this Feb 4, 2026
@linear
Copy link

linear bot commented Feb 4, 2026

@andrii-harbour andrii-harbour changed the title feat: telemetry feat: telemetry [WIP] Feb 4, 2026
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 64ce62e12f

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

- Simplified telemetry logging in the Editor class by removing unnecessary comments and enhancing debug output for document information.
- Removed redundant isNewFile tracking in SuperDoc, allowing automatic handling based on context.
- Introduced default community license key in the Editor class for telemetry initialization.
- Updated `initTelemetry` function to use the default license key when none is provided.
- Added tests to verify behavior with default and custom license keys.
- Improved documentation for the community license key usage.
Copy link
Contributor

@caio-pizzol caio-pizzol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice work! just a few comments

@andrii-harbour
Copy link
Contributor Author

@caio-pizzol forgot to mention. I intentionally left console logs and livetest url here for easy testing. Once code reviewed - I'll remove that of course

- Introduced a guard flag to prevent double-tracking of document opens in the Editor class.
- Updated document identifier generation to be asynchronous, ensuring metadata is available before tracking.
- Enhanced SuperConverter to manage document timestamps and unique identifiers more effectively.
- Added new utility methods for generating Word-compatible timestamps and content hashes.
- Improved test coverage for document identifier resolution and timestamp handling in various scenarios.
@caio-pizzol caio-pizzol self-requested a review February 5, 2026 11:06
Copy link
Contributor

@caio-pizzol caio-pizzol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - feel free to merge after addressing all comments and fixing unit-test

- Renamed `isNewFile` to `isBlankDoc` in SuperConverter for clarity regarding document creation context.
- Updated related comments and documentation to reflect the new naming and functionality.
- Enhanced test cases to align with the refactored telemetry and document handling logic.
@andrii-harbour andrii-harbour force-pushed the andrii/sd-1638-telemetry-create-telemetry-set-up-in-superdoc-core-lib branch from 05fae90 to 43e0d97 Compare February 5, 2026 16:41
- Ensured document metadata is generated regardless of telemetry settings
Copy link
Collaborator

@harbournick harbournick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just the null licenseKey/default stuff otherwise looks good!

- Simplified license key management in telemetry initialization.
- Updated tests to reflect changes in license key usage and ensure correct behavior.
- Introduced COMMUNITY_LICENSE_KEY constant for consistent license key usage across modules.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants