feat: add regex pattern for custom cdn urls (#43)

* feat: add regex pattern and use for custom cdn urls * fix: typo in test Co-authored-by: Espen Hovlandsdal <espen@hovlandsdal.com> * refactor: update check for readability --------- Co-authored-by: Espen Hovlandsdal <espen@hovlandsdal.com>
sanity-io · Nov 14, 2024 · 211f387 · 211f387
1 parent c8786cf
commit 211f387
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 3 deletions.
diff --git a/src/constants.ts b/src/constants.ts
@@ -8,6 +8,12 @@ export const cdnUrl = 'https://cdn.sanity.io'
  */
 export const cdnUrlPattern = /^https:\/\/cdn\.sanity\./
 
+/**
+ * @internal
+ */
+export const customCdnUrlPattern =
+  /^https:\/\/cdn\.[^/]+\/(images|files)\/[^/]+\/.*?[a-zA-Z0-9_]{24,40}.*$/
+
 /**
  * @internal
  */

diff --git a/src/parse.ts b/src/parse.ts
@@ -1,5 +1,6 @@
 import {
   cdnUrlPattern,
+  customCdnUrlPattern,
   fileAssetIdPattern,
   imageAssetFilenamePattern,
   imageAssetIdPattern,
@@ -116,7 +117,7 @@ export function parseAssetFilename(filename: string): SanityAssetIdParts {
  * @throws If URL is invalid or not a Sanity asset URL
  */
 export function parseAssetUrl(url: string): SanityAssetUrlParts {
-  if (!cdnUrlPattern.test(url)) {
+  if (!cdnUrlPattern.test(url) && !customCdnUrlPattern.test(url)) {
     throw new Error(`URL is not a valid Sanity asset URL: ${url}`)
   }
 

diff --git a/src/paths.ts b/src/paths.ts
@@ -2,6 +2,7 @@ import {isAssetObjectStub, isAssetPathStub, isAssetUrlStub, isReference} from '.
 import {
   cdnUrl,
   cdnUrlPattern,
+  customCdnUrlPattern,
   fileAssetFilenamePattern,
   imageAssetFilenamePattern,
   pathPattern,
@@ -157,7 +158,7 @@ export function getUrlPath(url: string): string {
     return url
   }
 
-  if (!cdnUrlPattern.test(url)) {
+  if (!cdnUrlPattern.test(url) && !customCdnUrlPattern.test(url)) {
     throw new UnresolvableError(`Failed to resolve path from URL "${url}"`)
   }
 

diff --git a/test/parse.test.ts b/test/parse.test.ts
@@ -112,6 +112,7 @@ test('parseAssetFilename(): returns object of named image properties if legacy f
 test.each([
   'https://cdn.sanity.io/images/espenhov/diary/756e4bd9c0a04ada3d3cc396cf81f1c433b07870-5760x3840.jpg/vanity-filename.jpg',
   'https://cdn.sanity.staging/images/espenhov/diary/756e4bd9c0a04ada3d3cc396cf81f1c433b07870-5760x3840.jpg/vanity-filename.jpg',
+  'https://cdn.autofoos.com/images/espenhov/diary/756e4bd9c0a04ada3d3cc396cf81f1c433b07870-5760x3840.jpg/vanity-filename.jpg',
 ])(
   'parseAssetUrl(): returns object of named image properties on modern filename with vanity filename',
   (url) => {
@@ -131,6 +132,7 @@ test.each([
 test.each([
   'https://cdn.sanity.io/images/espenhov/diary/756e4bd9c0a04ada3d3cc396cf81f1c433b07870-5760x3840.jpg',
   'https://cdn.sanity.staging/images/espenhov/diary/756e4bd9c0a04ada3d3cc396cf81f1c433b07870-5760x3840.jpg',
+  'https://cdn.autofoos.com/images/espenhov/diary/756e4bd9c0a04ada3d3cc396cf81f1c433b07870-5760x3840.jpg',
 ])('parseAssetUrl(): returns object of named image properties on modern filename', (url) => {
   expect(parseAssetUrl(url)).toMatchObject({
     assetId: '756e4bd9c0a04ada3d3cc396cf81f1c433b07870',
@@ -147,6 +149,7 @@ test.each([
 test.each([
   'https://cdn.sanity.io/images/espenhov/diary/LA5zSofUOP0i_iQwi4B2dEbzHQseitcuORm4n-600x578.png',
   'https://cdn.sanity.staging/images/espenhov/diary/LA5zSofUOP0i_iQwi4B2dEbzHQseitcuORm4n-600x578.png',
+  'https://cdn.autofoos.com/images/espenhov/diary/LA5zSofUOP0i_iQwi4B2dEbzHQseitcuORm4n-600x578.png',
 ])('parseAssetUrl(): returns object of named image properties on legacy filename', (url) => {
   expect(parseAssetUrl(url)).toMatchObject({
     assetId: 'LA5zSofUOP0i_iQwi4B2dEbzHQseitcuORm4n',
@@ -163,6 +166,7 @@ test.each([
 test.each([
   'https://cdn.sanity.io/files/espenhov/diary/ae0ef9f916843d32fef3faffb9a675d4cce046f0.pdf/oslo-guide.pdf',
   'https://cdn.sanity.staging/files/espenhov/diary/ae0ef9f916843d32fef3faffb9a675d4cce046f0.pdf/oslo-guide.pdf',
+  'https://cdn.autofoos.com/files/espenhov/diary/ae0ef9f916843d32fef3faffb9a675d4cce046f0.pdf/oslo-guide.pdf',
 ])(
   'parseAssetUrl(): returns object of named file properties on modern filename with vanity filename',
   (url) => {
@@ -180,6 +184,7 @@ test.each([
 test.each([
   'https://cdn.sanity.io/files/espenhov/diary/ae0ef9f916843d32fef3faffb9a675d4cce046f0.pdf',
   'https://cdn.sanity.staging/files/espenhov/diary/ae0ef9f916843d32fef3faffb9a675d4cce046f0.pdf',
+  'https://cdn.autofoos.com/files/espenhov/diary/ae0ef9f916843d32fef3faffb9a675d4cce046f0.pdf',
 ])('parseAssetUrl(): returns object of named file properties on modern filename', (url) => {
   expect(parseAssetUrl(url)).toMatchObject({
     assetId: 'ae0ef9f916843d32fef3faffb9a675d4cce046f0',
@@ -194,6 +199,7 @@ test.each([
 test.each([
   'https://cdn.sanity.io/files/espenhov/diary/LA5zSofUOP0i_iQwi4B2dEbzHQseitcuORm4n.pdf',
   'https://cdn.sanity.staging/files/espenhov/diary/LA5zSofUOP0i_iQwi4B2dEbzHQseitcuORm4n.pdf',
+  'https://cdn.autofoos.com/files/espenhov/diary/LA5zSofUOP0i_iQwi4B2dEbzHQseitcuORm4n.pdf',
 ])('parseAssetUrl(): returns object of named file properties on legacy filename', (url) => {
   expect(parseAssetUrl(url)).toMatchObject({
     assetId: 'LA5zSofUOP0i_iQwi4B2dEbzHQseitcuORm4n',
@@ -239,4 +245,4 @@ test('parseAssetUrl(): throws on invalid URLs', () => {
   ).toThrowErrorMatchingInlineSnapshot(
     `[Error: Invalid image/file asset filename: ae0e-f9f916843d-32fef3faffb9a-675d4cce046f0.pdf]`,
   )
-})
+})
diff --git a/test/resolve.test.ts b/test/resolve.test.ts
@@ -36,6 +36,8 @@ const imgPathPretty = `${imgPath}/pretty.png`
 const imgUrlPretty = `${imgUrl}/pretty.png`
 const stagingImgUrl = `https://cdn.sanity.staging/${imgPath}`
 const stagingImgUrlPretty = `${stagingImgUrl}/pretty.png`
+const customCdnImgUrl = `https://cdn.autofoos.com/${imgPath}`
+const customCdnImgUrlPretty = `${customCdnImgUrl}/pretty.png`
 const validImgSources: [string, SanityImageSource][] = [
   ['asset id', imgId],
   ['reference', {_ref: imgId}],
@@ -47,12 +49,14 @@ const validImgSources: [string, SanityImageSource][] = [
   ['object path stub', {asset: {path: imgPath}}],
   ['object url stub', {asset: {url: imgUrl}}],
   ['staging object url stub', {asset: {url: stagingImgUrl}}],
+  ['custom cdn object url stub', {asset: {url: customCdnImgUrl}}],
   ['path stub (pretty filename)', {path: imgPathPretty}],
   ['url stub (pretty filename)', {url: imgUrlPretty}],
   ['staging url stub (pretty filename)', {url: stagingImgUrlPretty}],
   ['object path stub (pretty filename)', {asset: {path: imgPathPretty}}],
   ['object url stub (pretty filename)', {asset: {url: imgUrlPretty}}],
   ['staging object url stub (pretty filename)', {asset: {url: stagingImgUrlPretty}}],
+  ['custom cdn object url stub (pretty filename)', {asset: {url: customCdnImgUrlPretty}}],
 ]
 
 const imgLegacyId = 'image-LA5zSofUOP0i_iQwi4B2dEbzHQseitcuORm4n-600x578-png'
@@ -62,6 +66,8 @@ const imgLegacyPathPretty = `${imgLegacyPath}/pretty.png`
 const imgLegacyUrlPretty = `${imgLegacyUrl}/pretty.png`
 const stagingImgLegacyUrl = `https://cdn.sanity.io/${imgLegacyPath}`
 const stagingImgLegacyUrlPretty = `${stagingImgLegacyUrl}/pretty.png`
+const customCdnImgLegacyUrl = `https://cdn.autofoos.com/${imgLegacyPath}`
+const customCdnImgLegacyUrlPretty = `${customCdnImgLegacyUrl}/pretty.png`
 const validLegacyImgSources: [string, SanityImageSource][] = [
   ['asset id', imgLegacyId],
   ['reference', {_ref: imgLegacyId}],
@@ -73,12 +79,14 @@ const validLegacyImgSources: [string, SanityImageSource][] = [
   ['object path stub', {asset: {path: imgLegacyPath}}],
   ['object url stub', {asset: {url: imgLegacyUrl}}],
   ['staging object url stub', {asset: {url: stagingImgLegacyUrl}}],
+  ['custom cdn object url stub', {asset: {url: customCdnImgLegacyUrl}}],
   ['path stub (pretty filename)', {path: imgLegacyPathPretty}],
   ['url stub (pretty filename)', {url: imgLegacyUrlPretty}],
   ['staging url stub (pretty filename)', {url: stagingImgLegacyUrlPretty}],
   ['object path stub (pretty filename)', {asset: {path: imgLegacyPathPretty}}],
   ['object url stub (pretty filename)', {asset: {url: imgLegacyUrlPretty}}],
   ['staging object url stub (pretty filename)', {asset: {url: stagingImgLegacyUrlPretty}}],
+  ['custom cdn object url stub (pretty filename)', {asset: {url: customCdnImgLegacyUrlPretty}}],
 ]
 
 const fileId = 'file-def987abc12345678909877654321abcdef98765-pdf'
@@ -88,6 +96,8 @@ const filePathPretty = `${filePath}/pretty.pdf`
 const fileUrlPretty = `${fileUrl}/pretty.pdf`
 const stagingFileUrl = `https://cdn.sanity.staging/${filePath}`
 const stagingFileUrlPretty = `${stagingFileUrl}/pretty.pdf`
+const customCdnFileUrl = `https://cdn.autofoos.com/${filePath}`
+const customCdnFileUrlPretty = `${customCdnFileUrl}/pretty.pdf`
 const validFileSources: [string, SanityFileSource][] = [
   ['asset id', fileId],
   ['reference', {_ref: fileId}],
@@ -99,12 +109,14 @@ const validFileSources: [string, SanityFileSource][] = [
   ['object path stub', {asset: {path: filePath}}],
   ['object url stub', {asset: {url: fileUrl}}],
   ['staging object url stub', {asset: {url: stagingFileUrl}}],
+  ['custom cdn object url stub', {asset: {url: customCdnFileUrl}}],
   ['path stub (pretty filename)', {path: filePathPretty}],
   ['url stub (pretty filename)', {url: fileUrlPretty}],
   ['staging url stub (pretty filename)', {url: stagingFileUrlPretty}],
   ['object path stub (pretty filename)', {asset: {path: filePathPretty}}],
   ['object url stub (pretty filename)', {asset: {url: fileUrlPretty}}],
   ['staging object url stub (pretty filename)', {asset: {url: stagingFileUrlPretty}}],
+  ['custom cdn object url stub (pretty filename)', {asset: {url: customCdnFileUrlPretty}}],
 ]
 
 // buildImagePath()