-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
avoid 'app not found' flickering while awaiting for mount #56483
Merged
pgayvallet
merged 2 commits into
elastic:master
from
pgayvallet:kbn-56409-not-found-await-mount
Feb 3, 2020
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
/* | ||
* Licensed to Elasticsearch B.V. under one or more contributor | ||
* license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright | ||
* ownership. Elasticsearch B.V. licenses this file to you under | ||
* the Apache License, Version 2.0 (the "License"); you may | ||
* not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
|
||
import React from 'react'; | ||
import { mount } from 'enzyme'; | ||
|
||
import { AppContainer } from './app_container'; | ||
import { Mounter, AppMountParameters, AppStatus } from '../types'; | ||
|
||
describe('AppContainer', () => { | ||
const appId = 'someApp'; | ||
const setAppLeaveHandler = jest.fn(); | ||
|
||
const flushPromises = async () => { | ||
await new Promise(async resolve => { | ||
setImmediate(() => resolve()); | ||
}); | ||
}; | ||
|
||
const createResolver = (): [Promise<void>, () => void] => { | ||
let resolve: () => void | undefined; | ||
const promise = new Promise<void>(r => { | ||
resolve = r; | ||
}); | ||
return [promise, resolve!]; | ||
}; | ||
|
||
const createMounter = (promise: Promise<void>): Mounter => ({ | ||
appBasePath: '/base-path', | ||
appRoute: '/some-route', | ||
unmountBeforeMounting: false, | ||
mount: async ({ element }: AppMountParameters) => { | ||
await promise; | ||
const container = document.createElement('div'); | ||
container.innerHTML = 'some-content'; | ||
element.appendChild(container); | ||
return () => container.remove(); | ||
}, | ||
}); | ||
|
||
it('should hide the "not found" page before mounting the route', async () => { | ||
const [waitPromise, resolvePromise] = createResolver(); | ||
const mounter = createMounter(waitPromise); | ||
|
||
const wrapper = mount( | ||
<AppContainer | ||
appId={appId} | ||
appStatus={AppStatus.inaccessible} | ||
mounter={mounter} | ||
setAppLeaveHandler={setAppLeaveHandler} | ||
/> | ||
); | ||
|
||
expect(wrapper.text()).toContain('Application Not Found'); | ||
|
||
wrapper.setProps({ | ||
appId, | ||
setAppLeaveHandler, | ||
mounter, | ||
appStatus: AppStatus.accessible, | ||
}); | ||
wrapper.update(); | ||
|
||
expect(wrapper.text()).toEqual(''); | ||
|
||
resolvePromise(); | ||
await flushPromises(); | ||
wrapper.update(); | ||
|
||
expect(wrapper.text()).toContain('some-content'); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The main fix was to
setAppNotFound(false);
before awaiting formounter.mount
.I also extracted all the non-mount related code outside of
mount
function to execute all we can in a synchronous way (effects does not support async, so we are not effectively waiting formount
to resolve)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is starting to feel like a class component would be simpler to understand.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree. As discussed on slack, I think we should migrate back to class component next time we need to perform changing on this component. This may be when we'll want to show a proper loading message while awaiting the
mounter.mount
result.