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

chore: Update CLI to utilize new error object. #1109

Merged
merged 9 commits into from
Aug 6, 2024
Merged
4 changes: 2 additions & 2 deletions packages/cli/bin/cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const chalk = require('chalk');

const { logger } = require('@hubspot/local-dev-lib/logger');
const { addUserAgentHeader } = require('@hubspot/local-dev-lib/http');
const { logErrorInstance } = require('../lib/errorHandlers/standardErrors');
const { logError } = require('../lib/errorHandlers/index');
const { setLogLevel, getCommandName } = require('../lib/commonOpts');
const {
trackHelpUsage,
Expand Down Expand Up @@ -71,7 +71,7 @@ const handleFailure = (msg, err, yargs) => {
if (msg) {
logger.error(msg);
} else if (err) {
logErrorInstance(err);
logError(err);
}

if (msg === null) {
Expand Down
12 changes: 5 additions & 7 deletions packages/cli/commands/accounts/clean.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,8 @@ const { promptUser } = require('../../lib/prompts/promptUtils');
const { getTableContents } = require('../../lib/ui/table');
const SpinniesManager = require('../../lib/ui/SpinniesManager');
const { getConfig, deleteAccount } = require('@hubspot/local-dev-lib/config');
const {
isSpecifiedHubSpotAuthError,
} = require('@hubspot/local-dev-lib/errors/apiErrors');
const { uiAccountDescription } = require('../../lib/ui');
const { isSpecifiedError } = require('@hubspot/local-dev-lib/errors/index');

const i18nKey = 'commands.accounts.subcommands.clean';

Expand Down Expand Up @@ -57,13 +55,13 @@ exports.handler = async options => {
await accessTokenForPersonalAccessKey(account.portalId);
} catch (error) {
if (
isSpecifiedHubSpotAuthError(error, {
status: 401,
isSpecifiedError(error, {
statusCode: 401,
category: 'INVALID_AUTHENTICATION',
subCategory: 'LocalDevAuthErrorType.PORTAL_NOT_ACTIVE',
}) ||
isSpecifiedHubSpotAuthError(error, {
status: 404,
isSpecifiedError(error, {
statusCode: 404,
category: 'INVALID_AUTHENTICATION',
subCategory: 'LocalDevAuthErrorType.INVALID_PORTAL_ID',
})
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/commands/auth.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ const { trackAuthAction, trackCommandUsage } = require('../lib/usageTracking');
const { authenticateWithOauth } = require('../lib/oauth');
const { EXIT_CODES } = require('../lib/enums/exitCodes');
const { uiFeatureHighlight } = require('../lib/ui');
const { logErrorInstance } = require('../lib/errorHandlers/standardErrors');
const { logError } = require('../lib/errorHandlers/index');

const i18nKey = 'commands.auth';

Expand Down Expand Up @@ -117,7 +117,7 @@ exports.handler = async options => {
env
);
} catch (e) {
logErrorInstance(e);
logError(e);
}

if (!updatedConfig) {
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/commands/cms/convertFields.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const {
} = require('@hubspot/local-dev-lib/cms/handleFieldsJS');

const { trackConvertFieldsUsage } = require('../../lib/usageTracking');
const { logErrorInstance } = require('../../lib/errorHandlers/standardErrors');
const { logError } = require('../../lib/errorHandlers/index');
const i18nKey = 'commands.convertFields';

exports.command = 'convert-fields';
Expand Down Expand Up @@ -59,7 +59,7 @@ exports.handler = async options => {
try {
filePaths = await walk(src);
} catch (e) {
logErrorInstance(e);
logError(e);
}
const allowedFilePaths = filePaths
.filter(file => {
Expand Down
8 changes: 3 additions & 5 deletions packages/cli/commands/create.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,7 @@
*/

const fs = require('fs-extra');
const {
logFileSystemErrorInstance,
} = require('../lib/errorHandlers/fileSystemErrors');
const { logError } = require('../lib/errorHandlers/index');
const { logger } = require('@hubspot/local-dev-lib/logger');
const { setLogLevel, getAccountId } = require('../lib/commonOpts');
const { logDebugInfo } = require('../lib/debugInfo');
Expand Down Expand Up @@ -87,9 +85,9 @@ exports.handler = async options => {
path: dest,
})
);
logFileSystemErrorInstance(e, {
logError(e, {
filepath: dest,
write: true,
operation: 'write',
});
return;
}
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/commands/create/function.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ const { createFunction } = require('@hubspot/local-dev-lib/cms/functions');
const {
createFunctionPrompt,
} = require('../../lib/prompts/createFunctionPrompt');
const { logErrorInstance } = require('../../lib/errorHandlers/standardErrors');
const { logError } = require('../../lib/errorHandlers/index');
const { EXIT_CODES } = require('../../lib/enums/exitCodes');

module.exports = {
Expand All @@ -12,7 +12,7 @@ module.exports = {
try {
await createFunction(functionDefinition, dest);
} catch (e) {
logErrorInstance(e);
logError(e);
process.exit(EXIT_CODES.ERROR);
}
},
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/commands/create/module.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ const { logger } = require('@hubspot/local-dev-lib/logger');
const { createModule } = require('@hubspot/local-dev-lib/cms/modules');
const { i18n } = require('../../lib/lang');
const { createModulePrompt } = require('../../lib/prompts/createModulePrompt');
const { logErrorInstance } = require('../../lib/errorHandlers/standardErrors');
const { logError } = require('../../lib/errorHandlers/index');
const { EXIT_CODES } = require('../../lib/enums/exitCodes');

const i18nKey = 'commands.create.subcommands.module';
Expand All @@ -21,7 +21,7 @@ module.exports = {
try {
await createModule(moduleDefinition, name, dest, getInternalVersion);
} catch (e) {
logErrorInstance(e);
logError(e);
process.exit(EXIT_CODES.ERROR);
}
},
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/commands/create/template.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
const { createTemplate } = require('@hubspot/local-dev-lib/cms/templates');
const { logger } = require('@hubspot/local-dev-lib/logger');
const { logErrorInstance } = require('../../lib/errorHandlers/standardErrors');
const { logError } = require('../../lib/errorHandlers/index');
const {
createTemplatePrompt,
} = require('../../lib/prompts/createTemplatePrompt');
Expand All @@ -24,7 +24,7 @@ module.exports = {
try {
await createTemplate(name, dest, templateType);
} catch (e) {
logErrorInstance(e);
logError(e);
process.exit(EXIT_CODES.ERROR);
}
return { templateType };
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/commands/customObject/create.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const { logger } = require('@hubspot/local-dev-lib/logger');
const { logApiErrorInstance } = require('../../lib/errorHandlers/apiErrors');
const { logError } = require('../../lib/errorHandlers/index');
const { getAbsoluteFilePath } = require('@hubspot/local-dev-lib/path');
const {
checkAndConvertToJson,
Expand Down Expand Up @@ -38,7 +38,7 @@ exports.handler = async options => {
await batchCreateObjects(accountId, name, objectJson);
logger.success(i18n(`${i18nKey}.success.objectsCreated`));
} catch (e) {
logApiErrorInstance(e, { accountId });
logError(e, { accountId });
logger.error(
i18n(`${i18nKey}.errors.creationFailed`, {
definition,
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/commands/customObject/schema/create.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const { logger } = require('@hubspot/local-dev-lib/logger');
const { logApiErrorInstance } = require('../../../lib/errorHandlers/apiErrors');
const { logError } = require('../../../lib/errorHandlers/index');
const { getAbsoluteFilePath } = require('@hubspot/local-dev-lib/path');
const {
checkAndConvertToJson,
Expand Down Expand Up @@ -64,7 +64,7 @@ exports.handler = async options => {
);
}
} catch (e) {
logApiErrorInstance(e, { accountId });
logError(e, { accountId });
logger.error(
i18n(`${i18nKey}.errors.creationFailed`, {
definition,
Expand Down
5 changes: 2 additions & 3 deletions packages/cli/commands/customObject/schema/delete.js
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
const { logger } = require('@hubspot/local-dev-lib/logger');
const { logApiErrorInstance } = require('../../../lib/errorHandlers/apiErrors');

const { loadAndValidateOptions } = require('../../../lib/validation');
const { trackCommandUsage } = require('../../../lib/usageTracking');
const { getAccountId } = require('../../../lib/commonOpts');
const {
deleteObjectSchema,
} = require('@hubspot/local-dev-lib/api/customObjects');
const { i18n } = require('../../../lib/lang');
const { logError } = require('../../../lib/errorHandlers');

const i18nKey = 'commands.customObject.subcommands.schema.subcommands.delete';

Expand All @@ -31,7 +30,7 @@ exports.handler = async options => {
})
);
} catch (e) {
logApiErrorInstance(e);
logError(e);
logger.error(
i18n(`${i18nKey}.errors.delete`, {
name,
Expand Down
7 changes: 2 additions & 5 deletions packages/cli/commands/customObject/schema/fetch-all.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
const { logger } = require('@hubspot/local-dev-lib/logger');
const {
logErrorInstance,
} = require('../../../lib/errorHandlers/standardErrors');

const { loadAndValidateOptions } = require('../../../lib/validation');
const { trackCommandUsage } = require('../../../lib/usageTracking');
const { getAccountId } = require('../../../lib/commonOpts');
Expand All @@ -12,6 +8,7 @@ const {
} = require('@hubspot/local-dev-lib/customObjects');
const { i18n } = require('../../../lib/lang');
const { logSchemas } = require('../../../lib/schema');
const { logError } = require('../../../lib/errorHandlers');

const i18nKey = 'commands.customObject.subcommands.schema.subcommands.fetchAll';

Expand All @@ -34,7 +31,7 @@ exports.handler = async options => {
})
);
} catch (e) {
logErrorInstance(e);
logError(e);
logger.error(i18n(`${i18nKey}.errors.fetch`));
}
};
Expand Down
6 changes: 2 additions & 4 deletions packages/cli/commands/customObject/schema/fetch.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
const path = require('path');
const { isConfigFlagEnabled } = require('@hubspot/local-dev-lib/config');
const { logger } = require('@hubspot/local-dev-lib/logger');
const {
logErrorInstance,
} = require('../../../lib/errorHandlers/standardErrors');
const { CONFIG_FLAGS } = require('../../../lib/constants');
const {
downloadSchema,
Expand All @@ -16,6 +13,7 @@ const { loadAndValidateOptions } = require('../../../lib/validation');
const { trackCommandUsage } = require('../../../lib/usageTracking');
const { getAccountId } = require('../../../lib/commonOpts');
const { i18n } = require('../../../lib/lang');
const { logError } = require('../../../lib/errorHandlers');

const i18nKey = 'commands.customObject.subcommands.schema.subcommands.fetch';

Expand Down Expand Up @@ -50,7 +48,7 @@ exports.handler = async options => {
);
}
} catch (e) {
logErrorInstance(e);
logError(e);
logger.error(
i18n(`${i18nKey}.errors.fetch`, {
name,
Expand Down
6 changes: 2 additions & 4 deletions packages/cli/commands/customObject/schema/list.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
const { logger } = require('@hubspot/local-dev-lib/logger');
const {
logErrorInstance,
} = require('../../../lib/errorHandlers/standardErrors');
const { logError } = require('../../../lib/errorHandlers/index');

const { loadAndValidateOptions } = require('../../../lib/validation');
const { trackCommandUsage } = require('../../../lib/usageTracking');
Expand All @@ -24,7 +22,7 @@ exports.handler = async options => {
try {
await listSchemas(accountId);
} catch (e) {
logErrorInstance(e);
logError(e);
logger.error(i18n(`${i18nKey}.errors.list`));
}
};
4 changes: 2 additions & 2 deletions packages/cli/commands/customObject/schema/update.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const { logger } = require('@hubspot/local-dev-lib/logger');
const { logApiErrorInstance } = require('../../../lib/errorHandlers/apiErrors');
const { logError } = require('../../../lib/errorHandlers/index');
const { getAbsoluteFilePath } = require('@hubspot/local-dev-lib/path');
const {
ENVIRONMENTS,
Expand Down Expand Up @@ -64,7 +64,7 @@ exports.handler = async options => {
);
}
} catch (e) {
logApiErrorInstance(e, { accountId });
logError(e, { accountId });
logger.error(
i18n(`${i18nKey}.errors.update`, {
definition,
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/commands/fetch.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const { i18n } = require('../lib/lang');

const i18nKey = 'commands.fetch';
const { EXIT_CODES } = require('../lib/enums/exitCodes');
const { logErrorInstance } = require('../lib/errorHandlers/standardErrors');
const { logError } = require('../lib/errorHandlers/index');

exports.command = 'fetch <src> [dest]';
exports.describe = i18n(`${i18nKey}.describe`);
Expand Down Expand Up @@ -50,7 +50,7 @@ exports.handler = async options => {
options
);
} catch (err) {
logErrorInstance(err);
logError(err);
process.exit(EXIT_CODES.ERROR);
}
};
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/commands/filemanager/fetch.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ const { i18n } = require('../../lib/lang');

const i18nKey = 'commands.filemanager.subcommands.fetch';
const { EXIT_CODES } = require('../../lib/enums/exitCodes');
const { logErrorInstance } = require('../../lib/errorHandlers/standardErrors');
const { logError } = require('../../lib/errorHandlers/index');

exports.command = 'fetch <src> [dest]';
exports.describe = i18n(`${i18nKey}.describe`);
Expand Down Expand Up @@ -44,7 +44,7 @@ exports.handler = async options => {
includeArchived || false
);
} catch (err) {
logErrorInstance(err);
logError(err);
process.exit(EXIT_CODES.ERROR);
}
};
Expand Down
10 changes: 3 additions & 7 deletions packages/cli/commands/filemanager/upload.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,7 @@ const {
} = require('@hubspot/local-dev-lib/cms/modules');
const { shouldIgnoreFile } = require('@hubspot/local-dev-lib/ignoreRules');

const {
ApiErrorContext,
logApiUploadErrorInstance,
} = require('../../lib/errorHandlers/apiErrors');
const { logErrorInstance } = require('../../lib/errorHandlers/standardErrors');
const { ApiErrorContext, logError } = require('../../lib/errorHandlers/index');
const {
addConfigOptions,
addAccountOptions,
Expand Down Expand Up @@ -106,7 +102,7 @@ exports.handler = async options => {
src,
})
);
logApiUploadErrorInstance(
logError(
error,
new ApiErrorContext({
accountId,
Expand All @@ -133,7 +129,7 @@ exports.handler = async options => {
})
.catch(error => {
logger.error(i18n(`${i18nKey}.errors.uploadingFailed`));
logErrorInstance(error, {
logError(error, {
accountId,
});
});
Expand Down
Loading
Loading