Skip to content
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

feat(application): adding start stop actions #1122

Merged
merged 6 commits into from
May 28, 2024
Merged

feat(application): adding start stop actions #1122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e42f5e8
feat(application): adding start stop actions
axel7083 May 27, 2024
bb63d91
fix: pod status
axel7083 May 27, 2024
9119ceb
fix: studio api impl tests
axel7083 May 27, 2024
2f098c0
Apply suggestions from code review
axel7083 May 28, 2024
9ebb3e0
fix: application status
axel7083 May 28, 2024
3a13120
fix: application manager tests
axel7083 May 28, 2024
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
45 changes: 23 additions & 22 deletions packages/backend/src/managers/applicationManager.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,8 @@ const mocks = vi.hoisted(() => {
parseYamlFileMock: vi.fn(),
listImagesMock: vi.fn(),
getImageInspectMock: vi.fn(),
createPodMock: vi.fn(),
createContainerMock: vi.fn(),
startContainerMock: vi.fn(),
startPod: vi.fn(),
inspectContainerMock: vi.fn(),
logUsageMock: vi.fn(),
logErrorMock: vi.fn(),
Expand All @@ -69,8 +67,6 @@ const mocks = vi.hoisted(() => {
startupSubscribeMock: vi.fn(),
onMachineStopMock: vi.fn(),
listContainersMock: vi.fn(),
stopPodMock: vi.fn(),
removePodMock: vi.fn(),
performDownloadMock: vi.fn(),
getTargetMock: vi.fn(),
onEventDownloadMock: vi.fn(),
Expand Down Expand Up @@ -104,16 +100,12 @@ vi.mock('@podman-desktop/api', () => ({
containerEngine: {
listImages: mocks.listImagesMock,
getImageInspect: mocks.getImageInspectMock,
createPod: mocks.createPodMock,
createContainer: mocks.createContainerMock,
startContainer: mocks.startContainerMock,
startPod: mocks.startPod,
inspectContainer: mocks.inspectContainerMock,
pullImage: mocks.pullImageMock,
stopContainer: mocks.stopContainerMock,
listContainers: mocks.listContainersMock,
stopPod: mocks.stopPodMock,
removePod: mocks.removePodMock,
},
Disposable: {
create: vi.fn(),
Expand Down Expand Up @@ -146,6 +138,10 @@ const podManager = {
getPodsWithLabels: vi.fn(),
getHealth: vi.fn(),
getPod: vi.fn(),
createPod: vi.fn(),
stopPod: vi.fn(),
removePod: vi.fn(),
startPod: vi.fn(),
} as unknown as PodManager;

const localRepositoryRegistry = {
Expand Down Expand Up @@ -235,7 +231,7 @@ describe('pullApplication', () => {
Id: 'id1',
},
]);
mocks.createPodMock.mockResolvedValue({
vi.mocked(podManager.createPod).mockResolvedValue({
engineId: 'engine',
Id: 'id',
});
Expand Down Expand Up @@ -274,6 +270,7 @@ describe('pullApplication', () => {
);
}
test('pullApplication should clone repository and call downloadModelMain and buildImage', async () => {
vi.mocked(podManager.getPodsWithLabels).mockResolvedValue([]);
mockForPullApplication({
recipeFolderExists: false,
});
Expand Down Expand Up @@ -423,6 +420,7 @@ describe('pullApplication', () => {
);
});
test('pullApplication should not download model if already on disk', async () => {
vi.mocked(podManager.getPodsWithLabels).mockResolvedValue([]);
mockForPullApplication({
recipeFolderExists: true,
});
Expand Down Expand Up @@ -723,12 +721,12 @@ describe('createPod', async () => {
vi.spyOn(portsUtils, 'getPortsInfo').mockResolvedValueOnce('9000');
vi.spyOn(portsUtils, 'getPortsInfo').mockResolvedValueOnce('9001');
vi.spyOn(portsUtils, 'getPortsInfo').mockResolvedValueOnce('9002');
mocks.createPodMock.mockResolvedValue({
vi.mocked(podManager.createPod).mockResolvedValue({
Id: 'podId',
engineId: 'engineId',
});
await manager.createPod({ id: 'recipe-id' } as Recipe, { id: 'model-id' } as ModelInfo, images);
expect(mocks.createPodMock).toBeCalledWith({
expect(podManager.createPod).toBeCalledWith({
name: expect.anything(),
portmappings: [
{
Expand Down Expand Up @@ -870,10 +868,11 @@ describe('runApplication', () => {
],
} as unknown as PodInfo;
test('check startPod is called and also waitContainerIsRunning for sample app', async () => {
vi.mocked(podManager.getPodsWithLabels).mockResolvedValue([]);
const waitContainerIsRunningMock = vi.spyOn(manager, 'waitContainerIsRunning').mockResolvedValue(undefined);
vi.spyOn(utils, 'timeout').mockResolvedValue();
await manager.runApplication(pod);
expect(mocks.startPod).toBeCalledWith(pod.engineId, pod.Id);
expect(podManager.startPod).toBeCalledWith(pod.engineId, pod.Id);
expect(waitContainerIsRunningMock).toBeCalledWith(pod.engineId, {
Id: 'dummyContainerId',
});
Expand Down Expand Up @@ -1150,7 +1149,7 @@ describe('pod detection', async () => {
const sendApplicationStateSpy = vi.spyOn(manager, 'notify').mockResolvedValue();
manager.adoptRunningApplications();
await new Promise(resolve => setTimeout(resolve, 10));
expect(sendApplicationStateSpy).toHaveBeenCalledTimes(2);
expect(sendApplicationStateSpy).toHaveBeenCalledTimes(1);
});

test('onPodRemove updates the applications state by removing the removed pod', async () => {
Expand Down Expand Up @@ -1198,7 +1197,8 @@ describe('pod detection', async () => {
});
});

test('deleteApplication calls stopPod and removePod', async () => {
test('removeApplication calls stopPod and removePod', async () => {
vi.mocked(podManager.getPodsWithLabels).mockResolvedValue([]);
vi.mocked(podManager.findPodByLabelsValues).mockResolvedValue({
engineId: 'engine-1',
Id: 'pod-1',
Expand All @@ -1207,12 +1207,13 @@ describe('pod detection', async () => {
'ai-lab-model-id': 'model-id-1',
},
} as unknown as PodInfo);
await manager.deleteApplication('recipe-id-1', 'model-id-1');
expect(mocks.stopPodMock).toHaveBeenCalledWith('engine-1', 'pod-1');
expect(mocks.removePodMock).toHaveBeenCalledWith('engine-1', 'pod-1');
await manager.removeApplication('recipe-id-1', 'model-id-1');
expect(podManager.stopPod).toHaveBeenCalledWith('engine-1', 'pod-1');
expect(podManager.removePod).toHaveBeenCalledWith('engine-1', 'pod-1');
});

test('deleteApplication calls stopPod and removePod even if stopPod fails because pod already stopped', async () => {
test('removeApplication calls stopPod and removePod even if stopPod fails because pod already stopped', async () => {
vi.mocked(podManager.getPodsWithLabels).mockResolvedValue([]);
vi.mocked(podManager.findPodByLabelsValues).mockResolvedValue({
engineId: 'engine-1',
Id: 'pod-1',
Expand All @@ -1221,10 +1222,10 @@ describe('pod detection', async () => {
'ai-lab-model-id': 'model-id-1',
},
} as unknown as PodInfo);
mocks.stopPodMock.mockRejectedValue('something went wrong, pod already stopped...');
await manager.deleteApplication('recipe-id-1', 'model-id-1');
expect(mocks.stopPodMock).toHaveBeenCalledWith('engine-1', 'pod-1');
expect(mocks.removePodMock).toHaveBeenCalledWith('engine-1', 'pod-1');
vi.mocked(podManager.stopPod).mockRejectedValue('something went wrong, pod already stopped...');
await manager.removeApplication('recipe-id-1', 'model-id-1');
expect(podManager.stopPod).toHaveBeenCalledWith('engine-1', 'pod-1');
expect(podManager.removePod).toHaveBeenCalledWith('engine-1', 'pod-1');
});

test('adoptRunningApplications should check pods health', async () => {
Expand Down
134 changes: 79 additions & 55 deletions packages/backend/src/managers/applicationManager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ export class ApplicationManager extends Publisher<ApplicationState[]> implements

// first delete any existing pod with matching labels
if (await this.hasApplicationPod(recipe.id, model.id)) {
await this.deleteApplication(recipe.id, model.id);
await this.removeApplication(recipe.id, model.id);
}

// create a pod containing all the containers to run the application
Expand All @@ -213,7 +213,7 @@ export class ApplicationManager extends Publisher<ApplicationState[]> implements
const task = this.taskRegistry.createTask('Starting AI App', 'loading', labels);

// it starts the pod
await containerEngine.startPod(podInfo.engineId, podInfo.Id);
await this.podManager.startPod(podInfo.engineId, podInfo.Id);

// check if all containers have started successfully
for (const container of podInfo.Containers ?? []) {
Expand All @@ -226,6 +226,8 @@ export class ApplicationManager extends Publisher<ApplicationState[]> implements
state: 'success',
name: 'AI App is running',
});

return this.checkPodsHealth();
}

async waitContainerIsRunning(engineId: string, container: PodContainerInfo): Promise<void> {
Expand Down Expand Up @@ -387,7 +389,7 @@ export class ApplicationManager extends Publisher<ApplicationState[]> implements
if (appPorts.length) {
labels[LABEL_APP_PORTS] = appPorts.join(',');
}
const { engineId, Id } = await containerEngine.createPod({
const { engineId, Id } = await this.podManager.createPod({
name: getRandomName(`pod-${sampleAppImageInfo.appName}`),
portmappings: portmappings,
labels,
Expand All @@ -396,6 +398,59 @@ export class ApplicationManager extends Publisher<ApplicationState[]> implements
return this.podManager.getPod(engineId, Id);
}

/**
* Stop the pod with matching recipeId and modelId
* @param recipeId
* @param modelId
*/
async stopApplication(recipeId: string, modelId: string): Promise<PodInfo> {
// clear existing tasks
this.clearTasks(recipeId, modelId);

// get the application pod
const appPod = await this.getApplicationPod(recipeId, modelId);

// if the pod is already stopped skip
if (appPod.Status === 'Exited') {
return appPod;
}

// create a task to follow progress/error
const stoppingTask = this.taskRegistry.createTask(`Stopping AI App`, 'loading', {
'recipe-id': recipeId,
'model-id': modelId,
});

try {
await this.podManager.stopPod(appPod.engineId, appPod.Id);

stoppingTask.state = 'success';
stoppingTask.name = `AI App Stopped`;
} catch (err: unknown) {
stoppingTask.error = `Error removing the pod.: ${String(err)}`;
stoppingTask.name = 'Error stopping AI App';
} finally {
this.taskRegistry.updateTask(stoppingTask);
await this.checkPodsHealth();
}
return appPod;
}

/**
* Utility method to start a pod using (recipeId, modelId)
* @param recipeId
* @param modelId
*/
async startApplication(recipeId: string, modelId: string): Promise<void> {
this.clearTasks(recipeId, modelId);
const pod = await this.getApplicationPod(recipeId, modelId);

return this.runApplication(pod, {
'recipe-id': recipeId,
'model-id': modelId,
});
}

private getConfigAndFilterContainers(
recipeBaseDir: string | undefined,
localFolder: string,
Expand Down Expand Up @@ -526,9 +581,6 @@ export class ApplicationManager extends Publisher<ApplicationState[]> implements
this.podmanConnection.onPodStart((pod: PodInfo) => {
this.adoptPod(pod);
});
this.podmanConnection.onPodStop((pod: PodInfo) => {
this.forgetPod(pod);
});
this.podmanConnection.onPodRemove((podId: string) => {
this.forgetPodById(podId);
});
Expand Down Expand Up @@ -576,32 +628,6 @@ export class ApplicationManager extends Publisher<ApplicationState[]> implements
this.updateApplicationState(recipeId, modelId, state);
}

private forgetPod(pod: PodInfo) {
if (!pod.Labels) {
return;
}
const recipeId = pod.Labels[LABEL_RECIPE_ID];
const modelId = pod.Labels[LABEL_MODEL_ID];
if (!recipeId || !modelId) {
return;
}
if (!this.#applications.has({ recipeId, modelId })) {
return;
}
this.#applications.delete({ recipeId, modelId });
this.notify();

const protect = this.protectTasks.has(pod.Id);
if (!protect) {
this.taskRegistry.createTask('AI App stopped manually', 'success', {
'recipe-id': recipeId,
'model-id': modelId,
});
} else {
this.protectTasks.delete(pod.Id);
}
}

private forgetPodById(podId: string) {
const app = Array.from(this.#applications.values()).find(p => p.pod.Id === podId);
if (!app) {
Expand Down Expand Up @@ -671,47 +697,45 @@ export class ApplicationManager extends Publisher<ApplicationState[]> implements
return Array.from(this.#applications.values());
}

async deleteApplication(recipeId: string, modelId: string): Promise<void> {
private clearTasks(recipeId: string, modelId: string): void {
// clear any existing status / tasks related to the pair recipeId-modelId.
this.taskRegistry.deleteByLabels({
'recipe-id': recipeId,
'model-id': modelId,
});
}

const stoppingTask = this.taskRegistry.createTask(`Stopping AI App`, 'loading', {
/**
* Method that will stop then remove a pod corresponding to the recipe and model provided
* @param recipeId
* @param modelId
*/
async removeApplication(recipeId: string, modelId: string): Promise<void> {
const appPod = await this.stopApplication(recipeId, modelId);

const remoteTask = this.taskRegistry.createTask(`Removing AI App`, 'loading', {
'recipe-id': recipeId,
'model-id': modelId,
});
// protect the task
this.protectTasks.add(appPod.Id);

try {
const appPod = await this.getApplicationPod(recipeId, modelId);
try {
await containerEngine.stopPod(appPod.engineId, appPod.Id);
} catch (err: unknown) {
// continue when the pod is already stopped
if (!String(err).includes('pod already stopped')) {
stoppingTask.error = 'error stopping the pod. Please try to stop and remove the pod manually';
stoppingTask.name = 'Error stopping AI App';
this.taskRegistry.updateTask(stoppingTask);
throw err;
}
}
this.protectTasks.add(appPod.Id);
await containerEngine.removePod(appPod.engineId, appPod.Id);
await this.podManager.removePod(appPod.engineId, appPod.Id);

stoppingTask.state = 'success';
stoppingTask.name = `AI App stopped`;
remoteTask.state = 'success';
remoteTask.name = `AI App Removed`;
} catch (err: unknown) {
stoppingTask.error = 'error removing the pod. Please try to remove the pod manually';
stoppingTask.name = 'Error stopping AI App';
throw err;
remoteTask.error = 'error removing the pod. Please try to remove the pod manually';
remoteTask.name = 'Error stopping AI App';
} finally {
this.taskRegistry.updateTask(stoppingTask);
this.taskRegistry.updateTask(remoteTask);
}
}

async restartApplication(recipeId: string, modelId: string): Promise<void> {
const appPod = await this.getApplicationPod(recipeId, modelId);
await this.deleteApplication(recipeId, modelId);
await this.removeApplication(recipeId, modelId);
const recipe = this.catalogManager.getRecipeById(recipeId);
const model = this.catalogManager.getModelById(appPod.Labels[LABEL_MODEL_ID]);

Expand Down
Loading