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

[slugb0t]

Summary by Sourcery

Refactor the logging system by replacing 'consola' with 'logwatch' for better log handling. Introduce new environment variables 'BOT_LOGWATCH_URL' and 'VALIDATOR_URL' to enhance configuration flexibility. Update CI workflows and deployment configurations to accommodate these changes.

Enhancements:

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

Build:

• Add new environment variables 'BOT_LOGWATCH_URL' and 'VALIDATOR_URL' to the deployment configuration.

CI:

• Update CI workflows 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 refactors the logging system by replacing direct console logging with a centralized logwatch utility and adds environment variables for configuration. The changes primarily focus on standardizing logging patterns and improving configuration management across the application.

Class diagram for Logwatch utility

classDiagram
    class Logwatch {
        +constructor(endpoint)
        +success(message, isJson=false)
        +warn(message, isJson=false)
        +info(message, isJson=false)
        +error(message, isJson=false)
        +_sendLog(level, message, format)
    }
    note for Logwatch "Centralized logging utility replacing consola"

Loading

File-Level Changes

Change	Details	Files
Replace console logging with logwatch utility	Replace consola.info/error/success calls with logwatch equivalents Add structured logging support with JSON format option Add success method to logwatch class Standardize error logging format with additional context	bot/archival/index.js bot/cwl/index.js bot/index.js bot/metadata/index.js bot/license/index.js bot/utils/tools/index.js bot/utils/renderer/index.js bot/utils/logwatch.js
Add environment variable configuration	Add BOT_LOGWATCH_URL environment variable Add VALIDATOR_URL environment variable Update deployment workflows with new environment variables Update Kamal deployment configuration	bot/utils/logwatch.js bot/config/deploy.yml .github/workflows/deploy-main.yml .github/workflows/deploy-staging.yml

---

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: 2 issues found
• 🟡 Security: 1 issue found
• 🟢 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 response status code check before parsing JSON response

Should verify publishDeposition.ok before attempting to parse JSON to avoid potential runtime errors with malformed responses.

Suggested change

	}
	const publishedDeposition = await publishDeposition.json();
	consola.success("Zenodo deposition published successfully at:", publishedDeposition.links.latest_html);
	logwatch.success(`Zenodo deposition published successfully at: ${publishedDeposition.links.latest_html}`);
	const publishDeposition = await fetch(
	`${ZENODO_API_ENDPOINT}/deposit/depositions/${depositionId}/actions/publish`,
	{
	}
	if (!publishDeposition.ok) {
	const errorText = await publishDeposition.text();
	throw new Error(`Failed to publish Zenodo deposition. Status: ${publishDeposition.status}: ${publishDeposition.statusText}`, { cause: errorText });
	}
	const publishedDeposition = await publishDeposition.json();
	logwatch.success(`Zenodo deposition published successfully at: ${publishedDeposition.links.latest_html}`);

[sourcery-ai]

issue: Add validation for BOT_LOGWATCH_URL environment variable

Should validate that BOT_LOGWATCH_URL is defined and is a valid URL at initialization time to prevent runtime errors.

[sourcery-ai]

🚨 suggestion (security): Add URL validation for VALIDATOR_URL environment variable

Should validate VALIDATOR_URL is a properly formatted URL before using it in fetch calls.

Suggested change

	export async function validateCWLFile(downloadUrl) {
	try {
	const response = await fetch("https://cwl-validate.codefair.io/validate-cwl", {
	const response = await fetch(`${VALIDATOR_URL}/validate-cwl`, {
	function isValidUrl(string) {
	try {
	new URL(string);
	return true;
	} catch (_) {
	return false;
	}
	}
	export async function validateCWLFile(downloadUrl) {
	try {
	if (!VALIDATOR_URL || !isValidUrl(VALIDATOR_URL)) {
	logwatch.error({message: "Invalid VALIDATOR_URL environment variable"}, true);
	return [false, "Configuration error: Invalid validator URL"];
	}
	const response = await fetch(`${VALIDATOR_URL}/validate-cwl`, {

[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!