Fix cfn environment naming (#200)

Author: chrisqm-dev

src/environments/EnvironmentParser.ts …/cfnEnvironments/CfnEnvironmentParser.tssrc/environments/EnvironmentParser.ts renamed to src/cfnEnvironments/CfnEnvironmentParser.ts src/environments/EnvironmentParser.ts renamed to src/cfnEnvironments/CfnEnvironmentParser.ts

@@ -1,15 +1,15 @@
 import { OnStackFailure } from '@aws-sdk/client-cloudformation';
 import { z } from 'zod';
 import { DocumentType } from '../document/Document';
-import { ParseEnvironmentFilesParams, DeploymentConfig } from './EnvironmentRequestType';
+import { ParseCfnEnvironmentFilesParams, DeploymentConfig } from './CfnEnvironmentRequestType';
 
 const DocumentInfoSchema = z.object({
     type: z.enum(DocumentType),
     content: z.string(),
     fileName: z.string(),
 });
 
-const ParseEnvironmentFilesParamsSchema = z.object({
+const ParseCfnEnvironmentFilesParamsSchema = z.object({
     documents: z.array(DocumentInfoSchema),
 });
 
@@ -26,8 +26,8 @@ const DeploymentConfigSchema = z
         message: 'At least one property must be provided',
     });
 
-export function parseEnvironmentFileParams(input: unknown): ParseEnvironmentFilesParams {
-    return ParseEnvironmentFilesParamsSchema.parse(input);
+export function parseCfnEnvironmentFileParams(input: unknown): ParseCfnEnvironmentFilesParams {
+    return ParseCfnEnvironmentFilesParamsSchema.parse(input);
 }
 
 export function parseDeploymentConfig(input: unknown): DeploymentConfig {

…c/environments/EnvironmentRequestType.ts …nvironments/CfnEnvironmentRequestType.tssrc/environments/EnvironmentRequestType.ts renamed to src/cfnEnvironments/CfnEnvironmentRequestType.ts src/environments/EnvironmentRequestType.ts renamed to src/cfnEnvironments/CfnEnvironmentRequestType.ts

@@ -17,21 +17,21 @@ export type DeploymentConfig = {
     onStackFailure?: OnStackFailure;
 };
 
-export type ParsedEnvironmentFile = {
+export type ParsedCfnEnvironmentFile = {
     deploymentConfig: DeploymentConfig;
     fileName: string;
 };
 
-export type ParseEnvironmentFilesParams = {
+export type ParseCfnEnvironmentFilesParams = {
     documents: DocumentInfo[];
 };
 
-export type ParseEnvironmentFilesResult = {
-    parsedFiles: ParsedEnvironmentFile[];
+export type ParseCfnEnvironmentFilesResult = {
+    parsedFiles: ParsedCfnEnvironmentFile[];
 };
 
 export const ParseEnvironmentFilesRequest = new RequestType<
-    ParseEnvironmentFilesParams,
-    ParseEnvironmentFilesResult,
+    ParseCfnEnvironmentFilesParams,
+    ParseCfnEnvironmentFilesResult,
     void
 >('aws/cfn/environment/files/parse');

src/handlers/EnvironmentHandler.ts src/handlers/CfnEnvironmentHandler.tssrc/handlers/EnvironmentHandler.ts renamed to src/handlers/CfnEnvironmentHandler.ts

@@ -1,29 +1,29 @@
 import { load } from 'js-yaml';
 import { RequestHandler } from 'vscode-languageserver';
-import { DocumentType } from '../document/Document';
-import { parseDeploymentConfig, parseEnvironmentFileParams } from '../environments/EnvironmentParser';
+import { parseDeploymentConfig, parseCfnEnvironmentFileParams } from '../cfnEnvironments/CfnEnvironmentParser';
 import {
-    ParsedEnvironmentFile,
-    ParseEnvironmentFilesParams,
-    ParseEnvironmentFilesResult,
-} from '../environments/EnvironmentRequestType';
+    ParsedCfnEnvironmentFile,
+    ParseCfnEnvironmentFilesParams,
+    ParseCfnEnvironmentFilesResult,
+} from '../cfnEnvironments/CfnEnvironmentRequestType';
+import { DocumentType } from '../document/Document';
 import { TelemetryService } from '../telemetry/TelemetryService';
 import { handleLspError } from '../utils/Errors';
 import { parseWithPrettyError } from '../utils/ZodErrorWrapper';
 
-export function parseEnvironmentFilesHandler(): RequestHandler<
-    ParseEnvironmentFilesParams,
-    ParseEnvironmentFilesResult,
+export function parseCfnEnvironmentFilesHandler(): RequestHandler<
+    ParseCfnEnvironmentFilesParams,
+    ParseCfnEnvironmentFilesResult,
     void
 > {
-    const telemetry = TelemetryService.instance.get('EnvironmentHandler');
+    const telemetry = TelemetryService.instance.get('CfnEnvironmentHandler');
 
-    return (rawParams): ParseEnvironmentFilesResult => {
-        return telemetry.measure('parseEnvironmentFiles', () => {
+    return (rawParams): ParseCfnEnvironmentFilesResult => {
+        return telemetry.measure('parseCfnEnvironmentFiles', () => {
             try {
-                const parsedFiles: ParsedEnvironmentFile[] = [];
+                const parsedFiles: ParsedCfnEnvironmentFile[] = [];
 
-                const params = parseWithPrettyError(parseEnvironmentFileParams, rawParams);
+                const params = parseWithPrettyError(parseCfnEnvironmentFileParams, rawParams);
 
                 for (const document of params.documents) {
                     try {
@@ -43,7 +43,7 @@ export function parseEnvironmentFilesHandler(): RequestHandler<
                             deploymentConfig: deploymentConfig,
                         });
                     } catch {
-                        telemetry.count('environmentFile.malformed', 1);
+                        telemetry.count('cfnEnvironmentFile.malformed', 1);
                     }
                 }
 

src/protocol/LspCfnEnvironmentHandlers.ts

@@ -0,0 +1,16 @@
+import { Connection, RequestHandler } from 'vscode-languageserver';
+import {
+    ParseCfnEnvironmentFilesParams,
+    ParseCfnEnvironmentFilesResult,
+    ParseEnvironmentFilesRequest,
+} from '../cfnEnvironments/CfnEnvironmentRequestType';
+
+export class LspCfnEnvironmentHandlers {
+    constructor(private readonly connection: Connection) {}
+
+    onParseCfnEnvironmentFiles(
+        handler: RequestHandler<ParseCfnEnvironmentFilesParams, ParseCfnEnvironmentFilesResult, void>,
+    ) {
+        this.connection.onRequest(ParseEnvironmentFilesRequest.method, handler);
+    }
+}

src/protocol/LspComponents.ts

@@ -1,8 +1,8 @@
 import { LspAuthHandlers } from './LspAuthHandlers';
+import { LspCfnEnvironmentHandlers } from './LspCfnEnvironmentHandlers';
 import { LspCommunication } from './LspCommunication';
 import { LspDiagnostics } from './LspDiagnostics';
 import { LspDocuments } from './LspDocuments';
-import { LspEnvironmentHandlers } from './LspEnvironmentHandlers';
 import { LspHandlers } from './LspHandlers';
 import { LspRelatedResourcesHandlers } from './LspRelatedResourcesHandlers';
 import { LspResourceHandlers } from './LspResourceHandlers';
@@ -19,7 +19,7 @@ export class LspComponents {
         public readonly handlers: LspHandlers,
         public readonly authHandlers: LspAuthHandlers,
         public readonly stackHandlers: LspStackHandlers,
-        public readonly environmentHandlers: LspEnvironmentHandlers,
+        public readonly cfnEnvironmentHandlers: LspCfnEnvironmentHandlers,
         public readonly resourceHandlers: LspResourceHandlers,
         public readonly relatedResourcesHandlers: LspRelatedResourcesHandlers,
         public readonly s3Handlers: LspS3Handlers,

src/protocol/LspConnection.ts

@@ -9,11 +9,11 @@ import { InitializedParams } from 'vscode-languageserver-protocol';
 import { ExtensionName } from '../utils/ExtensionConfig';
 import { LspAuthHandlers } from './LspAuthHandlers';
 import { LspCapabilities } from './LspCapabilities';
+import { LspCfnEnvironmentHandlers } from './LspCfnEnvironmentHandlers';
 import { LspCommunication } from './LspCommunication';
 import { LspComponents } from './LspComponents';
 import { LspDiagnostics } from './LspDiagnostics';
 import { LspDocuments } from './LspDocuments';
-import { LspEnvironmentHandlers } from './LspEnvironmentHandlers';
 import { LspHandlers } from './LspHandlers';
 import { LspRelatedResourcesHandlers } from './LspRelatedResourcesHandlers';
 import { LspResourceHandlers } from './LspResourceHandlers';
@@ -36,7 +36,7 @@ export class LspConnection {
     private readonly handlers: LspHandlers;
     private readonly authHandlers: LspAuthHandlers;
     private readonly stackHandlers: LspStackHandlers;
-    private readonly environmentHandlers: LspEnvironmentHandlers;
+    private readonly cfnEnvironmentHandlers: LspCfnEnvironmentHandlers;
     private readonly resourceHandlers: LspResourceHandlers;
     private readonly relatedResourcesHandlers: LspRelatedResourcesHandlers;
     private readonly s3Handlers: LspS3Handlers;
@@ -61,7 +61,7 @@ export class LspConnection {
         this.handlers = new LspHandlers(this.connection);
         this.authHandlers = new LspAuthHandlers(this.connection);
         this.stackHandlers = new LspStackHandlers(this.connection);
-        this.environmentHandlers = new LspEnvironmentHandlers(this.connection);
+        this.cfnEnvironmentHandlers = new LspCfnEnvironmentHandlers(this.connection);
         this.resourceHandlers = new LspResourceHandlers(this.connection);
         this.relatedResourcesHandlers = new LspRelatedResourcesHandlers(this.connection);
         this.s3Handlers = new LspS3Handlers(this.connection);
@@ -96,7 +96,7 @@ export class LspConnection {
             this.handlers,
             this.authHandlers,
             this.stackHandlers,
-            this.environmentHandlers,
+            this.cfnEnvironmentHandlers,
             this.resourceHandlers,
             this.relatedResourcesHandlers,
             this.s3Handlers,

src/protocol/LspEnvironmentHandlers.ts

@@ -1,13 +1,13 @@
 import { InitializedParams } from 'vscode-languageserver-protocol';
 import { iamCredentialsDeleteHandler, iamCredentialsUpdateHandler } from '../handlers/AuthHandler';
+import { parseCfnEnvironmentFilesHandler } from '../handlers/CfnEnvironmentHandler';
 import { codeActionHandler } from '../handlers/CodeActionHandler';
 import { codeLensHandler } from '../handlers/CodeLensHandler';
 import { completionHandler } from '../handlers/CompletionHandler';
 import { configurationHandler } from '../handlers/ConfigurationHandler';
 import { definitionHandler } from '../handlers/DefinitionHandler';
 import { didChangeHandler, didCloseHandler, didOpenHandler, didSaveHandler } from '../handlers/DocumentHandler';
 import { documentSymbolHandler } from '../handlers/DocumentSymbolHandler';
-import { parseEnvironmentFilesHandler } from '../handlers/EnvironmentHandler';
 import { executionHandler } from '../handlers/ExecutionHandler';
 import { hoverHandler } from '../handlers/HoverHandler';
 import { initializedHandler } from '../handlers/Initialize';
@@ -127,7 +127,7 @@ export class CfnServer {
         this.lsp.stackHandlers.onClearStackEvents(clearStackEventsHandler(this.components));
         this.lsp.stackHandlers.onDescribeStack(describeStackHandler(this.components));
 
-        this.lsp.environmentHandlers.onParseEnvironmentFiles(parseEnvironmentFilesHandler());
+        this.lsp.cfnEnvironmentHandlers.onParseCfnEnvironmentFiles(parseCfnEnvironmentFilesHandler());
 
         this.lsp.relatedResourcesHandlers.onGetAuthoredResourceTypes(getAuthoredResourceTypesHandler(this.components));
         this.lsp.relatedResourcesHandlers.onGetRelatedResourceTypes(getRelatedResourceTypesHandler(this.components));

src/server/CfnServer.ts

@@ -69,7 +69,7 @@ import { LspS3Handlers } from '../src/protocol/LspS3Handlers';
 import { ExtendedInitializeParams } from '../src/server/InitParams';
 import { FeatureFlagProvider } from '../src/featureFlag/FeatureFlagProvider';
 import { RelationshipSchemaService } from '../src/services/RelationshipSchemaService';
-import { LspEnvironmentHandlers } from '../src/protocol/LspEnvironmentHandlers';
+import { LspCfnEnvironmentHandlers } from '../src/protocol/LspCfnEnvironmentHandlers';
 
 const argv = yargs(hideBin(process.argv))
     .option('templates', {
@@ -185,7 +185,7 @@ function main() {
         stubInterface<LspHandlers>(),
         createMockAuthHandlers(),
         stubInterface<LspStackHandlers>(),
-        stubInterface<LspEnvironmentHandlers>(),
+        stubInterface<LspCfnEnvironmentHandlers>(),
         stubInterface<LspResourceHandlers>(),
         stubInterface<LspRelatedResourcesHandlers>(),
         stubInterface<LspS3Handlers>(),

tools/telemetry-generator.ts

@@ -1,11 +1,14 @@
 import { OnStackFailure } from '@aws-sdk/client-cloudformation';
 import { describe, it, expect } from 'vitest';
 import { ZodError } from 'zod';
+import {
+    parseCfnEnvironmentFileParams,
+    parseDeploymentConfig,
+} from '../../../src/cfnEnvironments/CfnEnvironmentParser';
 import { DocumentType } from '../../../src/document/Document';
-import { parseEnvironmentFileParams, parseDeploymentConfig } from '../../../src/environments/EnvironmentParser';
 
-describe('environmentParser', () => {
-    describe('parseEnvironmentFileParams', () => {
+describe('cfnEnvironmentParser', () => {
+    describe('parseCfnEnvironmentFileParams', () => {
         it('should parse valid environment file params', () => {
             const input = {
                 documents: [
@@ -17,7 +20,7 @@ describe('environmentParser', () => {
                 ],
             };
 
-            const result = parseEnvironmentFileParams(input);
+            const result = parseCfnEnvironmentFileParams(input);
 
             expect(result).toEqual({
                 documents: [
@@ -33,15 +36,15 @@ describe('environmentParser', () => {
         it('should throw ZodError for missing documents', () => {
             const input = {};
 
-            expect(() => parseEnvironmentFileParams(input)).toThrow(ZodError);
+            expect(() => parseCfnEnvironmentFileParams(input)).toThrow(ZodError);
         });
 
         it('should handle empty documents array', () => {
             const input = {
                 documents: [],
             };
 
-            const result = parseEnvironmentFileParams(input);
+            const result = parseCfnEnvironmentFileParams(input);
             expect(result.documents).toEqual([]);
         });
 
@@ -56,7 +59,7 @@ describe('environmentParser', () => {
                 ],
             };
 
-            expect(() => parseEnvironmentFileParams(input)).toThrow(ZodError);
+            expect(() => parseCfnEnvironmentFileParams(input)).toThrow(ZodError);
         });
 
         it('should throw ZodError for missing document properties', () => {
@@ -70,7 +73,7 @@ describe('environmentParser', () => {
                 ],
             };
 
-            expect(() => parseEnvironmentFileParams(input)).toThrow(ZodError);
+            expect(() => parseCfnEnvironmentFileParams(input)).toThrow(ZodError);
         });
     });