Config Revamp #231

camden11 · 2025-02-03T21:45:11Z

Description and Context

This PR rebuilds the config module from the ground up. The new config module has a variety of improvements over the old one:

Combines the functionality of the old config/config and config/CLIConfiguration into a single file.
Supports both global and local config files
Reads configs with both the current account fields and deprecated portal fields, but converts them into a standardized format (no need to check portalId vs accountId anymore)
No longer loads config files into a JS object instance - instead treats the config file as the single source of truth. This means we will no longer run into issues when different dependencies of the CLI use different LDL vesions
Safer and more usable type system - most functions are guaranteed to return the expected type (or throw) and more fields on the HubSpotConfig and HubSpotConfigAccount types are guaranteed to exist. No more checking for null and undefined everywhere!
Renames many functions for clarity
Simpler, more streamlined setup within the repo - there are now only ~~two~~ three config files (added one for defaultAccountOverride stuff), down from five. config/index contains all exported functionality, and config/utils contains all non-exported helper functions
... and probably more that I'm not thinking of

Note: the majority of new functionality is in config/index and config/utils, both of which are hidden by default

TODO

This will require a substantial update to the CLI to maintain compatibility with the breaking changes here
- WIP PR: https://github.com/HubSpot/hubspot-cli/pull/1392/files
~~I haven't yet merged in the account override work since it appears to still be in flux. Will be working with @kemmerle on that.~~ Default account override functionality added
There are still a few exported instances in LDL, namely OAuth2Manager and logger. We will need to take care of those too, but I figured this PR is big enough as is

Who to Notify

@joe-yeager @brandenrodgers @kemmerle

camden11 · 2025-02-12T18:35:17Z

config/README.md

+
+Returns config data for a specific account, given the account's ID or name.

 ## Example config


I updated the existing content of the readme to reflect the changes I made, but it may make sense to rethink it completely

Yeah good call. That could always be done as a follow up

camden11 · 2025-02-12T18:36:59Z

config/index.ts

@@ -1,268 +1,406 @@
-import * as config_DEPRECATED from './config_DEPRECATED';


This file is more or less net new, but because it has the same name as the old one, GH is showing a diff.

camden11 · 2025-02-12T18:39:29Z

config/index.ts

-  }
-  return config_DEPRECATED.deleteEmptyConfigFile();
+export function getConfigFilePath(): string {
+  const { configFilePathFromEnvironment } = getConfigPathEnvironmentVariables();


getConfigFilePath checks for a HUBSPOT_CONFIG_PATH environment variable if the user is using a custom path - this variable will need to be set by the CLI if the user passes in the --config flag

camden11 · 2025-02-12T18:41:18Z

config/index.ts

-  if (CLIConfiguration.isActive()) {
-    return CLIConfiguration.config;
+export function getConfig(): HubSpotConfig {
+  const { useEnvironmentConfig } = getConfigPathEnvironmentVariables();


Same with environment config - a user passes in the --use-env flag to the CLI, the CLI should set the USE_ENVIRONMENT_CONFIG env variable to tell LDL to use environment variables. These new environment variables let us avoid needing to have configPath and useEnv arguments for every function that accesses the config

Is this (and the HUBSPOT_CONFIG_PATH) documented anywhere? It makes sense in terms of implementation, but it wouldn't be obvious behavior to someone coming into this.

Good call, I can add something to the readme for these. On the CLI side, we'll be setting these automatically when users use --use-env or --config paths so nothing should change there

camden11 · 2025-02-12T18:45:04Z

config/index.ts

-  } else {
-    config_DEPRECATED.updateHttpTimeout(timeout);
+export function updateConfigAccount(
+  updatedAccount: HubSpotConfigAccount


This function now accepts a full updated account rather than just fields to update. This makes it easier to use TS to confirm that updates are valid (for example, TS would have no way to know the auth type of the account you're trying to update, and therefore would allow updating accounts to have invalid auth)

camden11 · 2025-02-12T18:45:30Z

config/index.ts

+export function updateConfigAccount(
+  updatedAccount: HubSpotConfigAccount
+): void {
+  if (!isConfigAccountValid(updatedAccount)) {


We still manually check validity just in case though!

brandenrodgers · 2025-11-18T16:28:29Z

config/defaultAccountOverride.ts

+        hsAccountFile: defaultAccountOverrideFilePath,
+      }),
+      {
+        // TODO: This is improper use of cause, we should create a custom error class


Do these todos need to be addressed before merging?

I think they can be addressed separately. This is from existing code that I ported over to this new file - I just wanted to call it out so we remember to get around to it at some point

brandenrodgers · 2025-11-18T16:52:24Z

config/README.md

+#### getConfig()

-Locates, parses, and stores the `hubspot.config.yml` file in memory. This should be the first thing that you do if you plan to access any of the config file values. If the config has already been loaded, this function will simply return the already-parsed config values.
+Locates and parses the hubspot config file. This function will automatically find the correct config file. Typically, it defaults to the nearest config file by working up the direcotry tree. Custom config locations can be set using the following environment variables


This part "Typically, it defaults to the nearest config file by working up the direcotry tree." is only true if the user doesn't also have a global config file. If they have a global config, we'll prioritize using that one.

Good catch, will update that

camden11 · 2025-11-18T17:20:03Z

Updated the docs to more clearly explain the environment variable options + behavior of getConfig

config/index.ts

joe-yeager · 2025-11-19T17:12:07Z

config/index.ts

-export function loadConfigFromEnvironment(): boolean {
-  if (CLIConfiguration.isActive()) {
-    return CLIConfiguration.useEnvConfig;
+  if (fs.existsSync(globalConfigFilePath)) {


I wonder if we should be catching and wrapping these in the new HubSpotConfigError and providing more context

fs.existsSync doesn't throw

It can if there are access issues

config/index.ts

config/utils.ts

types/Config.ts

camden11 added 23 commits January 31, 2025 15:06

config revamp WIP

cee8aac

finish getConfig

b252721

more config WIP

4595dc5

more config WIP

29d26ba

config wip

63b55fa

-wip

9ab3c88

update handling of env config

7404320

Update accounts

93c27be

config account adding/updating

d521932

finish config exportable first pass

fc6ca45

add back missing methods we might need

c715602

handle new environment variables

06669df

Add config source options to environment

2492289

Cleanup wip

258be5e

Fix TS build

05699b3

remove unneeded types

930ac75

configUtils tests

b541617

Config WIP

e415848

Finish tests for config

5cb2fa0

Delete old tests

e85f998

update PAK tests

6ec40b3

Fix existing tests

59152d2

Add error and debug copy to new config methods

c0cdc17

camden11 changed the title ~~Dynamic config~~ Config Revamp Feb 12, 2025

camden11 commented Feb 12, 2025

View reviewed changes

camden11 requested review from brandenrodgers and joe-yeager November 17, 2025 21:30

brandenrodgers reviewed Nov 18, 2025

View reviewed changes

Update config readme

221ff2b

joe-yeager reviewed Nov 19, 2025

View reviewed changes

joe-yeager and others added 3 commits November 19, 2025 11:50

Fix bug with account creation not adding to config

acfee0f

More robust error handling

062aa9a

Fix updateConfigWithPersonalAccessKey again

eaf7883

camden11 force-pushed the dynamic-config branch from 5f3bc4b to eaf7883 Compare November 19, 2025 21:25

camden11 added 4 commits November 19, 2025 16:28

Merge branch 'main' into dynamic-config

26b0b69

only delete config file if empty

5f8df4e

Fix deleteConfigFileIfEmpty

56ace63

export getLocalConfigFilePath and getGlobalConfigFilePath

c1e6e04

camden11 force-pushed the dynamic-config branch from c4cd7ad to c1e6e04 Compare November 20, 2025 18:01

camden11 added 12 commits November 20, 2025 13:26

Fix some migrate bugs

0eb86da

Fix tests

ff10935

Fix migrate conflict bug

2eacdae

Fix bug in updateConfigWithAccessToken

fd5c85e

Update config validation

67d7630

Fix bug with validateConfig

5f50750

Update error copy

f9c7313

Fix bug in validateConfig

6166648

Make getConfigAccountByInferredIdentifier more robust

d1c303e

Allow custom cwd for getLocalConfigFilePath

0306b9d

Don't need custom cwd

0e17f07

Fix tests

4785230

joe-yeager approved these changes Nov 21, 2025

View reviewed changes

camden11 merged commit 85af656 into main Nov 21, 2025
1 check passed


		Returns config data for a specific account, given the account's ID or name.

		## Example config

		@@ -1,268 +1,406 @@
		import * as config_DEPRECATED from './config_DEPRECATED';

Config Revamp #231

Config Revamp #231

Uh oh!

Conversation

camden11 commented Feb 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description and Context

TODO

Who to Notify

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

brandenrodgers Nov 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

camden11 commented Nov 18, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

camden11 commented Feb 3, 2025 •

edited

Loading

brandenrodgers Nov 18, 2025 •

edited

Loading