Utils.h File Reference

This file defines general utility functions, like error handling, checks, converting types, etc. More...

#include <string>
#include "Enums.h"

Go to the source code of this file.

Functions
void	printInputError (InputErrors inputError)
	Prints error messages when user runs the script with incorrect parameters/input.
size_t	handleApiCallBack (char *data, size_t size, size_t numOfBytes, string *buffer)
	Callback function that is required to handle API response in libcurl.
void	handleGithubApiErrorCodes (long errorCode, string apiResponse)
	Throws runtime exceptions with appropriate messages that describe the given GitHub API error code All info obtained from https://docs.github.com/en/rest/using-the-rest-api/troubleshooting-the-rest-api?apiVersion=2022-11-28.
CommitTypeMatchResults	checkCommitTypeMatch (string commitMessage, int commitTypeIndex)
	Checks how the given commit message matches the expected conventional commit type.
string	convertMarkdownToHtml (string markdownText, string githubToken)
	Converts markdown to HTML using the GitHub API markdown endpoint.
void	writeGeneratedNotesInFiles (string markdownGeneratedNotes, string githubToken)
	Writes the generated markdown notes in the markdown file and converts these markdown notes to HTML and writes them in the HTML file.

Detailed Description

This file defines general utility functions, like error handling, checks, converting types, etc.

Author

Ahmed Khaled

Function Documentation

checkCommitTypeMatch()

CommitTypeMatchResults checkCommitTypeMatch	(	string	commitMessage,
		int	commitTypeIndex )

Checks how the given commit message matches the expected conventional commit type.

Parameters

commitMessage	The commit message
commitTypeIndex	Index of the commit type to check against in the commit types 2d array

Returns

The type of match that happened between the two commit types

                                                                                       {
    string correctCommitType = config.commitTypes[commitTypeIndex][(int)CommitTypeInfo::ConventionalName];
 
    if (commitMessage.substr(0, commitMessage.find(":")) == correctCommitType) {
        return CommitTypeMatchResults::MatchWithoutSubCategory;
    }
    else if (commitMessage.substr(0, commitMessage.find("(")) == correctCommitType) {
        return CommitTypeMatchResults::MatchWithSubCategory;
    }
    else {
        return CommitTypeMatchResults::NoMatch;
    }
}

convertMarkdownToHtml()

string convertMarkdownToHtml	(	string	markdownText,
		string	githubToken )

Converts markdown to HTML using the GitHub API markdown endpoint.

Parameters

markdownText	The markdown text to be converted to HTML
githubToken	The GitHub token used to make authenticated requests to the GitHub API

Returns

The HTML text containing the exact same content as the given markdown

                                                                      {
    // Initializing libcurl
    CURL* curl = curl_easy_init();
    CURLcode resultCode;
    string htmlText;
    struct curl_slist* headers = NULL;
    headers = curl_slist_append(headers, ((const string)"Accept: application/vnd.github+json").c_str());
    headers = curl_slist_append(headers, ("Authorization: token " + githubToken).c_str());
 
    if (curl) {
        curl_easy_setopt(curl, CURLOPT_URL, config.githubMarkdownApiUrl.c_str());
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, handleApiCallBack);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &htmlText);
        curl_easy_setopt(curl, CURLOPT_USERAGENT, "Ahmed-Khaled-dev");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
 
        json postData;
        postData["text"] = markdownText;
        string postDataString = postData.dump();
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, postDataString.c_str());
 
        resultCode = curl_easy_perform(curl);
 
        if (resultCode == CURLE_OK) {
            // Get the HTTP response code
            long httpCode;
            curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &httpCode);
 
            if (httpCode == 200) {
                return htmlText;
            }
            else if (httpCode == 404) {
                throw runtime_error("Markdown API url not found");
            }
            else {
                handleGithubApiErrorCodes(httpCode, htmlText);
            }
        }
        else {
            throw runtime_error(config.githubApiUnableToMakeRequestError);
        }
 
        curl_easy_cleanup(curl);
        curl_slist_free_all(headers);
    }
    else {
        throw runtime_error(config.githubApiLibcurlError);
    }
 
    return htmlText;
}

handleApiCallBack()

size_t handleApiCallBack	(	char *	data,
		size_t	size,
		size_t	numOfBytes,
		string *	buffer )

Callback function that is required to handle API response in libcurl.

Parameters

data	Pointer to the data received
size	Size of each data element
numOfBytes	Number of bytes received
buffer	Pointer to the buffer storing the response

Returns

Total size of the received data

                                                                                     {
    size_t totalSize = size * numOfBytes;
    buffer->append(data, totalSize);
    return totalSize;
}

handleGithubApiErrorCodes()

void handleGithubApiErrorCodes	(	long	errorCode,
		string	apiResponse )

Throws runtime exceptions with appropriate messages that describe the given GitHub API error code All info obtained from https://docs.github.com/en/rest/using-the-rest-api/troubleshooting-the-rest-api?apiVersion=2022-11-28.

Parameters

errorCode	The GitHub API error code that occurred
apiResponse	The GitHub API response

                                                                   {
    if (errorCode == 429 || errorCode == 403) {
        throw runtime_error(config.githubApiRateLimitExceededError + apiResponse);
    }
    else if (errorCode == 401) {
        throw runtime_error(config.githubApiUnauthorizedAccessError + apiResponse);
    }
    else if (errorCode == 400) {
        throw runtime_error(config.githubApiBadRequestError + apiResponse);
    }
}

printInputError()

void printInputError

(

InputErrors

inputError

)

Prints error messages when user runs the script with incorrect parameters/input.

Parameters

inputError

The type of input error

                                             {
    if (inputError == InputErrors::NoReleaseNotesSource) {
        cerr << config.noReleaseNotesSourceError << endl;
    }
    else if (inputError == InputErrors::IncorrectReleaseNotesSource) {
        cerr << config.incorrectReleaseNotesSourceError << endl;
    }
    else if (inputError == InputErrors::NoReleaseNotesMode) {
        cerr << config.noReleaseNotesModeError << endl;
    }
    else if (inputError == InputErrors::IncorrectReleaseNotesMode) {
        cerr << config.incorrectReleaseNotesModeError << endl;
    }
    else if (inputError == InputErrors::NoGithubToken) {
        cerr << config.noGithubTokenError << endl;
    }
    else if (inputError == InputErrors::NoReleaseStartReference) {
        cerr << config.noReleaseStartReferenceError << endl;
    }
    else if (inputError == InputErrors::NoReleaseEndReference) {
        cerr << config.noReleaseEndReferenceError << endl;
    }
    else if (inputError == InputErrors::NoPullRequestNumber) {
        cerr << config.noPullRequestNumberError << endl;
    }
    else if(inputError == InputErrors::NoGithubRepository) {
        cerr << config.noGithubRepositoryError << endl;
    }
    cerr << config.expectedSyntaxMessage << endl;
}

writeGeneratedNotesInFiles()

void writeGeneratedNotesInFiles	(	string	markdownGeneratedNotes,
		string	githubToken )

Writes the generated markdown notes in the markdown file and converts these markdown notes to HTML and writes them in the HTML file.

Parameters

markdownGeneratedNotes	The generated markdown notes to be written
githubToken	The GitHub token used to make authenticated requests to the GitHub API

                                                                                   {
    ofstream markdownFileOutput(config.markdownOutputFileName);
 
    if (!markdownFileOutput.is_open()) {
        throw runtime_error(config.markdownFileError);
    }
 
    if (markdownGeneratedNotes.size() == 0) {
        throw runtime_error(config.emptyReleaseNotesMessage);
    }
 
    markdownFileOutput << markdownGeneratedNotes;
    markdownFileOutput.close();
 
    ofstream htmlFileOutput(config.htmlOutputFileName);
 
    if (!htmlFileOutput.is_open()) {
        throw runtime_error(config.htmlFileError);
    }
 
    htmlFileOutput << convertMarkdownToHtml(markdownGeneratedNotes, githubToken);
}