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

[OTE-129] remove geoblocking from Indexer endpoints #1029

Merged
merged 1 commit into from
Feb 1, 2024

Conversation

dydxwill
Copy link
Contributor

@dydxwill dydxwill commented Jan 31, 2024

Changelist

Remove geoblocking from Indexer endpoints:

  • Compliance endpoints
  • GetCandles
  • GetHeight
  • GetHistoricalFunding
  • GetPerpetualMarket
  • ListPerpetualMarkets
  • GetSparkLines
  • GetTime
  • GetTrades

Test Plan

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Copy link
Contributor

coderabbitai bot commented Jan 31, 2024

Walkthrough

The recent updates involve the removal of the rejectRestrictedCountries middleware across various route handlers and controllers within the service. This change indicates that the application no longer restricts access based on the user's country for endpoints related to perpetual markets, compliance, height, historical funding, order books, sparklines, time, and trades. This could signify a policy shift towards more inclusive access or a restructuring of how country-based restrictions are enforced.

Changes

File Path Change Summary
.../api/v4/candles-controller.ts Removed rejectRestrictedCountries middleware from /perpetualMarkets/:ticker route handler.
.../api/v4/compliance-controller.ts Removed import of rejectRestrictedCountries.
.../api/v4/height-controller.ts Removed rejectRestrictedCountries middleware from GET / endpoint.
.../api/v4/historical-funding-controller.ts Removed rejectRestrictedCountries middleware from GET /:ticker endpoint.
.../api/v4/orderbook-controller.ts Removed import of rejectRestrictedCountries.
.../api/v4/perpetual-markets-controller.ts Removed rejectRestrictedCountries middleware from router.get method; removed corresponding import.
.../api/v4/sparklines-controller.ts Removed rejectRestrictedCountries function from middleware chain in router.get method.
.../api/v4/time-controller.ts Removed rejectRestrictedCountries middleware from / route.
.../api/v4/trades-controller.ts Removed rejectRestrictedCountries middleware from /perpetualMarket/:ticker route; removed corresponding import.

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between bc57835 and b90f422.
Files selected for processing (9)
  • indexer/services/comlink/src/controllers/api/v4/candles-controller.ts (2 hunks)
  • indexer/services/comlink/src/controllers/api/v4/compliance-controller.ts (2 hunks)
  • indexer/services/comlink/src/controllers/api/v4/height-controller.ts (2 hunks)
  • indexer/services/comlink/src/controllers/api/v4/historical-funding-controller.ts (2 hunks)
  • indexer/services/comlink/src/controllers/api/v4/orderbook-controller.ts (2 hunks)
  • indexer/services/comlink/src/controllers/api/v4/perpetual-markets-controller.ts (2 hunks)
  • indexer/services/comlink/src/controllers/api/v4/sparklines-controller.ts (2 hunks)
  • indexer/services/comlink/src/controllers/api/v4/time-controller.ts (2 hunks)
  • indexer/services/comlink/src/controllers/api/v4/trades-controller.ts (2 hunks)
Files skipped from review due to trivial changes (1)
  • indexer/services/comlink/src/controllers/api/v4/historical-funding-controller.ts
Additional comments: 8
indexer/services/comlink/src/controllers/api/v4/time-controller.ts (1)
  • 4-9: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-1]

The removal of rejectRestrictedCountries middleware is aligned with the PR's objective to disable geoblocking. Ensure that all necessary updates to documentation and tests reflecting this change are made.

indexer/services/comlink/src/controllers/api/v4/height-controller.ts (1)
  • 8-13: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-1]

The removal of rejectRestrictedCountries middleware from the height-controller aligns with the PR's goal. Verify that this change does not introduce any security or compliance issues, given the nature of the data being accessed.

indexer/services/comlink/src/controllers/api/v4/orderbook-controller.ts (1)
  • 13-18: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-1]

Confirmed the removal of the rejectRestrictedCountries import. This change is consistent with the PR's objective to remove geoblocking. Ensure that the removal of this middleware does not affect the integrity or security of the data provided by the orderbook endpoint.

indexer/services/comlink/src/controllers/api/v4/candles-controller.ts (1)
  • 12-17: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-1]

The removal of rejectRestrictedCountries middleware from the candles-controller is in line with the PR's objectives. It's important to confirm that this change does not compromise the data's security or accessibility in unintended ways.

indexer/services/comlink/src/controllers/api/v4/sparklines-controller.ts (1)
  • 21-26: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-1]

The removal of rejectRestrictedCountries middleware from the sparklines-controller is consistent with the PR's goal of removing geoblocking. Ensure that this change is thoroughly tested to confirm that it does not introduce any unintended access or data integrity issues.

indexer/services/comlink/src/controllers/api/v4/trades-controller.ts (1)
  • 23-28: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-1]

Confirmed the removal of the rejectRestrictedCountries middleware and its import from the trades-controller. This change aligns with the PR's objectives. It's crucial to ensure that removing this middleware does not expose the endpoint to compliance or security risks.

indexer/services/comlink/src/controllers/api/v4/perpetual-markets-controller.ts (1)
  • 25-30: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-1]

The removal of rejectRestrictedCountries middleware from the perpetual-markets-controller is in line with the PR's objectives. Verify that this change does not introduce any security or compliance issues, given the nature of the data being accessed.

indexer/services/comlink/src/controllers/api/v4/compliance-controller.ts (1)
  • 17-22: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-1]

Confirmed the removal of the rejectRestrictedCountries import from the compliance-controller. This change is consistent with the PR's objective to remove geoblocking. Ensure that the removal of this middleware does not affect the integrity or security of the compliance checks performed by this endpoint.

@dydxwill dydxwill changed the title remove geoblocking from Indexer endpoints [OTE-129] remove geoblocking from Indexer endpoints Feb 1, 2024
Copy link

linear bot commented Feb 1, 2024

@dydxwill dydxwill merged commit f8d8c3c into main Feb 1, 2024
11 checks passed
@dydxwill dydxwill deleted the wl/rm_geoblocking branch February 1, 2024 20:17
dydxwill added a commit that referenced this pull request Mar 5, 2024
* remove geoblocking from Indexer endpoints (#1029)

* [OTE-130] implement new geo-blocking strategy for socks (#1049)
dydxwill added a commit that referenced this pull request Mar 5, 2024
* remove geoblocking from Indexer endpoints (#1029)

* [OTE-130] implement new geo-blocking strategy for socks (#1049)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants