Add rule for RPC-Policy-V1-03: no properties of type object without a schema

.chronus/changes/almend-Rule-2024-8-17-16-58-23.md

@@ -0,0 +1,7 @@
+---
+changeKind: feature
+packages:
+  - "@azure-tools/typespec-azure-resource-manager"
+---
+
+Add arm-properties-type-object-no-definition rule

.chronus/changes/almend-Rule-2024-8-18-10-2-28.md

@@ -0,0 +1,7 @@
+---
+changeKind: feature
+packages:
+  - "@azure-tools/typespec-azure-rulesets"
+---
+
+Add arm-properties-type-object-no-definition rule to ruleset

docs/libraries/azure-resource-manager/reference/linter.md

@@ -31,6 +31,7 @@ Available ruleSets:
 | [`@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes`](/libraries/azure-resource-manager/rules/delete-operation-response-codes.md) | Ensure delete operations have the appropriate status codes.                                                                                                                                                                                          |
 | [`@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes`](/libraries/azure-resource-manager/rules/put-operation-response-codes.md)       | Ensure put operations have the appropriate status codes.                                                                                                                                                                                             |
 | [`@azure-tools/typespec-azure-resource-manager/arm-post-operation-response-codes`](/libraries/azure-resource-manager/rules/post-operation-response-codes.md)     | Ensure post operations have the appropriate status codes.                                                                                                                                                                                            |
+| `@azure-tools/typespec-azure-resource-manager/arm-properties-type-object-no-definition`                                                                          | ARM Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience.                                                                        |
 | `@azure-tools/typespec-azure-resource-manager/arm-resource-action-no-segment`                                                                                    | `@armResourceAction` should not be used with `@segment`.                                                                                                                                                                                             |
 | `@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property`                                                                                   | Warn about duplicate properties in resources.                                                                                                                                                                                                        |
 | `@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property`                                                                            | Check for invalid resource envelope properties.                                                                                                                                                                                                      |

docs/libraries/azure-resource-manager/rules/arm-properties-type-object-no-definition.md

@@ -0,0 +1,45 @@
+---
+title: arm-properties-type-object-no-definition
+---
+
+```text title=- Full name-
+@azure-tools/typespec-azure-resource-manager/arm-properties-type-object-no-definition
+```
+
+ARM Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience.
+
+#### ❌ Incorrect
+
+```tsp
+model Information {
+  address: {};
+}
+```
+
+#### ✅ Correct
+
+```tsp
+model Information {
+  address: Address;
+}
+
+model Address {
+  street: string;
+  city: string;
+  state: string;
+  country: string;
+  postalCode: string;
+}
+```
+
+#### ✅ Correct
+
+```tsp
+model Information {
+  street: string;
+  city: string;
+  state: string;
+  country: string;
+  postalCode: string;
+}
+```

packages/typespec-azure-resource-manager/README.md

@@ -35,6 +35,7 @@ Available ruleSets:
 | [`@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes`](https://azure.github.io/typespec-azure/docs/libraries/azure-resource-manager/rules/delete-operation-response-codes) | Ensure delete operations have the appropriate status codes.                                                                                                                                                                                          |
 | [`@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes`](https://azure.github.io/typespec-azure/docs/libraries/azure-resource-manager/rules/put-operation-response-codes)       | Ensure put operations have the appropriate status codes.                                                                                                                                                                                             |
 | [`@azure-tools/typespec-azure-resource-manager/arm-post-operation-response-codes`](https://azure.github.io/typespec-azure/docs/libraries/azure-resource-manager/rules/post-operation-response-codes)     | Ensure post operations have the appropriate status codes.                                                                                                                                                                                            |
+| `@azure-tools/typespec-azure-resource-manager/arm-properties-type-object-no-definition`                                                                                                                  | ARM Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience.                                                                        |
 | `@azure-tools/typespec-azure-resource-manager/arm-resource-action-no-segment`                                                                                                                            | `@armResourceAction` should not be used with `@segment`.                                                                                                                                                                                             |
 | `@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property`                                                                                                                           | Warn about duplicate properties in resources.                                                                                                                                                                                                        |
 | `@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property`                                                                                                                    | Check for invalid resource envelope properties.                                                                                                                                                                                                      |

packages/typespec-azure-resource-manager/src/linter.ts

@@ -3,6 +3,7 @@ import { armCommonTypesVersionRule } from "./rules/arm-common-types-version.js";
 import { armDeleteResponseCodesRule } from "./rules/arm-delete-response-codes.js";
 import { armNoRecordRule } from "./rules/arm-no-record.js";
 import { armPostResponseCodesRule } from "./rules/arm-post-response-codes.js";
+import { armPropertiesTypeObjectNoDefinitionRule } from "./rules/arm-properties-type-object-no-definition.js";
 import { armPutResponseCodesRule } from "./rules/arm-put-response-codes.js";
 import { armResourceActionNoSegmentRule } from "./rules/arm-resource-action-no-segment.js";
 import { armResourceDuplicatePropertiesRule } from "./rules/arm-resource-duplicate-property.js";
@@ -36,6 +37,7 @@ const rules = [
   armDeleteResponseCodesRule,
   armPutResponseCodesRule,
   armPostResponseCodesRule,
+  armPropertiesTypeObjectNoDefinitionRule,
   armResourceActionNoSegmentRule,
   armResourceDuplicatePropertiesRule,
   armResourceEnvelopeProperties,

packages/typespec-azure-resource-manager/src/rules/arm-properties-type-object-no-definition.ts

@@ -0,0 +1,37 @@
+import { createRule, Model, ModelProperty, SemanticNodeListener } from "@typespec/compiler";
+
+export const armPropertiesTypeObjectNoDefinitionRule = createRule({
+  name: "arm-properties-type-object-no-definition",
+  severity: "warning",
+  description:
+    "ARM Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience.",
+  messages: {
+    default: "Properties with type:object must have definition of a reference model.",
+    extends:
+      "The `type:object` model is not defined in the payload. Define the reference model of the object or change the `type` to a primitive data type like string, int, etc",
+  },
+  create(context): SemanticNodeListener {
+    return {
+      model: (model: Model) => {
+        for (const property of getProperties(model)) {
+          if (property.type.kind === "Model" && !property.type.name) {
+            context.reportDiagnostic({
+              code: "arm-no-record",
+              target: model,
+            });
+          }
+        }
+      },
+    };
+
+    function getProperties(model: Model): ModelProperty[] {
+      const result: ModelProperty[] = [];
+      let current: Model | undefined = model;
+      while (current !== undefined) {
+        if (current.properties.size > 0) result.push(...current.properties.values());
+        current = current.baseModel;
+      }
+      return result;
+    }
+  },
+});

packages/typespec-azure-resource-manager/test/rules/arm-properties-type-object-no-definition.test.ts

@@ -0,0 +1,74 @@
+import {
+  BasicTestRunner,
+  LinterRuleTester,
+  createLinterRuleTester,
+} from "@typespec/compiler/testing";
+import { beforeEach, describe, it } from "vitest";
+import { armPropertiesTypeObjectNoDefinitionRule } from "../../src/rules/arm-properties-type-object-no-definition.js";
+import { createAzureResourceManagerTestRunner } from "../test-host.js";
+
+const armDef = `
+@armProviderNamespace
+@useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1)
+namespace Microsoft.Contoso;
+`;
+
+describe("typespec-azure-resource-manager: arm properties type-object no definition rule", () => {
+  let runner: BasicTestRunner;
+  let tester: LinterRuleTester;
+
+  beforeEach(async () => {
+    runner = await createAzureResourceManagerTestRunner();
+    tester = createLinterRuleTester(
+      runner,
+      armPropertiesTypeObjectNoDefinitionRule,
+      "@azure-tools/typespec-azure-resource-manager",
+    );
+  });
+
+  it("emits diagnostic when a property use type:object that is not defined", async () => {
+    await tester
+      .expect(
+        ` 
+      ${armDef}
+      model Foo { 
+        props: {}; 
+      } 
+        `,
+      )
+      .toEmitDiagnostics({
+        code: "@azure-tools/typespec-azure-resource-manager/arm-properties-type-object-no-definition",
+        message: "Properties with type:object must have definition of a reference model.",
+      });
+  });
+
+  it("valid when a property use type:object that is defined", async () => {
+    await tester
+      .expect(
+        `
+      ${armDef}
+      model WidgetProperties {
+        props: Foo;
+      }
+
+      model Foo{
+        Name: string;
+      }
+    `,
+      )
+      .toBeValid();
+  });
+
+  it("valid when a property use type:object known scalar", async () => {
+    await tester
+      .expect(
+        ` 
+      ${armDef}
+      model WidgetProperties {
+        Date: utcDateTime;
+      }
+        `,
+      )
+      .toBeValid();
+  });
+});

packages/typespec-azure-rulesets/src/rulesets/resource-manager.ts

@@ -50,6 +50,7 @@ export default {
 
     // Azure resource manager
     "@azure-tools/typespec-azure-resource-manager/arm-no-record": true,
+    "@azure-tools/typespec-azure-resource-manager/arm-properties-type-object-no-definition": true,
     "@azure-tools/typespec-azure-resource-manager/arm-common-types-version": true,
     "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes": true,
     "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes": true,