perf(swagger-ui): use jsdelivr instead of unpkg to serve swagger-ui a…

…ssets (#701) * perf: use jsdelivr instead of unpkg to serve swagger-ui assets * format * add changeset
honojs · Aug 25, 2024 · 32abe11 · 32abe11
1 parent f4030cb
commit 32abe11
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 13 deletions.
diff --git a/.changeset/beige-snails-cover.md b/.changeset/beige-snails-cover.md
@@ -0,0 +1,5 @@
+---
+'@hono/swagger-ui': patch
+---
+
+perf: use jsdelivr instead of unpkg to serve swagger-ui assets
diff --git a/packages/swagger-ui/src/swagger/resource.ts b/packages/swagger-ui/src/swagger/resource.ts
@@ -8,7 +8,9 @@ type ResourceConfig = {
 }
 
 export const remoteAssets = ({ version }: ResourceConfig): AssetURLs => {
-  const url = `https://unpkg.com/swagger-ui-dist${version !== undefined ? `@${version}` : ''}`
+  const url = `https://cdn.jsdelivr.net/npm/swagger-ui-dist${
+    version !== undefined ? `@${version}` : ''
+  }`
 
   return {
     css: [`${url}/swagger-ui.css`],

diff --git a/packages/swagger-ui/test/index.test.ts b/packages/swagger-ui/test/index.test.ts
@@ -8,8 +8,8 @@ describe('SwaggerUI Rendering', () => {
     expect(SwaggerUI({ url }).toString()).toEqual(`
     <div>
       <div id="swagger-ui"></div>
-      <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist/swagger-ui.css" />
-      <script src="https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js" crossorigin="anonymous"></script>
+      <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist/swagger-ui.css" />
+      <script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist/swagger-ui-bundle.js" crossorigin="anonymous"></script>
       <script>
         window.onload = () => {
           window.ui = SwaggerUIBundle({
@@ -25,8 +25,8 @@ describe('SwaggerUI Rendering', () => {
     expect(SwaggerUI({ url, version: '5.0.0' }).toString()).toEqual(`
     <div>
       <div id="swagger-ui"></div>
-      <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@5.0.0/swagger-ui.css" />
-      <script src="https://unpkg.com/swagger-ui-dist@5.0.0/swagger-ui-bundle.js" crossorigin="anonymous"></script>
+      <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.0.0/swagger-ui.css" />
+      <script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.0.0/swagger-ui-bundle.js" crossorigin="anonymous"></script>
       <script>
         window.onload = () => {
           window.ui = SwaggerUIBundle({
@@ -51,8 +51,8 @@ describe('SwaggerUI Rendering', () => {
     ).toEqual(`
     <div>
       <div id="swagger-ui"></div>
-      <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist/swagger-ui.css" />
-      <script src="https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js" crossorigin="anonymous"></script>
+      <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist/swagger-ui.css" />
+      <script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist/swagger-ui-bundle.js" crossorigin="anonymous"></script>
       <script>
         window.onload = () => {
           window.ui = SwaggerUIBundle({
@@ -89,8 +89,8 @@ describe('SwaggerUI Rendering', () => {
       `
         <div>
           <div id="swagger-ui-manually"></div>
-          <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist/swagger-ui.css" />
-          <script src="https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js" crossorigin="anonymous"></script>
+          <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist/swagger-ui.css" />
+          <script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist/swagger-ui-bundle.js" crossorigin="anonymous"></script>
           <script>
             window.onload = () => {
               window.ui = SwaggerUIBundle({

diff --git a/packages/swagger-ui/test/remote-assets.test.ts b/packages/swagger-ui/test/remote-assets.test.ts
@@ -3,14 +3,18 @@ import { remoteAssets } from '../src/swagger/resource'
 describe('remoteAssets', () => {
   it('should return default assets when no version is provided', () => {
     const assets = remoteAssets({})
-    expect(assets.css).toEqual(['https://unpkg.com/swagger-ui-dist/swagger-ui.css'])
-    expect(assets.js).toEqual(['https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js'])
+    expect(assets.css).toEqual(['https://cdn.jsdelivr.net/npm/swagger-ui-dist/swagger-ui.css'])
+    expect(assets.js).toEqual(['https://cdn.jsdelivr.net/npm/swagger-ui-dist/swagger-ui-bundle.js'])
   })
 
   it('should return assets with version when version is provided', () => {
     const version = '1.2.3'
     const assets = remoteAssets({ version })
-    expect(assets.css).toEqual([`https://unpkg.com/swagger-ui-dist@${version}/swagger-ui.css`])
-    expect(assets.js).toEqual([`https://unpkg.com/swagger-ui-dist@${version}/swagger-ui-bundle.js`])
+    expect(assets.css).toEqual([
+      `https://cdn.jsdelivr.net/npm/swagger-ui-dist@${version}/swagger-ui.css`,
+    ])
+    expect(assets.js).toEqual([
+      `https://cdn.jsdelivr.net/npm/swagger-ui-dist@${version}/swagger-ui-bundle.js`,
+    ])
   })
 })