add new public method: getMainTrackEvents (#11)

* add new method: getMainTrackEvents

* Fix lint issues

* Update index.test.ts.snap

Author: farhan-sauce

jest.config.js

@@ -1,13 +1,14 @@
 module.exports = {
     preset: 'ts-jest',
     testEnvironment: 'node',
+    collectCoverageFrom: ['./src/**'],
     coverageDirectory: './coverage/',
     coverageThreshold: {
         global: {
-            branches: 43,
-            functions: 68,
-            lines: 63,
-            statements: 63
+            branches: 90,
+            functions: 90,
+            lines: 90,
+            statements: 90
         }
     },
     testMatch: [

src/index.ts

@@ -29,6 +29,14 @@ export default class Tracelib {
             ))
     }
 
+    public getMainTrackEvents(): Event[] {
+        const mainTrack = this._findMainTrack()
+        if (!mainTrack) {
+            throw new Error('MainTrack is missing in traceLog')
+        }
+        return mainTrack.events
+    }
+
     public getFPS(): number[] {
         return this._timelineLoader.performanceModel.frames()
             .map(({ duration }): number => calcFPS(duration))
@@ -38,9 +46,14 @@ export default class Tracelib {
         const timelineUtils = new TimelineUIUtils()
         const startTime = from || this._performanceModel.startTime
         const endTime = to || this._performanceModel.endTime
+        const mainTrack = this._findMainTrack()
+        if (!mainTrack) {
+            throw new Error('MainTrack is missing in traceLog')
+        }
+
         return {
             ...timelineUtils.statsForTimeRange(
-                this._findMainTrack().syncEvents(), startTime, endTime
+                mainTrack.syncEvents(), startTime, endTime
             ),
             startTime,
             endTime,

tests/__snapshots__/index.test.ts.snap

@@ -1,5 +1,25 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`getSummary: should get summary data 1`] = `
+Object {
+  "endTime": 289961229.717,
+  "idle": 52.38300037384033,
+  "other": 9.896000564098358,
+  "painting": 69.94999980926514,
+  "rendering": 847.373997092247,
+  "scripting": 394.4800021648407,
+  "startTime": 289959855.634,
+}
+`;
+
+exports[`getWarningCounts: should get warning counts 1`] = `
+Object {
+  "ForcedLayout": 4683,
+  "ForcedStyle": 4684,
+  "LongRecurringHandler": 13,
+}
+`;
+
 exports[`should get FPS 1`] = `
 Array [
   182.2821727559685,
@@ -100,18 +120,6 @@ Object {
 }
 `;
 
-exports[`should get summary data 1`] = `
-Object {
-  "endTime": 289961229.717,
-  "idle": 52.38300037384033,
-  "other": 9.896000564098358,
-  "painting": 69.94999980926514,
-  "rendering": 847.373997092247,
-  "scripting": 394.4800021648407,
-  "startTime": 289959855.634,
-}
-`;
-
 exports[`should get summary data between passed range 1`] = `
 Object {
   "endTime": 289960729.717,
@@ -123,11 +131,3 @@ Object {
   "startTime": 289960055.634,
 }
 `;
-
-exports[`should get warning counts 1`] = `
-Object {
-  "ForcedLayout": 4683,
-  "ForcedStyle": 4684,
-  "LongRecurringHandler": 13,
-}
-`;

tests/index.test.ts

@@ -12,26 +12,50 @@ test('should get FPS', () => {
     expect(result).toMatchSnapshot()
 })
 
-test('should get summary data', () => {
+test('getSummary: should get summary data', () => {
     const trace = new Tracelib(JANK_TRACE_LOG)
     const result = trace.getSummary()
     expect(result).toMatchSnapshot()
 })
 
+test('getSummary: should throw error if main track is missing', () => {
+    const trace = new Tracelib([])
+    expect(() => trace.getSummary())
+        .toThrow(new Error('MainTrack is missing in traceLog'))
+})
+
 test('should get summary data between passed range', () => {
     const trace = new Tracelib(JANK_TRACE_LOG)
     const result = trace.getSummary(289960055.634, 289960729.717)
     expect(result).toMatchSnapshot()
 })
 
-test('should get warning counts', () => {
+test('getWarningCounts: should get warning counts', () => {
     const trace = new Tracelib(JANK_TRACE_LOG)
     const result = trace.getWarningCounts()
     expect(result).toMatchSnapshot()
 })
 
+test('getWarningCounts: should throw error if main track is missing', () => {
+    const trace = new Tracelib([])
+    expect(() => trace.getWarningCounts())
+        .toThrow(new Error('MainTrack is missing in traceLog'))
+})
+
 test('should get memory counters', () => {
     const trace = new Tracelib(JANK_TRACE_LOG)
     const result = trace.getMemoryCounters()
     expect(result).toMatchSnapshot()
 })
+
+test('mainTrackEvents: should get events', () => {
+    const trace = new Tracelib(JANK_TRACE_LOG)
+    const result = trace.getMainTrackEvents()
+    expect(result.length).toEqual(56244)
+})
+
+test('mainTrackEvents: should throws error if main track is missing', () => {
+    const trace = new Tracelib([])
+    expect(() => trace.getMainTrackEvents())
+        .toThrow(new Error('MainTrack is missing in traceLog'))
+})