Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: show build error #45

Merged
merged 8 commits into from
Oct 1, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 33 additions & 9 deletions app/app.vue
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,22 @@
<h3>Loading...</h3>
</transition>
</div>
<div v-else-if="hasErrors">
<div v-else-if="hasErrors && !errorDescription">
<h3 class="hasErrors">
An error occured, please look at Nuxt.js terminal.
</h3>
</div>
<div v-else-if="hasErrors && errorDescription">
<h3 class="hasErrors">
An error occured, please see below or look at Nuxt.js terminal for more info.

</h3>
<div class="errorStack">
<p class="hasErrors">{{ errorDescription }}</p>
<p class="pre" v-if="errorStack">{{ errorStack }}</p>
</div>
<p><span class="hasErrors">Note:</span> A manual restart of the Nuxt.js dev server may be required</p>
</div>
<div v-else-if="preventReload" class="reload_prevented">
<h3 class="hasErrors">Failed to show Nuxt.js app after {{ maxReloadCount }} reloads</h3>
<p>
Expand Down Expand Up @@ -68,6 +79,8 @@ export default {

data() {
return {
error: false,
stack: false,
allDone: false,
hasErrors: false,
isFinished: false,
Expand Down Expand Up @@ -144,20 +157,31 @@ export default {
},

onData(data) {
if (!data || !data.states || this._reloading) {
if (!data || this._reloading) {
return
}

// Update active bundles
this.bundles = data.states.map(state => state.name.toLowerCase())
const { error, states, hasErrors, allDone } = data

if (error) {
const { description, stack } = error

this.errorDescription = description
this.errorStack = stack
this.hasErrors = true
return
}

// Ignore if no bundle is active
if (!this.bundles.length) {
if (!states || !states.length) {
return
}

// Update active bundles
this.bundles = states.map(state => state.name.toLowerCase())

// Update bundle states
for (const state of data.states) {
for (const state of states) {
const bundle = state.name.toLowerCase()
if (!this.states[bundle]) {
this.states[bundle] = {}
Expand All @@ -167,13 +191,13 @@ export default {
}

// Try to show nuxt app if allDone and no errors
if (!data.hasErrors && data.allDone && !this.allDone) {
if (!hasErrors && allDone && !this.allDone) {
this.reload()
}

// Update state
this.allDone = data.allDone
this.hasErrors = data.hasErrors
this.allDone = allDone
this.hasErrors = hasErrors
},

canReload() {
Expand Down
18 changes: 16 additions & 2 deletions app/css/loading.css
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,28 @@ h3 {
font-weight: 500;
font-size: 18px;
color: #383838;
margin-bottom: 10px;
margin: 1em 0;
letter-spacing: 1px;
}

h3.hasErrors {
.hasErrors {
color: #D0021B;
}

.errorStack {
padding: 1.5em;
border: 1px solid #108775;
border-radius: 1em;
background-color: #eee;
margin: 1em 0;
}

p.pre {
margin-top: 1em;
line-height: 1.2em;
white-space: pre;
}

h4 {
margin-bottom: 30px;
font-size: 15px;
Expand Down
1 change: 1 addition & 0 deletions app/index.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import Vue from 'vue'
import App from './app.vue'

// Vue.config.devtools = true
window._nuxtLoadingScreen = new Vue(App)
22 changes: 22 additions & 0 deletions lib/loading.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ const serveStatic = require('serve-static')
const fs = require('fs-extra')
const { json, end, header } = require('node-res')

const { parseStack } = require('./utils/error')
const SSE = require('./sse')

class LoadingUI {
Expand Down Expand Up @@ -43,19 +44,40 @@ class LoadingUI {

get state () {
return {
error: this.error,
states: this.states,
allDone: this.allDone,
hasErrors: this.hasErrors
}
}

setStates (states) {
this.clearError()
this.states = states
this.allDone = this.states.every(state => state.progress === 0 || state.progress === 100)
this.hasErrors = this.states.some(state => state.hasErrors === true)
this.broadcastState()
}

setError (error) {
this.clearStates(true)
this.error = {
description: error.toString(),
stack: parseStack(error.stack).join('\n')
}
this.broadcastState()
}

clearError () {
this.error = undefined
}

clearStates (hasErrors) {
this.status = []
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pi0 oops, made a typo here! should be states not status

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you please make direct commit to master?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this message was to ping you asap in case you were already releasing ;)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I won't release without proper testing ;)

this.allDone = false
this.hasErrors = !!hasErrors
}

broadcastState () {
const now = new Date()

Expand Down
4 changes: 4 additions & 0 deletions lib/module.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ module.exports = async function NuxtLoadingScreen () {
loading.setStates(states)
})

this.nuxt.hook('cli:buildError', (error) => {
pi0 marked this conversation as resolved.
Show resolved Hide resolved
loading.setError(error)
})

this.nuxt.hook('server:nuxt:renderLoading', (req, res) => {
loading.serveIndex(req, res)
})
Expand Down
17 changes: 17 additions & 0 deletions lib/utils/error.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import { sep } from 'path'

// copied from https://github.com/nuxt/consola/blob/master/src/utils/error.js
export function parseStack (stack) {
const cwd = process.cwd() + sep

const lines = stack
.split('\n')
.splice(1)
.map(l => l
.trim()
.replace('file://', '')
.replace(cwd, '')
)

return lines
}
Empty file added lib/utils/index.js
Empty file.