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

fix(gnoweb): transform relative args links #3981

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

alexiscolin
Copy link
Member

@alexiscolin alexiscolin commented Mar 20, 2025

Description

This PR fixes issue #3865 by implementing proper transformation of relative links that start with ":" into full gnoweb URLs. This ensures proper URL resolution and maintains the gno.land URL structure.

Changes

  • Added TransformRelArgsURL function to handle relative links starting with ":"
  • Added comprehensive test cases covering various URL scenarios
  • Updated documentation with clear examples

Example

from https://gno.land/r/demo/polls URL:

Input:  [link text](:2/votes)
Output: [link text](/r/demo/polls:2/votes)

Fixes: #3865

@alexiscolin alexiscolin requested a review from gfanton March 20, 2025 06:40
@github-actions github-actions bot added the 📦 ⛰️ gno.land Issues or PRs gno.land package related label Mar 20, 2025
@alexiscolin alexiscolin added the 🌍 gnoweb Issues & PRs related to gnoweb and render label Mar 20, 2025
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Mar 20, 2025
@Gno2D2
Copy link
Collaborator

Gno2D2 commented Mar 20, 2025

🛠 PR Checks Summary

All Automated Checks passed. ✅

Manual Checks (for Reviewers):
  • IGNORE the bot requirements for this PR (force green CI check)
Read More

🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.

✅ Automated Checks (for Contributors):

🟢 Maintainers must be able to edit this pull request (more info)
🟢 Changes related to gnoweb must be reviewed by its codeowners
🟢 Pending initial approval by a review team member, or review from tech-staff

☑️ Contributor Actions:
  1. Fix any issues flagged by automated checks.
  2. Follow the Contributor Checklist to ensure your PR is ready for review.
    • Add new tests, or document why they are unnecessary.
    • Provide clear examples/screenshots, if necessary.
    • Update documentation, if required.
    • Ensure no breaking changes, or include BREAKING CHANGE notes.
    • Link related issues/PRs, where applicable.
☑️ Reviewer Actions:
  1. Complete manual checks for the PR, including the guidelines and additional checks if applicable.
📚 Resources:
Debug
Automated Checks
Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 The pull request was created from a fork (head branch repo: alexiscolin/gno)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

Changes related to gnoweb must be reviewed by its codeowners

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 A changed file matches this pattern: ^gno.land/pkg/gnoweb/ (filename: gno.land/pkg/gnoweb/webclient_html.go)

Then

🟢 Requirement satisfied
└── 🟢 Or
    ├── 🔴 This user reviewed pull request: alexiscolin
    └── 🟢 This user reviewed pull request: gfanton

Pending initial approval by a review team member, or review from tech-staff

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🟢 Requirement satisfied
└── 🟢 If
    ├── 🟢 Condition
    │   └── 🟢 Or
    │       ├── 🟢 At least 1 user(s) of the organization reviewed the pull request (with state "APPROVED")
    │       ├── 🟢 At least 1 user(s) of the team tech-staff reviewed pull request
    │       └── 🔴 This pull request is a draft
    └── 🟢 Then
        └── 🟢 Not (🔴 This label is applied to pull request: review/triage-pending)

Manual Checks
**IGNORE** the bot requirements for this PR (force green CI check)

If

🟢 Condition met
└── 🟢 On every pull request

Can be checked by

  • Any user with comment edit permission

Copy link

codecov bot commented Mar 20, 2025

Codecov Report

Attention: Patch coverage is 86.36364% with 3 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
gno.land/pkg/gnoweb/webclient_html.go 86.36% 2 Missing and 1 partial ⚠️

📢 Thoughts on this report? Let us know!

@Gno2D2 Gno2D2 removed the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Mar 20, 2025
@alexiscolin alexiscolin requested a review from gfanton March 20, 2025 09:21
@alexiscolin
Copy link
Member Author

Even simpler 👍 Thank you @gfanton

Copy link
Member

@gfanton gfanton left a comment

Choose a reason for hiding this comment

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

Should we document this somewhere? Otherwise, it looks good! Thanks!

@leohhhn
Copy link
Contributor

leohhhn commented Mar 20, 2025

In r/docs/markdown we can have a section for links, ie abs vs relative vs special chars :

Copy link
Member

@moul moul left a comment

Choose a reason for hiding this comment

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

I had a similar idea at one point but then decided to focus on creating good p/ libraries to manage this for us. I still believe this idea could be very beneficial, but I prefer blocking so we can discuss it with more people during a review meeting.

@ajnavarro
Copy link
Contributor

@moul I don't know if you are referring to these two gno packages or other things:

But none of them fixes the problem we are having with relative paths not working. It is impossible to fix at gno code level because for that you must know from where your code is called.

Implementing the proxy pattern, I needed to delegate the Render call to a struct. That Render method can be called from gno.land/r/gov/dao or gno.land/r/gov/dao/v3/impl. Not having relative paths working makes it impossible to properly write the markdown code for that case.

In any case, I think we need relative paths, and we don't have them. What I saw was people having to hardcode the name of the package realm on their code to have it working properly.

Examples:

@moul
Copy link
Member

moul commented Mar 20, 2025

I was referring to this one: https://github.com/gnolang/gno/blob/master/examples/gno.land/p/moul/realmpath/realmpath.gno

I don't understand how we can say, "you must know where your code is called," while also mentioning "relative links." If something is relative, it pertains to the current rendering realm, which is the one from which you are executing Render(). Is that correct?

Perhaps realmpath should, like the txlink package, allow specifying an arbitrary realm as the caller. Alternatively, it could have another constructor that accepts previousrealm. I agree that this approach seems more complex than necessary. However, using relative links in a context where we can create rendering helpers appears more dangerous than explicitly creating full paths.

That said, I think it's reasonable to view a realm as akin to a domain name. In this context, the notion of a relative link makes sense if we consider each realm to be a unique domain.

Can we explore how using realmpath (or another solution) could address your case before considering this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌍 gnoweb Issues & PRs related to gnoweb and render 📦 ⛰️ gno.land Issues or PRs gno.land package related
Projects
Status: In Progress
Status: Triage
Development

Successfully merging this pull request may close these issues.

[gnoweb]: Markdown links not rendering the expected path
6 participants