refactor(cli): rename logs to logs-monitor

mrgrain · mrgrain · commit c9dec4e66d6f · 2025-04-03T22:58:52.000+01:00
We are about to move this module into a different package, and the target package is gitignoring any directory called `logs`. We could just fix the gitignore, but the module name is very inacurate anyway. Therefore we are renaming it.

Also moves `rwlock` from `api/utils` to `api`. This was an oversight and doesn't warrant a separate PR.

Finally moves some test files into their correct corresponding directories.
diff --git a/packages/@aws-cdk/toolkit-lib/lib/api/aws-cdk.ts b/packages/@aws-cdk/toolkit-lib/lib/api/aws-cdk.ts
@@ -12,19 +12,15 @@ export { CloudWatchLogEventMonitor, findCloudWatchLogGroups } from '../../../../
 export { type WorkGraph, WorkGraphBuilder, AssetBuildNode, AssetPublishNode, StackNode, Concurrency } from '../../../../aws-cdk/lib/api/work-graph';
 export { Bootstrapper } from '../../../../aws-cdk/lib/api/bootstrap';
 export { loadTree, some } from '../../../../aws-cdk/lib/api/tree';
+export { RWLock, type ILock } from '../../../../aws-cdk/lib/api/rwlock';
+export { HotswapMode, HotswapPropertyOverrides, EcsHotswapProperties } from '../../../../aws-cdk/lib/api/hotswap';
 
 // Context Providers
 export * as contextproviders from '../../../../aws-cdk/lib/context-providers';
 
-// @todo APIs not clean import
-export { HotswapMode } from '../../../../aws-cdk/lib/api/hotswap';
-export { HotswapPropertyOverrides, EcsHotswapProperties } from '../../../../aws-cdk/lib/api/hotswap';
-export { RWLock, type ILock } from '../../../../aws-cdk/lib/api/util/rwlock';
-
 // @todo Cloud Assembly and Executable - this is a messy API right now
 export { CloudAssembly, sanitizePatterns, StackCollection, ExtendedStackSelection } from '../../../../aws-cdk/lib/api/cxapp/cloud-assembly';
-export { prepareDefaultEnvironment, prepareContext, spaceAvailableForContext } from '../../../../aws-cdk/lib/api/cxapp/exec';
-export { guessExecutable } from '../../../../aws-cdk/lib/api/cxapp/exec';
+export { guessExecutable, prepareDefaultEnvironment, prepareContext, spaceAvailableForContext } from '../../../../aws-cdk/lib/api/cxapp/exec';
 
 // @todo Should not use! investigate how to replace
 export { versionNumber } from '../../../../aws-cdk/lib/cli/version';
diff --git a/packages/aws-cdk/lib/api/cxapp/exec.ts b/packages/aws-cdk/lib/api/cxapp/exec.ts
@@ -14,9 +14,9 @@ import { PROJECT_CONFIG, USER_DEFAULTS } from '../../cli/user-configuration';
 import { versionNumber } from '../../cli/version';
 import { splitBySize } from '../../util';
 import type { SdkProvider } from '../aws-auth';
+import type { ILock } from '../rwlock';
+import { RWLock } from '../rwlock';
 import type { Settings } from '../settings';
-import type { ILock } from '../util/rwlock';
-import { RWLock } from '../util/rwlock';
 
 export interface ExecProgramResult {
   readonly assembly: cxapi.CloudAssembly;
diff --git a/packages/aws-cdk/lib/api/logs-monitor/find-cloudwatch-logs.ts b/packages/aws-cdk/lib/api/logs-monitor/find-cloudwatch-logs.ts
diff --git a/packages/aws-cdk/lib/api/logs-monitor/index.ts b/packages/aws-cdk/lib/api/logs-monitor/index.ts
diff --git a/packages/aws-cdk/lib/api/logs-monitor/logs-monitor.ts b/packages/aws-cdk/lib/api/logs-monitor/logs-monitor.ts
diff --git a/packages/aws-cdk/lib/api/rwlock.ts b/packages/aws-cdk/lib/api/rwlock.ts
@@ -1,6 +1,6 @@
 import { promises as fs } from 'fs';
 import * as path from 'path';
-import { ToolkitError } from '../../../../@aws-cdk/tmp-toolkit-helpers/src/api';
+import { ToolkitError } from '../../../@aws-cdk/tmp-toolkit-helpers/src/api';
 
 /**
  * A single-writer/multi-reader lock on a directory
diff --git a/packages/aws-cdk/lib/cli/cdk-toolkit.ts b/packages/aws-cdk/lib/cli/cdk-toolkit.ts
@@ -29,8 +29,8 @@ import type { DeploymentMethod, SuccessfulDeployStackResult, Deployments } from
 import { createDiffChangeSet } from '../api/deployments/cfn-api';
 import { GarbageCollector } from '../api/garbage-collection/garbage-collector';
 import { HotswapMode, HotswapPropertyOverrides, EcsHotswapProperties } from '../api/hotswap/common';
-import { findCloudWatchLogGroups } from '../api/logs/find-cloudwatch-logs';
-import { CloudWatchLogEventMonitor } from '../api/logs/logs-monitor';
+import { findCloudWatchLogGroups } from '../api/logs-monitor/find-cloudwatch-logs';
+import { CloudWatchLogEventMonitor } from '../api/logs-monitor/logs-monitor';
 import { ResourceImporter, removeNonImportResources, ResourceMigrator } from '../api/resource-import';
 import { tagsForStack, type Tag } from '../api/tags';
 import type { AssetBuildNode, AssetPublishNode, Concurrency, StackNode, WorkGraph } from '../api/work-graph';
diff --git a/packages/aws-cdk/lib/cli/cli.ts b/packages/aws-cdk/lib/cli/cli.ts
@@ -25,9 +25,9 @@ import type { DeploymentMethod } from '../api/deployments';
 import { Deployments } from '../api/deployments';
 import { HotswapMode } from '../api/hotswap/common';
 import { PluginHost } from '../api/plugin';
+import type { ILock } from '../api/rwlock';
 import type { Settings } from '../api/settings';
 import { ToolkitInfo } from '../api/toolkit-info';
-import type { ILock } from '../api/util/rwlock';
 import { contextHandler as context } from '../commands/context';
 import { docs } from '../commands/docs';
 import { doctor } from '../commands/doctor';
diff --git a/packages/aws-cdk/test/api/cloudformation/evaluate-cloudformation-template.test.ts b/packages/aws-cdk/test/api/cloudformation/evaluate-cloudformation-template.test.ts
@@ -3,8 +3,8 @@ import {
   CfnEvaluationException,
   EvaluateCloudFormationTemplate,
   Template,
-} from '../../lib/api/cloudformation';
-import { MockSdk, mockCloudFormationClient, restoreSdkMocksToDefault } from '../_helpers/mock-sdk';
+} from '../../../lib/api/cloudformation';
+import { MockSdk, mockCloudFormationClient, restoreSdkMocksToDefault } from '../../_helpers/mock-sdk';
 
 const sdk = new MockSdk();
 
diff --git a/packages/aws-cdk/test/api/cloudformation/lazy-list-stack-resources.test.ts b/packages/aws-cdk/test/api/cloudformation/lazy-list-stack-resources.test.ts
@@ -1,8 +1,8 @@
 import 'aws-sdk-client-mock-jest';
 
 import { ListStackResourcesCommand } from '@aws-sdk/client-cloudformation';
-import { LazyListStackResources } from '../../lib/api/cloudformation';
-import { MockSdk, mockCloudFormationClient } from '../_helpers/mock-sdk';
+import { LazyListStackResources } from '../../../lib/api/cloudformation';
+import { MockSdk, mockCloudFormationClient } from '../../_helpers/mock-sdk';
 
 describe('Lazy ListStackResources', () => {
   test('correctly caches calls to the CloudFormation API', async () => {
diff --git a/packages/aws-cdk/test/api/cloudformation/lazy-lookup-export.test.ts b/packages/aws-cdk/test/api/cloudformation/lazy-lookup-export.test.ts
@@ -1,6 +1,6 @@
 import { ListExportsCommand } from '@aws-sdk/client-cloudformation';
-import { LazyLookupExport } from '../../lib/api/cloudformation';
-import { MockSdk, mockCloudFormationClient, restoreSdkMocksToDefault } from '../_helpers/mock-sdk';
+import { LazyLookupExport } from '../../../lib/api/cloudformation';
+import { MockSdk, mockCloudFormationClient, restoreSdkMocksToDefault } from '../../_helpers/mock-sdk';
 
 describe('LazyLookupExport', () => {
   const mockSdk = new MockSdk();
diff --git a/packages/aws-cdk/test/api/cxapp/exec.test.ts b/packages/aws-cdk/test/api/cxapp/exec.test.ts
@@ -10,7 +10,7 @@ import { Configuration } from '../../../lib/cli/user-configuration';
 import { testAssembly } from '../../_helpers/assembly';
 import { mockSpawn } from '../../util/mock-child_process';
 import { MockSdkProvider } from '../../_helpers/mock-sdk';
-import { RWLock } from '../../../lib/api/util/rwlock';
+import { RWLock } from '../../../lib/api/rwlock';
 import { rewriteManifestMinimumCliVersion, rewriteManifestVersion } from './assembly-versions';
 import { TestIoHost } from '../../_helpers/io-host';
 import { ToolkitError } from '../../../../@aws-cdk/tmp-toolkit-helpers/src/api';
diff --git a/packages/aws-cdk/test/api/logs-monitor/find-cloudwatch-logs.test.ts b/packages/aws-cdk/test/api/logs-monitor/find-cloudwatch-logs.test.ts
@@ -6,8 +6,7 @@ import {
   StackStatus,
 } from '@aws-sdk/client-cloudformation';
 import { SdkProvider } from '../../../lib/api';
-import { findCloudWatchLogGroups } from '../../../lib/api/logs/find-cloudwatch-logs';
-import { CliIoHost, IoMessaging } from '../../../lib/cli/io-host';
+import { findCloudWatchLogGroups } from '../../../lib/api/logs-monitor/find-cloudwatch-logs';
 import { testStack, TestStackArtifact } from '../../_helpers/assembly';
 import {
   mockCloudFormationClient,
@@ -16,10 +15,13 @@ import {
   restoreSdkMocksToDefault,
   setDefaultSTSMocks,
 } from '../../_helpers/mock-sdk';
+import { TestIoHost } from '../../_helpers/io-host';
 
 let sdk: MockSdk;
 let logsMockSdkProvider: SdkProvider;
-const mockMsg: IoMessaging = { ioHost: CliIoHost.instance(), action: 'deploy' };
+
+const ioHost = new TestIoHost();
+const ioHelper = ioHost.asHelper('deploy');
 
 beforeEach(() => {
   logsMockSdkProvider = new MockSdkProvider();
@@ -59,7 +61,7 @@ test('add log groups from lambda function', async () => {
   pushStackResourceSummaries(stackSummaryOf('Func', 'AWS::Lambda::Function', 'my-function'));
 
   // WHEN
-  const result = await findCloudWatchLogGroups(logsMockSdkProvider, mockMsg, cdkStackArtifact);
+  const result = await findCloudWatchLogGroups(logsMockSdkProvider, ioHelper, cdkStackArtifact);
 
   // THEN
   expect(result.logGroupNames).toEqual(['/aws/lambda/my-function']);
@@ -85,7 +87,7 @@ test('add log groups from lambda function when using custom LoggingConfig', asyn
   pushStackResourceSummaries(stackSummaryOf('Func', 'AWS::Lambda::Function', 'my-function'));
 
   // WHEN
-  const result = await findCloudWatchLogGroups(logsMockSdkProvider, mockMsg, cdkStackArtifact);
+  const result = await findCloudWatchLogGroups(logsMockSdkProvider, ioHelper, cdkStackArtifact);
 
   // THEN
   expect(result.logGroupNames).toEqual(['/this/custom/my-custom-log-group']);
@@ -119,7 +121,7 @@ test('add log groups from lambda function when using custom LoggingConfig using
   pushStackResourceSummaries(stackSummaryOf('Func', 'AWS::Lambda::Function', 'my-function'));
 
   // WHEN
-  const result = await findCloudWatchLogGroups(logsMockSdkProvider, mockMsg, cdkStackArtifact);
+  const result = await findCloudWatchLogGroups(logsMockSdkProvider, ioHelper, cdkStackArtifact);
 
   // THEN
   expect(result.logGroupNames).toEqual(['/this/custom/my-custom-log-group']);
@@ -139,7 +141,7 @@ test('add log groups from lambda function without physical name', async () => {
   pushStackResourceSummaries(stackSummaryOf('Func', 'AWS::Lambda::Function', 'my-function'));
 
   // WHEN
-  const result = await findCloudWatchLogGroups(logsMockSdkProvider, mockMsg, cdkStackArtifact);
+  const result = await findCloudWatchLogGroups(logsMockSdkProvider, ioHelper, cdkStackArtifact);
 
   // THEN
   expect(result.logGroupNames).toEqual(['/aws/lambda/my-function']);
@@ -152,7 +154,7 @@ test('empty template', async () => {
   });
 
   // WHEN
-  const result = await findCloudWatchLogGroups(logsMockSdkProvider, mockMsg, cdkStackArtifact);
+  const result = await findCloudWatchLogGroups(logsMockSdkProvider, ioHelper, cdkStackArtifact);
 
   // THEN
   expect(result.logGroupNames).toEqual([]);
@@ -191,7 +193,7 @@ test('add log groups from ECS Task Definitions', async () => {
   pushStackResourceSummaries(stackSummaryOf('LogGroup', 'AWS::Logs::LogGroup', 'log_group'));
 
   // WHEN
-  const result = await findCloudWatchLogGroups(logsMockSdkProvider, mockMsg, cdkStackArtifact);
+  const result = await findCloudWatchLogGroups(logsMockSdkProvider, ioHelper, cdkStackArtifact);
 
   // THEN
   expect(result.logGroupNames).toEqual(['log_group']);
@@ -230,7 +232,7 @@ test('add log groups from State Machines', async () => {
   pushStackResourceSummaries(stackSummaryOf('LogGroup', 'AWS::Logs::LogGroup', 'log_group'));
 
   // WHEN
-  const result = await findCloudWatchLogGroups(logsMockSdkProvider, mockMsg, cdkStackArtifact);
+  const result = await findCloudWatchLogGroups(logsMockSdkProvider, ioHelper, cdkStackArtifact);
 
   // THEN
   expect(result.logGroupNames).toEqual(['log_group']);
@@ -288,7 +290,7 @@ test('excluded log groups are not added', async () => {
   pushStackResourceSummaries(stackSummaryOf('Def', 'AWS::CodeBuild:Project', 'project'));
 
   // WHEN
-  const result = await findCloudWatchLogGroups(logsMockSdkProvider, mockMsg, cdkStackArtifact);
+  const result = await findCloudWatchLogGroups(logsMockSdkProvider, ioHelper, cdkStackArtifact);
 
   // THEN
   expect(result.logGroupNames).toEqual([]);
@@ -311,7 +313,7 @@ test('unassociated log groups are added', async () => {
   pushStackResourceSummaries(stackSummaryOf('LogGroup', 'AWS::Logs::LogGroup', 'log_group'));
 
   // WHEN
-  const result = await findCloudWatchLogGroups(logsMockSdkProvider, mockMsg, cdkStackArtifact);
+  const result = await findCloudWatchLogGroups(logsMockSdkProvider, ioHelper, cdkStackArtifact);
 
   // THEN
   expect(result.logGroupNames).toEqual(['log_group']);
@@ -331,7 +333,7 @@ test('log groups without physical names are added', async () => {
   pushStackResourceSummaries(stackSummaryOf('LogGroup', 'AWS::Logs::LogGroup', 'log_group'));
 
   // WHEN
-  const result = await findCloudWatchLogGroups(logsMockSdkProvider, mockMsg, cdkStackArtifact);
+  const result = await findCloudWatchLogGroups(logsMockSdkProvider, ioHelper, cdkStackArtifact);
 
   // THEN
   expect(result.logGroupNames).toEqual(['log_group']);
diff --git a/packages/aws-cdk/test/api/logs-monitor/logs-monitor.test.ts b/packages/aws-cdk/test/api/logs-monitor/logs-monitor.test.ts
@@ -1,5 +1,5 @@
 import { FilterLogEventsCommand, type FilteredLogEvent } from '@aws-sdk/client-cloudwatch-logs';
-import { CloudWatchLogEventMonitor } from '../../../lib/api/logs/logs-monitor';
+import { CloudWatchLogEventMonitor } from '../../../lib/api/logs-monitor';
 import { sleep } from '../../_helpers/sleep';
 import { MockSdk, mockCloudWatchClient } from '../../_helpers/mock-sdk';
 import { TestIoHost } from '../../_helpers/io-host';
diff --git a/packages/aws-cdk/test/api/rwlock.test.ts b/packages/aws-cdk/test/api/rwlock.test.ts
@@ -1,7 +1,7 @@
 /* eslint-disable import/order */
 import * as os from 'os';
 import * as path from 'path';
-import { RWLock } from '../../lib/api/util/rwlock';
+import { RWLock } from '../../lib/api/rwlock';
 
 function testDir() {
   return path.join(os.tmpdir(), 'rwlock-tests');
diff --git a/packages/aws-cdk/test/logging.test.ts b/packages/aws-cdk/test/logging.test.ts
@@ -1,5 +1,5 @@
-import { result, success, highlight, error, warning, info, debug, trace } from '../../../lib/logging';
-import { CliIoHost } from '../../../lib/cli/io-host';
+import { result, success, highlight, error, warning, info, debug, trace } from '../lib/logging';
+import { CliIoHost } from '../lib/cli/io-host';
 
 describe('logging', () => {
   const ioHost = CliIoHost.instance({}, true);
