use toMinimalFormattedString for the localstore.json

BuZZ-T · Apr 24, 2022 · f32a994 · f32a994
1 parent 219a7da
commit f32a994
Show file tree

Hide file tree

Showing 9 changed files with 95 additions and 16 deletions.
diff --git a/import.int.spec.ts b/import.int.spec.ts
@@ -15,6 +15,7 @@ import { mocked } from 'ts-jest/utils'
 import { promisify } from 'util'
 
 import { rusted } from './rusted'
+import { Store } from './store/Store'
 import { mockNodeFetch, IMockAdditional, getJestTmpFolder } from './test/int.utils'
 import { createStore } from './test/test.utils'
 
@@ -81,7 +82,7 @@ describe('[int] import store', () => {
 
         const storedStore = await readFile(localStoreFile, { encoding: 'utf-8' })
 
-        expect(storedStore).toEqual(JSON.stringify(expectedStore, null, 4))
+        expect(storedStore).toEqual(new Store(expectedStore).toMinimalFormattedString())
     })
 
     it('should import by URL', async () => {
@@ -106,6 +107,6 @@ describe('[int] import store', () => {
 
         const storedStore = await readFile(localStoreFile, { encoding: 'utf-8' })
 
-        expect(storedStore).toEqual(JSON.stringify(expectedStore, null, 4))
+        expect(storedStore).toEqual(new Store(expectedStore).toMinimalFormattedString())
     })
 })
diff --git a/store/Store.spec.ts b/store/Store.spec.ts
@@ -262,5 +262,69 @@ describe('Store', () => {
     }
 }`)
         })
+
+        it('should format the store with indentation without indenting the arrays', () => {
+            const store = new Store(createStore({
+                linux: {
+                    x64: ['10.0.0.0', '20.0.0.0', '30.0.0.0'],
+                    x86: ['10.0.0.0']
+                }
+            }))
+
+            expect(store.toMinimalFormattedString()).toEqual(`{
+    "win": {
+        "x64": [],
+        "x86": []
+    },
+    "linux": {
+        "x64": ["10.0.0.0","20.0.0.0","30.0.0.0"],
+        "x86": ["10.0.0.0"]
+    },
+    "mac": {
+        "x64": [],
+        "arm": []
+    }
+}`)
+        })
+
+        it('should create a parsable string using toString', () => {
+            const store = new Store(createStore({
+                linux: {
+                    x64: ['10.0.0.0', '20.0.0.0', '30.0.0.0'],
+                    x86: ['10.0.0.0']
+                }
+            }))
+
+            const parsedStore = JSON.parse(store.toString())
+
+            expect(new Store(parsedStore)).toEqual(store)
+        })
+
+        it('should create a parsable string using toFormattedString', () => {
+            const store = new Store(createStore({
+                linux: {
+                    x64: ['10.0.0.0', '20.0.0.0', '30.0.0.0'],
+                    x86: ['10.0.0.0']
+                }
+            }))
+
+            const parsedStore = JSON.parse(store.toFormattedString())
+
+            expect(new Store(parsedStore)).toEqual(store)
+        })
+
+        it('should create a parsable string using toMinimalFormattedString', () => {
+            const store = new Store(createStore({
+                linux: {
+                    x64: ['10.0.0.0', '20.0.0.0', '30.0.0.0'],
+                    x86: ['10.0.0.0']
+                }
+            }))
+
+            const parsedStore = JSON.parse(store.toMinimalFormattedString())
+
+            expect(new Store(parsedStore)).toEqual(store)
+        })
+
     })
 })
diff --git a/store/Store.ts b/store/Store.ts
@@ -9,6 +9,10 @@ export class Store {
     private store: ISetStore
 
     public constructor(store_: IListStore) {
+
+        console.log('new: ')
+        console.log(store_)
+
         this.store = {
             linux: {
                 x64: new Set(store_.linux.x64),
@@ -113,6 +117,14 @@ export class Store {
         return JSON.stringify(sortStoreEntries(setStoreToListStore(this.store)), null, spaces)
     }
 
+    public toMinimalFormattedString(spaces = 4): string {
+        return JSON.stringify(sortStoreEntries(setStoreToListStore(this.store)), (k, v) => v instanceof Array ? JSON.stringify(v) : v, spaces)
+            .replace(/"\[/g, '[')
+            .replace(/\]"/g, ']')
+            .replace(/\\"/g, '"')
+            .replace(/""/g, '"')
+    }
+
     public size(): StoreSize {
         return {
             linux: this.store.linux.x64.size + this.store.linux.x86.size,

diff --git a/store/importStore.spec.ts b/store/importStore.spec.ts
@@ -69,7 +69,7 @@ describe('importStore', () => {
             expect(readFileMock).toHaveBeenCalledTimes(0)
 
             expect(writeFileMock).toHaveBeenCalledTimes(1)
-            expect(writeFileMock).toHaveBeenCalledWith(pathJoin(__dirname, '..', LOCAL_STORE_FILE), anyStore.toFormattedString(), expect.any(Function))
+            expect(writeFileMock).toHaveBeenCalledWith(pathJoin(__dirname, '..', LOCAL_STORE_FILE), anyStore.toMinimalFormattedString(), expect.any(Function))
 
         })
 
@@ -93,7 +93,7 @@ describe('importStore', () => {
             expect(readFileMock).toHaveBeenCalledTimes(0)
 
             expect(writeFileMock).toHaveBeenCalledTimes(1)
-            expect(writeFileMock).toHaveBeenCalledWith(pathJoin(__dirname, '..', LOCAL_STORE_FILE), anyStore.toFormattedString(), expect.any(Function))
+            expect(writeFileMock).toHaveBeenCalledWith(pathJoin(__dirname, '..', LOCAL_STORE_FILE), anyStore.toMinimalFormattedString(), expect.any(Function))
         })
 
         it('should do nothing, if no store file is loaded from file system', async () => {
@@ -170,7 +170,7 @@ describe('importStore', () => {
             expect(readFileMock).toHaveBeenCalledTimes(1)
 
             expect(writeFileMock).toHaveBeenCalledTimes(1)
-            expect(writeFileMock).toHaveBeenCalledWith(pathJoin(__dirname, '..', LOCAL_STORE_FILE), JSON.stringify(mergedStore, null, 4), expect.any(Function))
+            expect(writeFileMock).toHaveBeenCalledWith(pathJoin(__dirname, '..', LOCAL_STORE_FILE), new Store(mergedStore).toMinimalFormattedString(), expect.any(Function))
         })
 
         it('should merge the existing file with the file downloaded by local file', async () => {
@@ -207,7 +207,7 @@ describe('importStore', () => {
             expect(readFileMock).toHaveBeenCalledTimes(1)
 
             expect(writeFileMock).toHaveBeenCalledTimes(1)
-            expect(writeFileMock).toHaveBeenCalledWith(pathJoin(__dirname, '..', LOCAL_STORE_FILE), JSON.stringify(mergedStore, null, 4), expect.any(Function))
+            expect(writeFileMock).toHaveBeenCalledWith(pathJoin(__dirname, '..', LOCAL_STORE_FILE), new Store(mergedStore).toMinimalFormattedString(), expect.any(Function))
         })
     })
 })
diff --git a/store/importStore.ts b/store/importStore.ts
@@ -36,5 +36,5 @@ export async function importAndMergeLocalstore(config: IStoreConfig): Promise<St
 }
 
 async function storeStoreFile(store: Store): Promise<void> {
-    return writeFilePromise(localStoreFilePath, store.toFormattedString())
+    return writeFilePromise(localStoreFilePath, store.toMinimalFormattedString())
 }
diff --git a/store/storeNegativeHit.spec.ts b/store/storeNegativeHit.spec.ts
@@ -56,12 +56,12 @@ describe('storeNegativeHit', () => {
             patch: 4,
         }), 'linux', 'x64')
 
-        const expectedStore = createStore({ linux: { x64: ['1.2.3.4'], x86: [], } })
+        const expectedStore = new Store(createStore({ linux: { x64: ['1.2.3.4'], x86: [], } }))
 
         expect(loadStoreMock).toHaveBeenCalledTimes(1)
 
         expect(writeFileMock).toHaveBeenCalledTimes(1)
-        expect(writeFileMock).toHaveBeenCalledWith(localPath, JSON.stringify(expectedStore, null, 4), expect.any(Function))
+        expect(writeFileMock).toHaveBeenCalledWith(localPath, expectedStore.toMinimalFormattedString(), expect.any(Function))
     })
 
     it('should extend an existing store with one entry', async () => {
@@ -81,12 +81,12 @@ describe('storeNegativeHit', () => {
             patch: 4,
         }), 'linux', 'x64')
 
-        const expectedStore = createStore({ linux: { x64: ['1.2.3.4'], x86: [] }, win: { x64: ['10.0.0.0'], x86: [], } })
+        const expectedStore = new Store(createStore({ linux: { x64: ['1.2.3.4'], x86: [] }, win: { x64: ['10.0.0.0'], x86: [], } }))
 
         expect(loadStoreMock).toHaveBeenCalledTimes(1)
 
         expect(writeFileMock).toHaveBeenCalledTimes(1)
-        expect(writeFileMock).toHaveBeenCalledWith(localPath, JSON.stringify(expectedStore, null, 4), expect.any(Function))
+        expect(writeFileMock).toHaveBeenCalledWith(localPath, expectedStore.toMinimalFormattedString(), expect.any(Function))
     })
 
     it('should do nothing, if entry already exists', async () => {
@@ -128,11 +128,11 @@ describe('storeNegativeHit', () => {
             patch: 4,
         }), 'linux', 'x64')
 
-        const expectedStore = createStore({ linux: { x64: ['1.2.3.4'], x86: [] }, win: { x64: ['10.0.0.0', '11.0.0.0', '12.0.0.0'], x86: [], } })
+        const expectedStore = new Store(createStore({ linux: { x64: ['1.2.3.4'], x86: [] }, win: { x64: ['10.0.0.0', '11.0.0.0', '12.0.0.0'], x86: [], } }))
 
         expect(loadStoreMock).toHaveBeenCalledTimes(1)
 
         expect(writeFileMock).toHaveBeenCalledTimes(1)
-        expect(writeFileMock).toHaveBeenCalledWith(localPath, JSON.stringify(expectedStore, null, 4), expect.any(Function))
+        expect(writeFileMock).toHaveBeenCalledWith(localPath, expectedStore.toMinimalFormattedString(), expect.any(Function))
     })
 })
diff --git a/store/storeNegativeHit.ts b/store/storeNegativeHit.ts
@@ -18,6 +18,6 @@ export async function storeNegativeHit(version: ComparableVersion, os: OS, arch:
     if (!currentStore.has(os, arch, version)) {
         currentStore.add(os, arch, version)
 
-        await writeFile(STORE_FILE, currentStore.toFormattedString())
+        await writeFile(STORE_FILE, currentStore.toMinimalFormattedString())
     }
 }
diff --git a/utils.ts b/utils.ts
@@ -1,6 +1,6 @@
 import type { IChromeConfig } from './interfaces/interfaces'
 import type { OSSetting, OS, ExtendedOS } from './interfaces/os.interfaces'
-import { IListStore, ISetStore } from './interfaces/store.interfaces'
+import type { IListStore, ISetStore } from './interfaces/store.interfaces'
 
 export function detectOperatingSystem(config: IChromeConfig): OSSetting {
 

diff --git a/versions.spec.ts b/versions.spec.ts
@@ -21,6 +21,8 @@ import { Store } from './store/Store'
 import { storeNegativeHit } from './store/storeNegativeHit'
 import { createNodeParserHTMLElement, createNodeWithChildren, createStore, createChromeSingleConfig, createChromeFullConfig } from './test/test.utils'
 import { detectOperatingSystem } from './utils'
+// eslint-disable-next-line import/no-namespace
+import * as utils from './utils'
 import { mapVersions, getChromeDownloadUrl, loadVersions } from './versions'
 
 jest.mock('node-html-parser')
@@ -32,7 +34,7 @@ jest.mock('./store/storeNegativeHit')
 
 // don't mock compareComparableVersions to test the sort and filtering based on version.comparableVersion
 jest.mock('./utils', () => ({
-    ...jest.requireActual<any>('./utils'),
+    ...jest.requireActual<typeof utils>('./utils'),
     detectOperatingSystem: jest.fn(),
 }))