@hubspot/cli 8.0.10-experimental.6 → 8.0.11-experimental.0

package/lib/doctor/DiagnosticInfoBuilder.js

@@ -0,0 +1,169 @@
+import { getProjectConfig } from '../projects/config.js';
+import { fetchProject } from '@hubspot/local-dev-lib/api/projects';
+import path from 'path';
+import { pkg } from '../jsonLoader.js';
+import { uiLogger } from '../ui/logger.js';
+import { isConfigFlagEnabled, getConfigFilePath, getConfigDefaultAccountIfExists, } from '@hubspot/local-dev-lib/config';
+import { CONFIG_FLAGS } from '@hubspot/local-dev-lib/constants/config';
+import { getDefaultAccountOverrideFilePath } from '@hubspot/local-dev-lib/config/defaultAccountOverride';
+import { getAccessToken } from '@hubspot/local-dev-lib/personalAccessKey';
+import { walk } from '@hubspot/local-dev-lib/fs';
+import util from 'util';
+import { exec as execAsync } from 'node:child_process';
+import { CMS_ASSETS_FILE, LEGACY_PRIVATE_APP_FILE, LEGACY_PUBLIC_APP_FILE, LEGACY_SERVERLESS_FILE, PROJECT_CONFIG_FILE, THEME_FILE, } from '../constants.js';
+import { METAFILE_EXTENSION } from '@hubspot/project-parsing-lib/constants';
+// This needs to be hardcoded since we are using it in the TS type
+const hubspotCli = '@hubspot/cli';
+const configFiles = [
+    LEGACY_SERVERLESS_FILE,
+    PROJECT_CONFIG_FILE,
+    LEGACY_PRIVATE_APP_FILE,
+    LEGACY_PUBLIC_APP_FILE,
+    THEME_FILE,
+    CMS_ASSETS_FILE,
+];
+export class DiagnosticInfoBuilder {
+    accountId;
+    configSettings;
+    env;
+    authType;
+    accountType;
+    personalAccessKey;
+    _projectConfig;
+    accessToken;
+    projectDetails;
+    files;
+    processInfo;
+    constructor(processInfo) {
+        const accountConfig = getConfigDefaultAccountIfExists();
+        this.accountId = accountConfig?.accountId;
+        this.configSettings = {
+            httpUseLocalhost: isConfigFlagEnabled(CONFIG_FLAGS.HTTP_USE_LOCALHOST),
+        };
+        this.env = accountConfig?.env;
+        this.authType = accountConfig?.authType;
+        this.accountType = accountConfig?.accountType;
+        this.personalAccessKey =
+            accountConfig && 'personalAccessKey' in accountConfig
+                ? accountConfig.personalAccessKey
+                : undefined;
+        this.processInfo = processInfo;
+    }
+    async generateDiagnosticInfo() {
+        this._projectConfig = await getProjectConfig();
+        if (this._projectConfig?.projectConfig) {
+            await this.fetchProjectDetails();
+            await this.fetchAccessToken();
+        }
+        if (this._projectConfig?.projectDir) {
+            await this.fetchProjectFilenames();
+        }
+        const { platform, arch, versions: { node }, mainModule, } = this.processInfo;
+        return {
+            platform,
+            arch,
+            path: mainModule?.path,
+            config: getConfigFilePath(),
+            defaultAccountOverrideFile: getDefaultAccountOverrideFilePath(),
+            configSettings: this.configSettings,
+            versions: {
+                [hubspotCli]: pkg.version,
+                node,
+                npm: await this.getNpmVersion(),
+            },
+            account: {
+                accountId: this.accountId,
+                accountType: this.accountType,
+                authType: this.authType,
+                name: this.accessToken?.hubName,
+                scopeGroups: this.accessToken?.scopeGroups,
+                enabledFeatures: this.accessToken?.enabledFeatures,
+            },
+            project: {
+                config: this._projectConfig,
+                details: this.projectDetails,
+            },
+            ...this.generateFilesArrays(),
+            files: this.files || [],
+        };
+    }
+    async fetchProjectDetails() {
+        try {
+            const { data } = await fetchProject(this.accountId, 
+            // We check that config exists before running this function
+            this._projectConfig.projectConfig.name);
+            this.projectDetails = data;
+        }
+        catch (e) {
+            uiLogger.debug(e);
+        }
+    }
+    async fetchAccessToken() {
+        try {
+            this.accessToken = await getAccessToken(this.personalAccessKey, this.env, this.accountId);
+        }
+        catch (e) {
+            uiLogger.debug(e);
+        }
+        return this.accessToken;
+    }
+    async fetchProjectFilenames() {
+        try {
+            // We check that projectDir exists before running this function
+            this.files = (await walk(this._projectConfig.projectDir, ['node_modules'])).map(filename => path.relative(this._projectConfig.projectDir, filename));
+        }
+        catch (e) {
+            uiLogger.debug(e);
+        }
+    }
+    async getNpmVersion() {
+        const exec = util.promisify(execAsync);
+        try {
+            const { stdout } = await exec('npm --version');
+            return stdout.toString().trim();
+        }
+        catch (e) {
+            uiLogger.debug(e);
+            return null;
+        }
+    }
+    generateFilesArrays() {
+        const output = {
+            files: this.files || [],
+            configFiles: [],
+            hsMetaFiles: [],
+            packageFiles: [],
+            packageLockFiles: [],
+            envFiles: [],
+            jsonFiles: [],
+        };
+        if (!this.files) {
+            return output;
+        }
+        return this.files.reduce((acc, file) => {
+            const { base } = path.parse(file);
+            if (base === 'package.json') {
+                acc.packageFiles.push(file);
+            }
+            else if (file.endsWith(METAFILE_EXTENSION)) {
+                acc.hsMetaFiles.push(file);
+            }
+            else if (configFiles.includes(base)) {
+                acc.configFiles.push(file);
+                if (file.endsWith('.json')) {
+                    acc.jsonFiles.push(file);
+                }
+            }
+            else if (base === 'package-lock.json') {
+                acc.packageLockFiles.push(file);
+            }
+            else if (file.endsWith('.env')) {
+                acc.envFiles.push(file);
+            }
+            else if (file.endsWith('.json')) {
+                acc.jsonFiles.push(file);
+            }
+            return acc;
+        }, output);
+    }
+}

package/lib/doctor/Doctor.d.ts

@@ -0,0 +1,35 @@
+import { DiagnosticInfoBuilder, DiagnosticInfo } from './DiagnosticInfoBuilder.js';
+export declare class Doctor {
+    accountId: number | null;
+    private diagnosis?;
+    private projectConfig?;
+    private diagnosticInfo?;
+    readonly diagnosticInfoBuilder: DiagnosticInfoBuilder;
+    constructor(diagnosticInfoBuilder?: DiagnosticInfoBuilder);
+    diagnose(): Promise<DiagnosticInfo>;
+    private performCliChecks;
+    private performNetworkingChecks;
+    private performProjectChecks;
+    private performCliConfigChecks;
+    private performDefaultAccountOverrideFileChecks;
+    private performCliConfigSettingsChecks;
+    private checkIfAccessTokenValid;
+    private checkIfNodeIsInstalled;
+    private checkIfNpmIsInstalled;
+    private checkCLIVersion;
+    private checkIfNpmInstallRequired;
+    private isValidJsonFile;
+    private checkProjectConfigJsonFiles;
+    private checkIfPortsAreAvailable;
+    private checkNetworkConnectivity;
+    private checkUrlEndpoints;
+    private checkWebhookEndpoints;
+    private extractWebhookUrls;
+    private checkAppRedirectUrls;
+    private extractAppRedirectUrls;
+    private validateProjectConfigWrapper;
+    private validateProjectSourceDirectory;
+    private validateProfiles;
+    private validateProjectWithoutProfile;
+    private checkProjectValidation;
+}