FilterVisibility

[dvv]

Hi!

I upgraded to 1.13.0 and tried to apply the new FilterVisibility type:

import "@typespec/http";

using TypeSpec.Reflection;

@service(#{ })
namespace Rpc;

// -----------------------------------------------------------------------------

model Base {
  @visibility(Lifecycle.Read) id: string,
}

model Auditable extends Base {
  @visibility(Lifecycle.Read) created_at: utcDateTime,
  @visibility(Lifecycle.Read) created_by: string,
  @visibility(Lifecycle.Read) updated_at: utcDateTime,
  @visibility(Lifecycle.Read) updated_by: string,
}

// -----------------------------------------------------------------------------

model User extends Auditable {
  name: string,
}

// -----------------------------------------------------------------------------

@doc("DTO to create {name}", T) model ObjectCreate<T extends Model> is FilterVisibility<T, #{ all: #[Lifecycle.Create] }, "{name}Create"> {}

model UserCreate is ObjectCreate<User> {}

// -----------------------------------------------------------------------------

The resulting spec is somewhat surprising to me:

openapi: 3.0.0
info:
  title: (title)
  version: 0.0.0
tags: []
paths: {}
components:
  schemas:
    Auditable:
      type: object
      required:
        - created_at
        - created_by
        - updated_at
        - updated_by
      properties:
        created_at:
          type: string
          format: date-time
          readOnly: true
        created_by:
          type: string
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        updated_by:
          type: string
          readOnly: true
      allOf:
        - $ref: '#/components/schemas/Base'
    Base:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          readOnly: true
    User:
      type: object
      required:
        - name
      properties:
        name:
          type: string
      allOf:
        - $ref: '#/components/schemas/Auditable'
    UserCreate:
      type: object
      required:
        - name
      properties:
        name:
          type: string
      allOf:
        - $ref: '#/components/schemas/Auditable'
      description: DTO to create User

That is, Create lifecycle is applied to explicit portion of User model, and inherited properties go on without visibility filter.
Is this the expected behavior?

Then, I made User model to read:

model User extends Auditable {
  @visibility(Lifecycle.Create) login: string, 
  name: string,
}

and encounter the compilation error:
error @typespec/openapi/duplicate-type-name Duplicate type name: 'User'. Check @friendlyName decorators and overlap with types in TypeSpec or service namespace..
Wonder what is the cause of the (rather unexpeced) error?

TIA

[timotheeguerin]

Looks like something we missed, also applies to MergePatchUpdate, can you file an issue?

[dvv]

Sure, #11036.

[dvv]

@timotheeguerin please, point at where am I wrong?

Given:

using TypeSpec.Reflection;

// -----------------------------------------------------------------------------

enum Marker {
  unique,
}

// model UniqueProperties<T extends Model> {
//   ...FilterVisibility<T, #{ all: #[Marker.unique] }, "{name}UniqueProperties">,
// }

@withVisibility(Marker.unique)
model UniqueProperties<T extends Model> {
  ...T,
}

// -----------------------------------------------------------------------------

model Foo {
  id: string,
  @visibility(Marker.unique) name: string,
}

model FooUniqueProperties is UniqueProperties<Foo>;

// -----------------------------------------------------------------------------

I get:

    FooUniqueProperties:
      type: object
      required:
        - id # WHY?
        - name
      properties:
        id: # WHY?
          type: string
        name:
          type: string

TIA

[timotheeguerin]

All unannotated properties are included I believe. (they have all visibility applied)

[dvv]

Hmm.
Changing to

model Foo {
  @visibility(Lifecycle.Read) id: string,
  @visibility(Marker.unique) name: string,
}

results in the same output.

[dvv]

I finally found:

@defaultVisibility(Marker.none)
enum Marker {
  none,
  unique,
}

to be the solution.
Able to move on.