-
Notifications
You must be signed in to change notification settings - Fork 2.9k
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
Feature: Add bit.ly as a shortening link - 545 #601
base: main
Are you sure you want to change the base?
Feature: Add bit.ly as a shortening link - 545 #601
Conversation
@pritam1322 is attempting to deploy a commit to the Listinai Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThis PR introduces a new Bitly provider in the NestJS URL shortening library. A new file implements the Bitly class adhering to the ShortLinking interface with methods to create, convert, and retrieve short links along with their statistics via the Bitly API. Additionally, the ShortLinkService is updated to include a provider check for the BITLY_TOKEN, enabling Bitly integration alongside existing providers. The implementation also covers recursive pagination for aggregating link statistics. Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant ShortLinkService
participant Bitly
Client->>+ShortLinkService: Request URL shortening or stats
ShortLinkService->>ShortLinkService: Check BITLY_TOKEN environment variable
alt BITLY_TOKEN is set
ShortLinkService->>+Bitly: Invoke relevant Bitly method
Bitly-->>-ShortLinkService: Return short link / statistics
else BITLY_TOKEN not set
ShortLinkService->>ShortLinkService: Fallback to other providers
end
ShortLinkService-->>-Client: Deliver result
Possibly related issues
Possibly related PRs
Suggested reviewers
Poem
✨ Finishing Touches
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
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.
Actionable comments posted: 5
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
libraries/nestjs-libraries/src/short-linking/providers/bitly.ts
(1 hunks)libraries/nestjs-libraries/src/short-linking/short.link.service.ts
(2 hunks)
🔇 Additional comments (1)
libraries/nestjs-libraries/src/short-linking/short.link.service.ts (1)
6-6
: LGTM!The Bitly provider integration follows the same pattern as other providers and is correctly implemented.
Also applies to: 17-19
async convertShortLinkToLink(shortLink: string) { | ||
const linkId = shortLink.split('/').pop(); | ||
const response = await fetch(`https://api-ssl.bitly.com/v4/bitlinks/${linkId}`, options); | ||
const data = await response.json(); | ||
return data.long_url; | ||
} |
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.
Add error handling for link retrieval.
The method lacks error handling for failed API calls and response validation.
async convertShortLinkToLink(shortLink: string) {
const linkId = shortLink.split('/').pop();
- const response = await fetch(`https://api-ssl.bitly.com/v4/bitlinks/${linkId}`, options);
- const data = await response.json();
- return data.long_url;
+ try {
+ const response = await fetch(`https://api-ssl.bitly.com/v4/bitlinks/${linkId}`, options);
+ if (!response.ok) {
+ throw new Error(`Failed to retrieve original link: ${response.statusText}`);
+ }
+
+ const data = await response.json();
+ if (!data.long_url) {
+ throw new Error('Invalid response: missing long_url property');
+ }
+
+ return data.long_url;
+ } catch (error) {
+ console.error('Error retrieving original link:', error);
+ throw error;
+ }
}
async convertLinkToShortLink(id: string, link: string) { | ||
return ( | ||
await ( | ||
await fetch(`https://api-ssl.bitly.com/v4/shorten`, { | ||
...options, | ||
method: 'POST', | ||
body: JSON.stringify({ | ||
long_url: link, | ||
group_guid: id, | ||
domain: this.shortLinkDomain, | ||
}), | ||
}) | ||
).json() | ||
).link; | ||
} |
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.
Add error handling for link creation.
The method lacks error handling for failed API calls and response validation.
async convertLinkToShortLink(id: string, link: string) {
- return (
- await (
- await fetch(`https://api-ssl.bitly.com/v4/shorten`, {
- ...options,
- method: 'POST',
- body: JSON.stringify({
- long_url: link,
- group_guid: id,
- domain: this.shortLinkDomain,
- }),
- })
- ).json()
- ).link;
+ try {
+ const response = await fetch(`https://api-ssl.bitly.com/v4/shorten`, {
+ ...options,
+ method: 'POST',
+ body: JSON.stringify({
+ long_url: link,
+ group_guid: id,
+ domain: this.shortLinkDomain,
+ }),
+ });
+
+ if (!response.ok) {
+ throw new Error(`Failed to create short link: ${response.statusText}`);
+ }
+
+ const data = await response.json();
+ if (!data.link) {
+ throw new Error('Invalid response: missing link property');
+ }
+
+ return data.link;
+ } catch (error) {
+ console.error('Error creating short link:', error);
+ throw error;
+ }
}
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
async convertLinkToShortLink(id: string, link: string) { | |
return ( | |
await ( | |
await fetch(`https://api-ssl.bitly.com/v4/shorten`, { | |
...options, | |
method: 'POST', | |
body: JSON.stringify({ | |
long_url: link, | |
group_guid: id, | |
domain: this.shortLinkDomain, | |
}), | |
}) | |
).json() | |
).link; | |
} | |
async convertLinkToShortLink(id: string, link: string) { | |
try { | |
const response = await fetch(`https://api-ssl.bitly.com/v4/shorten`, { | |
...options, | |
method: 'POST', | |
body: JSON.stringify({ | |
long_url: link, | |
group_guid: id, | |
domain: this.shortLinkDomain, | |
}), | |
}); | |
if (!response.ok) { | |
throw new Error(`Failed to create short link: ${response.statusText}`); | |
} | |
const data = await response.json(); | |
if (!data.link) { | |
throw new Error('Invalid response: missing link property'); | |
} | |
return data.link; | |
} catch (error) { | |
console.error('Error creating short link:', error); | |
throw error; | |
} | |
} |
const options = { | ||
headers: { | ||
Authorization: `Bearer ${process.env.BITLY_TOKEN}`, | ||
'Content-Type': 'application/json', | ||
}, | ||
}; |
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.
🛠️ Refactor suggestion
Add token validation and error handling.
The Bitly token is accessed directly from environment variables without validation. Consider adding validation to ensure the token exists and has the correct format.
const options = {
headers: {
- Authorization: `Bearer ${process.env.BITLY_TOKEN}`,
+ Authorization: `Bearer ${
+ process.env.BITLY_TOKEN ??
+ (() => { throw new Error('BITLY_TOKEN environment variable is not set') })()
+ }`,
'Content-Type': 'application/json',
},
};
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
const options = { | |
headers: { | |
Authorization: `Bearer ${process.env.BITLY_TOKEN}`, | |
'Content-Type': 'application/json', | |
}, | |
}; | |
const options = { | |
headers: { | |
- Authorization: `Bearer ${process.env.BITLY_TOKEN}`, | |
+ Authorization: `Bearer ${ | |
+ process.env.BITLY_TOKEN ?? | |
+ (() => { throw new Error('BITLY_TOKEN environment variable is not set') })() | |
+ }`, | |
'Content-Type': 'application/json', | |
}, | |
}; |
async linksStatistics(links: string[]) { | ||
return Promise.all( | ||
links.map(async (link) => { | ||
const linkId = link.split('/').pop(); | ||
const response = await ( | ||
await fetch(`https://api-ssl.bitly.com/v4/bitlinks/${linkId}`, options) | ||
).json(); | ||
|
||
const clicksResponse = await ( | ||
await fetch(`https://api-ssl.bitly.com/v4/bitlinks/${linkId}/clicks/summary`, options) | ||
).json(); | ||
|
||
return { | ||
short: link, | ||
original: response.long_url, | ||
clicks: clicksResponse.total_clicks || 0, | ||
}; | ||
}) | ||
); | ||
} |
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.
Add error handling and rate limiting for API calls.
The method makes multiple API calls without error handling or rate limiting considerations. This could lead to failures or API rate limits being exceeded.
async linksStatistics(links: string[]) {
+ const delay = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
return Promise.all(
- links.map(async (link) => {
+ links.map(async (link, index) => {
+ // Add delay between requests to avoid rate limiting
+ await delay(index * 100);
+
const linkId = link.split('/').pop();
- const response = await (
- await fetch(`https://api-ssl.bitly.com/v4/bitlinks/${linkId}`, options)
- ).json();
+ try {
+ const response = await fetch(`https://api-ssl.bitly.com/v4/bitlinks/${linkId}`, options);
+ if (!response.ok) {
+ throw new Error(`Failed to fetch bitlink: ${response.statusText}`);
+ }
+ const data = await response.json();
- const clicksResponse = await (
- await fetch(`https://api-ssl.bitly.com/v4/bitlinks/${linkId}/clicks/summary`, options)
- ).json();
+ const clicksResponse = await fetch(
+ `https://api-ssl.bitly.com/v4/bitlinks/${linkId}/clicks/summary`,
+ options
+ );
+ if (!clicksResponse.ok) {
+ throw new Error(`Failed to fetch clicks: ${clicksResponse.statusText}`);
+ }
+ const clicksData = await clicksResponse.json();
- return {
- short: link,
- original: response.long_url,
- clicks: clicksResponse.total_clicks || 0,
- };
+ return {
+ short: link,
+ original: data.long_url,
+ clicks: clicksData.total_clicks || 0,
+ };
+ } catch (error) {
+ console.error(`Error processing link ${link}:`, error);
+ return {
+ short: link,
+ original: '',
+ clicks: 0,
+ };
+ }
})
);
}
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
async linksStatistics(links: string[]) { | |
return Promise.all( | |
links.map(async (link) => { | |
const linkId = link.split('/').pop(); | |
const response = await ( | |
await fetch(`https://api-ssl.bitly.com/v4/bitlinks/${linkId}`, options) | |
).json(); | |
const clicksResponse = await ( | |
await fetch(`https://api-ssl.bitly.com/v4/bitlinks/${linkId}/clicks/summary`, options) | |
).json(); | |
return { | |
short: link, | |
original: response.long_url, | |
clicks: clicksResponse.total_clicks || 0, | |
}; | |
}) | |
); | |
} | |
async linksStatistics(links: string[]) { | |
const delay = (ms: number) => new Promise(resolve => setTimeout(resolve, ms)); | |
return Promise.all( | |
links.map(async (link, index) => { | |
// Add delay between requests to avoid rate limiting | |
await delay(index * 100); | |
const linkId = link.split('/').pop(); | |
try { | |
const response = await fetch(`https://api-ssl.bitly.com/v4/bitlinks/${linkId}`, options); | |
if (!response.ok) { | |
throw new Error(`Failed to fetch bitlink: ${response.statusText}`); | |
} | |
const data = await response.json(); | |
const clicksResponse = await fetch( | |
`https://api-ssl.bitly.com/v4/bitlinks/${linkId}/clicks/summary`, | |
options | |
); | |
if (!clicksResponse.ok) { | |
throw new Error(`Failed to fetch clicks: ${clicksResponse.statusText}`); | |
} | |
const clicksData = await clicksResponse.json(); | |
return { | |
short: link, | |
original: data.long_url, | |
clicks: clicksData.total_clicks || 0, | |
}; | |
} catch (error) { | |
console.error(`Error processing link ${link}:`, error); | |
return { | |
short: link, | |
original: '', | |
clicks: 0, | |
}; | |
} | |
}) | |
); | |
} |
async getAllLinksStatistics( | ||
groupId: string, | ||
page = 1 | ||
): Promise<{ short: string; original: string; clicks: string }[]> { | ||
const response = await ( | ||
await fetch( | ||
`https://api-ssl.bitly.com/v4/groups/${groupId}/bitlinks?page=${page}&size=100`, | ||
options | ||
) | ||
).json(); | ||
|
||
const mapLinks = await Promise.all( | ||
response.links.map(async (link: any) => { | ||
const clicksResponse = await ( | ||
await fetch(`https://api-ssl.bitly.com/v4/bitlinks/${link.id}/clicks/summary`, options) | ||
).json(); | ||
|
||
return { | ||
short: link.link, | ||
original: link.long_url, | ||
clicks: clicksResponse.total_clicks || 0, | ||
}; | ||
}) | ||
); | ||
|
||
if (mapLinks.length < 100) { | ||
return mapLinks; | ||
} | ||
|
||
return [...mapLinks, ...(await this.getAllLinksStatistics(groupId, page + 1))]; | ||
} |
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.
🛠️ Refactor suggestion
Improve error handling and implement iterative pagination.
The method has several issues:
- Missing error handling for API calls
- No rate limiting consideration
- Recursive implementation could lead to stack overflow with large datasets
async getAllLinksStatistics(
groupId: string,
page = 1
): Promise<{ short: string; original: string; clicks: string }[]> {
- const response = await (
- await fetch(
- `https://api-ssl.bitly.com/v4/groups/${groupId}/bitlinks?page=${page}&size=100`,
- options
- )
- ).json();
+ try {
+ let allLinks = [];
+ let currentPage = page;
+
+ while (true) {
+ const response = await fetch(
+ `https://api-ssl.bitly.com/v4/groups/${groupId}/bitlinks?page=${currentPage}&size=100`,
+ options
+ );
+
+ if (!response.ok) {
+ throw new Error(`Failed to fetch links: ${response.statusText}`);
+ }
+
+ const data = await response.json();
+ if (!data.links || !Array.isArray(data.links)) {
+ throw new Error('Invalid response: missing or invalid links array');
+ }
+
+ const delay = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
+ const mapLinks = await Promise.all(
+ data.links.map(async (link: any, index: number) => {
+ // Add delay between requests to avoid rate limiting
+ await delay(index * 100);
+
+ try {
+ const clicksResponse = await fetch(
+ `https://api-ssl.bitly.com/v4/bitlinks/${link.id}/clicks/summary`,
+ options
+ );
+
+ if (!clicksResponse.ok) {
+ throw new Error(`Failed to fetch clicks: ${clicksResponse.statusText}`);
+ }
+
+ const clicksData = await clicksResponse.json();
+ return {
+ short: link.link,
+ original: link.long_url,
+ clicks: clicksData.total_clicks || 0,
+ };
+ } catch (error) {
+ console.error(`Error fetching clicks for ${link.id}:`, error);
+ return {
+ short: link.link,
+ original: link.long_url,
+ clicks: 0,
+ };
+ }
+ })
+ );
+
+ allLinks = [...allLinks, ...mapLinks];
+
+ if (mapLinks.length < 100) {
+ break;
+ }
+
+ currentPage++;
+ }
+
+ return allLinks;
+ } catch (error) {
+ console.error('Error fetching all links:', error);
+ throw error;
+ }
}
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
async getAllLinksStatistics( | |
groupId: string, | |
page = 1 | |
): Promise<{ short: string; original: string; clicks: string }[]> { | |
const response = await ( | |
await fetch( | |
`https://api-ssl.bitly.com/v4/groups/${groupId}/bitlinks?page=${page}&size=100`, | |
options | |
) | |
).json(); | |
const mapLinks = await Promise.all( | |
response.links.map(async (link: any) => { | |
const clicksResponse = await ( | |
await fetch(`https://api-ssl.bitly.com/v4/bitlinks/${link.id}/clicks/summary`, options) | |
).json(); | |
return { | |
short: link.link, | |
original: link.long_url, | |
clicks: clicksResponse.total_clicks || 0, | |
}; | |
}) | |
); | |
if (mapLinks.length < 100) { | |
return mapLinks; | |
} | |
return [...mapLinks, ...(await this.getAllLinksStatistics(groupId, page + 1))]; | |
} | |
async getAllLinksStatistics( | |
groupId: string, | |
page = 1 | |
): Promise<{ short: string; original: string; clicks: string }[]> { | |
try { | |
let allLinks = []; | |
let currentPage = page; | |
while (true) { | |
const response = await fetch( | |
`https://api-ssl.bitly.com/v4/groups/${groupId}/bitlinks?page=${currentPage}&size=100`, | |
options | |
); | |
if (!response.ok) { | |
throw new Error(`Failed to fetch links: ${response.statusText}`); | |
} | |
const data = await response.json(); | |
if (!data.links || !Array.isArray(data.links)) { | |
throw new Error('Invalid response: missing or invalid links array'); | |
} | |
const delay = (ms: number) => new Promise(resolve => setTimeout(resolve, ms)); | |
const mapLinks = await Promise.all( | |
data.links.map(async (link: any, index: number) => { | |
// Add delay between requests to avoid rate limiting | |
await delay(index * 100); | |
try { | |
const clicksResponse = await fetch( | |
`https://api-ssl.bitly.com/v4/bitlinks/${link.id}/clicks/summary`, | |
options | |
); | |
if (!clicksResponse.ok) { | |
throw new Error(`Failed to fetch clicks: ${clicksResponse.statusText}`); | |
} | |
const clicksData = await clicksResponse.json(); | |
return { | |
short: link.link, | |
original: link.long_url, | |
clicks: clicksData.total_clicks || 0, | |
}; | |
} catch (error) { | |
console.error(`Error fetching clicks for ${link.id}:`, error); | |
return { | |
short: link.link, | |
original: link.long_url, | |
clicks: 0, | |
}; | |
} | |
}) | |
); | |
allLinks = [...allLinks, ...mapLinks]; | |
if (mapLinks.length < 100) { | |
break; | |
} | |
currentPage++; | |
} | |
return allLinks; | |
} catch (error) { | |
console.error('Error fetching all links:', error); | |
throw error; | |
} | |
} |
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.
LGTM
Work permit visa needed |
@Azadbangladeshi-com ? |
it's spam |
can't you ban him from commenting? |
What kind of change does this PR introduce?
Feature: Add bit.ly as a shortening link #545
Why was this change needed?
#545
Please link to related issues when possible, and explain WHY you changed things, not WHAT you changed.
Other information:
eg: Did you discuss this change with anybody before working on it (not required, but can be a good idea for bigger changes). Any plans for the future, etc?
Checklist:
Put a "X" in the boxes below to indicate you have followed the checklist;
Summary by CodeRabbit