@rosen-bridge/utils 0.0.1 → 0.2.0

package/lib/utils/github.ts

@@ -3,19 +3,20 @@ import { Octokit } from 'octokit';
 import { isValidAssetName } from './rosen';
 
 import {
-  CONTRACT_REPO_NAME,
   DEFAULT_RELEASES_FETCHING_PAGE_SIZE,
   ROSEN_BRIDGE_ORGANIZATION,
 } from '../constants';
 
-import { GithubRelease } from '../types';
+import { GithubRelease, SupportedRepo } from '../types';
 
 /**
  * Fetch a page of releases from Github Api in each iteration until there are no
  * more releases.
+ * @param repoName
  * @param pageSize
  */
 async function* fetchReleasesPage(
+  repoName: SupportedRepo,
   pageSize = DEFAULT_RELEASES_FETCHING_PAGE_SIZE
 ) {
   const octokit = new Octokit();
@@ -25,7 +26,7 @@ async function* fetchReleasesPage(
   while (true) {
     const releasesPage = await octokit.rest.repos.listReleases({
       owner: ROSEN_BRIDGE_ORGANIZATION,
-      repo: CONTRACT_REPO_NAME,
+      repo: repoName,
       per_page: pageSize,
       page: currentPage,
     });
@@ -42,12 +43,14 @@ async function* fetchReleasesPage(
 /**
  * Find the last release matching the predicate. If all releases are iterated and
  * no matching release is found, return null.
+ * @param repoName
  * @param predicate
  */
 const findLastRelease = async (
+  repoName: SupportedRepo,
   predicate: (release: GithubRelease) => boolean = () => true
 ) => {
-  const releasesPageIterator = fetchReleasesPage();
+  const releasesPageIterator = fetchReleasesPage(repoName);
 
   for await (const releasesPage of releasesPageIterator) {
     const foundRelease = releasesPage.find(predicate);
@@ -59,6 +62,22 @@ const findLastRelease = async (
   return null;
 };
 
+/**
+ * get a GitHub release by its tag
+ * @param repoName
+ * @param tag
+ */
+const getReleaseByTag = async (repoName: SupportedRepo, tag: string) => {
+  const octokit = new Octokit();
+  const release = await octokit.rest.repos.getReleaseByTag({
+    owner: ROSEN_BRIDGE_ORGANIZATION,
+    repo: repoName,
+    tag,
+  });
+
+  return release.data;
+};
+
 /**
  * Return a function which checks if a release has at least one asset for a
  * specific chain type
@@ -77,27 +96,74 @@ const isStableReleaseForChainType =
   (chainType: string) => (release: GithubRelease) =>
     !release.prerelease && hasAssetForChainType(chainType)(release);
 
+/**
+ * Return a function which checks if tagPrefix is matched with release tag_name
+ * @param tagPrefix
+ */
+const hasMatchedTagPrefix = (tagPrefix: string) => (release: GithubRelease) => {
+  const regex = new RegExp(`^${tagPrefix}`);
+  return regex.test(release.tag_name);
+};
+
+/**
+ * Return a function which checks if a release is a stable (that is, non-prerelease),
+ * and tagPrefix is matched with release tag_name
+ * @param tagPrefix
+ */
+const isStableReleaseForRegexTagType =
+  (tagPrefix: string) => (release: GithubRelease) =>
+    !release.prerelease && hasMatchedTagPrefix(tagPrefix)(release);
+
 /**
  * Find latest release (prerelease or non-prerelease) having some asset matching
  * a specific chain type
+ * @param repoName
  * @param chainType
  */
-const findLatestRelease = async (chainType: string) =>
-  findLastRelease(hasAssetForChainType(chainType));
+const findLatestRelease = async (repoName: SupportedRepo, chainType: string) =>
+  findLastRelease(repoName, hasAssetForChainType(chainType));
 
 /**
  * Find latest stable (that is, non-prerelease) release having some asset matching
  * a specific chain type
+ * @param repoName
  * @param chainType
  */
-const findLatestStableRelease = async (chainType: string) =>
-  findLastRelease(isStableReleaseForChainType(chainType));
+const findLatestStableRelease = async (
+  repoName: SupportedRepo,
+  chainType: string
+) => findLastRelease(repoName, isStableReleaseForChainType(chainType));
+
+/**
+ * Find the latest stable (that is, non-prerelease) release that tagPrefix is matched with release tag_name
+ * @param repoName
+ * @param tagPrefix
+ */
+const findLatestStableReleaseByPrefixTag = async (
+  repoName: SupportedRepo,
+  tagPrefix: string
+) => findLastRelease(repoName, isStableReleaseForRegexTagType(tagPrefix));
+
+/**
+ * Find the latest release that tagPrefix is matched with release tag_name
+ * @param repoName
+ * @param tagPrefix
+ */
+const findLatestReleaseByPrefixTag = async (
+  repoName: SupportedRepo,
+  tagPrefix: string
+) => findLastRelease(repoName, hasMatchedTagPrefix(tagPrefix));
 
 export {
   fetchReleasesPage,
   findLastRelease,
   findLatestRelease,
   findLatestStableRelease,
+  findLatestStableReleaseByPrefixTag,
+  findLatestReleaseByPrefixTag,
+  getReleaseByTag,
   hasAssetForChainType,
   isStableReleaseForChainType,
+  isStableReleaseForRegexTagType,
+  hasMatchedTagPrefix,
 };

package/lib/utils/rosen.ts

@@ -6,6 +6,13 @@
 export const isValidAssetName = (chainType: string) => (assetName: string) =>
   new RegExp(`(contracts-.+|tokensMap)-${chainType}-.+.json`).test(assetName);
 
+/**
+ * Check if an OS name is a valid supported tss OS
+ * @param OSName
+ */
+export const isValidOS = (OSName: string) => (releaseAssetName: string) =>
+  new RegExp(`(rosenTss-${OSName}-.+).zip`).test(releaseAssetName);
+
 /**
  * Remove chain type and tag from the asset name and optionally replaces them
  * with a suffix

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rosen-bridge/utils",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Misc utility functions used inside Rosen bridge projects",
   "main": "dist/lib/index.js",
   "types": "dist/lib/index.d.ts",
@@ -10,8 +10,8 @@
     "lint": "eslint --fix . && npm run prettify",
     "build": "tsc --build tsconfig.build.json",
     "type-check": "tsc --noEmit",
-    "test": "jest",
-    "coverage": "jest --coverage",
+    "test": "jest --runInBand",
+    "coverage": "jest --coverage --runInBand",
     "release": "npm run test && npm run build && npm publish --access public"
   },
   "repository": {
@@ -22,7 +22,6 @@
   "devDependencies": {
     "@types/download": "^8.0.2",
     "@babel/preset-env": "^7.19.0",
-    "@types/download": "^8.0.2",
     "@types/jest": "^29.1.2",
     "@types/node": "^18.0.0",
     "@typescript-eslint/eslint-plugin": "^5.30.7",

package/tests/data/octokit.data.ts

@@ -4,6 +4,7 @@ export type PartialReleases = Partial<GithubRelease>[];
 
 export const mainNetPrereleaseRelease = {
   id: 1,
+  tag_name: '1',
   prerelease: true,
   assets: [
     {
@@ -20,6 +21,7 @@ export const mainNetPrereleaseRelease = {
 
 export const mainNetStableRelease = {
   id: 2,
+  tag_name: '2',
   prerelease: false,
   assets: [
     {
@@ -34,8 +36,80 @@ export const mainNetStableRelease = {
   ],
 };
 
+export const tssTag1 = {
+  id: 1,
+  tag_name: 'tss-api-1.0.0',
+  name: 'tss-api-1.0.0',
+  prerelease: false,
+  assets: [
+    {
+      name: 'rosenTss-linux-tss-api-1.0.0.zip',
+      browser_download_url:
+        'https://example.com/sign-protocols/releases/download/tss-api-1.0.0/rosenTss-linux-tss-api-1.0.0.zip',
+    } as any,
+    {
+      name: 'rosenTss-macOS-tss-api-1.0.0.zip',
+      browser_download_url:
+        'https://example.com/sign-protocols/releases/download/tss-api-1.0.0/rosenTss-macOS-tss-api-1.0.0.zip',
+    } as any,
+    {
+      name: 'rosenTss-windows-tss-api-1.0.0.zip',
+      browser_download_url:
+        'https://example.com/sign-protocols/releases/download/tss-api-1.0.0/rosenTss-windows-tss-api-1.0.0.zip',
+    } as any,
+  ],
+};
+export const tssTag2 = {
+  id: 2,
+  tag_name: 'tss-api-2.0.0',
+  name: 'tss-api-2.0.0',
+  prerelease: false,
+  assets: [
+    {
+      name: 'rosenTss-linux-tss-api-2.0.0.zip',
+      browser_download_url:
+        'https://example.com/sign-protocols/releases/download/tss-api-2.0.0/rosenTss-linux-tss-api-2.0.0.zip',
+    } as any,
+    {
+      name: 'rosenTss-macOS-tss-api-2.0.0.zip',
+      browser_download_url:
+        'https://example.com/sign-protocols/releases/download/tss-api-2.0.0/rosenTss-macOS-tss-api-2.0.0.zip',
+    } as any,
+    {
+      name: 'rosenTss-windows-tss-api-2.0.0.zip',
+      browser_download_url:
+        'https://example.com/sign-protocols/releases/download/tss-api-2.0.0/rosenTss-windows-tss-api-2.0.0.zip',
+    } as any,
+  ],
+};
+
+export const tssTag3PreRelease = {
+  id: 3,
+  tag_name: 'tss-api-3.0.0',
+  name: 'tss-api-3.0.0',
+  prerelease: true,
+  assets: [
+    {
+      name: 'rosenTss-linux-tss-api-3.0.0.zip',
+      browser_download_url:
+        'https://example.com/sign-protocols/releases/download/tss-api-3.0.0/rosenTss-linux-tss-api-3.0.0.zip',
+    } as any,
+    {
+      name: 'rosenTss-macOS-tss-api-3.0.0.zip',
+      browser_download_url:
+        'https://example.com/sign-protocols/releases/download/tss-api-3.0.0/rosenTss-macOS-tss-api-3.0.0.zip',
+    } as any,
+    {
+      name: 'rosenTss-windows-tss-api-3.0.0.zip',
+      browser_download_url:
+        'https://example.com/sign-protocols/releases/download/tss-api-3.0.0/rosenTss-windows-tss-api-3.0.0.zip',
+    } as any,
+  ],
+};
+
 export const testNetPrereleaseRelease = {
   id: 4,
+  tag_name: '4',
   prerelease: true,
   assets: [
     {
@@ -48,6 +122,7 @@ export const testNetPrereleaseRelease = {
 
 export const testNetStableRelease = {
   id: 5,
+  tag_name: '5',
   prerelease: false,
   assets: [
     {
@@ -58,11 +133,12 @@ export const testNetStableRelease = {
   ],
 };
 
-export const releases = [
+export const contractReleases = [
   mainNetPrereleaseRelease,
   mainNetStableRelease,
   {
     id: 3,
+    tag_name: '3',
     prerelease: false,
     assets: [
       {
@@ -76,6 +152,7 @@ export const releases = [
   testNetStableRelease,
   {
     id: 6,
+    tag_name: '6',
     prerelease: false,
     assets: [
       {
@@ -87,6 +164,7 @@ export const releases = [
   },
   {
     id: 7,
+    tag_name: '7',
     prerelease: false,
     assets: [
       {
@@ -98,6 +176,7 @@ export const releases = [
   },
   {
     id: 8,
+    tag_name: '8',
     prerelease: false,
     assets: [
       {
@@ -109,6 +188,7 @@ export const releases = [
   },
   {
     id: 9,
+    tag_name: '9',
     prerelease: false,
     assets: [
       {
@@ -119,3 +199,10 @@ export const releases = [
     ],
   },
 ] satisfies PartialReleases;
+
+export const tssReleases = [
+  mainNetStableRelease, // in case of sign-protocols mono repo we have other tags
+  tssTag3PreRelease,
+  tssTag2,
+  tssTag1,
+] satisfies PartialReleases;

package/tests/downloadRosenAssets.spec.ts

@@ -7,15 +7,16 @@ import { RosenAssetsDownloadError } from '../lib';
 import {
   mainNetPrereleaseRelease,
   mainNetStableRelease,
+  contractReleases,
 } from './data/octokit.data';
 
-import { mockOctokit } from './mocks/octokit.mock';
+import { mockOctokit, mockOctokitGetReleaseByTag } from './mocks/octokit.mock';
 
 jest.mock('download');
 
 describe('downloadRosenAssets', () => {
   beforeEach(() => {
-    mockOctokit();
+    mockOctokit(contractReleases);
   });
 
   /**
@@ -23,7 +24,7 @@ describe('downloadRosenAssets', () => {
    * @dependencies
    * - mocked Octokit
    * @scenario
-   * - mock Octokit `listReleases` to return 9 releases
+   * - mock Octokit `listReleases` to return 9 contractReleases
    * - call `downloadRosenAssets` with mainnet chain type and `rosen` download
    *   directory
    * @expected
@@ -59,7 +60,7 @@ describe('downloadRosenAssets', () => {
    * @dependencies
    * - mocked Octokit
    * @scenario
-   * - mock Octokit `listReleases` to return 9 releases
+   * - mock Octokit `listReleases` to return 9 contractReleases
    * - call `downloadRosenAssets` with mainnet chain type, `rosen` download
    *   directory and including prereleases
    * @expected
@@ -71,7 +72,10 @@ describe('downloadRosenAssets', () => {
    *    corresponding truncated asset name
    */
   it('should download Rosen assets correctly when including prereleases', async () => {
-    await downloadRosenAssets('mainnet', 'rosen', true);
+    jest.mocked(download).mockClear();
+    await downloadRosenAssets('mainnet', 'rosen', {
+      includePrereleases: true,
+    });
 
     expect(download).toHaveBeenCalledWith(
       mainNetPrereleaseRelease.assets[0].browser_download_url,
@@ -95,7 +99,7 @@ describe('downloadRosenAssets', () => {
    * @dependencies
    * - mocked Octokit
    * @scenario
-   * - mock Octokit `listReleases` to return 9 releases
+   * - mock Octokit `listReleases` to return 9 contractReleases
    * - call `downloadRosenAssets` with mainnet chain type, `rosen` download
    *   directory, including prereleases and a providing a suffix
    * @expected
@@ -107,7 +111,9 @@ describe('downloadRosenAssets', () => {
    *    truncated asset name
    */
   it('should download Rosen assets and add a suffix correctly', async () => {
-    await downloadRosenAssets('mainnet', 'rosen', false, 'suffix');
+    await downloadRosenAssets('mainnet', 'rosen', {
+      nameSuffix: 'suffix',
+    });
 
     expect(download).toHaveBeenCalledWith(
       mainNetStableRelease.assets[0].browser_download_url,
@@ -125,6 +131,30 @@ describe('downloadRosenAssets', () => {
     );
   });
 
+  /**
+   * @target `downloadRosenAssets` should download a Rosen asset by tag
+   * @dependencies
+   * - mocked `getReleaseByTag` of Octokit
+   * @scenario
+   * - call `downloadRosenAssets` with a specific tag
+   * @expected
+   * - `download` should be called with the assets of "3" tag release
+   */
+  it('should download a Rosen asset by tag', async () => {
+    mockOctokitGetReleaseByTag(contractReleases);
+    await downloadRosenAssets('mainnet', 'rosen', {
+      tag: '3',
+    });
+
+    expect(download).toHaveBeenCalledWith(
+      contractReleases[2].assets[0].browser_download_url,
+      'rosen',
+      {
+        filename: 'contracts-awesomechain.json',
+      }
+    );
+  });
+
   /**
    * @target `downloadRosenAssets` should not call `download` function when no
    * matching release is found
@@ -132,7 +162,7 @@ describe('downloadRosenAssets', () => {
    * - mocked Octokit
    * - emptied mocked download package
    * @scenario
-   * - mock Octokit `listReleases` to return 9 releases
+   * - mock Octokit `listReleases` to return 9 contractReleases
    * - clear download package mock data (so that we can check calls count)
    * - call `downloadRosenAssets` with "no-release-net" chain type and `rosen`
    *   download directory
@@ -153,7 +183,7 @@ describe('downloadRosenAssets', () => {
    * - mocked Octokit
    * - mocked download package
    * @scenario
-   * - mock Octokit `listReleases` to return 9 releases
+   * - mock Octokit `listReleases` to return 9 contractReleases
    * - mock download package to throw an error
    * - call `downloadRosenAssets` with mainnet chain type and `rosen` download
    *   directory

package/tests/downloadTssBinary.spec.ts

@@ -0,0 +1,153 @@
+import download from 'download';
+
+import { downloadTssBinary } from '../lib';
+import { RosenAssetsDownloadError } from '../lib';
+
+import {
+  tssReleases,
+  tssTag1,
+  tssTag2,
+  tssTag3PreRelease,
+} from './data/octokit.data';
+
+import { mockOctokit, mockOctokitGetReleaseByTag } from './mocks/octokit.mock';
+
+jest.mock('download');
+
+describe('downloadTssBinary', () => {
+  beforeEach(() => {
+    mockOctokit(tssReleases);
+  });
+
+  /**
+   * @target `downloadTssBinary` should download Tss binary correctly by specific tag
+   * @dependencies
+   * - mocked Octokit
+   * - mocked Octokit GetReleaseByTag
+   * @scenario
+   * - mock Octokit `listReleases` to return tssReleases
+   * - mock Octokit GetReleaseByTag to return desired release
+   * - call `downloadTssBinary` with Windows OS name, `tss-api-1.0.0` and `rosen` download
+   *   directory
+   * @expected
+   * - `download` function should be called with third asset of tss-api stable
+   *    release (windows) download url and `bin` download directory
+   */
+  it('should download Tss binary correctly with specific tag', async () => {
+    mockOctokitGetReleaseByTag(tssReleases);
+    await downloadTssBinary('bin', {
+      osName: 'windows',
+      tag: 'tss-api-1.0.0',
+      regex: false,
+    });
+
+    expect(download).toHaveBeenCalledWith(
+      tssTag1.assets[2].browser_download_url,
+      'bin'
+    );
+  });
+
+  /**
+   * @target `downloadTssBinary` should download Tss binary correctly by
+   *  prefix of a tag
+   * @dependencies
+   * - mocked Octokit
+   * @scenario
+   * - mock Octokit `listReleases` to return tssReleases
+   * - call `downloadTssBinary` with linux OS name, prefix tag `tss-api` and
+   * regex should be true
+   * @expected
+   * - `download` function should be called with first asset of tss-api stable
+   *    release (linux) download url and `bin` download directory
+   */
+  it('should download Tss binary correctly with prefix of tag', async () => {
+    await downloadTssBinary('bin', {
+      osName: 'linux',
+      tag: 'tss-api',
+      regex: true,
+    });
+
+    expect(download).toHaveBeenCalledWith(
+      tssTag2.assets[0].browser_download_url,
+      'bin'
+    );
+  });
+
+  /**
+   * @target `downloadTssBinary` should download Tss binary correctly by
+   *  prefix of a tag for an included prereleases release
+   * @dependencies
+   * - mocked Octokit
+   * @scenario
+   * - mock Octokit `listReleases` to return tssReleases
+   * - call `downloadTssBinary` with linux OS name, prefix tag `tss-api`,
+   *  enable includePrereleases and regex should be true
+   * @expected
+   * - `download` function should be called with first asset of tss-api prerelease
+   *    release (linux) download url and `bin` download directory
+   */
+  it('should download prerelease Tss binary correctly with prefix of tag', async () => {
+    await downloadTssBinary('bin', {
+      osName: 'linux',
+      tag: 'tss-api',
+      regex: true,
+      includePrereleases: true,
+    });
+
+    expect(download).toHaveBeenCalledWith(
+      tssTag3PreRelease.assets[0].browser_download_url,
+      'bin'
+    );
+  });
+
+  /**
+   * @target `downloadTssBinary` should not call `download` function when no
+   * matching release is found
+   * @dependencies
+   * - mocked Octokit
+   * - emptied mocked download package
+   * @scenario
+   * - mock Octokit `listReleases` to return tssReleases
+   * - clear download package mock data (so that we can check calls count)
+   * - call `downloadTssBinary` with "no-release-tag", osName linux and `bin`
+   *   download directory
+   * @expected
+   * - `download` function should not get called
+   */
+  it('should not call `download` function when no matching release is found', async () => {
+    jest.mocked(download).mockClear();
+
+    await downloadTssBinary('bin', {
+      osName: 'linux',
+      tag: 'no-release-tag',
+      regex: true,
+    });
+
+    expect(download).toHaveBeenCalledTimes(0);
+  });
+
+  /**
+   * @target `downloadTssBinary` should throw an error when an error happens
+   * @dependencies
+   * - mocked Octokit
+   * - mocked download package
+   * @scenario
+   * - mock Octokit `listReleases` to return tssReleases
+   * - mock download package to throw an error
+   * - call `downloadTssBinary` with linux OS name, prefix tag `tss-api` and
+   *    regex should be true
+   * @expected
+   * - `download` function should throw `RosenAssetsDownloadError`
+   */
+  it('should throw an error when an error happens', async () => {
+    jest.mocked(download).mockRejectedValue(new Error('Bad!'));
+
+    const downloadPromise = downloadTssBinary('bin', {
+      osName: 'linux',
+      tag: 'tss-api',
+      regex: true,
+    });
+
+    await expect(downloadPromise).rejects.toThrow(RosenAssetsDownloadError);
+  });
+});

package/tests/mocks/octokit.mock.ts

@@ -1,10 +1,10 @@
 import { Octokit } from 'octokit';
 
-import { releases } from '../data/octokit.data';
+import { contractReleases, PartialReleases } from '../data/octokit.data';
 
 import { DEFAULT_RELEASES_FETCHING_PAGE_SIZE } from '../../lib/constants';
 
-export const mockOctokit = () =>
+export const mockOctokit = (releases: any[]) =>
   jest.mocked(Octokit).mockImplementation(() => {
     let page = 0;
     return {
@@ -21,3 +21,21 @@ export const mockOctokit = () =>
       },
     } as any;
   });
+
+/**
+ * mock `getReleaseByTag` of Octokit
+ */
+export const mockOctokitGetReleaseByTag = (releases: PartialReleases) =>
+  jest.mocked(Octokit).mockImplementation(() => {
+    return {
+      rest: {
+        repos: {
+          getReleaseByTag: async ({ tag }: { tag: string }) => {
+            return {
+              data: releases.find((release) => release.tag_name === tag),
+            };
+          },
+        },
+      },
+    } as any;
+  });