refactor(watchedfiles): rename registeredItems => items #3945

Problem:
- `getRegisteredItem` implies there is some other kind of "item", which
  is confusing.
- The name `registeredItems` implies there is some other kind of "item",
  which is confusing and noisy, and unnecessarily verbose.

Solution:
- Rename to `getItem`.
- Rename to `items`.

Author: justinmk3

src/codecatalyst/devfile.ts

@@ -66,7 +66,7 @@ export class DevfileCodeLensProvider implements vscode.CodeLensProvider {
         this.disposables.push(this._onDidChangeCodeLenses)
         this.disposables.push(
             workspace.onDidSaveTextDocument(async document => {
-                if (!registry.getRegisteredItem(document.fileName)) {
+                if (!registry.getItem(document.fileName)) {
                     return
                 }
 

src/lambda/commands/createNewSamApp.ts

@@ -271,7 +271,7 @@ export async function createNewSamApplication(
         // Race condition where SAM app is created but template doesn't register in time.
         // Poll for 5 seconds, otherwise direct user to codelens.
         const isTemplateRegistered = await waitUntil(
-            async () => (await globals.templateRegistry).getRegisteredItem(templateUri),
+            async () => (await globals.templateRegistry).getItem(templateUri),
             {
                 timeout: 5000,
                 interval: 500,

src/lambda/local/debugConfiguration.ts

@@ -193,7 +193,7 @@ export async function getTemplate(
     }
     const templateInvoke = config.invokeTarget as TemplateTargetProperties
     const fullPath = tryGetAbsolutePath(folder, templateInvoke.templatePath)
-    const cfnTemplate = (await globals.templateRegistry).getRegisteredItem(fullPath)?.item
+    const cfnTemplate = (await globals.templateRegistry).getItem(fullPath)?.item
     return cfnTemplate
 }
 

src/lambda/vue/configEditor/samInvokeBackend.ts

@@ -161,7 +161,7 @@ export class SamInvokeWebview extends VueWebview {
     public async getTemplate() {
         const items: (vscode.QuickPickItem & { templatePath: string })[] = []
         const noTemplate = 'NOTEMPLATEFOUND'
-        for (const template of (await globals.templateRegistry).registeredItems) {
+        for (const template of (await globals.templateRegistry).items) {
             const resources = template.item.Resources
             if (resources) {
                 for (const resource of Object.keys(resources)) {

src/lambda/wizards/samDeployWizard.ts

@@ -211,7 +211,7 @@ export class DefaultSamDeployWizardContext implements SamDeployWizardContext {
     }
 
     public async determineIfTemplateHasImages(templatePath: vscode.Uri): Promise<boolean> {
-        const template = (await globals.templateRegistry).getRegisteredItem(templatePath.fsPath)
+        const template = (await globals.templateRegistry).getItem(templatePath.fsPath)
         const resources = template?.item?.Resources
         if (resources === undefined) {
             return false
@@ -933,7 +933,7 @@ function validateStackName(value: string): string | undefined {
 }
 
 async function getTemplateChoices(...workspaceFolders: vscode.Uri[]): Promise<SamTemplateQuickPickItem[]> {
-    const templateUris = (await globals.templateRegistry).registeredItems.map(o => vscode.Uri.file(o.path))
+    const templateUris = (await globals.templateRegistry).items.map(o => vscode.Uri.file(o.path))
     const uriToLabel: Map<vscode.Uri, string> = new Map<vscode.Uri, string>()
     const labelCounts: Map<string, number> = new Map()
 

src/shared/awsFiletypes.ts

@@ -67,7 +67,7 @@ export function activate(): void {
         vscode.workspace.onDidOpenTextDocument(async (doc: vscode.TextDocument) => {
             const isAwsFileExt = isAwsFiletype(doc)
             const isSchemaHandled = globals.schemaService.isMapped(doc.uri)
-            const isCfnTemplate = !!(await globals.templateRegistry).registeredItems.find(
+            const isCfnTemplate = !!(await globals.templateRegistry).items.find(
                 t => pathutil.normalize(t.path) === pathutil.normalize(doc.fileName)
             )
             if (!isAwsFileExt && !isSchemaHandled && !isCfnTemplate) {

src/shared/codelens/codeLensUtils.ts

@@ -61,11 +61,7 @@ export async function makeCodeLenses({
 
         try {
             const registry = await globals.templateRegistry
-            const associatedResources = getResourcesForHandler(
-                handler.filename,
-                handler.handlerName,
-                registry.registeredItems
-            )
+            const associatedResources = getResourcesForHandler(handler.filename, handler.handlerName, registry.items)
             const templateConfigs: AddSamDebugConfigurationInput[] = []
 
             if (associatedResources.length > 0) {

src/shared/extensionGlobals.ts

@@ -109,6 +109,7 @@ interface ToolkitGlobals {
     regionProvider: RegionProvider
     sdkClientBuilder: AWSClientBuilder
     telemetry: TelemetryService & { logger: TelemetryLogger }
+    /** template.yaml registry. _Avoid_ calling this until it is actually needed (for SAM features). */
     templateRegistry: Promise<CloudFormationTemplateRegistry>
     schemaService: SchemaService
     codelensRootRegistry: CodelensRootRegistry

src/shared/fs/watchedFiles.ts

@@ -148,7 +148,7 @@ export abstract class WatchedFiles<T> implements vscode.Disposable {
         this.disposables.push(
             vscode.workspace.onDidChangeTextDocument((event: vscode.TextDocumentChangeEvent) => {
                 if (isUntitledScheme(event.document.uri)) {
-                    this.addItemToRegistry(event.document.uri, true, event.document.getText())
+                    this.addItem(event.document.uri, true, event.document.getText())
                 }
             }),
             vscode.workspace.onDidCloseTextDocument((event: vscode.TextDocument) => {
@@ -175,7 +175,7 @@ export abstract class WatchedFiles<T> implements vscode.Disposable {
      * Adds an item to registry. Wipes any existing item in its place with new copy of the data
      * @param uri vscode.Uri containing the item to load in
      */
-    public async addItemToRegistry(uri: vscode.Uri, quiet?: boolean, contents?: string): Promise<void> {
+    public async addItem(uri: vscode.Uri, quiet?: boolean, contents?: string): Promise<void> {
         const excluded = this.excludedFilePatterns.find(pattern => uri.fsPath.match(pattern))
         if (excluded) {
             getLogger().verbose(`${this.name}: excluding path (matches "${excluded}"): ${uri.fsPath}`)
@@ -200,12 +200,13 @@ export abstract class WatchedFiles<T> implements vscode.Disposable {
     }
 
     /**
-     * Get a specific item's data
-     * Untitled files must be referred to by their URI
+     * Gets an item by filepath or URI.
+     *
+     * Untitled files must be referred to by URI.
+     *
      * @param path Absolute path to item of interest or a vscode.Uri to the item
      */
-    public getRegisteredItem(path: string | vscode.Uri): WatchedItem<T> | undefined {
-        // fsPath is needed for Windows, it's equivalent to path on mac/linux
+    public getItem(path: string | vscode.Uri): WatchedItem<T> | undefined {
         const normalizedPath = typeof path === 'string' ? pathutils.normalize(path) : normalizeVSCodeUri(path)
         this.assertAbsolute(normalizedPath)
         const item = this.registryData.get(normalizedPath)
@@ -219,13 +220,13 @@ export abstract class WatchedFiles<T> implements vscode.Disposable {
     }
 
     /**
-     * Returns the registry's data as an array of paths to type T objects
+     * Gets all registry items as an array of paths to type `T` objects.
      */
-    public get registeredItems(): WatchedItem<T>[] {
+    public get items(): WatchedItem<T>[] {
         const arr: WatchedItem<T>[] = []
 
         for (const itemPath of this.registryData.keys()) {
-            const item = this.getRegisteredItem(itemPath)
+            const item = this.getItem(itemPath)
             if (item) {
                 arr.push(item)
             }
@@ -272,7 +273,7 @@ export abstract class WatchedFiles<T> implements vscode.Disposable {
             try {
                 const found = await vscode.workspace.findFiles(glob, exclude)
                 for (const item of found) {
-                    await this.addItemToRegistry(item, true)
+                    await this.addItem(item, true)
                 }
             } catch (e) {
                 const err = e as Error
@@ -299,11 +300,11 @@ export abstract class WatchedFiles<T> implements vscode.Disposable {
             watcher,
             watcher.onDidChange(async uri => {
                 getLogger().verbose(`${this.name}: detected change: ${uri.fsPath}`)
-                await this.addItemToRegistry(uri)
+                await this.addItem(uri)
             }),
             watcher.onDidCreate(async uri => {
                 getLogger().verbose(`${this.name}: detected new file: ${uri.fsPath}`)
-                await this.addItemToRegistry(uri)
+                await this.addItem(uri)
             }),
             watcher.onDidDelete(async uri => {
                 getLogger().verbose(`${this.name}: detected delete: ${uri.fsPath}`)

src/shared/sam/debugger/awsSamDebugConfigurationValidator.ts

@@ -72,7 +72,7 @@ export class DefaultAwsSamDebugConfigurationValidator implements AwsSamDebugConf
                 const fullpath = tryGetAbsolutePath(this.workspaceFolder, config.invokeTarget.templatePath)
                 // Normalize to absolute path for use in the runner.
                 config.invokeTarget.templatePath = fullpath
-                cfnTemplate = registry.getRegisteredItem(fullpath)?.item
+                cfnTemplate = registry.getItem(fullpath)?.item
             }
             rv = this.validateTemplateConfig(config, config.invokeTarget.templatePath, cfnTemplate)
         } else if (config.invokeTarget.target === CODE_TARGET_TYPE) {