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.

Sign up for GitHub

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

Jump to bottom

Handle case where an error occurs of any type when attempting to get page layout for missing objects. #61

Merged
merged 3 commits into from
Feb 20, 2024
Merged

Handle case where an error occurs of any type when attempting to get page layout for missing objects. #61

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d10c2dd
Refactored to return an error in callback.
dbreese Feb 20, 2024
7c0fa69
Adding more tests.
dbreese Feb 20, 2024
911baf8
Updating error to be more visible.
dbreese Feb 20, 2024
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
13 changes: 13 additions & 0 deletions resources/instructions/createSObjectLwcQuickActions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,10 @@ <h1>Create sObject LWC Quick Actions</h1>
</tbody>
</table>

<div id="errorDiv">
maliroteh-sf marked this conversation as resolved.
Show resolved Hide resolved
<!-- placeholder for any error messages -->
</div>

<label
style="display: block; margin-top: 10px; margin-bottom: 8px"
for="generateLwcQuickActionsButton"
Expand All @@ -81,6 +85,8 @@ <h1>Create sObject LWC Quick Actions</h1>
'quickActionStatusTable'
);

const errorDiv = document.getElementById('errorDiv');

generateQuickActionsButtonElement.addEventListener('click', () => {
webviewMessaging.sendMessageRequest(
'generateLwcQuickActions',
Expand All @@ -105,6 +111,13 @@ <h1>Create sObject LWC Quick Actions</h1>
});

function handleQuickActionStatusResponse(response) {
// check for an error
errorDiv.innerHTML = '';
if (response.error != undefined) {
errorDiv.innerHTML = 'An error occurred: ' + response.error;
return;
}

var tbody =
quickActionStatusTable.getElementsByTagName('tbody')[0];

Expand Down
193 changes: 109 additions & 84 deletions src/commands/wizard/lwcGenerationCommand.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,12 @@ export type QuickActionStatus = {
};

export type SObjectQuickActionStatus = {
error?: string;
sobjects: {
[name: string]: QuickActionStatus;
};
};

export type GetSObjectsStatus = {
error?: string;
sobjects: string[];
};

Expand All @@ -54,17 +52,29 @@ export class LwcGenerationCommand {
type: 'generateLwcQuickActions',
action: async (_panel, _data, callback) => {
const quickActionStatus =
await LwcGenerationCommand.checkForExistingQuickActions();
await LwcGenerationCommand.checkForExistingQuickActions().catch(
(error) => {
if (callback) {
callback({ error: error });
}
return;
}
);

const newLwcQuickActionStatus =
await LwcGenerationCommand.generateMissingLwcsAndQuickActions(
extensionUri,
quickActionStatus
);
quickActionStatus!
).catch((error) => {
if (callback) {
callback({ error: error });
}
return;
});

// send back updates so UI can be refreshed
if (callback) {
callback(newLwcQuickActionStatus);
callback(newLwcQuickActionStatus!);
}
}
},
Expand All @@ -73,8 +83,13 @@ export class LwcGenerationCommand {
action: async (_panel, _data, callback) => {
if (callback) {
const quickActionStatus =
await LwcGenerationCommand.checkForExistingQuickActions();
callback(quickActionStatus);
await LwcGenerationCommand.checkForExistingQuickActions().catch(
(error) => {
callback({ error: error });
return;
}
);
callback(quickActionStatus!);
}
}
}
Expand All @@ -84,7 +99,7 @@ export class LwcGenerationCommand {
}

static async getSObjectsFromLandingPage(): Promise<GetSObjectsStatus> {
return new Promise<GetSObjectsStatus>(async (resolve) => {
return new Promise<GetSObjectsStatus>(async (resolve, reject) => {
const staticResourcesPath =
await WorkspaceUtils.getStaticResourcesDir();
const landingPageJson = 'landing_page.json';
Expand All @@ -101,107 +116,117 @@ export class LwcGenerationCommand {
await access(landingPagePath);
const uem = CommonUtils.loadJsonFromFile(landingPagePath);
getSObjectsStatus.sobjects = UEMParser.findSObjects(uem);
resolve(getSObjectsStatus);
} catch (err) {
console.warn(
`File '${landingPageJson}' does not exist at '${staticResourcesPath}'.`
);
getSObjectsStatus.error = (err as Error).message;
reject((err as Error).message);
}

resolve(getSObjectsStatus);
});
}

static async checkForExistingQuickActions(): Promise<SObjectQuickActionStatus> {
return new Promise<SObjectQuickActionStatus>(async (resolve) => {
const results: SObjectQuickActionStatus = { sobjects: {} };
return new Promise<SObjectQuickActionStatus>(
Copy link
Collaborator

Choose a reason for hiding this comment

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

It looks like only the formatting changed. Was it by running prettier?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This file changed mostly because of prettier, but also because the lines grew in length some because I added the reject block to the Promise.

async (resolve, reject) => {
const results: SObjectQuickActionStatus = { sobjects: {} };

const sObjectsStatus =
await this.getSObjectsFromLandingPage().catch((error) => {
return reject(error);
});

sObjectsStatus!.sobjects.forEach((sobject) => {
const quickActionStatus: QuickActionStatus = {
view: false,
edit: false,
create: false
};
quickActionStatus.view =
LwcGenerationCommand.checkForExistingQuickAction(
sobject,
'view'
);
quickActionStatus.edit =
LwcGenerationCommand.checkForExistingQuickAction(
sobject,
'edit'
);
quickActionStatus.create =
LwcGenerationCommand.checkForExistingQuickAction(
sobject,
'create'
);

results.sobjects[sobject] = quickActionStatus;
});

const sObjectsStatus = await this.getSObjectsFromLandingPage();
if (sObjectsStatus.error) {
results.error = sObjectsStatus.error;
return resolve(results);
}

sObjectsStatus.sobjects.forEach((sobject) => {
const quickActionStatus: QuickActionStatus = {
view: false,
edit: false,
create: false
};
quickActionStatus.view =
LwcGenerationCommand.checkForExistingQuickAction(
sobject,
'view'
);
quickActionStatus.edit =
LwcGenerationCommand.checkForExistingQuickAction(
sobject,
'edit'
);
quickActionStatus.create =
LwcGenerationCommand.checkForExistingQuickAction(
sobject,
'create'
);

results.sobjects[sobject] = quickActionStatus;
});

return resolve(results);
});
);
}

static async generateMissingLwcsAndQuickActions(
extensionUri: Uri,
quickActionStatus: SObjectQuickActionStatus
): Promise<SObjectQuickActionStatus> {
return new Promise<SObjectQuickActionStatus>(async (resolve) => {
for (const sobject in quickActionStatus.sobjects) {
try {
const quickActions = quickActionStatus.sobjects[sobject];

if (
!quickActions.create ||
!quickActions.edit ||
!quickActions.view
) {
// at least 1 needs to be created
const compactLayoutFields =
await OrgUtils.getCompactLayoutFieldsForSObject(
sobject
return new Promise<SObjectQuickActionStatus>(
async (resolve, reject) => {
for (const sobject in quickActionStatus.sobjects) {
try {
const quickActions =
quickActionStatus.sobjects[sobject];

if (
!quickActions.create ||
!quickActions.edit ||
!quickActions.view
) {
// at least 1 needs to be created
const compactLayoutFields =
await OrgUtils.getCompactLayoutFieldsForSObject(
sobject
).catch((err) => {
reject(
`An error occurred while obtaining layout for ${sobject} : ${
(err as Error).message
}`
);
return;
});

const codeBuilder = new CodeBuilder(
extensionUri,
sobject,
compactLayoutFields!
);

const codeBuilder = new CodeBuilder(
extensionUri,
sobject,
compactLayoutFields
);

if (!quickActions.view) {
await codeBuilder.generateView();
}
if (!quickActions.view) {
await codeBuilder.generateView();
}

if (!quickActions.edit) {
await codeBuilder.generateEdit();
}
if (!quickActions.edit) {
await codeBuilder.generateEdit();
}

if (!quickActions.create) {
await codeBuilder.generateCreate();
if (!quickActions.create) {
await codeBuilder.generateCreate();
}
}
} catch (err) {
console.error(
`Could not generate quick actions for sobject ${sobject}, so skipping`,
err
);
}
} catch (err) {
console.error(
`Could not generate quick actions for sobject ${sobject}, so skipping`,
err
);
}
}

// Just double check now that things have been created.
const newStatus =
await LwcGenerationCommand.checkForExistingQuickActions();
resolve(newStatus);
});
// Just double check now that things have been created.
const newStatus =
await LwcGenerationCommand.checkForExistingQuickActions();
resolve(newStatus);
}
);
}

private static checkForExistingQuickAction(
Expand Down
Loading
Loading