@quintype/framework 7.19.11 → 7.19.12-brightcove.0

package/foo

@@ -0,0 +1,430 @@
+
+> @quintype/framework@7.19.11 test
+> NODE_ENV=test npx mocha --recursive --require ./test/babel
+
+
+  1) Uncaught error outside test suite
+
+  0 passing (16ms)
+  1 failing
+
+  1) Uncaught error outside test suite:
+     Uncaught Error: listen EADDRINUSE: address already in use :::4000
+      at Server.setupListenHandle [as _listen2] (node:net:1330:16)
+      at listenInCluster (node:net:1378:12)
+      at Server.listen (node:net:1465:7)
+      at Function.listen (node_modules/express/lib/application.js:635:24)
+      at Suite.<anonymous> (test/integration/isomorphic-handler-test.js:263:30)
+      at Suite.<anonymous> (test/integration/isomorphic-handler-test.js:261:3)
+      at Object.<anonymous> (test/integration/isomorphic-handler-test.js:53:1)
+      at Module._compile (node:internal/modules/cjs/loader:1103:14)
+      at loader (node_modules/babel-register/lib/node.js:144:5)
+      at Object.require.extensions.<computed> [as .js] (node_modules/babel-register/lib/node.js:154:7)
+      at Module.load (node:internal/modules/cjs/loader:981:32)
+      at Function.Module._load (node:internal/modules/cjs/loader:822:12)
+      at ModuleWrap.<anonymous> (node:internal/modules/esm/translators:168:29)
+      at ModuleJob.run (node:internal/modules/esm/module_job:197:25)
+      at async Promise.all (index 0)
+      at ESMLoader.import (node:internal/modules/esm/loader:337:24)
+      at importModuleDynamicallyWrapper (node:internal/vm/module:437:15)
+
+
+
+
+
+  ampStoryPageHandler integration tests
+    ✔ mounts an amp story page (78ms)
+    ✔ passes on errors to express error handler
+    ✔ should redirect to non-amp page if enableAmp is false
+    ✔ Redirects the urls with status code to 302 if redirectUrls is present 
+    ✔ should redirect to non-amp page if story contains unsuported elements and invalid-elements-strategy in /api/v1/amp/config is set to redirect-to-web-version
+    ✔ should show amp page if story contains unsuported elements but invalid-elements-strategy in /api/v1/amp/config is set to any value other than redirect-to-web-version
+
+  Amp infinite scroll handler
+    ✔ Should return a 200 if request is same origin
+    ✔ Should return a 200 if origin is google/bing CDN
+    ✔ Should return a 200 if origin is subdomain
+    ✔ Should return a 200 if origin is CDN of subdomain
+    ✔ Should return a 401 if not same origin or origin is not in whitelist
+    ✔ returns infinite scroll json config from story 5 onwards
+    ✔ removes current story from infinite scroll json config
+
+  AssetLink Handler
+    ✔ returns a manifest
+
+  configWrapper
+    ✔ if passed extends the existing config with it being asynchronous in nature
+
+  configWrapper
+    ✔ if passed extends the existing config with it being synchronous in nature
+
+  configWrapper
+    ✔ if not passed returns the existing config
+
+  createApp
+    ✔ correctly gzips content
+    ✔ returns static files
+    ✔ static files that are assets have a long cache header
+
+  proxyGetHandler
+    ✔ can proxy a request to a handler which returs some data
+    ✔ returns a 503 if there is no data
+    proxying to another host
+      ✔ forwards the call upstream
+
+  Custom Route Handler
+    ✔ Redirects with status code 301 if API has 301 redirection setup
+    ✔ Redirects with status code 302 if API has 302 redirection setup
+    ✔ Renders the page in the normal flow if it's a static page and either header or footer is enabled
+    ✔ Renders the page by sending the content if it's a static page with disabled header and footer
+    ✔ Returns 404 if the route doesn't exist
+    ✔ DisableIsomorphicComponent is set to true
+    ✔ Store reads config and data from data-loader response
+    ✔ Redirects to an absolute route, even if sketches gives a junk response
+    ✔ Adds content type as per metadata in response
+    ✔ Adds content type default if metadata in response is not set
+
+  Isomorphic Data Load
+    ✔ returns data given by the load data function
+    ✔ passes url parameters to the load data function
+    ✔ loads data for the homepage if no path is passed in
+    ✔ returns an appVersion on every response
+    ✔ return the title of the page
+    ✔ passes any params to the loadData function
+    ✔ passes back caching headers
+    aborting the data loader
+      ✔ returns a 200 with a not-found if the load data decides to abort
+      ✔ returns a 200 with a not-found if the load data decides to abort
+    status codes
+      ✔ any status code more than 500 becomes an http 500
+      ✔ any status code less than 500 becomes an http 200
+    Multi Domain Support
+      ✔ passes the domain slug to the load data function, and returns currentHostUrl in response
+      ✔ passes undefined if domain mapping is not present, and returns currentHostUrl in response
+      ✔ passes null if the domain is the default domain (or not present in the map), and returns currentHostUrl in response
+      ✔ passes the domainSlug to generateSlug
+      ✔ strips the mount point
+    failure scenarios
+      ✔ returns 404 if the path is not matched
+      ✔ returns 404 if generate routes throws an exception
+      ✔ return 500 if loadData and loadErrorData both throw exceptions
+      ✔ loads error data if loadData throws an exceptions
+      ✔ has a default loadErrorData
+    Mobile Data
+      ✔ loads only config needed for mobile when mobileApiEnabled flag and the mobileConfigFields is passed
+      ✔ loads all the config fields if the list of mobile config fields is empty
+      ✔ third level of data remain as original
+      ✔ loads only data listed in the whitelisted keys
+      ✔ does not filter data if no whitelist is passed
+
+  Isomorphic Handler
+    ✔ Renders the page if the route matches
+    ✔ Accepts an async pickComponent function
+    ✔ Passes all URL parameters to the load data function
+    ✔ Throws a 404 if the route is not matched
+    ✔ Throws a 500 if loadData doesn't work
+    ✔ Throws a 500 if loadData and loadErrorData both crash
+    ✔ Cache headers are set
+    ✔ it redirects on a 301
+    ✔ returns a 500 if render layout crashes
+    ✔ Passes the primaryHostUrl and currentHostUrl to the render
+    preloading
+      ✔ preloads the app.js
+    Prerender server
+      ✔ Should run prerender servre if i pass any other server top of it
+    aborting the data loader
+      ✔ Throws a 404 if load data decides not to handle the request
+      ✔ Allows bypassing even data.abort is set
+      ✔ Allows you to chain one loader to the next if two routes overlap
+    lightPages
+      ✔ renders amp story pages
+      ✔ renders amp story pages when lightPages is passed as a function which return true
+      ✔ renders a normal story page when lightPages is passed as a function which return false
+      ✔ renders amp story pages using non-encode slug when lightPages is passed as a function which return true and shouldEncodeAmpUri is false
+    cdnProvider
+      ✔ Returns the right cloudflare headers for cache keys passed and no cdn provider passed
+      ✔ Returns the right cloudflare headers for no cacheKeys and no cdnProvider passed
+      ✔ Returns the right headers when there is cachekeys is set to DO_NOT_CACHE
+      ✔ Returns the right akamai headers when cachekeys are not passed
+      ✔ Returns the right akamai headers when right cachekeys are passed
+      ✔ Returns the right cache headers when cdnProvider is of type function
+      ✔ Override the s-maxage cache headers when sMaxAge value present
+      ✔ Fallback the value of s-maxage to 900 second if when sMaxAge value not present
+    redirectToLowercaseSlugs
+      ✔ when enabled, redirects story slug with capital letters to lowercase slug URL
+      ✔ when enabled, it does not redirect for story slugs containing accents or non-latin letters
+      ✔ when enabled, it does not redirect for section pages containing capital letters
+      ✔ when not enabled, story slug with capital letters gives a normal response
+    mountAt
+      ✔ Gets Pages Mounted at Some Path
+      ✔ returns 404 for pages outside the mount at
+      ✔ Gets Pages Mounted at Some Path
+      ✔ doesn't apply the mountpoint if the function returns undefined
+
+  ManifestHandler
+    ✔ returns a manifest
+
+  ServiceWorker Generator
+    ✔ generates the service worker correctly
+    ✔ skips only includes PWA routes in the route
+    ✔ generates the one signal handler
+
+  ShellHandler
+    ✔ returns the shell if the prechaching matches
+    ✔ returns a 503 if the precache doesn't match
+    ✔ returns the shell if there is no precaching
+    ✔ sets a header for preloading script
+
+  Sketches Proxy
+    forwarding requests
+      ✔ forwards requests to sketches
+      ✔ forwards custom routes to sketches
+      ✔ grabs the hostname from the client
+      ✔ does not forward unknown requests
+      ✔ forwards amp requests
+      ✔ gets favicon
+      ✔ allows mounting at a different path
+    Override the s-maxage cache header
+      ✔ Override the s-maxage cache header when sMaxAge value is present (463ms)
+      ✔ Does not override the s-maxage cache header if cacheability is Private
+      ✔ Does not override the s-maxage cache header for Breaking News (395ms)
+      ✔ if sMaxAge value is not present, do not override cache headers (48ms)
+    sitemap requests
+      ✔ forwards requests to test new_sitemap/today.xml should not throw error if isSitemapUrlEnabled is enabled
+      ✔ forwards requests to test news_sitemap.xml should not throw error if isSitemapUrlEnabled is disabled
+    ping check
+      ✔ returns a successful ping if the config is loaded
+      ✔ fails with a 503 if the config fails
+      ✔ responds with a ping even if it's mounted somewhere
+
+  Static Routes
+    route-data.json
+      ✔ Loads the data for the static route
+      ✔ defaults the pageType to static-page
+      ✔ disableIsomorphicComponent is always set to true
+    isomorphic handler
+      ✔ It renders a static page
+      ✔ defaults the pagetype to static page
+      ✔ can also set disableIsomorphicComponent to false
+
+  Redirect Handler
+    ✔ Redirects to a story on the root level
+    ✔ Redirects to a story on the root level even if there is a trailing /
+    ✔ Does not redirect if story is not found
+
+  TemplateOptionsHandler
+    ✔ returns the template options
+    ✔ does template options when passed in a function
+
+  Redirect Routes Handler
+    ✔ Redirects all the urls with status code to 301 if redirectUrls is present
+    ✔ Redirects all the urls with status code to 302 if redirectUrls is present
+    ✔ Renders homepage when redirect urls are present
+    ✔ Redirects all the urls with status code to 301 if redirectUrls function is present
+    ✔ Should handle Route Parameters redirects properly
+    ✔ Should handle multiple Route Parameters redirects properly
+    ✔ Should handle interchanging route parameter redirects properly
+    ✔ Should handle external redirects
+    ✔ Should handle external redirects with params
+    ✔ Should not crash if redirectUrls is not present
+    ✔ Returns 404 if the route doesn't exist
+
+  getDomainSpecificOpts helper function
+    ✔ Should return correct opts for subdomain
+    ✔ Should return correct opts for main domain
+
+  setCorsHeaders helper function
+    ✔ same-origin requests go through
+    ✔ sets CORS headers for requests coming from google CDN
+    ✔ sets CORS headers for requests coming from bing CDN
+    ✔ sets CORS headers for requests coming from a valid subdomain
+    ✔ sets a 401 on requests originating from an invalid subdomain
+    ✔ sets CORS headers for requests coming from a cached subdomain (Google)
+    ✔ sets CORS headers for requests coming from a cached subdomain (Bing)
+    ✔ sets a 401 on requests originating from a non-whitelisted source
+
+  ampStoryPageHandler unit tests
+    ✔ Should not mutate opts (102ms)
+    ✔ should not mutate req, res, client, config
+    ✔ should call the next middleware if story not found
+    ✔ should pass related stories to amplib if present
+    ✔ should not pass related stories to amplib if absent
+    ✔ should call seo function with pageType == 'story-page-amp' if passed from FE
+    ✔ should call getAdditionalConfig method if it's passed from FE; pass it on to amplib as additionalConfig
+    ✔ should call seo lib with appropriate timezone if timezone info is present in publisher config, pass it on to amplib
+    ✔ should call seo lib with null timezone if timezone info is absent in publisher config
+
+  getInitialInlineConfig method of InfiniteScrollAmp helper function
+    ✔ should throw err if storyId isn't passed
+    ✔ should return null if infinite scroll collection doesn't exist
+    ✔ should return null if infinite scroll collection contains no stories
+    ✔ should remove current story from infinite scroll
+    ✔ should remove visual stories from infinite scroll
+    ✔ should format JSON as per AMP spec
+    ✔ should throw err if storyId isn't passed for relatedStoriesApi
+    ✔ should return null if relatedStoriesApi infinite scroll collection doesn't exist
+    ✔ should return null if relatedStoriesApi infinite scroll collection contains no stories
+    ✔ should remove visual stories from relatedStoriesApi infinite scroll
+    ✔ relatedStoriesApi Response should be in JSON format as per AMP spec
+    ✔ should return null if CustomApi Stories infinite scroll collection doesn't exist
+    ✔ should return null if CustomApi Stories infinite scroll collection contains no stories
+    ✔ CustomApi Stories Response should be in JSON format as per AMP spec
+
+  getResponse method of InfiniteScrollAmp helper function
+    ✔ should throw an error in Collection if 'story-id' isn't passed as query param
+    ✔ should throw an error if Collection infinite scroll collection doesn't exist
+    ✔ should remove current story from Collection response
+    ✔ should remove visual stories from Collection response
+    ✔ should format Collection JSON as per AMP spec
+    ✔ should throw an error in relatedStoriesApi if 'story-id' isn't passed as query param
+    ✔ should throw an error if relatedStoriesApi scroll collection doesn't exist
+    ✔ should remove visual stories from relatedStoriesApi response
+    ✔ should format relatedStoriesApi JSON as per AMP spec
+    ✔ should throw an error if customApi infinite scroll collection doesn't exist
+    ✔ should format JSON as per AMP spec in customApi list
+
+  ApiClient
+    getClient
+      ✔ returns a cachedSecondaryClient if present
+      ✔ creates a temporary client if it matches a string
+      ✔ creates a temporary client if it matches a string with a .
+      ✔ creates a temporary client if host_to_api_host_is set
+      ✔ creates a wildcard temporary client if it matches a string
+      ✔ returns null if no client is found
+    Collection
+      ✔ should return collection as non-automated when automated key is not present in a collection
+      ✔ should return collection as non-automated when automated is false in a collection
+      ✔ should return collection as automated for an automated collection
+      ✔ should return all child collections at current level for a collection
+      ✔ should handle get child collections when items is missing in a collection
+      ✔ should return as leaf collection when it has no items and has no collection cache keys
+      ✔ should not be a leaf collection when collection has items or collection cache keys
+      ✔ should return empty array as cacheable child items when depth is less than or equal to zero for an automated collection
+      ✔ should return all child collections as cacheable child items when depth is undefined or greater than zero for an automated collection
+      ✔ should return only stories as cacheable child items when depth is less than or equal to zero for manual collection
+      ✔ should return all child items as cacheable child items when depth is undefined or greater than zero for an automated collection
+    caching
+      ✔ returns cache keys for the story
+      ✔ should return all stories and collection id as cache tags for a manual collection
+      ✔ should include all nested stories and collection ids as cache tags for a manual collection
+      ✔ should return only collection cache keys excluding story keys as cache keys for an automated collection
+      ✔ should include all nested collection cache keys excluding story keys as cache keys for automated collection
+      ✔ should return cache keys when an automated collection has a manual collection
+      ✔ should return cache keys when a manual collection has an automated collection under it
+      ✔ should include nested collection and stories cache tags only upto depth when depth is passed
+      ✔ should only include base collection cache keys and child items id as tags for an automated collection when depth is zero
+      ✔ should only include base collection cache keys, item ids at level zero for manual collection when depth is zero
+      ✔ should add all nested collection cache tags when depth is not passed
+      ✔ should add all nested collection cache tags even when leaf collection does not have much data
+      ✔ can also find the cache key for a sorter
+    Author
+      ✔ returns cache keys
+      ✔ returns cache keys as null if author is invalid
+    Custom urls
+      ✔ returns cache keys
+      ✔ returns cache keys as null if page is invalid
+
+  AssetHelper
+    assetPath
+      ✔ returns the asset path of known assets
+      ✔ returns nil for unknown assets
+      ✔ overwrites asset path
+    readAsset
+      ✔ can read assets from the disk
+      ✔ can read assets from the disk
+      ✔ returns undefined for any file that doesn't exist
+    get asset hash
+      ✔ returns null if the asset is not found
+      ✔ gets the asset hash for a particular asset
+      ✔ returns 1 if the asset has no hash
+    get all asset files
+      ✔ returns a set of all files
+    get files for a chunk
+      ✔ has a css-path and css-content
+      ✔ has js-paths with related dependencies
+      ✔ returns all the chunks
+      ✔ returns all the assets
+
+  assetify
+    ✔ returns the asset path
+
+  createQtStore
+    store
+      ✔ it can create a store with initial values
+      ✔ updates the store when a navigation event happens
+Service Worker Has Updated
+      ✔ gets updates when the service worker is updated
+      ✔ can accept custom reducers too
+
+  NotFoundException
+    ✔ has a status of 404
+
+  generateRoutes
+    ✔ generates section routes correctly
+    ✔ generates section routes correctly with section prefix
+    ✔ generates section with collection slug
+    ✔ generates extra sub section route when secWithoutParentPrefix is true
+    ✔ generates extra sub section route and with section prefix when both secWithoutParentPrefix and addSectionPrefix is true
+    ✔ generates story routes correctly
+    ✔ adds routes for subsections when withoutParentSection is set
+    ✔ does not go into infinite loop if sections are recursive
+    ✔ handles missing parents correctly
+
+  MultiDomain Support
+    ✔ generate routes given a domainSlug
+    ✔ generates routes for null domain
+    ✔ generates story page routes given a domain Slug
+
+  generateCommonRoutes
+    ✔ generates section and story page routes
+    ✔ respects the skipPWA parameter for home, story and section pages
+    ✔ picks up the collection slug if there is one present in the section
+    ✔ only picks the sections from the correct domain
+    ✔ puts section urls before the story urls
+    ✔ removes /section from the story route
+    ✔ generates things correctly if the section-url is missing
+    ✔ generates the home page route
+    ✔ removes the mount point from the section path
+
+  LoadServiceWorker
+    registerServiceWorker
+      ✔ registers a service worker
+      ✔ does not register a service worker if enableServiceWorker is false
+      ✔ does not register a service worker if serviceworker is not supported
+    updating ServiceWorker
+Updating the Service Worker
+Service Worker Has Updated
+      ✔ updates the service worker if the page's appVersion is more than the app's version
+      ✔ doesn't update the service worker if the page's app version and the main app version are the same
+Updating service worker due to config change
+Service Worker Has Updated
+      ✔ updates service worker if the config timestamp is greater than the global timestamp
+      ✔ does not update service worker if the config timestamp is lesser than the global timestamp
+      ✔ does nothing if the service worker promise is null
+      ✔ does nothing if the service worker promise resolves to null
+      ✔ does nothing if the service worker promise has no update
+Updating the Service Worker
+Service Worker Has Updated
+      ✔ updates if a later page has a higher version
+
+  Logger
+    ✔ It should log error while sending logger.error
+    ✔ It should not log error while sending logger.info
+
+  OneSignal
+    ✔ should not break if onesignal config is not availabe in publisher config
+    ✔ should not render onesignal script if is_enable is set to false
+    ✔ should render onesignal script if is_enabled
+
+  routes
+    matchBestRoute
+      ✔ matches the home page
+      ✔ matches subsection-page
+      ✔ matches story page
+      ✔ matches story page with extra date info
+      ✔ matches route params
+      ✔ returns undefined if there is no match
+      ✔ matches even if there is no /
+    matchAllRoutes
+      ✔ matches all routes in order
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quintype/framework",
-  "version": "7.19.11",
+  "version": "7.19.12-brightcove.0",
   "description": "Libraries to help build Quintype Node.js apps",
   "main": "index.js",
   "engines": {
@@ -31,7 +31,7 @@
   "homepage": "https://github.com/quintype/quintype-node-framework#readme",
   "dependencies": {
     "@ampproject/toolbox-optimizer": "2.8.3",
-    "@quintype/amp": "^2.15.2",
+    "@quintype/amp": "^2.15.3-brightcove.1",
     "@quintype/backend": "^2.3.3",
     "@quintype/components": "^3.3.0",
     "@quintype/prerender-node": "^3.2.26",