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

fix: add links to .NET Core SDK to publish error #3011

Merged
merged 14 commits into from
May 13, 2020
Merged
Show file tree
Hide file tree
Changes from 5 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
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,18 @@ import { Callout } from 'office-ui-fabric-react/lib/Callout';
import { Stack } from 'office-ui-fabric-react/lib/Stack';
import { PrimaryButton, DefaultButton } from 'office-ui-fabric-react/lib/Button';

import { calloutLabel, calloutDescription, calloutContainer } from './styles';
import { calloutLabel, calloutDescription, calloutContainer, calloutLink } from './styles';
export interface IErrorCalloutProps {
onDismiss: () => void;
onTry: () => void;
target: React.RefObject<Element> | null;
visible: boolean;
error: { title: string; message: string };
error: {
title: string;
message: string;
link?: { url: string; text: string };
linkAfterMessage?: { url: string; text: string };
};
}

export const ErrorCallout: React.FC<IErrorCalloutProps> = props => {
Expand All @@ -34,8 +39,20 @@ export const ErrorCallout: React.FC<IErrorCalloutProps> = props => {
{error.title}
</p>
<p css={calloutDescription} id="callout-description-id">
{error.message}
{error.message + ' '}
{error.linkAfterMessage != null && (
<a href={error.linkAfterMessage.url} id="callout-description-id">
{error.linkAfterMessage.text}
</a>
)}
</p>
{error.link != null && (
<p css={calloutLink}>
<a href={error.link.url} id="callout-description-id">
{error.link.text}
</a>
</p>
)}
<Stack
horizontal
tokens={{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,8 @@ export const calloutContainer = css`
export const calloutDescription = css``;

export const calloutAction = css``;

export const calloutLink = css`
margin-top: 24px;
margin-bottom: 24px;
`;
2 changes: 2 additions & 0 deletions Composer/packages/client/src/constants/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ export enum ActionTypes {
GET_PUBLISH_TYPES_SUCCESS = 'GET_PUBLISH_TYPES_SUCCESS',
PUBLISH_SUCCESS = 'PUBLISH_SUCCESS',
PUBLISH_FAILED = 'PUBLISH_FAILED',
PUBLISH_FAILED_DOTNET = 'PUBLISH_FAILED_DOTNET',
GET_PUBLISH_STATUS = 'GET_PUBLISH_STATUS',
GET_PUBLISH_STATUS_FAILED = 'GET_PUBLISH_STATUS_FAILED',
GET_PUBLISH_HISTORY = 'GET_PUBLISH_HISTORY',
Expand Down Expand Up @@ -125,6 +126,7 @@ export const Text = {
LUISDEPLOYSUCCESS: formatMessage('Congratulations! Your model is successfully published.'),
LUISDEPLOYFAILURE: formatMessage('Sorry, something went wrong with publishing. Try again or exit out of this task.'),
CONNECTBOTFAILURE: formatMessage('Sorry, something went wrong with connecting bot runtime'),
DOTNETFAILURE: formatMessage('Composer needs .NET Core SDK'),
};

export enum LuisConfig {
Expand Down
37 changes: 29 additions & 8 deletions Composer/packages/client/src/store/action/publisher.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

import { ActionCreator } from '../types';
import formatMessage from 'format-message';

import { ActionCreator } from '../types';
import { ActionTypes } from './../../constants/index';
import httpClient from './../../utils/httpUtil';

Expand Down Expand Up @@ -37,13 +38,33 @@ export const publishToTarget: ActionCreator = async ({ dispatch }, projectId, ta
},
});
} catch (err) {
dispatch({
type: ActionTypes.PUBLISH_FAILED,
payload: {
error: err.response.data,
target: target,
},
});
// special case to handle dotnet issues
if (/dotnet/.test(err.response?.data?.message as string)) {
dispatch({
type: ActionTypes.PUBLISH_FAILED_DOTNET,
payload: {
error: {
message: formatMessage('To run this bot, Composer needs .NET Core SDK.'),
linkAfterMessage: {
text: formatMessage('Learn more.'),
url: 'https://docs.microsoft.com/en-us/composer/setup-yarn',
},
link: {
text: formatMessage('Install Microsoft .NET Core SDK'),
url: 'https://dotnet.microsoft.com/download/dotnet-core/3.1',
},
},
target: target,
},
});
} else
dispatch({
type: ActionTypes.PUBLISH_FAILED,
payload: {
error: err.response.data,
target: target,
},
});
}
};

Expand Down
8 changes: 5 additions & 3 deletions Composer/packages/client/src/store/reducer/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -450,10 +450,11 @@ const publishSuccess: ReducerFunc = (state, payload) => {
return state;
};

const publishFailure: ReducerFunc = (state, { error, target }) => {
const publishFailure: (title: string) => ReducerFunc = title => (state, { error, target }) => {
if (target.name === 'default') {
state.botStatus = BotStatus.failed;
state.botLoadErrorMsg = { title: Text.CONNECTBOTFAILURE, message: error.message };

state.botLoadErrorMsg = { ...error, title };
}
// prepend the latest publish results to the history
if (!state.publishHistory[target.name]) {
Expand Down Expand Up @@ -630,7 +631,8 @@ export const reducer = createReducer({
[ActionTypes.USER_SESSION_EXPIRED]: setUserSessionExpired,
[ActionTypes.GET_PUBLISH_TYPES_SUCCESS]: setPublishTypes,
[ActionTypes.PUBLISH_SUCCESS]: publishSuccess,
[ActionTypes.PUBLISH_FAILED]: publishFailure,
[ActionTypes.PUBLISH_FAILED]: publishFailure(Text.CONNECTBOTFAILURE),
[ActionTypes.PUBLISH_FAILED_DOTNET]: publishFailure(Text.DOTNETFAILURE),
[ActionTypes.GET_PUBLISH_STATUS]: getPublishStatus,
[ActionTypes.GET_PUBLISH_STATUS_FAILED]: getPublishStatus,
[ActionTypes.GET_PUBLISH_HISTORY]: getPublishHistory,
Expand Down
7 changes: 6 additions & 1 deletion Composer/packages/client/src/store/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,12 @@ export interface State {
storages: any[];
focusedStorageFolder: StorageFolder;
botStatus: BotStatus;
botLoadErrorMsg: { title: string; message: string };
botLoadErrorMsg: {
title: string;
message: string;
linkAfterMessage?: { url: string; text: string };
link?: { url: string; text: string };
};
creationFlowStatus: CreationFlowStatus;
templateId: string;
storageFileLoadingStatus: string;
Expand Down
1 change: 1 addition & 0 deletions Composer/packages/server/src/controllers/publisher.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ export const PublishController = {
// set status and return value as json
res.status(results.status).json(response);
} catch (err) {
console.error('Publishing error: ' + err.message);
Copy link
Contributor

Choose a reason for hiding this comment

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

this is not exactly what I meant, since this is just going to say
"failed to run dotnet build"

we can attach to the spawned child process and output the errors it generates to get more detail.

Copy link
Contributor

Choose a reason for hiding this comment

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

the actual exec happens inside the localPublish plugin.

res.status(400).json({
statusCode: '400',
message: err.message,
Expand Down