Merge pull request thoughtworks#318 from setchy/feature/doc-sheet-bac…

…kwards-compatibility feat: add backwards compatibility for sheetId
setchy · Jul 17, 2023 · 3e35804 · 3e35804
2 parents 28bc969 + 2b19a19
commit 3e35804
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 17 deletions.
diff --git a/spec/util/urlUtils-spec.js b/spec/util/urlUtils-spec.js
@@ -1,4 +1,4 @@
-const { constructSheetUrl } = require('../../src/util/urlUtils')
+const { constructSheetUrl, getDocumentOrSheetId, getSheetName } = require('../../src/util/urlUtils')
 const config = require('../../src/config')
 const queryParams = require('../../src/util/queryParamProcessor')
 
@@ -32,4 +32,52 @@ describe('Url Utils', () => {
     expect(config).toHaveBeenCalledTimes(1)
     expect(queryParams).toHaveBeenCalledTimes(1)
   })
+
+  it('should prioritize documentId before legacy sheetId', () => {
+    queryParams.mockReturnValue({ documentId: 'documentId', sheetId: 'sheetId' })
+    delete window.location
+    window.location = Object.create(window)
+    window.location.href = 'https://thoughtworks.com/radar?documentId=documentId&sheetId=sheetId'
+    window.location.search = '?'
+
+    const id = getDocumentOrSheetId()
+
+    expect(id).toEqual('documentId')
+  })
+
+  it('supports documentId', () => {
+    queryParams.mockReturnValue({ documentId: 'documentId' })
+    delete window.location
+    window.location = Object.create(window)
+    window.location.href = 'https://thoughtworks.com/radar?documentId=documentId'
+    window.location.search = '?'
+
+    const id = getDocumentOrSheetId()
+
+    expect(id).toEqual('documentId')
+  })
+
+  it('supports sheetId', () => {
+    queryParams.mockReturnValue({ sheetId: 'sheetId' })
+    delete window.location
+    window.location = Object.create(window)
+    window.location.href = 'https://thoughtworks.com/radar?sheetId=sheetId'
+    window.location.search = '?'
+
+    const id = getDocumentOrSheetId()
+
+    expect(id).toEqual('sheetId')
+  })
+
+  it('supports sheetName', () => {
+    queryParams.mockReturnValue({ sheetName: 'sheetName' })
+    delete window.location
+    window.location = Object.create(window)
+    window.location.href = 'https://thoughtworks.com/radar?sheetName=sheetName'
+    window.location.search = '?'
+
+    const sheetName = getSheetName()
+
+    expect(sheetName).toEqual('sheetName')
+  })
 })
diff --git a/src/util/factory.js b/src/util/factory.js
@@ -13,7 +13,6 @@ const Quadrant = require('../models/quadrant')
 const Ring = require('../models/ring')
 const Blip = require('../models/blip')
 const GraphingRadar = require('../graphing/radar')
-const QueryParams = require('./queryParamProcessor')
 const MalformedDataError = require('../exceptions/malformedDataError')
 const SheetNotFoundError = require('../exceptions/sheetNotFoundError')
 const ContentValidator = require('./contentValidator')
@@ -22,6 +21,7 @@ const ExceptionMessages = require('./exceptionMessages')
 const GoogleAuth = require('./googleAuth')
 const config = require('../config')
 const featureToggles = config().featureToggles
+const { getDocumentOrSheetId, getSheetName } = require('./urlUtils')
 const { getGraphSize, graphConfig, isValidConfig } = require('../graphing/config')
 const InvalidConfigError = require('../exceptions/invalidConfigError')
 const InvalidContentError = require('../exceptions/invalidContentError')
@@ -317,20 +317,17 @@ const Factory = function () {
     })
 
     const domainName = DomainName(window.location.search.substring(1))
-    const queryString = featureToggles.UIRefresh2022
-      ? window.location.href.match(/documentId(.*)/)
-      : window.location.href.match(/sheetId(.*)/)
-    const queryParams = queryString ? QueryParams(queryString[0]) : {}
 
-    const paramId = featureToggles.UIRefresh2022 ? queryParams.documentId : queryParams.sheetId
+    const paramId = getDocumentOrSheetId()
     if (paramId && paramId.endsWith('.csv')) {
       sheet = CSVDocument(paramId)
       sheet.init().build()
     } else if (paramId && paramId.endsWith('.json')) {
       sheet = JSONFile(paramId)
       sheet.init().build()
     } else if (domainName && domainName.endsWith('google.com') && paramId) {
-      sheet = GoogleSheet(paramId, queryParams.sheetName)
+      const sheetName = getSheetName()
+      sheet = GoogleSheet(paramId, sheetName)
       sheet.init().build()
     } else {
       if (!featureToggles.UIRefresh2022) {
@@ -540,15 +537,8 @@ function plotUnauthorizedErrorMessage() {
 
   button.on('click', () => {
     let sheet
-    if (featureToggles.UIRefresh2022) {
-      const queryString = window.location.href.match(/documentId(.*)/)
-      const queryParams = queryString ? QueryParams(queryString[0]) : {}
-      sheet = GoogleSheet(queryParams.documentId, queryParams.sheetName)
-    } else {
-      const queryString = window.location.href.match(/sheetId(.*)/)
-      const queryParams = queryString ? QueryParams(queryString[0]) : {}
-      sheet = GoogleSheet(queryParams.sheetId, queryParams.sheetName)
-    }
+    sheet = GoogleSheet(getDocumentOrSheetId(), getSheetName())
+
     sheet.authenticate(true, false, () => {
       if (featureToggles.UIRefresh2022 && !sheet.error) {
         helperDescription.style('display', 'block')

diff --git a/src/util/urlUtils.js b/src/util/urlUtils.js
@@ -13,6 +13,18 @@ function constructSheetUrl(sheetName) {
   return sheetUrl
 }
 
+function getDocumentOrSheetId() {
+  const queryParams = QueryParams(window.location.search.substring(1))
+  return queryParams.documentId ?? queryParams.sheetId
+}
+
+function getSheetName() {
+  const queryParams = QueryParams(window.location.search.substring(1))
+  return queryParams.sheetName
+}
+
 module.exports = {
   constructSheetUrl,
+  getDocumentOrSheetId,
+  getSheetName,
 }