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

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-02-12T21:35:22Z

constants/config.ts

+  HTTP_USE_LOCALHOST: 'HTTP_USE_LOCALHOST',
+  ALLOW_USAGE_TRACKING: 'ALLOW_USAGE_TRACKING',
+  DEFAULT_CMS_PUBLISH_MODE: 'DEFUALT_CMS_PUBLISH_MODE',
+  USE_ENVIRONMENT_CONFIG: 'USE_ENVIRONMENT_CONFIG',


Slight nit, but does it make sense for USE_ENVIRONMENT_CONFIG to include "hubspot" in the name somewhere? It doesn't matter a ton if the CLI is setting it, but I imagine people can also manually set this if they want to.

brandenrodgers · 2025-02-12T21:37:58Z

config/utils.ts

+
+export function getConfigAccountIndexById(
+  accounts: Array<HubSpotConfigAccount>,
+  id: string | number


Is it possible for accountId to be anything except for a number in this new format?

Good catch, this should just be number

brandenrodgers · 2025-02-12T21:39:00Z

config/utils.ts

+
+  return {
+    identifier: isId ? identifierAsNumber : accountIdentifier,
+    identifierType: isId ? 'accountId' : 'name',


Not a blocker, but could it potentially prevent some future pain by making these identifiers constants?

brandenrodgers · 2025-02-12T21:54:42Z

config/__tests__/utils.test.ts

+  describe('writeConfigFile()', () => {
+    it('writes formatted config to file', () => {
+      // eslint-disable-next-line @typescript-eslint/no-empty-function
+      mockFs.ensureFileSync.mockImplementation(() => {});


Not a blocker, but you could get rid of the ignores if you make these return undefined instead

camden11 · 2025-02-12T22:12:57Z

config/defaultAccountOverride.ts

+} from '../constants/config';
+import { i18n } from '../utils/lang';
+import { FileSystemError } from '../models/FileSystemError';
+import { getAllConfigAccounts } from './index';


I opted to move this stuff to its own file because it doesn't directly interact with the config file

joe-yeager

I like the new approach a lot!

brandenrodgers · 2025-02-21T20:44:15Z

Code lgtm 👌 we should chat about what the rollout strategy looks like

brandenrodgers · 2025-03-18T21:02:36Z

config/index.ts

-    ...configOptions,
-    portalId: accountIdentifier,
-  });
+export function getConfigAccountIfExists(


I was reviewing one of your PR's in the CLI, and this util tripped me up a little. This is effectively the same functionality as getConfigAccountByInferredIdentifier. But the naming of this util doesn't make it clear that we're inferring the identifier.`

Also here's a relevant comment from a CLI PR

Dynamic config migrations

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

brandenrodgers reviewed Feb 12, 2025

View reviewed changes

camden11 added 3 commits February 12, 2025 16:43

Add defaultAccountOverride functionality

267b483

return default account if exists

2533194

Fix tests

a236fa8

brandenrodgers reviewed Feb 12, 2025

View reviewed changes

camden11 added 3 commits February 12, 2025 16:58

Update tests for getDefaultAccount

1a686ed

Add tests for default account override

48cff29

Add tests for default account override

1b99a2b

camden11 commented Feb 12, 2025

View reviewed changes

camden11 added 3 commits February 12, 2025 17:31

Clean some things up

c413242

make sandboxAccountType deprecated

6b5dd10

Fix casing bug

46f0b30

joe-yeager approved these changes Feb 19, 2025

View reviewed changes

camden11 added 2 commits March 13, 2025 14:16

add getConfigAccountIfExists

fec1d99

Update a lot of lib files

fb7d46c

brandenrodgers reviewed Mar 18, 2025

View reviewed changes

camden11 added 11 commits March 21, 2025 12:38

v0.2.0-experimental.0

8e68f43

Merge branch 'main' into dynamic-config

78d8a03

add http use localhost config flag

32433cd

add getConfigDefaultAccountIfExists

61e2a1e

Merge branch 'main' into dynamic-config

a8c86af

Updateconfig migrate for revamped config

7eb31fc

remove unused copy

d8eab5f

export getConfigAtPath

bcacccd

Updateconfig merging logic

bbef362

Add tests for migrations

1b6e75b

Merge pull request #254 from HubSpot/dynamic-config-migrations

e17b8b2

Dynamic config migrations


		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

Are you sure you want to change the base?

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!

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!

joe-yeager left a comment

Choose a reason for hiding this comment

Uh oh!

brandenrodgers commented Feb 21, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

camden11 commented Feb 3, 2025 •

edited

Loading