Update telemetry readme, and do not fetch private schemas if there is no auth

Author: satyakigh

src/auth/AwsCredentials.ts

@@ -34,6 +34,10 @@ export class AwsCredentials {
         this.logger.info(`AWS credentials ${encryptionKey ? 'encrypted' : 'unencrypted'}`);
     }
 
+    credentialsAvailable() {
+        return this.iamCredentials !== undefined;
+    }
+
     getIAM(): DeepReadonly<IamCredentials> {
         if (!this.iamCredentials) {
             throw new Error('IAM credentials not configured');

src/document/DocumentManager.ts

@@ -8,6 +8,7 @@ import { Telemetry } from '../telemetry/TelemetryDecorator';
 import { Delayer } from '../utils/Delayer';
 import { CloudFormationFileType, Document, DocumentType } from './Document';
 import { DocumentMetadata } from './DocumentProtocol';
+import { byteSize } from '../utils/String';
 
 export class DocumentManager implements SettingsConfigurable {
     private readonly log = LoggerFactory.getLogger(DocumentManager);
@@ -154,6 +155,9 @@ export class DocumentManager implements SettingsConfigurable {
             this.telemetry.registerGaugeProvider(`documents.open.extension.type.${ext}`, () =>
                 this.countDocumentsByExtension(ext),
             );
+            this.telemetry.registerGaugeProvider(`documents.size.extension.type.${ext}`, () =>
+                this.getTotalSizeByExtension(ext),
+            );
         }
     }
 
@@ -168,4 +172,10 @@ export class DocumentManager implements SettingsConfigurable {
     private countDocumentsByExtension(extension: string): number {
         return [...this.documentMap.values()].filter((doc) => doc.isTemplate() && doc.extension === extension).length;
     }
+
+    private getTotalSizeByExtension(extension: string): number {
+        return [...this.documentMap.values()]
+            .filter((doc) => doc.isTemplate() && doc.extension === extension)
+            .reduce((total, doc) => total + byteSize(doc.getText()), 0);
+    }
 }

src/schema/GetSchemaTask.ts

@@ -1,5 +1,6 @@
 import { DescribeTypeOutput } from '@aws-sdk/client-cloudformation';
 import { Logger } from 'pino';
+import { AwsCredentials } from '../auth/AwsCredentials';
 import { DataStore } from '../datastore/DataStore';
 import { CfnService } from '../services/CfnService';
 import { Measure } from '../telemetry/TelemetryDecorator';
@@ -98,6 +99,10 @@ export function getRemotePublicSchemas(region: AwsRegion) {
     return unZipFile(downloadFile(cfnResourceSchemaLink(region)));
 }
 
-export function getRemotePrivateSchemas(cfnService: CfnService) {
-    return cfnService.getAllPrivateResourceSchemas();
+export function getRemotePrivateSchemas(awsCredentials: AwsCredentials, cfnService: CfnService) {
+    if (awsCredentials.credentialsAvailable()) {
+        return cfnService.getAllPrivateResourceSchemas();
+    }
+
+    return Promise.resolve([]);
 }

src/server/CfnExternal.ts

@@ -46,7 +46,7 @@ export class CfnExternal implements Configurables, Closeable {
         this.schemaTaskManager =
             overrides.schemaTaskManager ??
             new GetSchemaTaskManager(this.schemaStore, getRemotePublicSchemas, () => {
-                return getRemotePrivateSchemas(this.cfnService);
+                return getRemotePrivateSchemas(core.awsCredentials, this.cfnService);
             });
         this.schemaRetriever =
             overrides.schemaRetriever ?? new SchemaRetriever(this.schemaTaskManager, this.schemaStore);

src/telemetry/README.md

@@ -58,7 +58,8 @@ initializationOptions: {
 }
 ...
 ```
+
+Your LSP client controls telemetry settings. Consult your LSP client's documentation for configuration options. Changes require restarting the language server to take effect.
+
 * **Alpha environment**: Telemetry is enabled by default if no initialization parameter is provided
 * **Beta and Production environments**: Telemetry is disabled by default if no initialization parameter is provided
-
-Your LSP client application controls telemetry settings. Consult your LSP client's documentation for configuration options. Changes require restarting the language server to take effect.

src/utils/String.ts

@@ -37,3 +37,8 @@ export function isStringABoolean(value: string): boolean {
 export function stringToBoolean(value: string): boolean {
     return value.trim().toLowerCase() === 'true';
 }
+
+export function byteSize(str: string) {
+    const bytes: Uint8Array = new TextEncoder().encode(str);
+    return bytes.length;
+}