This repository has been archived by the owner on Dec 9, 2024. It is now read-only.
fix: add resource group name hash to resource names #310
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tbarlow12
reviewed
Sep 5, 2019
src/services/namingService.ts
Outdated
| @@ -26,6 +26,10 @@ export class AzureNamingService { | |||
| this.createShortStageName(stage), | |||
| ].join("-"); | |||
|
|
|||
| if(includeHash && config.provider.resourceGroup) { | |||
There was a problem hiding this comment.
I think if config.provider.resourceGroup is not defined, there are bigger problems here. It would probably be good to throw an error as opposed to just skipping the addition of the hash
wbreza
suggested changes
Sep 5, 2019
src/services/namingService.ts
Outdated
| @@ -14,7 +14,7 @@ export class AzureNamingService { | |||
| * @param resourceConfig The serverless resource configuration | |||
| * @param suffix Optional suffix to append on the end of the generated name | |||
| */ | |||
| public static getResourceName(config: ServerlessAzureConfig, resourceConfig?: ResourceConfig, suffix?: string) { | |||
| public static getResourceName(config: ServerlessAzureConfig, resourceConfig?: ResourceConfig, suffix?: string, includeHash: boolean = true) { | |||
There was a problem hiding this comment.
These flags and extra params are getting out of hand. Let's convert this into a typed options object
wbreza
approved these changes
Sep 6, 2019
src/services/namingService.ts
Outdated
| @@ -46,11 +61,11 @@ export class AzureNamingService { | |||
| * @param forbidden Regex for characters to remove from name. Defaults to non-alpha-numerics | |||
| * @param replaceWith String to replace forbidden characters. Defaults to empty string | |||
| */ | |||
| public static getSafeResourceName(config: ServerlessAzureConfig, maxLength: number, resourceConfig?: ResourceConfig, suffix: string = "", includeHash = false) { | |||
| public static getSafeResourceName(options: AzureNamingServiceOptions, maxLength: number) { | |||
There was a problem hiding this comment.
Any reason maxLength isn't in the options?
There was a problem hiding this comment.
Only since the regular get resource name func didn't need it, but it makes more sense to add
|
Resolves #299 |
tbarlow12
pushed a commit
that referenced
this pull request
Sep 13, 2019
* Add hashed resource name to resource name * Fix tests * Fix resource group name test issues * Add test * Add naming service test * test: APIM resource test (#311) * Add test to validate resource naming * Add service options and refactor * Address pr feedback
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fix: add resource group name hash to resource names
Azure has naming requirements for resources, and for some, requires the names to be unique across azure. Currently on deployments, the plugin doesn't add a more unique hash to the name, so it is possible collisions can occur. By adding the resource group name hash to the resource name, we can avoid this.
AB#1002