Skip to content

Conversation

@richie-ni
Copy link
Collaborator

@richie-ni richie-ni commented Oct 13, 2025

Pull Request

🤨 Rationale

As part of bypassing webserver for the API that will be used in the Dataframe datasource, this pull request introduces a utility class, ApiSessionUtils, for managing API session keys with caching.

👩‍💻 Implementation

  • Added the ApiSessionUtils class in api-session.utils.ts to handle API session creation, caching, and validation, including a 5-minute expiry buffer and error handling with event publishing.
  • Defined the ApiSession interface to standardize the session object structure.
  • Added documentation to enable and use UI-ingress in local environment.

Reference

The implementation in this PR is inspired by the API session service from the Test Insights App

Prototype PR : #407

🧪 Testing

  • Added Unit tests

✅ Checklist

Copy link
Collaborator

@kartheeswaran-ni kartheeswaran-ni left a comment

Choose a reason for hiding this comment

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

I'm waiting to see the final version with the actual usage of this utility along with docs as we discussed offline.

@richie-ni richie-ni requested a review from priya-ni October 22, 2025 11:04
@richie-ni richie-ni marked this pull request as ready for review October 22, 2025 14:15
Copy link
Collaborator

@kartheeswaran-ni kartheeswaran-ni left a comment

Choose a reason for hiding this comment

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

I would like to take a look once all the comments are addressed.

@richie-ni
Copy link
Collaborator Author

@rajsite , @m-akinc a gentle reminder to review this PR.

Copy link
Collaborator

@m-akinc m-akinc left a comment

Choose a reason for hiding this comment

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

Approving, but I left some feedback.

@richie-ni richie-ni changed the title feat: Implement ApiSession and ApiSessionUtils with session management feat(core): Implement ApiSession and ApiSessionUtils with session management Oct 28, 2025
@richie-ni richie-ni merged commit 3e5a2f4 into main Oct 28, 2025
1 check passed
@richie-ni richie-ni deleted the users/richie/create-api-session-key branch October 28, 2025 10:51
Ahalya-ni pushed a commit that referenced this pull request Oct 28, 2025
## [4.29.0](v4.28.0...v4.29.0) (2025-10-28)

### Features

* **core:** Implement ApiSession and ApiSessionUtils with session management ([#434](#434)) ([3e5a2f4](3e5a2f4))
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.

6 participants