From 03a903d9245a1bc00a8d8dbf24763e3045ec897c Mon Sep 17 00:00:00 2001
From: Marc Bernard <59966492+mbtools@users.noreply.github.com>
Date: Mon, 15 Jul 2024 17:41:02 -0400
Subject: [PATCH] fix favicon

---
 config.yaml                                   |  13 +++++----
 .../src/middlewares/web/render-web.ts         |  10 ++++++-
 .../src/middlewares/web/utils/renderHTML.ts   |   2 ++
 packages/middleware/test/config/favicon.ico   | Bin 0 -> 15086 bytes
 .../middleware/test/config/file-logo.yaml     |   1 +
 .../middleware/test/config/http-logo.yaml     |  26 ++++++++++++++++++
 packages/middleware/test/config/no-logo.yaml  |   1 +
 packages/middleware/test/render.spec.ts       |  16 +++++++++++
 8 files changed, 63 insertions(+), 6 deletions(-)
 create mode 100644 packages/middleware/test/config/favicon.ico
 create mode 100644 packages/middleware/test/config/http-logo.yaml

diff --git a/config.yaml b/config.yaml
index bc4744309..85bda98ee 100644
--- a/config.yaml
+++ b/config.yaml
@@ -23,9 +23,10 @@ plugins: /verdaccio/plugins
 web:
   enable: true
   title: apm - A Package Manager for ABAP
-  logo: /verdaccio/abappm/apm_banner_gray.png
+  logo: /verdaccio/abappm/apm_banner.png
+  logoDark: /verdaccio/abappm/apm_banner_gray.png
   favicon: /verdaccio/abappm/apm.ico
-  primary_color: '#a0a0a0'
+  primaryColor: '#c0c0c0'
   darkMode: true
   gravatar: true
   # by default packages are ordercer ascendant (asc|desc)
@@ -38,7 +39,8 @@ web:
   pkgManagers:
     - apm
   showInfo: false
-  # showSettings: true
+  showUplinks: false
+  showSettings: false
   # In combination with darkMode you can force specific theme
   # showThemeSwitch: true
   # showFooter: true
@@ -51,13 +53,14 @@ web:
   #  HTML tags injected before ends </head>
   metaScripts:
     - '<meta name="robots" content="noindex" />'
+    - '<meta name="description" content="apm - A Package Manager 📦, a Website 🌐, and a Registry 📑 for ABAP" />'
   #    - '<script type="text/javascript" src="https://code.jquery.com/jquery-3.5.1.slim.min.js"></script>'
   #    - '<script type="text/javascript" src="https://browser.sentry-cdn.com/5.15.5/bundle.min.js"></script>'
   #  HTML tags injected first child at <body/>
   scriptsbodyBefore:
-    - '<div id="beta" style="color:white;background-color:blue;margin:auto;text-align:center;font-size:12px;"><strong>***BETA***</strong>  All published packages will be deleted before go-live!  <strong>***BETA***</strong></div>'
+    - '<div id="beta" style="color:white;background-color:blue;margin:auto;text-align:center;font-size:12px;"><strong>***PLAYGROUND***</strong>  Packages will be deleted every Sunday night!  <strong>***PLAYGROUND***</strong></div>'
   #  Public path for template manifest scripts (only manifest)
-  publicPath: https://registry.abappm.com/
+  publicPath: https://playground.abappm.com/
 
 auth:
   htpasswd:
diff --git a/packages/middleware/src/middlewares/web/render-web.ts b/packages/middleware/src/middlewares/web/render-web.ts
index 3064a42d3..a52c0588e 100644
--- a/packages/middleware/src/middlewares/web/render-web.ts
+++ b/packages/middleware/src/middlewares/web/render-web.ts
@@ -37,7 +37,15 @@ export function renderWebMiddleware(config, tokenMiddleware, pluginOptions) {
   // any match within the static is routed to the file system
   router.get('/-/static/*', function (req, res, next) {
     const filename = req.params[0];
-    const file = `${staticPath}/${filename}`;
+    let file = `${staticPath}/${filename}`;
+    if (filename === 'favicon.ico' && config?.web?.favicon) {
+      file = config?.web?.favicon;
+      if (isURLhasValidProtocol(file)) {
+        debug('redirect to favicon %s', file);
+        req.url = file;
+        return next();
+      }
+    }
     debug('render static file %o', file);
     res.sendFile(file, sendFileCallback(next));
   });
diff --git a/packages/middleware/src/middlewares/web/utils/renderHTML.ts b/packages/middleware/src/middlewares/web/utils/renderHTML.ts
index 65f1f1077..3d8976285 100644
--- a/packages/middleware/src/middlewares/web/utils/renderHTML.ts
+++ b/packages/middleware/src/middlewares/web/utils/renderHTML.ts
@@ -65,6 +65,7 @@ export default function renderHTML(
   const title = config?.web?.title ?? WEB_TITLE;
   const login = hasLogin(config);
   const scope = config?.web?.scope ?? '';
+  const favicon = resolveLogo(config?.web?.favicon, config?.url_prefix, requestOptions);
   const logo = resolveLogo(config?.web?.logo, config?.url_prefix, requestOptions);
   const logoDark = resolveLogo(config?.web?.logoDark, config?.url_prefix, requestOptions);
   const pkgManagers = config?.web?.pkgManagers ?? ['yarn', 'pnpm', 'npm'];
@@ -114,6 +115,7 @@ export default function renderHTML(
     version,
     logo,
     logoDark,
+    favicon,
     flags,
     login,
     pkgManagers,
diff --git a/packages/middleware/test/config/favicon.ico b/packages/middleware/test/config/favicon.ico
new file mode 100644
index 0000000000000000000000000000000000000000..1a4beb4b677465975cb41cf7dc28ea1b3a745038
GIT binary patch
literal 15086
zcmdU0TWnNS6ulK9iHXRcCdODJ8b65fLlJ4kmPb**SH;?DLBIzEiJ*dtQK`=lKNLk2
z1T91mHToe4sA#AXYZXiB1H^)KkcWLj3v^~kl<i*U&c3~OdY?15w4G%4%-nm<*=z0d
z+Gn3rP0P>*Y1dt+ahj=pdX=V))HE$KGx2+vrXA#G!#KtJlEIqxI%l|s^KcPu1`D36
z&u~3S=WjF`y|gPHpA(J6HbmpG9V`b~;w%(UPzGgppe|J>*PRYFr?NyenCmZLJv&+7
z*?>5M@Hz_}&;^}Nc>F%+Ix?bXq6Lh%p%*bb@oRu?VDO9AoR7;5jmD#!`T%zlpXerF
zF=O-k9*@Vb?25<s^gVWcOaTipdEv%;<cpq(we=V51`fvL#R2WqpX_d6Pt0w==G2$?
zc}D-}?_Tq;8V^0jbYh-K8arNf*}w0KMd@_3%OZFNNw#T9zj<CVj|H~<V6G>WIT9F8
zb)BY;lbv*;vqK5KpFDj^@d=4T1278*wKfG`KYQ3xupjR@K`m{q)YQ^UP0dZz+}c9z
zCyrC+sgsIBN;Xfz2h4&$v99*O6I2iS3~ar$>^&NppJS2S;z<NvXq!;lfY)i@hd;wO
z)Ak8~34H{1&bn^`-Bd7+ZZ5u6N%sADH1eJt+PwW6#Sc7#+QugTS;H4gY8#upp8CZ0
zZ<Q@qb{|uG8{IN}k|Cq+9ZNaf2H+P~8*m>IKhhJQ8>gPOA8+6m4rmW>*i~N>UK@1#
zz-i$Z+e^Pswmte0#>0(Mb7|UBkA&F<;=iYiKZxyROo!M8sqQ@tzCmm+_(N=iRQ62<
z_Ec;y971dZ1CQGnwR<PFcbap|{a$cOI(=cN;~+4HbZjpis`u1}Hx~t51H|@A*XV1l
z)0~r4Fu}483wET_7d;y8n(UK<U)yID=FzIp);Qt^hnhd?lwX88?fPhMJo9V&m7kWW
z{*hZe*^$G8i)NqGJ`}|E@Q2_llzq9*5kJ~s&;EU(`K4a%CAN2(bH*gr+7%l<H2i&(
znelW9-8H93$(<#IWR{g1J~Hxp=}+gqZ`-r~3ENAbMhXt*eGPnR+20_QwvsaG;B+eM
z*Y@v!vbslq5bnU;+TN!2G}zZbu-9oj-mb<$SiWg82hk7zceL{F?R`x6{$|_Hd%KaQ
zEN)OT`mwz<WWp|sTzFeGU3~X$x+K4bD(jj;-J_W~i0$8YnD3?Ezqf9c#r7*U{zEUX
zJ*=d(><|sf+eKPVm91PqyFQimz|#kU?a{98wjZzdU1r;x`LEyBOe?-RMpIvGu*D8e
z87$HUKF5K?uwB;<={xVNU7_Z|<h538|L(dEEVeh}zx}xex?%QSx_<T^8Z_44{@{T3
z*h8be&E*}w>+yGwbyx7C-(wGwRXD*SqwXE2Z0~36z4q~8x^>Y$*EXoy*X9?$Iy-RS
zX7C68oi$ZFZpYK;0()7$ew8s_y49Ee!hV|a?4LAra<yd~%eWpkWj8H+KjNz{<J`l;
z{=fqcB4}H)$a6Q`=68}Gskt6}mv`p;PT$r3J*4=Fla5||uHq*u2Be=08U3Xfb%v)S
z5x)Zdu;Pd3lD9d27-szT9C5J3Z&e@C&*{QzUmtTq%3PD;=fFSE&o2@j2JHC}@Z&R(
z&+l{wI*0yrju+(oR5<W>7_jHpCJqDk{(x{miuFOQar!!)_F0X~ycz2K4KoM%Zk*Y4
zpB<zc!<M~ATK8w@UroD(*v1h}8-lcy?+bBy7J!#%8o%ZYJf@Leu4x@eFVeIK(jnbx
zIerh)G)YVGn@^dOQ#|g^pHhIc!Cj8$CVmn8Ht`p`h@Hf4Vn?y7VdsS1aZf9gC5Oeh
zr^R=<f_%77UB>74`CYNt>pa(e$NP$Qmp-ohD4Yj*Q3hpEM-ZLJ%j5C_zVon*b%ik|
zxsK>E)aeIDEEdaVy$3vb2KS>5pl&w|u`{v7toOfO&@KMsf6!rvA;G&hb$4S(vV-2<
z{%tP%OT+~rvcC*qw*%(>kmzfI&ohNS#5NHhgvi--0R5~Zx(w~0##n%U4(_;bF}L(d
z%I0$j$fSp-Dm=gy00Z`^YJ3MMqwJ0QA2{<yd<iip#A(XDSZ9e(`l>TAxA@ANh*cm4
zRrJIx8qKjHIfKtC%A>K<rl=TU5E~ftn$NL}zNWZOW$x3u?=g(x-;nak9f54%dro!X
zjyoV|3!Hc4&wU`64gAdK3EQ}Fzww@2r5|Zf8~AB^^m)5>H**L7lx*Om?cKPKDVnJC
zihi>V{BZNiBisuY%&_!%a344Qc3S=UT8n<M0p<vl^{U_Ny&Lz6UB9Zi7h_NOOIlI&
zYufs~xC_4{O-HF_Z!O=!*-ce-)k+Q@I~r&#+S$R2JId@oa+3B&I_aCr7W#10AzJ-a
zBdz&5LK}bjoBnKUQ5fv%_Id_xXv6#FC%5}V)$YQ*<jqDtd)QCc&Z_Sb`@Xuk)_YxW
zm;*46I?Z*zRR3n_S7lq9=%F|MqVxF-%6x{Cky}NZD~_o(!<KKtSG0Qv{e=r=(oMX!
zWZyqg3C;)5=Y_kJLmO<WXr;*<KR4^g_bZBORUehS=G5?0ZRP;zC|>w5O`LVNMJj84
zw{VyGYX9m~XIUd=*3<9@>I}(Qu#Y;s?8l+uBirbgdV4iJqx<KqBMd*=)-EpimH(l9
zAl=swT0YJEy8i|JLH$n`PJS_2{7+!$OaB}C@#)L`hmOFoL!a!w1cTlm`ey$r7?6s8
zZuqGVbG4;ECgxOQZt>WEQ)z|@)o^^_a*j1z6yfMYIY%T)Icy-JrTCHZNXxm-2-giA
z(51o@tQ&C(ge5Xrj5vjHgPk8HeYkDT<CxvtSUk3cdAC@&>+@&}-XRb2nv3%oyMq6R
zrP8L1{kY}4D1$msSD>;or*j>G*-7sUZ@o&7zw(Sd2Cm1%w@04uD}Lm)k@tbTM&hj5
zPKT4Nu*PA1!#)aYYvKHvJ=WGleRg)HZ57*<UhIXi2ZZmtx%^vO49U2lJ8$M)N_RH<
z(6|Ey-_ZqwrCzgc_z4?-*h2GOT1X|&&!;B7yOXTX{5x59OM5H9hsl}$2aT9fPX$XF
z?CfCJVB62zmA!C}6#g0NK5+CD-LY8rKj8P2Z9Qhjp!%d>*s=3xdU5HiN}AidvDO{z
zq-R$~=&9w6w7sg$C@=k4$_GtlETq$aF$U5ZKPZonj0LAY$=qzmZwJSQ%Q;S3nxTtc
MoAY1EhcYPpKk8q&4gdfE

literal 0
HcmV?d00001

diff --git a/packages/middleware/test/config/file-logo.yaml b/packages/middleware/test/config/file-logo.yaml
index 468ad357a..50441befc 100644
--- a/packages/middleware/test/config/file-logo.yaml
+++ b/packages/middleware/test/config/file-logo.yaml
@@ -15,6 +15,7 @@ web:
   primary_color: '#ffffff'
   logo: './test/config/dark-logo.png'
   logoDark: './test/config/dark-logo.png'
+  favicon: './test/config/favicon.ico'
   html_cache: false
 
 url_prefix: /prefix
diff --git a/packages/middleware/test/config/http-logo.yaml b/packages/middleware/test/config/http-logo.yaml
new file mode 100644
index 000000000..6f59e43d7
--- /dev/null
+++ b/packages/middleware/test/config/http-logo.yaml
@@ -0,0 +1,26 @@
+web:
+  title: verdaccio web
+  login: true
+  scope: '@scope'
+  pkgManagers:
+    - pnpm
+    - yarn
+  showInfo: true
+  showSettings: true
+  showSearch: true
+  showFooter: true
+  showThemeSwitch: true
+  showDownloadTarball: true
+  showRaw: true
+  primary_color: '#ffffff'
+  logo: https://raw.githubusercontent.com/verdaccio/verdaccio/master/assets/svg/logo-small.svg
+  logoDark: https://raw.githubusercontent.com/verdaccio/verdaccio/master/assets/svg/logo-blackwhite.svg
+  favicon: https://raw.githubusercontent.com/verdaccio/verdaccio/master/website/static/img/favicon/favicon.ico
+  html_cache: false
+
+url_prefix: /prefix
+
+log: { type: stdout, format: pretty, level: trace }
+
+flags:
+  changePassword: true
diff --git a/packages/middleware/test/config/no-logo.yaml b/packages/middleware/test/config/no-logo.yaml
index 794b8a441..0a7c19308 100644
--- a/packages/middleware/test/config/no-logo.yaml
+++ b/packages/middleware/test/config/no-logo.yaml
@@ -14,6 +14,7 @@ web:
   showRaw: true
   primary_color: '#ffffff'
   logo:
+  favicon:
   html_cache: false
 
 url_prefix: /prefix
diff --git a/packages/middleware/test/render.spec.ts b/packages/middleware/test/render.spec.ts
index 810f3adb8..96916abcd 100644
--- a/packages/middleware/test/render.spec.ts
+++ b/packages/middleware/test/render.spec.ts
@@ -86,6 +86,21 @@ describe('test web server', () => {
         expect(__VERDACCIO_BASENAME_UI_OPTIONS.logoDark).toMatch('/prefix/-/static/dark-logo.png');
       });
 
+      test('should render favicon as file', async () => {
+        const {
+          window: { __VERDACCIO_BASENAME_UI_OPTIONS },
+        } = await render('file-logo.yaml');
+        expect(__VERDACCIO_BASENAME_UI_OPTIONS.favicon).toMatch('/prefix/-/static/favicon.ico');
+      });
+
+      test('should render logo and favicon as URL', async () => {
+        const {
+          window: { __VERDACCIO_BASENAME_UI_OPTIONS },
+        } = await render('http-logo.yaml');
+        expect(__VERDACCIO_BASENAME_UI_OPTIONS.logo).toMatch(/https:.*logo-small.svg/i);
+        expect(__VERDACCIO_BASENAME_UI_OPTIONS.favicon).toMatch(/https:.*favicon.ico/i);
+      });
+
       test('should not render logo as absolute file is wrong', async () => {
         const {
           window: { __VERDACCIO_BASENAME_UI_OPTIONS },
@@ -98,6 +113,7 @@ describe('test web server', () => {
           window: { __VERDACCIO_BASENAME_UI_OPTIONS },
         } = await render('no-logo.yaml');
         expect(__VERDACCIO_BASENAME_UI_OPTIONS.logo).toEqual('');
+        expect(__VERDACCIO_BASENAME_UI_OPTIONS.favicon).toEqual('');
       });
 
       test.todo('should default title');