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

feat(web): add example of show selected features information in plugin playground #1376

Open
wants to merge 16 commits into
base: main
Choose a base branch
from

Conversation

ShogoHirasawa
Copy link
Contributor

@ShogoHirasawa ShogoHirasawa commented Jan 27, 2025

Overview

This is PR for adding Plugin Playgroung example.

What I've done

  • I have created "Show Selected Features Information" in Manage Layer.
  • User can understand how to get information that feature have through this example.
  • It is used 3D Tiles(PLATEAU)to show that

What I haven't done

How I tested

I have tested in my local environment.

Which point I want you to review particularly

Memo

Summary by CodeRabbit

  • New Features
    • Added a new plugin for displaying selected feature information in the Re:Earth environment.
    • Enables viewing building IDs and feature details when clicking on 3D Tiles layers.
    • Integrated new feature selection and information display functionality.
    • Introduced the "Manage Layer" category with the new showFeaturesInfo plugin option.

Copy link

coderabbitai bot commented Jan 27, 2025

Warning

Rate limit exceeded

@ShogoHirasawa has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 51 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between a9ea53b and e6643b4.

📒 Files selected for processing (1)
  • web/src/beta/features/PluginPlayground/Plugins/presets/layers/showSelectedFeaturesInformation.ts (1 hunks)

Walkthrough

This pull request introduces a new plugin called showFeaturesInfo to the Re:Earth Plugin Playground. The plugin is designed to display selected feature information when a user interacts with a 3D layer. It has been added to the presetPlugins array in the plugin configuration, expanding the existing set of layer management tools. The implementation includes a YAML file for metadata and a widget file that handles feature selection and information display.

Changes

File Change Summary
web/src/beta/features/PluginPlayground/Plugins/presets/index.ts Added import for showFeaturesInfo and included it in the presetPlugins array
web/src/beta/features/PluginPlayground/Plugins/presets/layers/showSelectedFeaturesInformation.ts Created new plugin with yamlFile and widgetFile for displaying feature information

Possibly related PRs

Suggested reviewers

  • mkumbobeaty
  • airslice

Poem

🐰 A rabbit's tale of layers bright,
Where features dance in digital light,
Click and reveal, a magical scene,
Information flows, crisp and clean,
Re:Earth plugins, oh what a delight! 🌍


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.

Copy link

netlify bot commented Jan 27, 2025

Deploy Preview for reearth-web ready!

Name Link
🔨 Latest commit e6643b4
🔍 Latest deploy log https://app.netlify.com/sites/reearth-web/deploys/679785d0d84a9c00085bdcb5
😎 Deploy Preview https://deploy-preview-1376--reearth-web.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

@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: 0

🧹 Nitpick comments (5)
web/src/beta/features/PluginPlayground/Plugins/presets/layers/showSelectedFeaturesInformation.ts (5)

46-46: Fix HTML structure.

There's an orphaned closing </p> tag without a corresponding opening tag.

-      <span id="message" class="displayId"></span></p>
+      <span id="message" class="displayId"></span>

50-57: Enhance message handling robustness.

The message handling could be more robust by:

  1. Validating the message origin
  2. Adding error handling for missing elements
     window.addEventListener('message', function(e) {
+      // Validate message origin
+      if (e.source !== parent) return;
+
       if (e.data?.action === "buildingClick") {
         const gmlId = e.data.payload?.gmlId || "";
         const messageEl = document.getElementById("message");
+        if (!messageEl) {
+          console.error("Message element not found");
+          return;
+        }
         messageEl.textContent = gmlId;
       }
     });

65-76: Consider making the tileset URL configurable.

The tileset URL is hardcoded, which could make it difficult to:

  1. Switch between different PLATEAU datasets
  2. Handle URL changes or migrations
  3. Support different environments (development, staging, production)

Consider making this configurable through plugin settings or environment variables.

Also, please add documentation for the 3D tiles configuration options to improve maintainability.


78-102: Add error handling for layer setup and improve camera configuration.

  1. Add error handling for layer addition
  2. Consider making camera position configurable or document why these specific coordinates are used
 // Add the 3D Tiles layer from the URL to Re:Earth
-reearth.layers.add(layer3dTiles);
+try {
+  reearth.layers.add(layer3dTiles);
+} catch (error) {
+  console.error("Failed to add 3D Tiles layer:", error);
+}

+// Camera position for Minato-ku, Tokyo
 reearth.camera.flyTo(
   {
     heading: 4.022965234428543,

104-126: Add error handling for feature lookup.

The feature selection handling looks good, but could benefit from additional error handling for the feature lookup.

   // Get information about the selected building (feature)
-  const feature = reearth.layers.findFeatureById(layerId, featureId);
+  let feature;
+  try {
+    feature = reearth.layers.findFeatureById(layerId, featureId);
+  } catch (error) {
+    console.error("Failed to find feature:", error);
+    reearth.ui.postMessage({
+      action: "buildingClick",
+      payload: { gmlId: "", error: "Failed to fetch feature information" },
+    });
+    return;
+  }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e2b9520 and 6e0dc27.

📒 Files selected for processing (2)
  • web/src/beta/features/PluginPlayground/Plugins/presets/index.ts (2 hunks)
  • web/src/beta/features/PluginPlayground/Plugins/presets/layers/showSelectedFeaturesInformation.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: ci-server / ci-server-lint
  • GitHub Check: ci-web / ci
  • GitHub Check: ci-server / ci-server-test
🔇 Additional comments (3)
web/src/beta/features/PluginPlayground/Plugins/presets/index.ts (1)

15-15: LGTM! Plugin integration looks good.

The new plugin is correctly imported and integrated into the layers category of preset plugins.

Also applies to: 61-62

web/src/beta/features/PluginPlayground/Plugins/presets/layers/showSelectedFeaturesInformation.ts (2)

4-23: LGTM! Plugin configuration is well-structured.

The YAML configuration appropriately defines the widget layout and metadata.


129-133: LGTM! Plugin export is correctly structured.

The plugin is exported with the appropriate type and includes all necessary files.

Copy link
Contributor

@mulengawilfred mulengawilfred left a comment

Choose a reason for hiding this comment

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

Looks good to me. Small question. Is it possible to display other information including the building id, like building height for example?

Comment on lines 15 to 19
widgetLayout:
defaultLocation:
zone: outer
section: center
area: top
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
widgetLayout:
defaultLocation:
zone: outer
section: center
area: top

Better remove this part unless current plugin requires any certain location.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants