Skip to content

fix(toolkit): initialize compute region in get call with a default value to fix extension activation failure #7527

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed

fix(toolkit): initialize compute region in get call with a default value to fix extension activation failure #7527

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
28c2610
fix(toolkit): initialize compute region in get call with a default va…
parameja1 Jun 18, 2025
f3e86fd
Merge branch 'aws:master' into master
parameja1 Jun 19, 2025
32d14e7
Merge branch 'aws:master' into master
parameja1 Jun 20, 2025
ee20d5e
fix(toolkit): refactor unit test to return default value when compute…
parameja1 Jun 20, 2025
1b149d8
Merge branch 'aws:master' into master
parameja1 Jun 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions packages/core/src/shared/extensionUtilities.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,9 +370,15 @@ export async function initializeComputeRegion(

export function getComputeRegion(): string | undefined {
if (computeRegion === notInitialized) {
throw new Error('Attempted to get compute region without initializing.')
Copy link
Contributor

@justinmk3 justinmk3 Jun 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By removing this, you are hiding a problem.

The error exists to ensure that order-of-operations is correct. After your change, that guarantee will no longer be possible.

It seems convenient now, but is a short-term solution with long-term consequences.

Copy link
Contributor Author

@parameja1 parameja1 Jun 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the question, though the Error is removed in terms of order-of-operations the above implementation ensures initializeComputeRegion is being called within getComputeRegion to handle case where user may not set it correctly. Also default region being set follows same logic from initializeComputeRegion

  • curious why not handle initialize region within get call above?

// Set a default value immediately to prevent future calls from throwing error
const isC9 = isCloud9()
const isSM = isSageMaker()
computeRegion = isC9 || isSM ? 'unknown' : undefined
// Start async initialization in the background
initializeComputeRegion(undefined, isC9, isSM).catch((e) => {
getLogger().error('Failed to initialize compute region: %s and using a default value: %s', e, computeRegion)
})
}

return computeRegion
}

Expand Down
11 changes: 4 additions & 7 deletions packages/core/src/test/shared/extensionUtilities.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,10 @@ describe('initializeComputeRegion, getComputeRegion', async function () {
sandbox.restore()
})

it('throws if the region has not been set', async function () {
// not quite a pure test: we call activate during the test load so this value will always be set
// manually hack in the notInitialized value to trigger the error
sandbox.stub(metadataService, 'getInstanceIdentity').resolves({ region: 'notInitialized' })

await initializeComputeRegion(metadataService, true)
assert.throws(getComputeRegion)
it('returns default value when region is not initialized', function () {
// Test the auto-initialization behavior when getComputeRegion is called before initialization
const result = getComputeRegion()
assert.ok(result === 'unknown' || result === undefined)
})

it('returns a compute region', async function () {
Expand Down
Loading