Misspelled ExtraTypes dangling ref in schema

[t0yv0]

What happened?

jq .config.variables.region $(find . -name 'schema.json')                                                                                                                                                                                                                      ~/code/pulumi-aws-2
{
  "type": "string",
  "$ref": "#/types/aws:index/region:Region",
  "description": "The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc.\n",
  "defaultInfo": {
    "environment": [
      "AWS_REGION",
      "AWS_DEFAULT_REGION"
    ]
  }
}

Note how it references #/types/aws:index/region:Region but there is no such type in the schema.

Instead we have slightly differently cased enum in here coming from ExtraTypes:

jq '.types|keys' $(find . -name 'schema.json') | grep Region | grep 'aws:index' | grep -v Filter                                                                                                                                                                               ~/code/pulumi-aws-2
  "aws:index/Region:Region",

Expected Behavior

No dangling refs in schema

Steps to reproduce

See JQ code above

Output of pulumi about

N/A

Additional context

Having to account for dangling refs complicates consuming code a bit.

Contributing

Vote on this issue by adding a 👍 reaction.
To contribute a fix for this issue, leave a comment (and link to your pull request, if you've opened one already).

[t0yv0]

AFAIK the SDK projections ignore this ref and treat region as a *string. It might be that some user code out there relies on the ExtraType. Paths forward here

• drop the dangling "$ref", will not break anything
• drop ExtraType, possibly breaking user code we do not see
• fix the ref typo - would changing a string to a string-based Enum be a non-breaking change over all language SDKs? not sure at the moment

[t0yv0]

I think it's an authoring issue - https://github.com/pulumi/pulumi-aws/blob/07d08a0a50a459620181440fbb00ba497843f6c6/provider/resources.go#L3788-#L3788 and https://github.com/pulumi/pulumi-aws/blob/07d08a0a50a459620181440fbb00ba497843f6c6/provider/resources.go#L450-#L450

I've not done too deeply though - but I think the tokens originate from code in resoures.go, awsTypeDefaultFile seems suspect. It's hard to change this though as a change would be breaking. I've worked around it so no need to do it now

[kpitzen]

This, currently, seems like a breaking change from an SDK perspective, though we can likely ease that in the next major version via aliasing, similar to what we're doing in AZ Native 2.0. I'll mark this as such - thank you for reporting this @t0yv0 !

[t0yv0]

Yes. The only non-breaking way would be to remove the "ref" from config - but maybe I'm mistaken there too.

[mikhailshilkov]

This is tracked more broadly in #2565