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

Add state apis #156

Merged
merged 10 commits into from
Jan 27, 2025
+1,203 −14
Merged

Add state apis #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
9b9895d
add libs
nikrooz Jan 27, 2025
b833a49
add routes
nikrooz Jan 27, 2025
2fa4182
add routes
nikrooz Jan 27, 2025
7f5e2bc
update animation
nikrooz Jan 27, 2025
ef35131
update title
nikrooz Jan 27, 2025
31c0dd7
add api
nikrooz Jan 27, 2025
9c24967
add api
nikrooz Jan 27, 2025
3899d49
fix type check
nikrooz Jan 27, 2025
9b3d8e9
update styles
nikrooz Jan 27, 2025
5cdd832
add non existenet deployment
nikrooz Jan 27, 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
11 changes: 10 additions & 1 deletion apps/web-ui/app/routes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
import { type RouteConfig, route, index } from '@react-router/dev/routes';
import {
type RouteConfig,
route,
index,
prefix,
} from '@react-router/dev/routes';

export default [
index('routes/_index.tsx'),
route('overview', 'routes/overview.tsx'),
route('invocations', 'routes/invocations.tsx'),
...prefix('state', [
index('routes/state.tsx'),
route(':virtualObject', 'routes/virtual-object.tsx'),
]),
] satisfies RouteConfig;
6 changes: 6 additions & 0 deletions apps/web-ui/app/routes/state.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import { state } from '@restate/features/state-route';

export function meta() {
return [{ title: 'Restate - State' }];
}
export default state.Component;
7 changes: 7 additions & 0 deletions apps/web-ui/app/routes/virtual-object.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { virtualObject } from '@restate/features/state-object-route';
import { MetaFunction } from 'react-router';

export const meta: MetaFunction = (args) => {
return [{ title: `Restate - State - ${args.params.virtualObject}` }];
};
export default virtualObject.Component;
53 changes: 51 additions & 2 deletions libs/data-access/admin-api/src/lib/api/hooks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -409,14 +409,44 @@ export function useGetVirtualObjectState(
};
}

export function useGetVirtualObjectStateInterface(
export function useQueryVirtualObjectState(
serviceName: string,
options?: HookQueryOptions<'/query/services/{name}/state', 'get'>
filters?: FilterItem[],
options?: HookQueryOptions<'/query/services/{name}/state', 'post'>
) {
const baseUrl = useAdminBaseUrl();
const queryOptions = adminApi(
'query',
'/query/services/{name}/state',
'post',
{
baseUrl,
parameters: { path: { name: serviceName } },
body: {
filters,
},
}
);

const results = useQuery({
...queryOptions,
...options,
});

return {
...results,
queryKey: queryOptions.queryKey,
};
}

export function useGetVirtualObjectStateInterface(
serviceName: string,
options?: HookQueryOptions<'/query/services/{name}/state/keys', 'get'>
) {
const baseUrl = useAdminBaseUrl();
const queryOptions = adminApi(
'query',
'/query/services/{name}/state/keys',
'get',
{
baseUrl,
Expand All @@ -435,6 +465,25 @@ export function useGetVirtualObjectStateInterface(
};
}

export function useGetStateInterface(
options?: HookQueryOptions<'/query/services/state', 'get'>
) {
const baseUrl = useAdminBaseUrl();
const queryOptions = adminApi('query', '/query/services/state', 'get', {
baseUrl,
});

const results = useQuery({
...queryOptions,
...options,
});

return {
...results,
queryKey: queryOptions.queryKey,
};
}

export function useDeleteInvocation(
invocation_id: string,
options?: HookMutationOptions<'/invocations/{invocation_id}', 'delete'>
Expand Down
198 changes: 197 additions & 1 deletion libs/data-access/admin-api/src/lib/api/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,7 @@ export interface paths {
patch?: never;
trace?: never;
};
'/query/services/{name}/state': {
'/query/services/{name}/state/keys': {
parameters: {
query?: never;
header?: never;
Expand All @@ -421,6 +421,26 @@ export interface paths {
patch?: never;
trace?: never;
};
'/query/services/{name}/state': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* List virtual object state
* @description List virtual object state
*/
post: operations['list_virtual_object_state'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/query/services/{name}/keys/{key}/state': {
parameters: {
query?: never;
Expand All @@ -441,6 +461,26 @@ export interface paths {
patch?: never;
trace?: never;
};
'/query/services/state': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List state
* @description List state
*/
get: operations['list_state'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
}
export type webhooks = Record<string, never>;
export interface components {
Expand Down Expand Up @@ -830,9 +870,13 @@ export interface components {
*/
services: components['schemas']['ServiceMetadata'][];
};
VirtualObjectState: string[];
ListInvocationsRequestBody: {
filters?: components['schemas']['FilterItem'][];
};
ListVirtualObjectStateRequestBody: {
filters?: components['schemas']['FilterItem'][];
};
FilterItem: components['schemas']['FilterBaseItem'] &
(
| components['schemas']['FilterNumberItem']
Expand Down Expand Up @@ -2781,6 +2825,86 @@ export interface operations {
};
};
};
list_virtual_object_state: {
parameters: {
query?: never;
header?: never;
path: {
/** @description service name */
name: string;
};
cookie?: never;
};
requestBody: {
content: {
'application/json': components['schemas']['ListVirtualObjectStateRequestBody'];
};
};
responses: {
200: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': {
objects: (components['schemas']['StateResponse'] & {
key?: string;
})[];
total_count: number;
limit?: number;
};
};
};
400: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['ErrorDescriptionResponse'];
};
};
403: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['ErrorDescriptionResponse'];
};
};
404: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['ErrorDescriptionResponse'];
};
};
409: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['ErrorDescriptionResponse'];
};
};
500: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['ErrorDescriptionResponse'];
};
};
503: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['ErrorDescriptionResponse'];
};
};
};
};
get_state: {
parameters: {
query?: never;
Expand Down Expand Up @@ -2853,4 +2977,76 @@ export interface operations {
};
};
};
list_state: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': {
objects: {
name: string;
keys: components['schemas']['StateInterfaceResponse'][];
}[];
};
};
};
400: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['ErrorDescriptionResponse'];
};
};
403: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['ErrorDescriptionResponse'];
};
};
404: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['ErrorDescriptionResponse'];
};
};
409: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['ErrorDescriptionResponse'];
};
};
500: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['ErrorDescriptionResponse'];
};
};
503: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['ErrorDescriptionResponse'];
};
};
};
};
}
Loading
Loading