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

Issueid #231004 feat:play youtube help video in mylearning iframe #219

Merged

Conversation

ajinkyapandetekdi
Copy link
Collaborator

@ajinkyapandetekdi ajinkyapandetekdi commented Nov 25, 2024

Summary by CodeRabbit

  • New Features
    • Introduced a streamlined help video link feature that posts a message instead of opening a modal.
  • Bug Fixes
    • Removed outdated video modal functionality for improved user experience.
  • Refactor
    • Simplified control flow by eliminating unnecessary modal logic.

Copy link

coderabbitai bot commented Nov 25, 2024

Walkthrough

The changes in the pull request focus on the src/components/Assesment/Assesment.jsx file, where a video modal feature has been removed. The state management and handlers associated with the video modal have been eliminated. Instead, a new functionality has been introduced that posts a message containing the help video link to the parent window when the help video button is clicked, based on a specific environment variable. The Dialog component that displayed the video has also been removed, streamlining the control flow of the component.

Changes

File Path Change Summary
src/components/Assesment/Assesment.jsx Removed video modal feature, including isVideoOpen state and handleOpenVideo/handleCloseVideo methods. Introduced message posting for help video links based on REACT_APP_SHOW_HELP_VIDEO. Removed Dialog component.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Assesment
    participant ParentWindow

    User->>Assesment: Click help video button
    Assesment->>ParentWindow: Post help video link (if REACT_APP_SHOW_HELP_VIDEO is true)
Loading

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/components/Assesment/Assesment.jsx

Oops! Something went wrong! :(

ESLint: 7.32.0

ESLint couldn't find the config "react-app" to extend from. Please check that the name of the config is correct.

The config "react-app" was referenced from the config file in "/package.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.


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.

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.

if (process.env.REACT_APP_SHOW_HELP_VIDEO === "true") {
window.parent.postMessage(
{
helpVideo: process.env.REACT_APP_SHOW_HELP_VIDEO_LINK,
Copy link
Member

Choose a reason for hiding this comment

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

This should be part of the parent app

Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
D Security Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

const handleCloseVideo = () => {
setIsVideoOpen(false);
if (process.env.REACT_APP_SHOW_HELP_VIDEO === "true") {
window.parent.postMessage(

Check failure

Code scanning / SonarCloud

Origins should be verified during cross-origin communications High

Specify a target origin for this message. See more on SonarQube Cloud
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: 1

🧹 Outside diff range and nitpick comments (2)
src/components/Assesment/Assesment.jsx (2)

653-655: Enhance message structure for better maintainability

Consider using a more structured message format with type and payload fields for better maintainability and future extensibility.

Apply this improvement:

      window.parent.postMessage(
        {
-          message: "help-video-link",
+          type: "HELP_VIDEO",
+          payload: {
+            action: "OPEN",
+            videoType: "help"
+          }
        },
        "*"
      );

651-651: Consider centralizing feature flag management

The direct usage of environment variables for feature flags could be improved by centralizing the configuration management.

Consider creating a dedicated configuration module:

// config/features.js
export const FEATURES = {
  HELP_VIDEO: process.env.REACT_APP_SHOW_HELP_VIDEO === "true",
  // Add other feature flags here
};

Then use it in your component:

-    if (process.env.REACT_APP_SHOW_HELP_VIDEO === "true") {
+    if (FEATURES.HELP_VIDEO) {
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fb4f571 and caf4d24.

📒 Files selected for processing (1)
  • src/components/Assesment/Assesment.jsx (1 hunks)
🧰 Additional context used
🪛 GitHub Check: SonarCloud
src/components/Assesment/Assesment.jsx

[failure] 652-652: Origins should be verified during cross-origin communications

Specify a target origin for this message.

See more on SonarQube Cloud

Comment on lines 651 to 658
if (process.env.REACT_APP_SHOW_HELP_VIDEO === "true") {
window.parent.postMessage(
{
message: "help-video-link",
},
"*"
);
}
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Add origin verification to postMessage for security

The current implementation of postMessage lacks origin verification, which could lead to security vulnerabilities. Always specify the target origin when using cross-origin communication.

Apply this fix:

    if (process.env.REACT_APP_SHOW_HELP_VIDEO === "true") {
      window.parent.postMessage(
        {
          message: "help-video-link",
        },
-        "*"
+        process.env.REACT_APP_PARENT_ORIGIN || window.location.origin
      );
    }

Also, ensure to add REACT_APP_PARENT_ORIGIN to your environment variables.

Committable suggestion skipped: line range outside the PR's diff.

🧰 Tools
🪛 GitHub Check: SonarCloud

[failure] 652-652: Origins should be verified during cross-origin communications

Specify a target origin for this message.

See more on SonarQube Cloud

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: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between caf4d24 and 5999899.

📒 Files selected for processing (1)
  • src/components/Assesment/Assesment.jsx (1 hunks)

Comment on lines +651 to +681
if (process.env.REACT_APP_SHOW_HELP_VIDEO === "true") {
let allowedOrigins = [];
try {
allowedOrigins = JSON.parse(
process.env.REACT_APP_PARENT_ORIGIN_URL || "[]"
);
} catch (error) {
console.error(
"Invalid JSON format in REACT_APP_PARENT_ORIGIN_URL:",
error
);
}

const parentOrigin =
window?.location?.ancestorOrigins?.[0] || window.parent.location.origin;

const handleCloseVideo = () => {
setIsVideoOpen(false);
if (allowedOrigins.includes(parentOrigin)) {
try {
window.parent.postMessage(
{
message: "help-video-link",
},
parentOrigin
);
} catch (error) {
console.error("Error sending postMessage:", error);
}
} else {
console.warn(`Parent origin "${parentOrigin}" is not allowed.`);
}
}
Copy link

Choose a reason for hiding this comment

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

💡 Codebase verification

🛠️ Refactor suggestion

Security vulnerability: Multiple instances of unrestricted postMessage usage found

The verification revealed several security issues in the codebase:

  • src/components/DiscoverSentance/DiscoverSentance.jsx:104-110: Unrestricted postMessage with wildcard origin
  • src/components/Assesment/Assesment.jsx:352: Unrestricted postMessage with wildcard origin
  • src/views/Practice/Practice.jsx:125-131: Unrestricted postMessage with wildcard origin
  • src/views/Practice/Practice.jsx:763: Unrestricted postMessage with wildcard origin

The original review comment's security concerns are valid and even more critical now, as we've found multiple instances of unsafe cross-origin communication using wildcard origins ("*"). All these locations need the same origin verification pattern proposed in the review.

🔗 Analysis chain

Enhance security and error handling in cross-origin communication

The implementation has good security measures but could be strengthened further:

  1. Origin verification could be more robust
  2. Error handling could be more specific
  3. Environment variables should be validated at startup

Apply these improvements:

 const handleOpenVideo = () => {
   if (process.env.REACT_APP_SHOW_HELP_VIDEO === "true") {
     let allowedOrigins = [];
     try {
       allowedOrigins = JSON.parse(
         process.env.REACT_APP_PARENT_ORIGIN_URL || "[]"
       );
+      if (!Array.isArray(allowedOrigins)) {
+        throw new Error('REACT_APP_PARENT_ORIGIN_URL must be a JSON array');
+      }
     } catch (error) {
       console.error(
         "Invalid JSON format in REACT_APP_PARENT_ORIGIN_URL:",
         error
       );
+      return;
     }

     const parentOrigin =
       window?.location?.ancestorOrigins?.[0] || window.parent.location.origin;
+    
+    // Validate origin format
+    try {
+      new URL(parentOrigin);
+    } catch {
+      console.error(`Invalid parent origin format: ${parentOrigin}`);
+      return;
+    }

     if (allowedOrigins.includes(parentOrigin)) {
       try {
         window.parent.postMessage(
           {
             message: "help-video-link",
+            timestamp: Date.now(), // Add timestamp for message validation
           },
           parentOrigin
         );
       } catch (error) {
-        console.error("Error sending postMessage:", error);
+        console.error("Failed to send postMessage:", {
+          error: error.message,
+          parentOrigin,
+          timestamp: new Date().toISOString()
+        });
       }
     } else {
-      console.warn(`Parent origin "${parentOrigin}" is not allowed.`);
+      console.error(`Security violation: Unauthorized parent origin "${parentOrigin}"`);
     }
   }
 };

Consider implementing these additional security measures:

  1. Add message versioning for better compatibility
  2. Implement a message acknowledgment mechanism
  3. Add rate limiting for postMessage calls
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify if there are any other postMessage calls without origin verification
ast-grep --pattern 'window.parent.postMessage($$$, "*")'

# Check for potential security issues in postMessage usage
rg -n "postMessage.*\*" --type js

Length of output: 1485

@gouravmore gouravmore merged commit 240c84f into Sunbird-ALL:all-1.3-tn-dev-hotfix Nov 26, 2024
bharathrams pushed a commit to Bhashabyasa/nd-all-learner-ai-app that referenced this pull request Dec 2, 2024
Issueid #231004 feat:play youtube help video in mylearning iframe
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.

2 participants