@lightningjs/blits 1.30.1 → 1.31.0

package/src/router/router.test.js

@@ -1,473 +0,0 @@
-/*
- * Copyright 2024 Comcast Cable Communications Management, LLC
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import test from 'tape'
-import { matchHash, getHash, to } from './router.js'
-
-const routes = [
-  {
-    path: '/',
-  },
-  {
-    path: '/page1',
-  },
-  {
-    path: '/page1/subpage1',
-  },
-  {
-    path: '/tv/:show/seasons/:season',
-  },
-  {
-    path: '/movies/special',
-  },
-  {
-    path: '/movies/:name',
-  },
-  {
-    path: '/examples/*',
-  },
-  {
-    path: '/route/with/trailing/slash/',
-  },
-  {
-    path: '/dutchmovies/:id',
-  },
-  {
-    path: '*',
-  },
-]
-
-test('Type of matchHash', (assert) => {
-  const expected = 'function'
-  const actual = typeof matchHash
-
-  assert.equal(actual, expected, 'matchhash should be a function')
-  assert.end()
-})
-
-test('Match paths with static routes that have an exact match', (assert) => {
-  assert.equal(matchHash('', routes), routes[0], 'Should return the correct route object')
-  assert.equal(matchHash('/', routes), routes[0], 'Should return the correct route object')
-  assert.equal(matchHash('/page1', routes), routes[1], 'Should return the correct route object')
-  assert.equal(
-    matchHash('/page1/subpage1', routes),
-    routes[2],
-    'Should return the correct route object'
-  )
-  assert.equal(
-    matchHash('/movies/special', routes),
-    routes[4],
-    'Should return the correct route object'
-  )
-  assert.end()
-})
-
-test('Match paths with dynamic route parts', (assert) => {
-  assert.equal(
-    matchHash('/tv/simpsons/seasons/first', routes),
-    routes[3],
-    'Should return the correct route object'
-  )
-
-  assert.equal(
-    matchHash('/tv/simpsons/season/first', routes),
-    routes[9],
-    'Should return the correct route object'
-  )
-
-  assert.equal(
-    matchHash('/examples/test/seasons/5', routes),
-    routes[6],
-    'Should return the correct route object'
-  )
-
-  assert.equal(
-    matchHash('/movies/avengers-endgame', routes),
-    routes[5],
-    'Should return the correct route object'
-  )
-
-  assert.equal(
-    matchHash('/movies/special-1', routes),
-    routes[5],
-    'Should return the correct route object'
-  )
-
-  assert.equal(
-    matchHash('/dutchmovies/123', routes),
-    routes[8],
-    'Should return the correct route object'
-  )
-
-  assert.end()
-})
-
-test('Match paths with a wildcard asterix', (assert) => {
-  assert.equal(
-    matchHash('/examples/example1', routes),
-    routes[6],
-    'Should return the correct route object'
-  )
-
-  assert.equal(
-    matchHash('/examples/example1/subexample/and-another-page', routes),
-    routes[6],
-    'Should return the correct route object'
-  )
-
-  assert.equal(matchHash('/404', routes), routes[9], 'Should return the correct route object')
-
-  assert.equal(
-    matchHash('/page1/non-existing-path', routes),
-    routes[9],
-    'Should return the correct route object'
-  )
-
-  assert.equal(
-    matchHash('/page1/subpage1/i-dont-exist', routes),
-    routes[9],
-    'Should return the correct route object'
-  )
-
-  assert.equal(
-    matchHash('/completely/unexpected/route', routes),
-    routes[9],
-    'Should return the correct route object'
-  )
-
-  assert.end()
-})
-
-test('Add params to route for dynamic route matches', (assert) => {
-  const match1 = matchHash('/tv/simpsons/seasons/first', routes)
-
-  assert.deepEqual(
-    match1.params,
-    {
-      show: 'simpsons',
-      season: 'first',
-    },
-    'Should return the correct params object'
-  )
-
-  const match2 = matchHash('/movies/avengers-endgame', routes)
-  assert.deepEqual(
-    match2.params,
-    {
-      name: 'avengers-endgame',
-    },
-    'Should return the correct route object'
-  )
-
-  const match3 = matchHash('/dutchmovies/1', routes)
-  assert.deepEqual(
-    match3.params,
-    {
-      id: '1',
-    },
-    'Should return the correct route object'
-  )
-
-  assert.end()
-})
-
-test('Add remaining path as param for wild card routes', (assert) => {
-  const match1 = matchHash('/examples/example1', routes)
-  assert.deepEqual(match1.params, { path: 'example1' }, 'Should return the correct route object')
-
-  const match2 = matchHash('/examples/example1/subexample/and-another-page', routes)
-  assert.deepEqual(
-    match2.params,
-    { path: 'example1/subexample/and-another-page' },
-    'Should return the correct params object'
-  )
-
-  const match3 = matchHash('/404', routes)
-  assert.deepEqual(match3.params, { path: '404' }, 'Should return the correct params object')
-
-  const match4 = matchHash('/page1/subpage1/i-dont-exist', routes)
-  assert.deepEqual(
-    match4.params,
-    { path: 'page1/subpage1/i-dont-exist' },
-    'Should return the correct params object'
-  )
-
-  assert.end()
-})
-
-test('Work with trailing slashes', (assert) => {
-  assert.equal(matchHash('/page1/', routes), routes[1], 'Should return the correct route object')
-  assert.equal(
-    matchHash('/page1//////', routes),
-    routes[1],
-    'Should return the correct route object'
-  )
-  assert.equal(
-    matchHash('/page1/subpage1/', routes),
-    routes[2],
-    'Should return the correct route object'
-  )
-
-  assert.equal(
-    matchHash('/route/with/trailing/slash', routes),
-    routes[7],
-    'Should return the correct route object'
-  )
-
-  assert.equal(
-    matchHash('/tv/simpsons/seasons/first', routes),
-    routes[3],
-    'Should return the correct route object'
-  )
-
-  assert.end()
-})
-
-test('Work with and without leading slashes', (assert) => {
-  assert.equal(matchHash('page1/', routes), routes[1], 'Should return the correct route object')
-
-  assert.equal(matchHash('////page1', routes), routes[1], 'Should return the correct route object')
-  assert.equal(
-    matchHash('page1/subpage1/', routes),
-    routes[2],
-    'Should return the correct route object'
-  )
-
-  assert.equal(
-    matchHash('route/with/trailing/slash', routes),
-    routes[7],
-    'Should return the correct route object'
-  )
-
-  assert.equal(
-    matchHash('//tv/simpsons/seasons/first//', routes),
-    routes[3],
-    'Should return the correct route object'
-  )
-
-  assert.end()
-})
-
-test('Match routes case insensitive', (assert) => {
-  assert.equal(matchHash('/', routes), routes[0], 'Should return the correct route object')
-  assert.equal(matchHash('/Page1', routes), routes[1], 'Should return the correct route object')
-  assert.equal(
-    matchHash('/pagE1/SUBpage1', routes),
-    routes[2],
-    'Should return the correct route object'
-  )
-  assert.equal(
-    matchHash('/Tv/SimpsonS/Seasons/First', routes),
-    routes[3],
-    'Should return the correct route object'
-  )
-
-  assert.equal(
-    matchHash('/Movies/Avengers-Endgame', routes),
-    routes[5],
-    'Should return the correct route object'
-  )
-  assert.end()
-})
-
-test('Match routes case insensitive, but pass props with original casing', (assert) => {
-  const match1 = matchHash('/Tv/SimpsonS/Seasons/First', routes)
-  assert.deepEqual(
-    match1.params,
-    {
-      show: 'SimpsonS',
-      season: 'First',
-    },
-    'Should return the correct params object'
-  )
-
-  const match2 = matchHash('/Movies/Avengers-Endgame', routes)
-  assert.deepEqual(
-    match2.params,
-    {
-      name: 'Avengers-Endgame',
-    },
-    'Should return the correct params object'
-  )
-
-  const match3 = matchHash('/DutchMovies/ID_123', routes)
-  assert.deepEqual(
-    match3.params,
-    {
-      id: 'ID_123',
-    },
-    'Should return the correct params object'
-  )
-
-  assert.end()
-})
-
-test('Match paths with dynamic route parts along with query string params', (assert) => {
-  const hash1 = '#/tv/simpsons/seasons/first?token=123&ln=en'
-  document.location.hash = hash1
-
-  const { hash, path, queryParams } = getHash()
-
-  assert.equal(hash, hash1, 'Should return correct hash')
-  assert.equal(path, '/tv/simpsons/seasons/first', 'Should return the correct route path')
-  assert.equal(matchHash(path, routes), routes[3], 'Should return the correct route object')
-  assert.equal(
-    queryParams.get('token'),
-    '123',
-    'Should contain the correct query parameter key with value'
-  )
-  assert.equal(
-    queryParams.get('ln'),
-    'en',
-    'Should contain the correct query parameter key with value'
-  )
-  assert.end()
-})
-
-test('Get the hash from the URL', (assert) => {
-  const hash = '#/movies/action/the-avengers'
-  document.location.hash = hash
-
-  const result = getHash()
-
-  assert.equal(
-    result.hash,
-    hash,
-    'The result object should contain a hash key with the correct location hash'
-  )
-
-  assert.equal(
-    result.path,
-    '/movies/action/the-avengers',
-    'The result object should contain a path key with the hash (stripped the # symbol)'
-  )
-
-  assert.end()
-})
-
-test('Get the hash from the URL and handle query params', (assert) => {
-  const hash = '#/movies/comedy/the-hangover?category=1&item=2'
-  document.location.hash = hash
-
-  const result = getHash()
-
-  assert.equal(
-    result.hash,
-    hash,
-    'The result object should contain a hash key with the correct location hash without the query params'
-  )
-
-  assert.equal(
-    result.path,
-    '/movies/comedy/the-hangover',
-    'The result object should contain a path key with the hash (stripped the # symbol)'
-  )
-
-  assert.equal(
-    result.queryParams instanceof URLSearchParams,
-    true,
-    'The result object should contain a queryParams key with an URLSearchParams object'
-  )
-
-  assert.equal(
-    result.queryParams.get('category'),
-    '1',
-    'The result object should contain a queryParams key with the correct route query param values'
-  )
-
-  assert.equal(
-    result.queryParams.get('item'),
-    '2',
-    'The result object should contain a queryParams key with the correct route query param values'
-  )
-
-  assert.end()
-})
-
-test('Get route object from Match hash when navigating using to() method', (assert) => {
-  const hash = '/page1/subpage1'
-
-  to(hash)
-
-  const result = matchHash(hash, routes)
-
-  assert.equal(
-    result.path,
-    'page1/subpage1',
-    'The result object should contain a path key with path hash'
-  )
-  assert.equal(
-    Object.keys(result.params).length,
-    0,
-    'The results object should contain a params key with zero props'
-  )
-  assert.equal(
-    Object.keys(result.data).length,
-    0,
-    'The results object should contain a data key with zero props'
-  )
-  assert.equal(
-    Object.keys(result.options).length,
-    0,
-    'The results object should contain a options key with zero props'
-  )
-  assert.end()
-})
-
-test('Get route object from Match hash when navigating using to() method with options', (assert) => {
-  const hash = '/page1/subpage1'
-
-  to(hash, undefined, { keepAlive: true })
-
-  const result = matchHash(hash, routes)
-
-  assert.equal(
-    result.path,
-    'page1/subpage1',
-    'The result object should contain a path key with path hash'
-  )
-
-  assert.equal(
-    result.options.keepAlive,
-    true,
-    'The results object should contain a options key with keep alive as True'
-  )
-
-  assert.end()
-})
-
-test('Get Hash from URL when navigating using to() method', (assert) => {
-  const hash = '#/movies/action/avengers'
-
-  to(hash)
-
-  const result = getHash()
-
-  assert.equal(
-    result.hash,
-    hash,
-    'The result object key property should contain correct location hash'
-  )
-
-  assert.equal(
-    result.path,
-    '/movies/action/avengers',
-    'The result object should contain a path key with hash without #'
-  )
-
-  assert.end()
-})