FlatteningError while working with remote "$ref" in typeConfiguration

Aperta
#1,084 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
aws, python
Ambito
cloud, tooling

Direzione di ricerca

Riproduci il problema con lo schema mostrato ed esegui cfn generate, quindi esamina i log e il JSON di configurazione generato in remote/schema0 e remote/schema1. Il lavoro è completato quando un $ref remoto all’interno di typeConfiguration viene appiattito senza FlatteningError e la configurazione generata contiene un riferimento valido.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

I am working on a set of custom resource types that share two pieces of configuration over all planned types:

  • The Environment property
  • The EnvironmentMapping typeConfiguration

To limit the amount of duplicate JSON definitions, I took a page out of the teams book and created a bucket where I placed my remote definitions. And uploaded the shared definitions in that bucket.

Resulting in a definition JSON like follows:

{
    "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json#",
    "properties": {
        "Title": {
            "description": "Title/Name of the folder.",
            "type": "string"
        },
        "Environment": {
            "$ref": "https://s3.eu-west-1.amazonaws.com/my.fake.schemas.bucket/environment.def.v0.json"
        }
    },
...
   "typeConfiguration": {
        "additionalProperties": false,
        "properties": {
            "EnvironmentMapping":{
                "description": "A list of environment definitions detailing which secret is bound to which host.",
                "type":"array",
                "insertionOrder": false,
                "items": {
                    "$ref": "https://s3.eu-west-1.amazonaws.com/my.fake.schemas.bucket/environment-config.def.v0.json"
                }
            }
        },
        "required": ["EnvironmentConfiguration"]
    }
}

It works for the Environment property. That by itself and cfn generate finishes without problem. But when I add the reference to the typeConfiguration, cfn generate will produce the following error:
rpdk.core.jsonutils.utils.FlatteningError: Invalid ref: ('remote', 'schema1')

When perusing through the logs, I do see both schema's being picked up and verified. Both written to remote/schema0 and remote/schema1. And files are generated, but the config JSON looks as follows:

{
    "additionalProperties": false,
    "properties": {
        "EnvironmentConfiguration": {
            "type": "array",
            "insertionOrder": false,
            "items": {
                "$ref": "#/remote/schema1"
            }
        }
    },
    "required": [
        "EnvironmentConfiguration"
    ],
    "definitions": {},
    "typeName": "ORG::App::Folder"
}

I tried a few things:

  • I swapped both $ref-s: Flattening error. Resulting generated code did reflect the swapped configuration.
  • I added an extra object layer to the config definition json: Flattening error.
  • Move external property into the definitions block: Works, generation successful. But it defeats the effort of keeping the amount of copied schema low.

I might dive into the code and see how both blocks are rendered and how they differ. But it is late for me, at the time of writing this issue, and maybe someone will see an obvious mistake I missed.

Thanks in advance.

Lingua principale
Python
Stelle
336
Fork
173
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di aws-cloudformation/cloudformation-cli

Tutte le issue di aws-cloudformation/cloudformation-cli

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.