Add job info menu to log view

Author: MetRonnie

src/services/mock/json/index.cjs

@@ -20,7 +20,7 @@ const taskProxy = require('./taskProxy.json')
 const familyProxy = require('./familyProxy.json')
 const { one, workflows, Workflow } = require('./workflows/index.cjs')
 const { LogData } = require('./logData.cjs')
-const { LogFiles, JobState } = require('./logFiles.cjs')
+const { LogFiles, Jobs } = require('./logFiles.cjs')
 const analysisQuery = require('./analysisQuery.json')
 const ganttQuery = require('./ganttQuery.json')
 const InfoViewSubscription = require('./infoView.json')
@@ -31,7 +31,7 @@ module.exports = {
   familyProxy,
   LogData,
   LogFiles,
-  JobState,
+  Jobs,
   App: workflows,
   Workflow,
   GraphIQLTest: one,

src/services/mock/json/logFiles.cjs

@@ -55,7 +55,7 @@ const LogFiles = async ({ id }) => {
  *
  * @param {{ id: string }} variables
  */
-const JobState = async ({ id, workflowId }) => {
+const Jobs = async ({ id, workflowId }) => {
   if (!workflowId.startsWith('~')) {
     workflowId = `~user/${workflowId}`
   }
@@ -65,17 +65,17 @@ const JobState = async ({ id, workflowId }) => {
   ).replace(
     /\/(\d+)$/, (match, p1) => `/${parseInt(p1)}` // strips leading zeroes
   )
-  const { state } = deltas?.added?.jobs?.find((job) => job.id.includes(searchID)) ?? {}
+  const node = deltas?.added?.jobs?.find((job) => job.id.includes(searchID)) ?? {}
   await simulatedDelay(500)
   return {
     data: {
-      jobs: state ? [{ id, state }] : []
+      jobs: node.state ? [{ id, ...node }] : []
     }
   }
 }
 
 module.exports = {
-  JobState,
+  Jobs,
   LogFiles,
   deletedFile,
   jobLogFiles,

src/views/Log.vue

@@ -69,7 +69,41 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
             :rules="[validateInputID]"
             placeholder="cycle/task/job"
             clearable
-          />
+          >
+            <template #prepend-inner>
+              <v-btn
+                :disabled="!relativeTokens || jobNode === false"
+                v-bind="toolbarBtnProps"
+                size="medium"
+                variant="plain"
+                @click="() => jobNode ?? fetchJobData()"
+                data-cy="job-info-btn"
+              >
+                <v-icon :icon="$options.icons.mdiInformationOutline"/>
+                <v-menu
+                  activator="parent"
+                  :close-on-content-click="false"
+                >
+                  <v-card class="pa-2">
+                    <v-skeleton-loader
+                      v-if="!jobNode"
+                      type="text@6"
+                    />
+                    <JobDetails
+                      v-else
+                      :node="jobNode"
+                      density="compact"
+                      hover
+                    >
+                      <template #header>
+                        {{ new Tokens(jobNode.id).relativeID }}
+                      </template>
+                    </JobDetails>
+                  </v-card>
+                </v-menu>
+              </v-btn>
+            </template>
+          </v-text-field>
           <v-text-field
             v-else
             data-cy="workflow-id-input"
@@ -181,6 +215,7 @@ import {
   mdiWrap,
   mdiFileAlertOutline,
   mdiMouseMoveDown,
+  mdiInformationOutline,
 } from '@mdi/js'
 import { btnProps } from '@/utils/viewToolbar'
 import graphqlMixin from '@/mixins/graphql'
@@ -200,6 +235,7 @@ import { debounce } from 'lodash-es'
 import CopyBtn from '@/components/core/CopyBtn.vue'
 import { Alert } from '@/model/Alert.model'
 import { getJobLogFileFromState } from '@/model/JobState.model'
+import JobDetails from '@/components/cylc/common/JobDetails.vue'
 
 /**
  * Query used to retrieve data for the Log view.
@@ -236,10 +272,16 @@ query LogFiles($id: ID!) {
  * @type {DocumentNode}
 */
 const JOB_QUERY = gql`
-query JobState($id: ID!, $workflowId: ID!) {
+query Jobs($id: ID!, $workflowId: ID!) {
   jobs (live: false, ids: [$id], workflows: [$workflowId]) {
     id
     state
+    platform
+    jobId
+    jobRunnerName
+    submittedTime
+    startedTime
+    finishedTime
   }
 }
 `
@@ -306,6 +348,7 @@ export default {
     CopyBtn,
     LogComponent,
     ViewToolbar,
+    JobDetails,
   },
   emits: [
     updateInitialOptionsEvent,
@@ -400,6 +443,7 @@ export default {
       inputID,
       validateInputID,
       relativeTokens,
+      Tokens,
       file,
       // the label for the file input
       fileLabel: ref('Select File'),
@@ -414,6 +458,7 @@ export default {
       reset,
       toolbarBtnSize,
       toolbarBtnProps: btnProps(toolbarBtnSize),
+      jobNode: ref(null),
     }
   },
 
@@ -508,12 +553,13 @@ export default {
       )
     },
     /**
-     * Query the job state and return the appropriate default log file based on the result.
+     * Query job data.
      *
-     * @returns {?string}
+     * @returns {Object|false} The job node, or false if no data/the query failed.
      */
-    async getDefaultJobLog () {
+    async fetchJobData () {
       let result
+      this.jobNode = null
       try {
         if (this.relativeTokens) {
           // get the latest job state
@@ -528,9 +574,10 @@ export default {
       } catch (err) {
         // the query failed
         console.error(err)
-        return
+        return false
       }
-      return getJobLogFileFromState(result?.data?.jobs?.[0]?.state)
+      this.jobNode = result?.data?.jobs?.[0] ?? false
+      return this.jobNode
     },
     /**
      * Get the default workflow log file from the given log filenames, if there is a
@@ -593,7 +640,9 @@ export default {
       if (this.jobLog && !initialLoad) {
         // (Don't query job state on initial load, as it will either be pre-populated or empty)
         promises.push(
-          this.getDefaultJobLog().then((result) => { this.file = result })
+          this.fetchJobData().then((result) => {
+            this.file = getJobLogFileFromState(result?.state)
+          })
         )
       }
       // Simultaneously wait for the log file list and the job state result
@@ -626,7 +675,8 @@ export default {
     mdiFolderRefresh,
     mdiPowerPlug,
     mdiPowerPlugOff,
-    mdiFileAlertOutline
+    mdiFileAlertOutline,
+    mdiInformationOutline,
   }
 }
 </script>

tests/e2e/specs/log.cy.js

@@ -184,6 +184,31 @@ describe('Log View', () => {
       .then((clip) => clip.readText())
       .should('equal', `${logDirPath}/${workflowLogFiles[0]}`)
   })
+
+  it('has a job info menu', () => {
+    cy.get('.c-log [data-cy=job-info-btn]')
+      .should('not.exist')
+    cy.get('[data-cy=job-toggle]').click()
+      .get('[data-cy=job-id-input] input')
+      .type('20000102T0000Z/')
+    cy.get('.c-log [data-cy=job-info-btn]')
+      .should('be.visible')
+      // The button should be disabled until a task ID is entered:
+      .should('be.disabled')
+    cy.get('[data-cy=job-id-input] input')
+      .type('succeeded')
+    cy.get('.c-log [data-cy=job-info-btn]')
+      .should('not.be.disabled')
+      .click()
+      .get('[data-cy=job-details]')
+      // It includes job submit number:
+      .contains('20000102T0000Z/succeeded/1')
+      .get('[data-cy=job-details] td')
+      // It includes platform:
+      .contains('Platform')
+      .parent().find('td:last')
+      .contains('localhost')
+  })
 })
 
 describe('Log command in menu', () => {
@@ -209,10 +234,10 @@ describe('Log command in menu', () => {
         .click()
     }
 
-    const jobStateQueries = []
+    const jobDataQueries = []
     cy.intercept('/graphql', ({ body }) => {
-      if (body.operationName === 'JobState') {
-        jobStateQueries.push(body.variables.id)
+      if (body.operationName === 'Jobs') {
+        jobDataQueries.push(body.variables.id)
       }
     })
 
@@ -226,7 +251,7 @@ describe('Log command in menu', () => {
       .contains('job.out')
       // Should not have run queries for this
       .then(() => {
-        expect(jobStateQueries.length).to.eq(0)
+        expect(jobDataQueries.length).to.eq(0)
       })
     // But should run the job state query if we manually enter a job ID:
     const failedID = '20000102T0000Z/failed/01'
@@ -236,7 +261,7 @@ describe('Log command in menu', () => {
       .get('.c-log [data-cy=file-input]')
       .contains('job.err')
       .then(() => {
-        expect(jobStateQueries).to.deep.eq([failedID])
+        expect(jobDataQueries).to.deep.eq([failedID])
       })
   })
 })

tests/unit/views/log.vue.spec.js

@@ -24,6 +24,7 @@ import sinon from 'sinon'
 import Log from '@/views/Log.vue'
 import WorkflowService from '@/services/workflow.service'
 import User from '@/model/User.model'
+import { getJobLogFileFromState } from '@/model/JobState.model'
 
 describe('Log view', () => {
   const owner = 'svimes'
@@ -87,7 +88,9 @@ describe('Log view', () => {
         const wrapper = mountFunction()
         wrapper.vm.jobLog = 1
         wrapper.vm.relativeID = '1/foo'
-        expect(await wrapper.vm.getDefaultJobLog()).toBe(expected)
+        const result = await wrapper.vm.fetchJobData()
+        expect(result.state).toBe(state)
+        expect(getJobLogFileFromState(result.state)).toBe(expected)
       })
     })