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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Feature: Add bit.ly as a shortening link - 545 #601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2083da0
Feature: Add bit.ly as a shortening link - 545
pritam1322 Feb 9, 2025
293e42e
Merge branch 'main' into 545----Add-bit.ly-as-a-shortening-link
egelhaus Feb 12, 2025
4ad7848
Merge branch 'main' into 545----Add-bit.ly-as-a-shortening-link
egelhaus Feb 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 88 additions & 0 deletions libraries/nestjs-libraries/src/short-linking/providers/bitly.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
import { ShortLinking } from '@gitroom/nestjs-libraries/short-linking/short-linking.interface';

const options = {
headers: {
Authorization: `Bearer ${process.env.BITLY_TOKEN}`,
'Content-Type': 'application/json',
},
};
Comment on lines +3 to +8
Copy link

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.

Suggested change
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',
},
};


export class Bitly implements ShortLinking {
shortLinkDomain = 'bit.ly';

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,
};
})
);
}
Comment on lines +13 to +32
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

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.

Suggested change
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 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;
}
Comment on lines +34 to +48
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

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.

Suggested change
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;
}
}


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;
}
Comment on lines +50 to +55
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

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 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))];
}
Comment on lines +57 to +87
Copy link

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:

  1. Missing error handling for API calls
  2. No rate limiting consideration
  3. 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.

Suggested change
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;
}
}

}
5 changes: 5 additions & 0 deletions libraries/nestjs-libraries/src/short-linking/short.link.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { Empty } from '@gitroom/nestjs-libraries/short-linking/providers/empty';
import { ShortLinking } from '@gitroom/nestjs-libraries/short-linking/short-linking.interface';
import { Injectable } from '@nestjs/common';
import { ShortIo } from './providers/short.io';
import { Bitly } from '@gitroom/nestjs-libraries/short-linking/providers/bitly';

const getProvider = (): ShortLinking => {
if (process.env.DUB_TOKEN) {
Expand All @@ -13,6 +14,10 @@ const getProvider = (): ShortLinking => {
return new ShortIo();
}

if(process.env.BITLY_TOKEN){
return new Bitly();
}

return new Empty();
};

Expand Down
Loading