Add properties of objects and behaviors to extensions summaries sent to AI (#7967)

4ian · web-flow · commit 04384e319945 · 2025-11-07T12:22:11.000+01:00
Don't show in changelog
diff --git a/newIDE/app/src/EditorFunctions/SimplifiedProject/ExtensionSummary.js b/newIDE/app/src/EditorFunctions/SimplifiedProject/ExtensionSummary.js
@@ -1,5 +1,5 @@
 // @flow
-import { mapFor } from '../../Utils/MapFor';
+import { mapFor, mapVector } from '../../Utils/MapFor';
 
 export type ParameterSummary = {|
   isCodeOnly?: boolean,
@@ -36,12 +36,27 @@ export type PropertySummary = {|
   name: string,
   description: string,
   type: string,
+
+  label?: string,
+  measurementUnit?: {
+    name: string,
+  },
+  extraInfo?: Array<string>,
+  group?: string,
+  choices?: Array<{
+    value: string,
+    label: string,
+  }>,
+  hidden?: boolean,
+  deprecated?: boolean,
+  advanced?: boolean,
 |};
 
 export type ObjectSummary = {|
   name: string,
   fullName: string,
   description: string,
+  properties?: Array<PropertySummary>,
   actions: Array<InstructionSummary>,
   conditions: Array<InstructionSummary>,
   expressions: Array<ExpressionSummary>,
@@ -52,6 +67,8 @@ export type BehaviorSummary = {|
   fullName: string,
   description: string,
   objectType?: string,
+  properties: Array<PropertySummary>,
+  sharedProperties: Array<PropertySummary>,
   actions: Array<InstructionSummary>,
   conditions: Array<InstructionSummary>,
   expressions: Array<ExpressionSummary>,
@@ -122,32 +139,79 @@ const getParameterSummary = (
 
 const getPropertySummary = (
   propertyName: string,
-  property: gdPropertyDescriptor
-) => {
-  return {
+  property: gdPropertyDescriptor | gdNamedPropertyDescriptor
+): PropertySummary => {
+  const propertySummary: PropertySummary = {
     name: propertyName,
     description: property.getDescription(),
     type: property.getType(),
   };
+
+  if (property.getLabel()) {
+    propertySummary.label = property.getLabel();
+  }
+  if (property.getGroup()) {
+    propertySummary.group = property.getGroup();
+  }
+  if (!property.getMeasurementUnit().isUndefined()) {
+    propertySummary.measurementUnit = {
+      name: property.getMeasurementUnit().getName(),
+    };
+  }
+  if (property.getChoices().size() > 0) {
+    propertySummary.choices = mapVector(property.getChoices(), choice => ({
+      value: choice.getValue(),
+      label: choice.getLabel(),
+    }));
+  }
+  if (property.isHidden()) {
+    propertySummary.hidden = true;
+  }
+  if (property.isDeprecated()) {
+    propertySummary.deprecated = true;
+  }
+  if (property.isAdvanced()) {
+    propertySummary.advanced = true;
+  }
+  const extraInfo = property.getExtraInfo().toJSArray();
+  if (extraInfo.length > 0) {
+    propertySummary.extraInfo = extraInfo;
+  }
+
+  return propertySummary;
 };
 
-const getPropertiesSummary = (
-  propertiesMetadata: gdMapStringPropertyDescriptor
-) => {
-  return propertiesMetadata
-    .keys()
-    .toJSArray()
-    .map(propertyName => {
-      const property = propertiesMetadata.get(propertyName);
-      return getPropertySummary(propertyName, property);
+const getPropertiesSummary = ({
+  propertiesMetadata,
+  propertiesContainer,
+}: {|
+  propertiesMetadata?: gdMapStringPropertyDescriptor,
+  propertiesContainer?: gdPropertiesContainer,
+|}) => {
+  if (propertiesMetadata)
+    return propertiesMetadata
+      .keys()
+      .toJSArray()
+      .map(propertyName => {
+        const property = propertiesMetadata.get(propertyName);
+        return getPropertySummary(propertyName, property);
+      });
+
+  if (propertiesContainer)
+    return mapVector(propertiesContainer, namedProperty => {
+      return getPropertySummary(namedProperty.getName(), namedProperty);
     });
+
+  return [];
 };
 
 export const buildExtensionSummary = ({
   gd,
+  eventsFunctionsExtension,
   extension,
 }: {
   gd: libGDevelop,
+  eventsFunctionsExtension: gdEventsFunctionsExtension | null,
   extension: gdPlatformExtension,
 }): ExtensionSummary => {
   const objects: { [string]: ObjectSummary } = {};
@@ -238,10 +302,27 @@ export const buildExtensionSummary = ({
         return;
       }
 
+      const objectName =
+        objectType.split('::').pop() || 'Unrecognized object type format';
+
+      const eventsBasedObjects = eventsFunctionsExtension
+        ? eventsFunctionsExtension.getEventsBasedObjects()
+        : null;
+
+      const eventsBasedObject =
+        eventsBasedObjects && eventsBasedObjects.has(objectName)
+          ? eventsBasedObjects.get(objectName)
+          : null;
+
       objects[objectType] = {
         name: objectMetadata.getName(),
         fullName: objectMetadata.getFullName(),
         description: objectMetadata.getDescription(),
+        properties: eventsBasedObject
+          ? getPropertiesSummary({
+              propertiesContainer: eventsBasedObject.getPropertyDescriptors(),
+            })
+          : undefined,
         actions: generateInstructionsSummaries({
           instructionsMetadata: objectMetadata.getAllActions(),
         }),
@@ -274,6 +355,12 @@ export const buildExtensionSummary = ({
         name: behaviorMetadata.getName(),
         fullName: behaviorMetadata.getFullName(),
         description: behaviorMetadata.getDescription(),
+        properties: getPropertiesSummary({
+          propertiesMetadata: behaviorMetadata.getProperties(),
+        }),
+        sharedProperties: getPropertiesSummary({
+          propertiesMetadata: behaviorMetadata.getSharedProperties(),
+        }),
         actions: generateInstructionsSummaries({
           instructionsMetadata: behaviorMetadata.getAllActions(),
         }),
@@ -312,7 +399,9 @@ export const buildExtensionSummary = ({
         onlyWorkingFor2D: effectMetadata.isMarkedAsOnlyWorkingFor2D(),
         onlyWorkingFor3D: effectMetadata.isMarkedAsOnlyWorkingFor3D(),
         unique: effectMetadata.isMarkedAsUnique(),
-        properties: getPropertiesSummary(effectMetadata.getProperties()),
+        properties: getPropertiesSummary({
+          propertiesMetadata: effectMetadata.getProperties(),
+        }),
       };
 
       effects[effectType] = effectSummary;
diff --git a/newIDE/app/src/EditorFunctions/SimplifiedProject/SimplifiedProject.js b/newIDE/app/src/EditorFunctions/SimplifiedProject/SimplifiedProject.js
@@ -383,9 +383,20 @@ export const makeSimplifiedProjectBuilder = (gd: libGDevelop) => {
     ).filter(Boolean);
 
     const extensionsSummary: ProjectSpecificExtensionsSummary = {
-      extensionSummaries: projectSpecificExtensions.map(extension =>
-        buildExtensionSummary({ gd, extension })
-      ),
+      extensionSummaries: projectSpecificExtensions.map(extension => {
+        const extensionName = extension.getName();
+        const eventsFunctionsExtension = project.hasEventsFunctionsExtensionNamed(
+          extensionName
+        )
+          ? project.getEventsFunctionsExtension(extensionName)
+          : null;
+
+        return buildExtensionSummary({
+          gd,
+          eventsFunctionsExtension,
+          extension,
+        });
+      }),
     };
 
     const duration = Date.now() - startTime;
diff --git a/newIDE/app/src/EditorFunctions/SimplifiedProject/SimplifiedProject.spec.js b/newIDE/app/src/EditorFunctions/SimplifiedProject/SimplifiedProject.spec.js
@@ -949,6 +949,20 @@ describe('SimplifiedProject', () => {
                 ],
                 "fullName": "Fake behavior with two properties",
                 "name": "FakeBehavior::FakeBehavior",
+                "properties": Array [
+                  Object {
+                    "description": "",
+                    "label": "Property 1",
+                    "name": "property1",
+                    "type": "",
+                  },
+                  Object {
+                    "description": "A description for property 2",
+                    "name": "property2",
+                    "type": "Boolean",
+                  },
+                ],
+                "sharedProperties": Array [],
               },
             },
             "description": "A fake extension with a fake behavior containing 2 properties.",
@@ -966,4 +980,83 @@ describe('SimplifiedProject', () => {
 
     project.delete();
   });
+
+  it('should include summaries of project specific extensions with events based objects', async () => {
+    const gd = await initializeGDevelopJs();
+    makeTestExtensions(gd);
+
+    const { project } = makeTestProject(gd);
+
+    const projectSpecificExtensionsSummary = makeSimplifiedProjectBuilder(
+      gd
+    ).getProjectSpecificExtensionsSummary(project);
+
+    const buttonExtensionSummary = projectSpecificExtensionsSummary.extensionSummaries.find(
+      extensionSummary => extensionSummary.extensionName === 'Button'
+    );
+
+    expect(buttonExtensionSummary).toMatchInlineSnapshot(`
+      Object {
+        "behaviors": Object {},
+        "description": "Fake event-based object",
+        "effects": Object {},
+        "extensionFullName": "Fake event-based object",
+        "extensionName": "Button",
+        "freeActions": Array [],
+        "freeConditions": Array [],
+        "freeExpressions": Array [],
+        "objects": Object {
+          "Button::PanelSpriteButton": Object {
+            "actions": Array [],
+            "conditions": Array [],
+            "description": "A fake button made with a panel sprite and events.",
+            "expressions": Array [],
+            "fullName": "PanelSpriteButton",
+            "name": "Button::PanelSpriteButton",
+            "properties": Array [
+              Object {
+                "description": "",
+                "label": "Label offset on Y axis when pressed",
+                "name": "PressedLabelOffsetY",
+                "type": "number",
+              },
+              Object {
+                "description": "The left padding of the button",
+                "group": "Padding",
+                "label": "Left padding",
+                "measurementUnit": Object {
+                  "name": "Pixel",
+                },
+                "name": "LeftPadding",
+                "type": "number",
+              },
+              Object {
+                "description": "",
+                "group": "Padding",
+                "label": "Right padding",
+                "name": "RightPadding",
+                "type": "number",
+              },
+              Object {
+                "description": "",
+                "group": "Padding",
+                "label": "Top padding",
+                "name": "TopPadding",
+                "type": "number",
+              },
+              Object {
+                "description": "",
+                "group": "Padding",
+                "label": "Down padding",
+                "name": "DownPadding",
+                "type": "number",
+              },
+            ],
+          },
+        },
+      }
+    `);
+
+    project.delete();
+  });
 });
diff --git a/newIDE/app/src/fixtures/TestExtensions.js b/newIDE/app/src/fixtures/TestExtensions.js
@@ -1,14 +1,14 @@
 // @flow
-let testExtensionsAdded = false;
+let testExtensionsAdded = new WeakSet();
 
 /**
  * Create dummy extensions into gd.JsPlatform
  * @param gd The GD instance to use to create the extensions and find the platform.
  */
 export const makeTestExtensions = (gd: libGDevelop) => {
   // Be sure to only add test extensions once, as gd.JsPlatform is a singleton.
-  if (testExtensionsAdded) return;
-  testExtensionsAdded = true;
+  if (testExtensionsAdded.has(gd)) return;
+  testExtensionsAdded.add(gd);
 
   const platform = gd.JsPlatform.get();
 
@@ -185,9 +185,11 @@ export const makeTestExtensions = (gd: libGDevelop) => {
 
       behaviorProperties
         .getOrCreate('property1')
+        .setLabel('Property 1')
         .setValue(behaviorContent.getStringAttribute('property1'));
       behaviorProperties
         .getOrCreate('property2')
+        .setDescription('A description for property 2')
         .setValue(
           behaviorContent.getBoolAttribute('property2') ? 'true' : 'false'
         )
@@ -336,6 +338,13 @@ export const makeTestExtensions = (gd: libGDevelop) => {
       '',
       'MIT'
     );
+    extension.addObject(
+      'PanelSpriteButton',
+      'PanelSpriteButton',
+      'A fake button made with a panel sprite and events.',
+      'res/button.svg',
+      new gd.ObjectJsImplementation()
+    );
     platform.addNewExtension(extension);
     extension.delete(); // Release the extension as it was copied inside gd.JsPlatform
   }
diff --git a/newIDE/app/src/fixtures/TestProject.js b/newIDE/app/src/fixtures/TestProject.js
@@ -142,6 +142,8 @@ export const makeTestProject = (gd /*: libGDevelop */) /*: TestProject */ => {
     .insertNew('LeftPadding', 1)
     .setType('number')
     .setLabel('Left padding')
+    .setMeasurementUnit(gd.MeasurementUnit.getPixel())
+    .setDescription('The left padding of the button')
     .setGroup('Padding');
   buttonProperties
     .insertNew('RightPadding', 2)
