release-please 14.0.0 → 14.1.0

package/CHANGELOG.md

@@ -4,6 +4,23 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [14.1.0](https://github.com/googleapis/release-please/compare/v14.0.0...v14.1.0) (2022-08-19)
+
+
+### Features
+
+* Allow $schema key in manifest config schema ([#1584](https://github.com/googleapis/release-please/issues/1584)) ([d0d43a0](https://github.com/googleapis/release-please/commit/d0d43a0f15d44941c2338f3c8e8c9f972fb45938))
+* customize pr body header ([#1579](https://github.com/googleapis/release-please/issues/1579)) ([92e1366](https://github.com/googleapis/release-please/commit/92e13664bc5a7c4b849f3cea367944280e20b894))
+* use file-cache from git-file-utils ([#1585](https://github.com/googleapis/release-please/issues/1585)) ([e0572f8](https://github.com/googleapis/release-please/commit/e0572f899202ddbad995e8ff21621166d7aae07e))
+
+
+### Bug Fixes
+
+* convert `MissingFileError` thrown by `git-file-utils` ([#1590](https://github.com/googleapis/release-please/issues/1590)) ([cf4f0a3](https://github.com/googleapis/release-please/commit/cf4f0a3068a049cac99d191f40195c686baee413))
+* correct $schema format in manifest config schema ([#1589](https://github.com/googleapis/release-please/issues/1589)) ([e25537b](https://github.com/googleapis/release-please/commit/e25537b559d56c46aedba1e83f7dda7c6825781f))
+* **deps:** update git-file-utils to 1.1.0 ([297a7b7](https://github.com/googleapis/release-please/commit/297a7b7ef862b7aa5e64a6077f86d674eefc140e))
+* use git-file-utils' cache for file search ([#1588](https://github.com/googleapis/release-please/issues/1588)) ([297a7b7](https://github.com/googleapis/release-please/commit/297a7b7ef862b7aa5e64a6077f86d674eefc140e))
+
 ## [14.0.0](https://github.com/googleapis/release-please/compare/v13.21.0...v14.0.0) (2022-08-15)
 
 

package/build/src/bin/release-please.js

@@ -266,6 +266,10 @@ function taggingOptions(yargs) {
         .option('pull-request-title-pattern', {
         describe: 'Title pattern to make release PR',
         type: 'string',
+    })
+        .option('pull-request-header', {
+        describe: 'Header for release PR',
+        type: 'string',
     });
 }
 const createReleasePullRequestCommand = {
@@ -290,6 +294,7 @@ const createReleasePullRequestCommand = {
                 changelogType: argv.changelogType,
                 changelogHost: argv.changelogHost,
                 pullRequestTitlePattern: argv.pullRequestTitlePattern,
+                pullRequestHeader: argv.pullRequestHeader,
                 changelogSections: argv.changelogSections,
                 releaseAs: argv.releaseAs,
                 versioning: argv.versioningStrategy,

package/build/src/github.d.ts

@@ -9,7 +9,7 @@ import { Repository } from './repository';
 import { ReleasePullRequest } from './release-pull-request';
 import { Update } from './update';
 import { Release } from './release';
-import { GitHubFileContents } from './util/file-cache';
+import { GitHubFileContents } from '@google-automations/git-file-utils';
 declare type RequestBuilderType = typeof request;
 declare type DefaultFunctionType = RequestBuilderType['defaults'];
 declare type RequestFunctionType = ReturnType<DefaultFunctionType>;

package/build/src/github.js

@@ -27,7 +27,7 @@ exports.GH_GRAPHQL_URL = 'https://api.github.com';
 const logger_1 = require("./util/logger");
 const manifest_1 = require("./manifest");
 const signoff_commit_message_1 = require("./util/signoff-commit-message");
-const file_cache_1 = require("./util/file-cache");
+const git_file_utils_1 = require("@google-automations/git-file-utils");
 class GitHub {
     constructor(options) {
         /**
@@ -107,30 +107,7 @@ class GitHub {
                 prefix = normalizePrefix(prefix);
             }
             logger_1.logger.debug(`finding files by filename: ${filename}, ref: ${ref}, prefix: ${prefix}`);
-            const response = await this.octokit.git.getTree({
-                owner: this.repository.owner,
-                repo: this.repository.repo,
-                tree_sha: ref,
-                recursive: 'true',
-            });
-            return response.data.tree
-                .filter(file => {
-                const path = file.path;
-                return (path &&
-                    // match the filename
-                    path.endsWith(filename) &&
-                    // match the prefix if provided
-                    (!prefix || path.startsWith(`${prefix}/`)));
-            })
-                .map(file => {
-                let path = file.path;
-                // strip the prefix if provided
-                if (prefix) {
-                    const pfix = new RegExp(`^${prefix}[/\\\\]`);
-                    path = path.replace(pfix, '');
-                }
-                return path;
-            });
+            return await this.fileCache.findFilesByFilename(filename, ref, prefix);
         });
         this.createPullRequest = wrapAsync(async (pullRequest, targetBranch, message, updates, options) => {
             //  Update the files for the release if not already supplied
@@ -245,30 +222,7 @@ class GitHub {
             if (prefix) {
                 prefix = normalizePrefix(prefix);
             }
-            const response = await this.octokit.git.getTree({
-                owner: this.repository.owner,
-                repo: this.repository.repo,
-                tree_sha: ref,
-                recursive: 'true',
-            });
-            return response.data.tree
-                .filter(file => {
-                const path = file.path;
-                return (path &&
-                    // match the file extension
-                    path.endsWith(`.${extension}`) &&
-                    // match the prefix if provided
-                    (!prefix || path.startsWith(`${prefix}/`)));
-            })
-                .map(file => {
-                let path = file.path;
-                // strip the prefix if provided
-                if (prefix) {
-                    const pfix = new RegExp(`^${prefix}[/\\\\]`);
-                    path = path.replace(pfix, '');
-                }
-                return path;
-            });
+            return this.fileCache.findFilesByExtension(extension, ref, prefix);
         });
         /**
          * Create a GitHub release
@@ -368,7 +322,7 @@ class GitHub {
         this.octokit = options.octokitAPIs.octokit;
         this.request = options.octokitAPIs.request;
         this.graphql = options.octokitAPIs.graphql;
-        this.fileCache = new file_cache_1.RepositoryFileCache(this.octokit, this.repository);
+        this.fileCache = new git_file_utils_1.RepositoryFileCache(this.octokit, this.repository);
     }
     /**
      * Build a new GitHub client with auto-detected default branch.
@@ -852,7 +806,15 @@ class GitHub {
      */
     async getFileContentsOnBranch(path, branch) {
         logger_1.logger.debug(`Fetching ${path} from branch ${branch}`);
-        return await this.fileCache.getFileContents(path, branch);
+        try {
+            return await this.fileCache.getFileContents(path, branch);
+        }
+        catch (e) {
+            if (e instanceof git_file_utils_1.FileNotFoundError) {
+                throw new errors_1.FileNotFoundError(path);
+            }
+            throw e;
+        }
     }
     async getFileJson(path, branch) {
         const content = await this.getFileContentsOnBranch(path, branch);
@@ -934,7 +896,7 @@ class GitHub {
                 changes.set(update.path, {
                     content: updatedContent,
                     originalContent: (content === null || content === void 0 ? void 0 : content.parsedContent) || null,
-                    mode: (content === null || content === void 0 ? void 0 : content.mode) || file_cache_1.DEFAULT_FILE_MODE,
+                    mode: (content === null || content === void 0 ? void 0 : content.mode) || git_file_utils_1.DEFAULT_FILE_MODE,
                 });
             }
         }

package/build/src/manifest.d.ts

@@ -43,6 +43,7 @@ export interface ReleaserConfig {
     includeComponentInTag?: boolean;
     includeVInTag?: boolean;
     pullRequestTitlePattern?: string;
+    pullRequestHeader?: string;
     tagSeparator?: string;
     separatePullRequests?: boolean;
     labels?: string[];
@@ -85,6 +86,7 @@ interface ReleaserConfigJson {
     'changelog-type'?: ChangelogNotesType;
     'changelog-host'?: string;
     'pull-request-title-pattern'?: string;
+    'pull-request-header'?: string;
     'separate-pull-requests'?: boolean;
     'tag-separator'?: string;
     'extra-files'?: ExtraFile[];

package/build/src/manifest.js

@@ -730,6 +730,7 @@ function extractReleaserConfig(config) {
         includeVInTag: config['include-v-in-tag'],
         changelogType: config['changelog-type'],
         pullRequestTitlePattern: config['pull-request-title-pattern'],
+        pullRequestHeader: config['pull-request-header'],
         tagSeparator: config['tag-separator'],
         separatePullRequests: config['separate-pull-requests'],
         labels: (_a = config['label']) === null || _a === void 0 ? void 0 : _a.split(','),
@@ -941,7 +942,7 @@ async function latestReleaseVersion(github, targetBranch, releaseFilter, config,
     return candidateTagVersion.sort((a, b) => b.compare(a))[0];
 }
 function mergeReleaserConfig(defaultConfig, pathConfig) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z;
     return {
         releaseType: (_b = (_a = pathConfig.releaseType) !== null && _a !== void 0 ? _a : defaultConfig.releaseType) !== null && _b !== void 0 ? _b : 'node',
         bumpMinorPreMajor: (_c = pathConfig.bumpMinorPreMajor) !== null && _c !== void 0 ? _c : defaultConfig.bumpMinorPreMajor,
@@ -963,8 +964,9 @@ function mergeReleaserConfig(defaultConfig, pathConfig) {
         includeVInTag: (_u = pathConfig.includeVInTag) !== null && _u !== void 0 ? _u : defaultConfig.includeVInTag,
         tagSeparator: (_v = pathConfig.tagSeparator) !== null && _v !== void 0 ? _v : defaultConfig.tagSeparator,
         pullRequestTitlePattern: (_w = pathConfig.pullRequestTitlePattern) !== null && _w !== void 0 ? _w : defaultConfig.pullRequestTitlePattern,
-        separatePullRequests: (_x = pathConfig.separatePullRequests) !== null && _x !== void 0 ? _x : defaultConfig.separatePullRequests,
-        skipSnapshot: (_y = pathConfig.skipSnapshot) !== null && _y !== void 0 ? _y : defaultConfig.skipSnapshot,
+        pullRequestHeader: (_x = pathConfig.pullRequestHeader) !== null && _x !== void 0 ? _x : defaultConfig.pullRequestHeader,
+        separatePullRequests: (_y = pathConfig.separatePullRequests) !== null && _y !== void 0 ? _y : defaultConfig.separatePullRequests,
+        skipSnapshot: (_z = pathConfig.skipSnapshot) !== null && _z !== void 0 ? _z : defaultConfig.skipSnapshot,
     };
 }
 /**

package/build/src/plugins/merge.d.ts

@@ -9,6 +9,7 @@ import { GitHub } from '../github';
  */
 export declare class Merge extends ManifestPlugin {
     private pullRequestTitlePattern?;
-    constructor(github: GitHub, targetBranch: string, repositoryConfig: RepositoryConfig, pullRequestTitlePattern?: string);
+    private pullRequestHeader?;
+    constructor(github: GitHub, targetBranch: string, repositoryConfig: RepositoryConfig, pullRequestTitlePattern?: string, pullRequestHeader?: string);
     run(candidates: CandidateReleasePullRequest[]): Promise<CandidateReleasePullRequest[]>;
 }

package/build/src/plugins/merge.js

@@ -28,10 +28,11 @@ const logger_1 = require("../util/logger");
  * Release notes are broken up using `<summary>`/`<details>` blocks.
  */
 class Merge extends plugin_1.ManifestPlugin {
-    constructor(github, targetBranch, repositoryConfig, pullRequestTitlePattern) {
+    constructor(github, targetBranch, repositoryConfig, pullRequestTitlePattern, pullRequestHeader) {
         super(github, targetBranch, repositoryConfig);
         this.pullRequestTitlePattern =
             pullRequestTitlePattern || manifest_1.MANIFEST_PULL_REQUEST_TITLE_PATTERN;
+        this.pullRequestHeader = pullRequestHeader;
     }
     async run(candidates) {
         if (candidates.length < 1) {
@@ -65,7 +66,10 @@ class Merge extends plugin_1.ManifestPlugin {
         const updates = (0, composite_1.mergeUpdates)(rawUpdates);
         const pullRequest = {
             title: pull_request_title_1.PullRequestTitle.ofComponentTargetBranchVersion(rootRelease === null || rootRelease === void 0 ? void 0 : rootRelease.pullRequest.title.component, this.targetBranch, rootRelease === null || rootRelease === void 0 ? void 0 : rootRelease.pullRequest.title.version, this.pullRequestTitlePattern),
-            body: new pull_request_body_1.PullRequestBody(releaseData, { useComponents: true }),
+            body: new pull_request_body_1.PullRequestBody(releaseData, {
+                useComponents: true,
+                header: this.pullRequestHeader,
+            }),
             updates,
             labels: Array.from(labels),
             headRefName: branch_name_1.BranchName.ofTargetBranch(this.targetBranch).toString(),

package/build/src/strategies/base.d.ts

@@ -40,6 +40,7 @@ export interface BaseStrategyOptions {
     includeComponentInTag?: boolean;
     includeVInTag?: boolean;
     pullRequestTitlePattern?: string;
+    pullRequestHeader?: string;
     extraFiles?: ExtraFile[];
     versionFile?: string;
     snapshotLabels?: string[];
@@ -65,6 +66,7 @@ export declare abstract class BaseStrategy implements Strategy {
     protected includeComponentInTag: boolean;
     protected includeVInTag: boolean;
     readonly pullRequestTitlePattern?: string;
+    readonly pullRequestHeader?: string;
     readonly extraFiles: ExtraFile[];
     readonly changelogNotes: ChangelogNotes;
     protected changelogSections?: ChangelogSection[];
@@ -91,7 +93,7 @@ export declare abstract class BaseStrategy implements Strategy {
      */
     protected postProcessCommits(commits: ConventionalCommit[]): Promise<ConventionalCommit[]>;
     protected buildReleaseNotes(conventionalCommits: ConventionalCommit[], newVersion: Version, newVersionTag: TagName, latestRelease?: Release, commits?: Commit[]): Promise<string>;
-    protected buildPullRequestBody(component: string | undefined, newVersion: Version, releaseNotesBody: string, _conventionalCommits: ConventionalCommit[], _latestRelease?: Release): Promise<PullRequestBody>;
+    protected buildPullRequestBody(component: string | undefined, newVersion: Version, releaseNotesBody: string, _conventionalCommits: ConventionalCommit[], _latestRelease?: Release, pullRequestHeader?: string): Promise<PullRequestBody>;
     /**
      * Builds a candidate release pull request
      * @param {Commit[]} commits Raw commits to consider for this release.

package/build/src/strategies/base.js

@@ -58,6 +58,7 @@ class BaseStrategy {
         this.includeComponentInTag = (_a = options.includeComponentInTag) !== null && _a !== void 0 ? _a : true;
         this.includeVInTag = (_b = options.includeVInTag) !== null && _b !== void 0 ? _b : true;
         this.pullRequestTitlePattern = options.pullRequestTitlePattern;
+        this.pullRequestHeader = options.pullRequestHeader;
         this.extraFiles = options.extraFiles || [];
     }
     /**
@@ -113,14 +114,14 @@ class BaseStrategy {
             commits: commits,
         });
     }
-    async buildPullRequestBody(component, newVersion, releaseNotesBody, _conventionalCommits, _latestRelease) {
+    async buildPullRequestBody(component, newVersion, releaseNotesBody, _conventionalCommits, _latestRelease, pullRequestHeader) {
         return new pull_request_body_1.PullRequestBody([
             {
                 component,
                 version: newVersion,
                 notes: releaseNotesBody,
             },
-        ]);
+        ], { header: pullRequestHeader });
     }
     /**
      * Builds a candidate release pull request
@@ -163,7 +164,7 @@ class BaseStrategy {
             latestVersion: latestRelease === null || latestRelease === void 0 ? void 0 : latestRelease.tag.version,
         });
         const updatesWithExtras = (0, composite_1.mergeUpdates)(updates.concat(...this.extraFileUpdates(newVersion, versionsMap)));
-        const pullRequestBody = await this.buildPullRequestBody(component, newVersion, releaseNotesBody, conventionalCommits, latestRelease);
+        const pullRequestBody = await this.buildPullRequestBody(component, newVersion, releaseNotesBody, conventionalCommits, latestRelease, this.pullRequestHeader);
         return {
             title: pullRequestTitle,
             body: pullRequestBody,

package/build/src/strategies/dotnet-yoshi.js

@@ -34,15 +34,18 @@ const CHANGELOG_SECTIONS = [
 ];
 const DEFAULT_CHANGELOG_PATH = 'docs/history.md';
 const DEFAULT_PULL_REQUEST_TITLE_PATTERN = 'Release${component} version ${version}';
+const DEFAULT_PULL_REQUEST_HEADER = ':robot: I have created a release *beep* *boop*';
 const RELEASE_NOTES_HEADER_PATTERN = /#{2,3} \[?(\d+\.\d+\.\d+-?[^\]]*)\]?.* \((\d{4}-\d{2}-\d{2})\)/;
 class DotnetYoshi extends base_1.BaseStrategy {
     constructor(options) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e;
         options.changelogSections = (_a = options.changelogSections) !== null && _a !== void 0 ? _a : CHANGELOG_SECTIONS;
         options.changelogPath = (_b = options.changelogPath) !== null && _b !== void 0 ? _b : DEFAULT_CHANGELOG_PATH;
         options.pullRequestTitlePattern =
             (_c = options.pullRequestTitlePattern) !== null && _c !== void 0 ? _c : DEFAULT_PULL_REQUEST_TITLE_PATTERN;
-        options.includeVInTag = (_d = options.includeVInTag) !== null && _d !== void 0 ? _d : false;
+        options.pullRequestHeader =
+            (_d = options.pullRequestHeader) !== null && _d !== void 0 ? _d : DEFAULT_PULL_REQUEST_HEADER;
+        options.includeVInTag = (_e = options.includeVInTag) !== null && _e !== void 0 ? _e : false;
         super(options);
     }
     async buildReleaseNotes(conventionalCommits, newVersion, newVersionTag, latestRelease) {

package/build/src/strategies/java-yoshi.d.ts

@@ -1,6 +1,6 @@
 import { Update } from '../update';
 import { Version, VersionsMap } from '../version';
-import { GitHubFileContents } from '../util/file-cache';
+import { GitHubFileContents } from '@google-automations/git-file-utils';
 import { ConventionalCommit } from '../commit';
 import { Java, JavaBuildUpdatesOption } from './java';
 export declare class JavaYoshi extends Java {

package/build/src/strategies/java.js

@@ -79,6 +79,7 @@ class Java extends base_1.BaseStrategy {
             ? branch_name_1.BranchName.ofComponentTargetBranch(component, this.targetBranch)
             : branch_name_1.BranchName.ofTargetBranch(this.targetBranch);
         const notes = '### Updating meta-information for bleeding-edge SNAPSHOT release.';
+        // TODO use pullrequest header here?
         const pullRequestBody = new pull_request_body_1.PullRequestBody([
             {
                 component,

package/build/src/strategies/php-yoshi.js

@@ -136,6 +136,7 @@ class PHPYoshi extends base_1.BaseStrategy {
                 });
             }
         }
+        // TODO use pullrequest header here?
         const pullRequestBody = new pull_request_body_1.PullRequestBody([
             {
                 component,

package/build/src/update.d.ts

@@ -1,4 +1,4 @@
-import { GitHubFileContents } from './util/file-cache';
+import { GitHubFileContents } from '@google-automations/git-file-utils';
 /**
  * An update is a collection of data that represents changes to
  * a file in a repository.

package/build/src/updaters/release-please-config.js

@@ -60,6 +60,7 @@ function releaserConfigToJsonConfig(config) {
         'changelog-type': config.changelogType,
         'changelog-host': config.changelogHost,
         'pull-request-title-pattern': config.pullRequestTitlePattern,
+        'pull-request-header': config.pullRequestHeader,
         'separate-pull-requests': config.separatePullRequests,
         'tag-separator': config.tagSeparator,
         'extra-files': config.extraFiles,

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "release-please",
-  "version": "14.0.0",
+  "version": "14.1.0",
   "description": "generate release PRs based on the conventionalcommits.org spec",
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",
   "scripts": {
-    "test": "cross-env ENVIRONMENT=test c8 mocha --recursive --timeout=5000 build/test",
+    "test": "cross-env ENVIRONMENT=test LC_ALL=en c8 mocha --recursive --timeout=5000 build/test",
     "docs": "echo add docs tests",
-    "test:snap": "SNAPSHOT_UPDATE=1 npm test",
+    "test:snap": "SNAPSHOT_UPDATE=1 LC_ALL=en npm test",
     "clean": "gts clean",
     "prepare": "npm run compile",
     "lint": "gts check",
@@ -56,6 +56,7 @@
     "@types/xmldom": "^0.1.31",
     "@types/yargs": "^17.0.0",
     "ajv": "^8.11.0",
+    "ajv-formats": "^2.1.1",
     "c8": "^7.0.0",
     "chai": "^4.2.0",
     "cross-env": "^7.0.0",
@@ -67,6 +68,7 @@
   },
   "dependencies": {
     "@conventional-commits/parser": "^0.4.1",
+    "@google-automations/git-file-utils": "^1.1.0",
     "@iarna/toml": "^2.2.5",
     "@lerna/collect-updates": "^4.0.0",
     "@lerna/package": "^4.0.0",

package/schemas/config.json

@@ -95,6 +95,10 @@
           "description": "Customize the release pull request title.",
           "type": "string"
         },
+        "pull-request-header": {
+          "description": "Customize the release pull request header.",
+          "type": "string"
+        },
         "separate-pull-requests": {
           "description": "Open a separate release pull request for each component. Defaults to `false`.",
           "type": "boolean"
@@ -189,6 +193,11 @@
     },
     {
       "properties": {
+        "$schema": {
+          "description": "Path to the release-please manifest config schema",
+          "type": "string",
+          "format": "uri-reference"
+        },
         "packages": {
           "description": "Per-path component configuration.",
           "type": "object",
@@ -297,6 +306,7 @@
     }
   ],
   "properties": {
+    "$schema": true,
     "packages": true,
     "bootstrap-sha": true,
     "last-release-sha": true,
@@ -323,6 +333,7 @@
     "changelog-type": true,
     "changelog-host": true,
     "pull-request-title-pattern": true,
+    "pull-request-header": true,
     "separate-pull-requests": true,
     "tag-separator": true,
     "extra-files": true,

package/build/src/util/file-cache.d.ts

@@ -1,104 +0,0 @@
-import { Octokit } from '@octokit/rest';
-import { Repository } from '../repository';
-export declare const DEFAULT_FILE_MODE = "100644";
-export interface GitHubFileContents {
-    sha: string;
-    content: string;
-    parsedContent: string;
-    mode: string;
-}
-/**
- * This class is a read-through cache aimed at minimizing the
- * number of API requests needed to fetch file data/contents.
- * It lazy-caches data as it reads and will return cached data
- * for resources already fetched.
- */
-export declare class RepositoryFileCache {
-    private octokit;
-    private repository;
-    private cache;
-    /**
-     * Instantiate a new loading cache instance
-     *
-     * @param {Octokit} octokit An authenticated octokit instance
-     * @param {Repository} repository The repository we are fetching data for
-     */
-    constructor(octokit: Octokit, repository: Repository);
-    /**
-     * Fetch file contents for given path on a given branch. If the
-     * data has already been fetched, return a cached copy.
-     *
-     * @param {string} path Path to the file
-     * @param {string} branch Branch to fetch the file from
-     * @returns {GitHubFileContents} The file contents
-     */
-    getFileContents(path: string, branch: string): Promise<GitHubFileContents>;
-}
-/**
- * This class is a read-through cache for a single branch aimed
- * at minimizing the number of API requests needed to fetch file
- * data/contents. It lazy-caches data as it reads and will return
- * cached data for resources already fetched.
- */
-export declare class BranchFileCache {
-    private octokit;
-    private repository;
-    private branch;
-    private cache;
-    private treeCache;
-    private treeEntries?;
-    /**
-     * Instantiate a new loading cache instance
-     *
-     * @param {Octokit} octokit An authenticated octokit instance
-     * @param {Repository} repository The repository we are fetching data for
-     * @param {string} branch The branch we are fetching data from
-     */
-    constructor(octokit: Octokit, repository: Repository, branch: string);
-    /**
-     * Fetch file contents for given path. If the data has already been
-     * fetched, return the cached copy.
-     *
-     * @param {string} path Path to the file
-     * @param {string} branch Branch to fetch the file from
-     * @returns {GitHubFileContents} The file contents
-     */
-    getFileContents(path: string): Promise<GitHubFileContents>;
-    /**
-     * Actually fetch the file contents. Uses the tree API to fetch file
-     * data.
-     *
-     * @param {string} path Path to the file
-     */
-    private fetchFileContents;
-    /**
-     * Return the full recursive git tree. If already fetched, return
-     * the cached version. If the tree is too big, return null.
-     *
-     * @returns {TreeEntry[]} The tree entries
-     */
-    private getFullTree;
-    /**
-     * Returns the git tree for a given SHA. If already fetched, return
-     * the cached version.
-     *
-     * @param {string} sha The tree SHA
-     * @returns {TreeEntry[]} The tree entries
-     */
-    private getTree;
-    /**
-     * Fetch the git tree via the GitHub API
-     *
-     * @param {string} sha The tree SHA
-     * @returns {TreeEntry[]} The tree entries
-     */
-    private fetchTree;
-    /**
-     * Fetch the git blob from the GitHub API and convert into a
-     * GitHubFileContents object.
-     *
-     * @param {string} blobSha The git blob SHA
-     * @param {TreeEntry} treeEntry The associated tree object
-     */
-    private fetchContents;
-}

package/build/src/util/file-cache.js

@@ -1,208 +0,0 @@
-"use strict";
-// Copyright 2022 Google LLC
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BranchFileCache = exports.RepositoryFileCache = exports.DEFAULT_FILE_MODE = void 0;
-const logger_1 = require("./logger");
-const errors_1 = require("../errors");
-exports.DEFAULT_FILE_MODE = '100644';
-/**
- * This class is a read-through cache aimed at minimizing the
- * number of API requests needed to fetch file data/contents.
- * It lazy-caches data as it reads and will return cached data
- * for resources already fetched.
- */
-class RepositoryFileCache {
-    /**
-     * Instantiate a new loading cache instance
-     *
-     * @param {Octokit} octokit An authenticated octokit instance
-     * @param {Repository} repository The repository we are fetching data for
-     */
-    constructor(octokit, repository) {
-        this.octokit = octokit;
-        this.repository = repository;
-        this.cache = new Map();
-    }
-    /**
-     * Fetch file contents for given path on a given branch. If the
-     * data has already been fetched, return a cached copy.
-     *
-     * @param {string} path Path to the file
-     * @param {string} branch Branch to fetch the file from
-     * @returns {GitHubFileContents} The file contents
-     */
-    async getFileContents(path, branch) {
-        let fileCache = this.cache.get(branch);
-        if (!fileCache) {
-            fileCache = new BranchFileCache(this.octokit, this.repository, branch);
-            this.cache.set(branch, fileCache);
-        }
-        return await fileCache.getFileContents(path);
-    }
-}
-exports.RepositoryFileCache = RepositoryFileCache;
-/**
- * This class is a read-through cache for a single branch aimed
- * at minimizing the number of API requests needed to fetch file
- * data/contents. It lazy-caches data as it reads and will return
- * cached data for resources already fetched.
- */
-class BranchFileCache {
-    /**
-     * Instantiate a new loading cache instance
-     *
-     * @param {Octokit} octokit An authenticated octokit instance
-     * @param {Repository} repository The repository we are fetching data for
-     * @param {string} branch The branch we are fetching data from
-     */
-    constructor(octokit, repository, branch) {
-        this.octokit = octokit;
-        this.repository = repository;
-        this.branch = branch;
-        this.cache = new Map();
-        this.treeCache = new Map();
-    }
-    /**
-     * Fetch file contents for given path. If the data has already been
-     * fetched, return the cached copy.
-     *
-     * @param {string} path Path to the file
-     * @param {string} branch Branch to fetch the file from
-     * @returns {GitHubFileContents} The file contents
-     */
-    async getFileContents(path) {
-        const cached = this.cache.get(path);
-        if (cached) {
-            return cached;
-        }
-        const fetched = await this.fetchFileContents(path);
-        this.cache.set(path, fetched);
-        return fetched;
-    }
-    /**
-     * Actually fetch the file contents. Uses the tree API to fetch file
-     * data.
-     *
-     * @param {string} path Path to the file
-     */
-    async fetchFileContents(path) {
-        // try to use the entire git tree if it's not too big
-        const treeEntries = await this.getFullTree();
-        if (treeEntries) {
-            logger_1.logger.debug(`Using full tree to find ${path}`);
-            const found = treeEntries.find(entry => entry.path === path);
-            if (found === null || found === void 0 ? void 0 : found.sha) {
-                return await this.fetchContents(found.sha, found);
-            }
-            throw new errors_1.FileNotFoundError(path);
-        }
-        // full tree is too big, use data API to fetch
-        const parts = path.split('/');
-        let treeSha = this.branch;
-        let found;
-        for (const part of parts) {
-            const tree = await this.getTree(treeSha);
-            found = tree.find(item => item.path === part);
-            if (!(found === null || found === void 0 ? void 0 : found.sha)) {
-                throw new errors_1.FileNotFoundError(path);
-            }
-            treeSha = found.sha;
-        }
-        if (found === null || found === void 0 ? void 0 : found.sha) {
-            return await this.fetchContents(found.sha, found);
-        }
-        throw new errors_1.FileNotFoundError(path);
-    }
-    /**
-     * Return the full recursive git tree. If already fetched, return
-     * the cached version. If the tree is too big, return null.
-     *
-     * @returns {TreeEntry[]} The tree entries
-     */
-    async getFullTree() {
-        if (this.treeEntries === undefined) {
-            // fetch all tree entries recursively
-            const { data: { tree, truncated }, } = await this.octokit.git.getTree({
-                owner: this.repository.owner,
-                repo: this.repository.repo,
-                tree_sha: this.branch,
-                recursive: 'true',
-            });
-            if (truncated) {
-                // the full tree is too big to use, mark it as unusable
-                this.treeEntries = null;
-            }
-            else {
-                this.treeEntries = tree;
-            }
-        }
-        return this.treeEntries;
-    }
-    /**
-     * Returns the git tree for a given SHA. If already fetched, return
-     * the cached version.
-     *
-     * @param {string} sha The tree SHA
-     * @returns {TreeEntry[]} The tree entries
-     */
-    async getTree(sha) {
-        const cached = this.treeCache.get(sha);
-        if (cached) {
-            return cached;
-        }
-        const fetched = await this.fetchTree(sha);
-        this.treeCache.set(sha, fetched);
-        return fetched;
-    }
-    /**
-     * Fetch the git tree via the GitHub API
-     *
-     * @param {string} sha The tree SHA
-     * @returns {TreeEntry[]} The tree entries
-     */
-    async fetchTree(sha) {
-        const { data: { tree, truncated }, } = await this.octokit.git.getTree({
-            owner: this.repository.owner,
-            repo: this.repository.repo,
-            tree_sha: sha,
-        });
-        if (truncated) {
-            logger_1.logger.warn(`file list for tree sha ${sha} is truncated`);
-        }
-        return tree;
-    }
-    /**
-     * Fetch the git blob from the GitHub API and convert into a
-     * GitHubFileContents object.
-     *
-     * @param {string} blobSha The git blob SHA
-     * @param {TreeEntry} treeEntry The associated tree object
-     */
-    async fetchContents(blobSha, treeEntry) {
-        const { data: { content }, } = await this.octokit.git.getBlob({
-            owner: this.repository.owner,
-            repo: this.repository.repo,
-            file_sha: blobSha,
-        });
-        return {
-            sha: blobSha,
-            mode: treeEntry.mode || exports.DEFAULT_FILE_MODE,
-            content,
-            parsedContent: Buffer.from(content, 'base64').toString('utf8'),
-        };
-    }
-}
-exports.BranchFileCache = BranchFileCache;
-//# sourceMappingURL=file-cache.js.map