Merge pull request neo4j#812 from oskarhane/pc-hits-in-profile

Add pagecache hits and misses to plan output

Author: pe4cey

e2e_tests/integration/plan.spec.js

@@ -23,7 +23,20 @@
 describe('Plan output', () => {
   it('can connect', () => {
     const password = Cypress.env('browser-password') || 'newpassword'
-    cy.connect('neo4j', password)
+    cy.connect(
+      'neo4j',
+      password
+    )
+  })
+  it('print pagecache stats in PROFILE', () => {
+    cy.executeCommand(':clear')
+    cy.executeCommand(
+      `PROFILE MATCH (n:VendorId {{}uid: "d8eedae3ef0b4c45a9a27308", vendor: "run"}) RETURN n.uid, n.vendor, id(n)`
+    )
+    cy.get('[data-test-id="planExpandButton"]', { timeout: 10000 }).click()
+    const el = cy.get('[data-test-id="planSvg"]', { timeout: 10000 })
+    el.should('contain', 'pagecache hits')
+    el.should('contain', 'pagecache misses')
   })
   it('ouputs and preselects plan when using PROFILE', () => {
     cy.executeCommand(':clear')
@@ -40,8 +53,7 @@ describe('Plan output', () => {
     LIMIT 50;`)
     cy.get('[data-test-id="planExpandButton"]', { timeout: 10000 }).click()
     const el = cy.get('[data-test-id="planSvg"]', { timeout: 10000 })
-    el
-      .should('contain', 'NodeByLabelScan')
+    el.should('contain', 'NodeByLabelScan')
       .and('contain', 'tag')
       .and('contain', ':Tag')
       .and('contain', 'Filter')

src/browser/external/neoPlanner.js

@@ -164,8 +164,8 @@ neo.queryPlan = function(element) {
         (left =
           (left1 =
             operator.Expressions != null
-             ? operator.Expressions
-             : operator.Expression != null
+              ? operator.Expressions
+              : operator.Expression != null
                 ? operator.Expression
                 : operator.LegacyExpression != null
                   ? operator.LegacyExpression
@@ -179,6 +179,19 @@ neo.queryPlan = function(element) {
       details.push({ className: 'padding' })
     }
 
+    if (operator.PageCacheHits || operator.PageCacheMisses) {
+      details.push({
+        className: 'pagecache-hits',
+        key: 'pagecache hits',
+        value: formatNumber(operator.PageCacheHits)
+      })
+      details.push({
+        className: 'pagecache-misses',
+        key: 'pagecache misses',
+        value: formatNumber(operator.PageCacheMisses)
+      })
+    }
+
     if (operator.Rows != null && operator.EstimatedRows != null) {
       details.push({
         className: 'estimated-rows',

src/shared/services/bolt/boltMappings.js

@@ -111,12 +111,15 @@ export function extractPlan (result, calculateTotalDbHits = false) {
         Rows: plan.rows,
         identifiers: plan.identifiers,
         children: plan.children.map(_ => ({
-          ..._.arguments,
+          ...transformPlanArguments(_.arguments),
           ...boltPlanToRESTPlanShared(_)
         }))
       }
     }
-    let obj = { ...rawPlan.arguments, ...boltPlanToRESTPlanShared(rawPlan) }
+    let obj = {
+      ...transformPlanArguments(rawPlan.arguments),
+      ...boltPlanToRESTPlanShared(rawPlan)
+    }
 
     if (calculateTotalDbHits === true) {
       obj.totalDbHits = collectHits(obj)
@@ -127,6 +130,17 @@ export function extractPlan (result, calculateTotalDbHits = false) {
   return null
 }
 
+const transformPlanArguments = args => {
+  const res = { ...args }
+  if (res.PageCacheHits) {
+    res.PageCacheHits = res.PageCacheHits.toNumber()
+  }
+  if (res.PageCacheMisses) {
+    res.PageCacheMisses = res.PageCacheMisses.toNumber()
+  }
+  return res
+}
+
 const collectHits = function (operator) {
   let hits = operator.DbHits || 0
   if (operator.children) {
@@ -279,9 +293,9 @@ export const retrieveFormattedUpdateStatistics = result => {
       .filter(field => stats[field.field] > 0)
       .map(
         field =>
-          `${field.verb} ${stats[field.field]} ${stats[field.field] === 1
-            ? field.singular
-            : field.plural}`
+          `${field.verb} ${stats[field.field]} ${
+            stats[field.field] === 1 ? field.singular : field.plural
+          }`
       )
     return statsMessages.join(', ')
   } else return null