feat: make the open graph tags dynamic based on the base64 and url query parameters
#1122
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| import { NextRequest, NextResponse } from "next/server"; | ||
| import parseURL from "@/helpers/parser"; | ||
| import { DocumentInfo } from "@/types"; | ||
| import axios from "axios"; | ||
| import { metadata } from "@/app/page"; | ||
|
|
||
| export async function GET(request: NextRequest) { | ||
| const Base64searchParams = request.nextUrl.searchParams.get('base64'); | ||
| const URLsearchParams = request.nextUrl.searchParams.get('url'); | ||
| console.log('Base64searchParams:', Base64searchParams); | ||
| console.log('URLsearchParams:', URLsearchParams); | ||
| try { | ||
| if (!Base64searchParams && !URLsearchParams) return new NextResponse(null, { status: 200 }); | ||
| let info: DocumentInfo | null = null; | ||
|
|
||
| if (Base64searchParams) { | ||
| // directly run the parsing function | ||
| info = await parseURL(Base64searchParams); | ||
| } | ||
| if (URLsearchParams) { | ||
| // fetch the document information from the URL | ||
| try { | ||
| const response = await axios.get(URLsearchParams); | ||
| if (response.status === 200) { | ||
| info = await parseURL(response.data); | ||
| } else { | ||
| return new NextResponse("Not a valid URL", { status: 500 }); | ||
| } | ||
| } catch (error) { | ||
| return new NextResponse("Not a valid URL", { status: 500 }); | ||
| } | ||
| } | ||
|
|
||
| if (!info) { | ||
| const ogImage = "https://raw.githubusercontent.com/asyncapi/studio/master/apps/studio-next/public/img/meta-studio-og-image.jpeg"; | ||
|
|
||
| const crawlerInfo = ` | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| <title>"${metadata.openGraph?.title}"</title> | ||
| <meta property="og:title" content="${metadata.openGraph?.title}" /> | ||
| <meta property="og:description" content="${metadata.openGraph?.description}" /> | ||
| <meta property="og:url" content="${metadata.openGraph?.url}" /> | ||
| <meta property="og:image" content="${ogImage}" /> | ||
| ` | ||
| return new NextResponse(crawlerInfo, { | ||
| headers: { | ||
| 'Content-Type': 'text/html', | ||
| }, | ||
| }) | ||
| } | ||
|
|
||
| let ogImageParams = new URLSearchParams(); | ||
|
|
||
| if (info.title) { | ||
| ogImageParams.append('title', info.title.toString()); | ||
| } | ||
| if (info.description) { | ||
| ogImageParams.append('description', info.description.toString()); | ||
| } | ||
| if (info.numServers) { | ||
| ogImageParams.append('numServers', info.numServers.toString()); | ||
| } | ||
| if (info.numChannels) { | ||
| ogImageParams.append('numChannels', info.numChannels.toString()); | ||
| } | ||
| if (info.numOperations) { | ||
| ogImageParams.append('numOperations', info.numOperations.toString()); | ||
| } | ||
| if (info.numMessages) { | ||
| ogImageParams.append('numMessages', info.numMessages.toString()); | ||
| } | ||
|
|
||
| const ogImageurl = `https://ogp-studio.netlify.app/og?${ogImageParams.toString()}`; | ||
|
|
||
| const crawlerInfo = ` | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| <title>${info.title}</title> | ||
| ${info.title ? `<meta property="og:title" content="${info.title}" />` : ''} | ||
| ${info.description ? `<meta property="og:description" content="${info.description}" />` : ''} | ||
| <meta property="og:image" content=${ogImageurl} /> | ||
| </head> | ||
| </html> | ||
| `; | ||
| console.log(crawlerInfo); | ||
| return new NextResponse(crawlerInfo, { | ||
| status: 200, | ||
| headers: { | ||
| 'Content-Type': 'text/html', | ||
| }, | ||
| }); | ||
| } catch (err) { | ||
| return new NextResponse("Not a valid URL", { status: 500 }); | ||
| } | ||
| } | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| import { Input, Parser } from '@asyncapi/parser'; | ||
| import { DocumentInfo } from '@/types'; | ||
|
|
||
| export default async function parseURL(asyncapiDocument: string): Promise<DocumentInfo | null> { | ||
| const parser = new Parser(); | ||
|
|
||
| let decodedDocument: Input = ""; | ||
|
|
||
| if (asyncapiDocument.startsWith('https') || asyncapiDocument.startsWith('http')) { | ||
| decodedDocument = asyncapiDocument; | ||
| } else { | ||
| decodedDocument = Buffer.from(asyncapiDocument, "base64").toString("utf-8"); | ||
| } | ||
|
|
||
| const { document, diagnostics } = await parser.parse(decodedDocument); | ||
| console.log(document); | ||
| if (diagnostics.some(diagnostic => diagnostic.severity != 0)) { | ||
| return null; | ||
| } | ||
|
|
||
| let title = document?.info().title(); | ||
| if (title) { | ||
| title = title.length <= 20 ? title : title.slice(0, 20) + "..."; | ||
| } | ||
| const version = document?.info().version(); | ||
|
|
||
| let description = document?.info().description(); | ||
| if (description) { | ||
| description = description.length <= 100 ? description : description.slice(0, 100) + "..."; | ||
| } | ||
|
|
||
| const servers = document?.allServers(); | ||
| const channels = document?.allChannels(); | ||
| const operations = document?.allOperations(); | ||
| const messages = document?.allMessages(); | ||
|
|
||
| const numServers = servers?.length; | ||
| const numChannels = channels?.length; | ||
| const numOperations = operations?.length; | ||
| const numMessages = messages?.length; | ||
|
|
||
| const response = { | ||
| title, | ||
| version, | ||
| description, | ||
| numServers, | ||
| numChannels, | ||
| numOperations, | ||
| numMessages | ||
| }; | ||
| return response; | ||
| } |
|
There was a problem hiding this comment. The configuration and this middleware achieve the purpose, right? I don't understand why we are adding both. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| import { NextRequest, NextResponse, userAgent } from "next/server"; | ||
| import crawlers from 'crawler-user-agents'; | ||
|
|
||
| export async function middleware(request: NextRequest) { | ||
| const userAgents = crawlers.map(crawler => crawler.pattern); | ||
| const requestInfo = userAgent(request); | ||
| const res = NextResponse.next(); | ||
|
|
||
| // for (const ua of userAgents) { | ||
| // if (requestInfo.ua.toLowerCase().includes(ua.toLowerCase())) { | ||
|
|
||
| const documentURL = request.nextUrl.searchParams.get("url"); | ||
| const encodedDocument = request.nextUrl.searchParams.get("base64"); | ||
|
|
||
| if (!encodedDocument && !documentURL) { | ||
| return res; | ||
| } | ||
| if (encodedDocument) { | ||
| return NextResponse.rewrite(new URL(`/api/crawler?base64=${encodedDocument}`, request.url)); | ||
| } | ||
| if (documentURL) { | ||
| return NextResponse.rewrite(new URL(`/api/crawler?url=${documentURL}`, request.url)); | ||
| } | ||
| // } | ||
| // } | ||
| return res; | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,13 @@ | ||
| import type specs from '@asyncapi/specs'; | ||
|
|
||
| export type SpecVersions = keyof typeof specs.schemas; | ||
|
|
||
| export interface DocumentInfo { | ||
| title? : string, | ||
| version? : string, | ||
| description? : string, | ||
| numServers? : number, | ||
| numChannels? : number, | ||
| numOperations? : number, | ||
| numMessages?: number | ||
| } |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.