chore: code split for consolidated api span names to add module instances and entities in EE #38804

ApekshaBhosale · 2025-01-22T15:13:15Z

Description

Tip

Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team).

Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR.

Fixes #Issue Number
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags="@tag.All"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12945714399
Commit: f794c00
Cypress dashboard.
Tags: @tag.All
Spec:

Fri, 24 Jan 2025 12:14:23 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

Yes
No

Summary by CodeRabbit

Refactor
- Restructured span naming constants for consolidated API tracing
- Introduced a new base class ConsolidatedApiSpanNamesCE to centralize span name definitions
- Updated inheritance structure for ConsolidatedApiSpanNames
New Features
- Added comprehensive span naming constants for various application components
- Standardized span naming with appsmith. prefix for improved tracing consistency

coderabbitai · 2025-01-22T15:13:26Z

Walkthrough

The pull request introduces a new class ConsolidatedApiSpanNamesCE in the com.appsmith.external.constants.spans.ce package, which defines a comprehensive set of span name constants for performance tracing. The existing ConsolidatedApiSpanNames class has been refactored to extend this new class, effectively centralizing and standardizing span naming conventions across the application's tracing infrastructure.

Changes

File	Change Summary
`app/server/appsmith-interfaces/src/main/java/.../ConsolidatedApiSpanNames.java`	Refactored to extend `ConsolidatedApiSpanNamesCE`, removing local constant definitions
`app/server/appsmith-interfaces/src/main/java/.../ce/ConsolidatedApiSpanNamesCE.java`	New class added with multiple public static final span name constants prefixed with `appsmith.`

Possibly related PRs

chore: Add span for measuring performance of consolidated api #37328: Adds spans for measuring consolidated API performance
chore: span push and sentry logs #36682: Includes error handling and logging enhancements
chore: Add code split for adding package pull status indicator #37944: Modifies ConsolidatedAPIServiceCEImpl class related to API interactions

Suggested labels

skip-changelog, ok-to-test, Integrations Pod General, Query & JS Pod

Suggested reviewers

nidhi-nair
sondermanish

Poem

Spans of tracing, constants bright,
Naming patterns taking flight!
From CE to interface they go,
Performance tracking's gentle flow
Code poetry in Java's embrace 🚀

✨ Finishing Touches

📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

app/server/appsmith-interfaces/src/main/java/com/appsmith/external/constants/spans/ce/ConsolidatedApiSpanNamesCE.java (1)

10-34: Consider grouping related constants using nested classes.

While the constants are well-named, consider organizing related spans (e.g., pages, actions, datasources) into nested static classes for better maintainability.

Example refactoring:

 public class ConsolidatedApiSpanNamesCE {
     public static final String CONSOLIDATED_API_PREFIX = APPSMITH_SPAN_PREFIX + "consolidated-api.";
     public static final String VIEW = "view.";
     public static final String EDIT = "edit.";
     public static final String ROOT = "root";
     public static final String CONSOLIDATED_API_ROOT_EDIT = CONSOLIDATED_API_PREFIX + EDIT + ROOT;
     public static final String CONSOLIDATED_API_ROOT_VIEW = CONSOLIDATED_API_PREFIX + VIEW + ROOT;
 
+    public static class UserSpans {
         public static final String USER_PROFILE_SPAN = "user_profile";
         public static final String FEATURE_FLAG_SPAN = "feature_flag";
         public static final String TENANT_SPAN = "tenant";
+    }
 
+    public static class PageSpans {
         public static final String PAGES_SPAN = "pages";
         public static final String PAGES_DSL_SPAN = "pages_dsl_list";
         public static final String CURRENT_PAGE_SPAN = "current_page";
+    }
 
     // ... similar groupings for other related constants
 }

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b14669e and f794c00.

📒 Files selected for processing (2)

app/server/appsmith-interfaces/src/main/java/com/appsmith/external/constants/spans/ConsolidatedApiSpanNames.java (1 hunks)
app/server/appsmith-interfaces/src/main/java/com/appsmith/external/constants/spans/ce/ConsolidatedApiSpanNamesCE.java (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: server-spotless / spotless-check
GitHub Check: server-unit-tests / server-unit-tests

🔇 Additional comments (2)

app/server/appsmith-interfaces/src/main/java/com/appsmith/external/constants/spans/ConsolidatedApiSpanNames.java (1)

3-3: Clean implementation of code split.

The refactoring to extend ConsolidatedApiSpanNamesCE is well-structured and maintains all functionality through inheritance.

Also applies to: 9-9

app/server/appsmith-interfaces/src/main/java/com/appsmith/external/constants/spans/ce/ConsolidatedApiSpanNamesCE.java (1)

1-8: LGTM! Well-documented span naming requirements.

The import and documentation clearly communicate the critical requirement about the appsmith. prefix.

code split for consolidated api span names

f794c00

github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Jan 22, 2025

ApekshaBhosale requested review from rajatagrawal and trishaanand January 22, 2025 15:14

coderabbitai bot reviewed Jan 22, 2025

View reviewed changes

rajatagrawal approved these changes Jan 23, 2025

View reviewed changes

ApekshaBhosale added the ok-to-test Required label for CI label Jan 24, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: code split for consolidated api span names to add module instances and entities in EE #38804

chore: code split for consolidated api span names to add module instances and entities in EE #38804

ApekshaBhosale commented Jan 22, 2025 •

edited by github-actions bot

Loading

coderabbitai bot commented Jan 22, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

coderabbitai bot left a comment

chore: code split for consolidated api span names to add module instances and entities in EE #38804

Are you sure you want to change the base?

chore: code split for consolidated api span names to add module instances and entities in EE #38804

Conversation

ApekshaBhosale commented Jan 22, 2025 • edited by github-actions bot Loading

Description

Automation

🔍 Cypress test results

Communication

Summary by CodeRabbit

coderabbitai bot commented Jan 22, 2025 • edited Loading

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

ApekshaBhosale commented Jan 22, 2025 •

edited by github-actions bot

Loading

coderabbitai bot commented Jan 22, 2025 •

edited

Loading