Autogenerated RPC types by duzda · Pull Request #1136 · freeipa/freeipa-webui

duzda · 2026-07-09T13:14:03Z

No description provided.

Introduce shared aliases for FreeIPA wire types used by generated request and metadata definitions. Co-authored-by: Cursor <cursoragent@cursor.com> Signed-off-by: David Hanina <dhanina@redhat.com>

Define ParamType, ParamClass, and per-class parameter shapes derived from IPA json_metadata output. Co-authored-by: Cursor <cursoragent@cursor.com> Signed-off-by: David Hanina <dhanina@redhat.com>

Model IPA object relationships, methods, and attribute metadata for type-safe API usage. Co-authored-by: Cursor <cursoragent@cursor.com> Signed-off-by: David Hanina <dhanina@redhat.com>

Introduce ValidResponse, ErrorResponse, and batch response types for IPA JSON-RPC calls. Co-authored-by: Cursor <cursoragent@cursor.com> Signed-off-by: David Hanina <dhanina@redhat.com>

Provide Python tooling to produce param and request type definitions from json_metadata responses. Co-authored-by: Cursor <cursoragent@cursor.com> Signed-off-by: David Hanina <dhanina@redhat.com>

Pass methodname and command filters and call the JSON endpoint directly so metadata generation receives complete object definitions. Co-authored-by: Cursor <cursoragent@cursor.com> Signed-off-by: David Hanina <dhanina@redhat.com>

Introduce per-object Args and Options types plus a RequestMap index for all IPA API methods, with a typed request method helper. Co-authored-by: Cursor <cursoragent@cursor.com> Signed-off-by: David Hanina <dhanina@redhat.com>

Adds requests, which adds a RequestMethod type that forces the developer to use the correct types for args and options. Assisted-by: Cursor cursoragent@cursor.com Signed-off-by: David Hanina <dhanina@redhat.com>

sourcery-ai

Sorry @duzda, your pull request is larger than the review limit of 150000 diff characters

duzda · 2026-07-09T13:14:23Z

This includes only the initial types for requests, responses will come later

veronnicka

Hi, I just have a lot of questions as I tried to understand it. There are some comments I think worth double checking. I didnt try running the scripts but I can in the second review if you want me to.

veronnicka · 2026-07-14T07:14:58Z

+export type Decimal = number;
+export type Principal = string;
+export type Bytes = string;
+export type DateTime = string;


Dont we want to check? maybe
type ISODateString = ${number}-${number}-${number};

This code doesn't check, but good idea to dig into the exact type, my idea is to use this alias to know that the value is datetime convertible.

veronnicka · 2026-07-14T07:46:00Z

+  rdn_attribute: string;
+  bindable: boolean;
+  relationships: Relationships;
+  primary_key: string;


But you are already adding the PrimaryKeyObjectMetadata, so why have the primary_key here?

This is an oversight, thank you.

veronnicka · 2026-07-14T07:48:09Z

+  ObjectMetadata<T>;
+
+type ObjectRecord<T extends string> = {
+  [K in T]: ObjectMetadata<T> | ComplexObjectMetadata<T>;


You are not using the K here. Did you mean ObjectMetadata<K> ?

veronnicka · 2026-07-14T08:06:21Z

+
+def convert_name(name: str) -> str:
+    """
+    Convert from snake_case to PascalCase.


isnt there some library to do this 😢

return name.title().replace("_", "")

veronnicka · 2026-07-14T08:09:55Z

+                if p not in classes[param["class"]]:
+                    classes[param["class"]].add(p)
+
+    intersection = set.intersection(*classes.values())


why are we interested in the intersections?

The intersections model ParamMetadataBase, those variables are repeated throughout every type, therefore to save a bit of lines and complexity all the further types extend this one.

Intersections: ['alwaysask', 'attribute', 'autofill', 'class', 'cli_metavar', 'cli_name', 'confirm', 'deprecated', 'deprecated_cli_aliases', 'doc', 'flags', 'label', 'multivalue', 'name', 'no_convert', 'primary_key', 'query', 'required', 'sortorder', 'type'] Classes without intersection: Str: ['default', 'exclude', 'maxlength', 'minlength', 'noextrawhitespace', 'option_group', 'pattern', 'pattern_errmsg'] StrEnum: ['default', 'exclude', 'option_group', 'values'] Flag: ['default', 'falsehoods', 'option_group', 'truths'] DNParam: [] IA5Str: ['noextrawhitespace'] Bytes: [] ...

veronnicka · 2026-07-14T08:12:47Z

+        };
+      },
+      transformResponse: (response: ShowRPCResponse): Metadata => {
+        console.log(response);


This change will be later reverted :)

veronnicka · 2026-07-14T08:13:22Z

+              [],
+              {
+                object: "all",
+                methodname: "all",


why the addition of methodname and command ?

This change will be later reverted :)

veronnicka · 2026-07-14T08:20:07Z

@@ -0,0 +1,17 @@
+import { RequestMap } from "./requests";
+
+type ObjectValueTuple<T> = {


Could you give me an example of this type please?

carma12

I will probably come back to this PR to do further review, but please find some initial thoughts in my comments below.

carma12 · 2026-07-14T14:37:53Z

+  ? []
+  : ObjectValueTuple<T>;
+
+type RequestMethod = <const T extends keyof RequestMap>(


This function seems to be declared but never used?

Yes, there will be many more unused types and functions, this will be fixed later, just trying to get some initial ideas and issues.

carma12 · 2026-07-14T14:55:20Z

Not sure of the clarity of this file's name. It seems to be a diagnostic/analysis tool, not a generator despite its name. Consider renaming it to analyze-param-classes.py or similar.

Good idea, such name will be much more fitting.

carma12 · 2026-07-15T08:24:08Z

+type ObjectValueTuple<T> = {
+  [K in keyof T]-?: (x: T[K], ...args: ObjectValueTuple<Omit<T, K>>) => void;
+} extends (x: infer V, ...args: infer R) => void
+  ? [V, ...R]
+  : [];


The IPA server expects commands in this shape: params: [[positional_args], {named_options}]. The positional args are an ordered array: the first item is always the first argument, the second is the second, etc.

IINM, the ObjectValueTuple function takes a TypeScript object like { uid: string; krbprincipalname: Principal } and tries to convert it into a tuple like [string, Principal]. The problem I see with this is: TypeScript objects don't have a guaranteed order, so the data might be unsorted or not adjusted to what the API calls are expecting. But I'm not 100% if I'm mistaking this, so it might be checked...

Yes, as of TypeScript 5, the order is not guaranteed, however TypeScript 6 and 7 have this guarantee https://www.typescriptlang.org/docs/handbook/release-notes/typescript-6-0.html#the---stabletypeordering-flag

carma12 · 2026-07-15T08:24:32Z

+type ValidBatch<T> = {
+  error: null;
+  result: T;
+  truncated: boolean;
+  summary?: string;
+};
+
+type ErrorBatch = {
+  error: string;
+  error_code: number;
+  error_kw: {
+    reason: string;
+  };
+  error_name: string;
+};
+
+type RequestBatch = {
+  requests: Request[];
+};
+
+type RequestBatchResponse = {
+  responses: Response[];
+};


Declared but never used.

I'm still trying to figure out what to do with these types, on top of that they are incorrect at the moment.

carma12 · 2026-07-15T08:26:39Z

+
+export type ParamFindOptions = {
+  all: boolean;
+  raw: boolean;


Not sure if this parameter should be optional as well (depending on some API calls)?

For some reason this type is described as mandatory, even though it is not true...

duzda and others added 8 commits July 9, 2026 15:12

Add primitive types for IPA API metadata.

fd6dd20

Introduce shared aliases for FreeIPA wire types used by generated request and metadata definitions. Co-authored-by: Cursor <cursoragent@cursor.com> Signed-off-by: David Hanina <dhanina@redhat.com>

Add generated param metadata types.

7114179

Define ParamType, ParamClass, and per-class parameter shapes derived from IPA json_metadata output. Co-authored-by: Cursor <cursoragent@cursor.com> Signed-off-by: David Hanina <dhanina@redhat.com>

Add generated object metadata types.

829bfd8

Model IPA object relationships, methods, and attribute metadata for type-safe API usage. Co-authored-by: Cursor <cursoragent@cursor.com> Signed-off-by: David Hanina <dhanina@redhat.com>

Add typed RPC response shapes.

6ce3c42

Introduce ValidResponse, ErrorResponse, and batch response types for IPA JSON-RPC calls. Co-authored-by: Cursor <cursoragent@cursor.com> Signed-off-by: David Hanina <dhanina@redhat.com>

Add scripts to generate TypeScript from IPA metadata.

3669b27

Provide Python tooling to produce param and request type definitions from json_metadata responses. Co-authored-by: Cursor <cursoragent@cursor.com> Signed-off-by: David Hanina <dhanina@redhat.com>

Fix getObjectMetadata to request full API metadata.

d3ceb1b

Pass methodname and command filters and call the JSON endpoint directly so metadata generation receives complete object definitions. Co-authored-by: Cursor <cursoragent@cursor.com> Signed-off-by: David Hanina <dhanina@redhat.com>

Add generated typed IPA request definitions.

5f6aeb5

Introduce per-object Args and Options types plus a RequestMap index for all IPA API methods, with a typed request method helper. Co-authored-by: Cursor <cursoragent@cursor.com> Signed-off-by: David Hanina <dhanina@redhat.com>

Add Requests show case

9539683

Adds requests, which adds a RequestMethod type that forces the developer to use the correct types for args and options. Assisted-by: Cursor cursoragent@cursor.com Signed-off-by: David Hanina <dhanina@redhat.com>

duzda added the WIP Work in Progress (do not merge) label Jul 9, 2026

sourcery-ai Bot reviewed Jul 9, 2026

View reviewed changes

veronnicka reviewed Jul 14, 2026

View reviewed changes

carma12 reviewed Jul 15, 2026

View reviewed changes

		@@ -0,0 +1,17 @@
		import { RequestMap } from "./requests";

		type ObjectValueTuple<T> = {

Uh oh!

Conversation

duzda commented Jul 9, 2026

Uh oh!

sourcery-ai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

duzda commented Jul 9, 2026

Uh oh!

veronnicka left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

carma12 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

veronnicka left a comment •

edited

Loading