Dynamic title based on workflow execution (#865)

*  Added title changes based on workflow execution

*  Title changes on workflow open, reset on workflow delete, fixed not showing when page refreshed

*  Title icons
This commit is contained in:
Rupenieks 2020-08-25 20:37:24 +02:00 committed by GitHub
parent abdda858eb
commit 44f7b7a9c2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 57 additions and 7 deletions

View file

@ -89,6 +89,7 @@ import { workflowHelpers } from '@/components/mixins/workflowHelpers';
import { saveAs } from 'file-saver'; import { saveAs } from 'file-saver';
import mixins from 'vue-typed-mixins'; import mixins from 'vue-typed-mixins';
import titleChange from './mixins/titleChange';
export default mixins( export default mixins(
genericHelpers, genericHelpers,
@ -96,6 +97,7 @@ export default mixins(
restApi, restApi,
showMessage, showMessage,
workflowHelpers, workflowHelpers,
titleChange
) )
.extend({ .extend({
name: 'MainHeader', name: 'MainHeader',
@ -155,6 +157,7 @@ export default mixins(
}, },
methods: { methods: {
async openWorkflow (workflowId: string) { async openWorkflow (workflowId: string) {
titleChange.set(workflowId, 'IDLE');
// Change to other workflow // Change to other workflow
this.$router.push({ this.$router.push({
name: 'NodeViewExisting', name: 'NodeViewExisting',
@ -162,7 +165,6 @@ export default mixins(
}); });
}, },
}, },
async mounted () { async mounted () {
// Initialize the push connection // Initialize the push connection
this.pushConnect(); this.pushConnect();

View file

@ -186,6 +186,7 @@ import { workflowRun } from '@/components/mixins/workflowRun';
import { saveAs } from 'file-saver'; import { saveAs } from 'file-saver';
import mixins from 'vue-typed-mixins'; import mixins from 'vue-typed-mixins';
import titleChange from './mixins/titleChange';
export default mixins( export default mixins(
genericHelpers, genericHelpers,
@ -194,6 +195,7 @@ export default mixins(
workflowHelpers, workflowHelpers,
workflowRun, workflowRun,
workflowSave, workflowSave,
titleChange
) )
.extend({ .extend({
name: 'MainHeader', name: 'MainHeader',
@ -417,7 +419,8 @@ export default mixins(
this.$showError(error, 'Problem deleting the workflow', 'There was a problem deleting the workflow:'); this.$showError(error, 'Problem deleting the workflow', 'There was a problem deleting the workflow:');
return; return;
} }
// Reset tab title since workflow is deleted.
titleChange.reset();
this.$showMessage({ this.$showMessage({
title: 'Workflow got deleted', title: 'Workflow got deleted',
message: `The workflow "${this.workflowName}" got deleted!`, message: `The workflow "${this.workflowName}" got deleted!`,

View file

@ -37,11 +37,13 @@ import { showMessage } from '@/components/mixins/showMessage';
import { IWorkflowShortResponse } from '@/Interface'; import { IWorkflowShortResponse } from '@/Interface';
import mixins from 'vue-typed-mixins'; import mixins from 'vue-typed-mixins';
import titleChange from './mixins/titleChange';
export default mixins( export default mixins(
genericHelpers, genericHelpers,
restApi, restApi,
showMessage, showMessage,
titleChange
).extend({ ).extend({
name: 'WorkflowOpen', name: 'WorkflowOpen',
props: [ props: [
@ -89,6 +91,7 @@ export default mixins(
}, },
openWorkflow (data: IWorkflowShortResponse, column: any) { // tslint:disable-line:no-any openWorkflow (data: IWorkflowShortResponse, column: any) { // tslint:disable-line:no-any
if (column.label !== 'Active') { if (column.label !== 'Active') {
titleChange.set(data.name, 'IDLE');
this.$emit('openWorkflow', data.id); this.$emit('openWorkflow', data.id);
} }
}, },

View file

@ -12,10 +12,12 @@ import { nodeHelpers } from '@/components/mixins/nodeHelpers';
import { showMessage } from '@/components/mixins/showMessage'; import { showMessage } from '@/components/mixins/showMessage';
import mixins from 'vue-typed-mixins'; import mixins from 'vue-typed-mixins';
import titleChange from './titleChange';
export const pushConnection = mixins( export const pushConnection = mixins(
nodeHelpers, nodeHelpers,
showMessage, showMessage,
titleChange
) )
.extend({ .extend({
data () { data () {
@ -147,7 +149,7 @@ export const pushConnection = mixins(
*/ */
pushMessageReceived (event: Event, isRetry?: boolean): boolean { pushMessageReceived (event: Event, isRetry?: boolean): boolean {
const retryAttempts = 5; const retryAttempts = 5;
const workflow = this.getWorkflow();
let receivedData: IPushData; let receivedData: IPushData;
try { try {
// @ts-ignore // @ts-ignore
@ -207,7 +209,7 @@ export const pushConnection = mixins(
if (runDataExecuted.data.resultData.error && runDataExecuted.data.resultData.error.message) { if (runDataExecuted.data.resultData.error && runDataExecuted.data.resultData.error.message) {
errorMessage = `There was a problem executing the workflow:<br /><strong>"${runDataExecuted.data.resultData.error.message}"</strong>`; errorMessage = `There was a problem executing the workflow:<br /><strong>"${runDataExecuted.data.resultData.error.message}"</strong>`;
} }
titleChange.set(workflow.name, 'ERROR');
this.$showMessage({ this.$showMessage({
title: 'Problem executing workflow', title: 'Problem executing workflow',
message: errorMessage, message: errorMessage,
@ -215,6 +217,7 @@ export const pushConnection = mixins(
}); });
} else { } else {
// Workflow did execute without a problem // Workflow did execute without a problem
titleChange.set(workflow.name, 'IDLE');
this.$showMessage({ this.$showMessage({
title: 'Workflow got executed', title: 'Workflow got executed',
message: 'Workflow did get executed successfully!', message: 'Workflow did get executed successfully!',

View file

@ -0,0 +1,25 @@
type Status = 'EXECUTING' | 'IDLE' | 'ERROR';
export default {
/**
* Change title of n8n tab
* @param workflow Name of workflow
* @param status Status of workflow
*/
set (workflow : string, status : Status) {
if (status === 'EXECUTING') {
window.document.title = `n8n - 🔄 ${workflow}}`;
}
else if (status === 'IDLE') {
window.document.title = `n8n - ▶️ ${workflow}`;
}
else {
window.document.title = `n8n - ⚠️ ${workflow}`;
}
},
reset () {
document.title = `n8n - Workflow Automation`;
}
};

View file

@ -14,10 +14,13 @@ import { restApi } from '@/components/mixins/restApi';
import { workflowHelpers } from '@/components/mixins/workflowHelpers'; import { workflowHelpers } from '@/components/mixins/workflowHelpers';
import mixins from 'vue-typed-mixins'; import mixins from 'vue-typed-mixins';
import titleChange from './titleChange';
import { title } from 'process';
export const workflowRun = mixins( export const workflowRun = mixins(
restApi, restApi,
workflowHelpers, workflowHelpers,
titleChange
).extend({ ).extend({
methods: { methods: {
// Starts to executes a workflow on server. // Starts to executes a workflow on server.
@ -27,6 +30,7 @@ export const workflowRun = mixins(
// because then it can not receive the data as it executes. // because then it can not receive the data as it executes.
throw new Error('No active connection to server. It is maybe down.'); throw new Error('No active connection to server. It is maybe down.');
} }
const workflow = this.getWorkflow();
this.$store.commit('addActiveAction', 'workflowRunning'); this.$store.commit('addActiveAction', 'workflowRunning');
@ -55,7 +59,8 @@ export const workflowRun = mixins(
} }
const workflow = this.getWorkflow(); const workflow = this.getWorkflow();
titleChange.set(workflow.name, 'EXECUTING');
try { try {
// Check first if the workflow has any issues before execute it // Check first if the workflow has any issues before execute it
const issuesExist = this.$store.getters.nodesIssuesExist; const issuesExist = this.$store.getters.nodesIssuesExist;
@ -78,6 +83,7 @@ export const workflowRun = mixins(
type: 'error', type: 'error',
duration: 0, duration: 0,
}); });
titleChange.set(workflow.name, 'ERROR');
return; return;
} }
} }
@ -164,9 +170,10 @@ export const workflowRun = mixins(
}, },
}; };
this.$store.commit('setWorkflowExecutionData', executionData); this.$store.commit('setWorkflowExecutionData', executionData);
return await this.runWorkflowApi(startRunData); return await this.runWorkflowApi(startRunData);
} catch (error) { } catch (error) {
titleChange.set(workflow.name, 'ERROR');
this.$showError(error, 'Problem running workflow', 'There was a problem running the workflow:'); this.$showError(error, 'Problem running workflow', 'There was a problem running the workflow:');
return undefined; return undefined;
} }

View file

@ -15,6 +15,8 @@ import './n8n-theme.scss';
import App from '@/App.vue'; import App from '@/App.vue';
import router from './router'; import router from './router';
import titleChange from './components/mixins/titleChange';
import { library } from '@fortawesome/fontawesome-svg-core'; import { library } from '@fortawesome/fontawesome-svg-core';
import { import {
faAngleDoubleLeft, faAngleDoubleLeft,
@ -92,6 +94,7 @@ import { FontAwesomeIcon } from '@fortawesome/vue-fontawesome';
import { store } from './store'; import { store } from './store';
Vue.use(ElementUI, { locale }); Vue.use(ElementUI, { locale });
Vue.mixin(titleChange);
library.add(faAngleDoubleLeft); library.add(faAngleDoubleLeft);
library.add(faAngleDown); library.add(faAngleDown);

View file

@ -157,6 +157,7 @@ import {
IWorkflowDataUpdate, IWorkflowDataUpdate,
XYPositon, XYPositon,
} from '../Interface'; } from '../Interface';
import titleChange from '../components/mixins/titleChange';
export default mixins( export default mixins(
copyPaste, copyPaste,
@ -167,6 +168,7 @@ export default mixins(
showMessage, showMessage,
workflowHelpers, workflowHelpers,
workflowRun, workflowRun,
titleChange
) )
.extend({ .extend({
name: 'NodeView', name: 'NodeView',
@ -1324,6 +1326,8 @@ export default mixins(
} }
if (workflowId !== null) { if (workflowId !== null) {
let workflow = await this.restApi().getWorkflow(workflowId);
titleChange.set(workflow.name, 'IDLE');
// Open existing workflow // Open existing workflow
await this.openWorkflow(workflowId); await this.openWorkflow(workflowId);
} else { } else {