social media links using web4 #111
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
petersalomonsen
changed the title
fallback if not finding community in contract storage
escape stored content
frol
requested changes
Apr 30, 2024
Co-authored-by: Vlad Frolov <[email protected]>
Co-authored-by: Vlad Frolov <[email protected]>
…nsen/neardevhub-contract into feat/web4-social-media-links
WalkthroughThe update enhances web request handling in a Rust application by introducing the Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Out of diff range and nitpick comments (3)
src/web4/handler.rs (3)
1-5: Consider grouping thenear_sdk::base64imports into a single line for better readability.use near_sdk::base64::{alphabet, engine::{self, general_purpose}, Engine};
13-14: TheBASE64_ENGINEconstant is well-defined, but consider adding a comment to explain its purpose for future maintainability./// Base64 engine for encoding HTML responses without padding. pub const BASE64_ENGINE: engine::GeneralPurpose = engine::GeneralPurpose::new(&alphabet::URL_SAFE, general_purpose::NO_PAD);
30-41: The match statement for handling different paths is clear, but consider adding comments to explain each case for better readability and maintainability.match (page, path_parts.get(2)) { // Handle community path ("community", Some(handle)) => { if let Some(community) = contract.get_community(handle.to_string()) { title = html_escape::encode_text(community.name.as_str()).to_string(); description = html_escape::encode_text(community.description.as_str()).to_string(); image = community.logo_url; } redirect_path = format!("devhub.near/widget/app?page={}&handle={}", page, handle); initial_props_json = json!({"page": page, "handle": handle}).to_string(); } // Handle proposal path ("proposal", Some(id)) => { if let Ok(id) = id.parse::<u32>() { if let Some(versioned_proposal) = contract.proposals.get(id.into()) { let proposal_body = Proposal::from(versioned_proposal).snapshot.body.latest_version(); title = html_escape::encode_text(proposal_body.name.as_str()).to_string(); description = html_escape::encode_text(proposal_body.summary.as_str()).to_string(); } } redirect_path = format!("devhub.near/widget/app?page={}&id={}", page, id); initial_props_json = json!({"page": page, "id": id}).to_string(); } // Handle unknown paths _ => { redirect_path = "devhub.near/widget/app".to_string(); initial_props_json = json!({"page": page}).to_string(); } }
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- src/web4/handler.rs (1 hunks)
Additional comments not posted (1)
src/web4/handler.rs (1)
121-480: The tests cover a wide range of scenarios and are well-structured. Ensure that all edge cases are considered, especially for path parsing and metadata setting.
Comment on lines
+16
to
+18
| pub fn web4_get(contract: &Contract, request: Web4Request) -> Web4Response { | ||
| let path_parts: Vec<&str> = request.path.split('/').collect(); | ||
|
|
There was a problem hiding this comment.
The path parsing logic assumes that the path will always contain at least two elements. This assumption might not hold in all cases, leading to potential panics. Consider adding a check to ensure the path has the expected number of elements.
let path_parts: Vec<&str> = request.path.split('/').collect();
if path_parts.len() < 2 {
return Web4Response::Body {
content_type: "text/html; charset=UTF-8".to_owned(),
body: BASE64_ENGINE.encode("Invalid path".to_string()),
};
}
Comment on lines
+63
to
+111
| let body = format!( | ||
| r#"<!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <title>{title}</title> | ||
| <meta charset="utf-8"> | ||
| <meta name="viewport" content="width=device-width,initial-scale=1"> | ||
| <meta property="og:url" content="{url}" /> | ||
| <meta property="og:type" content="website" /> | ||
| <meta property="og:title" content="{title}" /> | ||
| <meta property="og:description" content="{description}" /> | ||
| <meta property="og:image" content="{image}" /> | ||
|
|
||
| <meta name="twitter:card" content="summary_large_image"> | ||
| <meta name="twitter:title" content="{title}"> | ||
| <meta name="twitter:description" content="{description}"> | ||
| <meta name="twitter:image" content="{image}"> | ||
| <script src="https://ipfs.web4.near.page/ipfs/bafybeic6aeztkdlthx5uwehltxmn5i6owm47b7b2jxbbpwmydv2mwxdfca/main.794b6347ae264789bc61.bundle.js"></script> | ||
| <script src="https://ipfs.web4.near.page/ipfs/bafybeic6aeztkdlthx5uwehltxmn5i6owm47b7b2jxbbpwmydv2mwxdfca/runtime.25b143da327a5371509f.bundle.js"></script> | ||
| <style> | ||
| @media screen and (max-width: 600px) {{ | ||
| .gatewaylinks .nav-link {{ | ||
| padding-top: 0px!important; | ||
| padding-bottom: 0px!important; | ||
| margin: 0px; | ||
| }} | ||
| .gatewaylinks img {{ | ||
| height: 30px; | ||
| }} | ||
| }} | ||
| </style> | ||
| </head> | ||
| <body> | ||
| <nav class="navbar navbar-expand-sm navbar-light bg-dark" style="display: flex; flex-wrap: nowrap; padding-left: 5px; padding-right: 5px; height: 73px; border-bottom: rgb(0, 236, 151) solid 5px;"> | ||
| <a class="navbar-brand" href="/""><img src="https://i.near.social/magic/large/https://near.social/magic/img/account/devhub.near" style="height: 68px" /></a> | ||
| <p class="nav-text" style="flex-grow: 1"></p> | ||
| <p class="nav-text text-light" style="margin-top: 1rem; margin-right: 1rem">Choose your gateway</p> | ||
| <div class="navbar-nav gatewaylinks"> | ||
| <a href="https://near.org/{redirect_path}" class="nav-link"> | ||
| <img src="https://ipfs.web4.near.page/ipfs/bafybeia2ptgyoz7b6oxu3k57jmiras2pgigmw7a3cp6osjog67rndmf36y/nearorg.svg" /> | ||
| </a> | ||
| <a href="https://near.social/{redirect_path}" class="nav-link"> | ||
| <img src="https://ipfs.web4.near.page/ipfs/bafybeia2ptgyoz7b6oxu3k57jmiras2pgigmw7a3cp6osjog67rndmf36y/nearsocial.svg" /> | ||
| </a> | ||
| </div> | ||
| </nav> | ||
| <near-social-viewer src="devhub.near/widget/app" initialProps='{initial_props_json}'></near-social-viewer> | ||
| </body> | ||
| </html>"#, |
There was a problem hiding this comment.
The HTML response construction is well-structured, but consider extracting the HTML template into a separate function or constant for better readability and maintainability.
const HTML_TEMPLATE: &str = r#"<!DOCTYPE html>
<html>
<head>
<title>{title}</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta property="og:url" content="{url}" />
<meta property="og:type" content="website" />
<meta property="og:title" content="{title}" />
<meta property="og:description" content="{description}" />
<meta property="og:image" content="{image}" />
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:title" content="{title}">
<meta name="twitter:description" content="{description}">
<meta name="twitter:image" content="{image}">
<script src="https://ipfs.web4.near.page/ipfs/bafybeic6aeztkdlthx5uwehltxmn5i6owm47b7b2jxbbpwmydv2mwxdfca/main.794b6347ae264789bc61.bundle.js"></script>
<script src="https://ipfs.web4.near.page/ipfs/bafybeic6aeztkdlthx5uwehltxmn5i6owm47b7b2jxbbpwmydv2mwxdfca/runtime.25b143da327a5371509f.bundle.js"></script>
<style>
@media screen and (max-width: 600px) {{
.gatewaylinks .nav-link {{
padding-top: 0px!important;
padding-bottom: 0px!important;
margin: 0px;
}}
.gatewaylinks img {{
height: 30px;
}}
}}
</style>
</head>
<body>
<nav class="navbar navbar-expand-sm navbar-light bg-dark" style="display: flex; flex-wrap: nowrap; padding-left: 5px; padding-right: 5px; height: 73px; border-bottom: rgb(0, 236, 151) solid 5px;">
<a class="navbar-brand" href="/""><img src="https://i.near.social/magic/large/https://near.social/magic/img/account/devhub.near" style="height: 68px" /></a>
<p class="nav-text" style="flex-grow: 1"></p>
<p class="nav-text text-light" style="margin-top: 1rem; margin-right: 1rem">Choose your gateway</p>
<div class="navbar-nav gatewaylinks">
<a href="https://near.org/{redirect_path}" class="nav-link">
<img src="https://ipfs.web4.near.page/ipfs/bafybeia2ptgyoz7b6oxu3k57jmiras2pgigmw7a3cp6osjog67rndmf36y/nearorg.svg" />
</a>
<a href="https://near.social/{redirect_path}" class="nav-link">
<img src="https://ipfs.web4.near.page/ipfs/bafybeia2ptgyoz7b6oxu3k57jmiras2pgigmw7a3cp6osjog67rndmf36y/nearsocial.svg" />
</a>
</div>
</nav>
<near-social-viewer src="devhub.near/widget/app" initialProps='{initial_props_json}'></near-social-viewer>
</body>
</html>"#;
let body = HTML_TEMPLATE
.replace("{title}", &title)
.replace("{url}", &redirect_path)
.replace("{description}", &description)
.replace("{image}", &image)
.replace("{redirect_path}", &redirect_path)
.replace("{initial_props_json}", &initial_props_json);
frol
approved these changes
May 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the
web4_getmethod to the contract, so that when merged, there will be a website at https://devhub.near.pageYou can preview it at https://devhublink.testnet.page/
Note that the preview deployment does not have access to content, so it will not be able to display proper content for preview links, which is provided by the contract. A test community "webassemblymusic" is created for the preview deployment, to demonstrate the preview links. You can test it at https://devhublink.testnet.page/community/webassemblymusic. You may also call the preview contract to create proposals and other communities to verify that social media headers are also populated with the content.
For now the first part of the part is always mapped to the
pageproperty, so that e.g./proposalsare translated to/devhub.near/widget/app?page=proposals. Also the second part translates tohandlefor community (/community/webassemblymusic->/devhub.near/widget/app?page=community&handle=webassemblymusic), or toidfor proposal/proposal/5->/devhub.near/widget/app?page=proposal&id=5In addition to metadata for social media links, and SEO friendly URLs, the actual content is viewed as well. This is done using near-bos-webcomponent which is also used for playwright tests in the DevHub frontend. A PR have also been created there to support the SEO friendly URL paths created here.
The
html-escapecrate is added to ensure that descriptions with html tags are escaped for the generated HTML ( to avoid malicious scripts etc ).Examples:
Part of NEAR-DevHub/neardevhub-bos#724
Summary by CodeRabbit
New Features
web4module to handle web requests, dynamically generate HTML content, and encode responses.Documentation
Dependencies
html-escapelibrary to support HTML content generation.