refactor: rename config admin functions to global

lib/config/admin.ts

@@ -1,9 +1,9 @@
-import type { RenovateConfig, RepoAdminConfig } from './types';
+import type { RenovateConfig, RepoGlobalConfig } from './types';
 
-let adminConfig: RepoAdminConfig = {};
+let repoGlobalConfig: RepoGlobalConfig = {};
 
 // TODO: once admin config work is complete, add a test to make sure this list includes all options with admin=true (#9603)
-const repoAdminOptions = [
+const repoGlobalOptions = [
   'allowCustomCrateRegistries',
   'allowPostUpgradeCommandTemplating',
   'allowScripts',
@@ -21,18 +21,18 @@ const repoAdminOptions = [
   'cacheDir',
 ];
 
-export function setAdminConfig(
-  config: RenovateConfig | RepoAdminConfig = {}
+export function setGlobalConfig(
+  config: RenovateConfig | RepoGlobalConfig = {}
 ): RenovateConfig {
-  adminConfig = {};
+  repoGlobalConfig = {};
   const result = { ...config };
-  for (const option of repoAdminOptions) {
-    adminConfig[option] = config[option];
+  for (const option of repoGlobalOptions) {
+    repoGlobalConfig[option] = config[option];
     delete result[option]; // eslint-disable-line no-param-reassign
   }
   return result;
 }
 
-export function getAdminConfig(): RepoAdminConfig {
-  return adminConfig;
+export function getGlobalConfig(): RepoGlobalConfig {
+  return repoGlobalConfig;
 }

lib/config/decrypt.spec.ts

@@ -1,5 +1,5 @@
 import { getName, loadFixture } from '../../test/util';
-import { setAdminConfig } from './admin';
+import { setGlobalConfig } from './admin';
 import { decryptConfig } from './decrypt';
 import type { RenovateConfig } from './types';
 
@@ -10,7 +10,7 @@ describe(getName(), () => {
     let config: RenovateConfig;
     beforeEach(() => {
       config = {};
-      setAdminConfig();
+      setGlobalConfig();
     });
     it('returns empty with no privateKey', () => {
       delete config.encrypted;
@@ -25,17 +25,17 @@ describe(getName(), () => {
     });
     it('handles invalid encrypted type', () => {
       config.encrypted = 1;
-      setAdminConfig({ privateKey });
+      setGlobalConfig({ privateKey });
       const res = decryptConfig(config);
       expect(res.encrypted).not.toBeDefined();
     });
     it('handles invalid encrypted value', () => {
       config.encrypted = { a: 1 };
-      setAdminConfig({ privateKey });
+      setGlobalConfig({ privateKey });
       expect(() => decryptConfig(config)).toThrow(Error('config-validation'));
     });
     it('replaces npm token placeholder in npmrc', () => {
-      setAdminConfig({ privateKey });
+      setGlobalConfig({ privateKey });
       config.npmrc =
         '//registry.npmjs.org/:_authToken=${NPM_TOKEN}\n//registry.npmjs.org/:_authToken=${NPM_TOKEN}\n'; // eslint-disable-line no-template-curly-in-string
       config.encrypted = {
@@ -50,7 +50,7 @@ describe(getName(), () => {
       );
     });
     it('appends npm token in npmrc', () => {
-      setAdminConfig({ privateKey });
+      setGlobalConfig({ privateKey });
       config.npmrc = 'foo=bar\n'; // eslint-disable-line no-template-curly-in-string
       config.encrypted = {
         npmToken:
@@ -62,7 +62,7 @@ describe(getName(), () => {
       expect(res.npmrc).toMatchSnapshot();
     });
     it('decrypts nested', () => {
-      setAdminConfig({ privateKey });
+      setGlobalConfig({ privateKey });
       config.packageFiles = [
         {
           packageFile: 'package.json',

lib/config/decrypt.ts

@@ -3,13 +3,13 @@ import is from '@sindresorhus/is';
 import { logger } from '../logger';
 import { maskToken } from '../util/mask';
 import { add } from '../util/sanitize';
-import { getAdminConfig } from './admin';
+import { getGlobalConfig } from './admin';
 import type { RenovateConfig } from './types';
 
 export function decryptConfig(config: RenovateConfig): RenovateConfig {
   logger.trace({ config }, 'decryptConfig()');
   const decryptedConfig = { ...config };
-  const { privateKey } = getAdminConfig();
+  const { privateKey } = getGlobalConfig();
   for (const [key, val] of Object.entries(config)) {
     if (key === 'encrypted' && is.object(val)) {
       logger.debug({ config: val }, 'Found encrypted config');

lib/config/migration.spec.ts

@@ -1,6 +1,6 @@
 import { getName } from '../../test/util';
 import { PLATFORM_TYPE_GITHUB } from '../constants/platforms';
-import { setAdminConfig } from './admin';
+import { setGlobalConfig } from './admin';
 import { getConfig } from './defaults';
 import * as configMigration from './migration';
 import type {
@@ -707,7 +707,7 @@ describe(getName(), () => {
     });
   });
   it('it migrates presets', () => {
-    setAdminConfig({
+    setGlobalConfig({
       migratePresets: {
         '@org': 'local>org/renovate-config',
         '@org2/foo': '',

lib/config/migration.ts

@@ -3,7 +3,7 @@ import is from '@sindresorhus/is';
 import { dequal } from 'dequal';
 import { logger } from '../logger';
 import { clone } from '../util/clone';
-import { getAdminConfig } from './admin';
+import { getGlobalConfig } from './admin';
 import { getOptions } from './options';
 import { removedPresets } from './presets/common';
 import type {
@@ -56,7 +56,7 @@ export function migrateConfig(
       'optionalDependencies',
       'peerDependencies',
     ];
-    const { migratePresets } = getAdminConfig();
+    const { migratePresets } = getGlobalConfig();
     for (const [key, val] of Object.entries(config)) {
       if (removedOptions.includes(key)) {
         delete migratedConfig[key];

lib/config/presets/npm/index.spec.ts

@@ -1,6 +1,6 @@
 import * as httpMock from '../../../../test/http-mock';
 import { getName } from '../../../../test/util';
-import { setAdminConfig } from '../../admin';
+import { setGlobalConfig } from '../../admin';
 import * as npm from '.';
 
 jest.mock('registry-auth-token');
@@ -9,7 +9,7 @@ jest.mock('delay');
 describe(getName(), () => {
   beforeEach(() => {
     jest.resetAllMocks();
-    setAdminConfig();
+    setGlobalConfig();
   });
   afterEach(() => {
     delete process.env.RENOVATE_CACHE_NPM_MINUTES;

lib/config/types.ts

@@ -86,7 +86,7 @@ export interface GlobalOnlyConfig {
 
 // Config options used within the repository worker, but not user configurable
 // The below should contain config options where admin=true
-export interface RepoAdminConfig {
+export interface RepoGlobalConfig {
   allowCustomCrateRegistries?: boolean;
   allowPostUpgradeCommandTemplating?: boolean;
   allowScripts?: boolean;

lib/datasource/crate/index.spec.ts

@@ -6,8 +6,8 @@ import { dirname, join } from 'upath';
 import { getPkgReleases } from '..';
 import * as httpMock from '../../../test/http-mock';
 import { getName, loadFixture } from '../../../test/util';
-import { setAdminConfig } from '../../config/admin';
-import type { RepoAdminConfig } from '../../config/types';
+import { setGlobalConfig } from '../../config/admin';
+import type { RepoGlobalConfig } from '../../config/types';
 import * as memCache from '../../util/cache/memory';
 import { RegistryFlavor, RegistryInfo } from './types';
 import { id as datasource, fetchCrateRecordsPayload, getIndexSuffix } from '.';
@@ -75,7 +75,7 @@ describe(getName(), () => {
 
   describe('getReleases', () => {
     let tmpDir: DirectoryResult | null;
-    let adminConfig: RepoAdminConfig;
+    let adminConfig: RepoGlobalConfig;
 
     beforeEach(async () => {
       tmpDir = await dir();
@@ -84,7 +84,7 @@ describe(getName(), () => {
         localDir: join(tmpDir.path, 'local'),
         cacheDir: join(tmpDir.path, 'cache'),
       };
-      setAdminConfig(adminConfig);
+      setGlobalConfig(adminConfig);
 
       simpleGit.mockReset();
       memCache.init();
@@ -93,7 +93,7 @@ describe(getName(), () => {
     afterEach(() => {
       fs.rmdirSync(tmpDir.path, { recursive: true });
       tmpDir = null;
-      setAdminConfig();
+      setGlobalConfig();
     });
 
     it('returns null for missing registry url', async () => {
@@ -229,7 +229,7 @@ describe(getName(), () => {
     });
     it('clones cloudsmith private registry', async () => {
       const { mockClone } = setupGitMocks();
-      setAdminConfig({ ...adminConfig, allowCustomCrateRegistries: true });
+      setGlobalConfig({ ...adminConfig, allowCustomCrateRegistries: true });
       const url = 'https://dl.cloudsmith.io/basic/myorg/myrepo/cargo/index.git';
       const res = await getPkgReleases({
         datasource,
@@ -243,7 +243,7 @@ describe(getName(), () => {
     });
     it('clones other private registry', async () => {
       const { mockClone } = setupGitMocks();
-      setAdminConfig({ ...adminConfig, allowCustomCrateRegistries: true });
+      setGlobalConfig({ ...adminConfig, allowCustomCrateRegistries: true });
       const url = 'https://github.com/mcorbin/testregistry';
       const res = await getPkgReleases({
         datasource,
@@ -257,7 +257,7 @@ describe(getName(), () => {
     });
     it('clones once then reuses the cache', async () => {
       const { mockClone } = setupGitMocks();
-      setAdminConfig({ ...adminConfig, allowCustomCrateRegistries: true });
+      setGlobalConfig({ ...adminConfig, allowCustomCrateRegistries: true });
       const url = 'https://github.com/mcorbin/othertestregistry';
       await getPkgReleases({
         datasource,
@@ -273,7 +273,7 @@ describe(getName(), () => {
     });
     it('guards against race conditions while cloning', async () => {
       const { mockClone } = setupGitMocks(250);
-      setAdminConfig({ ...adminConfig, allowCustomCrateRegistries: true });
+      setGlobalConfig({ ...adminConfig, allowCustomCrateRegistries: true });
       const url = 'https://github.com/mcorbin/othertestregistry';
 
       await Promise.all([
@@ -299,7 +299,7 @@ describe(getName(), () => {
     });
     it('returns null when git clone fails', async () => {
       setupErrorGitMock();
-      setAdminConfig({ ...adminConfig, allowCustomCrateRegistries: true });
+      setGlobalConfig({ ...adminConfig, allowCustomCrateRegistries: true });
       const url = 'https://github.com/mcorbin/othertestregistry';
 
       const result = await getPkgReleases({

lib/datasource/crate/index.ts

@@ -1,7 +1,7 @@
 import hasha from 'hasha';
 import Git from 'simple-git';
 import { join } from 'upath';
-import { getAdminConfig } from '../../config/admin';
+import { getGlobalConfig } from '../../config/admin';
 import { logger } from '../../logger';
 import { ExternalHostError } from '../../types/errors/external-host-error';
 import * as memCache from '../../util/cache/memory';
@@ -135,7 +135,7 @@ async function fetchRegistryInfo(
   };
 
   if (flavor !== RegistryFlavor.CratesIo) {
-    if (!getAdminConfig().allowCustomCrateRegistries) {
+    if (!getGlobalConfig().allowCustomCrateRegistries) {
       logger.warn(
         'crate datasource: allowCustomCrateRegistries=true is required for registries other than crates.io, bailing out'
       );

lib/datasource/npm/index.spec.ts

@@ -3,7 +3,7 @@ import _registryAuthToken from 'registry-auth-token';
 import { getPkgReleases } from '..';
 import * as httpMock from '../../../test/http-mock';
 import { getName } from '../../../test/util';
-import { setAdminConfig } from '../../config/admin';
+import { setGlobalConfig } from '../../config/admin';
 import { EXTERNAL_HOST_ERROR } from '../../constants/error-messages';
 import * as hostRules from '../../util/host-rules';
 import { id as datasource, getNpmrc, resetCache, setNpmrc } from '.';
@@ -18,7 +18,7 @@ let npmResponse: any;
 describe(getName(), () => {
   beforeEach(() => {
     jest.resetAllMocks();
-    setAdminConfig();
+    setGlobalConfig();
     hostRules.clear();
     resetCache();
     setNpmrc();
@@ -358,7 +358,7 @@ describe(getName(), () => {
       .reply(200, npmResponse);
     process.env.REGISTRY = 'https://registry.from-env.com';
     process.env.RENOVATE_CACHE_NPM_MINUTES = '15';
-    setAdminConfig({ exposeAllEnv: true });
+    setGlobalConfig({ exposeAllEnv: true });
     // eslint-disable-next-line no-template-curly-in-string
     const npmrc = 'registry=${REGISTRY}';
     const res = await getPkgReleases({ datasource, depName: 'foobar', npmrc });
@@ -367,7 +367,7 @@ describe(getName(), () => {
   });
 
   it('should throw error if necessary env var is not present', () => {
-    setAdminConfig({ exposeAllEnv: true });
+    setGlobalConfig({ exposeAllEnv: true });
     // eslint-disable-next-line no-template-curly-in-string
     expect(() => setNpmrc('registry=${REGISTRY_MISSING}')).toThrow(
       Error('env-replace')

lib/datasource/npm/npmrc.spec.ts

@@ -1,5 +1,5 @@
 import { getName, mocked } from '../../../test/util';
-import { setAdminConfig } from '../../config/admin';
+import { setGlobalConfig } from '../../config/admin';
 import * as _sanitize from '../../util/sanitize';
 import { getNpmrc, setNpmrc } from './npmrc';
 
@@ -10,7 +10,7 @@ const sanitize = mocked(_sanitize);
 describe(getName(), () => {
   beforeEach(() => {
     setNpmrc('');
-    setAdminConfig();
+    setGlobalConfig();
     jest.resetAllMocks();
   });
 
@@ -38,7 +38,7 @@ describe(getName(), () => {
   });
 
   it('sanitize _authtoken with high trust', () => {
-    setAdminConfig({ exposeAllEnv: true });
+    setGlobalConfig({ exposeAllEnv: true });
     process.env.TEST_TOKEN = 'test';
     setNpmrc(
       // eslint-disable-next-line no-template-curly-in-string

lib/datasource/npm/npmrc.ts

@@ -3,7 +3,7 @@ import is from '@sindresorhus/is';
 import ini from 'ini';
 import registryAuthToken from 'registry-auth-token';
 import getRegistryUrl from 'registry-auth-token/registry-url';
-import { getAdminConfig } from '../../config/admin';
+import { getGlobalConfig } from '../../config/admin';
 import { logger } from '../../logger';
 import type { OutgoingHttpHeaders } from '../../util/http/types';
 import { maskToken } from '../../util/mask';
@@ -60,7 +60,7 @@ export function setNpmrc(input?: string): void {
     npmrcRaw = input;
     logger.debug('Setting npmrc');
     npmrc = ini.parse(input.replace(/\\n/g, '\n'));
-    const { exposeAllEnv } = getAdminConfig();
+    const { exposeAllEnv } = getGlobalConfig();
     for (const [key, val] of Object.entries(npmrc)) {
       if (!exposeAllEnv) {
         sanitize(key, val);

lib/manager/batect/extract.spec.ts

@@ -1,6 +1,6 @@
 import { getName } from '../../../test/util';
-import { setAdminConfig } from '../../config/admin';
-import type { RepoAdminConfig } from '../../config/types';
+import { setGlobalConfig } from '../../config/admin';
+import type { RepoGlobalConfig } from '../../config/types';
 import { id as gitTagDatasource } from '../../datasource/git-tags';
 import { id as dockerVersioning } from '../../versioning/docker';
 import { id as semverVersioning } from '../../versioning/semver';
@@ -27,7 +27,7 @@ function createGitDependency(repo: string, version: string): PackageDependency {
   };
 }
 
-const adminConfig: RepoAdminConfig = {
+const adminConfig: RepoGlobalConfig = {
   localDir: '',
 };
 
@@ -36,11 +36,11 @@ const config: ExtractConfig = {};
 describe(getName(), () => {
   describe('extractPackageFile()', () => {
     beforeEach(() => {
-      setAdminConfig(adminConfig);
+      setGlobalConfig(adminConfig);
     });
 
     afterEach(() => {
-      setAdminConfig();
+      setGlobalConfig();
     });
 
     it('returns empty array for empty configuration file', async () => {