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

PROD-2709 Fix Email Connector logs so they use configuration key instead of name #5286

Merged
merged 5 commits into from
Sep 23, 2024

Conversation

erosselli
Copy link
Contributor

@erosselli erosselli commented Sep 16, 2024

Closes PROD-2709

Description Of Changes

Adds the name_or_key property to ConnectionConfig, and updates all email connectors to do two things:

  • All logs will log the connection config key, not the name
  • All ExecutionLog instances created will use the name_or_key property instead of just the name

This is because the name is an optional property for the connection config.

Steps to Confirm

  • list any manual steps for reviewers to confirm the changes

Pre-Merge Checklist

  • All CI Pipelines Succeeded
  • Documentation:
    • documentation complete, PR opened in fidesdocs
    • documentation issue created in fidesdocs
    • if there are any new client scopes created as part of the pull request, remember to update public-facing documentation that references our scope registry
  • Issue Requirements are Met
  • Relevant Follow-Up Issues Created
  • Update CHANGELOG.md
  • For API changes, the Postman collection has been updated
  • If there are any database migrations:
    • Ensure that your downrev is up to date with the latest revision on main
    • Ensure that your downgrade() migration is correct and works
      • If a downgrade migration is not possible for this change, please call this out in the PR description!

Copy link

vercel bot commented Sep 16, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
fides-plus-nightly ⬜️ Ignored (Inspect) Visit Preview Sep 23, 2024 6:31pm

Copy link

cypress bot commented Sep 16, 2024

fides    Run #10063

Run Properties:  status check passed Passed #10063  •  git commit 2361c26677 ℹ️: Merge 6d119ccfd64baaddc0ceb3f7190d314217e8a63d into d5986a5c39469165ef8743dd9f0a...
Project fides
Branch Review refs/pull/5286/merge
Run status status check passed Passed #10063
Run duration 00m 39s
Commit git commit 2361c26677 ℹ️: Merge 6d119ccfd64baaddc0ceb3f7190d314217e8a63d into d5986a5c39469165ef8743dd9f0a...
Committer erosselli
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 4
⚠️ You've recorded test results over your free plan limit.
Upgrade your plan to view test results.
View all changes introduced in this branch ↗︎

Copy link
Contributor

@pattisdr pattisdr left a comment

Choose a reason for hiding this comment

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

thanks for jumping on this, I don't know how long this has been here, but this will really help troubleshooting in places.

You might look into adding some sort of property on the conneciton config that returns name or key and use that everywhere

@erosselli erosselli marked this pull request as ready for review September 16, 2024 20:11
Comment on lines 309 to 313
"dataset_name": self.configuration.name
or self.configuration.key,
"privacy_request_id": privacy_request.id,
"collection_name": self.configuration.name,
"collection_name": self.configuration.name
or self.configuration.key,
Copy link
Contributor

Choose a reason for hiding this comment

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

a few more places where you can use your new property!

Comment on lines 120 to 124
"connection_key": self.configuration.key,
"dataset_name": self.configuration.name,
"collection_name": self.configuration.name,
"dataset_name": self.configuration.name
or self.configuration.key,
"collection_name": self.configuration.name
or self.configuration.key,
Copy link
Contributor

Choose a reason for hiding this comment

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

same here -

Copy link
Contributor

@pattisdr pattisdr left a comment

Choose a reason for hiding this comment

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

🎉

@erosselli erosselli merged commit 0a0ea4f into main Sep 23, 2024
37 checks passed
@erosselli erosselli deleted the PROD-2709 branch September 23, 2024 20:09
Copy link

cypress bot commented Sep 23, 2024

fides    Run #10068

Run Properties:  status check passed Passed #10068  •  git commit 0a0ea4f400: PROD-2709 Fix Email Connector logs so they use configuration key instead of name...
Project fides
Branch Review main
Run status status check passed Passed #10068
Run duration 00m 39s
Commit git commit 0a0ea4f400: PROD-2709 Fix Email Connector logs so they use configuration key instead of name...
Committer erosselli
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 4
⚠️ You've recorded test results over your free plan limit.
Upgrade your plan to view test results.
View all changes introduced in this branch ↗︎

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants