@aws-cdk/core/lib/private/physical-name-generator.js

AWS Cloud Development Kit Core Library

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.isGeneratedWhenNeededMarker = exports.GeneratedWhenNeededMarker = exports.generatePhysicalName = void 0;
const crypto = require("crypto");
const constructs_1 = require("constructs");
const stack_1 = require("../stack");
const token_1 = require("../token");
const token_map_1 = require("./token-map");
function generatePhysicalName(resource) {
    const stack = stack_1.Stack.of(resource);
    const stackPart = new PrefixNamePart(stack.stackName, 25);
    const idPart = new SuffixNamePart(constructs_1.Node.of(resource).uniqueId, 24);
    const region = stack.region;
    if (token_1.Token.isUnresolved(region) || !region) {
        throw new Error(`Cannot generate a physical name for ${constructs_1.Node.of(resource).path}, because the region is un-resolved or missing`);
    }
    const account = stack.account;
    if (token_1.Token.isUnresolved(account) || !account) {
        throw new Error(`Cannot generate a physical name for ${constructs_1.Node.of(resource).path}, because the account is un-resolved or missing`);
    }
    const parts = [stackPart, idPart]
        .map(part => part.generate());
    const hashLength = 12;
    const sha256 = crypto.createHash('sha256')
        .update(stackPart.bareStr)
        .update(idPart.bareStr)
        .update(region)
        .update(account);
    const hash = sha256.digest('hex').slice(0, hashLength);
    const ret = [...parts, hash].join('');
    return ret.toLowerCase();
}
exports.generatePhysicalName = generatePhysicalName;
class NamePart {
    constructor(bareStr) {
        this.bareStr = bareStr;
    }
}
class PrefixNamePart extends NamePart {
    constructor(bareStr, prefixLength) {
        super(bareStr);
        this.prefixLength = prefixLength;
    }
    generate() {
        return this.bareStr.slice(0, this.prefixLength);
    }
}
class SuffixNamePart extends NamePart {
    constructor(str, suffixLength) {
        super(str);
        this.suffixLength = suffixLength;
    }
    generate() {
        const strLen = this.bareStr.length;
        const startIndex = Math.max(strLen - this.suffixLength, 0);
        return this.bareStr.slice(startIndex, strLen);
    }
}
const GENERATE_IF_NEEDED_SYMBOL = Symbol.for('@aws-cdk/core.<private>.GenerateIfNeeded');
/**
 * This marker token is used by PhysicalName.GENERATE_IF_NEEDED. When that token is passed to the
 * physicalName property of a Resource, it triggers different behavior in the Resource constructor
 * that will allow emission of a generated physical name (when the resource is used across
 * environments) or undefined (when the resource is not shared).
 *
 * This token throws an Error when it is resolved, as a way to prevent inadvertent mis-uses of it.
 */
class GeneratedWhenNeededMarker {
    constructor() {
        this.creationStack = [];
        Object.defineProperty(this, GENERATE_IF_NEEDED_SYMBOL, { value: true });
    }
    resolve(_ctx) {
        throw new Error('Invalid physical name passed to CloudFormation. Use "this.physicalName" instead');
    }
    toString() {
        return 'PhysicalName.GENERATE_IF_NEEDED';
    }
}
exports.GeneratedWhenNeededMarker = GeneratedWhenNeededMarker;
/**
 * Checks whether a stringified token resolves to a `GeneratedWhenNeededMarker`.
 */
function isGeneratedWhenNeededMarker(val) {
    const token = token_map_1.TokenMap.instance().lookupString(val);
    return !!token && GENERATE_IF_NEEDED_SYMBOL in token;
}
exports.isGeneratedWhenNeededMarker = isGeneratedWhenNeededMarker;
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"physical-name-generator.js","sourceRoot":"","sources":["physical-name-generator.ts"],"names":[],"mappings":";;;AAAA,iCAAiC;AACjC,2CAAkC;AAGlC,oCAAiC;AACjC,oCAAiC;AACjC,2CAAuC;AAEvC,SAAgB,oBAAoB,CAAC,QAAmB;IACtD,MAAM,KAAK,GAAG,aAAK,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;IACjC,MAAM,SAAS,GAAG,IAAI,cAAc,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAC1D,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,iBAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAElE,MAAM,MAAM,GAAW,KAAK,CAAC,MAAM,CAAC;IACpC,IAAI,aAAK,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE;QACzC,MAAM,IAAI,KAAK,CAAC,uCAAuC,iBAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,IAAI,gDAAgD,CAAC,CAAC;KAChI;IAED,MAAM,OAAO,GAAW,KAAK,CAAC,OAAO,CAAC;IACtC,IAAI,aAAK,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE;QAC3C,MAAM,IAAI,KAAK,CAAC,uCAAuC,iBAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,IAAI,iDAAiD,CAAC,CAAC;KACjI;IAED,MAAM,KAAK,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC;SAC9B,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IAEhC,MAAM,UAAU,GAAG,EAAE,CAAC;IACtB,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC;SACvC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC;SACzB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;SACtB,MAAM,CAAC,MAAM,CAAC;SACd,MAAM,CAAC,OAAO,CAAC,CAAC;IACnB,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;IAEvD,MAAM,GAAG,GAAG,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEtC,OAAO,GAAG,CAAC,WAAW,EAAE,CAAC;AAC3B,CAAC;AA7BD,oDA6BC;AAED,MAAe,QAAQ;IAGrB,YAAY,OAAe;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CAGF;AAED,MAAM,cAAe,SAAQ,QAAQ;IACnC,YAAY,OAAe,EAAmB,YAAoB;QAChE,KAAK,CAAC,OAAO,CAAC,CAAC;QAD6B,iBAAY,GAAZ,YAAY,CAAQ;IAElE,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAClD,CAAC;CACF;AAED,MAAM,cAAe,SAAQ,QAAQ;IACnC,YAAY,GAAW,EAAmB,YAAoB;QAC5D,KAAK,CAAC,GAAG,CAAC,CAAC;QAD6B,iBAAY,GAAZ,YAAY,CAAQ;IAE9D,CAAC;IAEM,QAAQ;QACb,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QACnC,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;CACF;AAED,MAAM,yBAAyB,GAAG,MAAM,CAAC,GAAG,CAAC,0CAA0C,CAAC,CAAC;AAEzF;;;;;;;GAOG;AACH,MAAa,yBAAyB;IAGpC;QAFgB,kBAAa,GAAa,EAAE,CAAC;QAG3C,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,yBAAyB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1E,CAAC;IAEM,OAAO,CAAC,IAAqB;QAClC,MAAM,IAAI,KAAK,CAAC,iFAAiF,CAAC,CAAC;IACrG,CAAC;IAEM,QAAQ;QACb,OAAO,iCAAiC,CAAC;IAC3C,CAAC;CACF;AAdD,8DAcC;AAED;;GAEG;AACH,SAAgB,2BAA2B,CAAC,GAAW;IACrD,MAAM,KAAK,GAAG,oBAAQ,CAAC,QAAQ,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IACpD,OAAO,CAAC,CAAC,KAAK,IAAI,yBAAyB,IAAI,KAAK,CAAC;AACvD,CAAC;AAHD,kEAGC","sourcesContent":["import * as crypto from 'crypto';\nimport { Node } from 'constructs';\nimport { IResolvable, IResolveContext } from '../resolvable';\nimport { IResource } from '../resource';\nimport { Stack } from '../stack';\nimport { Token } from '../token';\nimport { TokenMap } from './token-map';\n\nexport function generatePhysicalName(resource: IResource): string {\n  const stack = Stack.of(resource);\n  const stackPart = new PrefixNamePart(stack.stackName, 25);\n  const idPart = new SuffixNamePart(Node.of(resource).uniqueId, 24);\n\n  const region: string = stack.region;\n  if (Token.isUnresolved(region) || !region) {\n    throw new Error(`Cannot generate a physical name for ${Node.of(resource).path}, because the region is un-resolved or missing`);\n  }\n\n  const account: string = stack.account;\n  if (Token.isUnresolved(account) || !account) {\n    throw new Error(`Cannot generate a physical name for ${Node.of(resource).path}, because the account is un-resolved or missing`);\n  }\n\n  const parts = [stackPart, idPart]\n    .map(part => part.generate());\n\n  const hashLength = 12;\n  const sha256 = crypto.createHash('sha256')\n    .update(stackPart.bareStr)\n    .update(idPart.bareStr)\n    .update(region)\n    .update(account);\n  const hash = sha256.digest('hex').slice(0, hashLength);\n\n  const ret = [...parts, hash].join('');\n\n  return ret.toLowerCase();\n}\n\nabstract class NamePart {\n  public readonly bareStr: string;\n\n  constructor(bareStr: string) {\n    this.bareStr = bareStr;\n  }\n\n  public abstract generate(): string;\n}\n\nclass PrefixNamePart extends NamePart {\n  constructor(bareStr: string, private readonly prefixLength: number) {\n    super(bareStr);\n  }\n\n  public generate(): string {\n    return this.bareStr.slice(0, this.prefixLength);\n  }\n}\n\nclass SuffixNamePart extends NamePart {\n  constructor(str: string, private readonly suffixLength: number) {\n    super(str);\n  }\n\n  public generate(): string {\n    const strLen = this.bareStr.length;\n    const startIndex = Math.max(strLen - this.suffixLength, 0);\n    return this.bareStr.slice(startIndex, strLen);\n  }\n}\n\nconst GENERATE_IF_NEEDED_SYMBOL = Symbol.for('@aws-cdk/core.<private>.GenerateIfNeeded');\n\n/**\n * This marker token is used by PhysicalName.GENERATE_IF_NEEDED. When that token is passed to the\n * physicalName property of a Resource, it triggers different behavior in the Resource constructor\n * that will allow emission of a generated physical name (when the resource is used across\n * environments) or undefined (when the resource is not shared).\n *\n * This token throws an Error when it is resolved, as a way to prevent inadvertent mis-uses of it.\n */\nexport class GeneratedWhenNeededMarker implements IResolvable {\n  public readonly creationStack: string[] = [];\n\n  constructor() {\n    Object.defineProperty(this, GENERATE_IF_NEEDED_SYMBOL, { value: true });\n  }\n\n  public resolve(_ctx: IResolveContext): never {\n    throw new Error('Invalid physical name passed to CloudFormation. Use \"this.physicalName\" instead');\n  }\n\n  public toString(): string {\n    return 'PhysicalName.GENERATE_IF_NEEDED';\n  }\n}\n\n/**\n * Checks whether a stringified token resolves to a `GeneratedWhenNeededMarker`.\n */\nexport function isGeneratedWhenNeededMarker(val: string): boolean {\n  const token = TokenMap.instance().lookupString(val);\n  return !!token && GENERATE_IF_NEEDED_SYMBOL in token;\n}\n"]}