Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

1.5 WattTime v3 Updates #547

Merged
merged 236 commits into from
Jul 23, 2024
Merged

1.5 WattTime v3 Updates #547

merged 236 commits into from
Jul 23, 2024

Conversation

vaughanknight
Copy link
Contributor

@vaughanknight vaughanknight commented Jul 23, 2024

Pull Request

Summary

This is the WattTime v3 update. Most notable changes that may require action are for deployment configuration, and these are minor efforts. The CA SDK API has no changed.

Added

WattTime v3 API support. This is an inplace upgrade for v2.

Removed

WattTime v2 API support due to v3 in place replacement.

Fixed

Changed

Updates for WattTime v3 API endpoint from v2, details in the ADR for WattTime v3 changes.

API

No changes

API Deployment

Due to the change for WattTime v3, there is change to the configuration for WattTime users.

With some of the changes to the code, some of the configuration will also needs to change.

Config (v2) Config (v3) Description
BalancingAuthorityCacheTTL RegionCacheTTL This is the cache for regions data in seconds, and has a default value of 1 day. This only needs updating if you set it
n/a AuthenticationBaseUrl NEW This is the base URL for the WattTime Authentication API and defaults to https://api.watttime.org/ if not set.

Example below if set (note they do not have to be set)

"wattTime_no-proxy": {
  "Type": "WattTime",
  "Username": "the_username",
  "Password": "super_secret_secret",
  "BaseURL": "https://api.watttime.org/v3/",
  "AutenticationBaseURL": "https://api.watttime.org", // This is new but not mandatory in config
  "RegionCacheTTL": 86400, // This is changed but not mandatory in config
  "Proxy": {
    "UseProxy": false
  }

SDK

No changes

Other

No changes

For more details, checkout #503

Checklist

  • Local Tests Passing?
  • CICD and Pipeline Tests Passing?
  • Added any new Tests?
  • Documentation Updates Made?
  • Are there any API Changes? If yes, please describe below.
  • This is not a breaking change. If it is, please describe it below.

Are there API Changes?

If yes, what are the expected API Changes? Please link to an API-Comparison
workflow with the API Diff.

Is this a breaking change?

If yes, what workflow does this break?

Anything else?

Other comments, collaborators, etc.

Please follow
GitHub's suggested syntax
to link Pull Requests to Issues via keywords

This PR Closes #<issue_number>

danuw and others added 30 commits August 3, 2023 14:42
…rently copied into casdk-docs/docs to get live updates (copied and not moved so changes in main can be easily identified when rebasing once it all works)
Signed-off-by: Phil Huang <phil.huang@microsoft.com>
Signed-off-by: tkuramoto33 <70622977+tkuramoto33@users.noreply.github.com>
Signed-off-by: tkuramoto33 <70622977+tkuramoto33@users.noreply.github.com>
Signed-off-by: tkuramoto33 <70622977+tkuramoto33@users.noreply.github.com>
table of content


Signed-off-by: Rintaro Ikeda <51394766+rinikeda@users.noreply.github.com>
Signed-off-by: Rintaro Ikeda <51394766+rinikeda@users.noreply.github.com>
Small typo ("arbon" => "Carbon")

Signed-off-by: Richard Jackson <jacksorjacksor@pm.me>
Update WattTime registration link
vaughanknight and others added 23 commits June 17, 2024 13:22
Historical forecasts updated
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: b9490e4
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: b991bac
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: e4f1494
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: b443e9e
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: ab1205d
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: 7c115fa
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: e047c9a
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: aa81382
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: 8640c8c
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: 880fcf7

Signed-off-by: Vaughan Knight <vaughan@vaughanknight.com>
Many tests reworked, a few to go.  Consolidated a lot of the hand crafted json objects into objects that get serialized as the purist JsonObject format was prone to errors - in some cases tests were passing even with bad typing.
Further test updates
Further updates, just 1 test left to remediate
…ests

Updated to add authentication client to the service builder for the tests.  All tests now passing.
Renaming of Balancing Authority to Region through all code and comments.  This will also need updating through documentation.
Fixed spelling error in latitude
Fixed a bug where location sources were loading twice.  Added a semaphore to stop any threading issues, and also stopped it loading twice in the service configuration.
Fixed typo for method name
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: e324f36
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: be6663c
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: 39e45a6
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: fbfcac1
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: 9aabd27
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: 8127a92
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: 4ff0151
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: d93320f
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: 91799f7
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: 4665813

Signed-off-by: Vaughan Knight <vaughan@vaughanknight.com>
Updates based on code review for WattTime Tests.  Mostly cleanup of constants which were removed elsewhere in tests.
Cleaned up a lot of the string literals.  They were causing too much fragility in the code base, and made it complex when updating the WattTime API.
More cleanup of some of the strings.  Creating consistency for using the test data on parameters and not just reponses also.
Updates to documentation and changelog
Latest azure-regions.json list 
Adds italynorth, polandcentral, spaincentral, mexicocentral, israelcentral, qatarcentral, brazilus, eastusstg
(Also seems to remove trailing zeros in some existing coordinates)

Signed-off-by: Dan Benitah <bdanuw@gmail.com>
Signed-off-by: Dan Benitah <bdanuw@gmail.com>
layout update

Signed-off-by: Dan Benitah <bdanuw@gmail.com>
Signed-off-by: Vaughan Knight <vaughan@vaughanknight.com>
Copy link
Collaborator

@danuw danuw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@vaughanknight vaughanknight merged commit 46f66d8 into main Jul 23, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.