fix(codecatalyst): workaround for mystery devfile location

Problem:
- Currently on prod the devfile location from MDE may resolve as ${workspaceRoot}/devfile.yaml instead of just "devfile.yaml". This causes issues because getDevfileLocation will return /projects/WebApplication/WebApplication/devfile.yaml which doesn't exist.

Solution:
- Build the devfile location depending on if the the user enters MDE in the /projects directory or /projects/[repo]

Author: jpinkney-aws

src/codecatalyst/model.ts

@@ -27,6 +27,8 @@ import { ensureDependencies, HOST_NAME_PREFIX } from './tools'
 import { isCodeCatalystVSCode } from './utils'
 import { Timeout } from '../shared/utilities/timeoutUtils'
 import { Commands } from '../shared/vscode/commands2'
+import { areEqual } from '../shared/utilities/pathUtils'
+import { fileExists } from '../shared/filesystemUtilities'
 
 export type DevEnvironmentId = Pick<DevEnvironment, 'id' | 'org' | 'project'>
 
@@ -289,14 +291,47 @@ export async function getDevfileLocation(client: DevEnvClient, root?: vscode.Uri
         throw new Error('No root directory or Dev Environment folder found')
     }
 
+    async function checkDefaultLocations(rootDirectory: vscode.Uri): Promise<vscode.Uri> {
+        // Check the projects root location
+        const devfileRoot = vscode.Uri.joinPath(vscode.Uri.parse('/projects'), 'devfile.yaml')
+        if (await fileExists(devfileRoot.fsPath)) {
+            return devfileRoot
+        }
+
+        // Check the location relative to the current directory
+        const projectRoot = vscode.Uri.joinPath(rootDirectory, 'devfile.yaml')
+        if (await fileExists(projectRoot.fsPath)) {
+            return projectRoot
+        }
+
+        throw new Error('Devfile location was not found')
+    }
+
     // TODO(sijaden): should make this load greedily and continously poll
     // latency is very high for some reason
     const devfileLocation = await client.getStatus().then(r => r.location)
     if (!devfileLocation) {
-        throw new Error('Devfile location was not found')
+        return checkDefaultLocations(rootDirectory)
+    }
+
+    if (areEqual(undefined, rootDirectory.fsPath, '/projects')) {
+        return vscode.Uri.joinPath(rootDirectory, devfileLocation)
+    }
+
+    // we have /projects/repo, where MDE may or may not return [repo]/devfile.yaml
+    const repo = path.basename(rootDirectory.fsPath)
+    const splitDevfilePath = devfileLocation.split('/')
+    const devfilePath = vscode.Uri.joinPath(rootDirectory, 'devfile.yaml')
+    if (repo === splitDevfilePath[0] && (await fileExists(devfilePath.fsPath))) {
+        return devfilePath
+    }
+
+    const baseLocation = vscode.Uri.joinPath(rootDirectory, devfileLocation)
+    if (await fileExists(baseLocation.fsPath)) {
+        return baseLocation
     }
 
-    return vscode.Uri.joinPath(rootDirectory, devfileLocation)
+    return checkDefaultLocations(rootDirectory)
 }
 
 /**

src/test/caws/devfileLocation.test.ts

@@ -0,0 +1,114 @@
+/*!
+ * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import * as assert from 'assert'
+import * as vscode from 'vscode'
+import { getDevfileLocation } from '../../codecatalyst/model'
+import { DevEnvClient } from '../../shared/clients/devenvClient'
+import * as sinon from 'sinon'
+const fileSystemUtils = require('../../shared/filesystemUtilities')
+
+describe('getDevfileLocation', function () {
+    let sandbox: sinon.SinonSandbox
+
+    beforeEach(function () {
+        sandbox = sinon.createSandbox()
+    })
+
+    afterEach(function () {
+        sandbox.restore()
+    })
+
+    function mockClient(location: string | undefined): DevEnvClient {
+        const devEnvClient = new DevEnvClient()
+        if (!location) {
+            sandbox.stub(devEnvClient, 'getStatus').resolves({})
+        } else {
+            sandbox.stub(devEnvClient, 'getStatus').resolves({
+                location: location,
+            })
+        }
+        return devEnvClient
+    }
+
+    it('devfile found at root', async function () {
+        const client = mockClient('devfile.yaml')
+        const location = await getDevfileLocation(client, vscode.Uri.parse('/projects'))
+        assert.strictEqual(location.toString(), 'file:///projects/devfile.yaml')
+    })
+
+    it('devfile with repo found in subfolder', async function () {
+        const client = mockClient('WebApplication/devfile.yaml')
+        const location = await getDevfileLocation(client, vscode.Uri.parse('/projects'))
+        assert.strictEqual(location.toString(), 'file:///projects/WebApplication/devfile.yaml')
+    })
+
+    it('devfile without repo found in workspace root', async function () {
+        const devfilePath = vscode.Uri.parse('/projects/WebApplication/devfile.yaml').fsPath
+        sandbox.stub(fileSystemUtils, 'fileExists').callsFake(function (p: string) {
+            return p === devfilePath
+        })
+        const client = mockClient('devfile.yaml')
+        const location = await getDevfileLocation(client, vscode.Uri.parse('/projects/WebApplication'))
+        assert.strictEqual(location.toString(), 'file:///projects/WebApplication/devfile.yaml')
+    })
+
+    it('devfile found in subfolder with repo', async function () {
+        const devfilePath = vscode.Uri.parse('/projects/WebApplication/devfile.yaml').fsPath
+        sandbox.stub(fileSystemUtils, 'fileExists').callsFake(function (p: string) {
+            return p === devfilePath
+        })
+        const client = mockClient('WebApplication/devfile.yaml')
+        const location = await getDevfileLocation(client, vscode.Uri.parse('/projects/WebApplication'))
+        assert.strictEqual(location.toString(), 'file:///projects/WebApplication/devfile.yaml')
+    })
+
+    it('throws when devfile is not found', async function () {
+        sandbox.stub(fileSystemUtils, 'fileExists').resolves(false)
+        const client = mockClient('test/devfile.yaml')
+        const location = getDevfileLocation(client, vscode.Uri.parse('/projects/WebApplication'))
+        assert.rejects(location, new Error('Devfile location was not found'))
+    })
+
+    it('falls back to default projects location when devfile cannot be located', async function () {
+        const devfilePath = vscode.Uri.parse('/projects/devfile.yaml').fsPath
+        sandbox.stub(fileSystemUtils, 'fileExists').callsFake(function (p: string) {
+            return p === devfilePath
+        })
+        const client = mockClient('WebApplication/devfile.yaml')
+        const location = await getDevfileLocation(client, vscode.Uri.parse('/projects/WebApplication'))
+        assert.strictEqual(location.toString(), 'file:///projects/devfile.yaml')
+    })
+
+    it('falls back to default workspace location when devfile cannot be located', async function () {
+        const devfilePath = vscode.Uri.parse('/projects/WebApplication/devfile.yaml').fsPath
+        sandbox.stub(fileSystemUtils, 'fileExists').callsFake(function (p: string) {
+            return p === devfilePath
+        })
+        const client = mockClient('devfile.yaml')
+        const location = await getDevfileLocation(client, vscode.Uri.parse('/projects/WebApplication'))
+        assert.strictEqual(location.toString(), 'file:///projects/WebApplication/devfile.yaml')
+    })
+
+    it('checks project root for devfile when location isnt specified', async function () {
+        const devfilePath = vscode.Uri.parse('/projects/devfile.yaml').fsPath
+        sandbox.stub(fileSystemUtils, 'fileExists').callsFake(function (p: string) {
+            return p === devfilePath
+        })
+        const client = mockClient(undefined)
+        const location = await getDevfileLocation(client, vscode.Uri.parse('/projects'))
+        assert.strictEqual(location.toString(), 'file:///projects/devfile.yaml')
+    })
+
+    it('checks workspace root for devfile when location isnt specified', async function () {
+        const devfilePath = vscode.Uri.parse('/projects/WebApplication/devfile.yaml').fsPath
+        sandbox.stub(fileSystemUtils, 'fileExists').callsFake(function (p: string) {
+            return p === devfilePath
+        })
+        const client = mockClient(undefined)
+        const location = await getDevfileLocation(client, vscode.Uri.parse('/projects/WebApplication'))
+        assert.strictEqual(location.toString(), 'file:///projects/WebApplication/devfile.yaml')
+    })
+})