Skip to content

fix(smus): update space before creating new app if space setting is changed #8173

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

Merged
merged 1 commit into from
Oct 15, 2025
Merged

fix(smus): update space before creating new app if space setting is changed #8173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 32 additions & 11 deletions packages/core/src/shared/clients/sagemaker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@ import { yes, no, continueText, cancel } from '../localizedText'
import { AwsCredentialIdentity } from '@aws-sdk/types'
import globals from '../extensionGlobals'

const appTypeSettingsMap: Record<string, string> = {
[AppType.JupyterLab as string]: 'JupyterLabAppSettings',
[AppType.CodeEditor as string]: 'CodeEditorAppSettings',
} as const

export interface SagemakerSpaceApp extends SpaceDetails {
App?: AppDetails
DomainSpaceKey: string
Expand Down Expand Up @@ -136,13 +141,13 @@ export class SagemakerClient extends ClientWrapper<SageMakerClient> {

// Get app type
const appType = spaceDetails.SpaceSettings?.AppType
if (appType !== 'JupyterLab' && appType !== 'CodeEditor') {
if (!appType || !(appType in appTypeSettingsMap)) {
throw new ToolkitError(`Unsupported AppType "${appType}" for space "${spaceName}"`)
}

// Get app resource spec
const requestedResourceSpec =
appType === 'JupyterLab'
appType === AppType.JupyterLab
Copy link
Contributor

@vpbhargav vpbhargav Oct 13, 2025

Choose a reason for hiding this comment

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

This is still prone to errors if someone updates the appTypeSettingsMap but does not update this condition. But fine for now. Ideal change would have been to use a case condition here as well.

? spaceDetails.SpaceSettings?.JupyterLabAppSettings?.DefaultResourceSpec
: spaceDetails.SpaceSettings?.CodeEditorAppSettings?.DefaultResourceSpec

Expand Down Expand Up @@ -181,16 +186,30 @@ export class SagemakerClient extends ClientWrapper<SageMakerClient> {
instanceType = InstanceTypeMinimum
}

// Get remote access flag
if (!spaceDetails.SpaceSettings?.RemoteAccess || spaceDetails.SpaceSettings?.RemoteAccess === 'DISABLED') {
// First, update the space if needed
const needsRemoteAccess =
!spaceDetails.SpaceSettings?.RemoteAccess || spaceDetails.SpaceSettings?.RemoteAccess === 'DISABLED'
const instanceTypeChanged = requestedResourceSpec?.InstanceType !== instanceType

if (needsRemoteAccess || instanceTypeChanged) {
const updateSpaceRequest: UpdateSpaceCommandInput = {
DomainId: domainId,
SpaceName: spaceName,
SpaceSettings: {
...(needsRemoteAccess && { RemoteAccess: 'ENABLED' }),
...(instanceTypeChanged && {
[appTypeSettingsMap[appType]]: {
DefaultResourceSpec: {
InstanceType: instanceType,
},
},
}),
},
}

try {
await this.updateSpace({
DomainId: domainId,
SpaceName: spaceName,
SpaceSettings: {
RemoteAccess: 'ENABLED',
},
})
getLogger().debug('SagemakerClient: Updating space: domainId=%s, spaceName=%s', domainId, spaceName)
await this.updateSpace(updateSpaceRequest)
await this.waitForSpaceInService(spaceName, domainId)
} catch (err) {
throw this.handleStartSpaceError(err)
Expand All @@ -214,6 +233,7 @@ export class SagemakerClient extends ClientWrapper<SageMakerClient> {
? { ...resourceSpec, EnvironmentArn: undefined, EnvironmentVersionArn: undefined }
: resourceSpec

// Second, create the App
const createAppRequest: CreateAppCommandInput = {
DomainId: domainId,
SpaceName: spaceName,
Expand All @@ -223,6 +243,7 @@ export class SagemakerClient extends ClientWrapper<SageMakerClient> {
}

try {
getLogger().debug('SagemakerClient: Creating app: domainId=%s, spaceName=%s', domainId, spaceName)
await this.createApp(createAppRequest)
} catch (err) {
throw this.handleStartSpaceError(err)
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/test/shared/clients/sagemakerClient.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,7 @@ describe('SagemakerClient.startSpace', function () {
getTestWindow().getFirstMessage().selectItem('Yes')

await promise
sinon.assert.calledOnce(updateSpaceStub)
sinon.assert.calledOnce(createAppStub)
})

Expand Down
4 changes: 4 additions & 0 deletions packages/toolkit/.changes/next-release/Bug Fix-f521ea3f-0ac5-4fc0-b939-9776b7a7fd88.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"type": "Bug Fix",
"description": "The space is updated upon creation of a new app with the requested settings"
}
Loading