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

Upgrade proposals: estimated upgrade time #507

Merged
merged 3 commits into from
Nov 25, 2024
Merged

Conversation

fadeev
Copy link
Member

@fadeev fadeev commented Nov 16, 2024

Summary by CodeRabbit

  • New Features
    • Introduced the Moment.js library for enhanced date manipulation.
    • Added a new column for "Estimated Upgrade Time" in the GovUpgradeProposals component, displaying time until upgrades based on the latest block height.
  • Bug Fixes
    • Improved error handling for proposals data fetching and updated error messages for clarity.

Copy link

vercel bot commented Nov 16, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 21, 2024 7:29am

Copy link
Contributor

coderabbitai bot commented Nov 16, 2024

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

📥 Commits

Reviewing files that changed from the base of the PR and between 75fca03 and ba2b7b2.

📒 Files selected for processing (1)
  • src/components/Docs/components/GovUpgradeProposals.tsx (6 hunks)
 _______________________________________
< Nullus Bugus Maximus. No bug too big. >
 ---------------------------------------
  \
   \   \
        \ /\
        ( )
      .( o ).
📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces a new dependency, Moment.js, to the package.json file for date manipulation. In the GovUpgradeProposals.tsx component, significant modifications include the renaming of an API constant, the addition of a new constant for fetching blockchain data, and the introduction of a state variable to track the latest block height. A new useEffect hook is implemented for fetching this data, along with enhanced error handling. Additionally, a function to calculate estimated upgrade times is added, and the component's rendered output now features a new column for these estimates.

Changes

File Path Change Summary
package.json Added dependency: "moment": "^2.30.1" in dependencies.
src/components/Docs/components/GovUpgradeProposals.tsx - Renamed constant: API to API_PROPOSALS.
- Added constant: API_BLOCKS.
- Added state variable: latestBlock.
- Introduced useEffect for fetching latest block data.
- Added function: calculateUpgradeTime for estimating upgrade time.
- Updated error handling and logging for proposals data.
- Rendered table now includes "Estimated Upgrade Time" column.

Possibly related PRs

  • Fix URL when fetching gov proposals #396: The changes in GovUpgradeProposals.tsx involve updates to API endpoint URLs, which are relevant to the same component where the moment library is now utilized for calculating upgrade times.

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.

@fadeev fadeev linked an issue Nov 16, 2024 that may be closed by this pull request
@fadeev
Copy link
Member Author

fadeev commented Nov 16, 2024

@CharlieMc0 added "Estimated upgrade time" estimated based on 5.5 s block time. Anything else we want to see from Polkachu's table?

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

🧹 Outside diff range and nitpick comments (4)
package.json (1)

58-58: Pin the dependency version

If moment.js must be retained, consider pinning its version to avoid unexpected breaking changes:

-    "moment": "^2.30.1",
+    "moment": "2.30.1",

This aligns with the versioning strategy used for other dependencies in the project.

src/components/Docs/components/GovUpgradeProposals.tsx (3)

9-16: Refactor API endpoints configuration

The API endpoints contain duplicated URL patterns and could benefit from a more maintainable structure.

const API_CONFIG = {
  testnet: {
    baseUrl: 'https://zetachain-athens',
    providers: {
      allthatnode: '.g.allthatnode.com/archive/rest',
      blockpi: '.blockpi.network/lcd/v1/public'
    }
  },
  mainnet: {
    baseUrl: 'https://zetachain',
    providers: {
      allthatnode: '.g.allthatnode.com/archive/rest',
      blockpi: '.blockpi.network/lcd/v1/public'
    }
  }
};

const buildUrl = (network: NetworkType, provider: string, path: string) => 
  `${API_CONFIG[network].baseUrl}${API_CONFIG[network].providers[provider]}${path}`;

Line range hint 70-98: Improve type safety and error handling in proposal fetching

The current implementation uses any types extensively and could benefit from proper TypeScript interfaces and more user-friendly error handling.

interface UpgradePlan {
  name: string;
  height: number;
  info: string;
}

interface Proposal {
  status: string;
  messages: Array<{
    '@type': string;
    plan?: UpgradePlan;
  }>;
}

const transformProposal = (proposal: Proposal) => {
  const plan = proposal.messages.find(msg => 
    msg['@type'].includes('MsgSoftwareUpgrade'))?.plan;
  
  if (!plan) return null;

  return {
    ...proposal,
    plan,
    status: proposal.status
      .replace('PROPOSAL_STATUS_', '')
      .replace(/_/g, ' ')
      .toLowerCase()
  };
};

const fetchProposals = async () => {
  try {
    const response = await fetch(API_PROPOSALS[activeTab.networkType]);
    const data = await response.json();

    if (!data?.proposals) {
      throw new Error('Invalid response format');
    }

    const upgrades = data.proposals
      .map(transformProposal)
      .filter(Boolean)
      .sort((a, b) => b.plan.height - a.plan.height);

    return upgrades;
  } catch (error) {
    console.error('Error:', error);
    throw new Error('Failed to fetch upgrade proposals');
  }
};

Line range hint 137-148: Enhance UI feedback for time estimates

Consider adding loading and error states for the time estimates to improve user experience.

<td>
  {latestBlock === 0 ? (
    <span className="text-gray-400">Loading...</span>
  ) : (
    calculateUpgradeTime(proposal.plan.height)
  )}
</td>
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6bc6fe5 and 75fca03.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (2)
  • package.json (2 hunks)
  • src/components/Docs/components/GovUpgradeProposals.tsx (6 hunks)

package.json Show resolved Hide resolved
src/components/Docs/components/GovUpgradeProposals.tsx Outdated Show resolved Hide resolved
Copy link
Collaborator

@GMaiolo GMaiolo left a comment

Choose a reason for hiding this comment

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

utACK

Co-authored-by: Guillermo Maiolo <guille.maiolo@gmail.com>
@fadeev fadeev merged commit 07bc9c5 into main Nov 25, 2024
5 checks passed
@fadeev fadeev deleted the estimated-upgrade-time branch November 25, 2024 07:22
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.

A page for displaying network upgrades
2 participants