Skip to content

Conversation

@allouis
Copy link
Collaborator

@allouis allouis commented Apr 16, 2025

ref https://linear.app/ghost/issue/AP-963
ref b682971

Our WebFinger implementation validates that the incoming acct resource has a
proper hostname, and we require there be a top level domain. In testing our
hostnames were all mapped to docker compose service names and so they do not
have a . in them and don't pass this test. This was also the case in the
linked commits isHandle function which has a special branch for test mode.

With docker compose we are able to specify aliases for services on a particular
network. I've gone for a separate testing network here to completely isolate
our testing stack, which is probably unecessary, especially because we're using
the .test TLD which shouldn't interfere with our dev stack, but I think it's
cleaner to have these on separate networks anyway and avoid any cross pollution.

Now that we have hostames which look like real hostnames in tests we're able to
remove test specific handling for the isHandle function. This also switches
us to use the new aliases everywhere in the tests for consistency

allouis added 2 commits April 16, 2025 12:11
ref https://linear.app/ghost/issue/AP-963
ref b682971

Our WebFinger implementation validates that the incoming `acct` resource has a
proper hostname, and we require there be a top level domain. In testing our
hostnames were all mapped to docker compose service names and so they do not
have a `.` in them and don't pass this test. This was also the case in the
linked commits `isHandle` function which has a special branch for test mode.

With docker compose we are able to specify aliases for services on a particular
network. I've gone for a separate testing network here to completely isolate
our testing stack, which is probably unecessary, especially because we're using
the `.test` TLD which shouldn't interfere with our dev stack, but I think it's
cleaner to have these on separate networks anyway and avoid any cross pollution.
Now that we have hostames which look like real hostnames in tests we're able to
remove test specific handling for the `isHandle` function. This also switches
us to use the new aliases everywhere in the tests for consistency
@coderabbitai
Copy link

coderabbitai bot commented Apr 16, 2025

Walkthrough

The changes introduce a new Docker network called test_network with a bridge driver in the docker-compose.yml file. Several testing and mock services are now explicitly connected to this network, and three mock services are assigned specific network aliases using the .test domain suffix. In the test suite, all references to the mock services' URLs are updated to use the .test domain, affecting both feature files and JavaScript step definitions. Additionally, the isHandle function in the ActivityPub actor helper is modified to remove a special-case bypass for handles ending with "@fake-external-activitypub" during testing; all handles are now validated strictly against the existing regex pattern, regardless of environment or suffix. No changes are made to the signatures of exported or public entities.

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4bcc3bc and 2852bcf.

📒 Files selected for processing (4)
  • docker-compose.yml (6 hunks)
  • features/account.feature (1 hunks)
  • features/step_definitions/stepdefs.js (45 hunks)
  • src/helpers/activitypub/actor.ts (0 hunks)
💤 Files with no reviewable changes (1)
  • src/helpers/activitypub/actor.ts
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Build, Test and Push
🔇 Additional comments (3)
docker-compose.yml (1)

104-247: Test network and alias configuration is correct and aligns with best practices.

The introduction of a dedicated test_network and the use of .test aliases for mock services is a robust solution for test isolation and hostname validation. No issues found.

features/account.feature (1)

17-17: Test handle updates are correct and necessary.

Changing the test handles to use .test ensures proper hostname validation and service resolution. No issues found.

Also applies to: 22-22

features/step_definitions/stepdefs.js (1)

27-404: All test URLs and handles updated for new network aliases.

The updates to use .test TLD for all mock service URLs and handles are correct and comprehensive. This ensures test reliability and consistency with the new Docker network configuration. No issues found.

Also applies to: 155-345, 637-1835, 1773-1777

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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.

@allouis allouis requested a review from vershwal April 16, 2025 05:20
@allouis allouis enabled auto-merge (rebase) April 16, 2025 05:25
@allouis allouis merged commit e6698c7 into main Apr 16, 2025
5 checks passed
@allouis allouis deleted the fix-hostnames-in-testing branch April 16, 2025 05:27
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