Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/__tests__/fixtures/mock-deps.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,15 @@ export function createMockOctokit(
parent: null,
},
}),
getLatestRelease:
(overrides.rest?.repos
?.getLatestRelease as OctokitClient["rest"]["repos"]["getLatestRelease"]) ??
jest.fn<any>().mockResolvedValue({
data: {
tag_name: "v1.2.1",
name: "v1.2.1",
},
}),
listLanguages:
(overrides.rest?.repos
?.listLanguages as OctokitClient["rest"]["repos"]["listLanguages"]) ??
Expand Down
22 changes: 22 additions & 0 deletions src/__tests__/unit/helper.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ describe("createHelpers - calculateMetaData", () => {
const result = await helpers.calculateMetaData();

expect(result.name).toBe("test-repo");
expect(result.version).toBe("1.2.1");
expect(result.description).toBe("A test repository");
expect(result.repositoryURL).toBe(
"https://github.com/test-owner/test-repo",
Expand All @@ -47,6 +48,27 @@ describe("createHelpers - calculateMetaData", () => {
expect(result.tags).toEqual(["test", "automation"]);
});

it("returns an empty version when the release lookup fails", async () => {
const mockOctokit = createMockOctokit({
rest: {
repos: {
getLatestRelease: jest
.fn<any>()
.mockRejectedValue(new Error("rate limited")),
},
},
});

deps = createMockDeps({ octokit: mockOctokit });
const helpers = createHelpers(deps);
const result = await helpers.calculateMetaData();

expect(result.version).toBe("");
expect(deps.log.warning).toHaveBeenCalledWith(
expect.stringContaining("Failed to fetch latest release version"),
);
});

it("reports private visibility for private repos", async () => {
const mockOctokit = createMockOctokit({
rest: {
Expand Down
52 changes: 52 additions & 0 deletions src/__tests__/unit/main.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,29 @@ describe("getMetaData", () => {
expect(result.feedbackMechanism).toContain("/issues");
});

it("preserves an existing version when the latest release is unavailable", async () => {
const releaseOctokit = createMockOctokit({
rest: {
repos: {
getLatestRelease: jest
.fn<any>()
.mockRejectedValue(new Error("not found")),
},
},
});

const deps = createMockDeps({ octokit: releaseOctokit });
const helpers = createHelpers(deps);

const existing = {
...validCodeJSON,
version: "7.8.9",
} as any;
const result = await getMetaData(helpers, deps, existing);

expect(result.version).toBe("7.8.9");
});

it("sets Archival status when isArchived", async () => {
const deps = createMockDeps({ isArchived: true });
const helpers = createHelpers(deps);
Expand Down Expand Up @@ -109,6 +132,29 @@ describe("getMetaData", () => {
URL: "https://github.com/upstream-owner/upstream-repo",
});
});

it("uses the latest release version when available", async () => {
const releaseOctokit = createMockOctokit({
rest: {
repos: {
getLatestRelease: jest.fn<any>().mockResolvedValue({
data: {
tag_name: "v2.4.6",
name: "Release 2.4.6",
},
}),
},
},
});

const deps = createMockDeps({ octokit: releaseOctokit });
const helpers = createHelpers(deps);

const result = await getMetaData(helpers, deps, null);

expect(result.version).toBe("2.4.6");
});

});

describe("runWithDeps", () => {
Expand Down Expand Up @@ -161,6 +207,12 @@ describe("runWithDeps", () => {
get: jest
.fn<any>()
.mockResolvedValue({ data: { default_branch: "main" } }),
getLatestRelease: jest.fn<any>().mockResolvedValue({
data: {
tag_name: "v1.2.1",
name: "v1.2.1",
},
}),
listLanguages: jest.fn<any>().mockResolvedValue({ data: {} }),
getContent: jest
.fn<any>()
Expand Down
40 changes: 39 additions & 1 deletion src/helper.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,15 @@ export function createHelpers(deps: Dependencies) {
//===============================================
async function calculateMetaData(): Promise<Partial<CodeJSON>> {
try {
const [laborHours, basicInfo] = await Promise.all([
const [laborHours, basicInfo, version] = await Promise.all([
getLaborHours(),
getBasicInfo(),
getVersion(),
]);

return {
name: basicInfo.title,
version: version,
description: basicInfo.description,
repositoryURL: basicInfo.url,
repositoryVisibility: basicInfo.repositoryVisibility,
Expand All @@ -44,6 +46,42 @@ export function createHelpers(deps: Dependencies) {
}
}

async function getVersion(): Promise<string> {
try {
const release = await octokit.rest.repos.getLatestRelease({ owner, repo });
const versionFromRelease = normalizeVersionString(release.data.tag_name);

if (versionFromRelease !== "") {
return versionFromRelease;
}

const releaseName = release.data.name;
if (typeof releaseName === "string") {
const versionFromName = normalizeVersionString(releaseName);

if (versionFromName !== "") {
return versionFromName;
}
}

log.warning("Latest release did not include a usable version string.");
} catch (error) {
log.warning(`Failed to fetch latest release version: ${error}`);
}

return "";
}

function normalizeVersionString(value: string): string {
const trimmedValue = value.trim();

if (trimmedValue.length > 1 && /^v\d/i.test(trimmedValue)) {
return trimmedValue.replace(/^v/i, "");
}

return trimmedValue;
}

async function getBasicInfo(): Promise<BasicRepoInfo> {
try {
const [repoData, languagesData] = await Promise.all([
Expand Down
2 changes: 2 additions & 0 deletions src/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ async function getMetaData(
existingCodeJSON?: CodeJSON | null,
): Promise<Partial<CodeJSON>> {
const partialCodeJSON = await helpers.calculateMetaData();
const version = existingCodeJSON?.version || partialCodeJSON.version;

// preserve existing feedback mechanisms if they exist, otherwise default to GitHub Issues
const feedbackMechanism =
Expand Down Expand Up @@ -150,6 +151,7 @@ async function getMetaData(

return {
name: partialCodeJSON.name,
version: version,
description: description,
status: status,
repositoryURL: partialCodeJSON.repositoryURL,
Expand Down
11 changes: 11 additions & 0 deletions src/types/Dependencies.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ export interface OctokitClient {
rest: {
repos: {
get: (params: { owner: string; repo: string }) => Promise<RepoResponse>;
getLatestRelease: (params: {
owner: string;
repo: string;
}) => Promise<ReleaseResponse>;
listLanguages: (params: {
owner: string;
repo: string;
Expand Down Expand Up @@ -91,6 +95,13 @@ export interface LanguagesResponse {
data: Record<string, number>;
}

export interface ReleaseResponse {
data: {
tag_name: string;
name: string | null;
};
}

export interface ContentResponse {
data: { sha?: string } | Array<unknown>;
}
Expand Down