@financial-times/dotcom-server-app-context 7.3.0 → 7.3.2

package/package.json

@@ -1,18 +1,17 @@
 {
   "name": "@financial-times/dotcom-server-app-context",
-  "version": "7.3.0",
+  "version": "7.3.2",
   "description": "",
   "main": "dist/node/index.js",
   "types": "src/index.ts",
   "scripts": {
     "generate-schema": "node scripts/schemaToMarkdown.js > schema.md",
     "test": "echo \"Error: no test specified\" && exit 1",
-    "tsc": "../../node_modules/.bin/tsc --incremental",
     "clean": "npm run clean:dist && npm run clean:node_modules",
     "clean:dist": "rm -rf dist",
     "clean:node_modules": "rm -rf node_modules",
+    "build:node": "tsc",
     "build": "npm run build:node",
-    "build:node": "npm run tsc -- --module commonjs --outDir ./dist/node",
     "dev": "npm run build:node -- --watch",
     "preinstall": "[ \"$INIT_CWD\" != \"$PWD\" ] || npm_config_yes=true npx check-engine"
   },
@@ -30,6 +29,10 @@
     "node": ">= 14.0.0",
     "npm": "7.x || 8.x"
   },
+  "files": [
+    "dist/",
+    "src/"
+  ],
   "repository": {
     "type": "git",
     "repository": "https://github.com/Financial-Times/dotcom-page-kit.git",
@@ -39,4 +42,4 @@
   "volta": {
     "extends": "../../package.json"
   }
-}
+}

package/src/__test__/AppContext.spec.ts

@@ -0,0 +1,75 @@
+import { AppContext } from '../AppContext'
+import * as fixtures from './__fixtures__/contextData'
+
+describe('dotcom-server-app-context/src/AppContext', () => {
+  describe('constructor', () => {
+    let instance
+
+    beforeAll(() => {
+      instance = new AppContext({ appContext: fixtures.validAppContext })
+    })
+
+    it('sets the given app context data', () => {
+      expect(instance.data).toEqual(fixtures.validAppContext)
+    })
+
+    describe('invalid data', () => {
+      it('throws if any app context data is invalid', () => {
+        const init = () =>
+          new AppContext({
+            appContext: fixtures.invalidAppContext as any
+          })
+
+        expect(init).toThrow()
+      })
+    })
+  })
+
+  describe('.get()', () => {
+    let instance
+
+    beforeEach(() => {
+      instance = new AppContext({ appContext: fixtures.validAppContext })
+    })
+
+    it('returns the value of the requested app context property', () => {
+      const result = instance.get('appVersion')
+      expect(result).toBe(fixtures.validAppContext.appVersion)
+    })
+  })
+
+  describe('.set()', () => {
+    let instance
+
+    beforeEach(() => {
+      instance = new AppContext()
+    })
+
+    it('sets the value of the specified property', () => {
+      instance.set('appVersion', 'v12')
+      expect(instance.data.appVersion).toBe('v12')
+    })
+
+    it('throws if the given value is invalid', () => {
+      expect(() => instance.set('conceptId', 123)).toThrow()
+    })
+  })
+
+  describe('.getAll()', () => {
+    let instance
+
+    beforeEach(() => {
+      instance = new AppContext({ appContext: fixtures.validAppContext })
+    })
+
+    it('returns a clone of the app context data', () => {
+      const result = instance.getAll()
+      expect(result).not.toBe(instance.data)
+    })
+
+    it('freezes the app context data clone', () => {
+      const result = instance.getAll()
+      expect(Object.isFrozen(result)).toBe(true)
+    })
+  })
+})

package/src/__test__/__fixtures__/contextData.ts

@@ -0,0 +1,18 @@
+export const validAppContext = Object.freeze({
+  appName: 'article',
+  appVersion: '882797258625531f20d604f6441ef8cfcb2d772b',
+  edition: 'uk',
+  product: 'next',
+  abTestState: 'subscriberCohort:on,premiumCohort:on,topicTracker_UIDemo:100-percent',
+  contentId: 'c5935758-7730-11e9-bbad-7c18c0ea0201',
+  contentType: 'article',
+  conceptId: 'c5935738-7730-11e9-bbad-7c18c0ea8201',
+  conceptType: 'http://www.ft.com/ontology/Location',
+  isProduction: true,
+  publishReference: 'tid_17wmwszvk3'
+})
+
+export const invalidAppContext = {
+  ...validAppContext,
+  isProduction: 'yes'
+}

package/src/__test__/filterEmptyData.spec.ts

@@ -0,0 +1,32 @@
+import subject from '../filterEmptyData'
+
+const fixture = Object.freeze({
+  appName: 'article',
+  abTest: ' ',
+  appVersion: null,
+  isProduction: false
+})
+
+describe('dotcom-server-app-context/src/filterEmptyData', () => {
+  it('returns a new object', () => {
+    const result = subject(fixture)
+    expect(result).not.toBe(fixture)
+  })
+
+  it('removes null values', () => {
+    const result = subject(fixture)
+    expect(result).not.toHaveProperty('appVersion')
+  })
+
+  it('removes empty string values', () => {
+    const result = subject(fixture)
+    expect(result).not.toHaveProperty('abTest')
+  })
+
+  it('copies all defined values', () => {
+    const result = subject(fixture)
+
+    expect(result).toHaveProperty('appName', 'article')
+    expect(result).toHaveProperty('isProduction', false)
+  })
+})

package/src/__test__/validate.spec.ts

@@ -0,0 +1,20 @@
+import subject from '../validate'
+
+describe('dotcom-server-app-context/src/validate', () => {
+  it('returns true when given a valid property/value', () => {
+    expect(subject('isProduction', true)).toBe(true)
+  })
+
+  it('throws an error when given an invalid property/value', () => {
+    expect(() => subject('isProduction', 'yes')).toThrow(
+      'Validation error: data.isProduction should be boolean'
+    )
+  })
+
+  it('throws an error when given an unknown property/value', () => {
+    expect(() => subject('thisProperty', 'isNotInTheSchema')).toThrow(
+      'Validation error: data should NOT have additional properties, received "isNotInTheSchema"' +
+        '\nIf you want to share application specific data with the client, consider using @financial-times/dotcom-ui-data-embed.'
+    )
+  })
+})

package/schema.md

@@ -1,97 +0,0 @@
-# FT App Context Schema
-
-The schema defines the following properties:
-
-## `abTestState` (string)
-
-The A/B test flags data as a comma delimited string
-
-Additional restrictions:
-
-* Regex pattern: `^,*([0-9A-Za-z-_]+:[0-9A-Za-z-_]+,*)+$`
-
-## `appName` (string)
-
-The name of the application
-
-Additional restrictions:
-
-* Regex pattern: `^.+$`
-
-## `appVersion` (string)
-
-The running version of the app (usually a Git commit hash)
-
-Additional restrictions:
-
-* Regex pattern: `^.+$`
-
-## `conceptId` (string)
-
-The UUID of the concept on the current page
-
-Additional restrictions:
-
-* Regex pattern: `^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$`
-
-## `conceptType` (string)
-
-The type of concept on the current page
-
-Additional restrictions:
-
-* Regex pattern: `^http://www.ft.com/ontology/.+$`
-
-## `contentId` (string)
-
-The UUID of the content on the current page
-
-Additional restrictions:
-
-* Regex pattern: `^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$`
-
-## `contentType` (string)
-
-The type or sub-type of the content on the current page
-
-Additional restrictions:
-
-* Regex pattern: `^(article|video|audio|podcast|package|live-blog)$`
-
-## `edition` (string)
-
-The selected FT edition
-
-Additional restrictions:
-
-* Regex pattern: `^(uk|international)$`
-
-## `isProduction` (boolean)
-
-If the app is currently running in a production environment
-
-Default: `false`
-
-## `isUserLoggedIn` (boolean)
-
-If the visitor is signed in to an FT account
-
-Default: `false`
-
-## `product` (string)
-
-The product name
-
-Default: `"next"`
-
-Additional restrictions:
-
-* Regex pattern: `^.+$`
-
-## `publishReference` (string)
-
-The publish reference of the content on the current page
-
-Additional restrictions:
-
-* Regex pattern: `^.+$`

package/scripts/schemaToMarkdown.js

@@ -1,4 +0,0 @@
-const parse = require('json-schema-to-markdown')
-const schema = require('../src/schema.json')
-
-console.log(parse(schema)) // eslint-disable-line no-console