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

Add in test environment connections #54

Merged
merged 23 commits into from
Oct 24, 2024

Conversation

rmbielby
Copy link
Contributor

@rmbielby rmbielby commented Oct 22, 2024

Brief overview of changes

This could get quite big. We need to add in the test environment examples, but also the environment needs to follow through appropriately in all the different components. And it'll be worth doing the same with api_version and dataset_version whilst we're on it.

Why are these changes being made?

We need eesyapi to work across multiple environments: dev, test, preprod, prod

Detailed description of changes

Environment and API version

  • Switched environment to ees_environment to avoid potential confusion with base R environment.
  • Cascaded ees_environment and api_version through the function hierarchy:
    • e.g. query_dataset() -> post_dataset() -> api_url()
  • I've set all these to default to NULL until api_url(), at which point it will choose "test" if nothing's been set by the user on ees_environment and "1.0" if nothing's been set on api_version. Once we're working on prod I think we reverse that, so that all functions explicitly default to "prod", but the current set up just means we should be able to switch between dev, test, preprod and prod a little more easily where needed.

example_id()

  • Renamed default example set to "absence"
  • Test added as an option on attendance and absence (and kept dev)

Function examples

Some function doc examples were hardwired with dev based codes. I've updated most of these to use example_id() instead to help make it a little easier to switch between platforms whilst we're developing.

Issue ticket number/s and link

Resolves #39

@rmbielby rmbielby linked an issue Oct 22, 2024 that may be closed by this pull request
@cjrace
Copy link
Contributor

cjrace commented Oct 22, 2024

@rmbielby - test data sets are now published and can be viewed in the test data catalogue

@rmbielby rmbielby marked this pull request as ready for review October 23, 2024 08:49
@rmbielby rmbielby self-assigned this Oct 23, 2024
@rmbielby rmbielby requested a review from cjrace October 23, 2024 08:49
…set (cascades through to several other functions as well)
@cjrace cjrace added this to the Ready for user testing milestone Oct 23, 2024
Copy link
Contributor

@cjrace cjrace left a comment

Choose a reason for hiding this comment

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

Not my most concise review!

Commented with some ideas that could be put into future issues, plus a handful minor of things to actually address in this PR

Copy link
Contributor

@cjrace cjrace left a comment

Choose a reason for hiding this comment

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

All good to merge!

@rmbielby rmbielby merged commit 2eb080c into main Oct 24, 2024
9 checks passed
@rmbielby rmbielby deleted the 39-update-to-point-at-new-data-on-test-environment branch January 22, 2025 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update to point at new data on test environment
2 participants