Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removed outdated code related to web analytics #8755

Merged
merged 3 commits into from
Dec 2, 2024

Conversation

bsekachev
Copy link
Member

@bsekachev bsekachev commented Nov 28, 2024

Motivation and context

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • I have created a changelog fragment
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)
  • I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

  • New Features

    • Updated build process for the CVAT UI to enhance configuration handling.
  • Bug Fixes

    • Simplified routing logic in the CVATApplication component to improve navigation tracking.
  • Documentation

    • Updated copyright notice in the environment utility file.
  • Chores

    • Removed unused web analytics tracking function to streamline code.

@bsekachev bsekachev requested a review from azhavoro as a code owner November 28, 2024 13:48
Copy link
Contributor

coderabbitai bot commented Nov 28, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes in this pull request involve modifications to the Dockerfile.ui, cvat-app.tsx, and environment.ts files. The Dockerfile.ui sees the removal of the WA_PAGE_VIEW_HIT argument and updates to build commands. In cvat-app.tsx, the location property is removed from the component's props, affecting how location changes are tracked. The customWaViewHit function is eliminated from environment.ts, along with updates to the copyright notice. Overall, the changes streamline the build process and refine component behavior in response to routing.

Changes

File Change Summary
Dockerfile.ui Removed ARG WA_PAGE_VIEW_HIT; retained UI_APP_CONFIG, CLIENT_PLUGINS, DISABLE_SOURCE_MAPS, SOURCE_MAPS_TOKEN; updated build command.
cvat-ui/src/components/cvat-app.tsx Removed location from this.props in componentDidMount; adjusted customWaViewHit invocation to history.listen; minor error handling adjustments.
cvat-ui/src/utils/environment.ts Updated copyright year to 2024; corrected spelling of "Corporation"; removed customWaViewHit function.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CVATApp
    participant History

    User->>CVATApp: Interacts with application
    CVATApp->>History: Listen for location changes
    History-->>CVATApp: Location change detected
    CVATApp->>CVATApp: Handle new location
Loading

🐇 "In the code, we made a change,
Removed some things, rearranged!
With builds now smooth and clean,
Our app will surely gleam!
Errors handled, routes in sight,
Hopping forward, all feels right!" 🐇


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 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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 88a3301 and 529fee7.

📒 Files selected for processing (3)
  • Dockerfile.ui (0 hunks)
  • cvat-ui/src/components/cvat-app.tsx (1 hunks)
  • cvat-ui/src/utils/environment.ts (1 hunks)
💤 Files with no reviewable changes (1)
  • Dockerfile.ui
✅ Files skipped from review due to trivial changes (1)
  • cvat-ui/src/utils/environment.ts
🔇 Additional comments (2)
cvat-ui/src/components/cvat-app.tsx (2)

Line range hint 144-193: LGTM: Web analytics code removal

The changes appropriately remove web analytics tracking while maintaining essential navigation functionality.


Line range hint 516-673: LGTM: Routing logic remains intact

The routing implementation maintains all necessary paths and authentication flows while removing analytics-related code.

@@ -142,7 +141,7 @@ class CVATApplication extends React.PureComponent<CVATAppProps & RouteComponentP

public componentDidMount(): void {
const core = getCore();
const { history, location, onChangeLocation } = this.props;
const { history, onChangeLocation } = this.props;
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Potential bug: Inconsistent prop usage

The location prop is removed from destructuring but is still used elsewhere in the component. This could lead to runtime errors.

Verify all usages of the location prop and ensure consistent handling:

#!/bin/bash
# Search for all usages of 'location' prop in the component
ast-grep --pattern 'location' cvat-ui/src/components/cvat-app.tsx

@codecov-commenter
Copy link

codecov-commenter commented Nov 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.92%. Comparing base (86deaff) to head (9eadbc3).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #8755   +/-   ##
========================================
  Coverage    73.92%   73.92%           
========================================
  Files          409      409           
  Lines        43932    43925    -7     
  Branches      3984     3983    -1     
========================================
- Hits         32477    32472    -5     
+ Misses       11455    11453    -2     
Components Coverage Δ
cvat-ui 78.36% <ø> (+<0.01%) ⬆️
cvat-server 70.12% <ø> (ø)

@bsekachev bsekachev merged commit 4681dd6 into develop Dec 2, 2024
33 checks passed
@bsekachev bsekachev deleted the bs/removed_outdated_code branch December 3, 2024 06:25
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