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

chore: replace with og endpoint #5571

Merged
merged 2 commits into from
May 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 15 additions & 2 deletions src/lib/open-graph.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,26 @@
type RoadmapOpenGraphQuery = {
group: 'roadmaps' | 'guides' | 'best-practices';
group: 'roadmap' | 'guide' | 'best-practice';
resourceId: string;
};

export function getOpenGraphImageUrl(params: RoadmapOpenGraphQuery) {
return `${import.meta.env.DEV ? 'http://localhost:3000' : 'https://roadmap.sh'}/og-images/${params.group}/${params.resourceId}.png`;
return `${import.meta.env.DEV ? 'http://localhost:3000' : 'https://roadmap.sh'}/og/${params.group}/${params.resourceId}`;
}

export async function getDefaultOpenGraphImageBuffer() {
const defaultImageUrl = `${import.meta.env.DEV ? 'http://localhost:3000' : 'https://roadmap.sh'}/images/og-img.png`;
return fetch(defaultImageUrl).then((response) => response.arrayBuffer());
}

export async function getResourceOpenGraph(
type: 'roadmap' | 'guide' | 'best-practice',
resourceId: string,
) {
const url = new URL(`${import.meta.env.PUBLIC_API_URL}/v1-open-graph`);
url.searchParams.set('type', type);
url.searchParams.set('resourceId', resourceId);
url.searchParams.set('variant', 'image');
const response = await fetch(url.toString());

return response.text();
}
2 changes: 1 addition & 1 deletion src/pages/[roadmapId]/index.astro
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ if (roadmapFAQs.length) {
const ogImageUrl =
roadmapData?.seo?.ogImageUrl ||
getOpenGraphImageUrl({
group: 'roadmaps',
group: 'roadmap',
resourceId: roadmapId,
});
---
Expand Down
2 changes: 1 addition & 1 deletion src/pages/backend/developer-skills.astro
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const guide = await getGuideById(guideId);
const { frontmatter: guideData } = guide!;

const ogImageUrl = getOpenGraphImageUrl({
group: 'guides',
group: 'guide',
resourceId: guideId,
});
---
Expand Down
2 changes: 1 addition & 1 deletion src/pages/backend/developer-tools.astro
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const guide = await getGuideById(guideId);
const { frontmatter: guideData } = guide!;

const ogImageUrl = getOpenGraphImageUrl({
group: 'guides',
group: 'guide',
resourceId: guideId,
});
---
Expand Down
2 changes: 1 addition & 1 deletion src/pages/backend/languages.astro
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ if (!guide) {
const { frontmatter: guideData } = guide!;

const ogImageUrl = getOpenGraphImageUrl({
group: 'guides',
group: 'guide',
resourceId: guideId,
});
---
Expand Down
6 changes: 3 additions & 3 deletions src/pages/best-practices/[bestPracticeId]/index.astro
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ import { UserProgressModal } from '../../../components/UserProgress/UserProgress
import { generateArticleSchema } from '../../../lib/jsonld-schema';
import { getOpenGraphImageUrl } from '../../../lib/open-graph';
import {
BestPracticeFileType,
BestPracticeFrontmatter,
type BestPracticeFileType,
type BestPracticeFrontmatter,
getAllBestPractices,
} from '../../../lib/best-practice';

Expand Down Expand Up @@ -55,7 +55,7 @@ if (bestPracticeData.schema) {
}

const ogImageUrl = getOpenGraphImageUrl({
group: 'best-practices',
group: 'best-practice',
resourceId: bestPracticeId,
});
---
Expand Down
2 changes: 1 addition & 1 deletion src/pages/guides/[guideId].astro
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ const { frontmatter: guideData, author } = guide;
const ogImageUrl =
guideData.ogImageUrl ||
getOpenGraphImageUrl({
group: 'guides',
group: 'guide',
resourceId: guideId,
});
---
Expand Down
31 changes: 31 additions & 0 deletions src/pages/og/best-practice/[slug].ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import type { APIRoute } from 'astro';
import {
getDefaultOpenGraphImageBuffer,
getResourceOpenGraph,
} from '../../../lib/open-graph';

export const prerender = false;

type Params = {
slug: string;
};

export const GET: APIRoute<any, Params> = async (context) => {
const { slug } = context.params;

if (!slug) {
const buffer = await getDefaultOpenGraphImageBuffer();
return new Response(buffer, {
headers: {
'Content-Type': 'image/png',
},
});
}

const svg = await getResourceOpenGraph('best-practice', slug);
return new Response(svg, {
headers: {
'Content-Type': 'image/svg+xml',
},
});
};
31 changes: 31 additions & 0 deletions src/pages/og/guide/[slug].ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import type { APIRoute } from 'astro';
import {
getDefaultOpenGraphImageBuffer,
getResourceOpenGraph,
} from '../../../lib/open-graph';

export const prerender = false;

type Params = {
slug: string;
};

export const GET: APIRoute<any, Params> = async (context) => {
const { slug } = context.params;

if (!slug) {
const buffer = await getDefaultOpenGraphImageBuffer();
return new Response(buffer, {
headers: {
'Content-Type': 'image/png',
},
});
}

const svg = await getResourceOpenGraph('guide', slug);
return new Response(svg, {
headers: {
'Content-Type': 'image/svg+xml',
},
});
};
31 changes: 31 additions & 0 deletions src/pages/og/roadmap/[slug].ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import type { APIRoute } from 'astro';
import {
getDefaultOpenGraphImageBuffer,
getResourceOpenGraph,
} from '../../../lib/open-graph';

export const prerender = false;

type Params = {
slug: string;
};

export const GET: APIRoute<any, Params> = async (context) => {
const { slug } = context.params;

if (!slug) {
const buffer = await getDefaultOpenGraphImageBuffer();
return new Response(buffer, {
headers: {
'Content-Type': 'image/png',
},
});
}

const svg = await getResourceOpenGraph('roadmap', slug);
return new Response(svg, {
headers: {
'Content-Type': 'image/svg+xml',
},
});
};
18 changes: 4 additions & 14 deletions src/pages/og/[slug].ts → src/pages/og/user/[username].ts
Original file line number Diff line number Diff line change
@@ -1,26 +1,16 @@
import type { APIRoute } from 'astro';
import { getDefaultOpenGraphImageBuffer } from '../../lib/open-graph';
import { getDefaultOpenGraphImageBuffer } from '../../../lib/open-graph';

export const prerender = false;

type Params = {
slug: string;
username: string;
};

export const GET: APIRoute<any, Params> = async (context) => {
const { slug } = context.params;
const { username } = context.params;

if (!slug.startsWith('user-')) {
const buffer = await getDefaultOpenGraphImageBuffer();
return new Response(buffer, {
headers: {
'Content-Type': 'image/png',
},
});
}

const username = slug.replace('user-', '');
if (!username) {
if (!username || !/^[a-zA-Z0-9]*?[a-zA-Z]+?[a-zA-Z0-9]*?$/.test(username)) {
const buffer = await getDefaultOpenGraphImageBuffer();
return new Response(buffer, {
headers: {
Expand Down
2 changes: 1 addition & 1 deletion src/pages/u/[username].astro
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ if (error || !userDetails) {
}

const origin = Astro.url.origin;
const ogImage = `${origin}/og/user-${username}`;
const ogImage = `${origin}/og/user/${username}`;
---

<BaseLayout
Expand Down