refactor: ♻️ 🔏 🔊 🧑‍💻 Add Environment Variables and Convert Logging to Use Logwatch

[slugb0t]

Summary by Sourcery

Refactor the application to replace 'consola' logging with 'logwatch' for better log management. Update CI and deployment configurations to incorporate new environment variables for logging and validation endpoints. Add a new API endpoint to handle Zenodo token deletion.

Enhancements:

• Convert logging from 'consola' to 'logwatch' for improved log management and consistency across the application.

CI:

• Update CI workflows to include new environment variables 'BOT_LOGWATCH_URL' and 'VALIDATOR_URL'.

Deployment:

• Update deployment configurations to include new environment variables 'BOT_LOGWATCH_URL' and 'VALIDATOR_URL'.

[fairdataihub-bot]

Thank you for submitting this pull request! We appreciate your contribution to the project. Before we can merge it, we need to review the changes you've made to ensure they align with our code standards and meet the requirements of the project. We'll get back to you as soon as we can with feedback. Thanks again!

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR implements a major logging system refactor, replacing the existing 'consola' logging with 'logwatch' for improved log management. The changes include environment variable updates, logging format standardization, and minor UI improvements. The implementation focuses on maintaining consistent logging patterns across the application while adding structured logging capabilities.

Class diagram for Logwatch integration

classDiagram
    class Logwatch {
        +constructor(endpoint)
        +info(message, isJson)
        +success(message, isJson)
        +warn(message, isJson)
        +error(message, isJson)
        +start(message, isJson)
    }
    class consola {
        <<deprecated>>
    }
    Logwatch --|> consola : replaces

Loading

File-Level Changes

Change	Details	Files
Replaced consola logging with logwatch across the application	Converted all consola.log/info/error calls to logwatch equivalent methods Added structured logging support with JSON formatting option Standardized error logging format with message and error object structure Added success logging method to logwatch class	bot/index.js bot/cwl/index.js bot/license/index.js bot/metadata/index.js bot/archival/index.js bot/utils/tools/index.js bot/utils/renderer/index.js bot/utils/logwatch.js
Added new environment variables and updated deployment configurations	Added BOT_LOGWATCH_URL environment variable Added VALIDATOR_URL environment variable Updated deployment workflows to include new environment variables Modified deployment configuration files to support new variables	.github/workflows/deploy-main.yml .github/workflows/deploy-staging.yml bot/config/deploy.yml bot/utils/logwatch.js
Enhanced Zenodo login workflow in the UI	Added new endpoint for purging Zenodo token Implemented token purge before redirecting to Zenodo login Updated UI components to handle Zenodo login flow	ui/pages/dashboard/[owner]/[repo]/release/zenodo.vue ui/server/api/user/zenodo.delete.ts
Updated UI dashboard layout and components	Improved button layout in the dashboard Added space between validation results and edit buttons Updated components.d.ts to reflect UI changes	ui/pages/dashboard/[owner]/[repo]/index.vue ui/components.d.ts

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[fairdataihub-bot]

Thanks for making updates to your pull request. Our team will take a look and provide feedback as soon as possible. Please wait for any GitHub Actions to complete before editing your pull request. If you have any additional questions or concerns, feel free to let us know. Thank you for your contributions!

[sourcery-ai]

Hey @slugb0t - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

suggestion (bug_risk): Add validation for the BOT_LOGWATCH_URL environment variable

Consider adding a check for BOT_LOGWATCH_URL being defined before using it. This will prevent runtime errors if the environment variable is missing.

Suggested change

	*/
	constructor(endpoint) {
	const BOT_ENDPOINT =
	"https://logwatch.fairdataihub.org/api/log/cm4hkn79200027r01ya9gij7r";
	BOT_LOGWATCH_URL;
	if (!endpoint) {
	this.endpoint = BOT_ENDPOINT;
	const { BOT_LOGWATCH_URL } = process.env;
	class Logwatch {
	/**
	*/
	constructor(endpoint) {
	if (!endpoint && !BOT_LOGWATCH_URL) {
	throw new Error('BOT_LOGWATCH_URL environment variable is not defined');
	}
	const BOT_ENDPOINT = BOT_LOGWATCH_URL;
	if (!endpoint) {
	this.endpoint = BOT_ENDPOINT;

[fairdataihub-bot]

Thanks for closing this pull request! If you have any further questions, please feel free to open a new issue. We are always happy to help!