kinsondigital / kd_clients Goto Github PK

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Improve the release workflow by automatically creating a GitHub release.

Acceptance Criteria

• Release workflow updated

ToDo Items

• Change type labels added to this issue. Refer to the Change Type Labels section below.
• Priority label added to this issue. Refer to the Priority Type Labels section below.
• Issue linked to the correct milestone (if applicable).

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Migrate the project to JSR.

Follow the docs to properly convert imports and configuration of the project so it is compatible with JSR.

This will also involve dealing with any slow types as well as doc generation.

Acceptance Criteria

ToDo Items

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Add a function named downloadAllLatestReleaseAssets to the ReleaseClient.

This will work just like the downloadAllAssetsByReleaseName and downloadAllAssetsByReleaseTag functions except that they will download all the assets for the latest release.

Acceptance Criteria

ToDo Items

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Currently, a lot of the GitHub clients do not specifically catch an authentication HTTP status code of 403 or something similar.

Fix this by going through each GitHub client to properly check for this error, and throwing a proper authentication error. The error to throw should be a custom authentication error named AuthError. The error should have the default message inherited from Error, but also have a property named InnerErrorMessage, which represents the original error from the API.

Example:
A good example of this is the RepoClient.getVariables() function. This function makes the HTTP REST API call, but it only checks if the returned status code is not equal to OK, and that is it. This means if an authentication error is returned, it will still return the same non-informative error and the user will not know that it is an authentication error.

Acceptance Criteria

ToDo Items

• Change type labels added to this issue. Refer to the Change Type Labels section below.
• Priority label added to this issue. Refer to the Priority Type Labels section below.
• Issue linked to the correct milestone (if applicable).

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

After using any of the download asset functions in the ReleaseClient, any subsequent calls to get assets throw an incorrect media type error.

This is because the download asset functions use the application/octet-stream for the content type but never change the header back to the way it was before updating it. This leaves the octet media type header in place for other requests that require a different media type.

In the download functions, get the current media type before setting the content header to octet-stream, and then set the value back to the value before it was changed.

Acceptance Criteria

ToDo Items

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Check various dependencies and update them

Acceptance Criteria

ToDo Items

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Add the ability to do the following with folders and files in the RepoClient.

1. Ability to check if a folder exists in a folder
2. Ability to check if a file exists in a folder
3. Ability to get a list of folders contained in another folder
4. Ability to get a list of files contained in another folder

import { Guards, Utils } from "../../deps.ts";
import { RepoClient } from "../../deps.ts";
import { FileOrFolder } from "../../deps.ts";

export class RepoFileService {
	private readonly fileRegex: RegExp;
	private readonly orgName: string;
	private readonly repoName: string;
	private readonly token: string;
	private readonly repoClient: RepoClient;

	constructor(orgName: string, repoName: string, token: string) {
		Guards.isNothing(orgName);
		Guards.isNothing(repoName);
		Guards.isNothing(token);

		this.fileRegex = /^.+\..+$/gm;
		this.orgName = orgName;
		this.repoName = repoName;
		this.token = token;

		this.repoClient = new RepoClient(orgName, repoName, token);
	}

	public async folderExists(folderPath: string): Promise<boolean> {
		Guards.isNothing(folderPath);

		// Strip leading and trailing slashes
		folderPath = folderPath.startsWith("/") ? folderPath.substring(1) : folderPath;
		folderPath = folderPath.endsWith("/") ? folderPath.substring(0, folderPath.length - 1) : folderPath;
		
		let parentFolder = "";

		if (this.fileRegex.test(folderPath)) {
			Utils.printGitHubError(`The file name '${folderPath}' is not a valid folder path.`);
			Deno.exit(1);
		}

		if (folderPath.includes("/")) {
			const parts = folderPath.split("/");
			parentFolder = parts.slice(0, parts.length - 1).join("/");
		}

		const filesAndFolders = await this.getFilesAndFolders(parentFolder);

		return filesAndFolders.some(f => this.isDir(f.type) && f.name === folderPath);
	}

	public async fileExists(filePath: string) : Promise<boolean> {
		Guards.isNothing(filePath);

		filePath = filePath.trim();

		let folderName = "";
		let fileName = "";
		
		if (filePath.includes("/")) {
			const parts = filePath.split("/");
			fileName = parts[parts.length - 1];
			
			if (!this.fileRegex.test(fileName)) {
				Utils.printGitHubError(`The file name '${fileName}' is not a valid file name.`);
				Deno.exit(1);
			}

			folderName = parts.slice(0, parts.length - 1).join("/");
		} else {
			if (!this.fileRegex.test(fileName)) {
				Utils.printGitHubError(`The file name '${fileName}' is not a valid file name.`);
				Deno.exit(1);
			}

			fileName = filePath;
		}

		const filesAndFolders = await this.getFilesAndFolders(folderName);

		return filesAndFolders.some(f => this.isFile(f.type) && f.name === fileName);
	}

	private async getFilesAndFolders(relativePath: string): Promise<FileOrFolder[]> {
		// Guards.isNothing(relativePath);

		const baseUrl = "https://api.github.com";
		const url = `${baseUrl}/repos/KinsonDigital/Velaptor/contents/${relativePath}`;
		
		const result = await fetch(url, {
			method: "GET",
			headers: {
				"Authorization": `Bearer ${this.token}`,
				"Accept": "application/vnd.github+json",
				"X-Github-Api-Version": "2022-11-28"
			},
		});
		
		if (result.status != 200) {
			console.error(result.statusText);
			Deno.exit(1);
		}
		
		const data = await result.json() as FileOrFolder[];

		return data;
	}

	private isFile(type: string): type is "file" {
		return type === "file";
	}

	private isDir(type: string): type is "dir" {
		return type === "dir";
	}
}

Acceptance Criteria

ToDo Items

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Add a new function to the release client to allow the updating of a GitHub release body.

Acceptance Criteria

ToDo Items

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

In the release workflow, the script URL for sending a release tweet is not fully formed and missing the script file name/relative path.

Fix this and improve pathing in the entire workflow.

Acceptance Criteria

ToDo Items

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Currently, the XClient is using the [email protected] npm package internally. This is causing issues when it comes npm package support in some systems such as with supabase edge functions.

To solve this issue, replace the npm package with a deno compatible version that can do the same thing as the npm package, or create a custom implementation.

Acceptance Criteria

ToDo Items

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Go through all GitHub clients and add checks for the HTTP 401 Unauthorized status code if it does not exist.

If this status code exists, throw an AuthError with the correct message.

Acceptance Criteria

ToDo Items

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Add some functions to the ReleaseClient to delete and upload assets from a release.

Delete single asset:

1. If the asset does not exist, an error will be thrown.
   • The error will only be thrown if the 'errorIfMissingis set totrue`

Upload single asset functions:

1. Create a function that uploads a single asset to a release by a release tag
   • If the asset to replace already exists, it will be replaced. But only if the overwrite param is set to true
2. Create a function that uploads a single asset to a release by a release name
   • If the asset to replace already exists, it will be replaced. But only if the overwrite param is set to true

Asset Exists:

1. Create a function that checks if a release asset exists by asset name

Acceptance Criteria

ToDo Items

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Create a workflow that helps prepare the release by creating the release notes and updating the version. Use the prepare release workflow from the Velaptor repository as a starting point.

The updating of the version will have to be done differently than in Velaptor. It exists in the deno.json. Currently the PrepareReleaseRunner in the Infrastructure repository needs to be updated to pull versions from deno files before this can be implemented.

Also, update the applicable workflows that use the pull_request_target trigger to use the preview branch in addition to the main branch.

With the creation of a preview branch, the release workflow will probably need to be updated.

Note
This is going to require this project to start using preview branches.

ToDo Items

• Change type labels added to this issue. Refer to the Change Type Labels section below.
• Priority label added to this issue. Refer to the Priority Type Labels section below.
• Issue linked to the correct milestone (if applicable).

Issue Dependencies

• KinsonDigital/Infrastructure#172

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Add a new function to the ReleaseClient to get all of the releases as an array.

Reason:
Some users are saying that they need to get all of the releases so they can perform their own filtering or processing of the releases. Currently, the only function available is the public function named getReleases(), but this takes the page and qtyPerPage parameters. This forces the user to implement their own pagination code to get all of the releases. This is not good DX..

Add a new function named getAllReleases() which will simply get all of the releases as an array.

Acceptance Criteria

ToDo Items

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 📋 emoji.

Description

Make improvements to the CLI class to better handle directory and file paths as well as make use of the Deno.execPath() API.

CLI Class Code:

/**
 * A simple CLI command wrapper.
 */
export class CLI {
	/**
	 * Runs the following CLI {@link command}.
	 * @param command The command to run.
	 * @returns The output of the command if successful, otherwise an error.
	 */
	public async runAsync(command: string): Promise<string | Error> {
		if (command === undefined || command === null || command === "") {
			const errorMsg = "The command parameter cannot be null or empty.";
			console.log(errorMsg);
			Deno.exit(1);
		}

		command = command.includes("'")
			? command.replace(/'/g, '"')
			: command;

		const sections: string[] = command.match(/(?:[^\s"']+|"[^"]*"|'[^']*')+/g) ?? [];

		const app = sections[0] === "deno" ? Deno.execPath() : sections[0];
		const args = sections.slice(1).map(arg => arg.replace(/"/g, ''));

		const cmd = new Deno.Command(app, { args: args });

		const { code, stdout, stderr } = await cmd.output();

		if (code === 0) {
			return new TextDecoder().decode(stdout);
		} else {
			return new Error(new TextDecoder().decode(stderr));
		}
	}
}

Directory.getFiles() Function

/**
 * Gets a list of files in the given {@link dirPath}.  This will search recursively
 * if {@link recursive} is true.
 * @param dirPath The path of the directory start searching.
 * @param extension The file extension to search for.
 * @param recursive True to search recursively, otherwise false.
 * @returns {string[]} A list of files in the given {@link dirPath}.
 */
public static getFiles(dirPath: string, extension:string, recursive = false): string[] {
	let files: string[] = [];

	extension = extension.trim();

	const extensionRegex = /\.[a-zA-Z]/g;

	extension = Utils.isNothing(extension) ? "*.*" : extension;

	if (extension != "*.*") {
		extension = extension.startsWith("*.") ? extension.substring(1) : extension;

		if (!extension.startsWith(".") || extension.length === 1) {
			const errorMsg = `The extension '${extension}' is not supported.\n` +
								`Must be a value of '*.*' or '*.<extension>'.`;
			console.log(errorMsg);
			throw new Error(errorMsg);
		}
	}

	if (dirPath === undefined || dirPath === null || dirPath === "") {
		const errorMsg = "The dirPath parameter cannot be null or empty.";
		console.log(errorMsg);
		Deno.exit(1);
	}

	dirPath = dirPath === "." || dirPath === "./" ? Deno.cwd() : dirPath;

	for (const dirEntry of Deno.readDirSync(dirPath)) {
		const entry = dirPath + "/" + dirEntry.name;

		if (recursive && dirEntry.isDirectory) {
			files = [...files, ...(Directory.getFiles(entry, extension, recursive))];
		} else if (dirEntry.isFile) {
			if (extension === "*.*") {
				files.push(entry);
			} else {
				if (entry.endsWith(extension)) {
					files.push(entry);
				}
			}
		}
	}

	return files;
}

Adjust deno-check.ts Script:

const files: string[] = Directory
-	.getFiles("/", ".ts", true)
+	.getFiles("./", ".ts", true)
	.filter(f => ignoreDirectories.every(ignoreDir => !f.startsWith(ignoreDir)));

Acceptance Criteria

ToDo Items

• Change type labels added to this issue. Refer to the Change Type Labels section below.
• Priority label added to this issue. Refer to the Priority Type Labels section below.

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Fix an issue with the release workflow with a missing argument to the close milestone script.

This is on line #158 in the release.yml workflow. The organization name is missing as the first argument.

Acceptance Criteria

ToDo Items

• Change type labels added to this issue. Refer to the Change Type Labels section below.
• Priority label added to this issue. Refer to the Priority Type Labels section below.
• Issue linked to the correct milestone (if applicable).

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

When creating a new OrgClient object, an error is thrown that the repoName is null, undefined, or empty when it is not.

error: Uncaught Error: The value is null, undefined, or empty.
Function Name: repoName
Param Name: v
			throw new Error(errorMsg);
			      ^
    at Function.isNothing (https://deno.land/x/[email protected]/core/Guard.ts:28:10)
    at OrgClient.set repoName (https://deno.land/x/[email protected]/core/GitHubClient.ts:64:9)
    at new GitHubClient (https://deno.land/x/[email protected]/core/GitHubClient.ts:27:16)
    at new OrgClient (https://deno.land/x/[email protected]/GitHubClients/OrgClient.ts:23:3)
    at AddItemToProjectRunner.validateArgs (file:///K:/SOFTWARE-DEV/PERSONAL/Infrastructure/cicd/scripts/runners/AddItemToProjectRunner.ts:78:21)
    at AddItemToProjectRunner.run (file:///K:/SOFTWARE-DEV/PERSONAL/Infrastructure/cicd/scripts/runners/ScriptRunner.ts:63:14)
    at AddItemToProjectRunner.run (file:///K:/SOFTWARE-DEV/PERSONAL/Infrastructure/cicd/scripts/runners/AddItemToProjectRunner.ts:35:15)
    at file:///K:/SOFTWARE-DEV/PERSONAL/Infrastructure/cicd/scripts/add-item-to-project.ts:4:32

After digging into the issue, the org client is sending in an empty string literal into the super() call which is type GitHubClient. In the GitHubClient class, the constructor contains a guard that checks if the repoName argument is null and throws an error when it is. Which in this case it always is.

Just send in the value na to fix this issue.

Acceptance Criteria

ToDo Items

• Change type labels added to this issue. Refer to the Change Type Labels section below.
• Priority label added to this issue. Refer to the Priority Type Labels section below.
• Issue linked to the correct milestone (if applicable).

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

With various functions in the IssueClient, add an options parameter to functions where using options would make sense to use.

A good example would be the getIssues() function. The following params could be added to an options param instead.

1. state
2. labels
3. milestoneNumber

Acceptance Criteria

ToDo Items

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Install and set up KDAdmin
Use this command to install KDAdmin:

  deno run -Ar https://raw.githubusercontent.com/KinsonDigital/kd-admin/preview/installation/install.ts latest

& "dev-tools/bin/kd-admin" create-pr;

Acceptance Criteria

ToDo Items

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

This is the initial creation of the project. Everything from code, config, ide settings, deno settings, etc.

Release Workflow

The release workflow needs to be able to run linting, run tests, and then create an empty commit with a tag that is the version number. This number should be chosen when manually running the release workflow. All validation of inputs should be performed.

Prepare Release Templates:

Create new prepare release templates based on the ones that already exist in infrastructure.
Create these templates in this repo, not in the Infrastructure repo.

This will require the use of the following repo variables:

• PREV_RELATIVE_PR_RELEASE_TEMPLATE_FILE_PATH
• PROD_RELATIVE_PR_RELEASE_TEMPLATE_FILE_PATH
• PR_RELEASE_TEMPLATE_REPO_NAME

  Note
  This variable will hold the name of the repo where the templates exist

Acceptance Criteria

• Setup PR syncing system
• Build status check workflow created

  Note
  This uses the new deno-check.ts script

• Setup test status check workflow
• Setup linting status check workflow
• Setup release workflow
  • Runs linting
  • Runs tests
  • Creates an empty commit, tags that commit, and pushes all to remote
  • Version validation run against the incoming workflow version input
  • DENO_VERSION variable setup and used in all workflows
• Prepare release templates created
• Packages vendored

ToDo Items

• Change type labels added to this issue. Refer to the Change Type Labels section below.
• Priority label added to this issue. Refer to the Priority Type Labels section below.
• Issue linked to the correct milestone (if applicable).

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Create a default mod.ts module for the models in the Models and Models/GraphQlModels directories.

The GraphQL modules should be also imported into the Models folder and reexported. This will give the option to the user to point to the Models mod.ts module and get every single model or to reference the mod.ts module for the GraphQL modules only.

Acceptance Criteria

• default module added to the Models/GraphQlModels directory
• default module added to the Models directory
  • Models/GraphQlModels mod.ts imported into the

ToDo Items

• Change type labels added to this issue. Refer to the Change Type Labels section below.
• Priority label added to this issue. Refer to the Priority Type Labels section below.
• Issue linked to the correct milestone (if applicable).

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Fix a bug where updating a repo file using the RepoClient.updateFile() function throws an error when the file that is trying to be updated already exists.

Expected Behavior:
The error should only be thrown if the file does not exist.

Acceptance Criteria

ToDo Items

• Change type labels added to this issue. Refer to the Change Type Labels section below.
• Priority label added to this issue. Refer to the Priority Type Labels section below.
• Issue linked to the correct milestone (if applicable).

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Add a new function to the ReleaseClient that takes a release id or name and an asset name parameter and returns a result indicating whether the asset exists in the release.

Add the following function signature:

public async assetExists(releaseIdOrName: number | string, assetName: string): Promise<boolean>;

This function will dynamically check if the release is an id number or name string and then use the asset name to check if the asset exists.

Acceptance Criteria

ToDo Items

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Change the token parameter in the OrgClient constructor from optional to required.

Acceptance Criteria

ToDo Items

• Change type labels added to this issue. Refer to the Change Type Labels section below.
• Priority label added to this issue. Refer to the Priority Type Labels section below.
• Issue linked to the correct milestone (if applicable).

Issue Dependencies

No response

Related Work

No response

Additional Information:

Code of Conduct

• I agree to follow this project's Code of Conduct.

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Update the release client to give the ability to upload assets to an existing release.

Should have the following capabilities:

1. Upload a single asset
2. Upload multiple assets via an array of files
3. Check to make sure that the release exists first
4. Can take the title of a release as a parameter when choosing a release to upload assets to

Acceptance Criteria

ToDo Items

• Change type labels added to this issue. Refer to the Change Type Labels section below.
• Priority label added to this issue. Refer to the Priority Type Labels section below.
• Issue linked to the correct milestone (if applicable).

Issue Dependencies

No response

Related Work

No response

Additional Information: