fix(sponsors): fix custom tiers processing; (#238)

* feat: add sponsor list generator;

* feat: added deploy action;

* fix: fixed layout;

* fix: use utm links inside tooltips;

* fix(CI): set engine version;

* chore: reverted the start button title change;

* fix: add the ability to retry the request to get a list of sponsors;

* chore: change sponsors config & fix sponsor card layout;

* chore: hide 'incognito' sponsor from the list of sponsors;

* chore: add Route4Me sponsor;

* chore: fixed resolution of utm link for manually added sponsors;

* chore: fixed sponsors' tiers resolving;

* chore: draft;

* chore(sponsors): disable utm links generation for `slotozilla-deutschland`;

* chore(draft): Improve sponsors list generator;

* chore(draft): fix origin preset;

* chore(draft): delete generated icon;

* chore(draft): add check to ensure dir exists;

* chore(draft): add check to ensure dir exists;

* chore(draft): activate GitHub data pulling;

* chore(draft): fix crown chevron styling;

* chore(draft): reduce logo min-width;

* chore(draft): add missed `route4me` light logo;

* chore(draft): add a title for readme sponsor block;

* chore(draft): fix description resolving;

* chore(draft): add utm links for sponsors rendered to markdown;

* chore(draft): respect autoUTMLinks for utm links generation;

* chore(draft): set user theme timeout to 24 hours;

* chore(draft): set utm link for markdown output;

* chore(draft): add sponsors' logos;

* chore(draft): fix sponsor.json;

* chore(draft): fix sponsor.json;

* chore(draft): add principal logo;

* chore(draft): add a hotfix for svg logos;

* chore(draft): use image metadata instead of file extension to determine image format;

* chore(draft): add Stytch & Descope links;

* chore(draft): fix utm link generator to respect sponsor's params;

* chore(draft): add page active link rendering;

* chore(draft): notes block refactoring;

* chore(draft): remove graphql packages;

* chore(sponsors): add website link for buzzoid.com;

* chore(sponsors): remove Route4me from the list;

* chore(sponsors): Fixed relative URLs for dark theme logos in the Readme sponsor generator;

* fix(sponsors): add a hotfix for sponsors generator by emulating OpenCollective's isActive property.

* fix(sponsors): fix custom tiers processing;

---------

Co-authored-by: Jay <[email protected]>

Author: DigitalBrainJS

data/sponsors.json

@@ -6,19 +6,22 @@
   "scoreTotalAmountFactor": 0.2,
   "tiers": {
     "backer" : {
+      "name": "Backer",
       "price": 20,
       "benefits": {
         "showAtSponsorList": true
       },
       "period": 2
     },
     "bronze": {
+      "name": "Bronze",
       "price": 49,
       "benefits": {
         "showAtSponsorList": true
       }
     },
     "silver" : {
+      "name": "Silver",
       "price": 99,
       "benefits": {
         "showAtSponsorList": true,
@@ -27,6 +30,7 @@
       }
     },
     "gold" : {
+      "name": "Gold",
       "price": 299,
       "benefits": {
         "showAtSponsorList": true,
@@ -40,6 +44,7 @@
       }
     },
     "platinum" : {
+      "name": "Platinum",
       "price": 599,
       "benefits": {
         "showAtSponsorList": true,
@@ -92,7 +97,6 @@
       "autoUTMLinks": false
     },
     "stytch": {
-      "tier": "gold",
       "description": "API-first authentication, authorization, and fraud prevention",
       "image": "/assets/sponsors/stytch.png",
       "image_dark": "/assets/sponsors/stytch_white.png",
@@ -101,22 +105,36 @@
         "Website": "https://stytch.com/?utm_source=oss-sponsorship&utm_medium=paid_sponsorship&utm_content=website-link&utm_campaign=axios-http",
         "Documentation": "https://stytch.com/docs?utm_source=oss-sponsorship&utm_medium=paid_sponsorship&utm_content=docs-link&utm_campaign=axios-http",
         "Node.js": "https://github.com/stytchauth/stytch-node?utm_source=oss-sponsorship&utm_medium=paid_sponsorship&utm_content=node-sdk&utm_campaign=axios-http"
+      },
+      "tiers": {
+        "gold": {
+          "price": 200
+        }
       }
     },
     "descope": {
-      "tier": "gold",
       "image": "/assets/sponsors/descope.png",
       "image_dark": "/assets/sponsors/descope_white.png",
       "targetLink": "https://www.descope.com/?utm_source=axios&utm_medium=referral&utm_campaign=axios-oss-sponsorship",
       "links": {
         "Website": "https://www.descope.com/?utm_source=axios&utm_medium=referral&utm_campaign=axios-oss-sponsorship",
-        "Documentation": "https://docs.descope.com/?utm_source=axios&utm_medium=referral&utm_campaign=axios-oss-sponsorship",
+        "Docs": "https://docs.descope.com/?utm_source=axios&utm_medium=referral&utm_campaign=axios-oss-sponsorship",
         "Community": "https://www.descope.com/community?utm_source=axios&utm_medium=referral&utm_campaign=axios-oss-sponsorship"
+      },
+      "tiers": {
+        "gold": {
+          "price": 200
+        }
       }
     },
     "principal": {
       "tier": "gold",
-      "image": "/assets/sponsors/principal.svg"
+      "image": "/assets/sponsors/principal.svg",
+      "tiers": {
+        "gold": {
+          "price": 175
+        }
+      }
     },
     "buy-instagram-followers-buzzoid":  {
       "website": "https://buzzoid.com/buy-instagram-followers/"

package-lock.json

@@ -23,6 +23,7 @@
     "http-server": "^14.1.0",
     "inert-ssg": "^2.0.0-alpha.15",
     "joi": "^17.13.3",
+    "lodash": "^4.17.21",
     "mime-types": "^2.1.35",
     "sharp": "^0.31.3"
   }

package.json

@@ -8,6 +8,7 @@ const crypto = require('crypto');
 const Joi = require('joi');
 const Handlebars = require('handlebars');
 const axios = require('axios');
+const {merge} = require('lodash');
 
 const origin = 'https://axios-http.com/';
 //const origin = 'http://127.0.0.1:8080/';
@@ -436,13 +437,13 @@ const processGithub = async (sponsor, repo = 'axios-sponsor', file = 'sponsor.js
 
 
 const renderTooltip = async (sponsor) => {
-  let {icon, isActive, displayName, tier, lastTransactionAmount, price, description, website, benefits, video, autoUTMLinks, links} = sponsor;
+  let {icon, isActive, displayName, tier, tierId, lastTransactionAmount, price, description, website, benefits, video, autoUTMLinks, links} = sponsor;
 
   const iconSrc = icon && (await downloadImage(icon));
 
   const iconHTML = iconSrc ? `<img class="sponsor-icon" src="/${iconSrc}" alt="${html.escape(displayName)}"/>` : '';
 
-  const renderedTier = isActive && tier.toLowerCase() === 'backer' ? `${price || lastTransactionAmount || 0}$ a month` : tier;
+  const renderedTier = isActive && (tierId === 'backer' || sponsor.tierPrice < sponsor.originalTierPrice) ? `${price || lastTransactionAmount || 0}$ a month` : tier;
 
   let tooltip = `<h2 class="caption">${iconHTML}<span>${html.escape(displayName)} (${sponsor.totalAmountDonated || 0}$${' <sup class="tier">' + renderedTier + '</sup>'})</span></h2> `;
 
@@ -502,7 +503,7 @@ const findTier = (price, tiers) => {
   price && Object.entries(tiers).forEach(([tier, data]) => {
     if (data.price <= price && max < price) {
       max = data.price;
-      found = tier;
+      found = data.name || tier;
     }
   });
 
@@ -537,9 +538,15 @@ const processSponsors = async (collectiveSponsors, sponsorsConfig = './data/spon
     const {period = 31} = tierData || {};
     const isActiveSubscription = tierData && passed <= period;
 
-    sponsor.isActive = !!(isActiveSubscription && lastTransactionAmount > 0 && totalAmountDonated);
+    if (tier) {
+      sponsor.isActive = !!(isActiveSubscription && lastTransactionAmount > 0 && totalAmountDonated);
+    } else {
+      sponsor.isActive = undefined;
+    }
 
-    mergedSponsors[sponsor.login] = {...sponsor};
+    if (!mergedSponsors[sponsor.login] || sponsor.isActive) {
+      mergedSponsors[sponsor.login] = {...sponsor};
+    }
   });
 
   // merge sponsors from sponsors.json
@@ -550,7 +557,6 @@ const processSponsors = async (collectiveSponsors, sponsorsConfig = './data/spon
       login,
       ...collective,
       ...local,
-      localConfig: {...local},
       manualBilling: !!(local.lastTransactionAt && local.lastTransactionAmount || local.endDate)
     }
   });
@@ -559,39 +565,44 @@ const processSponsors = async (collectiveSponsors, sponsorsConfig = './data/spon
 
   // normalize sponsors config
   Object.entries(mergedSponsors).forEach(([login, sponsor]) => {
-    if (!sponsor.tier) {
-      sponsor.tier = 'backer';
-    }
 
-    let {isActive, tier, lastTransactionAmount = 0, lastTransactionAt, manualBilling, localConfig} = sponsor;
+    let {lastTransactionAmount = 0, lastTransactionAt, manualBilling} = sponsor;
+
+    const sponsorTiers = merge({}, tiers, sponsor.tiers);
 
-    const tierLower = tier.toLowerCase();
+    if (lastTransactionAmount) {
+      sponsor.tier = findTier(lastTransactionAmount, sponsorTiers);
+    }
 
-    const tierData = tiers[tierLower];
+    const tierId = sponsor.tier ? sponsor.tier?.toLowerCase() : null;
+    const tierData = tierId && sponsorTiers[tierId];
 
-    if (!tierData) {
-      console.log(`Unknown tier [${tier}]`);
+    if (tierId && !tierData) {
+      console.log(`Unknown tier [${sponsor.tier}]`);
     }
 
     const {price, benefits, period = PERIOD} = tierData || {};
 
+    if (sponsor.isActive == null) {
+      sponsor.isActive = tierData && days(lastTransactionAt) <= period && sponsor.lastTransactionAmount >= price;
+    }
+
     console.log(sponsor.login);
 
-    const isBacker = tierLower === 'backer';
+    const originalTierPrice = tiers[tierId]?.price;
 
-    sponsor.tierId = tierLower;
-    sponsor.tierPrice = isBacker && isActive && lastTransactionAmount ? lastTransactionAmount : price;
+    const isCustomTier = !!(tierData && price !== originalTierPrice);
+    sponsor.tierId = tierId;
+    sponsor.tier = sponsor.tier + (lastTransactionAmount > originalTierPrice ? '+' : '')
+    sponsor.tierPrice = price;
+    sponsor.originalTierPrice = originalTierPrice;
+    sponsor.isCustomTier = isCustomTier;
     sponsor.totalAmountDonated = sponsor.totalAmountDonated || lastTransactionAmount || 0;
 
-    sponsor.associatedTierId = tierLower;
-
 
-    let assoc;
 
-    if (localConfig?.isActive === false) {
-      sponsor.isActive = false;
-    } else if (tier && (manualBilling || tierLower === 'backer')) {
-      if(sponsor.endDate || lastTransactionAmount >= price) {
+    if (sponsor.tier && manualBilling) {
+      if (sponsor.endDate || lastTransactionAmount >= price) {
         const pricePerSec = price / (period * DAY);
         const timePaid = lastTransactionAmount / pricePerSec
         const endDate = sponsor.endDate = sponsor.endDate || +(new Date(lastTransactionAt)) + timePaid * 1000;
@@ -608,11 +619,6 @@ const processSponsors = async (collectiveSponsors, sponsorsConfig = './data/spon
       sponsor.boost = sponsor.boost || 1;
     }
 
-    if (isActive && isBacker && !localConfig?.tier && (assoc = findTier(lastTransactionAmount, tiers))) {
-      const tier = assoc.toLowerCase();
-      tier !== 'backer' && (sponsor.associatedTierId = tier);
-    }
-
     sponsor.isActive = sponsor.isActive === true;
 
     sponsor.benefits = {

scripts/updateData.js

@@ -103,7 +103,7 @@
               <% if (count) { %>
                 <% config.custom.sponsors && config.custom.sponsors.forEach(sponsor => { %>
                   <% if(sponsor.isActive && !sponsor.hide && sponsor.benefits.showAtSponsorList ){ %>
-                    <li class="splide__slide sponsor-card <%= sponsor.visual.className || "" %> opacity_<%= Math.round(4 * sponsor.visual.opacity) * 25 %>" data-tier="<%=sponsor.associatedTierId%>" data-is-wide="<%= !!sponsor.isWideImage %>" data-is-active="<%= sponsor.isActive ? "yes" : "no" %>"  data-image-type="<%= sponsor.imageType || '' %>" <% if(sponsor.tooltip){ %>data-tippy-content="<%= sponsor.tooltip %>"<% } %>>
+                    <li class="splide__slide sponsor-card <%= sponsor.visual.className || "" %> opacity_<%= Math.round(4 * sponsor.visual.opacity) * 25 %>" data-tier="<%=sponsor.tierId%>" data-is-wide="<%= !!sponsor.isWideImage %>" data-is-active="<%= sponsor.isActive ? "yes" : "no" %>"  data-image-type="<%= sponsor.imageType || '' %>" <% if(sponsor.tooltip){ %>data-tippy-content="<%= sponsor.tooltip %>"<% } %>>
                       <a href="<%= sponsor.targetLink || '#' %>" target="_blank" >
                         <% if(sponsor.image){ %>
                           <div>

templates/home.ejs

@@ -212,7 +212,7 @@
                 <% if (count) { %>
                   <% config.custom.sponsors && config.custom.sponsors.forEach(sponsor => { %>
                     <% if(sponsor.isActive && !sponsor.hide && sponsor.benefits.showAtPages ){ %>
-                      <li class="splide__slide sponsor-card <%= sponsor.visual.className || "" %> opacity_<%= Math.round(4 * sponsor.visual.opacity) * 25 %>" data-tier="<%=sponsor.associatedTierId%>" data-is-wide="<%= !!sponsor.isWideImage %>" data-has-logo="<%= !!sponsor.image %>" data-is-active="<%= sponsor.isActive ? "yes" : "no" %>" data-image-type="<%= sponsor.imageType || '' %>" <% if(sponsor.tooltip){ %>data-tippy-content="<%= sponsor.tooltip %>"<% } %>>
+                      <li class="splide__slide sponsor-card <%= sponsor.visual.className || "" %> opacity_<%= Math.round(4 * sponsor.visual.opacity) * 25 %>" data-tier="<%=sponsor.tierId%>" data-is-wide="<%= !!sponsor.isWideImage %>" data-has-logo="<%= !!sponsor.image %>" data-is-active="<%= sponsor.isActive ? "yes" : "no" %>" data-image-type="<%= sponsor.imageType || '' %>" <% if(sponsor.tooltip){ %>data-tippy-content="<%= sponsor.tooltip %>"<% } %>>
                         <a href="<%= sponsor.targetLink || '#' %>" target="_blank" >
                           <% if(sponsor.image){ %><div>
                             <% if (sponsor.tierId=== 'platinum' && sponsor.benefits.crown) { %><div class="chevron"><span class="sponsor_chevron_crown"></span></div><% } %>

templates/post.ejs

@@ -23,7 +23,7 @@
         {{/if}}
         {{#if description}}<p align="center" title="{{description}}">{{#short benefits.maxReadmeDescLength}}{{description}}{{/short}}</p>{{else}}{{#if showCaptions}}<p align="center">{{displayName}}</p>{{/if}}{{/if}}
         {{#if links}}<p align="center">
-          {{#each links}}<a href="{{this}}"><b>{{@key}}</b></a>{{#sep}} | {{/sep}}{{/each}}
+          {{#each links}}<a href="{{this}}"><b>{{#short 40}}{{@key}}{{/short}}</b></a>{{#sep}} | {{/sep}}{{/each}}
         </p>{{/if}}
       {{else}}
         - {{displayName}}