Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Deprecate "provider.region" in favor of "provider.defaultRegion"

See original GitHub issue

Use case description

Many (and it was my case for long long time) assume that provider.region property represents final region to be used in deployment. While in reality it’s the value of last resort, which is used if region is not provided via other means (--region CLI param).

Technically this property represents a default region fallback (if it’s not specified from command line)

To clarify this confusion. I propose to rename provider.region to provider.defaultRegion

Proposed solution

Internally replace reference of service.provider.region to service.provider.defaultRegion:
- https://github.com/serverless/serverless/blob/ef530506d5044ab3312c829838bb29cfcd2c889f/lib/plugins/print.js#L55 (also rename to defaultRegion on target object)
- https://github.com/serverless/serverless/blob/ef530506d5044ab3312c829838bb29cfcd2c889f/lib/plugins/print.js#L73-L75
Preset provider.defaultRegion aside of provider.region here: https://github.com/serverless/serverless/blob/ef530506d5044ab3312c829838bb29cfcd2c889f/lib/plugins/aws/provider.js#L231
Recognize service.provider.defaultRegion (and favor over service.provider.region) in region resolution here: https://github.com/serverless/serverless/blob/ef530506d5044ab3312c829838bb29cfcd2c889f/lib/plugins/aws/provider.js#L1442
Ensure schema for provider.defaultRegion: https://github.com/serverless/serverless/blob/ef530506d5044ab3312c829838bb29cfcd2c889f/lib/plugins/aws/provider.js#L804
Deprecate provider.region setting in configuration. Probably best logic point for that is here: https://github.com/serverless/serverless/blob/ef530506d5044ab3312c829838bb29cfcd2c889f/lib/plugins/aws/provider.js#L230
Update all documentation to use defaultStage instead of stage
Update all templates to use defaultStage instead of stage
Supplement no vars usage deprecation in @serverless/enterprise-plugin. So variables in provider.defaultRegion setting are also rejected: https://github.com/serverless/enterprise-plugin/pull/524

Issue Analytics

State:
Created 3 years ago
Comments:6 (5 by maintainers)

Top GitHub Comments

1reaction

vinothmdevcommented, Jan 20, 2021

Hi @medikoo Thanks for checking. I did not start working on this. please let @WillHof take it, if possible #8684 as well. Sorry for the delay I was occupied with other priorities.

0reactions

medikoocommented, Dec 8, 2021

As this change will be breaking for many services, I’m downgrading it to needs feedback. It’s not in consideration at this point

Top Results From Across the Web

terraform tells me The argument "region" is required, but was ...

I'm running into the same issue whenever I execute terraform plan inside a new project. Terraform v0.12.12 + provider.aws v2.33.0.

Provider Configuration | Terraform - HashiCorp Developer

Some providers require you to configure them with endpoint URLs, cloud regions, or other settings before Terraform can use them. This page documents...

com.amazonaws.regions (AWS SDK for Java - 1.12.360)

Loads region information from the shared AWS config file. ... Default region provider chain used when no explicit region is supplied to a...

Google Provider Configuration Reference - Terraform Registry

If another project is specified on a resource, it will take precedence. region - (Optional) The default region to manage resources in. If...

Changing the default region or zone - Compute Engine

When you use the Google Cloud console to create regional or zonal resources like addresses and instances, Compute Engine sets the region and...