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.

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

Add Register Model and Register Model Version form #431

Merged
merged 1 commit into from
Sep 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 18 additions & 0 deletions clients/ui/frontend/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions clients/ui/frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@
"@patternfly/react-icons": "6.0.0-alpha.37",
"@patternfly/react-styles": "6.0.0-alpha.35",
"@patternfly/react-table": "6.0.0-alpha.101",
"@patternfly/react-templates": "6.0.0-alpha.50",
"lodash-es": "^4.17.15",
"npm-run-all": "^4.1.5",
"react": "^18",
Expand Down
4 changes: 2 additions & 2 deletions clients/ui/frontend/src/__mocks__/mockBFFResponse.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { ModelRegistryResponse } from '~/app/types';
import { ModelRegistryBody } from '~/app/types';

export const mockBFFResponse = <T>(data: T): ModelRegistryResponse<T> => ({
export const mockBFFResponse = <T>(data: T): ModelRegistryBody<T> => ({
data,
});
4 changes: 2 additions & 2 deletions clients/ui/frontend/src/__mocks__/utils.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import {
ModelRegistryMetadataType,
ModelRegistryResponse,
ModelRegistryBody,
ModelRegistryStringCustomProperties,
} from '~/app/types';

Expand All @@ -16,6 +16,6 @@ export const createModelRegistryLabelsObject = (
return acc;
}, {} as ModelRegistryStringCustomProperties);

export const mockBFFResponse = <T>(data: T): ModelRegistryResponse<T> => ({
export const mockBFFResponse = <T>(data: T): ModelRegistryBody<T> => ({
data,
});
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import type {
ModelArtifact,
ModelArtifactList,
ModelRegistry,
ModelRegistryResponse,
ModelRegistryBody,
ModelVersion,
ModelVersionList,
RegisteredModel,
Expand Down Expand Up @@ -35,7 +35,7 @@ declare global {
interceptApi: ((
type: 'GET /api/:apiVersion/model_registry/:modelRegistryName/registered_models',
options: { path: { modelRegistryName: string; apiVersion: string } },
response: ApiResponse<ModelRegistryResponse<RegisteredModelList>>,
response: ApiResponse<ModelRegistryBody<RegisteredModelList>>,
) => Cypress.Chainable<null>) &
((
type: 'POST /api/:apiVersion/model_registry/:modelRegistryName/registered_models',
Expand All @@ -47,7 +47,7 @@ declare global {
options: {
path: { modelRegistryName: string; apiVersion: string; registeredModelId: number };
},
response: ApiResponse<ModelRegistryResponse<ModelVersionList>>,
response: ApiResponse<ModelRegistryBody<ModelVersionList>>,
) => Cypress.Chainable<null>) &
((
type: 'POST /api/:apiVersion/model_registry/:modelRegistryName/registered_models/:registeredModelId/versions',
Expand All @@ -61,28 +61,28 @@ declare global {
options: {
path: { modelRegistryName: string; apiVersion: string; registeredModelId: number };
},
response: ApiResponse<ModelRegistryResponse<RegisteredModel>>,
response: ApiResponse<ModelRegistryBody<RegisteredModel>>,
) => Cypress.Chainable<null>) &
((
type: 'PATCH /api/:apiVersion/model_registry/:modelRegistryName/registered_models/:registeredModelId',
options: {
path: { modelRegistryName: string; apiVersion: string; registeredModelId: number };
},
response: ApiResponse<ModelRegistryResponse<RegisteredModel>>,
response: ApiResponse<ModelRegistryBody<RegisteredModel>>,
) => Cypress.Chainable<null>) &
((
type: 'GET /api/:apiVersion/model_registry/:modelRegistryName/model_versions/:modelVersionId',
options: {
path: { modelRegistryName: string; apiVersion: string; modelVersionId: number };
},
response: ApiResponse<ModelRegistryResponse<ModelVersion>>,
response: ApiResponse<ModelRegistryBody<ModelVersion>>,
) => Cypress.Chainable<null>) &
((
type: 'GET /api/:apiVersion/model_registry/:modelRegistryName/model_versions/:modelVersionId/artifacts',
options: {
path: { modelRegistryName: string; apiVersion: string; modelVersionId: number };
},
response: ApiResponse<ModelRegistryResponse<ModelArtifactList>>,
response: ApiResponse<ModelRegistryBody<ModelArtifactList>>,
) => Cypress.Chainable<null>) &
((
type: 'POST /api/:apiVersion/model_registry/:modelRegistryName/model_versions/:modelVersionId/artifacts',
Expand All @@ -101,7 +101,7 @@ declare global {
((
type: 'GET /api/:apiVersion/model_registry',
options: { path: { apiVersion: string } },
response: ApiResponse<ModelRegistryResponse<ModelRegistry[]>>,
response: ApiResponse<ModelRegistryBody<ModelRegistry[]>>,
) => Cypress.Chainable<null>);
}
}
Expand Down
17 changes: 9 additions & 8 deletions clients/ui/frontend/src/app/api/__tests__/service.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ jest.mock('~/app/api/apiUtils', () => ({
restCREATE: jest.fn(() => mockRestPromise),
restGET: jest.fn(() => mockRestPromise),
restPATCH: jest.fn(() => mockRestPromise),
assembleModelRegistryBody: jest.fn(() => ({})),
isModelRegistryResponse: jest.fn(() => true),
}));

Expand Down Expand Up @@ -61,7 +62,7 @@ describe('createRegisteredModel', () => {
expect(restCREATEMock).toHaveBeenCalledWith(
`/api/${BFF_API_VERSION}/model_registry/model-registry-1/`,
`/registered_models`,
mockData,
{},
{},
APIOptionsMock,
);
Expand Down Expand Up @@ -89,7 +90,7 @@ describe('createModelVersion', () => {
expect(restCREATEMock).toHaveBeenCalledWith(
`/api/${BFF_API_VERSION}/model_registry/model-registry-1/`,
`/model_versions`,
mockData,
{},
{},
APIOptionsMock,
);
Expand Down Expand Up @@ -117,7 +118,7 @@ describe('createModelVersionForRegisteredModel', () => {
expect(restCREATEMock).toHaveBeenCalledWith(
`/api/${BFF_API_VERSION}/model_registry/model-registry-1/`,
`/registered_models/1/versions`,
mockData,
{},
{},
APIOptionsMock,
);
Expand Down Expand Up @@ -150,7 +151,7 @@ describe('createModelArtifact', () => {
expect(restCREATEMock).toHaveBeenCalledWith(
`/api/${BFF_API_VERSION}/model_registry/model-registry-1/`,
`/model_artifacts`,
mockData,
{},
{},
APIOptionsMock,
);
Expand Down Expand Up @@ -183,7 +184,7 @@ describe('createModelArtifactForModelVersion', () => {
expect(restCREATEMock).toHaveBeenCalledWith(
`/api/${BFF_API_VERSION}/model_registry/model-registry-1/`,
`/model_versions/2/artifacts`,
mockData,
{},
{},
APIOptionsMock,
);
Expand Down Expand Up @@ -347,7 +348,7 @@ describe('patchRegisteredModel', () => {
expect(restPATCHMock).toHaveBeenCalledWith(
`/api/${BFF_API_VERSION}/model_registry/model-registry-1/`,
`/registered_models/1`,
mockData,
{},
APIOptionsMock,
);
expect(handleRestFailuresMock).toHaveBeenCalledTimes(1);
Expand All @@ -366,7 +367,7 @@ describe('patchModelVersion', () => {
expect(restPATCHMock).toHaveBeenCalledWith(
`/api/${BFF_API_VERSION}/model_registry/model-registry-1/`,
`/model_versions/1`,
mockData,
{},
APIOptionsMock,
);
expect(handleRestFailuresMock).toHaveBeenCalledTimes(1);
Expand All @@ -385,7 +386,7 @@ describe('patchModelArtifact', () => {
expect(restPATCHMock).toHaveBeenCalledWith(
`/api/${BFF_API_VERSION}/model_registry/model-registry-1/`,
`/model_artifacts/1`,
mockData,
{},
APIOptionsMock,
);
expect(handleRestFailuresMock).toHaveBeenCalledTimes(1);
Expand Down
14 changes: 8 additions & 6 deletions clients/ui/frontend/src/app/api/apiUtils.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { APIOptions } from '~/app/api/types';
import { EitherOrNone } from '~/typeHelpers';
import { ModelRegistryResponse } from '~/app/types';
import { ModelRegistryBody } from '~/app/types';

export const mergeRequestInit = (
opts: APIOptions = {},
Expand Down Expand Up @@ -163,14 +163,16 @@ export const restDELETE = <T>(
parseJSON: options?.parseJSON,
});

export const isModelRegistryResponse = <T>(
response: unknown,
): response is ModelRegistryResponse<T> => {
export const isModelRegistryResponse = <T>(response: unknown): response is ModelRegistryBody<T> => {
if (typeof response === 'object' && response !== null) {
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
const modelRegistryResponse = response as { data?: T };
const modelRegistryBody = response as { data?: T };
// TODO: Check if data is conforming any type so we have a proper check
return modelRegistryResponse.data !== undefined;
return modelRegistryBody.data !== undefined;
}
return false;
};

export const assembleModelRegistryBody = <T>(data: T): ModelRegistryBody<T> => ({
data,
});
Loading