@playpilot/tpi 7.0.0-beta.4 → 7.0.0-beta.6

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@playpilot/tpi",
-	"version": "7.0.0-beta.4",
+	"version": "7.0.0-beta.6",
 	"type": "module",
 	"scripts": {
 		"dev": "vite dev",

package/src/lib/api/auth.ts

@@ -5,7 +5,7 @@ const cookieName = 'EncryptedToken'
 const urlParam = 'articleReplacementEditToken'
 const editorialParam = 'playpilot-editorial-mode'
 
-export async function authorize(href: string = window.location.href): Promise<boolean> {
+export async function authorize({ href, throwError }: { href?: string, throwError?: boolean } = { href: window.location.href, throwError: false }): Promise<boolean> {
   try {
     const apiToken = getApiToken()
     if (!apiToken) throw new Error('No token was provided')
@@ -26,10 +26,12 @@ export async function authorize(href: string = window.location.href): Promise<bo
     return true
   } catch(error: any) {
     console.error(error)
-    throw error
+    if (throwError) throw error
   } finally {
     removeAuthParamFromUrl()
   }
+
+  return false
 }
 
 export function getAuthToken(href: string = ''): string {

package/src/lib/injectionElements.ts

@@ -1,3 +1,5 @@
+import type { ConfigResponse } from './types/config'
+
 /**
  * Return a list of all valid text containing elements that may get injected into.
  * This excludes duplicates, empty elements, links, buttons, and header tags.
@@ -88,3 +90,11 @@ export function getLinkInjectionsParentElement(): HTMLElement {
 export function getPageText(elements: HTMLElement[]): string {
   return elements.map(element => element.innerText).join('\n\n')
 }
+
+export function getPageTextAndElements(config: ConfigResponse | null): { parentElement: HTMLElement, elements: HTMLElement[], pageText: string } {
+  const parentElement = getLinkInjectionsParentElement()
+  const elements = getLinkInjectionElements(parentElement, config?.exclude_elements_selector || '')
+  const pageText = getPageText(elements)
+
+  return { parentElement, elements, pageText }
+}

package/src/lib/url.ts

@@ -1,3 +1,5 @@
+import type { ConfigResponse } from './types/config'
+
 /**
  * Get the full path, including host and protocol, but excluding url params.
  * Removes any extra slashes that might be present. //path -> /path. This is because some sites accept both,
@@ -12,3 +14,8 @@ export function paramsToString(params: Record<string, any>): string {
   const filteredParams = Object.entries(params).filter(([_, value]) => value !== undefined && value !== null && value !== '')
   return filteredParams.map(([key, value]) => `${key}=${value}`).join('&')
 }
+
+export function isUrlExcludedViaConfig(config: ConfigResponse): boolean {
+  console.log(getFullUrlPath())
+  return !!(config.exclude_urls_pattern && getFullUrlPath().match(new RegExp(config.exclude_urls_pattern)))
+}

package/src/main.ts

@@ -2,7 +2,8 @@ import { fetchConfig } from '$lib/api/config'
 import { pollLinkInjections } from '$lib/api/externalPages'
 import { setConsent } from '$lib/consent'
 import { isCrawler } from '$lib/crawler'
-import { getLinkInjectionElements, getLinkInjectionsParentElement, getPageText } from '$lib/injectionElements'
+import { getPageTextAndElements } from '$lib/injectionElements'
+import { isUrlExcludedViaConfig } from '$lib/url'
 
 window.PlayPilotLinkInjections = {
   token: '',
@@ -62,11 +63,12 @@ window.PlayPilotLinkInjections = {
 
     this.config = await fetchConfig() || {}
 
-    const parentElement = getLinkInjectionsParentElement()
-    const elements = getLinkInjectionElements(parentElement, this.config.exclude_elements_selector || '')
-    const pageText = getPageText(elements)
+    if (isUrlExcludedViaConfig(this.config)) return
+
+    const { pageText } = getPageTextAndElements(this.config)
 
     this.initial_link_injections_promise = pollLinkInjections(pageText, { maxTries: 1, runAiWhenRelevant: !isCrawler() })
+
     this.mount()
   },
 

package/src/routes/+page.svelte

@@ -2,9 +2,9 @@
   import { onDestroy } from 'svelte'
   import { pollLinkInjections } from '$lib/api/externalPages'
   import { clearLinkInjections, injectLinksInDocument, separateLinkInjectionTypes } from '$lib/injection'
-  import { getLinkInjectionElements, getLinkInjectionsParentElement, getPageText } from '$lib/injectionElements'
+  import { getPageText, getPageTextAndElements } from '$lib/injectionElements'
   import { fireQueuedTrackingEvents, setTrackingSids, track } from '$lib/tracking'
-  import { getFullUrlPath } from '$lib/url'
+  import { isUrlExcludedViaConfig } from '$lib/url'
   import { isCrawler } from '$lib/crawler'
   import { TrackingEvent } from '$lib/enums/TrackingEvent'
   import { fetchAds } from '$lib/api/ads'
@@ -21,7 +21,6 @@
   import UserJourney from './components/UserJourney.svelte'
   import PostersScrollReveal from './components/PostersScrollReveal.svelte'
 
-  let parentElement: HTMLElement | null = $state(null)
   let elements: HTMLElement[] = $state([])
 
   let response: LinkInjectionResponse | null = $state(null)
@@ -67,23 +66,24 @@
     loading = true
 
     try {
-      if (isEditorialMode) authorized = await authorize()
+      if (isEditorialMode) authorized = await authorize({ throwError: true })
     } catch {
       track(TrackingEvent.AuthFailed)
     }
 
     try {
-      const url = getFullUrlPath()
-
-      const config = window.PlayPilotLinkInjections.config || await fetchConfig()
+      const config = window.PlayPilotLinkInjections.config || await fetchConfig() || {}
+      window.PlayPilotLinkInjections.config = config
 
       if (config?.custom_style) insertCustomStyle(config.custom_style || '')
       if (config?.explore_navigation_selector) insertExploreIntoNavigation()
 
-      isUrlExcluded = !!(config?.exclude_urls_pattern && url.match(new RegExp(config.exclude_urls_pattern)))
+      isUrlExcluded = isUrlExcludedViaConfig(config)
       if (isUrlExcluded) return
 
-      setElements(config?.html_selector || '', config?.exclude_elements_selector || '')
+      if (config?.html_selector) window.PlayPilotLinkInjections.selector = config?.html_selector
+
+      elements = getPageTextAndElements(window.PlayPilotLinkInjections.config).elements
     } catch(error) {
       // We return if the config did not get fetched properly, as we can't determine what should and should
       // get injected without it.
@@ -146,16 +146,6 @@
     if (!isEditorialMode) trackInjections(filteredInjections)
   }
 
-  // Set elements to be used by script, if a selector is passed from the config request we update
-  // the selector on the window object.
-  // Additionally, a selector can be passed to exclude certain elements.
-  function setElements(configSelector: string, configExcludeElementsSelector: string): void {
-    if (configSelector) window.PlayPilotLinkInjections.selector = configSelector
-
-    parentElement = getLinkInjectionsParentElement()
-    elements = getLinkInjectionElements(parentElement, configExcludeElementsSelector)
-  }
-
   function openEditorialMode(): void {
     isEditorialMode = true
     setEditorialParamInUrl()

package/src/tests/lib/afterArticle.test.js

@@ -1,7 +1,8 @@
 import { beforeEach, describe, expect, it, vi } from 'vitest'
 
 import { generateInjection } from '../helpers'
-import { clearLinkInjections, getLinkInjectionElements } from '$lib/injection'
+import { clearLinkInjections } from '$lib/injection'
+import { getLinkInjectionElements } from '$lib/injectionElements'
 import { insertAfterArticlePlaylinks } from '$lib/afterArticle'
 import { mount } from 'svelte'
 

package/src/tests/lib/api/auth.test.js

@@ -1,7 +1,6 @@
 import { describe, it, expect, vi, beforeEach } from 'vitest'
 
 import { authorize, getAuthToken, isEditorialModeEnabled, removeAuthCookie, removeAuthParamFromUrl, setEditorialParamInUrl } from '$lib/api/auth'
-import { track } from '$lib/tracking'
 import { api } from '$lib/api/api'
 
 vi.mock('$lib/tracking', () => ({
@@ -19,7 +18,7 @@ describe('$lib/api/auth', () => {
 
   describe('authorize', () => {
     it('Should authorize correctly with url token', async () => {
-      const authorized = await authorize('https://example.com/some-path?articleReplacementEditToken=some-token')
+      const authorized = await authorize({ href: 'https://example.com/some-path?articleReplacementEditToken=some-token' })
 
       expect(authorized).toBeTruthy()
     })
@@ -27,40 +26,45 @@ describe('$lib/api/auth', () => {
     it('Should authorize correctly with editorial token', async () => {
       // @ts-ignore
       window.PlayPilotLinkInjections = { token: 'some-api-token', editorial_token: 'some-token' }
-      const authorized = await authorize('https://example.com/some-path')
+      const authorized = await authorize({ href: 'https://example.com/some-path' })
 
       expect(authorized).toBeTruthy()
     })
 
     it('Should not authorize if required url param is not present', async () => {
-      const authorized = await authorize('https://example.com/some-path')
+      const authorized = await authorize({ href: 'https://example.com/some-path' })
 
       expect(api).not.toHaveBeenCalled()
       expect(authorized).not.toBeTruthy()
     })
 
     it('Should authorize with cookie if previously authorized with url param', async () => {
-      let authorized = await authorize('https://example.com/some-path?articleReplacementEditToken=some-token')
+      let authorized = await authorize({ href: 'https://example.com/some-path?articleReplacementEditToken=some-token' })
       expect(authorized).toBeTruthy()
 
-      authorized = await authorize('https://example.com/some-path')
+      authorized = await authorize({ href: 'https://example.com/some-path' })
       expect(authorized).toBeTruthy()
     })
 
     it('Should authorize with cookie if previously authorized with url param and no url is given', async () => {
-      let authorized = await authorize('https://example.com/some-path?articleReplacementEditToken=some-token')
+      let authorized = await authorize({ href: 'https://example.com/some-path?articleReplacementEditToken=some-token' })
       expect(authorized).toBeTruthy()
 
       authorized = await authorize()
       expect(authorized).toBeTruthy()
     })
 
-    it('Should not authorize is api response was negative', async () => {
+    it('Should not authorize if api response was negative', async () => {
       vi.mocked(api).mockRejectedValueOnce({ response: '', ok: false, status: 403 })
-      const authorized = await authorize('https://example.com/some-path?articleReplacementEditToken=some-token')
+      const authorized = await authorize({ href: 'https://example.com/some-path?articleReplacementEditToken=some-token' })
 
       expect(authorized).not.toBeTruthy()
-      expect(track).toHaveBeenCalled()
+    })
+
+    it('Should throw error if api response was negative and throwError is true', async () => {
+      vi.mocked(api).mockRejectedValueOnce({ response: '', ok: false, status: 403 })
+
+      expect(async () => await authorize({ href: 'https://example.com/some-path?articleReplacementEditToken=some-token', throwError: true })).rejects.toThrowError()
     })
   })
 

package/src/tests/lib/disclaimer.test.js

@@ -1,6 +1,7 @@
 import { beforeEach, describe, expect, it, vi } from 'vitest'
 
-import { clearLinkInjections, getLinkInjectionElements } from '$lib/injection'
+import { clearLinkInjections } from '$lib/injection'
+import { getLinkInjectionElements } from '$lib/injectionElements'
 import { mount } from 'svelte'
 import { insertInTextDisclaimer } from '$lib/disclaimer'
 

package/src/tests/lib/url.test.js

@@ -1,6 +1,5 @@
 import { describe, it, expect, beforeEach, afterEach } from 'vitest'
-import { getFullUrlPath, paramsToString } from '$lib/url'
-
+import { getFullUrlPath, isUrlExcludedViaConfig, paramsToString } from '$lib/url'
 
 describe('url.ts', () => {
   describe('getFullUrlPath', () => {
@@ -75,4 +74,27 @@ describe('url.ts', () => {
       expect(paramsToString({ some: 'param', no: '' })).toBe('some=param')
     })
   })
+
+  describe('isUrlExcludedViaConfig', () => {
+    it('Should return false if no key is given in config object', () => {
+      expect(isUrlExcludedViaConfig({})).toBe(false)
+    })
+
+    it('Should return false if no key is given but is empty', () => {
+      expect(isUrlExcludedViaConfig({ exclude_urls_pattern: '' })).toBe(false)
+    })
+
+    it('Should return false if pattern is given but does not match url', () => {
+      window.location.pathname = '/path'
+      expect(isUrlExcludedViaConfig({ exclude_urls_pattern: '/not-path' })).toBe(false)
+    })
+
+    it('Should return true if pattern is given and does matches url', () => {
+      window.location.pathname = '/path'
+      expect(isUrlExcludedViaConfig({ exclude_urls_pattern: '/path' })).toBe(true)
+
+      window.location.pathname = '/some-page/subpath'
+      expect(isUrlExcludedViaConfig({ exclude_urls_pattern: '/some-page(/.*)?$' })).toBe(true)
+    })
+  })
 })

package/src/tests/routes/+page.test.js

@@ -60,9 +60,13 @@ vi.mock('$lib/crawler', () => ({
   isCrawler: vi.fn(() => false),
 }))
 
-vi.mock('$lib/url', () => ({
-  getFullUrlPath: vi.fn(),
-}))
+vi.mock(import('$lib/url'), async (importOriginal) => {
+  const actual = await importOriginal()
+  return {
+    ...actual,
+    getFullUrlPath: vi.fn(),
+  }
+})
 
 vi.mock('$lib/splitTest', () => ({
   trackSplitTestView: vi.fn(),
@@ -93,11 +97,11 @@ describe('$routes/+page.svelte', () => {
   afterEach(() => {
     Object.defineProperty(window, 'location', {
       writable: true,
-      value: { search: '', href: 'http://localhost:3000/' },
+      value: { search: '', href: 'http://localhost:3000/', pathname: '/test' },
     })
 
     // @ts-ignore
-    window.PlayPiloLinkInjections = null
+    window.PlayPiloLinkInjections = {}
   })
 
   it('Should call pollLinkInjections and fetchConfig on mount', async () => {